Commit | Line | Data |
---|---|---|
c906108c | 1 | \input texinfo @c -*-texinfo-*- |
44944448 JB |
2 | @c Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, |
3 | @c 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, | |
4 | @c 2010, 2011 Free Software Foundation, Inc. | |
c906108c | 5 | @c |
5d161b24 | 6 | @c %**start of header |
c906108c SS |
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 | |
c906108c | 13 | @settitle Debugging with @value{GDBN} |
c906108c SS |
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 | |
89c73ade | 24 | @syncodeindex tp cp |
c906108c | 25 | |
41afff9a | 26 | @c readline appendices use @vindex, @findex and @ftable, |
48e934c6 | 27 | @c annotate.texi and gdbmi use @findex. |
c906108c | 28 | @syncodeindex vr cp |
41afff9a | 29 | @syncodeindex fn cp |
c906108c SS |
30 | |
31 | @c !!set GDB manual's edition---not the same as GDB version! | |
9fe8321b | 32 | @c This is updated by GNU Press. |
e9c75b65 | 33 | @set EDITION Ninth |
c906108c | 34 | |
87885426 FN |
35 | @c !!set GDB edit command default editor |
36 | @set EDITOR /bin/ex | |
c906108c | 37 | |
6c0e9fb3 | 38 | @c THIS MANUAL REQUIRES TEXINFO 4.0 OR LATER. |
c906108c | 39 | |
c906108c | 40 | @c This is a dir.info fragment to support semi-automated addition of |
6d2ebf8b | 41 | @c manuals to an info tree. |
03727ca6 | 42 | @dircategory Software development |
96a2c332 | 43 | @direntry |
03727ca6 | 44 | * Gdb: (gdb). The GNU debugger. |
96a2c332 SS |
45 | @end direntry |
46 | ||
a67ec3f4 JM |
47 | @copying |
48 | Copyright @copyright{} 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, | |
9d2897ad | 49 | 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
a67ec3f4 | 50 | Free Software Foundation, Inc. |
c906108c | 51 | |
e9c75b65 | 52 | Permission is granted to copy, distribute and/or modify this document |
4f5d9f07 | 53 | under the terms of the GNU Free Documentation License, Version 1.3 or |
e9c75b65 | 54 | any later version published by the Free Software Foundation; with the |
959acfd1 EZ |
55 | Invariant Sections being ``Free Software'' and ``Free Software Needs |
56 | Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,'' | |
57 | and with the Back-Cover Texts as in (a) below. | |
c906108c | 58 | |
b8533aec DJ |
59 | (a) The FSF's Back-Cover Text is: ``You are free to copy and modify |
60 | this GNU Manual. Buying copies from GNU Press supports the FSF in | |
61 | developing GNU and promoting software freedom.'' | |
a67ec3f4 JM |
62 | @end copying |
63 | ||
64 | @ifnottex | |
65 | This file documents the @sc{gnu} debugger @value{GDBN}. | |
66 | ||
67 | This is the @value{EDITION} Edition, of @cite{Debugging with | |
68 | @value{GDBN}: the @sc{gnu} Source-Level Debugger} for @value{GDBN} | |
69 | @ifset VERSION_PACKAGE | |
70 | @value{VERSION_PACKAGE} | |
71 | @end ifset | |
72 | Version @value{GDBVN}. | |
73 | ||
74 | @insertcopying | |
75 | @end ifnottex | |
c906108c SS |
76 | |
77 | @titlepage | |
78 | @title Debugging with @value{GDBN} | |
79 | @subtitle The @sc{gnu} Source-Level Debugger | |
c906108c | 80 | @sp 1 |
c906108c | 81 | @subtitle @value{EDITION} Edition, for @value{GDBN} version @value{GDBVN} |
c16158bc JM |
82 | @ifset VERSION_PACKAGE |
83 | @sp 1 | |
84 | @subtitle @value{VERSION_PACKAGE} | |
85 | @end ifset | |
9e9c5ae7 | 86 | @author Richard Stallman, Roland Pesch, Stan Shebs, et al. |
c906108c | 87 | @page |
c906108c SS |
88 | @tex |
89 | {\parskip=0pt | |
c16158bc | 90 | \hfill (Send bugs and comments on @value{GDBN} to @value{BUGURL}.)\par |
c906108c SS |
91 | \hfill {\it Debugging with @value{GDBN}}\par |
92 | \hfill \TeX{}info \texinfoversion\par | |
93 | } | |
94 | @end tex | |
53a5351d | 95 | |
c906108c | 96 | @vskip 0pt plus 1filll |
c906108c | 97 | Published by the Free Software Foundation @* |
c02a867d EZ |
98 | 51 Franklin Street, Fifth Floor, |
99 | Boston, MA 02110-1301, USA@* | |
6d2ebf8b | 100 | ISBN 1-882114-77-9 @* |
e9c75b65 | 101 | |
a67ec3f4 | 102 | @insertcopying |
c906108c SS |
103 | @end titlepage |
104 | @page | |
105 | ||
6c0e9fb3 | 106 | @ifnottex |
6d2ebf8b SS |
107 | @node Top, Summary, (dir), (dir) |
108 | ||
c906108c SS |
109 | @top Debugging with @value{GDBN} |
110 | ||
111 | This file describes @value{GDBN}, the @sc{gnu} symbolic debugger. | |
112 | ||
c16158bc JM |
113 | This is the @value{EDITION} Edition, for @value{GDBN} |
114 | @ifset VERSION_PACKAGE | |
115 | @value{VERSION_PACKAGE} | |
116 | @end ifset | |
117 | Version @value{GDBVN}. | |
c906108c | 118 | |
9d2897ad | 119 | Copyright (C) 1988-2010 Free Software Foundation, Inc. |
6d2ebf8b | 120 | |
3fb6a982 JB |
121 | This edition of the GDB manual is dedicated to the memory of Fred |
122 | Fish. Fred was a long-standing contributor to GDB and to Free | |
123 | software in general. We will miss him. | |
124 | ||
6d2ebf8b SS |
125 | @menu |
126 | * Summary:: Summary of @value{GDBN} | |
127 | * Sample Session:: A sample @value{GDBN} session | |
128 | ||
129 | * Invocation:: Getting in and out of @value{GDBN} | |
130 | * Commands:: @value{GDBN} commands | |
131 | * Running:: Running programs under @value{GDBN} | |
132 | * Stopping:: Stopping and continuing | |
bacec72f | 133 | * Reverse Execution:: Running programs backward |
a2311334 | 134 | * Process Record and Replay:: Recording inferior's execution and replaying it |
6d2ebf8b SS |
135 | * Stack:: Examining the stack |
136 | * Source:: Examining source files | |
137 | * Data:: Examining data | |
edb3359d | 138 | * Optimized Code:: Debugging optimized code |
e2e0bcd1 | 139 | * Macros:: Preprocessor Macros |
b37052ae | 140 | * Tracepoints:: Debugging remote targets non-intrusively |
df0cd8c5 | 141 | * Overlays:: Debugging programs that use overlays |
6d2ebf8b SS |
142 | |
143 | * Languages:: Using @value{GDBN} with different languages | |
144 | ||
145 | * Symbols:: Examining the symbol table | |
146 | * Altering:: Altering execution | |
147 | * GDB Files:: @value{GDBN} files | |
148 | * Targets:: Specifying a debugging target | |
6b2f586d | 149 | * Remote Debugging:: Debugging remote programs |
6d2ebf8b SS |
150 | * Configurations:: Configuration-specific information |
151 | * Controlling GDB:: Controlling @value{GDBN} | |
d57a3c85 | 152 | * Extending GDB:: Extending @value{GDBN} |
21c294e6 | 153 | * Interpreters:: Command Interpreters |
c8f4133a | 154 | * TUI:: @value{GDBN} Text User Interface |
6d2ebf8b | 155 | * Emacs:: Using @value{GDBN} under @sc{gnu} Emacs |
7162c0ca | 156 | * GDB/MI:: @value{GDBN}'s Machine Interface. |
c8f4133a | 157 | * Annotations:: @value{GDBN}'s annotation interface. |
4efc6507 | 158 | * JIT Interface:: Using the JIT debugging interface. |
6d2ebf8b SS |
159 | |
160 | * GDB Bugs:: Reporting bugs in @value{GDBN} | |
6d2ebf8b | 161 | |
39037522 TT |
162 | @ifset SYSTEM_READLINE |
163 | * Command Line Editing: (rluserman). Command Line Editing | |
164 | * Using History Interactively: (history). Using History Interactively | |
165 | @end ifset | |
166 | @ifclear SYSTEM_READLINE | |
6d2ebf8b SS |
167 | * Command Line Editing:: Command Line Editing |
168 | * Using History Interactively:: Using History Interactively | |
39037522 | 169 | @end ifclear |
4ceed123 | 170 | * In Memoriam:: In Memoriam |
0869d01b | 171 | * Formatting Documentation:: How to format and print @value{GDBN} documentation |
6d2ebf8b | 172 | * Installing GDB:: Installing GDB |
eb12ee30 | 173 | * Maintenance Commands:: Maintenance Commands |
e0ce93ac | 174 | * Remote Protocol:: GDB Remote Serial Protocol |
f418dd93 | 175 | * Agent Expressions:: The GDB Agent Expression Mechanism |
23181151 DJ |
176 | * Target Descriptions:: How targets can describe themselves to |
177 | @value{GDBN} | |
07e059b5 VP |
178 | * Operating System Information:: Getting additional information from |
179 | the operating system | |
00bf0b85 | 180 | * Trace File Format:: GDB trace file format |
90476074 | 181 | * Index Section Format:: .gdb_index section format |
aab4e0ec AC |
182 | * Copying:: GNU General Public License says |
183 | how you can copy and share GDB | |
6826cf00 | 184 | * GNU Free Documentation License:: The license for this documentation |
6d2ebf8b SS |
185 | * Index:: Index |
186 | @end menu | |
187 | ||
6c0e9fb3 | 188 | @end ifnottex |
c906108c | 189 | |
449f3b6c | 190 | @contents |
449f3b6c | 191 | |
6d2ebf8b | 192 | @node Summary |
c906108c SS |
193 | @unnumbered Summary of @value{GDBN} |
194 | ||
195 | The purpose of a debugger such as @value{GDBN} is to allow you to see what is | |
196 | going on ``inside'' another program while it executes---or what another | |
197 | program was doing at the moment it crashed. | |
198 | ||
199 | @value{GDBN} can do four main kinds of things (plus other things in support of | |
200 | these) to help you catch bugs in the act: | |
201 | ||
202 | @itemize @bullet | |
203 | @item | |
204 | Start your program, specifying anything that might affect its behavior. | |
205 | ||
206 | @item | |
207 | Make your program stop on specified conditions. | |
208 | ||
209 | @item | |
210 | Examine what has happened, when your program has stopped. | |
211 | ||
212 | @item | |
213 | Change things in your program, so you can experiment with correcting the | |
214 | effects of one bug and go on to learn about another. | |
215 | @end itemize | |
216 | ||
49efadf5 | 217 | You can use @value{GDBN} to debug programs written in C and C@t{++}. |
79a6e687 | 218 | For more information, see @ref{Supported Languages,,Supported Languages}. |
c906108c SS |
219 | For more information, see @ref{C,,C and C++}. |
220 | ||
6aecb9c2 JB |
221 | Support for D is partial. For information on D, see |
222 | @ref{D,,D}. | |
223 | ||
cce74817 | 224 | @cindex Modula-2 |
e632838e AC |
225 | Support for Modula-2 is partial. For information on Modula-2, see |
226 | @ref{Modula-2,,Modula-2}. | |
c906108c | 227 | |
f4b8a18d KW |
228 | Support for OpenCL C is partial. For information on OpenCL C, see |
229 | @ref{OpenCL C,,OpenCL C}. | |
230 | ||
cce74817 JM |
231 | @cindex Pascal |
232 | Debugging Pascal programs which use sets, subranges, file variables, or | |
233 | nested functions does not currently work. @value{GDBN} does not support | |
234 | entering expressions, printing values, or similar features using Pascal | |
235 | syntax. | |
c906108c | 236 | |
c906108c SS |
237 | @cindex Fortran |
238 | @value{GDBN} can be used to debug programs written in Fortran, although | |
53a5351d | 239 | it may be necessary to refer to some variables with a trailing |
cce74817 | 240 | underscore. |
c906108c | 241 | |
b37303ee AF |
242 | @value{GDBN} can be used to debug programs written in Objective-C, |
243 | using either the Apple/NeXT or the GNU Objective-C runtime. | |
244 | ||
c906108c SS |
245 | @menu |
246 | * Free Software:: Freely redistributable software | |
247 | * Contributors:: Contributors to GDB | |
248 | @end menu | |
249 | ||
6d2ebf8b | 250 | @node Free Software |
79a6e687 | 251 | @unnumberedsec Free Software |
c906108c | 252 | |
5d161b24 | 253 | @value{GDBN} is @dfn{free software}, protected by the @sc{gnu} |
c906108c SS |
254 | General Public License |
255 | (GPL). The GPL gives you the freedom to copy or adapt a licensed | |
256 | program---but every person getting a copy also gets with it the | |
257 | freedom to modify that copy (which means that they must get access to | |
258 | the source code), and the freedom to distribute further copies. | |
259 | Typical software companies use copyrights to limit your freedoms; the | |
260 | Free Software Foundation uses the GPL to preserve these freedoms. | |
261 | ||
262 | Fundamentally, the General Public License is a license which says that | |
263 | you have these freedoms and that you cannot take these freedoms away | |
264 | from anyone else. | |
265 | ||
2666264b | 266 | @unnumberedsec Free Software Needs Free Documentation |
959acfd1 EZ |
267 | |
268 | The biggest deficiency in the free software community today is not in | |
269 | the software---it is the lack of good free documentation that we can | |
270 | include with the free software. Many of our most important | |
271 | programs do not come with free reference manuals and free introductory | |
272 | texts. Documentation is an essential part of any software package; | |
273 | when an important free software package does not come with a free | |
274 | manual and a free tutorial, that is a major gap. We have many such | |
275 | gaps today. | |
276 | ||
277 | Consider Perl, for instance. The tutorial manuals that people | |
278 | normally use are non-free. How did this come about? Because the | |
279 | authors of those manuals published them with restrictive terms---no | |
280 | copying, no modification, source files not available---which exclude | |
281 | them from the free software world. | |
282 | ||
283 | That wasn't the first time this sort of thing happened, and it was far | |
284 | from the last. Many times we have heard a GNU user eagerly describe a | |
285 | manual that he is writing, his intended contribution to the community, | |
286 | only to learn that he had ruined everything by signing a publication | |
287 | contract to make it non-free. | |
288 | ||
289 | Free documentation, like free software, is a matter of freedom, not | |
290 | price. The problem with the non-free manual is not that publishers | |
291 | charge a price for printed copies---that in itself is fine. (The Free | |
292 | Software Foundation sells printed copies of manuals, too.) The | |
293 | problem is the restrictions on the use of the manual. Free manuals | |
294 | are available in source code form, and give you permission to copy and | |
295 | modify. Non-free manuals do not allow this. | |
296 | ||
297 | The criteria of freedom for a free manual are roughly the same as for | |
298 | free software. Redistribution (including the normal kinds of | |
299 | commercial redistribution) must be permitted, so that the manual can | |
300 | accompany every copy of the program, both on-line and on paper. | |
301 | ||
302 | Permission for modification of the technical content is crucial too. | |
303 | When people modify the software, adding or changing features, if they | |
304 | are conscientious they will change the manual too---so they can | |
305 | provide accurate and clear documentation for the modified program. A | |
306 | manual that leaves you no choice but to write a new manual to document | |
307 | a changed version of the program is not really available to our | |
308 | community. | |
309 | ||
310 | Some kinds of limits on the way modification is handled are | |
311 | acceptable. For example, requirements to preserve the original | |
312 | author's copyright notice, the distribution terms, or the list of | |
313 | authors, are ok. It is also no problem to require modified versions | |
314 | to include notice that they were modified. Even entire sections that | |
315 | may not be deleted or changed are acceptable, as long as they deal | |
316 | with nontechnical topics (like this one). These kinds of restrictions | |
317 | are acceptable because they don't obstruct the community's normal use | |
318 | of the manual. | |
319 | ||
320 | However, it must be possible to modify all the @emph{technical} | |
321 | content of the manual, and then distribute the result in all the usual | |
322 | media, through all the usual channels. Otherwise, the restrictions | |
323 | obstruct the use of the manual, it is not free, and we need another | |
324 | manual to replace it. | |
325 | ||
326 | Please spread the word about this issue. Our community continues to | |
327 | lose manuals to proprietary publishing. If we spread the word that | |
328 | free software needs free reference manuals and free tutorials, perhaps | |
329 | the next person who wants to contribute by writing documentation will | |
330 | realize, before it is too late, that only free manuals contribute to | |
331 | the free software community. | |
332 | ||
333 | If you are writing documentation, please insist on publishing it under | |
334 | the GNU Free Documentation License or another free documentation | |
335 | license. Remember that this decision requires your approval---you | |
336 | don't have to let the publisher decide. Some commercial publishers | |
337 | will use a free license if you insist, but they will not propose the | |
338 | option; it is up to you to raise the issue and say firmly that this is | |
339 | what you want. If the publisher you are dealing with refuses, please | |
340 | try other publishers. If you're not sure whether a proposed license | |
42584a72 | 341 | is free, write to @email{licensing@@gnu.org}. |
959acfd1 EZ |
342 | |
343 | You can encourage commercial publishers to sell more free, copylefted | |
344 | manuals and tutorials by buying them, and particularly by buying | |
345 | copies from the publishers that paid for their writing or for major | |
346 | improvements. Meanwhile, try to avoid buying non-free documentation | |
347 | at all. Check the distribution terms of a manual before you buy it, | |
348 | and insist that whoever seeks your business must respect your freedom. | |
72c9928d EZ |
349 | Check the history of the book, and try to reward the publishers that |
350 | have paid or pay the authors to work on it. | |
959acfd1 EZ |
351 | |
352 | The Free Software Foundation maintains a list of free documentation | |
353 | published by other publishers, at | |
354 | @url{http://www.fsf.org/doc/other-free-books.html}. | |
355 | ||
6d2ebf8b | 356 | @node Contributors |
96a2c332 SS |
357 | @unnumberedsec Contributors to @value{GDBN} |
358 | ||
359 | Richard Stallman was the original author of @value{GDBN}, and of many | |
360 | other @sc{gnu} programs. Many others have contributed to its | |
361 | development. This section attempts to credit major contributors. One | |
362 | of the virtues of free software is that everyone is free to contribute | |
363 | to it; with regret, we cannot actually acknowledge everyone here. The | |
364 | file @file{ChangeLog} in the @value{GDBN} distribution approximates a | |
c906108c SS |
365 | blow-by-blow account. |
366 | ||
367 | Changes much prior to version 2.0 are lost in the mists of time. | |
368 | ||
369 | @quotation | |
370 | @emph{Plea:} Additions to this section are particularly welcome. If you | |
371 | or your friends (or enemies, to be evenhanded) have been unfairly | |
372 | omitted from this list, we would like to add your names! | |
373 | @end quotation | |
374 | ||
375 | So that they may not regard their many labors as thankless, we | |
376 | particularly thank those who shepherded @value{GDBN} through major | |
377 | releases: | |
7ba3cf9c | 378 | Andrew Cagney (releases 6.3, 6.2, 6.1, 6.0, 5.3, 5.2, 5.1 and 5.0); |
c906108c SS |
379 | Jim Blandy (release 4.18); |
380 | Jason Molenda (release 4.17); | |
381 | Stan Shebs (release 4.14); | |
382 | Fred Fish (releases 4.16, 4.15, 4.13, 4.12, 4.11, 4.10, and 4.9); | |
383 | Stu Grossman and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, and 4.4); | |
384 | John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9); | |
385 | Jim Kingdon (releases 3.5, 3.4, and 3.3); | |
386 | and Randy Smith (releases 3.2, 3.1, and 3.0). | |
387 | ||
388 | Richard Stallman, assisted at various times by Peter TerMaat, Chris | |
389 | Hanson, and Richard Mlynarik, handled releases through 2.8. | |
390 | ||
b37052ae EZ |
391 | Michael Tiemann is the author of most of the @sc{gnu} C@t{++} support |
392 | in @value{GDBN}, with significant additional contributions from Per | |
393 | Bothner and Daniel Berlin. James Clark wrote the @sc{gnu} C@t{++} | |
394 | demangler. Early work on C@t{++} was by Peter TerMaat (who also did | |
395 | much general update work leading to release 3.0). | |
c906108c | 396 | |
b37052ae | 397 | @value{GDBN} uses the BFD subroutine library to examine multiple |
c906108c SS |
398 | object-file formats; BFD was a joint project of David V. |
399 | Henkel-Wallace, Rich Pixley, Steve Chamberlain, and John Gilmore. | |
400 | ||
401 | David Johnson wrote the original COFF support; Pace Willison did | |
402 | the original support for encapsulated COFF. | |
403 | ||
0179ffac | 404 | Brent Benson of Harris Computer Systems contributed DWARF 2 support. |
c906108c SS |
405 | |
406 | Adam de Boor and Bradley Davis contributed the ISI Optimum V support. | |
407 | Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS | |
408 | support. | |
409 | Jean-Daniel Fekete contributed Sun 386i support. | |
410 | Chris Hanson improved the HP9000 support. | |
411 | Noboyuki Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support. | |
412 | David Johnson contributed Encore Umax support. | |
413 | Jyrki Kuoppala contributed Altos 3068 support. | |
414 | Jeff Law contributed HP PA and SOM support. | |
415 | Keith Packard contributed NS32K support. | |
416 | Doug Rabson contributed Acorn Risc Machine support. | |
417 | Bob Rusk contributed Harris Nighthawk CX-UX support. | |
418 | Chris Smith contributed Convex support (and Fortran debugging). | |
419 | Jonathan Stone contributed Pyramid support. | |
420 | Michael Tiemann contributed SPARC support. | |
421 | Tim Tucker contributed support for the Gould NP1 and Gould Powernode. | |
422 | Pace Willison contributed Intel 386 support. | |
423 | Jay Vosburgh contributed Symmetry support. | |
a37295f9 | 424 | Marko Mlinar contributed OpenRISC 1000 support. |
c906108c | 425 | |
1104b9e7 | 426 | Andreas Schwab contributed M68K @sc{gnu}/Linux support. |
c906108c SS |
427 | |
428 | Rich Schaefer and Peter Schauer helped with support of SunOS shared | |
429 | libraries. | |
430 | ||
431 | Jay Fenlason and Roland McGrath ensured that @value{GDBN} and GAS agree | |
432 | about several machine instruction sets. | |
433 | ||
434 | Patrick Duval, Ted Goldstein, Vikram Koka and Glenn Engel helped develop | |
435 | remote debugging. Intel Corporation, Wind River Systems, AMD, and ARM | |
436 | contributed remote debugging modules for the i960, VxWorks, A29K UDI, | |
437 | and RDI targets, respectively. | |
438 | ||
439 | Brian Fox is the author of the readline libraries providing | |
440 | command-line editing and command history. | |
441 | ||
7a292a7a SS |
442 | Andrew Beers of SUNY Buffalo wrote the language-switching code, the |
443 | Modula-2 support, and contributed the Languages chapter of this manual. | |
c906108c | 444 | |
5d161b24 | 445 | Fred Fish wrote most of the support for Unix System Vr4. |
b37052ae | 446 | He also enhanced the command-completion support to cover C@t{++} overloaded |
c906108c | 447 | symbols. |
c906108c | 448 | |
f24c5e49 KI |
449 | Hitachi America (now Renesas America), Ltd. sponsored the support for |
450 | H8/300, H8/500, and Super-H processors. | |
c906108c SS |
451 | |
452 | NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors. | |
453 | ||
f24c5e49 KI |
454 | Mitsubishi (now Renesas) sponsored the support for D10V, D30V, and M32R/D |
455 | processors. | |
c906108c SS |
456 | |
457 | Toshiba sponsored the support for the TX39 Mips processor. | |
458 | ||
459 | Matsushita sponsored the support for the MN10200 and MN10300 processors. | |
460 | ||
96a2c332 | 461 | Fujitsu sponsored the support for SPARClite and FR30 processors. |
c906108c SS |
462 | |
463 | Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware | |
464 | watchpoints. | |
465 | ||
466 | Michael Snyder added support for tracepoints. | |
467 | ||
468 | Stu Grossman wrote gdbserver. | |
469 | ||
470 | Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made | |
96a2c332 | 471 | nearly innumerable bug fixes and cleanups throughout @value{GDBN}. |
c906108c SS |
472 | |
473 | The following people at the Hewlett-Packard Company contributed | |
474 | support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0 | |
b37052ae | 475 | (narrow mode), HP's implementation of kernel threads, HP's aC@t{++} |
d0d5df6f AC |
476 | compiler, and the Text User Interface (nee Terminal User Interface): |
477 | Ben Krepp, Richard Title, John Bishop, Susan Macchia, Kathy Mann, | |
478 | Satish Pai, India Paul, Steve Rehrauer, and Elena Zannoni. Kim Haase | |
479 | provided HP-specific information in this manual. | |
c906108c | 480 | |
b37052ae EZ |
481 | DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project. |
482 | Robert Hoehne made significant contributions to the DJGPP port. | |
483 | ||
96a2c332 SS |
484 | Cygnus Solutions has sponsored @value{GDBN} maintenance and much of its |
485 | development since 1991. Cygnus engineers who have worked on @value{GDBN} | |
2df3850c JM |
486 | fulltime include Mark Alexander, Jim Blandy, Per Bothner, Kevin |
487 | Buettner, Edith Epstein, Chris Faylor, Fred Fish, Martin Hunt, Jim | |
488 | Ingham, John Gilmore, Stu Grossman, Kung Hsu, Jim Kingdon, John Metzler, | |
489 | Fernando Nasser, Geoffrey Noer, Dawn Perchik, Rich Pixley, Zdenek | |
490 | Radouch, Keith Seitz, Stan Shebs, David Taylor, and Elena Zannoni. In | |
491 | addition, Dave Brolley, Ian Carmichael, Steve Chamberlain, Nick Clifton, | |
492 | JT Conklin, Stan Cox, DJ Delorie, Ulrich Drepper, Frank Eigler, Doug | |
493 | Evans, Sean Fagan, David Henkel-Wallace, Richard Henderson, Jeff | |
494 | Holcomb, Jeff Law, Jim Lemke, Tom Lord, Bob Manson, Michael Meissner, | |
495 | Jason Merrill, Catherine Moore, Drew Moseley, Ken Raeburn, Gavin | |
496 | Romig-Koch, Rob Savoye, Jamie Smith, Mike Stump, Ian Taylor, Angela | |
497 | Thomas, Michael Tiemann, Tom Tromey, Ron Unrau, Jim Wilson, and David | |
498 | Zuhn have made contributions both large and small. | |
c906108c | 499 | |
ffed4509 AC |
500 | Andrew Cagney, Fernando Nasser, and Elena Zannoni, while working for |
501 | Cygnus Solutions, implemented the original @sc{gdb/mi} interface. | |
502 | ||
e2e0bcd1 JB |
503 | Jim Blandy added support for preprocessor macros, while working for Red |
504 | Hat. | |
c906108c | 505 | |
a9967aef AC |
506 | Andrew Cagney designed @value{GDBN}'s architecture vector. Many |
507 | people including Andrew Cagney, Stephane Carrez, Randolph Chung, Nick | |
508 | Duffek, Richard Henderson, Mark Kettenis, Grace Sainsbury, Kei | |
509 | Sakamoto, Yoshinori Sato, Michael Snyder, Andreas Schwab, Jason | |
510 | Thorpe, Corinna Vinschen, Ulrich Weigand, and Elena Zannoni, helped | |
511 | with the migration of old architectures to this new framework. | |
512 | ||
c5e30d01 AC |
513 | Andrew Cagney completely re-designed and re-implemented @value{GDBN}'s |
514 | unwinder framework, this consisting of a fresh new design featuring | |
515 | frame IDs, independent frame sniffers, and the sentinel frame. Mark | |
516 | Kettenis implemented the @sc{dwarf 2} unwinder, Jeff Johnston the | |
517 | libunwind unwinder, and Andrew Cagney the dummy, sentinel, tramp, and | |
db2e3e2e | 518 | trad unwinders. The architecture-specific changes, each involving a |
c5e30d01 AC |
519 | complete rewrite of the architecture's frame code, were carried out by |
520 | Jim Blandy, Joel Brobecker, Kevin Buettner, Andrew Cagney, Stephane | |
521 | Carrez, Randolph Chung, Orjan Friberg, Richard Henderson, Daniel | |
522 | Jacobowitz, Jeff Johnston, Mark Kettenis, Theodore A. Roth, Kei | |
523 | Sakamoto, Yoshinori Sato, Michael Snyder, Corinna Vinschen, and Ulrich | |
524 | Weigand. | |
525 | ||
ca3bf3bd DJ |
526 | Christian Zankel, Ross Morley, Bob Wilson, and Maxim Grigoriev from |
527 | Tensilica, Inc.@: contributed support for Xtensa processors. Others | |
528 | who have worked on the Xtensa port of @value{GDBN} in the past include | |
529 | Steve Tjiang, John Newlin, and Scott Foehner. | |
530 | ||
08be9d71 ME |
531 | Michael Eager and staff of Xilinx, Inc., contributed support for the |
532 | Xilinx MicroBlaze architecture. | |
533 | ||
6d2ebf8b | 534 | @node Sample Session |
c906108c SS |
535 | @chapter A Sample @value{GDBN} Session |
536 | ||
537 | You can use this manual at your leisure to read all about @value{GDBN}. | |
538 | However, a handful of commands are enough to get started using the | |
539 | debugger. This chapter illustrates those commands. | |
540 | ||
541 | @iftex | |
542 | In this sample session, we emphasize user input like this: @b{input}, | |
543 | to make it easier to pick out from the surrounding output. | |
544 | @end iftex | |
545 | ||
546 | @c FIXME: this example may not be appropriate for some configs, where | |
547 | @c FIXME...primary interest is in remote use. | |
548 | ||
549 | One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro | |
550 | processor) exhibits the following bug: sometimes, when we change its | |
551 | quote strings from the default, the commands used to capture one macro | |
552 | definition within another stop working. In the following short @code{m4} | |
553 | session, we define a macro @code{foo} which expands to @code{0000}; we | |
554 | then use the @code{m4} built-in @code{defn} to define @code{bar} as the | |
555 | same thing. However, when we change the open quote string to | |
556 | @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same | |
557 | procedure fails to define a new synonym @code{baz}: | |
558 | ||
559 | @smallexample | |
560 | $ @b{cd gnu/m4} | |
561 | $ @b{./m4} | |
562 | @b{define(foo,0000)} | |
563 | ||
564 | @b{foo} | |
565 | 0000 | |
566 | @b{define(bar,defn(`foo'))} | |
567 | ||
568 | @b{bar} | |
569 | 0000 | |
570 | @b{changequote(<QUOTE>,<UNQUOTE>)} | |
571 | ||
572 | @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))} | |
573 | @b{baz} | |
c8aa23ab | 574 | @b{Ctrl-d} |
c906108c SS |
575 | m4: End of input: 0: fatal error: EOF in string |
576 | @end smallexample | |
577 | ||
578 | @noindent | |
579 | Let us use @value{GDBN} to try to see what is going on. | |
580 | ||
c906108c SS |
581 | @smallexample |
582 | $ @b{@value{GDBP} m4} | |
583 | @c FIXME: this falsifies the exact text played out, to permit smallbook | |
584 | @c FIXME... format to come out better. | |
585 | @value{GDBN} is free software and you are welcome to distribute copies | |
5d161b24 | 586 | of it under certain conditions; type "show copying" to see |
c906108c | 587 | the conditions. |
5d161b24 | 588 | There is absolutely no warranty for @value{GDBN}; type "show warranty" |
c906108c SS |
589 | for details. |
590 | ||
591 | @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc... | |
592 | (@value{GDBP}) | |
593 | @end smallexample | |
c906108c SS |
594 | |
595 | @noindent | |
596 | @value{GDBN} reads only enough symbol data to know where to find the | |
597 | rest when needed; as a result, the first prompt comes up very quickly. | |
598 | We now tell @value{GDBN} to use a narrower display width than usual, so | |
599 | that examples fit in this manual. | |
600 | ||
601 | @smallexample | |
602 | (@value{GDBP}) @b{set width 70} | |
603 | @end smallexample | |
604 | ||
605 | @noindent | |
606 | We need to see how the @code{m4} built-in @code{changequote} works. | |
607 | Having looked at the source, we know the relevant subroutine is | |
608 | @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN} | |
609 | @code{break} command. | |
610 | ||
611 | @smallexample | |
612 | (@value{GDBP}) @b{break m4_changequote} | |
613 | Breakpoint 1 at 0x62f4: file builtin.c, line 879. | |
614 | @end smallexample | |
615 | ||
616 | @noindent | |
617 | Using the @code{run} command, we start @code{m4} running under @value{GDBN} | |
618 | control; as long as control does not reach the @code{m4_changequote} | |
619 | subroutine, the program runs as usual: | |
620 | ||
621 | @smallexample | |
622 | (@value{GDBP}) @b{run} | |
623 | Starting program: /work/Editorial/gdb/gnu/m4/m4 | |
624 | @b{define(foo,0000)} | |
625 | ||
626 | @b{foo} | |
627 | 0000 | |
628 | @end smallexample | |
629 | ||
630 | @noindent | |
631 | To trigger the breakpoint, we call @code{changequote}. @value{GDBN} | |
632 | suspends execution of @code{m4}, displaying information about the | |
633 | context where it stops. | |
634 | ||
635 | @smallexample | |
636 | @b{changequote(<QUOTE>,<UNQUOTE>)} | |
637 | ||
5d161b24 | 638 | Breakpoint 1, m4_changequote (argc=3, argv=0x33c70) |
c906108c SS |
639 | at builtin.c:879 |
640 | 879 if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3)) | |
641 | @end smallexample | |
642 | ||
643 | @noindent | |
644 | Now we use the command @code{n} (@code{next}) to advance execution to | |
645 | the next line of the current function. | |
646 | ||
647 | @smallexample | |
648 | (@value{GDBP}) @b{n} | |
649 | 882 set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\ | |
650 | : nil, | |
651 | @end smallexample | |
652 | ||
653 | @noindent | |
654 | @code{set_quotes} looks like a promising subroutine. We can go into it | |
655 | by using the command @code{s} (@code{step}) instead of @code{next}. | |
656 | @code{step} goes to the next line to be executed in @emph{any} | |
657 | subroutine, so it steps into @code{set_quotes}. | |
658 | ||
659 | @smallexample | |
660 | (@value{GDBP}) @b{s} | |
661 | set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>") | |
662 | at input.c:530 | |
663 | 530 if (lquote != def_lquote) | |
664 | @end smallexample | |
665 | ||
666 | @noindent | |
667 | The display that shows the subroutine where @code{m4} is now | |
668 | suspended (and its arguments) is called a stack frame display. It | |
669 | shows a summary of the stack. We can use the @code{backtrace} | |
670 | command (which can also be spelled @code{bt}), to see where we are | |
671 | in the stack as a whole: the @code{backtrace} command displays a | |
672 | stack frame for each active subroutine. | |
673 | ||
674 | @smallexample | |
675 | (@value{GDBP}) @b{bt} | |
676 | #0 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>") | |
677 | at input.c:530 | |
5d161b24 | 678 | #1 0x6344 in m4_changequote (argc=3, argv=0x33c70) |
c906108c SS |
679 | at builtin.c:882 |
680 | #2 0x8174 in expand_macro (sym=0x33320) at macro.c:242 | |
681 | #3 0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30) | |
682 | at macro.c:71 | |
683 | #4 0x79dc in expand_input () at macro.c:40 | |
684 | #5 0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195 | |
685 | @end smallexample | |
686 | ||
687 | @noindent | |
688 | We step through a few more lines to see what happens. The first two | |
689 | times, we can use @samp{s}; the next two times we use @code{n} to avoid | |
690 | falling into the @code{xstrdup} subroutine. | |
691 | ||
692 | @smallexample | |
693 | (@value{GDBP}) @b{s} | |
694 | 0x3b5c 532 if (rquote != def_rquote) | |
695 | (@value{GDBP}) @b{s} | |
696 | 0x3b80 535 lquote = (lq == nil || *lq == '\0') ? \ | |
697 | def_lquote : xstrdup(lq); | |
698 | (@value{GDBP}) @b{n} | |
699 | 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\ | |
700 | : xstrdup(rq); | |
701 | (@value{GDBP}) @b{n} | |
702 | 538 len_lquote = strlen(rquote); | |
703 | @end smallexample | |
704 | ||
705 | @noindent | |
706 | The last line displayed looks a little odd; we can examine the variables | |
707 | @code{lquote} and @code{rquote} to see if they are in fact the new left | |
708 | and right quotes we specified. We use the command @code{p} | |
709 | (@code{print}) to see their values. | |
710 | ||
711 | @smallexample | |
712 | (@value{GDBP}) @b{p lquote} | |
713 | $1 = 0x35d40 "<QUOTE>" | |
714 | (@value{GDBP}) @b{p rquote} | |
715 | $2 = 0x35d50 "<UNQUOTE>" | |
716 | @end smallexample | |
717 | ||
718 | @noindent | |
719 | @code{lquote} and @code{rquote} are indeed the new left and right quotes. | |
720 | To look at some context, we can display ten lines of source | |
721 | surrounding the current line with the @code{l} (@code{list}) command. | |
722 | ||
723 | @smallexample | |
724 | (@value{GDBP}) @b{l} | |
725 | 533 xfree(rquote); | |
726 | 534 | |
727 | 535 lquote = (lq == nil || *lq == '\0') ? def_lquote\ | |
728 | : xstrdup (lq); | |
729 | 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\ | |
730 | : xstrdup (rq); | |
731 | 537 | |
732 | 538 len_lquote = strlen(rquote); | |
733 | 539 len_rquote = strlen(lquote); | |
734 | 540 @} | |
735 | 541 | |
736 | 542 void | |
737 | @end smallexample | |
738 | ||
739 | @noindent | |
740 | Let us step past the two lines that set @code{len_lquote} and | |
741 | @code{len_rquote}, and then examine the values of those variables. | |
742 | ||
743 | @smallexample | |
744 | (@value{GDBP}) @b{n} | |
745 | 539 len_rquote = strlen(lquote); | |
746 | (@value{GDBP}) @b{n} | |
747 | 540 @} | |
748 | (@value{GDBP}) @b{p len_lquote} | |
749 | $3 = 9 | |
750 | (@value{GDBP}) @b{p len_rquote} | |
751 | $4 = 7 | |
752 | @end smallexample | |
753 | ||
754 | @noindent | |
755 | That certainly looks wrong, assuming @code{len_lquote} and | |
756 | @code{len_rquote} are meant to be the lengths of @code{lquote} and | |
757 | @code{rquote} respectively. We can set them to better values using | |
758 | the @code{p} command, since it can print the value of | |
759 | any expression---and that expression can include subroutine calls and | |
760 | assignments. | |
761 | ||
762 | @smallexample | |
763 | (@value{GDBP}) @b{p len_lquote=strlen(lquote)} | |
764 | $5 = 7 | |
765 | (@value{GDBP}) @b{p len_rquote=strlen(rquote)} | |
766 | $6 = 9 | |
767 | @end smallexample | |
768 | ||
769 | @noindent | |
770 | Is that enough to fix the problem of using the new quotes with the | |
771 | @code{m4} built-in @code{defn}? We can allow @code{m4} to continue | |
772 | executing with the @code{c} (@code{continue}) command, and then try the | |
773 | example that caused trouble initially: | |
774 | ||
775 | @smallexample | |
776 | (@value{GDBP}) @b{c} | |
777 | Continuing. | |
778 | ||
779 | @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))} | |
780 | ||
781 | baz | |
782 | 0000 | |
783 | @end smallexample | |
784 | ||
785 | @noindent | |
786 | Success! The new quotes now work just as well as the default ones. The | |
787 | problem seems to have been just the two typos defining the wrong | |
788 | lengths. We allow @code{m4} exit by giving it an EOF as input: | |
789 | ||
790 | @smallexample | |
c8aa23ab | 791 | @b{Ctrl-d} |
c906108c SS |
792 | Program exited normally. |
793 | @end smallexample | |
794 | ||
795 | @noindent | |
796 | The message @samp{Program exited normally.} is from @value{GDBN}; it | |
797 | indicates @code{m4} has finished executing. We can end our @value{GDBN} | |
798 | session with the @value{GDBN} @code{quit} command. | |
799 | ||
800 | @smallexample | |
801 | (@value{GDBP}) @b{quit} | |
802 | @end smallexample | |
c906108c | 803 | |
6d2ebf8b | 804 | @node Invocation |
c906108c SS |
805 | @chapter Getting In and Out of @value{GDBN} |
806 | ||
807 | This chapter discusses how to start @value{GDBN}, and how to get out of it. | |
5d161b24 | 808 | The essentials are: |
c906108c | 809 | @itemize @bullet |
5d161b24 | 810 | @item |
53a5351d | 811 | type @samp{@value{GDBP}} to start @value{GDBN}. |
5d161b24 | 812 | @item |
c8aa23ab | 813 | type @kbd{quit} or @kbd{Ctrl-d} to exit. |
c906108c SS |
814 | @end itemize |
815 | ||
816 | @menu | |
817 | * Invoking GDB:: How to start @value{GDBN} | |
818 | * Quitting GDB:: How to quit @value{GDBN} | |
819 | * Shell Commands:: How to use shell commands inside @value{GDBN} | |
79a6e687 | 820 | * Logging Output:: How to log @value{GDBN}'s output to a file |
c906108c SS |
821 | @end menu |
822 | ||
6d2ebf8b | 823 | @node Invoking GDB |
c906108c SS |
824 | @section Invoking @value{GDBN} |
825 | ||
c906108c SS |
826 | Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started, |
827 | @value{GDBN} reads commands from the terminal until you tell it to exit. | |
828 | ||
829 | You can also run @code{@value{GDBP}} with a variety of arguments and options, | |
830 | to specify more of your debugging environment at the outset. | |
831 | ||
c906108c SS |
832 | The command-line options described here are designed |
833 | to cover a variety of situations; in some environments, some of these | |
5d161b24 | 834 | options may effectively be unavailable. |
c906108c SS |
835 | |
836 | The most usual way to start @value{GDBN} is with one argument, | |
837 | specifying an executable program: | |
838 | ||
474c8240 | 839 | @smallexample |
c906108c | 840 | @value{GDBP} @var{program} |
474c8240 | 841 | @end smallexample |
c906108c | 842 | |
c906108c SS |
843 | @noindent |
844 | You can also start with both an executable program and a core file | |
845 | specified: | |
846 | ||
474c8240 | 847 | @smallexample |
c906108c | 848 | @value{GDBP} @var{program} @var{core} |
474c8240 | 849 | @end smallexample |
c906108c SS |
850 | |
851 | You can, instead, specify a process ID as a second argument, if you want | |
852 | to debug a running process: | |
853 | ||
474c8240 | 854 | @smallexample |
c906108c | 855 | @value{GDBP} @var{program} 1234 |
474c8240 | 856 | @end smallexample |
c906108c SS |
857 | |
858 | @noindent | |
859 | would attach @value{GDBN} to process @code{1234} (unless you also have a file | |
860 | named @file{1234}; @value{GDBN} does check for a core file first). | |
861 | ||
c906108c | 862 | Taking advantage of the second command-line argument requires a fairly |
2df3850c JM |
863 | complete operating system; when you use @value{GDBN} as a remote |
864 | debugger attached to a bare board, there may not be any notion of | |
865 | ``process'', and there is often no way to get a core dump. @value{GDBN} | |
866 | will warn you if it is unable to attach or to read core dumps. | |
c906108c | 867 | |
aa26fa3a TT |
868 | You can optionally have @code{@value{GDBP}} pass any arguments after the |
869 | executable file to the inferior using @code{--args}. This option stops | |
870 | option processing. | |
474c8240 | 871 | @smallexample |
3f94c067 | 872 | @value{GDBP} --args gcc -O2 -c foo.c |
474c8240 | 873 | @end smallexample |
aa26fa3a TT |
874 | This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set |
875 | @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}. | |
876 | ||
96a2c332 | 877 | You can run @code{@value{GDBP}} without printing the front material, which describes |
c906108c SS |
878 | @value{GDBN}'s non-warranty, by specifying @code{-silent}: |
879 | ||
880 | @smallexample | |
881 | @value{GDBP} -silent | |
882 | @end smallexample | |
883 | ||
884 | @noindent | |
885 | You can further control how @value{GDBN} starts up by using command-line | |
886 | options. @value{GDBN} itself can remind you of the options available. | |
887 | ||
888 | @noindent | |
889 | Type | |
890 | ||
474c8240 | 891 | @smallexample |
c906108c | 892 | @value{GDBP} -help |
474c8240 | 893 | @end smallexample |
c906108c SS |
894 | |
895 | @noindent | |
896 | to display all available options and briefly describe their use | |
897 | (@samp{@value{GDBP} -h} is a shorter equivalent). | |
898 | ||
899 | All options and command line arguments you give are processed | |
900 | in sequential order. The order makes a difference when the | |
901 | @samp{-x} option is used. | |
902 | ||
903 | ||
904 | @menu | |
c906108c SS |
905 | * File Options:: Choosing files |
906 | * Mode Options:: Choosing modes | |
6fc08d32 | 907 | * Startup:: What @value{GDBN} does during startup |
c906108c SS |
908 | @end menu |
909 | ||
6d2ebf8b | 910 | @node File Options |
79a6e687 | 911 | @subsection Choosing Files |
c906108c | 912 | |
2df3850c | 913 | When @value{GDBN} starts, it reads any arguments other than options as |
c906108c SS |
914 | specifying an executable file and core file (or process ID). This is |
915 | the same as if the arguments were specified by the @samp{-se} and | |
d52fb0e9 | 916 | @samp{-c} (or @samp{-p}) options respectively. (@value{GDBN} reads the |
19837790 MS |
917 | first argument that does not have an associated option flag as |
918 | equivalent to the @samp{-se} option followed by that argument; and the | |
919 | second argument that does not have an associated option flag, if any, as | |
920 | equivalent to the @samp{-c}/@samp{-p} option followed by that argument.) | |
921 | If the second argument begins with a decimal digit, @value{GDBN} will | |
922 | first attempt to attach to it as a process, and if that fails, attempt | |
923 | to open it as a corefile. If you have a corefile whose name begins with | |
b383017d | 924 | a digit, you can prevent @value{GDBN} from treating it as a pid by |
c1468174 | 925 | prefixing it with @file{./}, e.g.@: @file{./12345}. |
7a292a7a SS |
926 | |
927 | If @value{GDBN} has not been configured to included core file support, | |
928 | such as for most embedded targets, then it will complain about a second | |
929 | argument and ignore it. | |
c906108c SS |
930 | |
931 | Many options have both long and short forms; both are shown in the | |
932 | following list. @value{GDBN} also recognizes the long forms if you truncate | |
933 | them, so long as enough of the option is present to be unambiguous. | |
934 | (If you prefer, you can flag option arguments with @samp{--} rather | |
935 | than @samp{-}, though we illustrate the more usual convention.) | |
936 | ||
d700128c EZ |
937 | @c NOTE: the @cindex entries here use double dashes ON PURPOSE. This |
938 | @c way, both those who look for -foo and --foo in the index, will find | |
939 | @c it. | |
940 | ||
c906108c SS |
941 | @table @code |
942 | @item -symbols @var{file} | |
943 | @itemx -s @var{file} | |
d700128c EZ |
944 | @cindex @code{--symbols} |
945 | @cindex @code{-s} | |
c906108c SS |
946 | Read symbol table from file @var{file}. |
947 | ||
948 | @item -exec @var{file} | |
949 | @itemx -e @var{file} | |
d700128c EZ |
950 | @cindex @code{--exec} |
951 | @cindex @code{-e} | |
7a292a7a SS |
952 | Use file @var{file} as the executable file to execute when appropriate, |
953 | and for examining pure data in conjunction with a core dump. | |
c906108c SS |
954 | |
955 | @item -se @var{file} | |
d700128c | 956 | @cindex @code{--se} |
c906108c SS |
957 | Read symbol table from file @var{file} and use it as the executable |
958 | file. | |
959 | ||
c906108c SS |
960 | @item -core @var{file} |
961 | @itemx -c @var{file} | |
d700128c EZ |
962 | @cindex @code{--core} |
963 | @cindex @code{-c} | |
b383017d | 964 | Use file @var{file} as a core dump to examine. |
c906108c | 965 | |
19837790 MS |
966 | @item -pid @var{number} |
967 | @itemx -p @var{number} | |
968 | @cindex @code{--pid} | |
969 | @cindex @code{-p} | |
970 | Connect to process ID @var{number}, as with the @code{attach} command. | |
c906108c SS |
971 | |
972 | @item -command @var{file} | |
973 | @itemx -x @var{file} | |
d700128c EZ |
974 | @cindex @code{--command} |
975 | @cindex @code{-x} | |
95433b34 JB |
976 | Execute commands from file @var{file}. The contents of this file is |
977 | evaluated exactly as the @code{source} command would. | |
8150ff9c | 978 | @xref{Command Files,, Command files}. |
c906108c | 979 | |
8a5a3c82 AS |
980 | @item -eval-command @var{command} |
981 | @itemx -ex @var{command} | |
982 | @cindex @code{--eval-command} | |
983 | @cindex @code{-ex} | |
984 | Execute a single @value{GDBN} command. | |
985 | ||
986 | This option may be used multiple times to call multiple commands. It may | |
987 | also be interleaved with @samp{-command} as required. | |
988 | ||
989 | @smallexample | |
990 | @value{GDBP} -ex 'target sim' -ex 'load' \ | |
991 | -x setbreakpoints -ex 'run' a.out | |
992 | @end smallexample | |
993 | ||
c906108c SS |
994 | @item -directory @var{directory} |
995 | @itemx -d @var{directory} | |
d700128c EZ |
996 | @cindex @code{--directory} |
997 | @cindex @code{-d} | |
4b505b12 | 998 | Add @var{directory} to the path to search for source and script files. |
c906108c | 999 | |
c906108c SS |
1000 | @item -r |
1001 | @itemx -readnow | |
d700128c EZ |
1002 | @cindex @code{--readnow} |
1003 | @cindex @code{-r} | |
c906108c SS |
1004 | Read each symbol file's entire symbol table immediately, rather than |
1005 | the default, which is to read it incrementally as it is needed. | |
1006 | This makes startup slower, but makes future operations faster. | |
53a5351d | 1007 | |
c906108c SS |
1008 | @end table |
1009 | ||
6d2ebf8b | 1010 | @node Mode Options |
79a6e687 | 1011 | @subsection Choosing Modes |
c906108c SS |
1012 | |
1013 | You can run @value{GDBN} in various alternative modes---for example, in | |
1014 | batch mode or quiet mode. | |
1015 | ||
1016 | @table @code | |
1017 | @item -nx | |
1018 | @itemx -n | |
d700128c EZ |
1019 | @cindex @code{--nx} |
1020 | @cindex @code{-n} | |
96565e91 | 1021 | Do not execute commands found in any initialization files. Normally, |
2df3850c JM |
1022 | @value{GDBN} executes the commands in these files after all the command |
1023 | options and arguments have been processed. @xref{Command Files,,Command | |
79a6e687 | 1024 | Files}. |
c906108c SS |
1025 | |
1026 | @item -quiet | |
d700128c | 1027 | @itemx -silent |
c906108c | 1028 | @itemx -q |
d700128c EZ |
1029 | @cindex @code{--quiet} |
1030 | @cindex @code{--silent} | |
1031 | @cindex @code{-q} | |
c906108c SS |
1032 | ``Quiet''. Do not print the introductory and copyright messages. These |
1033 | messages are also suppressed in batch mode. | |
1034 | ||
1035 | @item -batch | |
d700128c | 1036 | @cindex @code{--batch} |
c906108c SS |
1037 | Run in batch mode. Exit with status @code{0} after processing all the |
1038 | command files specified with @samp{-x} (and all commands from | |
1039 | initialization files, if not inhibited with @samp{-n}). Exit with | |
1040 | nonzero status if an error occurs in executing the @value{GDBN} commands | |
5da1313b JK |
1041 | in the command files. Batch mode also disables pagination, sets unlimited |
1042 | terminal width and height @pxref{Screen Size}, and acts as if @kbd{set confirm | |
1043 | off} were in effect (@pxref{Messages/Warnings}). | |
c906108c | 1044 | |
2df3850c JM |
1045 | Batch mode may be useful for running @value{GDBN} as a filter, for |
1046 | example to download and run a program on another computer; in order to | |
1047 | make this more useful, the message | |
c906108c | 1048 | |
474c8240 | 1049 | @smallexample |
c906108c | 1050 | Program exited normally. |
474c8240 | 1051 | @end smallexample |
c906108c SS |
1052 | |
1053 | @noindent | |
2df3850c JM |
1054 | (which is ordinarily issued whenever a program running under |
1055 | @value{GDBN} control terminates) is not issued when running in batch | |
1056 | mode. | |
1057 | ||
1a088d06 AS |
1058 | @item -batch-silent |
1059 | @cindex @code{--batch-silent} | |
1060 | Run in batch mode exactly like @samp{-batch}, but totally silently. All | |
1061 | @value{GDBN} output to @code{stdout} is prevented (@code{stderr} is | |
1062 | unaffected). This is much quieter than @samp{-silent} and would be useless | |
1063 | for an interactive session. | |
1064 | ||
1065 | This is particularly useful when using targets that give @samp{Loading section} | |
1066 | messages, for example. | |
1067 | ||
1068 | Note that targets that give their output via @value{GDBN}, as opposed to | |
1069 | writing directly to @code{stdout}, will also be made silent. | |
1070 | ||
4b0ad762 AS |
1071 | @item -return-child-result |
1072 | @cindex @code{--return-child-result} | |
1073 | The return code from @value{GDBN} will be the return code from the child | |
1074 | process (the process being debugged), with the following exceptions: | |
1075 | ||
1076 | @itemize @bullet | |
1077 | @item | |
1078 | @value{GDBN} exits abnormally. E.g., due to an incorrect argument or an | |
1079 | internal error. In this case the exit code is the same as it would have been | |
1080 | without @samp{-return-child-result}. | |
1081 | @item | |
1082 | The user quits with an explicit value. E.g., @samp{quit 1}. | |
1083 | @item | |
1084 | The child process never runs, or is not allowed to terminate, in which case | |
1085 | the exit code will be -1. | |
1086 | @end itemize | |
1087 | ||
1088 | This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent}, | |
1089 | when @value{GDBN} is being used as a remote program loader or simulator | |
1090 | interface. | |
1091 | ||
2df3850c JM |
1092 | @item -nowindows |
1093 | @itemx -nw | |
d700128c EZ |
1094 | @cindex @code{--nowindows} |
1095 | @cindex @code{-nw} | |
2df3850c | 1096 | ``No windows''. If @value{GDBN} comes with a graphical user interface |
96a2c332 | 1097 | (GUI) built in, then this option tells @value{GDBN} to only use the command-line |
2df3850c JM |
1098 | interface. If no GUI is available, this option has no effect. |
1099 | ||
1100 | @item -windows | |
1101 | @itemx -w | |
d700128c EZ |
1102 | @cindex @code{--windows} |
1103 | @cindex @code{-w} | |
2df3850c JM |
1104 | If @value{GDBN} includes a GUI, then this option requires it to be |
1105 | used if possible. | |
c906108c SS |
1106 | |
1107 | @item -cd @var{directory} | |
d700128c | 1108 | @cindex @code{--cd} |
c906108c SS |
1109 | Run @value{GDBN} using @var{directory} as its working directory, |
1110 | instead of the current directory. | |
1111 | ||
aae1c79a DE |
1112 | @item -data-directory @var{directory} |
1113 | @cindex @code{--data-directory} | |
1114 | Run @value{GDBN} using @var{directory} as its data directory. | |
1115 | The data directory is where @value{GDBN} searches for its | |
1116 | auxiliary files. @xref{Data Files}. | |
1117 | ||
c906108c SS |
1118 | @item -fullname |
1119 | @itemx -f | |
d700128c EZ |
1120 | @cindex @code{--fullname} |
1121 | @cindex @code{-f} | |
7a292a7a SS |
1122 | @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a |
1123 | subprocess. It tells @value{GDBN} to output the full file name and line | |
1124 | number in a standard, recognizable fashion each time a stack frame is | |
1125 | displayed (which includes each time your program stops). This | |
1126 | recognizable format looks like two @samp{\032} characters, followed by | |
1127 | the file name, line number and character position separated by colons, | |
1128 | and a newline. The Emacs-to-@value{GDBN} interface program uses the two | |
1129 | @samp{\032} characters as a signal to display the source code for the | |
1130 | frame. | |
c906108c | 1131 | |
d700128c EZ |
1132 | @item -epoch |
1133 | @cindex @code{--epoch} | |
1134 | The Epoch Emacs-@value{GDBN} interface sets this option when it runs | |
1135 | @value{GDBN} as a subprocess. It tells @value{GDBN} to modify its print | |
1136 | routines so as to allow Epoch to display values of expressions in a | |
1137 | separate window. | |
1138 | ||
1139 | @item -annotate @var{level} | |
1140 | @cindex @code{--annotate} | |
1141 | This option sets the @dfn{annotation level} inside @value{GDBN}. Its | |
1142 | effect is identical to using @samp{set annotate @var{level}} | |
086432e2 AC |
1143 | (@pxref{Annotations}). The annotation @var{level} controls how much |
1144 | information @value{GDBN} prints together with its prompt, values of | |
1145 | expressions, source lines, and other types of output. Level 0 is the | |
1146 | normal, level 1 is for use when @value{GDBN} is run as a subprocess of | |
1147 | @sc{gnu} Emacs, level 3 is the maximum annotation suitable for programs | |
1148 | that control @value{GDBN}, and level 2 has been deprecated. | |
1149 | ||
265eeb58 | 1150 | The annotation mechanism has largely been superseded by @sc{gdb/mi} |
086432e2 | 1151 | (@pxref{GDB/MI}). |
d700128c | 1152 | |
aa26fa3a TT |
1153 | @item --args |
1154 | @cindex @code{--args} | |
1155 | Change interpretation of command line so that arguments following the | |
1156 | executable file are passed as command line arguments to the inferior. | |
1157 | This option stops option processing. | |
1158 | ||
2df3850c JM |
1159 | @item -baud @var{bps} |
1160 | @itemx -b @var{bps} | |
d700128c EZ |
1161 | @cindex @code{--baud} |
1162 | @cindex @code{-b} | |
c906108c SS |
1163 | Set the line speed (baud rate or bits per second) of any serial |
1164 | interface used by @value{GDBN} for remote debugging. | |
c906108c | 1165 | |
f47b1503 AS |
1166 | @item -l @var{timeout} |
1167 | @cindex @code{-l} | |
1168 | Set the timeout (in seconds) of any communication used by @value{GDBN} | |
1169 | for remote debugging. | |
1170 | ||
c906108c | 1171 | @item -tty @var{device} |
d700128c EZ |
1172 | @itemx -t @var{device} |
1173 | @cindex @code{--tty} | |
1174 | @cindex @code{-t} | |
c906108c SS |
1175 | Run using @var{device} for your program's standard input and output. |
1176 | @c FIXME: kingdon thinks there is more to -tty. Investigate. | |
c906108c | 1177 | |
53a5351d | 1178 | @c resolve the situation of these eventually |
c4555f82 SC |
1179 | @item -tui |
1180 | @cindex @code{--tui} | |
d0d5df6f AC |
1181 | Activate the @dfn{Text User Interface} when starting. The Text User |
1182 | Interface manages several text windows on the terminal, showing | |
1183 | source, assembly, registers and @value{GDBN} command outputs | |
1184 | (@pxref{TUI, ,@value{GDBN} Text User Interface}). Alternatively, the | |
1185 | Text User Interface can be enabled by invoking the program | |
46ba6afa | 1186 | @samp{@value{GDBTUI}}. Do not use this option if you run @value{GDBN} from |
d0d5df6f | 1187 | Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}). |
53a5351d JM |
1188 | |
1189 | @c @item -xdb | |
d700128c | 1190 | @c @cindex @code{--xdb} |
53a5351d JM |
1191 | @c Run in XDB compatibility mode, allowing the use of certain XDB commands. |
1192 | @c For information, see the file @file{xdb_trans.html}, which is usually | |
1193 | @c installed in the directory @code{/opt/langtools/wdb/doc} on HP-UX | |
1194 | @c systems. | |
1195 | ||
d700128c EZ |
1196 | @item -interpreter @var{interp} |
1197 | @cindex @code{--interpreter} | |
1198 | Use the interpreter @var{interp} for interface with the controlling | |
1199 | program or device. This option is meant to be set by programs which | |
94bbb2c0 | 1200 | communicate with @value{GDBN} using it as a back end. |
21c294e6 | 1201 | @xref{Interpreters, , Command Interpreters}. |
94bbb2c0 | 1202 | |
da0f9dcd | 1203 | @samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes |
2fcf52f0 | 1204 | @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, , |
6b5e8c01 | 1205 | The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0. The |
6c74ac8b AC |
1206 | previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and |
1207 | selected with @samp{--interpreter=mi1}, is deprecated. Earlier | |
1208 | @sc{gdb/mi} interfaces are no longer supported. | |
d700128c EZ |
1209 | |
1210 | @item -write | |
1211 | @cindex @code{--write} | |
1212 | Open the executable and core files for both reading and writing. This | |
1213 | is equivalent to the @samp{set write on} command inside @value{GDBN} | |
1214 | (@pxref{Patching}). | |
1215 | ||
1216 | @item -statistics | |
1217 | @cindex @code{--statistics} | |
1218 | This option causes @value{GDBN} to print statistics about time and | |
1219 | memory usage after it completes each command and returns to the prompt. | |
1220 | ||
1221 | @item -version | |
1222 | @cindex @code{--version} | |
1223 | This option causes @value{GDBN} to print its version number and | |
1224 | no-warranty blurb, and exit. | |
1225 | ||
c906108c SS |
1226 | @end table |
1227 | ||
6fc08d32 | 1228 | @node Startup |
79a6e687 | 1229 | @subsection What @value{GDBN} Does During Startup |
6fc08d32 EZ |
1230 | @cindex @value{GDBN} startup |
1231 | ||
1232 | Here's the description of what @value{GDBN} does during session startup: | |
1233 | ||
1234 | @enumerate | |
1235 | @item | |
1236 | Sets up the command interpreter as specified by the command line | |
1237 | (@pxref{Mode Options, interpreter}). | |
1238 | ||
1239 | @item | |
1240 | @cindex init file | |
098b41a6 JG |
1241 | Reads the system-wide @dfn{init file} (if @option{--with-system-gdbinit} was |
1242 | used when building @value{GDBN}; @pxref{System-wide configuration, | |
1243 | ,System-wide configuration and settings}) and executes all the commands in | |
1244 | that file. | |
1245 | ||
1246 | @item | |
1247 | Reads the init file (if any) in your home directory@footnote{On | |
6fc08d32 EZ |
1248 | DOS/Windows systems, the home directory is the one pointed to by the |
1249 | @code{HOME} environment variable.} and executes all the commands in | |
1250 | that file. | |
1251 | ||
1252 | @item | |
1253 | Processes command line options and operands. | |
1254 | ||
1255 | @item | |
1256 | Reads and executes the commands from init file (if any) in the current | |
119b882a EZ |
1257 | working directory. This is only done if the current directory is |
1258 | different from your home directory. Thus, you can have more than one | |
1259 | init file, one generic in your home directory, and another, specific | |
1260 | to the program you are debugging, in the directory where you invoke | |
6fc08d32 EZ |
1261 | @value{GDBN}. |
1262 | ||
a86caf66 DE |
1263 | @item |
1264 | If the command line specified a program to debug, or a process to | |
1265 | attach to, or a core file, @value{GDBN} loads any auto-loaded | |
1266 | scripts provided for the program or for its loaded shared libraries. | |
1267 | @xref{Auto-loading}. | |
1268 | ||
1269 | If you wish to disable the auto-loading during startup, | |
1270 | you must do something like the following: | |
1271 | ||
1272 | @smallexample | |
1273 | $ gdb -ex "set auto-load-scripts off" -ex "file myprogram" | |
1274 | @end smallexample | |
1275 | ||
1276 | The following does not work because the auto-loading is turned off too late: | |
1277 | ||
1278 | @smallexample | |
1279 | $ gdb -ex "set auto-load-scripts off" myprogram | |
1280 | @end smallexample | |
1281 | ||
6fc08d32 EZ |
1282 | @item |
1283 | Reads command files specified by the @samp{-x} option. @xref{Command | |
1284 | Files}, for more details about @value{GDBN} command files. | |
1285 | ||
1286 | @item | |
1287 | Reads the command history recorded in the @dfn{history file}. | |
d620b259 | 1288 | @xref{Command History}, for more details about the command history and the |
6fc08d32 EZ |
1289 | files where @value{GDBN} records it. |
1290 | @end enumerate | |
1291 | ||
1292 | Init files use the same syntax as @dfn{command files} (@pxref{Command | |
1293 | Files}) and are processed by @value{GDBN} in the same way. The init | |
1294 | file in your home directory can set options (such as @samp{set | |
1295 | complaints}) that affect subsequent processing of command line options | |
1296 | and operands. Init files are not executed if you use the @samp{-nx} | |
79a6e687 | 1297 | option (@pxref{Mode Options, ,Choosing Modes}). |
6fc08d32 | 1298 | |
098b41a6 JG |
1299 | To display the list of init files loaded by gdb at startup, you |
1300 | can use @kbd{gdb --help}. | |
1301 | ||
6fc08d32 EZ |
1302 | @cindex init file name |
1303 | @cindex @file{.gdbinit} | |
119b882a | 1304 | @cindex @file{gdb.ini} |
8807d78b | 1305 | The @value{GDBN} init files are normally called @file{.gdbinit}. |
119b882a EZ |
1306 | The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to |
1307 | the limitations of file names imposed by DOS filesystems. The Windows | |
1308 | ports of @value{GDBN} use the standard name, but if they find a | |
1309 | @file{gdb.ini} file, they warn you about that and suggest to rename | |
1310 | the file to the standard name. | |
1311 | ||
6fc08d32 | 1312 | |
6d2ebf8b | 1313 | @node Quitting GDB |
c906108c SS |
1314 | @section Quitting @value{GDBN} |
1315 | @cindex exiting @value{GDBN} | |
1316 | @cindex leaving @value{GDBN} | |
1317 | ||
1318 | @table @code | |
1319 | @kindex quit @r{[}@var{expression}@r{]} | |
41afff9a | 1320 | @kindex q @r{(@code{quit})} |
96a2c332 SS |
1321 | @item quit @r{[}@var{expression}@r{]} |
1322 | @itemx q | |
1323 | To exit @value{GDBN}, use the @code{quit} command (abbreviated | |
c8aa23ab | 1324 | @code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}). If you |
96a2c332 SS |
1325 | do not supply @var{expression}, @value{GDBN} will terminate normally; |
1326 | otherwise it will terminate using the result of @var{expression} as the | |
1327 | error code. | |
c906108c SS |
1328 | @end table |
1329 | ||
1330 | @cindex interrupt | |
c8aa23ab | 1331 | An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather |
c906108c SS |
1332 | terminates the action of any @value{GDBN} command that is in progress and |
1333 | returns to @value{GDBN} command level. It is safe to type the interrupt | |
1334 | character at any time because @value{GDBN} does not allow it to take effect | |
1335 | until a time when it is safe. | |
1336 | ||
c906108c SS |
1337 | If you have been using @value{GDBN} to control an attached process or |
1338 | device, you can release it with the @code{detach} command | |
79a6e687 | 1339 | (@pxref{Attach, ,Debugging an Already-running Process}). |
c906108c | 1340 | |
6d2ebf8b | 1341 | @node Shell Commands |
79a6e687 | 1342 | @section Shell Commands |
c906108c SS |
1343 | |
1344 | If you need to execute occasional shell commands during your | |
1345 | debugging session, there is no need to leave or suspend @value{GDBN}; you can | |
1346 | just use the @code{shell} command. | |
1347 | ||
1348 | @table @code | |
1349 | @kindex shell | |
1350 | @cindex shell escape | |
1351 | @item shell @var{command string} | |
1352 | Invoke a standard shell to execute @var{command string}. | |
c906108c | 1353 | If it exists, the environment variable @code{SHELL} determines which |
d4f3574e SS |
1354 | shell to run. Otherwise @value{GDBN} uses the default shell |
1355 | (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.). | |
c906108c SS |
1356 | @end table |
1357 | ||
1358 | The utility @code{make} is often needed in development environments. | |
1359 | You do not have to use the @code{shell} command for this purpose in | |
1360 | @value{GDBN}: | |
1361 | ||
1362 | @table @code | |
1363 | @kindex make | |
1364 | @cindex calling make | |
1365 | @item make @var{make-args} | |
1366 | Execute the @code{make} program with the specified | |
1367 | arguments. This is equivalent to @samp{shell make @var{make-args}}. | |
1368 | @end table | |
1369 | ||
79a6e687 BW |
1370 | @node Logging Output |
1371 | @section Logging Output | |
0fac0b41 | 1372 | @cindex logging @value{GDBN} output |
9c16f35a | 1373 | @cindex save @value{GDBN} output to a file |
0fac0b41 DJ |
1374 | |
1375 | You may want to save the output of @value{GDBN} commands to a file. | |
1376 | There are several commands to control @value{GDBN}'s logging. | |
1377 | ||
1378 | @table @code | |
1379 | @kindex set logging | |
1380 | @item set logging on | |
1381 | Enable logging. | |
1382 | @item set logging off | |
1383 | Disable logging. | |
9c16f35a | 1384 | @cindex logging file name |
0fac0b41 DJ |
1385 | @item set logging file @var{file} |
1386 | Change the name of the current logfile. The default logfile is @file{gdb.txt}. | |
1387 | @item set logging overwrite [on|off] | |
1388 | By default, @value{GDBN} will append to the logfile. Set @code{overwrite} if | |
1389 | you want @code{set logging on} to overwrite the logfile instead. | |
1390 | @item set logging redirect [on|off] | |
1391 | By default, @value{GDBN} output will go to both the terminal and the logfile. | |
1392 | Set @code{redirect} if you want output to go only to the log file. | |
1393 | @kindex show logging | |
1394 | @item show logging | |
1395 | Show the current values of the logging settings. | |
1396 | @end table | |
1397 | ||
6d2ebf8b | 1398 | @node Commands |
c906108c SS |
1399 | @chapter @value{GDBN} Commands |
1400 | ||
1401 | You can abbreviate a @value{GDBN} command to the first few letters of the command | |
1402 | name, if that abbreviation is unambiguous; and you can repeat certain | |
1403 | @value{GDBN} commands by typing just @key{RET}. You can also use the @key{TAB} | |
1404 | key to get @value{GDBN} to fill out the rest of a word in a command (or to | |
1405 | show you the alternatives available, if there is more than one possibility). | |
1406 | ||
1407 | @menu | |
1408 | * Command Syntax:: How to give commands to @value{GDBN} | |
1409 | * Completion:: Command completion | |
1410 | * Help:: How to ask @value{GDBN} for help | |
1411 | @end menu | |
1412 | ||
6d2ebf8b | 1413 | @node Command Syntax |
79a6e687 | 1414 | @section Command Syntax |
c906108c SS |
1415 | |
1416 | A @value{GDBN} command is a single line of input. There is no limit on | |
1417 | how long it can be. It starts with a command name, which is followed by | |
1418 | arguments whose meaning depends on the command name. For example, the | |
1419 | command @code{step} accepts an argument which is the number of times to | |
1420 | step, as in @samp{step 5}. You can also use the @code{step} command | |
96a2c332 | 1421 | with no arguments. Some commands do not allow any arguments. |
c906108c SS |
1422 | |
1423 | @cindex abbreviation | |
1424 | @value{GDBN} command names may always be truncated if that abbreviation is | |
1425 | unambiguous. Other possible command abbreviations are listed in the | |
1426 | documentation for individual commands. In some cases, even ambiguous | |
1427 | abbreviations are allowed; for example, @code{s} is specially defined as | |
1428 | equivalent to @code{step} even though there are other commands whose | |
1429 | names start with @code{s}. You can test abbreviations by using them as | |
1430 | arguments to the @code{help} command. | |
1431 | ||
1432 | @cindex repeating commands | |
41afff9a | 1433 | @kindex RET @r{(repeat last command)} |
c906108c | 1434 | A blank line as input to @value{GDBN} (typing just @key{RET}) means to |
96a2c332 | 1435 | repeat the previous command. Certain commands (for example, @code{run}) |
c906108c SS |
1436 | will not repeat this way; these are commands whose unintentional |
1437 | repetition might cause trouble and which you are unlikely to want to | |
c45da7e6 EZ |
1438 | repeat. User-defined commands can disable this feature; see |
1439 | @ref{Define, dont-repeat}. | |
c906108c SS |
1440 | |
1441 | The @code{list} and @code{x} commands, when you repeat them with | |
1442 | @key{RET}, construct new arguments rather than repeating | |
1443 | exactly as typed. This permits easy scanning of source or memory. | |
1444 | ||
1445 | @value{GDBN} can also use @key{RET} in another way: to partition lengthy | |
1446 | output, in a way similar to the common utility @code{more} | |
79a6e687 | 1447 | (@pxref{Screen Size,,Screen Size}). Since it is easy to press one |
c906108c SS |
1448 | @key{RET} too many in this situation, @value{GDBN} disables command |
1449 | repetition after any command that generates this sort of display. | |
1450 | ||
41afff9a | 1451 | @kindex # @r{(a comment)} |
c906108c SS |
1452 | @cindex comment |
1453 | Any text from a @kbd{#} to the end of the line is a comment; it does | |
1454 | nothing. This is useful mainly in command files (@pxref{Command | |
79a6e687 | 1455 | Files,,Command Files}). |
c906108c | 1456 | |
88118b3a | 1457 | @cindex repeating command sequences |
c8aa23ab EZ |
1458 | @kindex Ctrl-o @r{(operate-and-get-next)} |
1459 | The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of | |
7f9087cb | 1460 | commands. This command accepts the current line, like @key{RET}, and |
88118b3a TT |
1461 | then fetches the next line relative to the current line from the history |
1462 | for editing. | |
1463 | ||
6d2ebf8b | 1464 | @node Completion |
79a6e687 | 1465 | @section Command Completion |
c906108c SS |
1466 | |
1467 | @cindex completion | |
1468 | @cindex word completion | |
1469 | @value{GDBN} can fill in the rest of a word in a command for you, if there is | |
1470 | only one possibility; it can also show you what the valid possibilities | |
1471 | are for the next word in a command, at any time. This works for @value{GDBN} | |
1472 | commands, @value{GDBN} subcommands, and the names of symbols in your program. | |
1473 | ||
1474 | Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest | |
1475 | of a word. If there is only one possibility, @value{GDBN} fills in the | |
1476 | word, and waits for you to finish the command (or press @key{RET} to | |
1477 | enter it). For example, if you type | |
1478 | ||
1479 | @c FIXME "@key" does not distinguish its argument sufficiently to permit | |
1480 | @c complete accuracy in these examples; space introduced for clarity. | |
1481 | @c If texinfo enhancements make it unnecessary, it would be nice to | |
1482 | @c replace " @key" by "@key" in the following... | |
474c8240 | 1483 | @smallexample |
c906108c | 1484 | (@value{GDBP}) info bre @key{TAB} |
474c8240 | 1485 | @end smallexample |
c906108c SS |
1486 | |
1487 | @noindent | |
1488 | @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is | |
1489 | the only @code{info} subcommand beginning with @samp{bre}: | |
1490 | ||
474c8240 | 1491 | @smallexample |
c906108c | 1492 | (@value{GDBP}) info breakpoints |
474c8240 | 1493 | @end smallexample |
c906108c SS |
1494 | |
1495 | @noindent | |
1496 | You can either press @key{RET} at this point, to run the @code{info | |
1497 | breakpoints} command, or backspace and enter something else, if | |
1498 | @samp{breakpoints} does not look like the command you expected. (If you | |
1499 | were sure you wanted @code{info breakpoints} in the first place, you | |
1500 | might as well just type @key{RET} immediately after @samp{info bre}, | |
1501 | to exploit command abbreviations rather than command completion). | |
1502 | ||
1503 | If there is more than one possibility for the next word when you press | |
1504 | @key{TAB}, @value{GDBN} sounds a bell. You can either supply more | |
1505 | characters and try again, or just press @key{TAB} a second time; | |
1506 | @value{GDBN} displays all the possible completions for that word. For | |
1507 | example, you might want to set a breakpoint on a subroutine whose name | |
1508 | begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN} | |
1509 | just sounds the bell. Typing @key{TAB} again displays all the | |
1510 | function names in your program that begin with those characters, for | |
1511 | example: | |
1512 | ||
474c8240 | 1513 | @smallexample |
c906108c SS |
1514 | (@value{GDBP}) b make_ @key{TAB} |
1515 | @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see: | |
5d161b24 DB |
1516 | make_a_section_from_file make_environ |
1517 | make_abs_section make_function_type | |
1518 | make_blockvector make_pointer_type | |
1519 | make_cleanup make_reference_type | |
c906108c SS |
1520 | make_command make_symbol_completion_list |
1521 | (@value{GDBP}) b make_ | |
474c8240 | 1522 | @end smallexample |
c906108c SS |
1523 | |
1524 | @noindent | |
1525 | After displaying the available possibilities, @value{GDBN} copies your | |
1526 | partial input (@samp{b make_} in the example) so you can finish the | |
1527 | command. | |
1528 | ||
1529 | If you just want to see the list of alternatives in the first place, you | |
b37052ae | 1530 | can press @kbd{M-?} rather than pressing @key{TAB} twice. @kbd{M-?} |
7a292a7a | 1531 | means @kbd{@key{META} ?}. You can type this either by holding down a |
c906108c | 1532 | key designated as the @key{META} shift on your keyboard (if there is |
7a292a7a | 1533 | one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}. |
c906108c SS |
1534 | |
1535 | @cindex quotes in commands | |
1536 | @cindex completion of quoted strings | |
1537 | Sometimes the string you need, while logically a ``word'', may contain | |
7a292a7a SS |
1538 | parentheses or other characters that @value{GDBN} normally excludes from |
1539 | its notion of a word. To permit word completion to work in this | |
1540 | situation, you may enclose words in @code{'} (single quote marks) in | |
1541 | @value{GDBN} commands. | |
c906108c | 1542 | |
c906108c | 1543 | The most likely situation where you might need this is in typing the |
b37052ae EZ |
1544 | name of a C@t{++} function. This is because C@t{++} allows function |
1545 | overloading (multiple definitions of the same function, distinguished | |
1546 | by argument type). For example, when you want to set a breakpoint you | |
1547 | may need to distinguish whether you mean the version of @code{name} | |
1548 | that takes an @code{int} parameter, @code{name(int)}, or the version | |
1549 | that takes a @code{float} parameter, @code{name(float)}. To use the | |
1550 | word-completion facilities in this situation, type a single quote | |
1551 | @code{'} at the beginning of the function name. This alerts | |
1552 | @value{GDBN} that it may need to consider more information than usual | |
1553 | when you press @key{TAB} or @kbd{M-?} to request word completion: | |
c906108c | 1554 | |
474c8240 | 1555 | @smallexample |
96a2c332 | 1556 | (@value{GDBP}) b 'bubble( @kbd{M-?} |
c906108c SS |
1557 | bubble(double,double) bubble(int,int) |
1558 | (@value{GDBP}) b 'bubble( | |
474c8240 | 1559 | @end smallexample |
c906108c SS |
1560 | |
1561 | In some cases, @value{GDBN} can tell that completing a name requires using | |
1562 | quotes. When this happens, @value{GDBN} inserts the quote for you (while | |
1563 | completing as much as it can) if you do not type the quote in the first | |
1564 | place: | |
1565 | ||
474c8240 | 1566 | @smallexample |
c906108c SS |
1567 | (@value{GDBP}) b bub @key{TAB} |
1568 | @exdent @value{GDBN} alters your input line to the following, and rings a bell: | |
1569 | (@value{GDBP}) b 'bubble( | |
474c8240 | 1570 | @end smallexample |
c906108c SS |
1571 | |
1572 | @noindent | |
1573 | In general, @value{GDBN} can tell that a quote is needed (and inserts it) if | |
1574 | you have not yet started typing the argument list when you ask for | |
1575 | completion on an overloaded symbol. | |
1576 | ||
79a6e687 BW |
1577 | For more information about overloaded functions, see @ref{C Plus Plus |
1578 | Expressions, ,C@t{++} Expressions}. You can use the command @code{set | |
c906108c | 1579 | overload-resolution off} to disable overload resolution; |
79a6e687 | 1580 | see @ref{Debugging C Plus Plus, ,@value{GDBN} Features for C@t{++}}. |
c906108c | 1581 | |
65d12d83 TT |
1582 | @cindex completion of structure field names |
1583 | @cindex structure field name completion | |
1584 | @cindex completion of union field names | |
1585 | @cindex union field name completion | |
1586 | When completing in an expression which looks up a field in a | |
1587 | structure, @value{GDBN} also tries@footnote{The completer can be | |
1588 | confused by certain kinds of invalid expressions. Also, it only | |
1589 | examines the static type of the expression, not the dynamic type.} to | |
1590 | limit completions to the field names available in the type of the | |
1591 | left-hand-side: | |
1592 | ||
1593 | @smallexample | |
1594 | (@value{GDBP}) p gdb_stdout.@kbd{M-?} | |
01124a23 DE |
1595 | magic to_fputs to_rewind |
1596 | to_data to_isatty to_write | |
1597 | to_delete to_put to_write_async_safe | |
1598 | to_flush to_read | |
65d12d83 TT |
1599 | @end smallexample |
1600 | ||
1601 | @noindent | |
1602 | This is because the @code{gdb_stdout} is a variable of the type | |
1603 | @code{struct ui_file} that is defined in @value{GDBN} sources as | |
1604 | follows: | |
1605 | ||
1606 | @smallexample | |
1607 | struct ui_file | |
1608 | @{ | |
1609 | int *magic; | |
1610 | ui_file_flush_ftype *to_flush; | |
1611 | ui_file_write_ftype *to_write; | |
01124a23 | 1612 | ui_file_write_async_safe_ftype *to_write_async_safe; |
65d12d83 TT |
1613 | ui_file_fputs_ftype *to_fputs; |
1614 | ui_file_read_ftype *to_read; | |
1615 | ui_file_delete_ftype *to_delete; | |
1616 | ui_file_isatty_ftype *to_isatty; | |
1617 | ui_file_rewind_ftype *to_rewind; | |
1618 | ui_file_put_ftype *to_put; | |
1619 | void *to_data; | |
1620 | @} | |
1621 | @end smallexample | |
1622 | ||
c906108c | 1623 | |
6d2ebf8b | 1624 | @node Help |
79a6e687 | 1625 | @section Getting Help |
c906108c SS |
1626 | @cindex online documentation |
1627 | @kindex help | |
1628 | ||
5d161b24 | 1629 | You can always ask @value{GDBN} itself for information on its commands, |
c906108c SS |
1630 | using the command @code{help}. |
1631 | ||
1632 | @table @code | |
41afff9a | 1633 | @kindex h @r{(@code{help})} |
c906108c SS |
1634 | @item help |
1635 | @itemx h | |
1636 | You can use @code{help} (abbreviated @code{h}) with no arguments to | |
1637 | display a short list of named classes of commands: | |
1638 | ||
1639 | @smallexample | |
1640 | (@value{GDBP}) help | |
1641 | List of classes of commands: | |
1642 | ||
2df3850c | 1643 | aliases -- Aliases of other commands |
c906108c | 1644 | breakpoints -- Making program stop at certain points |
2df3850c | 1645 | data -- Examining data |
c906108c | 1646 | files -- Specifying and examining files |
2df3850c JM |
1647 | internals -- Maintenance commands |
1648 | obscure -- Obscure features | |
1649 | running -- Running the program | |
1650 | stack -- Examining the stack | |
c906108c SS |
1651 | status -- Status inquiries |
1652 | support -- Support facilities | |
12c27660 | 1653 | tracepoints -- Tracing of program execution without |
96a2c332 | 1654 | stopping the program |
c906108c | 1655 | user-defined -- User-defined commands |
c906108c | 1656 | |
5d161b24 | 1657 | Type "help" followed by a class name for a list of |
c906108c | 1658 | commands in that class. |
5d161b24 | 1659 | Type "help" followed by command name for full |
c906108c SS |
1660 | documentation. |
1661 | Command name abbreviations are allowed if unambiguous. | |
1662 | (@value{GDBP}) | |
1663 | @end smallexample | |
96a2c332 | 1664 | @c the above line break eliminates huge line overfull... |
c906108c SS |
1665 | |
1666 | @item help @var{class} | |
1667 | Using one of the general help classes as an argument, you can get a | |
1668 | list of the individual commands in that class. For example, here is the | |
1669 | help display for the class @code{status}: | |
1670 | ||
1671 | @smallexample | |
1672 | (@value{GDBP}) help status | |
1673 | Status inquiries. | |
1674 | ||
1675 | List of commands: | |
1676 | ||
1677 | @c Line break in "show" line falsifies real output, but needed | |
1678 | @c to fit in smallbook page size. | |
2df3850c | 1679 | info -- Generic command for showing things |
12c27660 | 1680 | about the program being debugged |
2df3850c | 1681 | show -- Generic command for showing things |
12c27660 | 1682 | about the debugger |
c906108c | 1683 | |
5d161b24 | 1684 | Type "help" followed by command name for full |
c906108c SS |
1685 | documentation. |
1686 | Command name abbreviations are allowed if unambiguous. | |
1687 | (@value{GDBP}) | |
1688 | @end smallexample | |
1689 | ||
1690 | @item help @var{command} | |
1691 | With a command name as @code{help} argument, @value{GDBN} displays a | |
1692 | short paragraph on how to use that command. | |
1693 | ||
6837a0a2 DB |
1694 | @kindex apropos |
1695 | @item apropos @var{args} | |
09d4efe1 | 1696 | The @code{apropos} command searches through all of the @value{GDBN} |
6837a0a2 | 1697 | commands, and their documentation, for the regular expression specified in |
99e008fe | 1698 | @var{args}. It prints out all matches found. For example: |
6837a0a2 DB |
1699 | |
1700 | @smallexample | |
1701 | apropos reload | |
1702 | @end smallexample | |
1703 | ||
b37052ae EZ |
1704 | @noindent |
1705 | results in: | |
6837a0a2 DB |
1706 | |
1707 | @smallexample | |
6d2ebf8b SS |
1708 | @c @group |
1709 | set symbol-reloading -- Set dynamic symbol table reloading | |
12c27660 | 1710 | multiple times in one run |
6d2ebf8b | 1711 | show symbol-reloading -- Show dynamic symbol table reloading |
12c27660 | 1712 | multiple times in one run |
6d2ebf8b | 1713 | @c @end group |
6837a0a2 DB |
1714 | @end smallexample |
1715 | ||
c906108c SS |
1716 | @kindex complete |
1717 | @item complete @var{args} | |
1718 | The @code{complete @var{args}} command lists all the possible completions | |
1719 | for the beginning of a command. Use @var{args} to specify the beginning of the | |
1720 | command you want completed. For example: | |
1721 | ||
1722 | @smallexample | |
1723 | complete i | |
1724 | @end smallexample | |
1725 | ||
1726 | @noindent results in: | |
1727 | ||
1728 | @smallexample | |
1729 | @group | |
2df3850c JM |
1730 | if |
1731 | ignore | |
c906108c SS |
1732 | info |
1733 | inspect | |
c906108c SS |
1734 | @end group |
1735 | @end smallexample | |
1736 | ||
1737 | @noindent This is intended for use by @sc{gnu} Emacs. | |
1738 | @end table | |
1739 | ||
1740 | In addition to @code{help}, you can use the @value{GDBN} commands @code{info} | |
1741 | and @code{show} to inquire about the state of your program, or the state | |
1742 | of @value{GDBN} itself. Each command supports many topics of inquiry; this | |
1743 | manual introduces each of them in the appropriate context. The listings | |
1744 | under @code{info} and under @code{show} in the Index point to | |
1745 | all the sub-commands. @xref{Index}. | |
1746 | ||
1747 | @c @group | |
1748 | @table @code | |
1749 | @kindex info | |
41afff9a | 1750 | @kindex i @r{(@code{info})} |
c906108c SS |
1751 | @item info |
1752 | This command (abbreviated @code{i}) is for describing the state of your | |
cda4ce5a | 1753 | program. For example, you can show the arguments passed to a function |
c906108c SS |
1754 | with @code{info args}, list the registers currently in use with @code{info |
1755 | registers}, or list the breakpoints you have set with @code{info breakpoints}. | |
1756 | You can get a complete list of the @code{info} sub-commands with | |
1757 | @w{@code{help info}}. | |
1758 | ||
1759 | @kindex set | |
1760 | @item set | |
5d161b24 | 1761 | You can assign the result of an expression to an environment variable with |
c906108c SS |
1762 | @code{set}. For example, you can set the @value{GDBN} prompt to a $-sign with |
1763 | @code{set prompt $}. | |
1764 | ||
1765 | @kindex show | |
1766 | @item show | |
5d161b24 | 1767 | In contrast to @code{info}, @code{show} is for describing the state of |
c906108c SS |
1768 | @value{GDBN} itself. |
1769 | You can change most of the things you can @code{show}, by using the | |
1770 | related command @code{set}; for example, you can control what number | |
1771 | system is used for displays with @code{set radix}, or simply inquire | |
1772 | which is currently in use with @code{show radix}. | |
1773 | ||
1774 | @kindex info set | |
1775 | To display all the settable parameters and their current | |
1776 | values, you can use @code{show} with no arguments; you may also use | |
1777 | @code{info set}. Both commands produce the same display. | |
1778 | @c FIXME: "info set" violates the rule that "info" is for state of | |
1779 | @c FIXME...program. Ck w/ GNU: "info set" to be called something else, | |
1780 | @c FIXME...or change desc of rule---eg "state of prog and debugging session"? | |
1781 | @end table | |
1782 | @c @end group | |
1783 | ||
1784 | Here are three miscellaneous @code{show} subcommands, all of which are | |
1785 | exceptional in lacking corresponding @code{set} commands: | |
1786 | ||
1787 | @table @code | |
1788 | @kindex show version | |
9c16f35a | 1789 | @cindex @value{GDBN} version number |
c906108c SS |
1790 | @item show version |
1791 | Show what version of @value{GDBN} is running. You should include this | |
2df3850c JM |
1792 | information in @value{GDBN} bug-reports. If multiple versions of |
1793 | @value{GDBN} are in use at your site, you may need to determine which | |
1794 | version of @value{GDBN} you are running; as @value{GDBN} evolves, new | |
1795 | commands are introduced, and old ones may wither away. Also, many | |
1796 | system vendors ship variant versions of @value{GDBN}, and there are | |
96a2c332 | 1797 | variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well. |
2df3850c JM |
1798 | The version number is the same as the one announced when you start |
1799 | @value{GDBN}. | |
c906108c SS |
1800 | |
1801 | @kindex show copying | |
09d4efe1 | 1802 | @kindex info copying |
9c16f35a | 1803 | @cindex display @value{GDBN} copyright |
c906108c | 1804 | @item show copying |
09d4efe1 | 1805 | @itemx info copying |
c906108c SS |
1806 | Display information about permission for copying @value{GDBN}. |
1807 | ||
1808 | @kindex show warranty | |
09d4efe1 | 1809 | @kindex info warranty |
c906108c | 1810 | @item show warranty |
09d4efe1 | 1811 | @itemx info warranty |
2df3850c | 1812 | Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty, |
96a2c332 | 1813 | if your version of @value{GDBN} comes with one. |
2df3850c | 1814 | |
c906108c SS |
1815 | @end table |
1816 | ||
6d2ebf8b | 1817 | @node Running |
c906108c SS |
1818 | @chapter Running Programs Under @value{GDBN} |
1819 | ||
1820 | When you run a program under @value{GDBN}, you must first generate | |
1821 | debugging information when you compile it. | |
7a292a7a SS |
1822 | |
1823 | You may start @value{GDBN} with its arguments, if any, in an environment | |
1824 | of your choice. If you are doing native debugging, you may redirect | |
1825 | your program's input and output, debug an already running process, or | |
1826 | kill a child process. | |
c906108c SS |
1827 | |
1828 | @menu | |
1829 | * Compilation:: Compiling for debugging | |
1830 | * Starting:: Starting your program | |
c906108c SS |
1831 | * Arguments:: Your program's arguments |
1832 | * Environment:: Your program's environment | |
c906108c SS |
1833 | |
1834 | * Working Directory:: Your program's working directory | |
1835 | * Input/Output:: Your program's input and output | |
1836 | * Attach:: Debugging an already-running process | |
1837 | * Kill Process:: Killing the child process | |
c906108c | 1838 | |
6c95b8df | 1839 | * Inferiors and Programs:: Debugging multiple inferiors and programs |
c906108c | 1840 | * Threads:: Debugging programs with multiple threads |
6c95b8df | 1841 | * Forks:: Debugging forks |
5c95884b | 1842 | * Checkpoint/Restart:: Setting a @emph{bookmark} to return to later |
c906108c SS |
1843 | @end menu |
1844 | ||
6d2ebf8b | 1845 | @node Compilation |
79a6e687 | 1846 | @section Compiling for Debugging |
c906108c SS |
1847 | |
1848 | In order to debug a program effectively, you need to generate | |
1849 | debugging information when you compile it. This debugging information | |
1850 | is stored in the object file; it describes the data type of each | |
1851 | variable or function and the correspondence between source line numbers | |
1852 | and addresses in the executable code. | |
1853 | ||
1854 | To request debugging information, specify the @samp{-g} option when you run | |
1855 | the compiler. | |
1856 | ||
514c4d71 | 1857 | Programs that are to be shipped to your customers are compiled with |
edb3359d | 1858 | optimizations, using the @samp{-O} compiler option. However, some |
514c4d71 EZ |
1859 | compilers are unable to handle the @samp{-g} and @samp{-O} options |
1860 | together. Using those compilers, you cannot generate optimized | |
c906108c SS |
1861 | executables containing debugging information. |
1862 | ||
514c4d71 | 1863 | @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or |
53a5351d JM |
1864 | without @samp{-O}, making it possible to debug optimized code. We |
1865 | recommend that you @emph{always} use @samp{-g} whenever you compile a | |
1866 | program. You may think your program is correct, but there is no sense | |
edb3359d | 1867 | in pushing your luck. For more information, see @ref{Optimized Code}. |
c906108c SS |
1868 | |
1869 | Older versions of the @sc{gnu} C compiler permitted a variant option | |
1870 | @w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this | |
1871 | format; if your @sc{gnu} C compiler has this option, do not use it. | |
1872 | ||
514c4d71 EZ |
1873 | @value{GDBN} knows about preprocessor macros and can show you their |
1874 | expansion (@pxref{Macros}). Most compilers do not include information | |
1875 | about preprocessor macros in the debugging information if you specify | |
1876 | the @option{-g} flag alone, because this information is rather large. | |
1877 | Version 3.1 and later of @value{NGCC}, the @sc{gnu} C compiler, | |
1878 | provides macro information if you specify the options | |
1879 | @option{-gdwarf-2} and @option{-g3}; the former option requests | |
1880 | debugging information in the Dwarf 2 format, and the latter requests | |
1881 | ``extra information''. In the future, we hope to find more compact | |
1882 | ways to represent macro information, so that it can be included with | |
1883 | @option{-g} alone. | |
1884 | ||
c906108c | 1885 | @need 2000 |
6d2ebf8b | 1886 | @node Starting |
79a6e687 | 1887 | @section Starting your Program |
c906108c SS |
1888 | @cindex starting |
1889 | @cindex running | |
1890 | ||
1891 | @table @code | |
1892 | @kindex run | |
41afff9a | 1893 | @kindex r @r{(@code{run})} |
c906108c SS |
1894 | @item run |
1895 | @itemx r | |
7a292a7a SS |
1896 | Use the @code{run} command to start your program under @value{GDBN}. |
1897 | You must first specify the program name (except on VxWorks) with an | |
1898 | argument to @value{GDBN} (@pxref{Invocation, ,Getting In and Out of | |
1899 | @value{GDBN}}), or by using the @code{file} or @code{exec-file} command | |
79a6e687 | 1900 | (@pxref{Files, ,Commands to Specify Files}). |
c906108c SS |
1901 | |
1902 | @end table | |
1903 | ||
c906108c SS |
1904 | If you are running your program in an execution environment that |
1905 | supports processes, @code{run} creates an inferior process and makes | |
8edfe269 DJ |
1906 | that process run your program. In some environments without processes, |
1907 | @code{run} jumps to the start of your program. Other targets, | |
1908 | like @samp{remote}, are always running. If you get an error | |
1909 | message like this one: | |
1910 | ||
1911 | @smallexample | |
1912 | The "remote" target does not support "run". | |
1913 | Try "help target" or "continue". | |
1914 | @end smallexample | |
1915 | ||
1916 | @noindent | |
1917 | then use @code{continue} to run your program. You may need @code{load} | |
1918 | first (@pxref{load}). | |
c906108c SS |
1919 | |
1920 | The execution of a program is affected by certain information it | |
1921 | receives from its superior. @value{GDBN} provides ways to specify this | |
1922 | information, which you must do @emph{before} starting your program. (You | |
1923 | can change it after starting your program, but such changes only affect | |
1924 | your program the next time you start it.) This information may be | |
1925 | divided into four categories: | |
1926 | ||
1927 | @table @asis | |
1928 | @item The @emph{arguments.} | |
1929 | Specify the arguments to give your program as the arguments of the | |
1930 | @code{run} command. If a shell is available on your target, the shell | |
1931 | is used to pass the arguments, so that you may use normal conventions | |
1932 | (such as wildcard expansion or variable substitution) in describing | |
1933 | the arguments. | |
1934 | In Unix systems, you can control which shell is used with the | |
1935 | @code{SHELL} environment variable. | |
79a6e687 | 1936 | @xref{Arguments, ,Your Program's Arguments}. |
c906108c SS |
1937 | |
1938 | @item The @emph{environment.} | |
1939 | Your program normally inherits its environment from @value{GDBN}, but you can | |
1940 | use the @value{GDBN} commands @code{set environment} and @code{unset | |
1941 | environment} to change parts of the environment that affect | |
79a6e687 | 1942 | your program. @xref{Environment, ,Your Program's Environment}. |
c906108c SS |
1943 | |
1944 | @item The @emph{working directory.} | |
1945 | Your program inherits its working directory from @value{GDBN}. You can set | |
1946 | the @value{GDBN} working directory with the @code{cd} command in @value{GDBN}. | |
79a6e687 | 1947 | @xref{Working Directory, ,Your Program's Working Directory}. |
c906108c SS |
1948 | |
1949 | @item The @emph{standard input and output.} | |
1950 | Your program normally uses the same device for standard input and | |
1951 | standard output as @value{GDBN} is using. You can redirect input and output | |
1952 | in the @code{run} command line, or you can use the @code{tty} command to | |
1953 | set a different device for your program. | |
79a6e687 | 1954 | @xref{Input/Output, ,Your Program's Input and Output}. |
c906108c SS |
1955 | |
1956 | @cindex pipes | |
1957 | @emph{Warning:} While input and output redirection work, you cannot use | |
1958 | pipes to pass the output of the program you are debugging to another | |
1959 | program; if you attempt this, @value{GDBN} is likely to wind up debugging the | |
1960 | wrong program. | |
1961 | @end table | |
c906108c SS |
1962 | |
1963 | When you issue the @code{run} command, your program begins to execute | |
79a6e687 | 1964 | immediately. @xref{Stopping, ,Stopping and Continuing}, for discussion |
c906108c SS |
1965 | of how to arrange for your program to stop. Once your program has |
1966 | stopped, you may call functions in your program, using the @code{print} | |
1967 | or @code{call} commands. @xref{Data, ,Examining Data}. | |
1968 | ||
1969 | If the modification time of your symbol file has changed since the last | |
1970 | time @value{GDBN} read its symbols, @value{GDBN} discards its symbol | |
1971 | table, and reads it again. When it does this, @value{GDBN} tries to retain | |
1972 | your current breakpoints. | |
1973 | ||
4e8b0763 JB |
1974 | @table @code |
1975 | @kindex start | |
1976 | @item start | |
1977 | @cindex run to main procedure | |
1978 | The name of the main procedure can vary from language to language. | |
1979 | With C or C@t{++}, the main procedure name is always @code{main}, but | |
1980 | other languages such as Ada do not require a specific name for their | |
1981 | main procedure. The debugger provides a convenient way to start the | |
1982 | execution of the program and to stop at the beginning of the main | |
1983 | procedure, depending on the language used. | |
1984 | ||
1985 | The @samp{start} command does the equivalent of setting a temporary | |
1986 | breakpoint at the beginning of the main procedure and then invoking | |
1987 | the @samp{run} command. | |
1988 | ||
f018e82f EZ |
1989 | @cindex elaboration phase |
1990 | Some programs contain an @dfn{elaboration} phase where some startup code is | |
1991 | executed before the main procedure is called. This depends on the | |
1992 | languages used to write your program. In C@t{++}, for instance, | |
4e8b0763 JB |
1993 | constructors for static and global objects are executed before |
1994 | @code{main} is called. It is therefore possible that the debugger stops | |
1995 | before reaching the main procedure. However, the temporary breakpoint | |
1996 | will remain to halt execution. | |
1997 | ||
1998 | Specify the arguments to give to your program as arguments to the | |
1999 | @samp{start} command. These arguments will be given verbatim to the | |
2000 | underlying @samp{run} command. Note that the same arguments will be | |
2001 | reused if no argument is provided during subsequent calls to | |
2002 | @samp{start} or @samp{run}. | |
2003 | ||
2004 | It is sometimes necessary to debug the program during elaboration. In | |
2005 | these cases, using the @code{start} command would stop the execution of | |
2006 | your program too late, as the program would have already completed the | |
2007 | elaboration phase. Under these circumstances, insert breakpoints in your | |
2008 | elaboration code before running your program. | |
ccd213ac DJ |
2009 | |
2010 | @kindex set exec-wrapper | |
2011 | @item set exec-wrapper @var{wrapper} | |
2012 | @itemx show exec-wrapper | |
2013 | @itemx unset exec-wrapper | |
2014 | When @samp{exec-wrapper} is set, the specified wrapper is used to | |
2015 | launch programs for debugging. @value{GDBN} starts your program | |
2016 | with a shell command of the form @kbd{exec @var{wrapper} | |
2017 | @var{program}}. Quoting is added to @var{program} and its | |
2018 | arguments, but not to @var{wrapper}, so you should add quotes if | |
2019 | appropriate for your shell. The wrapper runs until it executes | |
2020 | your program, and then @value{GDBN} takes control. | |
2021 | ||
2022 | You can use any program that eventually calls @code{execve} with | |
2023 | its arguments as a wrapper. Several standard Unix utilities do | |
2024 | this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending | |
2025 | with @code{exec "$@@"} will also work. | |
2026 | ||
2027 | For example, you can use @code{env} to pass an environment variable to | |
2028 | the debugged program, without setting the variable in your shell's | |
2029 | environment: | |
2030 | ||
2031 | @smallexample | |
2032 | (@value{GDBP}) set exec-wrapper env 'LD_PRELOAD=libtest.so' | |
2033 | (@value{GDBP}) run | |
2034 | @end smallexample | |
2035 | ||
2036 | This command is available when debugging locally on most targets, excluding | |
2037 | @sc{djgpp}, Cygwin, MS Windows, and QNX Neutrino. | |
2038 | ||
10568435 JK |
2039 | @kindex set disable-randomization |
2040 | @item set disable-randomization | |
2041 | @itemx set disable-randomization on | |
2042 | This option (enabled by default in @value{GDBN}) will turn off the native | |
2043 | randomization of the virtual address space of the started program. This option | |
2044 | is useful for multiple debugging sessions to make the execution better | |
2045 | reproducible and memory addresses reusable across debugging sessions. | |
2046 | ||
2047 | This feature is implemented only on @sc{gnu}/Linux. You can get the same | |
2048 | behavior using | |
2049 | ||
2050 | @smallexample | |
2051 | (@value{GDBP}) set exec-wrapper setarch `uname -m` -R | |
2052 | @end smallexample | |
2053 | ||
2054 | @item set disable-randomization off | |
2055 | Leave the behavior of the started executable unchanged. Some bugs rear their | |
2056 | ugly heads only when the program is loaded at certain addresses. If your bug | |
2057 | disappears when you run the program under @value{GDBN}, that might be because | |
2058 | @value{GDBN} by default disables the address randomization on platforms, such | |
2059 | as @sc{gnu}/Linux, which do that for stand-alone programs. Use @kbd{set | |
2060 | disable-randomization off} to try to reproduce such elusive bugs. | |
2061 | ||
2062 | The virtual address space randomization is implemented only on @sc{gnu}/Linux. | |
2063 | It protects the programs against some kinds of security attacks. In these | |
2064 | cases the attacker needs to know the exact location of a concrete executable | |
2065 | code. Randomizing its location makes it impossible to inject jumps misusing | |
2066 | a code at its expected addresses. | |
2067 | ||
2068 | Prelinking shared libraries provides a startup performance advantage but it | |
2069 | makes addresses in these libraries predictable for privileged processes by | |
2070 | having just unprivileged access at the target system. Reading the shared | |
2071 | library binary gives enough information for assembling the malicious code | |
2072 | misusing it. Still even a prelinked shared library can get loaded at a new | |
2073 | random address just requiring the regular relocation process during the | |
2074 | startup. Shared libraries not already prelinked are always loaded at | |
2075 | a randomly chosen address. | |
2076 | ||
2077 | Position independent executables (PIE) contain position independent code | |
2078 | similar to the shared libraries and therefore such executables get loaded at | |
2079 | a randomly chosen address upon startup. PIE executables always load even | |
2080 | already prelinked shared libraries at a random address. You can build such | |
2081 | executable using @command{gcc -fPIE -pie}. | |
2082 | ||
2083 | Heap (malloc storage), stack and custom mmap areas are always placed randomly | |
2084 | (as long as the randomization is enabled). | |
2085 | ||
2086 | @item show disable-randomization | |
2087 | Show the current setting of the explicit disable of the native randomization of | |
2088 | the virtual address space of the started program. | |
2089 | ||
4e8b0763 JB |
2090 | @end table |
2091 | ||
6d2ebf8b | 2092 | @node Arguments |
79a6e687 | 2093 | @section Your Program's Arguments |
c906108c SS |
2094 | |
2095 | @cindex arguments (to your program) | |
2096 | The arguments to your program can be specified by the arguments of the | |
5d161b24 | 2097 | @code{run} command. |
c906108c SS |
2098 | They are passed to a shell, which expands wildcard characters and |
2099 | performs redirection of I/O, and thence to your program. Your | |
2100 | @code{SHELL} environment variable (if it exists) specifies what shell | |
2101 | @value{GDBN} uses. If you do not define @code{SHELL}, @value{GDBN} uses | |
d4f3574e SS |
2102 | the default shell (@file{/bin/sh} on Unix). |
2103 | ||
2104 | On non-Unix systems, the program is usually invoked directly by | |
2105 | @value{GDBN}, which emulates I/O redirection via the appropriate system | |
2106 | calls, and the wildcard characters are expanded by the startup code of | |
2107 | the program, not by the shell. | |
c906108c SS |
2108 | |
2109 | @code{run} with no arguments uses the same arguments used by the previous | |
2110 | @code{run}, or those set by the @code{set args} command. | |
2111 | ||
c906108c | 2112 | @table @code |
41afff9a | 2113 | @kindex set args |
c906108c SS |
2114 | @item set args |
2115 | Specify the arguments to be used the next time your program is run. If | |
2116 | @code{set args} has no arguments, @code{run} executes your program | |
2117 | with no arguments. Once you have run your program with arguments, | |
2118 | using @code{set args} before the next @code{run} is the only way to run | |
2119 | it again without arguments. | |
2120 | ||
2121 | @kindex show args | |
2122 | @item show args | |
2123 | Show the arguments to give your program when it is started. | |
2124 | @end table | |
2125 | ||
6d2ebf8b | 2126 | @node Environment |
79a6e687 | 2127 | @section Your Program's Environment |
c906108c SS |
2128 | |
2129 | @cindex environment (of your program) | |
2130 | The @dfn{environment} consists of a set of environment variables and | |
2131 | their values. Environment variables conventionally record such things as | |
2132 | your user name, your home directory, your terminal type, and your search | |
2133 | path for programs to run. Usually you set up environment variables with | |
2134 | the shell and they are inherited by all the other programs you run. When | |
2135 | debugging, it can be useful to try running your program with a modified | |
2136 | environment without having to start @value{GDBN} over again. | |
2137 | ||
2138 | @table @code | |
2139 | @kindex path | |
2140 | @item path @var{directory} | |
2141 | Add @var{directory} to the front of the @code{PATH} environment variable | |
17cc6a06 EZ |
2142 | (the search path for executables) that will be passed to your program. |
2143 | The value of @code{PATH} used by @value{GDBN} does not change. | |
d4f3574e SS |
2144 | You may specify several directory names, separated by whitespace or by a |
2145 | system-dependent separator character (@samp{:} on Unix, @samp{;} on | |
2146 | MS-DOS and MS-Windows). If @var{directory} is already in the path, it | |
2147 | is moved to the front, so it is searched sooner. | |
c906108c SS |
2148 | |
2149 | You can use the string @samp{$cwd} to refer to whatever is the current | |
2150 | working directory at the time @value{GDBN} searches the path. If you | |
2151 | use @samp{.} instead, it refers to the directory where you executed the | |
2152 | @code{path} command. @value{GDBN} replaces @samp{.} in the | |
2153 | @var{directory} argument (with the current path) before adding | |
2154 | @var{directory} to the search path. | |
2155 | @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to | |
2156 | @c document that, since repeating it would be a no-op. | |
2157 | ||
2158 | @kindex show paths | |
2159 | @item show paths | |
2160 | Display the list of search paths for executables (the @code{PATH} | |
2161 | environment variable). | |
2162 | ||
2163 | @kindex show environment | |
2164 | @item show environment @r{[}@var{varname}@r{]} | |
2165 | Print the value of environment variable @var{varname} to be given to | |
2166 | your program when it starts. If you do not supply @var{varname}, | |
2167 | print the names and values of all environment variables to be given to | |
2168 | your program. You can abbreviate @code{environment} as @code{env}. | |
2169 | ||
2170 | @kindex set environment | |
53a5351d | 2171 | @item set environment @var{varname} @r{[}=@var{value}@r{]} |
c906108c SS |
2172 | Set environment variable @var{varname} to @var{value}. The value |
2173 | changes for your program only, not for @value{GDBN} itself. @var{value} may | |
2174 | be any string; the values of environment variables are just strings, and | |
2175 | any interpretation is supplied by your program itself. The @var{value} | |
2176 | parameter is optional; if it is eliminated, the variable is set to a | |
2177 | null value. | |
2178 | @c "any string" here does not include leading, trailing | |
2179 | @c blanks. Gnu asks: does anyone care? | |
2180 | ||
2181 | For example, this command: | |
2182 | ||
474c8240 | 2183 | @smallexample |
c906108c | 2184 | set env USER = foo |
474c8240 | 2185 | @end smallexample |
c906108c SS |
2186 | |
2187 | @noindent | |
d4f3574e | 2188 | tells the debugged program, when subsequently run, that its user is named |
c906108c SS |
2189 | @samp{foo}. (The spaces around @samp{=} are used for clarity here; they |
2190 | are not actually required.) | |
2191 | ||
2192 | @kindex unset environment | |
2193 | @item unset environment @var{varname} | |
2194 | Remove variable @var{varname} from the environment to be passed to your | |
2195 | program. This is different from @samp{set env @var{varname} =}; | |
2196 | @code{unset environment} removes the variable from the environment, | |
2197 | rather than assigning it an empty value. | |
2198 | @end table | |
2199 | ||
d4f3574e SS |
2200 | @emph{Warning:} On Unix systems, @value{GDBN} runs your program using |
2201 | the shell indicated | |
c906108c SS |
2202 | by your @code{SHELL} environment variable if it exists (or |
2203 | @code{/bin/sh} if not). If your @code{SHELL} variable names a shell | |
2204 | that runs an initialization file---such as @file{.cshrc} for C-shell, or | |
2205 | @file{.bashrc} for BASH---any variables you set in that file affect | |
2206 | your program. You may wish to move setting of environment variables to | |
2207 | files that are only run when you sign on, such as @file{.login} or | |
2208 | @file{.profile}. | |
2209 | ||
6d2ebf8b | 2210 | @node Working Directory |
79a6e687 | 2211 | @section Your Program's Working Directory |
c906108c SS |
2212 | |
2213 | @cindex working directory (of your program) | |
2214 | Each time you start your program with @code{run}, it inherits its | |
2215 | working directory from the current working directory of @value{GDBN}. | |
2216 | The @value{GDBN} working directory is initially whatever it inherited | |
2217 | from its parent process (typically the shell), but you can specify a new | |
2218 | working directory in @value{GDBN} with the @code{cd} command. | |
2219 | ||
2220 | The @value{GDBN} working directory also serves as a default for the commands | |
2221 | that specify files for @value{GDBN} to operate on. @xref{Files, ,Commands to | |
79a6e687 | 2222 | Specify Files}. |
c906108c SS |
2223 | |
2224 | @table @code | |
2225 | @kindex cd | |
721c2651 | 2226 | @cindex change working directory |
c906108c SS |
2227 | @item cd @var{directory} |
2228 | Set the @value{GDBN} working directory to @var{directory}. | |
2229 | ||
2230 | @kindex pwd | |
2231 | @item pwd | |
2232 | Print the @value{GDBN} working directory. | |
2233 | @end table | |
2234 | ||
60bf7e09 EZ |
2235 | It is generally impossible to find the current working directory of |
2236 | the process being debugged (since a program can change its directory | |
2237 | during its run). If you work on a system where @value{GDBN} is | |
2238 | configured with the @file{/proc} support, you can use the @code{info | |
2239 | proc} command (@pxref{SVR4 Process Information}) to find out the | |
2240 | current working directory of the debuggee. | |
2241 | ||
6d2ebf8b | 2242 | @node Input/Output |
79a6e687 | 2243 | @section Your Program's Input and Output |
c906108c SS |
2244 | |
2245 | @cindex redirection | |
2246 | @cindex i/o | |
2247 | @cindex terminal | |
2248 | By default, the program you run under @value{GDBN} does input and output to | |
5d161b24 | 2249 | the same terminal that @value{GDBN} uses. @value{GDBN} switches the terminal |
c906108c SS |
2250 | to its own terminal modes to interact with you, but it records the terminal |
2251 | modes your program was using and switches back to them when you continue | |
2252 | running your program. | |
2253 | ||
2254 | @table @code | |
2255 | @kindex info terminal | |
2256 | @item info terminal | |
2257 | Displays information recorded by @value{GDBN} about the terminal modes your | |
2258 | program is using. | |
2259 | @end table | |
2260 | ||
2261 | You can redirect your program's input and/or output using shell | |
2262 | redirection with the @code{run} command. For example, | |
2263 | ||
474c8240 | 2264 | @smallexample |
c906108c | 2265 | run > outfile |
474c8240 | 2266 | @end smallexample |
c906108c SS |
2267 | |
2268 | @noindent | |
2269 | starts your program, diverting its output to the file @file{outfile}. | |
2270 | ||
2271 | @kindex tty | |
2272 | @cindex controlling terminal | |
2273 | Another way to specify where your program should do input and output is | |
2274 | with the @code{tty} command. This command accepts a file name as | |
2275 | argument, and causes this file to be the default for future @code{run} | |
2276 | commands. It also resets the controlling terminal for the child | |
2277 | process, for future @code{run} commands. For example, | |
2278 | ||
474c8240 | 2279 | @smallexample |
c906108c | 2280 | tty /dev/ttyb |
474c8240 | 2281 | @end smallexample |
c906108c SS |
2282 | |
2283 | @noindent | |
2284 | directs that processes started with subsequent @code{run} commands | |
2285 | default to do input and output on the terminal @file{/dev/ttyb} and have | |
2286 | that as their controlling terminal. | |
2287 | ||
2288 | An explicit redirection in @code{run} overrides the @code{tty} command's | |
2289 | effect on the input/output device, but not its effect on the controlling | |
2290 | terminal. | |
2291 | ||
2292 | When you use the @code{tty} command or redirect input in the @code{run} | |
2293 | command, only the input @emph{for your program} is affected. The input | |
3cb3b8df BR |
2294 | for @value{GDBN} still comes from your terminal. @code{tty} is an alias |
2295 | for @code{set inferior-tty}. | |
2296 | ||
2297 | @cindex inferior tty | |
2298 | @cindex set inferior controlling terminal | |
2299 | You can use the @code{show inferior-tty} command to tell @value{GDBN} to | |
2300 | display the name of the terminal that will be used for future runs of your | |
2301 | program. | |
2302 | ||
2303 | @table @code | |
2304 | @item set inferior-tty /dev/ttyb | |
2305 | @kindex set inferior-tty | |
2306 | Set the tty for the program being debugged to /dev/ttyb. | |
2307 | ||
2308 | @item show inferior-tty | |
2309 | @kindex show inferior-tty | |
2310 | Show the current tty for the program being debugged. | |
2311 | @end table | |
c906108c | 2312 | |
6d2ebf8b | 2313 | @node Attach |
79a6e687 | 2314 | @section Debugging an Already-running Process |
c906108c SS |
2315 | @kindex attach |
2316 | @cindex attach | |
2317 | ||
2318 | @table @code | |
2319 | @item attach @var{process-id} | |
2320 | This command attaches to a running process---one that was started | |
2321 | outside @value{GDBN}. (@code{info files} shows your active | |
2322 | targets.) The command takes as argument a process ID. The usual way to | |
09d4efe1 | 2323 | find out the @var{process-id} of a Unix process is with the @code{ps} utility, |
c906108c SS |
2324 | or with the @samp{jobs -l} shell command. |
2325 | ||
2326 | @code{attach} does not repeat if you press @key{RET} a second time after | |
2327 | executing the command. | |
2328 | @end table | |
2329 | ||
2330 | To use @code{attach}, your program must be running in an environment | |
2331 | which supports processes; for example, @code{attach} does not work for | |
2332 | programs on bare-board targets that lack an operating system. You must | |
2333 | also have permission to send the process a signal. | |
2334 | ||
2335 | When you use @code{attach}, the debugger finds the program running in | |
2336 | the process first by looking in the current working directory, then (if | |
2337 | the program is not found) by using the source file search path | |
79a6e687 | 2338 | (@pxref{Source Path, ,Specifying Source Directories}). You can also use |
c906108c SS |
2339 | the @code{file} command to load the program. @xref{Files, ,Commands to |
2340 | Specify Files}. | |
2341 | ||
2342 | The first thing @value{GDBN} does after arranging to debug the specified | |
2343 | process is to stop it. You can examine and modify an attached process | |
53a5351d JM |
2344 | with all the @value{GDBN} commands that are ordinarily available when |
2345 | you start processes with @code{run}. You can insert breakpoints; you | |
2346 | can step and continue; you can modify storage. If you would rather the | |
2347 | process continue running, you may use the @code{continue} command after | |
c906108c SS |
2348 | attaching @value{GDBN} to the process. |
2349 | ||
2350 | @table @code | |
2351 | @kindex detach | |
2352 | @item detach | |
2353 | When you have finished debugging the attached process, you can use the | |
2354 | @code{detach} command to release it from @value{GDBN} control. Detaching | |
2355 | the process continues its execution. After the @code{detach} command, | |
2356 | that process and @value{GDBN} become completely independent once more, and you | |
2357 | are ready to @code{attach} another process or start one with @code{run}. | |
2358 | @code{detach} does not repeat if you press @key{RET} again after | |
2359 | executing the command. | |
2360 | @end table | |
2361 | ||
159fcc13 JK |
2362 | If you exit @value{GDBN} while you have an attached process, you detach |
2363 | that process. If you use the @code{run} command, you kill that process. | |
2364 | By default, @value{GDBN} asks for confirmation if you try to do either of these | |
2365 | things; you can control whether or not you need to confirm by using the | |
2366 | @code{set confirm} command (@pxref{Messages/Warnings, ,Optional Warnings and | |
79a6e687 | 2367 | Messages}). |
c906108c | 2368 | |
6d2ebf8b | 2369 | @node Kill Process |
79a6e687 | 2370 | @section Killing the Child Process |
c906108c SS |
2371 | |
2372 | @table @code | |
2373 | @kindex kill | |
2374 | @item kill | |
2375 | Kill the child process in which your program is running under @value{GDBN}. | |
2376 | @end table | |
2377 | ||
2378 | This command is useful if you wish to debug a core dump instead of a | |
2379 | running process. @value{GDBN} ignores any core dump file while your program | |
2380 | is running. | |
2381 | ||
2382 | On some operating systems, a program cannot be executed outside @value{GDBN} | |
2383 | while you have breakpoints set on it inside @value{GDBN}. You can use the | |
2384 | @code{kill} command in this situation to permit running your program | |
2385 | outside the debugger. | |
2386 | ||
2387 | The @code{kill} command is also useful if you wish to recompile and | |
2388 | relink your program, since on many systems it is impossible to modify an | |
2389 | executable file while it is running in a process. In this case, when you | |
2390 | next type @code{run}, @value{GDBN} notices that the file has changed, and | |
2391 | reads the symbol table again (while trying to preserve your current | |
2392 | breakpoint settings). | |
2393 | ||
6c95b8df PA |
2394 | @node Inferiors and Programs |
2395 | @section Debugging Multiple Inferiors and Programs | |
b77209e0 | 2396 | |
6c95b8df PA |
2397 | @value{GDBN} lets you run and debug multiple programs in a single |
2398 | session. In addition, @value{GDBN} on some systems may let you run | |
2399 | several programs simultaneously (otherwise you have to exit from one | |
2400 | before starting another). In the most general case, you can have | |
2401 | multiple threads of execution in each of multiple processes, launched | |
2402 | from multiple executables. | |
b77209e0 PA |
2403 | |
2404 | @cindex inferior | |
2405 | @value{GDBN} represents the state of each program execution with an | |
2406 | object called an @dfn{inferior}. An inferior typically corresponds to | |
2407 | a process, but is more general and applies also to targets that do not | |
2408 | have processes. Inferiors may be created before a process runs, and | |
6c95b8df PA |
2409 | may be retained after a process exits. Inferiors have unique |
2410 | identifiers that are different from process ids. Usually each | |
2411 | inferior will also have its own distinct address space, although some | |
2412 | embedded targets may have several inferiors running in different parts | |
2413 | of a single address space. Each inferior may in turn have multiple | |
2414 | threads running in it. | |
b77209e0 | 2415 | |
6c95b8df PA |
2416 | To find out what inferiors exist at any moment, use @w{@code{info |
2417 | inferiors}}: | |
b77209e0 PA |
2418 | |
2419 | @table @code | |
2420 | @kindex info inferiors | |
2421 | @item info inferiors | |
2422 | Print a list of all inferiors currently being managed by @value{GDBN}. | |
3a1ff0b6 PA |
2423 | |
2424 | @value{GDBN} displays for each inferior (in this order): | |
2425 | ||
2426 | @enumerate | |
2427 | @item | |
2428 | the inferior number assigned by @value{GDBN} | |
2429 | ||
2430 | @item | |
2431 | the target system's inferior identifier | |
6c95b8df PA |
2432 | |
2433 | @item | |
2434 | the name of the executable the inferior is running. | |
2435 | ||
3a1ff0b6 PA |
2436 | @end enumerate |
2437 | ||
2438 | @noindent | |
2439 | An asterisk @samp{*} preceding the @value{GDBN} inferior number | |
2440 | indicates the current inferior. | |
2441 | ||
2442 | For example, | |
2277426b | 2443 | @end table |
3a1ff0b6 PA |
2444 | @c end table here to get a little more width for example |
2445 | ||
2446 | @smallexample | |
2447 | (@value{GDBP}) info inferiors | |
6c95b8df PA |
2448 | Num Description Executable |
2449 | 2 process 2307 hello | |
2450 | * 1 process 3401 goodbye | |
3a1ff0b6 | 2451 | @end smallexample |
2277426b PA |
2452 | |
2453 | To switch focus between inferiors, use the @code{inferior} command: | |
2454 | ||
2455 | @table @code | |
3a1ff0b6 PA |
2456 | @kindex inferior @var{infno} |
2457 | @item inferior @var{infno} | |
2458 | Make inferior number @var{infno} the current inferior. The argument | |
2459 | @var{infno} is the inferior number assigned by @value{GDBN}, as shown | |
2460 | in the first field of the @samp{info inferiors} display. | |
2277426b PA |
2461 | @end table |
2462 | ||
6c95b8df PA |
2463 | |
2464 | You can get multiple executables into a debugging session via the | |
2465 | @code{add-inferior} and @w{@code{clone-inferior}} commands. On some | |
2466 | systems @value{GDBN} can add inferiors to the debug session | |
2467 | automatically by following calls to @code{fork} and @code{exec}. To | |
2468 | remove inferiors from the debugging session use the | |
af624141 | 2469 | @w{@code{remove-inferiors}} command. |
6c95b8df PA |
2470 | |
2471 | @table @code | |
2472 | @kindex add-inferior | |
2473 | @item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ] | |
2474 | Adds @var{n} inferiors to be run using @var{executable} as the | |
2475 | executable. @var{n} defaults to 1. If no executable is specified, | |
2476 | the inferiors begins empty, with no program. You can still assign or | |
2477 | change the program assigned to the inferior at any time by using the | |
2478 | @code{file} command with the executable name as its argument. | |
2479 | ||
2480 | @kindex clone-inferior | |
2481 | @item clone-inferior [ -copies @var{n} ] [ @var{infno} ] | |
2482 | Adds @var{n} inferiors ready to execute the same program as inferior | |
2483 | @var{infno}. @var{n} defaults to 1. @var{infno} defaults to the | |
2484 | number of the current inferior. This is a convenient command when you | |
2485 | want to run another instance of the inferior you are debugging. | |
2486 | ||
2487 | @smallexample | |
2488 | (@value{GDBP}) info inferiors | |
2489 | Num Description Executable | |
2490 | * 1 process 29964 helloworld | |
2491 | (@value{GDBP}) clone-inferior | |
2492 | Added inferior 2. | |
2493 | 1 inferiors added. | |
2494 | (@value{GDBP}) info inferiors | |
2495 | Num Description Executable | |
2496 | 2 <null> helloworld | |
2497 | * 1 process 29964 helloworld | |
2498 | @end smallexample | |
2499 | ||
2500 | You can now simply switch focus to inferior 2 and run it. | |
2501 | ||
af624141 MS |
2502 | @kindex remove-inferiors |
2503 | @item remove-inferiors @var{infno}@dots{} | |
2504 | Removes the inferior or inferiors @var{infno}@dots{}. It is not | |
2505 | possible to remove an inferior that is running with this command. For | |
2506 | those, use the @code{kill} or @code{detach} command first. | |
6c95b8df PA |
2507 | |
2508 | @end table | |
2509 | ||
2510 | To quit debugging one of the running inferiors that is not the current | |
2511 | inferior, you can either detach from it by using the @w{@code{detach | |
2512 | inferior}} command (allowing it to run independently), or kill it | |
af624141 | 2513 | using the @w{@code{kill inferiors}} command: |
2277426b PA |
2514 | |
2515 | @table @code | |
af624141 MS |
2516 | @kindex detach inferiors @var{infno}@dots{} |
2517 | @item detach inferior @var{infno}@dots{} | |
2518 | Detach from the inferior or inferiors identified by @value{GDBN} | |
5e30da2c | 2519 | inferior number(s) @var{infno}@dots{}. Note that the inferior's entry |
af624141 MS |
2520 | still stays on the list of inferiors shown by @code{info inferiors}, |
2521 | but its Description will show @samp{<null>}. | |
2522 | ||
2523 | @kindex kill inferiors @var{infno}@dots{} | |
2524 | @item kill inferiors @var{infno}@dots{} | |
2525 | Kill the inferior or inferiors identified by @value{GDBN} inferior | |
2526 | number(s) @var{infno}@dots{}. Note that the inferior's entry still | |
2527 | stays on the list of inferiors shown by @code{info inferiors}, but its | |
2528 | Description will show @samp{<null>}. | |
2277426b PA |
2529 | @end table |
2530 | ||
6c95b8df | 2531 | After the successful completion of a command such as @code{detach}, |
af624141 | 2532 | @code{detach inferiors}, @code{kill} or @code{kill inferiors}, or after |
6c95b8df PA |
2533 | a normal process exit, the inferior is still valid and listed with |
2534 | @code{info inferiors}, ready to be restarted. | |
2535 | ||
2536 | ||
2277426b PA |
2537 | To be notified when inferiors are started or exit under @value{GDBN}'s |
2538 | control use @w{@code{set print inferior-events}}: | |
b77209e0 | 2539 | |
2277426b | 2540 | @table @code |
b77209e0 PA |
2541 | @kindex set print inferior-events |
2542 | @cindex print messages on inferior start and exit | |
2543 | @item set print inferior-events | |
2544 | @itemx set print inferior-events on | |
2545 | @itemx set print inferior-events off | |
2546 | The @code{set print inferior-events} command allows you to enable or | |
2547 | disable printing of messages when @value{GDBN} notices that new | |
2548 | inferiors have started or that inferiors have exited or have been | |
2549 | detached. By default, these messages will not be printed. | |
2550 | ||
2551 | @kindex show print inferior-events | |
2552 | @item show print inferior-events | |
2553 | Show whether messages will be printed when @value{GDBN} detects that | |
2554 | inferiors have started, exited or have been detached. | |
2555 | @end table | |
2556 | ||
6c95b8df PA |
2557 | Many commands will work the same with multiple programs as with a |
2558 | single program: e.g., @code{print myglobal} will simply display the | |
2559 | value of @code{myglobal} in the current inferior. | |
2560 | ||
2561 | ||
2562 | Occasionaly, when debugging @value{GDBN} itself, it may be useful to | |
2563 | get more info about the relationship of inferiors, programs, address | |
2564 | spaces in a debug session. You can do that with the @w{@code{maint | |
2565 | info program-spaces}} command. | |
2566 | ||
2567 | @table @code | |
2568 | @kindex maint info program-spaces | |
2569 | @item maint info program-spaces | |
2570 | Print a list of all program spaces currently being managed by | |
2571 | @value{GDBN}. | |
2572 | ||
2573 | @value{GDBN} displays for each program space (in this order): | |
2574 | ||
2575 | @enumerate | |
2576 | @item | |
2577 | the program space number assigned by @value{GDBN} | |
2578 | ||
2579 | @item | |
2580 | the name of the executable loaded into the program space, with e.g., | |
2581 | the @code{file} command. | |
2582 | ||
2583 | @end enumerate | |
2584 | ||
2585 | @noindent | |
2586 | An asterisk @samp{*} preceding the @value{GDBN} program space number | |
2587 | indicates the current program space. | |
2588 | ||
2589 | In addition, below each program space line, @value{GDBN} prints extra | |
2590 | information that isn't suitable to display in tabular form. For | |
2591 | example, the list of inferiors bound to the program space. | |
2592 | ||
2593 | @smallexample | |
2594 | (@value{GDBP}) maint info program-spaces | |
2595 | Id Executable | |
2596 | 2 goodbye | |
2597 | Bound inferiors: ID 1 (process 21561) | |
2598 | * 1 hello | |
2599 | @end smallexample | |
2600 | ||
2601 | Here we can see that no inferior is running the program @code{hello}, | |
2602 | while @code{process 21561} is running the program @code{goodbye}. On | |
2603 | some targets, it is possible that multiple inferiors are bound to the | |
2604 | same program space. The most common example is that of debugging both | |
2605 | the parent and child processes of a @code{vfork} call. For example, | |
2606 | ||
2607 | @smallexample | |
2608 | (@value{GDBP}) maint info program-spaces | |
2609 | Id Executable | |
2610 | * 1 vfork-test | |
2611 | Bound inferiors: ID 2 (process 18050), ID 1 (process 18045) | |
2612 | @end smallexample | |
2613 | ||
2614 | Here, both inferior 2 and inferior 1 are running in the same program | |
2615 | space as a result of inferior 1 having executed a @code{vfork} call. | |
2616 | @end table | |
2617 | ||
6d2ebf8b | 2618 | @node Threads |
79a6e687 | 2619 | @section Debugging Programs with Multiple Threads |
c906108c SS |
2620 | |
2621 | @cindex threads of execution | |
2622 | @cindex multiple threads | |
2623 | @cindex switching threads | |
2624 | In some operating systems, such as HP-UX and Solaris, a single program | |
2625 | may have more than one @dfn{thread} of execution. The precise semantics | |
2626 | of threads differ from one operating system to another, but in general | |
2627 | the threads of a single program are akin to multiple processes---except | |
2628 | that they share one address space (that is, they can all examine and | |
2629 | modify the same variables). On the other hand, each thread has its own | |
2630 | registers and execution stack, and perhaps private memory. | |
2631 | ||
2632 | @value{GDBN} provides these facilities for debugging multi-thread | |
2633 | programs: | |
2634 | ||
2635 | @itemize @bullet | |
2636 | @item automatic notification of new threads | |
2637 | @item @samp{thread @var{threadno}}, a command to switch among threads | |
2638 | @item @samp{info threads}, a command to inquire about existing threads | |
5d161b24 | 2639 | @item @samp{thread apply [@var{threadno}] [@var{all}] @var{args}}, |
c906108c SS |
2640 | a command to apply a command to a list of threads |
2641 | @item thread-specific breakpoints | |
93815fbf VP |
2642 | @item @samp{set print thread-events}, which controls printing of |
2643 | messages on thread start and exit. | |
17a37d48 PP |
2644 | @item @samp{set libthread-db-search-path @var{path}}, which lets |
2645 | the user specify which @code{libthread_db} to use if the default choice | |
2646 | isn't compatible with the program. | |
c906108c SS |
2647 | @end itemize |
2648 | ||
c906108c SS |
2649 | @quotation |
2650 | @emph{Warning:} These facilities are not yet available on every | |
2651 | @value{GDBN} configuration where the operating system supports threads. | |
2652 | If your @value{GDBN} does not support threads, these commands have no | |
2653 | effect. For example, a system without thread support shows no output | |
2654 | from @samp{info threads}, and always rejects the @code{thread} command, | |
2655 | like this: | |
2656 | ||
2657 | @smallexample | |
2658 | (@value{GDBP}) info threads | |
2659 | (@value{GDBP}) thread 1 | |
2660 | Thread ID 1 not known. Use the "info threads" command to | |
2661 | see the IDs of currently known threads. | |
2662 | @end smallexample | |
2663 | @c FIXME to implementors: how hard would it be to say "sorry, this GDB | |
2664 | @c doesn't support threads"? | |
2665 | @end quotation | |
c906108c SS |
2666 | |
2667 | @cindex focus of debugging | |
2668 | @cindex current thread | |
2669 | The @value{GDBN} thread debugging facility allows you to observe all | |
2670 | threads while your program runs---but whenever @value{GDBN} takes | |
2671 | control, one thread in particular is always the focus of debugging. | |
2672 | This thread is called the @dfn{current thread}. Debugging commands show | |
2673 | program information from the perspective of the current thread. | |
2674 | ||
41afff9a | 2675 | @cindex @code{New} @var{systag} message |
c906108c SS |
2676 | @cindex thread identifier (system) |
2677 | @c FIXME-implementors!! It would be more helpful if the [New...] message | |
2678 | @c included GDB's numeric thread handle, so you could just go to that | |
2679 | @c thread without first checking `info threads'. | |
2680 | Whenever @value{GDBN} detects a new thread in your program, it displays | |
2681 | the target system's identification for the thread with a message in the | |
2682 | form @samp{[New @var{systag}]}. @var{systag} is a thread identifier | |
2683 | whose form varies depending on the particular system. For example, on | |
8807d78b | 2684 | @sc{gnu}/Linux, you might see |
c906108c | 2685 | |
474c8240 | 2686 | @smallexample |
08e796bc | 2687 | [New Thread 0x41e02940 (LWP 25582)] |
474c8240 | 2688 | @end smallexample |
c906108c SS |
2689 | |
2690 | @noindent | |
2691 | when @value{GDBN} notices a new thread. In contrast, on an SGI system, | |
2692 | the @var{systag} is simply something like @samp{process 368}, with no | |
2693 | further qualifier. | |
2694 | ||
2695 | @c FIXME!! (1) Does the [New...] message appear even for the very first | |
2696 | @c thread of a program, or does it only appear for the | |
6ca652b0 | 2697 | @c second---i.e.@: when it becomes obvious we have a multithread |
c906108c SS |
2698 | @c program? |
2699 | @c (2) *Is* there necessarily a first thread always? Or do some | |
2700 | @c multithread systems permit starting a program with multiple | |
5d161b24 | 2701 | @c threads ab initio? |
c906108c SS |
2702 | |
2703 | @cindex thread number | |
2704 | @cindex thread identifier (GDB) | |
2705 | For debugging purposes, @value{GDBN} associates its own thread | |
2706 | number---always a single integer---with each thread in your program. | |
2707 | ||
2708 | @table @code | |
2709 | @kindex info threads | |
60f98dde MS |
2710 | @item info threads @r{[}@var{id}@dots{}@r{]} |
2711 | Display a summary of all threads currently in your program. Optional | |
2712 | argument @var{id}@dots{} is one or more thread ids separated by spaces, and | |
2713 | means to print information only about the specified thread or threads. | |
2714 | @value{GDBN} displays for each thread (in this order): | |
c906108c SS |
2715 | |
2716 | @enumerate | |
09d4efe1 EZ |
2717 | @item |
2718 | the thread number assigned by @value{GDBN} | |
c906108c | 2719 | |
09d4efe1 EZ |
2720 | @item |
2721 | the target system's thread identifier (@var{systag}) | |
c906108c | 2722 | |
4694da01 TT |
2723 | @item |
2724 | the thread's name, if one is known. A thread can either be named by | |
2725 | the user (see @code{thread name}, below), or, in some cases, by the | |
2726 | program itself. | |
2727 | ||
09d4efe1 EZ |
2728 | @item |
2729 | the current stack frame summary for that thread | |
c906108c SS |
2730 | @end enumerate |
2731 | ||
2732 | @noindent | |
2733 | An asterisk @samp{*} to the left of the @value{GDBN} thread number | |
2734 | indicates the current thread. | |
2735 | ||
5d161b24 | 2736 | For example, |
c906108c SS |
2737 | @end table |
2738 | @c end table here to get a little more width for example | |
2739 | ||
2740 | @smallexample | |
2741 | (@value{GDBP}) info threads | |
13fd8b81 TT |
2742 | Id Target Id Frame |
2743 | 3 process 35 thread 27 0x34e5 in sigpause () | |
2744 | 2 process 35 thread 23 0x34e5 in sigpause () | |
2745 | * 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8) | |
c906108c SS |
2746 | at threadtest.c:68 |
2747 | @end smallexample | |
53a5351d | 2748 | |
c45da7e6 EZ |
2749 | On Solaris, you can display more information about user threads with a |
2750 | Solaris-specific command: | |
2751 | ||
2752 | @table @code | |
2753 | @item maint info sol-threads | |
2754 | @kindex maint info sol-threads | |
2755 | @cindex thread info (Solaris) | |
2756 | Display info on Solaris user threads. | |
2757 | @end table | |
2758 | ||
c906108c SS |
2759 | @table @code |
2760 | @kindex thread @var{threadno} | |
2761 | @item thread @var{threadno} | |
2762 | Make thread number @var{threadno} the current thread. The command | |
2763 | argument @var{threadno} is the internal @value{GDBN} thread number, as | |
2764 | shown in the first field of the @samp{info threads} display. | |
2765 | @value{GDBN} responds by displaying the system identifier of the thread | |
2766 | you selected, and its current stack frame summary: | |
2767 | ||
2768 | @smallexample | |
c906108c | 2769 | (@value{GDBP}) thread 2 |
13fd8b81 TT |
2770 | [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))] |
2771 | #0 some_function (ignore=0x0) at example.c:8 | |
2772 | 8 printf ("hello\n"); | |
c906108c SS |
2773 | @end smallexample |
2774 | ||
2775 | @noindent | |
2776 | As with the @samp{[New @dots{}]} message, the form of the text after | |
2777 | @samp{Switching to} depends on your system's conventions for identifying | |
5d161b24 | 2778 | threads. |
c906108c | 2779 | |
6aed2dbc SS |
2780 | @vindex $_thread@r{, convenience variable} |
2781 | The debugger convenience variable @samp{$_thread} contains the number | |
2782 | of the current thread. You may find this useful in writing breakpoint | |
2783 | conditional expressions, command scripts, and so forth. See | |
2784 | @xref{Convenience Vars,, Convenience Variables}, for general | |
2785 | information on convenience variables. | |
2786 | ||
9c16f35a | 2787 | @kindex thread apply |
638ac427 | 2788 | @cindex apply command to several threads |
13fd8b81 | 2789 | @item thread apply [@var{threadno} | all] @var{command} |
839c27b7 EZ |
2790 | The @code{thread apply} command allows you to apply the named |
2791 | @var{command} to one or more threads. Specify the numbers of the | |
2792 | threads that you want affected with the command argument | |
2793 | @var{threadno}. It can be a single thread number, one of the numbers | |
2794 | shown in the first field of the @samp{info threads} display; or it | |
2795 | could be a range of thread numbers, as in @code{2-4}. To apply a | |
2796 | command to all threads, type @kbd{thread apply all @var{command}}. | |
93815fbf | 2797 | |
4694da01 TT |
2798 | @kindex thread name |
2799 | @cindex name a thread | |
2800 | @item thread name [@var{name}] | |
2801 | This command assigns a name to the current thread. If no argument is | |
2802 | given, any existing user-specified name is removed. The thread name | |
2803 | appears in the @samp{info threads} display. | |
2804 | ||
2805 | On some systems, such as @sc{gnu}/Linux, @value{GDBN} is able to | |
2806 | determine the name of the thread as given by the OS. On these | |
2807 | systems, a name specified with @samp{thread name} will override the | |
2808 | system-give name, and removing the user-specified name will cause | |
2809 | @value{GDBN} to once again display the system-specified name. | |
2810 | ||
60f98dde MS |
2811 | @kindex thread find |
2812 | @cindex search for a thread | |
2813 | @item thread find [@var{regexp}] | |
2814 | Search for and display thread ids whose name or @var{systag} | |
2815 | matches the supplied regular expression. | |
2816 | ||
2817 | As well as being the complement to the @samp{thread name} command, | |
2818 | this command also allows you to identify a thread by its target | |
2819 | @var{systag}. For instance, on @sc{gnu}/Linux, the target @var{systag} | |
2820 | is the LWP id. | |
2821 | ||
2822 | @smallexample | |
2823 | (@value{GDBN}) thread find 26688 | |
2824 | Thread 4 has target id 'Thread 0x41e02940 (LWP 26688)' | |
2825 | (@value{GDBN}) info thread 4 | |
2826 | Id Target Id Frame | |
2827 | 4 Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select () | |
2828 | @end smallexample | |
2829 | ||
93815fbf VP |
2830 | @kindex set print thread-events |
2831 | @cindex print messages on thread start and exit | |
2832 | @item set print thread-events | |
2833 | @itemx set print thread-events on | |
2834 | @itemx set print thread-events off | |
2835 | The @code{set print thread-events} command allows you to enable or | |
2836 | disable printing of messages when @value{GDBN} notices that new threads have | |
2837 | started or that threads have exited. By default, these messages will | |
2838 | be printed if detection of these events is supported by the target. | |
2839 | Note that these messages cannot be disabled on all targets. | |
2840 | ||
2841 | @kindex show print thread-events | |
2842 | @item show print thread-events | |
2843 | Show whether messages will be printed when @value{GDBN} detects that threads | |
2844 | have started and exited. | |
c906108c SS |
2845 | @end table |
2846 | ||
79a6e687 | 2847 | @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for |
c906108c SS |
2848 | more information about how @value{GDBN} behaves when you stop and start |
2849 | programs with multiple threads. | |
2850 | ||
79a6e687 | 2851 | @xref{Set Watchpoints,,Setting Watchpoints}, for information about |
c906108c | 2852 | watchpoints in programs with multiple threads. |
c906108c | 2853 | |
17a37d48 PP |
2854 | @table @code |
2855 | @kindex set libthread-db-search-path | |
2856 | @cindex search path for @code{libthread_db} | |
2857 | @item set libthread-db-search-path @r{[}@var{path}@r{]} | |
2858 | If this variable is set, @var{path} is a colon-separated list of | |
2859 | directories @value{GDBN} will use to search for @code{libthread_db}. | |
2860 | If you omit @var{path}, @samp{libthread-db-search-path} will be reset to | |
98a5dd13 | 2861 | its default value (@code{$sdir:$pdir} on @sc{gnu}/Linux and Solaris systems). |
7e0396aa DE |
2862 | Internally, the default value comes from the @code{LIBTHREAD_DB_SEARCH_PATH} |
2863 | macro. | |
17a37d48 PP |
2864 | |
2865 | On @sc{gnu}/Linux and Solaris systems, @value{GDBN} uses a ``helper'' | |
2866 | @code{libthread_db} library to obtain information about threads in the | |
2867 | inferior process. @value{GDBN} will use @samp{libthread-db-search-path} | |
98a5dd13 DE |
2868 | to find @code{libthread_db}. |
2869 | ||
2870 | A special entry @samp{$sdir} for @samp{libthread-db-search-path} | |
2871 | refers to the default system directories that are | |
2872 | normally searched for loading shared libraries. | |
2873 | ||
2874 | A special entry @samp{$pdir} for @samp{libthread-db-search-path} | |
2875 | refers to the directory from which @code{libpthread} | |
2876 | was loaded in the inferior process. | |
17a37d48 PP |
2877 | |
2878 | For any @code{libthread_db} library @value{GDBN} finds in above directories, | |
2879 | @value{GDBN} attempts to initialize it with the current inferior process. | |
2880 | If this initialization fails (which could happen because of a version | |
2881 | mismatch between @code{libthread_db} and @code{libpthread}), @value{GDBN} | |
2882 | will unload @code{libthread_db}, and continue with the next directory. | |
2883 | If none of @code{libthread_db} libraries initialize successfully, | |
2884 | @value{GDBN} will issue a warning and thread debugging will be disabled. | |
2885 | ||
2886 | Setting @code{libthread-db-search-path} is currently implemented | |
2887 | only on some platforms. | |
2888 | ||
2889 | @kindex show libthread-db-search-path | |
2890 | @item show libthread-db-search-path | |
2891 | Display current libthread_db search path. | |
02d868e8 PP |
2892 | |
2893 | @kindex set debug libthread-db | |
2894 | @kindex show debug libthread-db | |
2895 | @cindex debugging @code{libthread_db} | |
2896 | @item set debug libthread-db | |
2897 | @itemx show debug libthread-db | |
2898 | Turns on or off display of @code{libthread_db}-related events. | |
2899 | Use @code{1} to enable, @code{0} to disable. | |
17a37d48 PP |
2900 | @end table |
2901 | ||
6c95b8df PA |
2902 | @node Forks |
2903 | @section Debugging Forks | |
c906108c SS |
2904 | |
2905 | @cindex fork, debugging programs which call | |
2906 | @cindex multiple processes | |
2907 | @cindex processes, multiple | |
53a5351d JM |
2908 | On most systems, @value{GDBN} has no special support for debugging |
2909 | programs which create additional processes using the @code{fork} | |
2910 | function. When a program forks, @value{GDBN} will continue to debug the | |
2911 | parent process and the child process will run unimpeded. If you have | |
2912 | set a breakpoint in any code which the child then executes, the child | |
2913 | will get a @code{SIGTRAP} signal which (unless it catches the signal) | |
2914 | will cause it to terminate. | |
c906108c SS |
2915 | |
2916 | However, if you want to debug the child process there is a workaround | |
2917 | which isn't too painful. Put a call to @code{sleep} in the code which | |
2918 | the child process executes after the fork. It may be useful to sleep | |
2919 | only if a certain environment variable is set, or a certain file exists, | |
2920 | so that the delay need not occur when you don't want to run @value{GDBN} | |
2921 | on the child. While the child is sleeping, use the @code{ps} program to | |
2922 | get its process ID. Then tell @value{GDBN} (a new invocation of | |
2923 | @value{GDBN} if you are also debugging the parent process) to attach to | |
d4f3574e | 2924 | the child process (@pxref{Attach}). From that point on you can debug |
c906108c | 2925 | the child process just like any other process which you attached to. |
c906108c | 2926 | |
b51970ac DJ |
2927 | On some systems, @value{GDBN} provides support for debugging programs that |
2928 | create additional processes using the @code{fork} or @code{vfork} functions. | |
2929 | Currently, the only platforms with this feature are HP-UX (11.x and later | |
a6b151f1 | 2930 | only?) and @sc{gnu}/Linux (kernel version 2.5.60 and later). |
c906108c SS |
2931 | |
2932 | By default, when a program forks, @value{GDBN} will continue to debug | |
2933 | the parent process and the child process will run unimpeded. | |
2934 | ||
2935 | If you want to follow the child process instead of the parent process, | |
2936 | use the command @w{@code{set follow-fork-mode}}. | |
2937 | ||
2938 | @table @code | |
2939 | @kindex set follow-fork-mode | |
2940 | @item set follow-fork-mode @var{mode} | |
2941 | Set the debugger response to a program call of @code{fork} or | |
2942 | @code{vfork}. A call to @code{fork} or @code{vfork} creates a new | |
9c16f35a | 2943 | process. The @var{mode} argument can be: |
c906108c SS |
2944 | |
2945 | @table @code | |
2946 | @item parent | |
2947 | The original process is debugged after a fork. The child process runs | |
2df3850c | 2948 | unimpeded. This is the default. |
c906108c SS |
2949 | |
2950 | @item child | |
2951 | The new process is debugged after a fork. The parent process runs | |
2952 | unimpeded. | |
2953 | ||
c906108c SS |
2954 | @end table |
2955 | ||
9c16f35a | 2956 | @kindex show follow-fork-mode |
c906108c | 2957 | @item show follow-fork-mode |
2df3850c | 2958 | Display the current debugger response to a @code{fork} or @code{vfork} call. |
c906108c SS |
2959 | @end table |
2960 | ||
5c95884b MS |
2961 | @cindex debugging multiple processes |
2962 | On Linux, if you want to debug both the parent and child processes, use the | |
2963 | command @w{@code{set detach-on-fork}}. | |
2964 | ||
2965 | @table @code | |
2966 | @kindex set detach-on-fork | |
2967 | @item set detach-on-fork @var{mode} | |
2968 | Tells gdb whether to detach one of the processes after a fork, or | |
2969 | retain debugger control over them both. | |
2970 | ||
2971 | @table @code | |
2972 | @item on | |
2973 | The child process (or parent process, depending on the value of | |
2974 | @code{follow-fork-mode}) will be detached and allowed to run | |
2975 | independently. This is the default. | |
2976 | ||
2977 | @item off | |
2978 | Both processes will be held under the control of @value{GDBN}. | |
2979 | One process (child or parent, depending on the value of | |
2980 | @code{follow-fork-mode}) is debugged as usual, while the other | |
2981 | is held suspended. | |
2982 | ||
2983 | @end table | |
2984 | ||
11310833 NR |
2985 | @kindex show detach-on-fork |
2986 | @item show detach-on-fork | |
2987 | Show whether detach-on-fork mode is on/off. | |
5c95884b MS |
2988 | @end table |
2989 | ||
2277426b PA |
2990 | If you choose to set @samp{detach-on-fork} mode off, then @value{GDBN} |
2991 | will retain control of all forked processes (including nested forks). | |
2992 | You can list the forked processes under the control of @value{GDBN} by | |
2993 | using the @w{@code{info inferiors}} command, and switch from one fork | |
6c95b8df PA |
2994 | to another by using the @code{inferior} command (@pxref{Inferiors and |
2995 | Programs, ,Debugging Multiple Inferiors and Programs}). | |
5c95884b MS |
2996 | |
2997 | To quit debugging one of the forked processes, you can either detach | |
af624141 MS |
2998 | from it by using the @w{@code{detach inferiors}} command (allowing it |
2999 | to run independently), or kill it using the @w{@code{kill inferiors}} | |
6c95b8df PA |
3000 | command. @xref{Inferiors and Programs, ,Debugging Multiple Inferiors |
3001 | and Programs}. | |
5c95884b | 3002 | |
c906108c SS |
3003 | If you ask to debug a child process and a @code{vfork} is followed by an |
3004 | @code{exec}, @value{GDBN} executes the new target up to the first | |
3005 | breakpoint in the new target. If you have a breakpoint set on | |
3006 | @code{main} in your original program, the breakpoint will also be set on | |
3007 | the child process's @code{main}. | |
3008 | ||
2277426b PA |
3009 | On some systems, when a child process is spawned by @code{vfork}, you |
3010 | cannot debug the child or parent until an @code{exec} call completes. | |
c906108c SS |
3011 | |
3012 | If you issue a @code{run} command to @value{GDBN} after an @code{exec} | |
6c95b8df PA |
3013 | call executes, the new target restarts. To restart the parent |
3014 | process, use the @code{file} command with the parent executable name | |
3015 | as its argument. By default, after an @code{exec} call executes, | |
3016 | @value{GDBN} discards the symbols of the previous executable image. | |
3017 | You can change this behaviour with the @w{@code{set follow-exec-mode}} | |
3018 | command. | |
3019 | ||
3020 | @table @code | |
3021 | @kindex set follow-exec-mode | |
3022 | @item set follow-exec-mode @var{mode} | |
3023 | ||
3024 | Set debugger response to a program call of @code{exec}. An | |
3025 | @code{exec} call replaces the program image of a process. | |
3026 | ||
3027 | @code{follow-exec-mode} can be: | |
3028 | ||
3029 | @table @code | |
3030 | @item new | |
3031 | @value{GDBN} creates a new inferior and rebinds the process to this | |
3032 | new inferior. The program the process was running before the | |
3033 | @code{exec} call can be restarted afterwards by restarting the | |
3034 | original inferior. | |
3035 | ||
3036 | For example: | |
3037 | ||
3038 | @smallexample | |
3039 | (@value{GDBP}) info inferiors | |
3040 | (gdb) info inferior | |
3041 | Id Description Executable | |
3042 | * 1 <null> prog1 | |
3043 | (@value{GDBP}) run | |
3044 | process 12020 is executing new program: prog2 | |
3045 | Program exited normally. | |
3046 | (@value{GDBP}) info inferiors | |
3047 | Id Description Executable | |
3048 | * 2 <null> prog2 | |
3049 | 1 <null> prog1 | |
3050 | @end smallexample | |
3051 | ||
3052 | @item same | |
3053 | @value{GDBN} keeps the process bound to the same inferior. The new | |
3054 | executable image replaces the previous executable loaded in the | |
3055 | inferior. Restarting the inferior after the @code{exec} call, with | |
3056 | e.g., the @code{run} command, restarts the executable the process was | |
3057 | running after the @code{exec} call. This is the default mode. | |
3058 | ||
3059 | For example: | |
3060 | ||
3061 | @smallexample | |
3062 | (@value{GDBP}) info inferiors | |
3063 | Id Description Executable | |
3064 | * 1 <null> prog1 | |
3065 | (@value{GDBP}) run | |
3066 | process 12020 is executing new program: prog2 | |
3067 | Program exited normally. | |
3068 | (@value{GDBP}) info inferiors | |
3069 | Id Description Executable | |
3070 | * 1 <null> prog2 | |
3071 | @end smallexample | |
3072 | ||
3073 | @end table | |
3074 | @end table | |
c906108c SS |
3075 | |
3076 | You can use the @code{catch} command to make @value{GDBN} stop whenever | |
3077 | a @code{fork}, @code{vfork}, or @code{exec} call is made. @xref{Set | |
79a6e687 | 3078 | Catchpoints, ,Setting Catchpoints}. |
c906108c | 3079 | |
5c95884b | 3080 | @node Checkpoint/Restart |
79a6e687 | 3081 | @section Setting a @emph{Bookmark} to Return to Later |
5c95884b MS |
3082 | |
3083 | @cindex checkpoint | |
3084 | @cindex restart | |
3085 | @cindex bookmark | |
3086 | @cindex snapshot of a process | |
3087 | @cindex rewind program state | |
3088 | ||
3089 | On certain operating systems@footnote{Currently, only | |
3090 | @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a | |
3091 | program's state, called a @dfn{checkpoint}, and come back to it | |
3092 | later. | |
3093 | ||
3094 | Returning to a checkpoint effectively undoes everything that has | |
3095 | happened in the program since the @code{checkpoint} was saved. This | |
3096 | includes changes in memory, registers, and even (within some limits) | |
3097 | system state. Effectively, it is like going back in time to the | |
3098 | moment when the checkpoint was saved. | |
3099 | ||
3100 | Thus, if you're stepping thru a program and you think you're | |
3101 | getting close to the point where things go wrong, you can save | |
3102 | a checkpoint. Then, if you accidentally go too far and miss | |
3103 | the critical statement, instead of having to restart your program | |
3104 | from the beginning, you can just go back to the checkpoint and | |
3105 | start again from there. | |
3106 | ||
3107 | This can be especially useful if it takes a lot of time or | |
3108 | steps to reach the point where you think the bug occurs. | |
3109 | ||
3110 | To use the @code{checkpoint}/@code{restart} method of debugging: | |
3111 | ||
3112 | @table @code | |
3113 | @kindex checkpoint | |
3114 | @item checkpoint | |
3115 | Save a snapshot of the debugged program's current execution state. | |
3116 | The @code{checkpoint} command takes no arguments, but each checkpoint | |
3117 | is assigned a small integer id, similar to a breakpoint id. | |
3118 | ||
3119 | @kindex info checkpoints | |
3120 | @item info checkpoints | |
3121 | List the checkpoints that have been saved in the current debugging | |
3122 | session. For each checkpoint, the following information will be | |
3123 | listed: | |
3124 | ||
3125 | @table @code | |
3126 | @item Checkpoint ID | |
3127 | @item Process ID | |
3128 | @item Code Address | |
3129 | @item Source line, or label | |
3130 | @end table | |
3131 | ||
3132 | @kindex restart @var{checkpoint-id} | |
3133 | @item restart @var{checkpoint-id} | |
3134 | Restore the program state that was saved as checkpoint number | |
3135 | @var{checkpoint-id}. All program variables, registers, stack frames | |
3136 | etc.@: will be returned to the values that they had when the checkpoint | |
3137 | was saved. In essence, gdb will ``wind back the clock'' to the point | |
3138 | in time when the checkpoint was saved. | |
3139 | ||
3140 | Note that breakpoints, @value{GDBN} variables, command history etc. | |
3141 | are not affected by restoring a checkpoint. In general, a checkpoint | |
3142 | only restores things that reside in the program being debugged, not in | |
3143 | the debugger. | |
3144 | ||
b8db102d MS |
3145 | @kindex delete checkpoint @var{checkpoint-id} |
3146 | @item delete checkpoint @var{checkpoint-id} | |
5c95884b MS |
3147 | Delete the previously-saved checkpoint identified by @var{checkpoint-id}. |
3148 | ||
3149 | @end table | |
3150 | ||
3151 | Returning to a previously saved checkpoint will restore the user state | |
3152 | of the program being debugged, plus a significant subset of the system | |
3153 | (OS) state, including file pointers. It won't ``un-write'' data from | |
3154 | a file, but it will rewind the file pointer to the previous location, | |
3155 | so that the previously written data can be overwritten. For files | |
3156 | opened in read mode, the pointer will also be restored so that the | |
3157 | previously read data can be read again. | |
3158 | ||
3159 | Of course, characters that have been sent to a printer (or other | |
3160 | external device) cannot be ``snatched back'', and characters received | |
3161 | from eg.@: a serial device can be removed from internal program buffers, | |
3162 | but they cannot be ``pushed back'' into the serial pipeline, ready to | |
3163 | be received again. Similarly, the actual contents of files that have | |
3164 | been changed cannot be restored (at this time). | |
3165 | ||
3166 | However, within those constraints, you actually can ``rewind'' your | |
3167 | program to a previously saved point in time, and begin debugging it | |
3168 | again --- and you can change the course of events so as to debug a | |
3169 | different execution path this time. | |
3170 | ||
3171 | @cindex checkpoints and process id | |
3172 | Finally, there is one bit of internal program state that will be | |
3173 | different when you return to a checkpoint --- the program's process | |
3174 | id. Each checkpoint will have a unique process id (or @var{pid}), | |
3175 | and each will be different from the program's original @var{pid}. | |
3176 | If your program has saved a local copy of its process id, this could | |
3177 | potentially pose a problem. | |
3178 | ||
79a6e687 | 3179 | @subsection A Non-obvious Benefit of Using Checkpoints |
5c95884b MS |
3180 | |
3181 | On some systems such as @sc{gnu}/Linux, address space randomization | |
3182 | is performed on new processes for security reasons. This makes it | |
3183 | difficult or impossible to set a breakpoint, or watchpoint, on an | |
3184 | absolute address if you have to restart the program, since the | |
3185 | absolute location of a symbol will change from one execution to the | |
3186 | next. | |
3187 | ||
3188 | A checkpoint, however, is an @emph{identical} copy of a process. | |
3189 | Therefore if you create a checkpoint at (eg.@:) the start of main, | |
3190 | and simply return to that checkpoint instead of restarting the | |
3191 | process, you can avoid the effects of address randomization and | |
3192 | your symbols will all stay in the same place. | |
3193 | ||
6d2ebf8b | 3194 | @node Stopping |
c906108c SS |
3195 | @chapter Stopping and Continuing |
3196 | ||
3197 | The principal purposes of using a debugger are so that you can stop your | |
3198 | program before it terminates; or so that, if your program runs into | |
3199 | trouble, you can investigate and find out why. | |
3200 | ||
7a292a7a SS |
3201 | Inside @value{GDBN}, your program may stop for any of several reasons, |
3202 | such as a signal, a breakpoint, or reaching a new line after a | |
3203 | @value{GDBN} command such as @code{step}. You may then examine and | |
3204 | change variables, set new breakpoints or remove old ones, and then | |
3205 | continue execution. Usually, the messages shown by @value{GDBN} provide | |
3206 | ample explanation of the status of your program---but you can also | |
3207 | explicitly request this information at any time. | |
c906108c SS |
3208 | |
3209 | @table @code | |
3210 | @kindex info program | |
3211 | @item info program | |
3212 | Display information about the status of your program: whether it is | |
7a292a7a | 3213 | running or not, what process it is, and why it stopped. |
c906108c SS |
3214 | @end table |
3215 | ||
3216 | @menu | |
3217 | * Breakpoints:: Breakpoints, watchpoints, and catchpoints | |
3218 | * Continuing and Stepping:: Resuming execution | |
c906108c | 3219 | * Signals:: Signals |
c906108c | 3220 | * Thread Stops:: Stopping and starting multi-thread programs |
c906108c SS |
3221 | @end menu |
3222 | ||
6d2ebf8b | 3223 | @node Breakpoints |
79a6e687 | 3224 | @section Breakpoints, Watchpoints, and Catchpoints |
c906108c SS |
3225 | |
3226 | @cindex breakpoints | |
3227 | A @dfn{breakpoint} makes your program stop whenever a certain point in | |
3228 | the program is reached. For each breakpoint, you can add conditions to | |
3229 | control in finer detail whether your program stops. You can set | |
3230 | breakpoints with the @code{break} command and its variants (@pxref{Set | |
79a6e687 | 3231 | Breaks, ,Setting Breakpoints}), to specify the place where your program |
c906108c SS |
3232 | should stop by line number, function name or exact address in the |
3233 | program. | |
3234 | ||
09d4efe1 EZ |
3235 | On some systems, you can set breakpoints in shared libraries before |
3236 | the executable is run. There is a minor limitation on HP-UX systems: | |
3237 | you must wait until the executable is run in order to set breakpoints | |
3238 | in shared library routines that are not called directly by the program | |
3239 | (for example, routines that are arguments in a @code{pthread_create} | |
3240 | call). | |
c906108c SS |
3241 | |
3242 | @cindex watchpoints | |
fd60e0df | 3243 | @cindex data breakpoints |
c906108c SS |
3244 | @cindex memory tracing |
3245 | @cindex breakpoint on memory address | |
3246 | @cindex breakpoint on variable modification | |
3247 | A @dfn{watchpoint} is a special breakpoint that stops your program | |
fd60e0df | 3248 | when the value of an expression changes. The expression may be a value |
0ced0c34 | 3249 | of a variable, or it could involve values of one or more variables |
fd60e0df EZ |
3250 | combined by operators, such as @samp{a + b}. This is sometimes called |
3251 | @dfn{data breakpoints}. You must use a different command to set | |
79a6e687 | 3252 | watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside |
fd60e0df EZ |
3253 | from that, you can manage a watchpoint like any other breakpoint: you |
3254 | enable, disable, and delete both breakpoints and watchpoints using the | |
3255 | same commands. | |
c906108c SS |
3256 | |
3257 | You can arrange to have values from your program displayed automatically | |
3258 | whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,, | |
79a6e687 | 3259 | Automatic Display}. |
c906108c SS |
3260 | |
3261 | @cindex catchpoints | |
3262 | @cindex breakpoint on events | |
3263 | A @dfn{catchpoint} is another special breakpoint that stops your program | |
b37052ae | 3264 | when a certain kind of event occurs, such as the throwing of a C@t{++} |
c906108c SS |
3265 | exception or the loading of a library. As with watchpoints, you use a |
3266 | different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting | |
79a6e687 | 3267 | Catchpoints}), but aside from that, you can manage a catchpoint like any |
c906108c | 3268 | other breakpoint. (To stop when your program receives a signal, use the |
d4f3574e | 3269 | @code{handle} command; see @ref{Signals, ,Signals}.) |
c906108c SS |
3270 | |
3271 | @cindex breakpoint numbers | |
3272 | @cindex numbers for breakpoints | |
3273 | @value{GDBN} assigns a number to each breakpoint, watchpoint, or | |
3274 | catchpoint when you create it; these numbers are successive integers | |
3275 | starting with one. In many of the commands for controlling various | |
3276 | features of breakpoints you use the breakpoint number to say which | |
3277 | breakpoint you want to change. Each breakpoint may be @dfn{enabled} or | |
3278 | @dfn{disabled}; if disabled, it has no effect on your program until you | |
3279 | enable it again. | |
3280 | ||
c5394b80 JM |
3281 | @cindex breakpoint ranges |
3282 | @cindex ranges of breakpoints | |
3283 | Some @value{GDBN} commands accept a range of breakpoints on which to | |
3284 | operate. A breakpoint range is either a single breakpoint number, like | |
3285 | @samp{5}, or two such numbers, in increasing order, separated by a | |
3286 | hyphen, like @samp{5-7}. When a breakpoint range is given to a command, | |
d52fb0e9 | 3287 | all breakpoints in that range are operated on. |
c5394b80 | 3288 | |
c906108c SS |
3289 | @menu |
3290 | * Set Breaks:: Setting breakpoints | |
3291 | * Set Watchpoints:: Setting watchpoints | |
3292 | * Set Catchpoints:: Setting catchpoints | |
3293 | * Delete Breaks:: Deleting breakpoints | |
3294 | * Disabling:: Disabling breakpoints | |
3295 | * Conditions:: Break conditions | |
3296 | * Break Commands:: Breakpoint command lists | |
6149aea9 | 3297 | * Save Breakpoints:: How to save breakpoints in a file |
d4f3574e | 3298 | * Error in Breakpoints:: ``Cannot insert breakpoints'' |
79a6e687 | 3299 | * Breakpoint-related Warnings:: ``Breakpoint address adjusted...'' |
c906108c SS |
3300 | @end menu |
3301 | ||
6d2ebf8b | 3302 | @node Set Breaks |
79a6e687 | 3303 | @subsection Setting Breakpoints |
c906108c | 3304 | |
5d161b24 | 3305 | @c FIXME LMB what does GDB do if no code on line of breakpt? |
c906108c SS |
3306 | @c consider in particular declaration with/without initialization. |
3307 | @c | |
3308 | @c FIXME 2 is there stuff on this already? break at fun start, already init? | |
3309 | ||
3310 | @kindex break | |
41afff9a EZ |
3311 | @kindex b @r{(@code{break})} |
3312 | @vindex $bpnum@r{, convenience variable} | |
c906108c SS |
3313 | @cindex latest breakpoint |
3314 | Breakpoints are set with the @code{break} command (abbreviated | |
5d161b24 | 3315 | @code{b}). The debugger convenience variable @samp{$bpnum} records the |
f3b28801 | 3316 | number of the breakpoint you've set most recently; see @ref{Convenience |
79a6e687 | 3317 | Vars,, Convenience Variables}, for a discussion of what you can do with |
c906108c SS |
3318 | convenience variables. |
3319 | ||
c906108c | 3320 | @table @code |
2a25a5ba EZ |
3321 | @item break @var{location} |
3322 | Set a breakpoint at the given @var{location}, which can specify a | |
3323 | function name, a line number, or an address of an instruction. | |
3324 | (@xref{Specify Location}, for a list of all the possible ways to | |
3325 | specify a @var{location}.) The breakpoint will stop your program just | |
3326 | before it executes any of the code in the specified @var{location}. | |
3327 | ||
c906108c | 3328 | When using source languages that permit overloading of symbols, such as |
2a25a5ba | 3329 | C@t{++}, a function name may refer to more than one possible place to break. |
6ba66d6a JB |
3330 | @xref{Ambiguous Expressions,,Ambiguous Expressions}, for a discussion of |
3331 | that situation. | |
c906108c | 3332 | |
45ac276d | 3333 | It is also possible to insert a breakpoint that will stop the program |
2c88c651 JB |
3334 | only if a specific thread (@pxref{Thread-Specific Breakpoints}) |
3335 | or a specific task (@pxref{Ada Tasks}) hits that breakpoint. | |
45ac276d | 3336 | |
c906108c SS |
3337 | @item break |
3338 | When called without any arguments, @code{break} sets a breakpoint at | |
3339 | the next instruction to be executed in the selected stack frame | |
3340 | (@pxref{Stack, ,Examining the Stack}). In any selected frame but the | |
3341 | innermost, this makes your program stop as soon as control | |
3342 | returns to that frame. This is similar to the effect of a | |
3343 | @code{finish} command in the frame inside the selected frame---except | |
3344 | that @code{finish} does not leave an active breakpoint. If you use | |
3345 | @code{break} without an argument in the innermost frame, @value{GDBN} stops | |
3346 | the next time it reaches the current location; this may be useful | |
3347 | inside loops. | |
3348 | ||
3349 | @value{GDBN} normally ignores breakpoints when it resumes execution, until at | |
3350 | least one instruction has been executed. If it did not do this, you | |
3351 | would be unable to proceed past a breakpoint without first disabling the | |
3352 | breakpoint. This rule applies whether or not the breakpoint already | |
3353 | existed when your program stopped. | |
3354 | ||
3355 | @item break @dots{} if @var{cond} | |
3356 | Set a breakpoint with condition @var{cond}; evaluate the expression | |
3357 | @var{cond} each time the breakpoint is reached, and stop only if the | |
3358 | value is nonzero---that is, if @var{cond} evaluates as true. | |
3359 | @samp{@dots{}} stands for one of the possible arguments described | |
3360 | above (or no argument) specifying where to break. @xref{Conditions, | |
79a6e687 | 3361 | ,Break Conditions}, for more information on breakpoint conditions. |
c906108c SS |
3362 | |
3363 | @kindex tbreak | |
3364 | @item tbreak @var{args} | |
3365 | Set a breakpoint enabled only for one stop. @var{args} are the | |
3366 | same as for the @code{break} command, and the breakpoint is set in the same | |
3367 | way, but the breakpoint is automatically deleted after the first time your | |
79a6e687 | 3368 | program stops there. @xref{Disabling, ,Disabling Breakpoints}. |
c906108c | 3369 | |
c906108c | 3370 | @kindex hbreak |
ba04e063 | 3371 | @cindex hardware breakpoints |
c906108c | 3372 | @item hbreak @var{args} |
d4f3574e SS |
3373 | Set a hardware-assisted breakpoint. @var{args} are the same as for the |
3374 | @code{break} command and the breakpoint is set in the same way, but the | |
c906108c SS |
3375 | breakpoint requires hardware support and some target hardware may not |
3376 | have this support. The main purpose of this is EPROM/ROM code | |
d4f3574e SS |
3377 | debugging, so you can set a breakpoint at an instruction without |
3378 | changing the instruction. This can be used with the new trap-generation | |
09d4efe1 | 3379 | provided by SPARClite DSU and most x86-based targets. These targets |
d4f3574e SS |
3380 | will generate traps when a program accesses some data or instruction |
3381 | address that is assigned to the debug registers. However the hardware | |
3382 | breakpoint registers can take a limited number of breakpoints. For | |
3383 | example, on the DSU, only two data breakpoints can be set at a time, and | |
3384 | @value{GDBN} will reject this command if more than two are used. Delete | |
3385 | or disable unused hardware breakpoints before setting new ones | |
79a6e687 BW |
3386 | (@pxref{Disabling, ,Disabling Breakpoints}). |
3387 | @xref{Conditions, ,Break Conditions}. | |
9c16f35a EZ |
3388 | For remote targets, you can restrict the number of hardware |
3389 | breakpoints @value{GDBN} will use, see @ref{set remote | |
3390 | hardware-breakpoint-limit}. | |
501eef12 | 3391 | |
c906108c SS |
3392 | @kindex thbreak |
3393 | @item thbreak @var{args} | |
3394 | Set a hardware-assisted breakpoint enabled only for one stop. @var{args} | |
3395 | are the same as for the @code{hbreak} command and the breakpoint is set in | |
5d161b24 | 3396 | the same way. However, like the @code{tbreak} command, |
c906108c SS |
3397 | the breakpoint is automatically deleted after the |
3398 | first time your program stops there. Also, like the @code{hbreak} | |
5d161b24 | 3399 | command, the breakpoint requires hardware support and some target hardware |
79a6e687 BW |
3400 | may not have this support. @xref{Disabling, ,Disabling Breakpoints}. |
3401 | See also @ref{Conditions, ,Break Conditions}. | |
c906108c SS |
3402 | |
3403 | @kindex rbreak | |
3404 | @cindex regular expression | |
8bd10a10 | 3405 | @cindex breakpoints at functions matching a regexp |
c45da7e6 | 3406 | @cindex set breakpoints in many functions |
c906108c | 3407 | @item rbreak @var{regex} |
c906108c | 3408 | Set breakpoints on all functions matching the regular expression |
11cf8741 JM |
3409 | @var{regex}. This command sets an unconditional breakpoint on all |
3410 | matches, printing a list of all breakpoints it set. Once these | |
3411 | breakpoints are set, they are treated just like the breakpoints set with | |
3412 | the @code{break} command. You can delete them, disable them, or make | |
3413 | them conditional the same way as any other breakpoint. | |
3414 | ||
3415 | The syntax of the regular expression is the standard one used with tools | |
3416 | like @file{grep}. Note that this is different from the syntax used by | |
3417 | shells, so for instance @code{foo*} matches all functions that include | |
3418 | an @code{fo} followed by zero or more @code{o}s. There is an implicit | |
3419 | @code{.*} leading and trailing the regular expression you supply, so to | |
3420 | match only functions that begin with @code{foo}, use @code{^foo}. | |
c906108c | 3421 | |
f7dc1244 | 3422 | @cindex non-member C@t{++} functions, set breakpoint in |
b37052ae | 3423 | When debugging C@t{++} programs, @code{rbreak} is useful for setting |
c906108c SS |
3424 | breakpoints on overloaded functions that are not members of any special |
3425 | classes. | |
c906108c | 3426 | |
f7dc1244 EZ |
3427 | @cindex set breakpoints on all functions |
3428 | The @code{rbreak} command can be used to set breakpoints in | |
3429 | @strong{all} the functions in a program, like this: | |
3430 | ||
3431 | @smallexample | |
3432 | (@value{GDBP}) rbreak . | |
3433 | @end smallexample | |
3434 | ||
8bd10a10 CM |
3435 | @item rbreak @var{file}:@var{regex} |
3436 | If @code{rbreak} is called with a filename qualification, it limits | |
3437 | the search for functions matching the given regular expression to the | |
3438 | specified @var{file}. This can be used, for example, to set breakpoints on | |
3439 | every function in a given file: | |
3440 | ||
3441 | @smallexample | |
3442 | (@value{GDBP}) rbreak file.c:. | |
3443 | @end smallexample | |
3444 | ||
3445 | The colon separating the filename qualifier from the regex may | |
3446 | optionally be surrounded by spaces. | |
3447 | ||
c906108c SS |
3448 | @kindex info breakpoints |
3449 | @cindex @code{$_} and @code{info breakpoints} | |
e5a67952 MS |
3450 | @item info breakpoints @r{[}@var{n}@dots{}@r{]} |
3451 | @itemx info break @r{[}@var{n}@dots{}@r{]} | |
c906108c | 3452 | Print a table of all breakpoints, watchpoints, and catchpoints set and |
45ac1734 | 3453 | not deleted. Optional argument @var{n} means print information only |
e5a67952 MS |
3454 | about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)). |
3455 | For each breakpoint, following columns are printed: | |
c906108c SS |
3456 | |
3457 | @table @emph | |
3458 | @item Breakpoint Numbers | |
3459 | @item Type | |
3460 | Breakpoint, watchpoint, or catchpoint. | |
3461 | @item Disposition | |
3462 | Whether the breakpoint is marked to be disabled or deleted when hit. | |
3463 | @item Enabled or Disabled | |
3464 | Enabled breakpoints are marked with @samp{y}. @samp{n} marks breakpoints | |
b3db7447 | 3465 | that are not enabled. |
c906108c | 3466 | @item Address |
fe6fbf8b | 3467 | Where the breakpoint is in your program, as a memory address. For a |
b3db7447 NR |
3468 | pending breakpoint whose address is not yet known, this field will |
3469 | contain @samp{<PENDING>}. Such breakpoint won't fire until a shared | |
3470 | library that has the symbol or line referred by breakpoint is loaded. | |
3471 | See below for details. A breakpoint with several locations will | |
3b784c4f | 3472 | have @samp{<MULTIPLE>} in this field---see below for details. |
c906108c SS |
3473 | @item What |
3474 | Where the breakpoint is in the source for your program, as a file and | |
2650777c JJ |
3475 | line number. For a pending breakpoint, the original string passed to |
3476 | the breakpoint command will be listed as it cannot be resolved until | |
3477 | the appropriate shared library is loaded in the future. | |
c906108c SS |
3478 | @end table |
3479 | ||
3480 | @noindent | |
3481 | If a breakpoint is conditional, @code{info break} shows the condition on | |
3482 | the line following the affected breakpoint; breakpoint commands, if any, | |
2650777c JJ |
3483 | are listed after that. A pending breakpoint is allowed to have a condition |
3484 | specified for it. The condition is not parsed for validity until a shared | |
3485 | library is loaded that allows the pending breakpoint to resolve to a | |
3486 | valid location. | |
c906108c SS |
3487 | |
3488 | @noindent | |
3489 | @code{info break} with a breakpoint | |
3490 | number @var{n} as argument lists only that breakpoint. The | |
3491 | convenience variable @code{$_} and the default examining-address for | |
3492 | the @code{x} command are set to the address of the last breakpoint | |
79a6e687 | 3493 | listed (@pxref{Memory, ,Examining Memory}). |
c906108c SS |
3494 | |
3495 | @noindent | |
3496 | @code{info break} displays a count of the number of times the breakpoint | |
3497 | has been hit. This is especially useful in conjunction with the | |
3498 | @code{ignore} command. You can ignore a large number of breakpoint | |
3499 | hits, look at the breakpoint info to see how many times the breakpoint | |
3500 | was hit, and then run again, ignoring one less than that number. This | |
3501 | will get you quickly to the last hit of that breakpoint. | |
3502 | @end table | |
3503 | ||
3504 | @value{GDBN} allows you to set any number of breakpoints at the same place in | |
3505 | your program. There is nothing silly or meaningless about this. When | |
3506 | the breakpoints are conditional, this is even useful | |
79a6e687 | 3507 | (@pxref{Conditions, ,Break Conditions}). |
c906108c | 3508 | |
2e9132cc EZ |
3509 | @cindex multiple locations, breakpoints |
3510 | @cindex breakpoints, multiple locations | |
fcda367b | 3511 | It is possible that a breakpoint corresponds to several locations |
fe6fbf8b VP |
3512 | in your program. Examples of this situation are: |
3513 | ||
3514 | @itemize @bullet | |
fe6fbf8b VP |
3515 | @item |
3516 | For a C@t{++} constructor, the @value{NGCC} compiler generates several | |
3517 | instances of the function body, used in different cases. | |
3518 | ||
3519 | @item | |
3520 | For a C@t{++} template function, a given line in the function can | |
3521 | correspond to any number of instantiations. | |
3522 | ||
3523 | @item | |
3524 | For an inlined function, a given source line can correspond to | |
3525 | several places where that function is inlined. | |
fe6fbf8b VP |
3526 | @end itemize |
3527 | ||
3528 | In all those cases, @value{GDBN} will insert a breakpoint at all | |
2e9132cc EZ |
3529 | the relevant locations@footnote{ |
3530 | As of this writing, multiple-location breakpoints work only if there's | |
3531 | line number information for all the locations. This means that they | |
3532 | will generally not work in system libraries, unless you have debug | |
3533 | info with line numbers for them.}. | |
fe6fbf8b | 3534 | |
3b784c4f EZ |
3535 | A breakpoint with multiple locations is displayed in the breakpoint |
3536 | table using several rows---one header row, followed by one row for | |
3537 | each breakpoint location. The header row has @samp{<MULTIPLE>} in the | |
3538 | address column. The rows for individual locations contain the actual | |
3539 | addresses for locations, and show the functions to which those | |
3540 | locations belong. The number column for a location is of the form | |
fe6fbf8b VP |
3541 | @var{breakpoint-number}.@var{location-number}. |
3542 | ||
3543 | For example: | |
3b784c4f | 3544 | |
fe6fbf8b VP |
3545 | @smallexample |
3546 | Num Type Disp Enb Address What | |
3547 | 1 breakpoint keep y <MULTIPLE> | |
3548 | stop only if i==1 | |
3549 | breakpoint already hit 1 time | |
3550 | 1.1 y 0x080486a2 in void foo<int>() at t.cc:8 | |
3551 | 1.2 y 0x080486ca in void foo<double>() at t.cc:8 | |
3552 | @end smallexample | |
3553 | ||
3554 | Each location can be individually enabled or disabled by passing | |
3555 | @var{breakpoint-number}.@var{location-number} as argument to the | |
3b784c4f EZ |
3556 | @code{enable} and @code{disable} commands. Note that you cannot |
3557 | delete the individual locations from the list, you can only delete the | |
16bfc218 | 3558 | entire list of locations that belong to their parent breakpoint (with |
3b784c4f EZ |
3559 | the @kbd{delete @var{num}} command, where @var{num} is the number of |
3560 | the parent breakpoint, 1 in the above example). Disabling or enabling | |
3561 | the parent breakpoint (@pxref{Disabling}) affects all of the locations | |
3562 | that belong to that breakpoint. | |
fe6fbf8b | 3563 | |
2650777c | 3564 | @cindex pending breakpoints |
fe6fbf8b | 3565 | It's quite common to have a breakpoint inside a shared library. |
3b784c4f | 3566 | Shared libraries can be loaded and unloaded explicitly, |
fe6fbf8b VP |
3567 | and possibly repeatedly, as the program is executed. To support |
3568 | this use case, @value{GDBN} updates breakpoint locations whenever | |
3569 | any shared library is loaded or unloaded. Typically, you would | |
fcda367b | 3570 | set a breakpoint in a shared library at the beginning of your |
fe6fbf8b VP |
3571 | debugging session, when the library is not loaded, and when the |
3572 | symbols from the library are not available. When you try to set | |
3573 | breakpoint, @value{GDBN} will ask you if you want to set | |
3b784c4f | 3574 | a so called @dfn{pending breakpoint}---breakpoint whose address |
fe6fbf8b VP |
3575 | is not yet resolved. |
3576 | ||
3577 | After the program is run, whenever a new shared library is loaded, | |
3578 | @value{GDBN} reevaluates all the breakpoints. When a newly loaded | |
3579 | shared library contains the symbol or line referred to by some | |
3580 | pending breakpoint, that breakpoint is resolved and becomes an | |
3581 | ordinary breakpoint. When a library is unloaded, all breakpoints | |
3582 | that refer to its symbols or source lines become pending again. | |
3583 | ||
3584 | This logic works for breakpoints with multiple locations, too. For | |
3585 | example, if you have a breakpoint in a C@t{++} template function, and | |
3586 | a newly loaded shared library has an instantiation of that template, | |
3587 | a new location is added to the list of locations for the breakpoint. | |
3588 | ||
3589 | Except for having unresolved address, pending breakpoints do not | |
3590 | differ from regular breakpoints. You can set conditions or commands, | |
3591 | enable and disable them and perform other breakpoint operations. | |
3592 | ||
3593 | @value{GDBN} provides some additional commands for controlling what | |
3594 | happens when the @samp{break} command cannot resolve breakpoint | |
3595 | address specification to an address: | |
dd79a6cf JJ |
3596 | |
3597 | @kindex set breakpoint pending | |
3598 | @kindex show breakpoint pending | |
3599 | @table @code | |
3600 | @item set breakpoint pending auto | |
3601 | This is the default behavior. When @value{GDBN} cannot find the breakpoint | |
3602 | location, it queries you whether a pending breakpoint should be created. | |
3603 | ||
3604 | @item set breakpoint pending on | |
3605 | This indicates that an unrecognized breakpoint location should automatically | |
3606 | result in a pending breakpoint being created. | |
3607 | ||
3608 | @item set breakpoint pending off | |
3609 | This indicates that pending breakpoints are not to be created. Any | |
3610 | unrecognized breakpoint location results in an error. This setting does | |
3611 | not affect any pending breakpoints previously created. | |
3612 | ||
3613 | @item show breakpoint pending | |
3614 | Show the current behavior setting for creating pending breakpoints. | |
3615 | @end table | |
2650777c | 3616 | |
fe6fbf8b VP |
3617 | The settings above only affect the @code{break} command and its |
3618 | variants. Once breakpoint is set, it will be automatically updated | |
3619 | as shared libraries are loaded and unloaded. | |
2650777c | 3620 | |
765dc015 VP |
3621 | @cindex automatic hardware breakpoints |
3622 | For some targets, @value{GDBN} can automatically decide if hardware or | |
3623 | software breakpoints should be used, depending on whether the | |
3624 | breakpoint address is read-only or read-write. This applies to | |
3625 | breakpoints set with the @code{break} command as well as to internal | |
3626 | breakpoints set by commands like @code{next} and @code{finish}. For | |
fcda367b | 3627 | breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware |
765dc015 VP |
3628 | breakpoints. |
3629 | ||
3630 | You can control this automatic behaviour with the following commands:: | |
3631 | ||
3632 | @kindex set breakpoint auto-hw | |
3633 | @kindex show breakpoint auto-hw | |
3634 | @table @code | |
3635 | @item set breakpoint auto-hw on | |
3636 | This is the default behavior. When @value{GDBN} sets a breakpoint, it | |
3637 | will try to use the target memory map to decide if software or hardware | |
3638 | breakpoint must be used. | |
3639 | ||
3640 | @item set breakpoint auto-hw off | |
3641 | This indicates @value{GDBN} should not automatically select breakpoint | |
3642 | type. If the target provides a memory map, @value{GDBN} will warn when | |
3643 | trying to set software breakpoint at a read-only address. | |
3644 | @end table | |
3645 | ||
74960c60 VP |
3646 | @value{GDBN} normally implements breakpoints by replacing the program code |
3647 | at the breakpoint address with a special instruction, which, when | |
3648 | executed, given control to the debugger. By default, the program | |
3649 | code is so modified only when the program is resumed. As soon as | |
3650 | the program stops, @value{GDBN} restores the original instructions. This | |
3651 | behaviour guards against leaving breakpoints inserted in the | |
3652 | target should gdb abrubptly disconnect. However, with slow remote | |
3653 | targets, inserting and removing breakpoint can reduce the performance. | |
3654 | This behavior can be controlled with the following commands:: | |
3655 | ||
3656 | @kindex set breakpoint always-inserted | |
3657 | @kindex show breakpoint always-inserted | |
3658 | @table @code | |
3659 | @item set breakpoint always-inserted off | |
33e5cbd6 PA |
3660 | All breakpoints, including newly added by the user, are inserted in |
3661 | the target only when the target is resumed. All breakpoints are | |
3662 | removed from the target when it stops. | |
74960c60 VP |
3663 | |
3664 | @item set breakpoint always-inserted on | |
3665 | Causes all breakpoints to be inserted in the target at all times. If | |
3666 | the user adds a new breakpoint, or changes an existing breakpoint, the | |
3667 | breakpoints in the target are updated immediately. A breakpoint is | |
3668 | removed from the target only when breakpoint itself is removed. | |
33e5cbd6 PA |
3669 | |
3670 | @cindex non-stop mode, and @code{breakpoint always-inserted} | |
3671 | @item set breakpoint always-inserted auto | |
3672 | This is the default mode. If @value{GDBN} is controlling the inferior | |
3673 | in non-stop mode (@pxref{Non-Stop Mode}), gdb behaves as if | |
3674 | @code{breakpoint always-inserted} mode is on. If @value{GDBN} is | |
3675 | controlling the inferior in all-stop mode, @value{GDBN} behaves as if | |
3676 | @code{breakpoint always-inserted} mode is off. | |
74960c60 | 3677 | @end table |
765dc015 | 3678 | |
c906108c SS |
3679 | @cindex negative breakpoint numbers |
3680 | @cindex internal @value{GDBN} breakpoints | |
eb12ee30 AC |
3681 | @value{GDBN} itself sometimes sets breakpoints in your program for |
3682 | special purposes, such as proper handling of @code{longjmp} (in C | |
3683 | programs). These internal breakpoints are assigned negative numbers, | |
3684 | starting with @code{-1}; @samp{info breakpoints} does not display them. | |
c906108c | 3685 | You can see these breakpoints with the @value{GDBN} maintenance command |
eb12ee30 | 3686 | @samp{maint info breakpoints} (@pxref{maint info breakpoints}). |
c906108c SS |
3687 | |
3688 | ||
6d2ebf8b | 3689 | @node Set Watchpoints |
79a6e687 | 3690 | @subsection Setting Watchpoints |
c906108c SS |
3691 | |
3692 | @cindex setting watchpoints | |
c906108c SS |
3693 | You can use a watchpoint to stop execution whenever the value of an |
3694 | expression changes, without having to predict a particular place where | |
fd60e0df EZ |
3695 | this may happen. (This is sometimes called a @dfn{data breakpoint}.) |
3696 | The expression may be as simple as the value of a single variable, or | |
3697 | as complex as many variables combined by operators. Examples include: | |
3698 | ||
3699 | @itemize @bullet | |
3700 | @item | |
3701 | A reference to the value of a single variable. | |
3702 | ||
3703 | @item | |
3704 | An address cast to an appropriate data type. For example, | |
3705 | @samp{*(int *)0x12345678} will watch a 4-byte region at the specified | |
3706 | address (assuming an @code{int} occupies 4 bytes). | |
3707 | ||
3708 | @item | |
3709 | An arbitrarily complex expression, such as @samp{a*b + c/d}. The | |
3710 | expression can use any operators valid in the program's native | |
3711 | language (@pxref{Languages}). | |
3712 | @end itemize | |
c906108c | 3713 | |
fa4727a6 DJ |
3714 | You can set a watchpoint on an expression even if the expression can |
3715 | not be evaluated yet. For instance, you can set a watchpoint on | |
3716 | @samp{*global_ptr} before @samp{global_ptr} is initialized. | |
3717 | @value{GDBN} will stop when your program sets @samp{global_ptr} and | |
3718 | the expression produces a valid value. If the expression becomes | |
3719 | valid in some other way than changing a variable (e.g.@: if the memory | |
3720 | pointed to by @samp{*global_ptr} becomes readable as the result of a | |
3721 | @code{malloc} call), @value{GDBN} may not stop until the next time | |
3722 | the expression changes. | |
3723 | ||
82f2d802 EZ |
3724 | @cindex software watchpoints |
3725 | @cindex hardware watchpoints | |
c906108c | 3726 | Depending on your system, watchpoints may be implemented in software or |
2df3850c | 3727 | hardware. @value{GDBN} does software watchpointing by single-stepping your |
c906108c SS |
3728 | program and testing the variable's value each time, which is hundreds of |
3729 | times slower than normal execution. (But this may still be worth it, to | |
3730 | catch errors where you have no clue what part of your program is the | |
3731 | culprit.) | |
3732 | ||
37e4754d | 3733 | On some systems, such as HP-UX, PowerPC, @sc{gnu}/Linux and most other |
82f2d802 EZ |
3734 | x86-based targets, @value{GDBN} includes support for hardware |
3735 | watchpoints, which do not slow down the running of your program. | |
c906108c SS |
3736 | |
3737 | @table @code | |
3738 | @kindex watch | |
9c06b0b4 | 3739 | @item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} @r{[}mask @var{maskvalue}@r{]} |
fd60e0df EZ |
3740 | Set a watchpoint for an expression. @value{GDBN} will break when the |
3741 | expression @var{expr} is written into by the program and its value | |
3742 | changes. The simplest (and the most popular) use of this command is | |
3743 | to watch the value of a single variable: | |
3744 | ||
3745 | @smallexample | |
3746 | (@value{GDBP}) watch foo | |
3747 | @end smallexample | |
c906108c | 3748 | |
d8b2a693 | 3749 | If the command includes a @code{@r{[}thread @var{threadnum}@r{]}} |
9c06b0b4 | 3750 | argument, @value{GDBN} breaks only when the thread identified by |
d8b2a693 JB |
3751 | @var{threadnum} changes the value of @var{expr}. If any other threads |
3752 | change the value of @var{expr}, @value{GDBN} will not break. Note | |
3753 | that watchpoints restricted to a single thread in this way only work | |
3754 | with Hardware Watchpoints. | |
3755 | ||
06a64a0b TT |
3756 | Ordinarily a watchpoint respects the scope of variables in @var{expr} |
3757 | (see below). The @code{-location} argument tells @value{GDBN} to | |
3758 | instead watch the memory referred to by @var{expr}. In this case, | |
3759 | @value{GDBN} will evaluate @var{expr}, take the address of the result, | |
3760 | and watch the memory at that address. The type of the result is used | |
3761 | to determine the size of the watched memory. If the expression's | |
3762 | result does not have an address, then @value{GDBN} will print an | |
3763 | error. | |
3764 | ||
9c06b0b4 TJB |
3765 | The @code{@r{[}mask @var{maskvalue}@r{]}} argument allows creation |
3766 | of masked watchpoints, if the current architecture supports this | |
3767 | feature (e.g., PowerPC Embedded architecture, see @ref{PowerPC | |
3768 | Embedded}.) A @dfn{masked watchpoint} specifies a mask in addition | |
3769 | to an address to watch. The mask specifies that some bits of an address | |
3770 | (the bits which are reset in the mask) should be ignored when matching | |
3771 | the address accessed by the inferior against the watchpoint address. | |
3772 | Thus, a masked watchpoint watches many addresses simultaneously---those | |
3773 | addresses whose unmasked bits are identical to the unmasked bits in the | |
3774 | watchpoint address. The @code{mask} argument implies @code{-location}. | |
3775 | Examples: | |
3776 | ||
3777 | @smallexample | |
3778 | (@value{GDBP}) watch foo mask 0xffff00ff | |
3779 | (@value{GDBP}) watch *0xdeadbeef mask 0xffffff00 | |
3780 | @end smallexample | |
3781 | ||
c906108c | 3782 | @kindex rwatch |
9c06b0b4 | 3783 | @item rwatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} @r{[}mask @var{maskvalue}@r{]} |
09d4efe1 EZ |
3784 | Set a watchpoint that will break when the value of @var{expr} is read |
3785 | by the program. | |
c906108c SS |
3786 | |
3787 | @kindex awatch | |
9c06b0b4 | 3788 | @item awatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} @r{[}mask @var{maskvalue}@r{]} |
09d4efe1 EZ |
3789 | Set a watchpoint that will break when @var{expr} is either read from |
3790 | or written into by the program. | |
c906108c | 3791 | |
e5a67952 MS |
3792 | @kindex info watchpoints @r{[}@var{n}@dots{}@r{]} |
3793 | @item info watchpoints @r{[}@var{n}@dots{}@r{]} | |
d77f58be SS |
3794 | This command prints a list of watchpoints, using the same format as |
3795 | @code{info break} (@pxref{Set Breaks}). | |
c906108c SS |
3796 | @end table |
3797 | ||
65d79d4b SDJ |
3798 | If you watch for a change in a numerically entered address you need to |
3799 | dereference it, as the address itself is just a constant number which will | |
3800 | never change. @value{GDBN} refuses to create a watchpoint that watches | |
3801 | a never-changing value: | |
3802 | ||
3803 | @smallexample | |
3804 | (@value{GDBP}) watch 0x600850 | |
3805 | Cannot watch constant value 0x600850. | |
3806 | (@value{GDBP}) watch *(int *) 0x600850 | |
3807 | Watchpoint 1: *(int *) 6293584 | |
3808 | @end smallexample | |
3809 | ||
c906108c SS |
3810 | @value{GDBN} sets a @dfn{hardware watchpoint} if possible. Hardware |
3811 | watchpoints execute very quickly, and the debugger reports a change in | |
3812 | value at the exact instruction where the change occurs. If @value{GDBN} | |
3813 | cannot set a hardware watchpoint, it sets a software watchpoint, which | |
3814 | executes more slowly and reports the change in value at the next | |
82f2d802 EZ |
3815 | @emph{statement}, not the instruction, after the change occurs. |
3816 | ||
82f2d802 EZ |
3817 | @cindex use only software watchpoints |
3818 | You can force @value{GDBN} to use only software watchpoints with the | |
3819 | @kbd{set can-use-hw-watchpoints 0} command. With this variable set to | |
3820 | zero, @value{GDBN} will never try to use hardware watchpoints, even if | |
3821 | the underlying system supports them. (Note that hardware-assisted | |
3822 | watchpoints that were set @emph{before} setting | |
3823 | @code{can-use-hw-watchpoints} to zero will still use the hardware | |
d3e8051b | 3824 | mechanism of watching expression values.) |
c906108c | 3825 | |
9c16f35a EZ |
3826 | @table @code |
3827 | @item set can-use-hw-watchpoints | |
3828 | @kindex set can-use-hw-watchpoints | |
3829 | Set whether or not to use hardware watchpoints. | |
3830 | ||
3831 | @item show can-use-hw-watchpoints | |
3832 | @kindex show can-use-hw-watchpoints | |
3833 | Show the current mode of using hardware watchpoints. | |
3834 | @end table | |
3835 | ||
3836 | For remote targets, you can restrict the number of hardware | |
3837 | watchpoints @value{GDBN} will use, see @ref{set remote | |
3838 | hardware-breakpoint-limit}. | |
3839 | ||
c906108c SS |
3840 | When you issue the @code{watch} command, @value{GDBN} reports |
3841 | ||
474c8240 | 3842 | @smallexample |
c906108c | 3843 | Hardware watchpoint @var{num}: @var{expr} |
474c8240 | 3844 | @end smallexample |
c906108c SS |
3845 | |
3846 | @noindent | |
3847 | if it was able to set a hardware watchpoint. | |
3848 | ||
7be570e7 JM |
3849 | Currently, the @code{awatch} and @code{rwatch} commands can only set |
3850 | hardware watchpoints, because accesses to data that don't change the | |
3851 | value of the watched expression cannot be detected without examining | |
3852 | every instruction as it is being executed, and @value{GDBN} does not do | |
3853 | that currently. If @value{GDBN} finds that it is unable to set a | |
3854 | hardware breakpoint with the @code{awatch} or @code{rwatch} command, it | |
3855 | will print a message like this: | |
3856 | ||
3857 | @smallexample | |
3858 | Expression cannot be implemented with read/access watchpoint. | |
3859 | @end smallexample | |
3860 | ||
3861 | Sometimes, @value{GDBN} cannot set a hardware watchpoint because the | |
3862 | data type of the watched expression is wider than what a hardware | |
3863 | watchpoint on the target machine can handle. For example, some systems | |
3864 | can only watch regions that are up to 4 bytes wide; on such systems you | |
3865 | cannot set hardware watchpoints for an expression that yields a | |
3866 | double-precision floating-point number (which is typically 8 bytes | |
3867 | wide). As a work-around, it might be possible to break the large region | |
3868 | into a series of smaller ones and watch them with separate watchpoints. | |
3869 | ||
3870 | If you set too many hardware watchpoints, @value{GDBN} might be unable | |
3871 | to insert all of them when you resume the execution of your program. | |
3872 | Since the precise number of active watchpoints is unknown until such | |
3873 | time as the program is about to be resumed, @value{GDBN} might not be | |
3874 | able to warn you about this when you set the watchpoints, and the | |
3875 | warning will be printed only when the program is resumed: | |
3876 | ||
3877 | @smallexample | |
3878 | Hardware watchpoint @var{num}: Could not insert watchpoint | |
3879 | @end smallexample | |
3880 | ||
3881 | @noindent | |
3882 | If this happens, delete or disable some of the watchpoints. | |
3883 | ||
fd60e0df EZ |
3884 | Watching complex expressions that reference many variables can also |
3885 | exhaust the resources available for hardware-assisted watchpoints. | |
3886 | That's because @value{GDBN} needs to watch every variable in the | |
3887 | expression with separately allocated resources. | |
3888 | ||
c906108c | 3889 | If you call a function interactively using @code{print} or @code{call}, |
2df3850c | 3890 | any watchpoints you have set will be inactive until @value{GDBN} reaches another |
c906108c SS |
3891 | kind of breakpoint or the call completes. |
3892 | ||
7be570e7 JM |
3893 | @value{GDBN} automatically deletes watchpoints that watch local |
3894 | (automatic) variables, or expressions that involve such variables, when | |
3895 | they go out of scope, that is, when the execution leaves the block in | |
3896 | which these variables were defined. In particular, when the program | |
3897 | being debugged terminates, @emph{all} local variables go out of scope, | |
3898 | and so only watchpoints that watch global variables remain set. If you | |
3899 | rerun the program, you will need to set all such watchpoints again. One | |
3900 | way of doing that would be to set a code breakpoint at the entry to the | |
3901 | @code{main} function and when it breaks, set all the watchpoints. | |
3902 | ||
c906108c SS |
3903 | @cindex watchpoints and threads |
3904 | @cindex threads and watchpoints | |
d983da9c DJ |
3905 | In multi-threaded programs, watchpoints will detect changes to the |
3906 | watched expression from every thread. | |
3907 | ||
3908 | @quotation | |
3909 | @emph{Warning:} In multi-threaded programs, software watchpoints | |
53a5351d JM |
3910 | have only limited usefulness. If @value{GDBN} creates a software |
3911 | watchpoint, it can only watch the value of an expression @emph{in a | |
3912 | single thread}. If you are confident that the expression can only | |
3913 | change due to the current thread's activity (and if you are also | |
3914 | confident that no other thread can become current), then you can use | |
3915 | software watchpoints as usual. However, @value{GDBN} may not notice | |
3916 | when a non-current thread's activity changes the expression. (Hardware | |
3917 | watchpoints, in contrast, watch an expression in all threads.) | |
c906108c | 3918 | @end quotation |
c906108c | 3919 | |
501eef12 AC |
3920 | @xref{set remote hardware-watchpoint-limit}. |
3921 | ||
6d2ebf8b | 3922 | @node Set Catchpoints |
79a6e687 | 3923 | @subsection Setting Catchpoints |
d4f3574e | 3924 | @cindex catchpoints, setting |
c906108c SS |
3925 | @cindex exception handlers |
3926 | @cindex event handling | |
3927 | ||
3928 | You can use @dfn{catchpoints} to cause the debugger to stop for certain | |
b37052ae | 3929 | kinds of program events, such as C@t{++} exceptions or the loading of a |
c906108c SS |
3930 | shared library. Use the @code{catch} command to set a catchpoint. |
3931 | ||
3932 | @table @code | |
3933 | @kindex catch | |
3934 | @item catch @var{event} | |
3935 | Stop when @var{event} occurs. @var{event} can be any of the following: | |
3936 | @table @code | |
3937 | @item throw | |
4644b6e3 | 3938 | @cindex stop on C@t{++} exceptions |
b37052ae | 3939 | The throwing of a C@t{++} exception. |
c906108c SS |
3940 | |
3941 | @item catch | |
b37052ae | 3942 | The catching of a C@t{++} exception. |
c906108c | 3943 | |
8936fcda JB |
3944 | @item exception |
3945 | @cindex Ada exception catching | |
3946 | @cindex catch Ada exceptions | |
3947 | An Ada exception being raised. If an exception name is specified | |
3948 | at the end of the command (eg @code{catch exception Program_Error}), | |
3949 | the debugger will stop only when this specific exception is raised. | |
3950 | Otherwise, the debugger stops execution when any Ada exception is raised. | |
3951 | ||
87f67dba JB |
3952 | When inserting an exception catchpoint on a user-defined exception whose |
3953 | name is identical to one of the exceptions defined by the language, the | |
3954 | fully qualified name must be used as the exception name. Otherwise, | |
3955 | @value{GDBN} will assume that it should stop on the pre-defined exception | |
3956 | rather than the user-defined one. For instance, assuming an exception | |
3957 | called @code{Constraint_Error} is defined in package @code{Pck}, then | |
3958 | the command to use to catch such exceptions is @kbd{catch exception | |
3959 | Pck.Constraint_Error}. | |
3960 | ||
8936fcda JB |
3961 | @item exception unhandled |
3962 | An exception that was raised but is not handled by the program. | |
3963 | ||
3964 | @item assert | |
3965 | A failed Ada assertion. | |
3966 | ||
c906108c | 3967 | @item exec |
4644b6e3 | 3968 | @cindex break on fork/exec |
5ee187d7 DJ |
3969 | A call to @code{exec}. This is currently only available for HP-UX |
3970 | and @sc{gnu}/Linux. | |
c906108c | 3971 | |
a96d9b2e | 3972 | @item syscall |
ee8e71d4 | 3973 | @itemx syscall @r{[}@var{name} @r{|} @var{number}@r{]} @dots{} |
a96d9b2e SDJ |
3974 | @cindex break on a system call. |
3975 | A call to or return from a system call, a.k.a.@: @dfn{syscall}. A | |
3976 | syscall is a mechanism for application programs to request a service | |
3977 | from the operating system (OS) or one of the OS system services. | |
3978 | @value{GDBN} can catch some or all of the syscalls issued by the | |
3979 | debuggee, and show the related information for each syscall. If no | |
3980 | argument is specified, calls to and returns from all system calls | |
3981 | will be caught. | |
3982 | ||
3983 | @var{name} can be any system call name that is valid for the | |
3984 | underlying OS. Just what syscalls are valid depends on the OS. On | |
3985 | GNU and Unix systems, you can find the full list of valid syscall | |
3986 | names on @file{/usr/include/asm/unistd.h}. | |
3987 | ||
3988 | @c For MS-Windows, the syscall names and the corresponding numbers | |
3989 | @c can be found, e.g., on this URL: | |
3990 | @c http://www.metasploit.com/users/opcode/syscalls.html | |
3991 | @c but we don't support Windows syscalls yet. | |
3992 | ||
3993 | Normally, @value{GDBN} knows in advance which syscalls are valid for | |
3994 | each OS, so you can use the @value{GDBN} command-line completion | |
3995 | facilities (@pxref{Completion,, command completion}) to list the | |
3996 | available choices. | |
3997 | ||
3998 | You may also specify the system call numerically. A syscall's | |
3999 | number is the value passed to the OS's syscall dispatcher to | |
4000 | identify the requested service. When you specify the syscall by its | |
4001 | name, @value{GDBN} uses its database of syscalls to convert the name | |
4002 | into the corresponding numeric code, but using the number directly | |
4003 | may be useful if @value{GDBN}'s database does not have the complete | |
4004 | list of syscalls on your system (e.g., because @value{GDBN} lags | |
4005 | behind the OS upgrades). | |
4006 | ||
4007 | The example below illustrates how this command works if you don't provide | |
4008 | arguments to it: | |
4009 | ||
4010 | @smallexample | |
4011 | (@value{GDBP}) catch syscall | |
4012 | Catchpoint 1 (syscall) | |
4013 | (@value{GDBP}) r | |
4014 | Starting program: /tmp/catch-syscall | |
4015 | ||
4016 | Catchpoint 1 (call to syscall 'close'), \ | |
4017 | 0xffffe424 in __kernel_vsyscall () | |
4018 | (@value{GDBP}) c | |
4019 | Continuing. | |
4020 | ||
4021 | Catchpoint 1 (returned from syscall 'close'), \ | |
4022 | 0xffffe424 in __kernel_vsyscall () | |
4023 | (@value{GDBP}) | |
4024 | @end smallexample | |
4025 | ||
4026 | Here is an example of catching a system call by name: | |
4027 | ||
4028 | @smallexample | |
4029 | (@value{GDBP}) catch syscall chroot | |
4030 | Catchpoint 1 (syscall 'chroot' [61]) | |
4031 | (@value{GDBP}) r | |
4032 | Starting program: /tmp/catch-syscall | |
4033 | ||
4034 | Catchpoint 1 (call to syscall 'chroot'), \ | |
4035 | 0xffffe424 in __kernel_vsyscall () | |
4036 | (@value{GDBP}) c | |
4037 | Continuing. | |
4038 | ||
4039 | Catchpoint 1 (returned from syscall 'chroot'), \ | |
4040 | 0xffffe424 in __kernel_vsyscall () | |
4041 | (@value{GDBP}) | |
4042 | @end smallexample | |
4043 | ||
4044 | An example of specifying a system call numerically. In the case | |
4045 | below, the syscall number has a corresponding entry in the XML | |
4046 | file, so @value{GDBN} finds its name and prints it: | |
4047 | ||
4048 | @smallexample | |
4049 | (@value{GDBP}) catch syscall 252 | |
4050 | Catchpoint 1 (syscall(s) 'exit_group') | |
4051 | (@value{GDBP}) r | |
4052 | Starting program: /tmp/catch-syscall | |
4053 | ||
4054 | Catchpoint 1 (call to syscall 'exit_group'), \ | |
4055 | 0xffffe424 in __kernel_vsyscall () | |
4056 | (@value{GDBP}) c | |
4057 | Continuing. | |
4058 | ||
4059 | Program exited normally. | |
4060 | (@value{GDBP}) | |
4061 | @end smallexample | |
4062 | ||
4063 | However, there can be situations when there is no corresponding name | |
4064 | in XML file for that syscall number. In this case, @value{GDBN} prints | |
4065 | a warning message saying that it was not able to find the syscall name, | |
4066 | but the catchpoint will be set anyway. See the example below: | |
4067 | ||
4068 | @smallexample | |
4069 | (@value{GDBP}) catch syscall 764 | |
4070 | warning: The number '764' does not represent a known syscall. | |
4071 | Catchpoint 2 (syscall 764) | |
4072 | (@value{GDBP}) | |
4073 | @end smallexample | |
4074 | ||
4075 | If you configure @value{GDBN} using the @samp{--without-expat} option, | |
4076 | it will not be able to display syscall names. Also, if your | |
4077 | architecture does not have an XML file describing its system calls, | |
4078 | you will not be able to see the syscall names. It is important to | |
4079 | notice that these two features are used for accessing the syscall | |
4080 | name database. In either case, you will see a warning like this: | |
4081 | ||
4082 | @smallexample | |
4083 | (@value{GDBP}) catch syscall | |
4084 | warning: Could not open "syscalls/i386-linux.xml" | |
4085 | warning: Could not load the syscall XML file 'syscalls/i386-linux.xml'. | |
4086 | GDB will not be able to display syscall names. | |
4087 | Catchpoint 1 (syscall) | |
4088 | (@value{GDBP}) | |
4089 | @end smallexample | |
4090 | ||
4091 | Of course, the file name will change depending on your architecture and system. | |
4092 | ||
4093 | Still using the example above, you can also try to catch a syscall by its | |
4094 | number. In this case, you would see something like: | |
4095 | ||
4096 | @smallexample | |
4097 | (@value{GDBP}) catch syscall 252 | |
4098 | Catchpoint 1 (syscall(s) 252) | |
4099 | @end smallexample | |
4100 | ||
4101 | Again, in this case @value{GDBN} would not be able to display syscall's names. | |
4102 | ||
c906108c | 4103 | @item fork |
5ee187d7 DJ |
4104 | A call to @code{fork}. This is currently only available for HP-UX |
4105 | and @sc{gnu}/Linux. | |
c906108c SS |
4106 | |
4107 | @item vfork | |
5ee187d7 DJ |
4108 | A call to @code{vfork}. This is currently only available for HP-UX |
4109 | and @sc{gnu}/Linux. | |
c906108c | 4110 | |
c906108c SS |
4111 | @end table |
4112 | ||
4113 | @item tcatch @var{event} | |
4114 | Set a catchpoint that is enabled only for one stop. The catchpoint is | |
4115 | automatically deleted after the first time the event is caught. | |
4116 | ||
4117 | @end table | |
4118 | ||
4119 | Use the @code{info break} command to list the current catchpoints. | |
4120 | ||
b37052ae | 4121 | There are currently some limitations to C@t{++} exception handling |
c906108c SS |
4122 | (@code{catch throw} and @code{catch catch}) in @value{GDBN}: |
4123 | ||
4124 | @itemize @bullet | |
4125 | @item | |
4126 | If you call a function interactively, @value{GDBN} normally returns | |
4127 | control to you when the function has finished executing. If the call | |
4128 | raises an exception, however, the call may bypass the mechanism that | |
4129 | returns control to you and cause your program either to abort or to | |
4130 | simply continue running until it hits a breakpoint, catches a signal | |
4131 | that @value{GDBN} is listening for, or exits. This is the case even if | |
4132 | you set a catchpoint for the exception; catchpoints on exceptions are | |
4133 | disabled within interactive calls. | |
4134 | ||
4135 | @item | |
4136 | You cannot raise an exception interactively. | |
4137 | ||
4138 | @item | |
4139 | You cannot install an exception handler interactively. | |
4140 | @end itemize | |
4141 | ||
4142 | @cindex raise exceptions | |
4143 | Sometimes @code{catch} is not the best way to debug exception handling: | |
4144 | if you need to know exactly where an exception is raised, it is better to | |
4145 | stop @emph{before} the exception handler is called, since that way you | |
4146 | can see the stack before any unwinding takes place. If you set a | |
4147 | breakpoint in an exception handler instead, it may not be easy to find | |
4148 | out where the exception was raised. | |
4149 | ||
4150 | To stop just before an exception handler is called, you need some | |
b37052ae | 4151 | knowledge of the implementation. In the case of @sc{gnu} C@t{++}, exceptions are |
c906108c SS |
4152 | raised by calling a library function named @code{__raise_exception} |
4153 | which has the following ANSI C interface: | |
4154 | ||
474c8240 | 4155 | @smallexample |
c906108c | 4156 | /* @var{addr} is where the exception identifier is stored. |
d4f3574e SS |
4157 | @var{id} is the exception identifier. */ |
4158 | void __raise_exception (void **addr, void *id); | |
474c8240 | 4159 | @end smallexample |
c906108c SS |
4160 | |
4161 | @noindent | |
4162 | To make the debugger catch all exceptions before any stack | |
4163 | unwinding takes place, set a breakpoint on @code{__raise_exception} | |
79a6e687 | 4164 | (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Exceptions}). |
c906108c | 4165 | |
79a6e687 | 4166 | With a conditional breakpoint (@pxref{Conditions, ,Break Conditions}) |
c906108c SS |
4167 | that depends on the value of @var{id}, you can stop your program when |
4168 | a specific exception is raised. You can use multiple conditional | |
4169 | breakpoints to stop your program when any of a number of exceptions are | |
4170 | raised. | |
4171 | ||
4172 | ||
6d2ebf8b | 4173 | @node Delete Breaks |
79a6e687 | 4174 | @subsection Deleting Breakpoints |
c906108c SS |
4175 | |
4176 | @cindex clearing breakpoints, watchpoints, catchpoints | |
4177 | @cindex deleting breakpoints, watchpoints, catchpoints | |
4178 | It is often necessary to eliminate a breakpoint, watchpoint, or | |
4179 | catchpoint once it has done its job and you no longer want your program | |
4180 | to stop there. This is called @dfn{deleting} the breakpoint. A | |
4181 | breakpoint that has been deleted no longer exists; it is forgotten. | |
4182 | ||
4183 | With the @code{clear} command you can delete breakpoints according to | |
4184 | where they are in your program. With the @code{delete} command you can | |
4185 | delete individual breakpoints, watchpoints, or catchpoints by specifying | |
4186 | their breakpoint numbers. | |
4187 | ||
4188 | It is not necessary to delete a breakpoint to proceed past it. @value{GDBN} | |
4189 | automatically ignores breakpoints on the first instruction to be executed | |
4190 | when you continue execution without changing the execution address. | |
4191 | ||
4192 | @table @code | |
4193 | @kindex clear | |
4194 | @item clear | |
4195 | Delete any breakpoints at the next instruction to be executed in the | |
79a6e687 | 4196 | selected stack frame (@pxref{Selection, ,Selecting a Frame}). When |
c906108c SS |
4197 | the innermost frame is selected, this is a good way to delete a |
4198 | breakpoint where your program just stopped. | |
4199 | ||
2a25a5ba EZ |
4200 | @item clear @var{location} |
4201 | Delete any breakpoints set at the specified @var{location}. | |
4202 | @xref{Specify Location}, for the various forms of @var{location}; the | |
4203 | most useful ones are listed below: | |
4204 | ||
4205 | @table @code | |
c906108c SS |
4206 | @item clear @var{function} |
4207 | @itemx clear @var{filename}:@var{function} | |
09d4efe1 | 4208 | Delete any breakpoints set at entry to the named @var{function}. |
c906108c SS |
4209 | |
4210 | @item clear @var{linenum} | |
4211 | @itemx clear @var{filename}:@var{linenum} | |
09d4efe1 EZ |
4212 | Delete any breakpoints set at or within the code of the specified |
4213 | @var{linenum} of the specified @var{filename}. | |
2a25a5ba | 4214 | @end table |
c906108c SS |
4215 | |
4216 | @cindex delete breakpoints | |
4217 | @kindex delete | |
41afff9a | 4218 | @kindex d @r{(@code{delete})} |
c5394b80 JM |
4219 | @item delete @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]} |
4220 | Delete the breakpoints, watchpoints, or catchpoints of the breakpoint | |
4221 | ranges specified as arguments. If no argument is specified, delete all | |
c906108c SS |
4222 | breakpoints (@value{GDBN} asks confirmation, unless you have @code{set |
4223 | confirm off}). You can abbreviate this command as @code{d}. | |
4224 | @end table | |
4225 | ||
6d2ebf8b | 4226 | @node Disabling |
79a6e687 | 4227 | @subsection Disabling Breakpoints |
c906108c | 4228 | |
4644b6e3 | 4229 | @cindex enable/disable a breakpoint |
c906108c SS |
4230 | Rather than deleting a breakpoint, watchpoint, or catchpoint, you might |
4231 | prefer to @dfn{disable} it. This makes the breakpoint inoperative as if | |
4232 | it had been deleted, but remembers the information on the breakpoint so | |
4233 | that you can @dfn{enable} it again later. | |
4234 | ||
4235 | You disable and enable breakpoints, watchpoints, and catchpoints with | |
d77f58be SS |
4236 | the @code{enable} and @code{disable} commands, optionally specifying |
4237 | one or more breakpoint numbers as arguments. Use @code{info break} to | |
4238 | print a list of all breakpoints, watchpoints, and catchpoints if you | |
4239 | do not know which numbers to use. | |
c906108c | 4240 | |
3b784c4f EZ |
4241 | Disabling and enabling a breakpoint that has multiple locations |
4242 | affects all of its locations. | |
4243 | ||
c906108c SS |
4244 | A breakpoint, watchpoint, or catchpoint can have any of four different |
4245 | states of enablement: | |
4246 | ||
4247 | @itemize @bullet | |
4248 | @item | |
4249 | Enabled. The breakpoint stops your program. A breakpoint set | |
4250 | with the @code{break} command starts out in this state. | |
4251 | @item | |
4252 | Disabled. The breakpoint has no effect on your program. | |
4253 | @item | |
4254 | Enabled once. The breakpoint stops your program, but then becomes | |
d4f3574e | 4255 | disabled. |
c906108c SS |
4256 | @item |
4257 | Enabled for deletion. The breakpoint stops your program, but | |
d4f3574e SS |
4258 | immediately after it does so it is deleted permanently. A breakpoint |
4259 | set with the @code{tbreak} command starts out in this state. | |
c906108c SS |
4260 | @end itemize |
4261 | ||
4262 | You can use the following commands to enable or disable breakpoints, | |
4263 | watchpoints, and catchpoints: | |
4264 | ||
4265 | @table @code | |
c906108c | 4266 | @kindex disable |
41afff9a | 4267 | @kindex dis @r{(@code{disable})} |
c5394b80 | 4268 | @item disable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]} |
c906108c SS |
4269 | Disable the specified breakpoints---or all breakpoints, if none are |
4270 | listed. A disabled breakpoint has no effect but is not forgotten. All | |
4271 | options such as ignore-counts, conditions and commands are remembered in | |
4272 | case the breakpoint is enabled again later. You may abbreviate | |
4273 | @code{disable} as @code{dis}. | |
4274 | ||
c906108c | 4275 | @kindex enable |
c5394b80 | 4276 | @item enable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]} |
c906108c SS |
4277 | Enable the specified breakpoints (or all defined breakpoints). They |
4278 | become effective once again in stopping your program. | |
4279 | ||
c5394b80 | 4280 | @item enable @r{[}breakpoints@r{]} once @var{range}@dots{} |
c906108c SS |
4281 | Enable the specified breakpoints temporarily. @value{GDBN} disables any |
4282 | of these breakpoints immediately after stopping your program. | |
4283 | ||
c5394b80 | 4284 | @item enable @r{[}breakpoints@r{]} delete @var{range}@dots{} |
c906108c SS |
4285 | Enable the specified breakpoints to work once, then die. @value{GDBN} |
4286 | deletes any of these breakpoints as soon as your program stops there. | |
09d4efe1 | 4287 | Breakpoints set by the @code{tbreak} command start out in this state. |
c906108c SS |
4288 | @end table |
4289 | ||
d4f3574e SS |
4290 | @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is |
4291 | @c confusing: tbreak is also initially enabled. | |
c906108c | 4292 | Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks, |
79a6e687 | 4293 | ,Setting Breakpoints}), breakpoints that you set are initially enabled; |
c906108c SS |
4294 | subsequently, they become disabled or enabled only when you use one of |
4295 | the commands above. (The command @code{until} can set and delete a | |
4296 | breakpoint of its own, but it does not change the state of your other | |
4297 | breakpoints; see @ref{Continuing and Stepping, ,Continuing and | |
79a6e687 | 4298 | Stepping}.) |
c906108c | 4299 | |
6d2ebf8b | 4300 | @node Conditions |
79a6e687 | 4301 | @subsection Break Conditions |
c906108c SS |
4302 | @cindex conditional breakpoints |
4303 | @cindex breakpoint conditions | |
4304 | ||
4305 | @c FIXME what is scope of break condition expr? Context where wanted? | |
5d161b24 | 4306 | @c in particular for a watchpoint? |
c906108c SS |
4307 | The simplest sort of breakpoint breaks every time your program reaches a |
4308 | specified place. You can also specify a @dfn{condition} for a | |
4309 | breakpoint. A condition is just a Boolean expression in your | |
4310 | programming language (@pxref{Expressions, ,Expressions}). A breakpoint with | |
4311 | a condition evaluates the expression each time your program reaches it, | |
4312 | and your program stops only if the condition is @emph{true}. | |
4313 | ||
4314 | This is the converse of using assertions for program validation; in that | |
4315 | situation, you want to stop when the assertion is violated---that is, | |
4316 | when the condition is false. In C, if you want to test an assertion expressed | |
4317 | by the condition @var{assert}, you should set the condition | |
4318 | @samp{! @var{assert}} on the appropriate breakpoint. | |
4319 | ||
4320 | Conditions are also accepted for watchpoints; you may not need them, | |
4321 | since a watchpoint is inspecting the value of an expression anyhow---but | |
4322 | it might be simpler, say, to just set a watchpoint on a variable name, | |
4323 | and specify a condition that tests whether the new value is an interesting | |
4324 | one. | |
4325 | ||
4326 | Break conditions can have side effects, and may even call functions in | |
4327 | your program. This can be useful, for example, to activate functions | |
4328 | that log program progress, or to use your own print functions to | |
99e008fe | 4329 | format special data structures. The effects are completely predictable |
c906108c SS |
4330 | unless there is another enabled breakpoint at the same address. (In |
4331 | that case, @value{GDBN} might see the other breakpoint first and stop your | |
4332 | program without checking the condition of this one.) Note that | |
d4f3574e SS |
4333 | breakpoint commands are usually more convenient and flexible than break |
4334 | conditions for the | |
c906108c | 4335 | purpose of performing side effects when a breakpoint is reached |
79a6e687 | 4336 | (@pxref{Break Commands, ,Breakpoint Command Lists}). |
c906108c SS |
4337 | |
4338 | Break conditions can be specified when a breakpoint is set, by using | |
4339 | @samp{if} in the arguments to the @code{break} command. @xref{Set | |
79a6e687 | 4340 | Breaks, ,Setting Breakpoints}. They can also be changed at any time |
c906108c | 4341 | with the @code{condition} command. |
53a5351d | 4342 | |
c906108c SS |
4343 | You can also use the @code{if} keyword with the @code{watch} command. |
4344 | The @code{catch} command does not recognize the @code{if} keyword; | |
4345 | @code{condition} is the only way to impose a further condition on a | |
4346 | catchpoint. | |
c906108c SS |
4347 | |
4348 | @table @code | |
4349 | @kindex condition | |
4350 | @item condition @var{bnum} @var{expression} | |
4351 | Specify @var{expression} as the break condition for breakpoint, | |
4352 | watchpoint, or catchpoint number @var{bnum}. After you set a condition, | |
4353 | breakpoint @var{bnum} stops your program only if the value of | |
4354 | @var{expression} is true (nonzero, in C). When you use | |
4355 | @code{condition}, @value{GDBN} checks @var{expression} immediately for | |
4356 | syntactic correctness, and to determine whether symbols in it have | |
d4f3574e SS |
4357 | referents in the context of your breakpoint. If @var{expression} uses |
4358 | symbols not referenced in the context of the breakpoint, @value{GDBN} | |
4359 | prints an error message: | |
4360 | ||
474c8240 | 4361 | @smallexample |
d4f3574e | 4362 | No symbol "foo" in current context. |
474c8240 | 4363 | @end smallexample |
d4f3574e SS |
4364 | |
4365 | @noindent | |
c906108c SS |
4366 | @value{GDBN} does |
4367 | not actually evaluate @var{expression} at the time the @code{condition} | |
d4f3574e SS |
4368 | command (or a command that sets a breakpoint with a condition, like |
4369 | @code{break if @dots{}}) is given, however. @xref{Expressions, ,Expressions}. | |
c906108c SS |
4370 | |
4371 | @item condition @var{bnum} | |
4372 | Remove the condition from breakpoint number @var{bnum}. It becomes | |
4373 | an ordinary unconditional breakpoint. | |
4374 | @end table | |
4375 | ||
4376 | @cindex ignore count (of breakpoint) | |
4377 | A special case of a breakpoint condition is to stop only when the | |
4378 | breakpoint has been reached a certain number of times. This is so | |
4379 | useful that there is a special way to do it, using the @dfn{ignore | |
4380 | count} of the breakpoint. Every breakpoint has an ignore count, which | |
4381 | is an integer. Most of the time, the ignore count is zero, and | |
4382 | therefore has no effect. But if your program reaches a breakpoint whose | |
4383 | ignore count is positive, then instead of stopping, it just decrements | |
4384 | the ignore count by one and continues. As a result, if the ignore count | |
4385 | value is @var{n}, the breakpoint does not stop the next @var{n} times | |
4386 | your program reaches it. | |
4387 | ||
4388 | @table @code | |
4389 | @kindex ignore | |
4390 | @item ignore @var{bnum} @var{count} | |
4391 | Set the ignore count of breakpoint number @var{bnum} to @var{count}. | |
4392 | The next @var{count} times the breakpoint is reached, your program's | |
4393 | execution does not stop; other than to decrement the ignore count, @value{GDBN} | |
4394 | takes no action. | |
4395 | ||
4396 | To make the breakpoint stop the next time it is reached, specify | |
4397 | a count of zero. | |
4398 | ||
4399 | When you use @code{continue} to resume execution of your program from a | |
4400 | breakpoint, you can specify an ignore count directly as an argument to | |
4401 | @code{continue}, rather than using @code{ignore}. @xref{Continuing and | |
79a6e687 | 4402 | Stepping,,Continuing and Stepping}. |
c906108c SS |
4403 | |
4404 | If a breakpoint has a positive ignore count and a condition, the | |
4405 | condition is not checked. Once the ignore count reaches zero, | |
4406 | @value{GDBN} resumes checking the condition. | |
4407 | ||
4408 | You could achieve the effect of the ignore count with a condition such | |
4409 | as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that | |
4410 | is decremented each time. @xref{Convenience Vars, ,Convenience | |
79a6e687 | 4411 | Variables}. |
c906108c SS |
4412 | @end table |
4413 | ||
4414 | Ignore counts apply to breakpoints, watchpoints, and catchpoints. | |
4415 | ||
4416 | ||
6d2ebf8b | 4417 | @node Break Commands |
79a6e687 | 4418 | @subsection Breakpoint Command Lists |
c906108c SS |
4419 | |
4420 | @cindex breakpoint commands | |
4421 | You can give any breakpoint (or watchpoint or catchpoint) a series of | |
4422 | commands to execute when your program stops due to that breakpoint. For | |
4423 | example, you might want to print the values of certain expressions, or | |
4424 | enable other breakpoints. | |
4425 | ||
4426 | @table @code | |
4427 | @kindex commands | |
ca91424e | 4428 | @kindex end@r{ (breakpoint commands)} |
95a42b64 | 4429 | @item commands @r{[}@var{range}@dots{}@r{]} |
c906108c SS |
4430 | @itemx @dots{} @var{command-list} @dots{} |
4431 | @itemx end | |
95a42b64 | 4432 | Specify a list of commands for the given breakpoints. The commands |
c906108c SS |
4433 | themselves appear on the following lines. Type a line containing just |
4434 | @code{end} to terminate the commands. | |
4435 | ||
4436 | To remove all commands from a breakpoint, type @code{commands} and | |
4437 | follow it immediately with @code{end}; that is, give no commands. | |
4438 | ||
95a42b64 TT |
4439 | With no argument, @code{commands} refers to the last breakpoint, |
4440 | watchpoint, or catchpoint set (not to the breakpoint most recently | |
4441 | encountered). If the most recent breakpoints were set with a single | |
4442 | command, then the @code{commands} will apply to all the breakpoints | |
4443 | set by that command. This applies to breakpoints set by | |
86b17b60 PA |
4444 | @code{rbreak}, and also applies when a single @code{break} command |
4445 | creates multiple breakpoints (@pxref{Ambiguous Expressions,,Ambiguous | |
4446 | Expressions}). | |
c906108c SS |
4447 | @end table |
4448 | ||
4449 | Pressing @key{RET} as a means of repeating the last @value{GDBN} command is | |
4450 | disabled within a @var{command-list}. | |
4451 | ||
4452 | You can use breakpoint commands to start your program up again. Simply | |
4453 | use the @code{continue} command, or @code{step}, or any other command | |
4454 | that resumes execution. | |
4455 | ||
4456 | Any other commands in the command list, after a command that resumes | |
4457 | execution, are ignored. This is because any time you resume execution | |
4458 | (even with a simple @code{next} or @code{step}), you may encounter | |
4459 | another breakpoint---which could have its own command list, leading to | |
4460 | ambiguities about which list to execute. | |
4461 | ||
4462 | @kindex silent | |
4463 | If the first command you specify in a command list is @code{silent}, the | |
4464 | usual message about stopping at a breakpoint is not printed. This may | |
4465 | be desirable for breakpoints that are to print a specific message and | |
4466 | then continue. If none of the remaining commands print anything, you | |
4467 | see no sign that the breakpoint was reached. @code{silent} is | |
4468 | meaningful only at the beginning of a breakpoint command list. | |
4469 | ||
4470 | The commands @code{echo}, @code{output}, and @code{printf} allow you to | |
4471 | print precisely controlled output, and are often useful in silent | |
79a6e687 | 4472 | breakpoints. @xref{Output, ,Commands for Controlled Output}. |
c906108c SS |
4473 | |
4474 | For example, here is how you could use breakpoint commands to print the | |
4475 | value of @code{x} at entry to @code{foo} whenever @code{x} is positive. | |
4476 | ||
474c8240 | 4477 | @smallexample |
c906108c SS |
4478 | break foo if x>0 |
4479 | commands | |
4480 | silent | |
4481 | printf "x is %d\n",x | |
4482 | cont | |
4483 | end | |
474c8240 | 4484 | @end smallexample |
c906108c SS |
4485 | |
4486 | One application for breakpoint commands is to compensate for one bug so | |
4487 | you can test for another. Put a breakpoint just after the erroneous line | |
4488 | of code, give it a condition to detect the case in which something | |
4489 | erroneous has been done, and give it commands to assign correct values | |
4490 | to any variables that need them. End with the @code{continue} command | |
4491 | so that your program does not stop, and start with the @code{silent} | |
4492 | command so that no output is produced. Here is an example: | |
4493 | ||
474c8240 | 4494 | @smallexample |
c906108c SS |
4495 | break 403 |
4496 | commands | |
4497 | silent | |
4498 | set x = y + 4 | |
4499 | cont | |
4500 | end | |
474c8240 | 4501 | @end smallexample |
c906108c | 4502 | |
6149aea9 PA |
4503 | @node Save Breakpoints |
4504 | @subsection How to save breakpoints to a file | |
4505 | ||
4506 | To save breakpoint definitions to a file use the @w{@code{save | |
4507 | breakpoints}} command. | |
4508 | ||
4509 | @table @code | |
4510 | @kindex save breakpoints | |
4511 | @cindex save breakpoints to a file for future sessions | |
4512 | @item save breakpoints [@var{filename}] | |
4513 | This command saves all current breakpoint definitions together with | |
4514 | their commands and ignore counts, into a file @file{@var{filename}} | |
4515 | suitable for use in a later debugging session. This includes all | |
4516 | types of breakpoints (breakpoints, watchpoints, catchpoints, | |
4517 | tracepoints). To read the saved breakpoint definitions, use the | |
4518 | @code{source} command (@pxref{Command Files}). Note that watchpoints | |
4519 | with expressions involving local variables may fail to be recreated | |
4520 | because it may not be possible to access the context where the | |
4521 | watchpoint is valid anymore. Because the saved breakpoint definitions | |
4522 | are simply a sequence of @value{GDBN} commands that recreate the | |
4523 | breakpoints, you can edit the file in your favorite editing program, | |
4524 | and remove the breakpoint definitions you're not interested in, or | |
4525 | that can no longer be recreated. | |
4526 | @end table | |
4527 | ||
c906108c | 4528 | @c @ifclear BARETARGET |
6d2ebf8b | 4529 | @node Error in Breakpoints |
d4f3574e | 4530 | @subsection ``Cannot insert breakpoints'' |
c906108c | 4531 | |
fa3a767f PA |
4532 | If you request too many active hardware-assisted breakpoints and |
4533 | watchpoints, you will see this error message: | |
d4f3574e SS |
4534 | |
4535 | @c FIXME: the precise wording of this message may change; the relevant | |
4536 | @c source change is not committed yet (Sep 3, 1999). | |
4537 | @smallexample | |
4538 | Stopped; cannot insert breakpoints. | |
4539 | You may have requested too many hardware breakpoints and watchpoints. | |
4540 | @end smallexample | |
4541 | ||
4542 | @noindent | |
4543 | This message is printed when you attempt to resume the program, since | |
4544 | only then @value{GDBN} knows exactly how many hardware breakpoints and | |
4545 | watchpoints it needs to insert. | |
4546 | ||
4547 | When this message is printed, you need to disable or remove some of the | |
4548 | hardware-assisted breakpoints and watchpoints, and then continue. | |
4549 | ||
79a6e687 | 4550 | @node Breakpoint-related Warnings |
1485d690 KB |
4551 | @subsection ``Breakpoint address adjusted...'' |
4552 | @cindex breakpoint address adjusted | |
4553 | ||
4554 | Some processor architectures place constraints on the addresses at | |
4555 | which breakpoints may be placed. For architectures thus constrained, | |
4556 | @value{GDBN} will attempt to adjust the breakpoint's address to comply | |
4557 | with the constraints dictated by the architecture. | |
4558 | ||
4559 | One example of such an architecture is the Fujitsu FR-V. The FR-V is | |
4560 | a VLIW architecture in which a number of RISC-like instructions may be | |
4561 | bundled together for parallel execution. The FR-V architecture | |
4562 | constrains the location of a breakpoint instruction within such a | |
4563 | bundle to the instruction with the lowest address. @value{GDBN} | |
4564 | honors this constraint by adjusting a breakpoint's address to the | |
4565 | first in the bundle. | |
4566 | ||
4567 | It is not uncommon for optimized code to have bundles which contain | |
4568 | instructions from different source statements, thus it may happen that | |
4569 | a breakpoint's address will be adjusted from one source statement to | |
4570 | another. Since this adjustment may significantly alter @value{GDBN}'s | |
4571 | breakpoint related behavior from what the user expects, a warning is | |
4572 | printed when the breakpoint is first set and also when the breakpoint | |
4573 | is hit. | |
4574 | ||
4575 | A warning like the one below is printed when setting a breakpoint | |
4576 | that's been subject to address adjustment: | |
4577 | ||
4578 | @smallexample | |
4579 | warning: Breakpoint address adjusted from 0x00010414 to 0x00010410. | |
4580 | @end smallexample | |
4581 | ||
4582 | Such warnings are printed both for user settable and @value{GDBN}'s | |
4583 | internal breakpoints. If you see one of these warnings, you should | |
4584 | verify that a breakpoint set at the adjusted address will have the | |
4585 | desired affect. If not, the breakpoint in question may be removed and | |
b383017d | 4586 | other breakpoints may be set which will have the desired behavior. |
1485d690 KB |
4587 | E.g., it may be sufficient to place the breakpoint at a later |
4588 | instruction. A conditional breakpoint may also be useful in some | |
4589 | cases to prevent the breakpoint from triggering too often. | |
4590 | ||
4591 | @value{GDBN} will also issue a warning when stopping at one of these | |
4592 | adjusted breakpoints: | |
4593 | ||
4594 | @smallexample | |
4595 | warning: Breakpoint 1 address previously adjusted from 0x00010414 | |
4596 | to 0x00010410. | |
4597 | @end smallexample | |
4598 | ||
4599 | When this warning is encountered, it may be too late to take remedial | |
4600 | action except in cases where the breakpoint is hit earlier or more | |
4601 | frequently than expected. | |
d4f3574e | 4602 | |
6d2ebf8b | 4603 | @node Continuing and Stepping |
79a6e687 | 4604 | @section Continuing and Stepping |
c906108c SS |
4605 | |
4606 | @cindex stepping | |
4607 | @cindex continuing | |
4608 | @cindex resuming execution | |
4609 | @dfn{Continuing} means resuming program execution until your program | |
4610 | completes normally. In contrast, @dfn{stepping} means executing just | |
4611 | one more ``step'' of your program, where ``step'' may mean either one | |
4612 | line of source code, or one machine instruction (depending on what | |
7a292a7a SS |
4613 | particular command you use). Either when continuing or when stepping, |
4614 | your program may stop even sooner, due to a breakpoint or a signal. (If | |
d4f3574e SS |
4615 | it stops due to a signal, you may want to use @code{handle}, or use |
4616 | @samp{signal 0} to resume execution. @xref{Signals, ,Signals}.) | |
c906108c SS |
4617 | |
4618 | @table @code | |
4619 | @kindex continue | |
41afff9a EZ |
4620 | @kindex c @r{(@code{continue})} |
4621 | @kindex fg @r{(resume foreground execution)} | |
c906108c SS |
4622 | @item continue @r{[}@var{ignore-count}@r{]} |
4623 | @itemx c @r{[}@var{ignore-count}@r{]} | |
4624 | @itemx fg @r{[}@var{ignore-count}@r{]} | |
4625 | Resume program execution, at the address where your program last stopped; | |
4626 | any breakpoints set at that address are bypassed. The optional argument | |
4627 | @var{ignore-count} allows you to specify a further number of times to | |
4628 | ignore a breakpoint at this location; its effect is like that of | |
79a6e687 | 4629 | @code{ignore} (@pxref{Conditions, ,Break Conditions}). |
c906108c SS |
4630 | |
4631 | The argument @var{ignore-count} is meaningful only when your program | |
4632 | stopped due to a breakpoint. At other times, the argument to | |
4633 | @code{continue} is ignored. | |
4634 | ||
d4f3574e SS |
4635 | The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the |
4636 | debugged program is deemed to be the foreground program) are provided | |
4637 | purely for convenience, and have exactly the same behavior as | |
4638 | @code{continue}. | |
c906108c SS |
4639 | @end table |
4640 | ||
4641 | To resume execution at a different place, you can use @code{return} | |
79a6e687 | 4642 | (@pxref{Returning, ,Returning from a Function}) to go back to the |
c906108c | 4643 | calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a |
79a6e687 | 4644 | Different Address}) to go to an arbitrary location in your program. |
c906108c SS |
4645 | |
4646 | A typical technique for using stepping is to set a breakpoint | |
79a6e687 | 4647 | (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the |
c906108c SS |
4648 | beginning of the function or the section of your program where a problem |
4649 | is believed to lie, run your program until it stops at that breakpoint, | |
4650 | and then step through the suspect area, examining the variables that are | |
4651 | interesting, until you see the problem happen. | |
4652 | ||
4653 | @table @code | |
4654 | @kindex step | |
41afff9a | 4655 | @kindex s @r{(@code{step})} |
c906108c SS |
4656 | @item step |
4657 | Continue running your program until control reaches a different source | |
4658 | line, then stop it and return control to @value{GDBN}. This command is | |
4659 | abbreviated @code{s}. | |
4660 | ||
4661 | @quotation | |
4662 | @c "without debugging information" is imprecise; actually "without line | |
4663 | @c numbers in the debugging information". (gcc -g1 has debugging info but | |
4664 | @c not line numbers). But it seems complex to try to make that | |
4665 | @c distinction here. | |
4666 | @emph{Warning:} If you use the @code{step} command while control is | |
4667 | within a function that was compiled without debugging information, | |
4668 | execution proceeds until control reaches a function that does have | |
4669 | debugging information. Likewise, it will not step into a function which | |
4670 | is compiled without debugging information. To step through functions | |
4671 | without debugging information, use the @code{stepi} command, described | |
4672 | below. | |
4673 | @end quotation | |
4674 | ||
4a92d011 EZ |
4675 | The @code{step} command only stops at the first instruction of a source |
4676 | line. This prevents the multiple stops that could otherwise occur in | |
4677 | @code{switch} statements, @code{for} loops, etc. @code{step} continues | |
4678 | to stop if a function that has debugging information is called within | |
4679 | the line. In other words, @code{step} @emph{steps inside} any functions | |
4680 | called within the line. | |
c906108c | 4681 | |
d4f3574e SS |
4682 | Also, the @code{step} command only enters a function if there is line |
4683 | number information for the function. Otherwise it acts like the | |
5d161b24 | 4684 | @code{next} command. This avoids problems when using @code{cc -gl} |
c906108c | 4685 | on MIPS machines. Previously, @code{step} entered subroutines if there |
5d161b24 | 4686 | was any debugging information about the routine. |
c906108c SS |
4687 | |
4688 | @item step @var{count} | |
4689 | Continue running as in @code{step}, but do so @var{count} times. If a | |
7a292a7a SS |
4690 | breakpoint is reached, or a signal not related to stepping occurs before |
4691 | @var{count} steps, stepping stops right away. | |
c906108c SS |
4692 | |
4693 | @kindex next | |
41afff9a | 4694 | @kindex n @r{(@code{next})} |
c906108c SS |
4695 | @item next @r{[}@var{count}@r{]} |
4696 | Continue to the next source line in the current (innermost) stack frame. | |
7a292a7a SS |
4697 | This is similar to @code{step}, but function calls that appear within |
4698 | the line of code are executed without stopping. Execution stops when | |
4699 | control reaches a different line of code at the original stack level | |
4700 | that was executing when you gave the @code{next} command. This command | |
4701 | is abbreviated @code{n}. | |
c906108c SS |
4702 | |
4703 | An argument @var{count} is a repeat count, as for @code{step}. | |
4704 | ||
4705 | ||
4706 | @c FIX ME!! Do we delete this, or is there a way it fits in with | |
4707 | @c the following paragraph? --- Vctoria | |
4708 | @c | |
4709 | @c @code{next} within a function that lacks debugging information acts like | |
4710 | @c @code{step}, but any function calls appearing within the code of the | |
4711 | @c function are executed without stopping. | |
4712 | ||
d4f3574e SS |
4713 | The @code{next} command only stops at the first instruction of a |
4714 | source line. This prevents multiple stops that could otherwise occur in | |
4a92d011 | 4715 | @code{switch} statements, @code{for} loops, etc. |
c906108c | 4716 | |
b90a5f51 CF |
4717 | @kindex set step-mode |
4718 | @item set step-mode | |
4719 | @cindex functions without line info, and stepping | |
4720 | @cindex stepping into functions with no line info | |
4721 | @itemx set step-mode on | |
4a92d011 | 4722 | The @code{set step-mode on} command causes the @code{step} command to |
b90a5f51 CF |
4723 | stop at the first instruction of a function which contains no debug line |
4724 | information rather than stepping over it. | |
4725 | ||
4a92d011 EZ |
4726 | This is useful in cases where you may be interested in inspecting the |
4727 | machine instructions of a function which has no symbolic info and do not | |
4728 | want @value{GDBN} to automatically skip over this function. | |
b90a5f51 CF |
4729 | |
4730 | @item set step-mode off | |
4a92d011 | 4731 | Causes the @code{step} command to step over any functions which contains no |
b90a5f51 CF |
4732 | debug information. This is the default. |
4733 | ||
9c16f35a EZ |
4734 | @item show step-mode |
4735 | Show whether @value{GDBN} will stop in or step over functions without | |
4736 | source line debug information. | |
4737 | ||
c906108c | 4738 | @kindex finish |
8dfa32fc | 4739 | @kindex fin @r{(@code{finish})} |
c906108c SS |
4740 | @item finish |
4741 | Continue running until just after function in the selected stack frame | |
8dfa32fc JB |
4742 | returns. Print the returned value (if any). This command can be |
4743 | abbreviated as @code{fin}. | |
c906108c SS |
4744 | |
4745 | Contrast this with the @code{return} command (@pxref{Returning, | |
79a6e687 | 4746 | ,Returning from a Function}). |
c906108c SS |
4747 | |
4748 | @kindex until | |
41afff9a | 4749 | @kindex u @r{(@code{until})} |
09d4efe1 | 4750 | @cindex run until specified location |
c906108c SS |
4751 | @item until |
4752 | @itemx u | |
4753 | Continue running until a source line past the current line, in the | |
4754 | current stack frame, is reached. This command is used to avoid single | |
4755 | stepping through a loop more than once. It is like the @code{next} | |
4756 | command, except that when @code{until} encounters a jump, it | |
4757 | automatically continues execution until the program counter is greater | |
4758 | than the address of the jump. | |
4759 | ||
4760 | This means that when you reach the end of a loop after single stepping | |
4761 | though it, @code{until} makes your program continue execution until it | |
4762 | exits the loop. In contrast, a @code{next} command at the end of a loop | |
4763 | simply steps back to the beginning of the loop, which forces you to step | |
4764 | through the next iteration. | |
4765 | ||
4766 | @code{until} always stops your program if it attempts to exit the current | |
4767 | stack frame. | |
4768 | ||
4769 | @code{until} may produce somewhat counterintuitive results if the order | |
4770 | of machine code does not match the order of the source lines. For | |
4771 | example, in the following excerpt from a debugging session, the @code{f} | |
4772 | (@code{frame}) command shows that execution is stopped at line | |
4773 | @code{206}; yet when we use @code{until}, we get to line @code{195}: | |
4774 | ||
474c8240 | 4775 | @smallexample |
c906108c SS |
4776 | (@value{GDBP}) f |
4777 | #0 main (argc=4, argv=0xf7fffae8) at m4.c:206 | |
4778 | 206 expand_input(); | |
4779 | (@value{GDBP}) until | |
4780 | 195 for ( ; argc > 0; NEXTARG) @{ | |
474c8240 | 4781 | @end smallexample |
c906108c SS |
4782 | |
4783 | This happened because, for execution efficiency, the compiler had | |
4784 | generated code for the loop closure test at the end, rather than the | |
4785 | start, of the loop---even though the test in a C @code{for}-loop is | |
4786 | written before the body of the loop. The @code{until} command appeared | |
4787 | to step back to the beginning of the loop when it advanced to this | |
4788 | expression; however, it has not really gone to an earlier | |
4789 | statement---not in terms of the actual machine code. | |
4790 | ||
4791 | @code{until} with no argument works by means of single | |
4792 | instruction stepping, and hence is slower than @code{until} with an | |
4793 | argument. | |
4794 | ||
4795 | @item until @var{location} | |
4796 | @itemx u @var{location} | |
4797 | Continue running your program until either the specified location is | |
4798 | reached, or the current stack frame returns. @var{location} is any of | |
2a25a5ba EZ |
4799 | the forms described in @ref{Specify Location}. |
4800 | This form of the command uses temporary breakpoints, and | |
c60eb6f1 EZ |
4801 | hence is quicker than @code{until} without an argument. The specified |
4802 | location is actually reached only if it is in the current frame. This | |
4803 | implies that @code{until} can be used to skip over recursive function | |
4804 | invocations. For instance in the code below, if the current location is | |
4805 | line @code{96}, issuing @code{until 99} will execute the program up to | |
db2e3e2e | 4806 | line @code{99} in the same invocation of factorial, i.e., after the inner |
c60eb6f1 EZ |
4807 | invocations have returned. |
4808 | ||
4809 | @smallexample | |
4810 | 94 int factorial (int value) | |
4811 | 95 @{ | |
4812 | 96 if (value > 1) @{ | |
4813 | 97 value *= factorial (value - 1); | |
4814 | 98 @} | |
4815 | 99 return (value); | |
4816 | 100 @} | |
4817 | @end smallexample | |
4818 | ||
4819 | ||
4820 | @kindex advance @var{location} | |
4821 | @itemx advance @var{location} | |
09d4efe1 | 4822 | Continue running the program up to the given @var{location}. An argument is |
2a25a5ba EZ |
4823 | required, which should be of one of the forms described in |
4824 | @ref{Specify Location}. | |
4825 | Execution will also stop upon exit from the current stack | |
c60eb6f1 EZ |
4826 | frame. This command is similar to @code{until}, but @code{advance} will |
4827 | not skip over recursive function calls, and the target location doesn't | |
4828 | have to be in the same frame as the current one. | |
4829 | ||
c906108c SS |
4830 | |
4831 | @kindex stepi | |
41afff9a | 4832 | @kindex si @r{(@code{stepi})} |
c906108c | 4833 | @item stepi |
96a2c332 | 4834 | @itemx stepi @var{arg} |
c906108c SS |
4835 | @itemx si |
4836 | Execute one machine instruction, then stop and return to the debugger. | |
4837 | ||
4838 | It is often useful to do @samp{display/i $pc} when stepping by machine | |
4839 | instructions. This makes @value{GDBN} automatically display the next | |
4840 | instruction to be executed, each time your program stops. @xref{Auto | |
79a6e687 | 4841 | Display,, Automatic Display}. |
c906108c SS |
4842 | |
4843 | An argument is a repeat count, as in @code{step}. | |
4844 | ||
4845 | @need 750 | |
4846 | @kindex nexti | |
41afff9a | 4847 | @kindex ni @r{(@code{nexti})} |
c906108c | 4848 | @item nexti |
96a2c332 | 4849 | @itemx nexti @var{arg} |
c906108c SS |
4850 | @itemx ni |
4851 | Execute one machine instruction, but if it is a function call, | |
4852 | proceed until the function returns. | |
4853 | ||
4854 | An argument is a repeat count, as in @code{next}. | |
4855 | @end table | |
4856 | ||
6d2ebf8b | 4857 | @node Signals |
c906108c SS |
4858 | @section Signals |
4859 | @cindex signals | |
4860 | ||
4861 | A signal is an asynchronous event that can happen in a program. The | |
4862 | operating system defines the possible kinds of signals, and gives each | |
4863 | kind a name and a number. For example, in Unix @code{SIGINT} is the | |
c8aa23ab | 4864 | signal a program gets when you type an interrupt character (often @kbd{Ctrl-c}); |
c906108c SS |
4865 | @code{SIGSEGV} is the signal a program gets from referencing a place in |
4866 | memory far away from all the areas in use; @code{SIGALRM} occurs when | |
4867 | the alarm clock timer goes off (which happens only if your program has | |
4868 | requested an alarm). | |
4869 | ||
4870 | @cindex fatal signals | |
4871 | Some signals, including @code{SIGALRM}, are a normal part of the | |
4872 | functioning of your program. Others, such as @code{SIGSEGV}, indicate | |
d4f3574e | 4873 | errors; these signals are @dfn{fatal} (they kill your program immediately) if the |
c906108c SS |
4874 | program has not specified in advance some other way to handle the signal. |
4875 | @code{SIGINT} does not indicate an error in your program, but it is normally | |
4876 | fatal so it can carry out the purpose of the interrupt: to kill the program. | |
4877 | ||
4878 | @value{GDBN} has the ability to detect any occurrence of a signal in your | |
4879 | program. You can tell @value{GDBN} in advance what to do for each kind of | |
4880 | signal. | |
4881 | ||
4882 | @cindex handling signals | |
24f93129 EZ |
4883 | Normally, @value{GDBN} is set up to let the non-erroneous signals like |
4884 | @code{SIGALRM} be silently passed to your program | |
4885 | (so as not to interfere with their role in the program's functioning) | |
c906108c SS |
4886 | but to stop your program immediately whenever an error signal happens. |
4887 | You can change these settings with the @code{handle} command. | |
4888 | ||
4889 | @table @code | |
4890 | @kindex info signals | |
09d4efe1 | 4891 | @kindex info handle |
c906108c | 4892 | @item info signals |
96a2c332 | 4893 | @itemx info handle |
c906108c SS |
4894 | Print a table of all the kinds of signals and how @value{GDBN} has been told to |
4895 | handle each one. You can use this to see the signal numbers of all | |
4896 | the defined types of signals. | |
4897 | ||
45ac1734 EZ |
4898 | @item info signals @var{sig} |
4899 | Similar, but print information only about the specified signal number. | |
4900 | ||
d4f3574e | 4901 | @code{info handle} is an alias for @code{info signals}. |
c906108c SS |
4902 | |
4903 | @kindex handle | |
45ac1734 | 4904 | @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]} |
5ece1a18 EZ |
4905 | Change the way @value{GDBN} handles signal @var{signal}. @var{signal} |
4906 | can be the number of a signal or its name (with or without the | |
24f93129 | 4907 | @samp{SIG} at the beginning); a list of signal numbers of the form |
5ece1a18 | 4908 | @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the |
45ac1734 EZ |
4909 | known signals. Optional arguments @var{keywords}, described below, |
4910 | say what change to make. | |
c906108c SS |
4911 | @end table |
4912 | ||
4913 | @c @group | |
4914 | The keywords allowed by the @code{handle} command can be abbreviated. | |
4915 | Their full names are: | |
4916 | ||
4917 | @table @code | |
4918 | @item nostop | |
4919 | @value{GDBN} should not stop your program when this signal happens. It may | |
4920 | still print a message telling you that the signal has come in. | |
4921 | ||
4922 | @item stop | |
4923 | @value{GDBN} should stop your program when this signal happens. This implies | |
4924 | the @code{print} keyword as well. | |
4925 | ||
4926 | @item print | |
4927 | @value{GDBN} should print a message when this signal happens. | |
4928 | ||
4929 | @item noprint | |
4930 | @value{GDBN} should not mention the occurrence of the signal at all. This | |
4931 | implies the @code{nostop} keyword as well. | |
4932 | ||
4933 | @item pass | |
5ece1a18 | 4934 | @itemx noignore |
c906108c SS |
4935 | @value{GDBN} should allow your program to see this signal; your program |
4936 | can handle the signal, or else it may terminate if the signal is fatal | |
5ece1a18 | 4937 | and not handled. @code{pass} and @code{noignore} are synonyms. |
c906108c SS |
4938 | |
4939 | @item nopass | |
5ece1a18 | 4940 | @itemx ignore |
c906108c | 4941 | @value{GDBN} should not allow your program to see this signal. |
5ece1a18 | 4942 | @code{nopass} and @code{ignore} are synonyms. |
c906108c SS |
4943 | @end table |
4944 | @c @end group | |
4945 | ||
d4f3574e SS |
4946 | When a signal stops your program, the signal is not visible to the |
4947 | program until you | |
c906108c SS |
4948 | continue. Your program sees the signal then, if @code{pass} is in |
4949 | effect for the signal in question @emph{at that time}. In other words, | |
4950 | after @value{GDBN} reports a signal, you can use the @code{handle} | |
4951 | command with @code{pass} or @code{nopass} to control whether your | |
4952 | program sees that signal when you continue. | |
4953 | ||
24f93129 EZ |
4954 | The default is set to @code{nostop}, @code{noprint}, @code{pass} for |
4955 | non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and | |
4956 | @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the | |
4957 | erroneous signals. | |
4958 | ||
c906108c SS |
4959 | You can also use the @code{signal} command to prevent your program from |
4960 | seeing a signal, or cause it to see a signal it normally would not see, | |
4961 | or to give it any signal at any time. For example, if your program stopped | |
4962 | due to some sort of memory reference error, you might store correct | |
4963 | values into the erroneous variables and continue, hoping to see more | |
4964 | execution; but your program would probably terminate immediately as | |
4965 | a result of the fatal signal once it saw the signal. To prevent this, | |
4966 | you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your | |
79a6e687 | 4967 | Program a Signal}. |
c906108c | 4968 | |
4aa995e1 PA |
4969 | @cindex extra signal information |
4970 | @anchor{extra signal information} | |
4971 | ||
4972 | On some targets, @value{GDBN} can inspect extra signal information | |
4973 | associated with the intercepted signal, before it is actually | |
4974 | delivered to the program being debugged. This information is exported | |
4975 | by the convenience variable @code{$_siginfo}, and consists of data | |
4976 | that is passed by the kernel to the signal handler at the time of the | |
4977 | receipt of a signal. The data type of the information itself is | |
4978 | target dependent. You can see the data type using the @code{ptype | |
4979 | $_siginfo} command. On Unix systems, it typically corresponds to the | |
4980 | standard @code{siginfo_t} type, as defined in the @file{signal.h} | |
4981 | system header. | |
4982 | ||
4983 | Here's an example, on a @sc{gnu}/Linux system, printing the stray | |
4984 | referenced address that raised a segmentation fault. | |
4985 | ||
4986 | @smallexample | |
4987 | @group | |
4988 | (@value{GDBP}) continue | |
4989 | Program received signal SIGSEGV, Segmentation fault. | |
4990 | 0x0000000000400766 in main () | |
4991 | 69 *(int *)p = 0; | |
4992 | (@value{GDBP}) ptype $_siginfo | |
4993 | type = struct @{ | |
4994 | int si_signo; | |
4995 | int si_errno; | |
4996 | int si_code; | |
4997 | union @{ | |
4998 | int _pad[28]; | |
4999 | struct @{...@} _kill; | |
5000 | struct @{...@} _timer; | |
5001 | struct @{...@} _rt; | |
5002 | struct @{...@} _sigchld; | |
5003 | struct @{...@} _sigfault; | |
5004 | struct @{...@} _sigpoll; | |
5005 | @} _sifields; | |
5006 | @} | |
5007 | (@value{GDBP}) ptype $_siginfo._sifields._sigfault | |
5008 | type = struct @{ | |
5009 | void *si_addr; | |
5010 | @} | |
5011 | (@value{GDBP}) p $_siginfo._sifields._sigfault.si_addr | |
5012 | $1 = (void *) 0x7ffff7ff7000 | |
5013 | @end group | |
5014 | @end smallexample | |
5015 | ||
5016 | Depending on target support, @code{$_siginfo} may also be writable. | |
5017 | ||
6d2ebf8b | 5018 | @node Thread Stops |
79a6e687 | 5019 | @section Stopping and Starting Multi-thread Programs |
c906108c | 5020 | |
0606b73b SL |
5021 | @cindex stopped threads |
5022 | @cindex threads, stopped | |
5023 | ||
5024 | @cindex continuing threads | |
5025 | @cindex threads, continuing | |
5026 | ||
5027 | @value{GDBN} supports debugging programs with multiple threads | |
5028 | (@pxref{Threads,, Debugging Programs with Multiple Threads}). There | |
5029 | are two modes of controlling execution of your program within the | |
5030 | debugger. In the default mode, referred to as @dfn{all-stop mode}, | |
5031 | when any thread in your program stops (for example, at a breakpoint | |
5032 | or while being stepped), all other threads in the program are also stopped by | |
5033 | @value{GDBN}. On some targets, @value{GDBN} also supports | |
5034 | @dfn{non-stop mode}, in which other threads can continue to run freely while | |
5035 | you examine the stopped thread in the debugger. | |
5036 | ||
5037 | @menu | |
5038 | * All-Stop Mode:: All threads stop when GDB takes control | |
5039 | * Non-Stop Mode:: Other threads continue to execute | |
5040 | * Background Execution:: Running your program asynchronously | |
5041 | * Thread-Specific Breakpoints:: Controlling breakpoints | |
5042 | * Interrupted System Calls:: GDB may interfere with system calls | |
d914c394 | 5043 | * Observer Mode:: GDB does not alter program behavior |
0606b73b SL |
5044 | @end menu |
5045 | ||
5046 | @node All-Stop Mode | |
5047 | @subsection All-Stop Mode | |
5048 | ||
5049 | @cindex all-stop mode | |
5050 | ||
5051 | In all-stop mode, whenever your program stops under @value{GDBN} for any reason, | |
5052 | @emph{all} threads of execution stop, not just the current thread. This | |
5053 | allows you to examine the overall state of the program, including | |
5054 | switching between threads, without worrying that things may change | |
5055 | underfoot. | |
5056 | ||
5057 | Conversely, whenever you restart the program, @emph{all} threads start | |
5058 | executing. @emph{This is true even when single-stepping} with commands | |
5059 | like @code{step} or @code{next}. | |
5060 | ||
5061 | In particular, @value{GDBN} cannot single-step all threads in lockstep. | |
5062 | Since thread scheduling is up to your debugging target's operating | |
5063 | system (not controlled by @value{GDBN}), other threads may | |
5064 | execute more than one statement while the current thread completes a | |
5065 | single step. Moreover, in general other threads stop in the middle of a | |
5066 | statement, rather than at a clean statement boundary, when the program | |
5067 | stops. | |
5068 | ||
5069 | You might even find your program stopped in another thread after | |
5070 | continuing or even single-stepping. This happens whenever some other | |
5071 | thread runs into a breakpoint, a signal, or an exception before the | |
5072 | first thread completes whatever you requested. | |
5073 | ||
5074 | @cindex automatic thread selection | |
5075 | @cindex switching threads automatically | |
5076 | @cindex threads, automatic switching | |
5077 | Whenever @value{GDBN} stops your program, due to a breakpoint or a | |
5078 | signal, it automatically selects the thread where that breakpoint or | |
5079 | signal happened. @value{GDBN} alerts you to the context switch with a | |
5080 | message such as @samp{[Switching to Thread @var{n}]} to identify the | |
5081 | thread. | |
5082 | ||
5083 | On some OSes, you can modify @value{GDBN}'s default behavior by | |
5084 | locking the OS scheduler to allow only a single thread to run. | |
5085 | ||
5086 | @table @code | |
5087 | @item set scheduler-locking @var{mode} | |
5088 | @cindex scheduler locking mode | |
5089 | @cindex lock scheduler | |
5090 | Set the scheduler locking mode. If it is @code{off}, then there is no | |
5091 | locking and any thread may run at any time. If @code{on}, then only the | |
5092 | current thread may run when the inferior is resumed. The @code{step} | |
5093 | mode optimizes for single-stepping; it prevents other threads | |
5094 | from preempting the current thread while you are stepping, so that | |
5095 | the focus of debugging does not change unexpectedly. | |
5096 | Other threads only rarely (or never) get a chance to run | |
5097 | when you step. They are more likely to run when you @samp{next} over a | |
5098 | function call, and they are completely free to run when you use commands | |
5099 | like @samp{continue}, @samp{until}, or @samp{finish}. However, unless another | |
5100 | thread hits a breakpoint during its timeslice, @value{GDBN} does not change | |
5101 | the current thread away from the thread that you are debugging. | |
5102 | ||
5103 | @item show scheduler-locking | |
5104 | Display the current scheduler locking mode. | |
5105 | @end table | |
5106 | ||
d4db2f36 PA |
5107 | @cindex resume threads of multiple processes simultaneously |
5108 | By default, when you issue one of the execution commands such as | |
5109 | @code{continue}, @code{next} or @code{step}, @value{GDBN} allows only | |
5110 | threads of the current inferior to run. For example, if @value{GDBN} | |
5111 | is attached to two inferiors, each with two threads, the | |
5112 | @code{continue} command resumes only the two threads of the current | |
5113 | inferior. This is useful, for example, when you debug a program that | |
5114 | forks and you want to hold the parent stopped (so that, for instance, | |
5115 | it doesn't run to exit), while you debug the child. In other | |
5116 | situations, you may not be interested in inspecting the current state | |
5117 | of any of the processes @value{GDBN} is attached to, and you may want | |
5118 | to resume them all until some breakpoint is hit. In the latter case, | |
5119 | you can instruct @value{GDBN} to allow all threads of all the | |
5120 | inferiors to run with the @w{@code{set schedule-multiple}} command. | |
5121 | ||
5122 | @table @code | |
5123 | @kindex set schedule-multiple | |
5124 | @item set schedule-multiple | |
5125 | Set the mode for allowing threads of multiple processes to be resumed | |
5126 | when an execution command is issued. When @code{on}, all threads of | |
5127 | all processes are allowed to run. When @code{off}, only the threads | |
5128 | of the current process are resumed. The default is @code{off}. The | |
5129 | @code{scheduler-locking} mode takes precedence when set to @code{on}, | |
5130 | or while you are stepping and set to @code{step}. | |
5131 | ||
5132 | @item show schedule-multiple | |
5133 | Display the current mode for resuming the execution of threads of | |
5134 | multiple processes. | |
5135 | @end table | |
5136 | ||
0606b73b SL |
5137 | @node Non-Stop Mode |
5138 | @subsection Non-Stop Mode | |
5139 | ||
5140 | @cindex non-stop mode | |
5141 | ||
5142 | @c This section is really only a place-holder, and needs to be expanded | |
5143 | @c with more details. | |
5144 | ||
5145 | For some multi-threaded targets, @value{GDBN} supports an optional | |
5146 | mode of operation in which you can examine stopped program threads in | |
5147 | the debugger while other threads continue to execute freely. This | |
5148 | minimizes intrusion when debugging live systems, such as programs | |
5149 | where some threads have real-time constraints or must continue to | |
5150 | respond to external events. This is referred to as @dfn{non-stop} mode. | |
5151 | ||
5152 | In non-stop mode, when a thread stops to report a debugging event, | |
5153 | @emph{only} that thread is stopped; @value{GDBN} does not stop other | |
5154 | threads as well, in contrast to the all-stop mode behavior. Additionally, | |
5155 | execution commands such as @code{continue} and @code{step} apply by default | |
5156 | only to the current thread in non-stop mode, rather than all threads as | |
5157 | in all-stop mode. This allows you to control threads explicitly in | |
5158 | ways that are not possible in all-stop mode --- for example, stepping | |
5159 | one thread while allowing others to run freely, stepping | |
5160 | one thread while holding all others stopped, or stepping several threads | |
5161 | independently and simultaneously. | |
5162 | ||
5163 | To enter non-stop mode, use this sequence of commands before you run | |
5164 | or attach to your program: | |
5165 | ||
0606b73b SL |
5166 | @smallexample |
5167 | # Enable the async interface. | |
c6ebd6cf | 5168 | set target-async 1 |
0606b73b | 5169 | |
0606b73b SL |
5170 | # If using the CLI, pagination breaks non-stop. |
5171 | set pagination off | |
5172 | ||
5173 | # Finally, turn it on! | |
5174 | set non-stop on | |
5175 | @end smallexample | |
5176 | ||
5177 | You can use these commands to manipulate the non-stop mode setting: | |
5178 | ||
5179 | @table @code | |
5180 | @kindex set non-stop | |
5181 | @item set non-stop on | |
5182 | Enable selection of non-stop mode. | |
5183 | @item set non-stop off | |
5184 | Disable selection of non-stop mode. | |
5185 | @kindex show non-stop | |
5186 | @item show non-stop | |
5187 | Show the current non-stop enablement setting. | |
5188 | @end table | |
5189 | ||
5190 | Note these commands only reflect whether non-stop mode is enabled, | |
5191 | not whether the currently-executing program is being run in non-stop mode. | |
5192 | In particular, the @code{set non-stop} preference is only consulted when | |
5193 | @value{GDBN} starts or connects to the target program, and it is generally | |
5194 | not possible to switch modes once debugging has started. Furthermore, | |
5195 | since not all targets support non-stop mode, even when you have enabled | |
5196 | non-stop mode, @value{GDBN} may still fall back to all-stop operation by | |
5197 | default. | |
5198 | ||
5199 | In non-stop mode, all execution commands apply only to the current thread | |
5200 | by default. That is, @code{continue} only continues one thread. | |
5201 | To continue all threads, issue @code{continue -a} or @code{c -a}. | |
5202 | ||
5203 | You can use @value{GDBN}'s background execution commands | |
5204 | (@pxref{Background Execution}) to run some threads in the background | |
5205 | while you continue to examine or step others from @value{GDBN}. | |
5206 | The MI execution commands (@pxref{GDB/MI Program Execution}) are | |
5207 | always executed asynchronously in non-stop mode. | |
5208 | ||
5209 | Suspending execution is done with the @code{interrupt} command when | |
5210 | running in the background, or @kbd{Ctrl-c} during foreground execution. | |
5211 | In all-stop mode, this stops the whole process; | |
5212 | but in non-stop mode the interrupt applies only to the current thread. | |
5213 | To stop the whole program, use @code{interrupt -a}. | |
5214 | ||
5215 | Other execution commands do not currently support the @code{-a} option. | |
5216 | ||
5217 | In non-stop mode, when a thread stops, @value{GDBN} doesn't automatically make | |
5218 | that thread current, as it does in all-stop mode. This is because the | |
5219 | thread stop notifications are asynchronous with respect to @value{GDBN}'s | |
5220 | command interpreter, and it would be confusing if @value{GDBN} unexpectedly | |
5221 | changed to a different thread just as you entered a command to operate on the | |
5222 | previously current thread. | |
5223 | ||
5224 | @node Background Execution | |
5225 | @subsection Background Execution | |
5226 | ||
5227 | @cindex foreground execution | |
5228 | @cindex background execution | |
5229 | @cindex asynchronous execution | |
5230 | @cindex execution, foreground, background and asynchronous | |
5231 | ||
5232 | @value{GDBN}'s execution commands have two variants: the normal | |
5233 | foreground (synchronous) behavior, and a background | |
5234 | (asynchronous) behavior. In foreground execution, @value{GDBN} waits for | |
5235 | the program to report that some thread has stopped before prompting for | |
5236 | another command. In background execution, @value{GDBN} immediately gives | |
5237 | a command prompt so that you can issue other commands while your program runs. | |
5238 | ||
32fc0df9 PA |
5239 | You need to explicitly enable asynchronous mode before you can use |
5240 | background execution commands. You can use these commands to | |
5241 | manipulate the asynchronous mode setting: | |
5242 | ||
5243 | @table @code | |
5244 | @kindex set target-async | |
5245 | @item set target-async on | |
5246 | Enable asynchronous mode. | |
5247 | @item set target-async off | |
5248 | Disable asynchronous mode. | |
5249 | @kindex show target-async | |
5250 | @item show target-async | |
5251 | Show the current target-async setting. | |
5252 | @end table | |
5253 | ||
5254 | If the target doesn't support async mode, @value{GDBN} issues an error | |
5255 | message if you attempt to use the background execution commands. | |
5256 | ||
0606b73b SL |
5257 | To specify background execution, add a @code{&} to the command. For example, |
5258 | the background form of the @code{continue} command is @code{continue&}, or | |
5259 | just @code{c&}. The execution commands that accept background execution | |
5260 | are: | |
5261 | ||
5262 | @table @code | |
5263 | @kindex run& | |
5264 | @item run | |
5265 | @xref{Starting, , Starting your Program}. | |
5266 | ||
5267 | @item attach | |
5268 | @kindex attach& | |
5269 | @xref{Attach, , Debugging an Already-running Process}. | |
5270 | ||
5271 | @item step | |
5272 | @kindex step& | |
5273 | @xref{Continuing and Stepping, step}. | |
5274 | ||
5275 | @item stepi | |
5276 | @kindex stepi& | |
5277 | @xref{Continuing and Stepping, stepi}. | |
5278 | ||
5279 | @item next | |
5280 | @kindex next& | |
5281 | @xref{Continuing and Stepping, next}. | |
5282 | ||
7ce58dd2 DE |
5283 | @item nexti |
5284 | @kindex nexti& | |
5285 | @xref{Continuing and Stepping, nexti}. | |
5286 | ||
0606b73b SL |
5287 | @item continue |
5288 | @kindex continue& | |
5289 | @xref{Continuing and Stepping, continue}. | |
5290 | ||
5291 | @item finish | |
5292 | @kindex finish& | |
5293 | @xref{Continuing and Stepping, finish}. | |
5294 | ||
5295 | @item until | |
5296 | @kindex until& | |
5297 | @xref{Continuing and Stepping, until}. | |
5298 | ||
5299 | @end table | |
5300 | ||
5301 | Background execution is especially useful in conjunction with non-stop | |
5302 | mode for debugging programs with multiple threads; see @ref{Non-Stop Mode}. | |
5303 | However, you can also use these commands in the normal all-stop mode with | |
5304 | the restriction that you cannot issue another execution command until the | |
5305 | previous one finishes. Examples of commands that are valid in all-stop | |
5306 | mode while the program is running include @code{help} and @code{info break}. | |
5307 | ||
5308 | You can interrupt your program while it is running in the background by | |
5309 | using the @code{interrupt} command. | |
5310 | ||
5311 | @table @code | |
5312 | @kindex interrupt | |
5313 | @item interrupt | |
5314 | @itemx interrupt -a | |
5315 | ||
5316 | Suspend execution of the running program. In all-stop mode, | |
5317 | @code{interrupt} stops the whole process, but in non-stop mode, it stops | |
5318 | only the current thread. To stop the whole program in non-stop mode, | |
5319 | use @code{interrupt -a}. | |
5320 | @end table | |
5321 | ||
0606b73b SL |
5322 | @node Thread-Specific Breakpoints |
5323 | @subsection Thread-Specific Breakpoints | |
5324 | ||
c906108c | 5325 | When your program has multiple threads (@pxref{Threads,, Debugging |
79a6e687 | 5326 | Programs with Multiple Threads}), you can choose whether to set |
c906108c SS |
5327 | breakpoints on all threads, or on a particular thread. |
5328 | ||
5329 | @table @code | |
5330 | @cindex breakpoints and threads | |
5331 | @cindex thread breakpoints | |
5332 | @kindex break @dots{} thread @var{threadno} | |
5333 | @item break @var{linespec} thread @var{threadno} | |
5334 | @itemx break @var{linespec} thread @var{threadno} if @dots{} | |
5335 | @var{linespec} specifies source lines; there are several ways of | |
2a25a5ba EZ |
5336 | writing them (@pxref{Specify Location}), but the effect is always to |
5337 | specify some source line. | |
c906108c SS |
5338 | |
5339 | Use the qualifier @samp{thread @var{threadno}} with a breakpoint command | |
5340 | to specify that you only want @value{GDBN} to stop the program when a | |
5341 | particular thread reaches this breakpoint. @var{threadno} is one of the | |
5342 | numeric thread identifiers assigned by @value{GDBN}, shown in the first | |
5343 | column of the @samp{info threads} display. | |
5344 | ||
5345 | If you do not specify @samp{thread @var{threadno}} when you set a | |
5346 | breakpoint, the breakpoint applies to @emph{all} threads of your | |
5347 | program. | |
5348 | ||
5349 | You can use the @code{thread} qualifier on conditional breakpoints as | |
b6199126 DJ |
5350 | well; in this case, place @samp{thread @var{threadno}} before or |
5351 | after the breakpoint condition, like this: | |
c906108c SS |
5352 | |
5353 | @smallexample | |
2df3850c | 5354 | (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim |
c906108c SS |
5355 | @end smallexample |
5356 | ||
5357 | @end table | |
5358 | ||
0606b73b SL |
5359 | @node Interrupted System Calls |
5360 | @subsection Interrupted System Calls | |
c906108c | 5361 | |
36d86913 MC |
5362 | @cindex thread breakpoints and system calls |
5363 | @cindex system calls and thread breakpoints | |
5364 | @cindex premature return from system calls | |
0606b73b SL |
5365 | There is an unfortunate side effect when using @value{GDBN} to debug |
5366 | multi-threaded programs. If one thread stops for a | |
36d86913 MC |
5367 | breakpoint, or for some other reason, and another thread is blocked in a |
5368 | system call, then the system call may return prematurely. This is a | |
5369 | consequence of the interaction between multiple threads and the signals | |
5370 | that @value{GDBN} uses to implement breakpoints and other events that | |
5371 | stop execution. | |
5372 | ||
5373 | To handle this problem, your program should check the return value of | |
5374 | each system call and react appropriately. This is good programming | |
5375 | style anyways. | |
5376 | ||
5377 | For example, do not write code like this: | |
5378 | ||
5379 | @smallexample | |
5380 | sleep (10); | |
5381 | @end smallexample | |
5382 | ||
5383 | The call to @code{sleep} will return early if a different thread stops | |
5384 | at a breakpoint or for some other reason. | |
5385 | ||
5386 | Instead, write this: | |
5387 | ||
5388 | @smallexample | |
5389 | int unslept = 10; | |
5390 | while (unslept > 0) | |
5391 | unslept = sleep (unslept); | |
5392 | @end smallexample | |
5393 | ||
5394 | A system call is allowed to return early, so the system is still | |
5395 | conforming to its specification. But @value{GDBN} does cause your | |
5396 | multi-threaded program to behave differently than it would without | |
5397 | @value{GDBN}. | |
5398 | ||
5399 | Also, @value{GDBN} uses internal breakpoints in the thread library to | |
5400 | monitor certain events such as thread creation and thread destruction. | |
5401 | When such an event happens, a system call in another thread may return | |
5402 | prematurely, even though your program does not appear to stop. | |
5403 | ||
d914c394 SS |
5404 | @node Observer Mode |
5405 | @subsection Observer Mode | |
5406 | ||
5407 | If you want to build on non-stop mode and observe program behavior | |
5408 | without any chance of disruption by @value{GDBN}, you can set | |
5409 | variables to disable all of the debugger's attempts to modify state, | |
5410 | whether by writing memory, inserting breakpoints, etc. These operate | |
5411 | at a low level, intercepting operations from all commands. | |
5412 | ||
5413 | When all of these are set to @code{off}, then @value{GDBN} is said to | |
5414 | be @dfn{observer mode}. As a convenience, the variable | |
5415 | @code{observer} can be set to disable these, plus enable non-stop | |
5416 | mode. | |
5417 | ||
5418 | Note that @value{GDBN} will not prevent you from making nonsensical | |
5419 | combinations of these settings. For instance, if you have enabled | |
5420 | @code{may-insert-breakpoints} but disabled @code{may-write-memory}, | |
5421 | then breakpoints that work by writing trap instructions into the code | |
5422 | stream will still not be able to be placed. | |
5423 | ||
5424 | @table @code | |
5425 | ||
5426 | @kindex observer | |
5427 | @item set observer on | |
5428 | @itemx set observer off | |
5429 | When set to @code{on}, this disables all the permission variables | |
5430 | below (except for @code{insert-fast-tracepoints}), plus enables | |
5431 | non-stop debugging. Setting this to @code{off} switches back to | |
5432 | normal debugging, though remaining in non-stop mode. | |
5433 | ||
5434 | @item show observer | |
5435 | Show whether observer mode is on or off. | |
5436 | ||
5437 | @kindex may-write-registers | |
5438 | @item set may-write-registers on | |
5439 | @itemx set may-write-registers off | |
5440 | This controls whether @value{GDBN} will attempt to alter the values of | |
5441 | registers, such as with assignment expressions in @code{print}, or the | |
5442 | @code{jump} command. It defaults to @code{on}. | |
5443 | ||
5444 | @item show may-write-registers | |
5445 | Show the current permission to write registers. | |
5446 | ||
5447 | @kindex may-write-memory | |
5448 | @item set may-write-memory on | |
5449 | @itemx set may-write-memory off | |
5450 | This controls whether @value{GDBN} will attempt to alter the contents | |
5451 | of memory, such as with assignment expressions in @code{print}. It | |
5452 | defaults to @code{on}. | |
5453 | ||
5454 | @item show may-write-memory | |
5455 | Show the current permission to write memory. | |
5456 | ||
5457 | @kindex may-insert-breakpoints | |
5458 | @item set may-insert-breakpoints on | |
5459 | @itemx set may-insert-breakpoints off | |
5460 | This controls whether @value{GDBN} will attempt to insert breakpoints. | |
5461 | This affects all breakpoints, including internal breakpoints defined | |
5462 | by @value{GDBN}. It defaults to @code{on}. | |
5463 | ||
5464 | @item show may-insert-breakpoints | |
5465 | Show the current permission to insert breakpoints. | |
5466 | ||
5467 | @kindex may-insert-tracepoints | |
5468 | @item set may-insert-tracepoints on | |
5469 | @itemx set may-insert-tracepoints off | |
5470 | This controls whether @value{GDBN} will attempt to insert (regular) | |
5471 | tracepoints at the beginning of a tracing experiment. It affects only | |
5472 | non-fast tracepoints, fast tracepoints being under the control of | |
5473 | @code{may-insert-fast-tracepoints}. It defaults to @code{on}. | |
5474 | ||
5475 | @item show may-insert-tracepoints | |
5476 | Show the current permission to insert tracepoints. | |
5477 | ||
5478 | @kindex may-insert-fast-tracepoints | |
5479 | @item set may-insert-fast-tracepoints on | |
5480 | @itemx set may-insert-fast-tracepoints off | |
5481 | This controls whether @value{GDBN} will attempt to insert fast | |
5482 | tracepoints at the beginning of a tracing experiment. It affects only | |
5483 | fast tracepoints, regular (non-fast) tracepoints being under the | |
5484 | control of @code{may-insert-tracepoints}. It defaults to @code{on}. | |
5485 | ||
5486 | @item show may-insert-fast-tracepoints | |
5487 | Show the current permission to insert fast tracepoints. | |
5488 | ||
5489 | @kindex may-interrupt | |
5490 | @item set may-interrupt on | |
5491 | @itemx set may-interrupt off | |
5492 | This controls whether @value{GDBN} will attempt to interrupt or stop | |
5493 | program execution. When this variable is @code{off}, the | |
5494 | @code{interrupt} command will have no effect, nor will | |
5495 | @kbd{Ctrl-c}. It defaults to @code{on}. | |
5496 | ||
5497 | @item show may-interrupt | |
5498 | Show the current permission to interrupt or stop the program. | |
5499 | ||
5500 | @end table | |
c906108c | 5501 | |
bacec72f MS |
5502 | @node Reverse Execution |
5503 | @chapter Running programs backward | |
5504 | @cindex reverse execution | |
5505 | @cindex running programs backward | |
5506 | ||
5507 | When you are debugging a program, it is not unusual to realize that | |
5508 | you have gone too far, and some event of interest has already happened. | |
5509 | If the target environment supports it, @value{GDBN} can allow you to | |
5510 | ``rewind'' the program by running it backward. | |
5511 | ||
5512 | A target environment that supports reverse execution should be able | |
5513 | to ``undo'' the changes in machine state that have taken place as the | |
5514 | program was executing normally. Variables, registers etc.@: should | |
5515 | revert to their previous values. Obviously this requires a great | |
5516 | deal of sophistication on the part of the target environment; not | |
5517 | all target environments can support reverse execution. | |
5518 | ||
5519 | When a program is executed in reverse, the instructions that | |
5520 | have most recently been executed are ``un-executed'', in reverse | |
5521 | order. The program counter runs backward, following the previous | |
5522 | thread of execution in reverse. As each instruction is ``un-executed'', | |
5523 | the values of memory and/or registers that were changed by that | |
5524 | instruction are reverted to their previous states. After executing | |
5525 | a piece of source code in reverse, all side effects of that code | |
5526 | should be ``undone'', and all variables should be returned to their | |
5527 | prior values@footnote{ | |
5528 | Note that some side effects are easier to undo than others. For instance, | |
5529 | memory and registers are relatively easy, but device I/O is hard. Some | |
5530 | targets may be able undo things like device I/O, and some may not. | |
5531 | ||
5532 | The contract between @value{GDBN} and the reverse executing target | |
5533 | requires only that the target do something reasonable when | |
5534 | @value{GDBN} tells it to execute backwards, and then report the | |
5535 | results back to @value{GDBN}. Whatever the target reports back to | |
5536 | @value{GDBN}, @value{GDBN} will report back to the user. @value{GDBN} | |
5537 | assumes that the memory and registers that the target reports are in a | |
5538 | consistant state, but @value{GDBN} accepts whatever it is given. | |
5539 | }. | |
5540 | ||
5541 | If you are debugging in a target environment that supports | |
5542 | reverse execution, @value{GDBN} provides the following commands. | |
5543 | ||
5544 | @table @code | |
5545 | @kindex reverse-continue | |
5546 | @kindex rc @r{(@code{reverse-continue})} | |
5547 | @item reverse-continue @r{[}@var{ignore-count}@r{]} | |
5548 | @itemx rc @r{[}@var{ignore-count}@r{]} | |
5549 | Beginning at the point where your program last stopped, start executing | |
5550 | in reverse. Reverse execution will stop for breakpoints and synchronous | |
5551 | exceptions (signals), just like normal execution. Behavior of | |
5552 | asynchronous signals depends on the target environment. | |
5553 | ||
5554 | @kindex reverse-step | |
5555 | @kindex rs @r{(@code{step})} | |
5556 | @item reverse-step @r{[}@var{count}@r{]} | |
5557 | Run the program backward until control reaches the start of a | |
5558 | different source line; then stop it, and return control to @value{GDBN}. | |
5559 | ||
5560 | Like the @code{step} command, @code{reverse-step} will only stop | |
5561 | at the beginning of a source line. It ``un-executes'' the previously | |
5562 | executed source line. If the previous source line included calls to | |
5563 | debuggable functions, @code{reverse-step} will step (backward) into | |
5564 | the called function, stopping at the beginning of the @emph{last} | |
5565 | statement in the called function (typically a return statement). | |
5566 | ||
5567 | Also, as with the @code{step} command, if non-debuggable functions are | |
5568 | called, @code{reverse-step} will run thru them backward without stopping. | |
5569 | ||
5570 | @kindex reverse-stepi | |
5571 | @kindex rsi @r{(@code{reverse-stepi})} | |
5572 | @item reverse-stepi @r{[}@var{count}@r{]} | |
5573 | Reverse-execute one machine instruction. Note that the instruction | |
5574 | to be reverse-executed is @emph{not} the one pointed to by the program | |
5575 | counter, but the instruction executed prior to that one. For instance, | |
5576 | if the last instruction was a jump, @code{reverse-stepi} will take you | |
5577 | back from the destination of the jump to the jump instruction itself. | |
5578 | ||
5579 | @kindex reverse-next | |
5580 | @kindex rn @r{(@code{reverse-next})} | |
5581 | @item reverse-next @r{[}@var{count}@r{]} | |
5582 | Run backward to the beginning of the previous line executed in | |
5583 | the current (innermost) stack frame. If the line contains function | |
5584 | calls, they will be ``un-executed'' without stopping. Starting from | |
5585 | the first line of a function, @code{reverse-next} will take you back | |
5586 | to the caller of that function, @emph{before} the function was called, | |
5587 | just as the normal @code{next} command would take you from the last | |
5588 | line of a function back to its return to its caller | |
16af530a | 5589 | @footnote{Unless the code is too heavily optimized.}. |
bacec72f MS |
5590 | |
5591 | @kindex reverse-nexti | |
5592 | @kindex rni @r{(@code{reverse-nexti})} | |
5593 | @item reverse-nexti @r{[}@var{count}@r{]} | |
5594 | Like @code{nexti}, @code{reverse-nexti} executes a single instruction | |
5595 | in reverse, except that called functions are ``un-executed'' atomically. | |
5596 | That is, if the previously executed instruction was a return from | |
540aa8e7 | 5597 | another function, @code{reverse-nexti} will continue to execute |
bacec72f MS |
5598 | in reverse until the call to that function (from the current stack |
5599 | frame) is reached. | |
5600 | ||
5601 | @kindex reverse-finish | |
5602 | @item reverse-finish | |
5603 | Just as the @code{finish} command takes you to the point where the | |
5604 | current function returns, @code{reverse-finish} takes you to the point | |
5605 | where it was called. Instead of ending up at the end of the current | |
5606 | function invocation, you end up at the beginning. | |
5607 | ||
5608 | @kindex set exec-direction | |
5609 | @item set exec-direction | |
5610 | Set the direction of target execution. | |
5611 | @itemx set exec-direction reverse | |
5612 | @cindex execute forward or backward in time | |
5613 | @value{GDBN} will perform all execution commands in reverse, until the | |
5614 | exec-direction mode is changed to ``forward''. Affected commands include | |
5615 | @code{step, stepi, next, nexti, continue, and finish}. The @code{return} | |
5616 | command cannot be used in reverse mode. | |
5617 | @item set exec-direction forward | |
5618 | @value{GDBN} will perform all execution commands in the normal fashion. | |
5619 | This is the default. | |
5620 | @end table | |
5621 | ||
c906108c | 5622 | |
a2311334 EZ |
5623 | @node Process Record and Replay |
5624 | @chapter Recording Inferior's Execution and Replaying It | |
53cc454a HZ |
5625 | @cindex process record and replay |
5626 | @cindex recording inferior's execution and replaying it | |
5627 | ||
8e05493c EZ |
5628 | On some platforms, @value{GDBN} provides a special @dfn{process record |
5629 | and replay} target that can record a log of the process execution, and | |
5630 | replay it later with both forward and reverse execution commands. | |
a2311334 EZ |
5631 | |
5632 | @cindex replay mode | |
5633 | When this target is in use, if the execution log includes the record | |
5634 | for the next instruction, @value{GDBN} will debug in @dfn{replay | |
5635 | mode}. In the replay mode, the inferior does not really execute code | |
5636 | instructions. Instead, all the events that normally happen during | |
5637 | code execution are taken from the execution log. While code is not | |
5638 | really executed in replay mode, the values of registers (including the | |
5639 | program counter register) and the memory of the inferior are still | |
8e05493c EZ |
5640 | changed as they normally would. Their contents are taken from the |
5641 | execution log. | |
a2311334 EZ |
5642 | |
5643 | @cindex record mode | |
5644 | If the record for the next instruction is not in the execution log, | |
5645 | @value{GDBN} will debug in @dfn{record mode}. In this mode, the | |
5646 | inferior executes normally, and @value{GDBN} records the execution log | |
5647 | for future replay. | |
5648 | ||
8e05493c EZ |
5649 | The process record and replay target supports reverse execution |
5650 | (@pxref{Reverse Execution}), even if the platform on which the | |
5651 | inferior runs does not. However, the reverse execution is limited in | |
5652 | this case by the range of the instructions recorded in the execution | |
5653 | log. In other words, reverse execution on platforms that don't | |
5654 | support it directly can only be done in the replay mode. | |
5655 | ||
5656 | When debugging in the reverse direction, @value{GDBN} will work in | |
5657 | replay mode as long as the execution log includes the record for the | |
5658 | previous instruction; otherwise, it will work in record mode, if the | |
5659 | platform supports reverse execution, or stop if not. | |
5660 | ||
a2311334 EZ |
5661 | For architecture environments that support process record and replay, |
5662 | @value{GDBN} provides the following commands: | |
53cc454a HZ |
5663 | |
5664 | @table @code | |
5665 | @kindex target record | |
5666 | @kindex record | |
5667 | @kindex rec | |
5668 | @item target record | |
a2311334 EZ |
5669 | This command starts the process record and replay target. The process |
5670 | record and replay target can only debug a process that is already | |
5671 | running. Therefore, you need first to start the process with the | |
5672 | @kbd{run} or @kbd{start} commands, and then start the recording with | |
5673 | the @kbd{target record} command. | |
5674 | ||
5675 | Both @code{record} and @code{rec} are aliases of @code{target record}. | |
5676 | ||
5677 | @cindex displaced stepping, and process record and replay | |
5678 | Displaced stepping (@pxref{Maintenance Commands,, displaced stepping}) | |
5679 | will be automatically disabled when process record and replay target | |
5680 | is started. That's because the process record and replay target | |
5681 | doesn't support displaced stepping. | |
5682 | ||
5683 | @cindex non-stop mode, and process record and replay | |
5684 | @cindex asynchronous execution, and process record and replay | |
5685 | If the inferior is in the non-stop mode (@pxref{Non-Stop Mode}) or in | |
5686 | the asynchronous execution mode (@pxref{Background Execution}), the | |
5687 | process record and replay target cannot be started because it doesn't | |
5688 | support these two modes. | |
53cc454a HZ |
5689 | |
5690 | @kindex record stop | |
5691 | @kindex rec s | |
5692 | @item record stop | |
a2311334 EZ |
5693 | Stop the process record and replay target. When process record and |
5694 | replay target stops, the entire execution log will be deleted and the | |
5695 | inferior will either be terminated, or will remain in its final state. | |
53cc454a | 5696 | |
a2311334 EZ |
5697 | When you stop the process record and replay target in record mode (at |
5698 | the end of the execution log), the inferior will be stopped at the | |
5699 | next instruction that would have been recorded. In other words, if | |
5700 | you record for a while and then stop recording, the inferior process | |
5701 | will be left in the same state as if the recording never happened. | |
53cc454a | 5702 | |
a2311334 EZ |
5703 | On the other hand, if the process record and replay target is stopped |
5704 | while in replay mode (that is, not at the end of the execution log, | |
5705 | but at some earlier point), the inferior process will become ``live'' | |
5706 | at that earlier state, and it will then be possible to continue the | |
5707 | usual ``live'' debugging of the process from that state. | |
53cc454a | 5708 | |
a2311334 EZ |
5709 | When the inferior process exits, or @value{GDBN} detaches from it, |
5710 | process record and replay target will automatically stop itself. | |
53cc454a | 5711 | |
24e933df HZ |
5712 | @kindex record save |
5713 | @item record save @var{filename} | |
5714 | Save the execution log to a file @file{@var{filename}}. | |
5715 | Default filename is @file{gdb_record.@var{process_id}}, where | |
5716 | @var{process_id} is the process ID of the inferior. | |
5717 | ||
5718 | @kindex record restore | |
5719 | @item record restore @var{filename} | |
5720 | Restore the execution log from a file @file{@var{filename}}. | |
5721 | File must have been created with @code{record save}. | |
5722 | ||
53cc454a HZ |
5723 | @kindex set record insn-number-max |
5724 | @item set record insn-number-max @var{limit} | |
5725 | Set the limit of instructions to be recorded. Default value is 200000. | |
5726 | ||
a2311334 EZ |
5727 | If @var{limit} is a positive number, then @value{GDBN} will start |
5728 | deleting instructions from the log once the number of the record | |
5729 | instructions becomes greater than @var{limit}. For every new recorded | |
5730 | instruction, @value{GDBN} will delete the earliest recorded | |
5731 | instruction to keep the number of recorded instructions at the limit. | |
5732 | (Since deleting recorded instructions loses information, @value{GDBN} | |
5733 | lets you control what happens when the limit is reached, by means of | |
5734 | the @code{stop-at-limit} option, described below.) | |
53cc454a | 5735 | |
a2311334 EZ |
5736 | If @var{limit} is zero, @value{GDBN} will never delete recorded |
5737 | instructions from the execution log. The number of recorded | |
5738 | instructions is unlimited in this case. | |
53cc454a HZ |
5739 | |
5740 | @kindex show record insn-number-max | |
5741 | @item show record insn-number-max | |
a2311334 | 5742 | Show the limit of instructions to be recorded. |
53cc454a HZ |
5743 | |
5744 | @kindex set record stop-at-limit | |
a2311334 EZ |
5745 | @item set record stop-at-limit |
5746 | Control the behavior when the number of recorded instructions reaches | |
5747 | the limit. If ON (the default), @value{GDBN} will stop when the limit | |
5748 | is reached for the first time and ask you whether you want to stop the | |
5749 | inferior or continue running it and recording the execution log. If | |
5750 | you decide to continue recording, each new recorded instruction will | |
5751 | cause the oldest one to be deleted. | |
53cc454a | 5752 | |
a2311334 EZ |
5753 | If this option is OFF, @value{GDBN} will automatically delete the |
5754 | oldest record to make room for each new one, without asking. | |
53cc454a HZ |
5755 | |
5756 | @kindex show record stop-at-limit | |
5757 | @item show record stop-at-limit | |
a2311334 | 5758 | Show the current setting of @code{stop-at-limit}. |
53cc454a | 5759 | |
bb08c432 HZ |
5760 | @kindex set record memory-query |
5761 | @item set record memory-query | |
5762 | Control the behavior when @value{GDBN} is unable to record memory | |
5763 | changes caused by an instruction. If ON, @value{GDBN} will query | |
5764 | whether to stop the inferior in that case. | |
5765 | ||
5766 | If this option is OFF (the default), @value{GDBN} will automatically | |
5767 | ignore the effect of such instructions on memory. Later, when | |
5768 | @value{GDBN} replays this execution log, it will mark the log of this | |
5769 | instruction as not accessible, and it will not affect the replay | |
5770 | results. | |
5771 | ||
5772 | @kindex show record memory-query | |
5773 | @item show record memory-query | |
5774 | Show the current setting of @code{memory-query}. | |
5775 | ||
29153c24 MS |
5776 | @kindex info record |
5777 | @item info record | |
5778 | Show various statistics about the state of process record and its | |
5779 | in-memory execution log buffer, including: | |
5780 | ||
5781 | @itemize @bullet | |
5782 | @item | |
5783 | Whether in record mode or replay mode. | |
5784 | @item | |
5785 | Lowest recorded instruction number (counting from when the current execution log started recording instructions). | |
5786 | @item | |
5787 | Highest recorded instruction number. | |
5788 | @item | |
5789 | Current instruction about to be replayed (if in replay mode). | |
5790 | @item | |
5791 | Number of instructions contained in the execution log. | |
5792 | @item | |
5793 | Maximum number of instructions that may be contained in the execution log. | |
5794 | @end itemize | |
53cc454a HZ |
5795 | |
5796 | @kindex record delete | |
5797 | @kindex rec del | |
5798 | @item record delete | |
a2311334 | 5799 | When record target runs in replay mode (``in the past''), delete the |
53cc454a | 5800 | subsequent execution log and begin to record a new execution log starting |
a2311334 | 5801 | from the current address. This means you will abandon the previously |
53cc454a HZ |
5802 | recorded ``future'' and begin recording a new ``future''. |
5803 | @end table | |
5804 | ||
5805 | ||
6d2ebf8b | 5806 | @node Stack |
c906108c SS |
5807 | @chapter Examining the Stack |
5808 | ||
5809 | When your program has stopped, the first thing you need to know is where it | |
5810 | stopped and how it got there. | |
5811 | ||
5812 | @cindex call stack | |
5d161b24 DB |
5813 | Each time your program performs a function call, information about the call |
5814 | is generated. | |
5815 | That information includes the location of the call in your program, | |
5816 | the arguments of the call, | |
c906108c | 5817 | and the local variables of the function being called. |
5d161b24 | 5818 | The information is saved in a block of data called a @dfn{stack frame}. |
c906108c SS |
5819 | The stack frames are allocated in a region of memory called the @dfn{call |
5820 | stack}. | |
5821 | ||
5822 | When your program stops, the @value{GDBN} commands for examining the | |
5823 | stack allow you to see all of this information. | |
5824 | ||
5825 | @cindex selected frame | |
5826 | One of the stack frames is @dfn{selected} by @value{GDBN} and many | |
5827 | @value{GDBN} commands refer implicitly to the selected frame. In | |
5828 | particular, whenever you ask @value{GDBN} for the value of a variable in | |
5829 | your program, the value is found in the selected frame. There are | |
5830 | special @value{GDBN} commands to select whichever frame you are | |
79a6e687 | 5831 | interested in. @xref{Selection, ,Selecting a Frame}. |
c906108c SS |
5832 | |
5833 | When your program stops, @value{GDBN} automatically selects the | |
5d161b24 | 5834 | currently executing frame and describes it briefly, similar to the |
79a6e687 | 5835 | @code{frame} command (@pxref{Frame Info, ,Information about a Frame}). |
c906108c SS |
5836 | |
5837 | @menu | |
5838 | * Frames:: Stack frames | |
5839 | * Backtrace:: Backtraces | |
5840 | * Selection:: Selecting a frame | |
5841 | * Frame Info:: Information on a frame | |
c906108c SS |
5842 | |
5843 | @end menu | |
5844 | ||
6d2ebf8b | 5845 | @node Frames |
79a6e687 | 5846 | @section Stack Frames |
c906108c | 5847 | |
d4f3574e | 5848 | @cindex frame, definition |
c906108c SS |
5849 | @cindex stack frame |
5850 | The call stack is divided up into contiguous pieces called @dfn{stack | |
5851 | frames}, or @dfn{frames} for short; each frame is the data associated | |
5852 | with one call to one function. The frame contains the arguments given | |
5853 | to the function, the function's local variables, and the address at | |
5854 | which the function is executing. | |
5855 | ||
5856 | @cindex initial frame | |
5857 | @cindex outermost frame | |
5858 | @cindex innermost frame | |
5859 | When your program is started, the stack has only one frame, that of the | |
5860 | function @code{main}. This is called the @dfn{initial} frame or the | |
5861 | @dfn{outermost} frame. Each time a function is called, a new frame is | |
5862 | made. Each time a function returns, the frame for that function invocation | |
5863 | is eliminated. If a function is recursive, there can be many frames for | |
5864 | the same function. The frame for the function in which execution is | |
5865 | actually occurring is called the @dfn{innermost} frame. This is the most | |
5866 | recently created of all the stack frames that still exist. | |
5867 | ||
5868 | @cindex frame pointer | |
5869 | Inside your program, stack frames are identified by their addresses. A | |
5870 | stack frame consists of many bytes, each of which has its own address; each | |
5871 | kind of computer has a convention for choosing one byte whose | |
5872 | address serves as the address of the frame. Usually this address is kept | |
e09f16f9 EZ |
5873 | in a register called the @dfn{frame pointer register} |
5874 | (@pxref{Registers, $fp}) while execution is going on in that frame. | |
c906108c SS |
5875 | |
5876 | @cindex frame number | |
5877 | @value{GDBN} assigns numbers to all existing stack frames, starting with | |
5878 | zero for the innermost frame, one for the frame that called it, | |
5879 | and so on upward. These numbers do not really exist in your program; | |
5880 | they are assigned by @value{GDBN} to give you a way of designating stack | |
5881 | frames in @value{GDBN} commands. | |
5882 | ||
6d2ebf8b SS |
5883 | @c The -fomit-frame-pointer below perennially causes hbox overflow |
5884 | @c underflow problems. | |
c906108c SS |
5885 | @cindex frameless execution |
5886 | Some compilers provide a way to compile functions so that they operate | |
e22ea452 | 5887 | without stack frames. (For example, the @value{NGCC} option |
474c8240 | 5888 | @smallexample |
6d2ebf8b | 5889 | @samp{-fomit-frame-pointer} |
474c8240 | 5890 | @end smallexample |
6d2ebf8b | 5891 | generates functions without a frame.) |
c906108c SS |
5892 | This is occasionally done with heavily used library functions to save |
5893 | the frame setup time. @value{GDBN} has limited facilities for dealing | |
5894 | with these function invocations. If the innermost function invocation | |
5895 | has no stack frame, @value{GDBN} nevertheless regards it as though | |
5896 | it had a separate frame, which is numbered zero as usual, allowing | |
5897 | correct tracing of the function call chain. However, @value{GDBN} has | |
5898 | no provision for frameless functions elsewhere in the stack. | |
5899 | ||
5900 | @table @code | |
d4f3574e | 5901 | @kindex frame@r{, command} |
41afff9a | 5902 | @cindex current stack frame |
c906108c | 5903 | @item frame @var{args} |
5d161b24 | 5904 | The @code{frame} command allows you to move from one stack frame to another, |
c906108c | 5905 | and to print the stack frame you select. @var{args} may be either the |
5d161b24 DB |
5906 | address of the frame or the stack frame number. Without an argument, |
5907 | @code{frame} prints the current stack frame. | |
c906108c SS |
5908 | |
5909 | @kindex select-frame | |
41afff9a | 5910 | @cindex selecting frame silently |
c906108c SS |
5911 | @item select-frame |
5912 | The @code{select-frame} command allows you to move from one stack frame | |
5913 | to another without printing the frame. This is the silent version of | |
5914 | @code{frame}. | |
5915 | @end table | |
5916 | ||
6d2ebf8b | 5917 | @node Backtrace |
c906108c SS |
5918 | @section Backtraces |
5919 | ||
09d4efe1 EZ |
5920 | @cindex traceback |
5921 | @cindex call stack traces | |
c906108c SS |
5922 | A backtrace is a summary of how your program got where it is. It shows one |
5923 | line per frame, for many frames, starting with the currently executing | |
5924 | frame (frame zero), followed by its caller (frame one), and on up the | |
5925 | stack. | |
5926 | ||
5927 | @table @code | |
5928 | @kindex backtrace | |
41afff9a | 5929 | @kindex bt @r{(@code{backtrace})} |
c906108c SS |
5930 | @item backtrace |
5931 | @itemx bt | |
5932 | Print a backtrace of the entire stack: one line per frame for all | |
5933 | frames in the stack. | |
5934 | ||
5935 | You can stop the backtrace at any time by typing the system interrupt | |
c8aa23ab | 5936 | character, normally @kbd{Ctrl-c}. |
c906108c SS |
5937 | |
5938 | @item backtrace @var{n} | |
5939 | @itemx bt @var{n} | |
5940 | Similar, but print only the innermost @var{n} frames. | |
5941 | ||
5942 | @item backtrace -@var{n} | |
5943 | @itemx bt -@var{n} | |
5944 | Similar, but print only the outermost @var{n} frames. | |
0f061b69 NR |
5945 | |
5946 | @item backtrace full | |
0f061b69 | 5947 | @itemx bt full |
dd74f6ae NR |
5948 | @itemx bt full @var{n} |
5949 | @itemx bt full -@var{n} | |
e7109c7e | 5950 | Print the values of the local variables also. @var{n} specifies the |
286ba84d | 5951 | number of frames to print, as described above. |
c906108c SS |
5952 | @end table |
5953 | ||
5954 | @kindex where | |
5955 | @kindex info stack | |
c906108c SS |
5956 | The names @code{where} and @code{info stack} (abbreviated @code{info s}) |
5957 | are additional aliases for @code{backtrace}. | |
5958 | ||
839c27b7 EZ |
5959 | @cindex multiple threads, backtrace |
5960 | In a multi-threaded program, @value{GDBN} by default shows the | |
5961 | backtrace only for the current thread. To display the backtrace for | |
5962 | several or all of the threads, use the command @code{thread apply} | |
5963 | (@pxref{Threads, thread apply}). For example, if you type @kbd{thread | |
5964 | apply all backtrace}, @value{GDBN} will display the backtrace for all | |
5965 | the threads; this is handy when you debug a core dump of a | |
5966 | multi-threaded program. | |
5967 | ||
c906108c SS |
5968 | Each line in the backtrace shows the frame number and the function name. |
5969 | The program counter value is also shown---unless you use @code{set | |
5970 | print address off}. The backtrace also shows the source file name and | |
5971 | line number, as well as the arguments to the function. The program | |
5972 | counter value is omitted if it is at the beginning of the code for that | |
5973 | line number. | |
5974 | ||
5975 | Here is an example of a backtrace. It was made with the command | |
5976 | @samp{bt 3}, so it shows the innermost three frames. | |
5977 | ||
5978 | @smallexample | |
5979 | @group | |
5d161b24 | 5980 | #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8) |
c906108c | 5981 | at builtin.c:993 |
4f5376b2 | 5982 | #1 0x6e38 in expand_macro (sym=0x2b600, data=...) at macro.c:242 |
c906108c SS |
5983 | #2 0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08) |
5984 | at macro.c:71 | |
5985 | (More stack frames follow...) | |
5986 | @end group | |
5987 | @end smallexample | |
5988 | ||
5989 | @noindent | |
5990 | The display for frame zero does not begin with a program counter | |
5991 | value, indicating that your program has stopped at the beginning of the | |
5992 | code for line @code{993} of @code{builtin.c}. | |
5993 | ||
4f5376b2 JB |
5994 | @noindent |
5995 | The value of parameter @code{data} in frame 1 has been replaced by | |
5996 | @code{@dots{}}. By default, @value{GDBN} prints the value of a parameter | |
5997 | only if it is a scalar (integer, pointer, enumeration, etc). See command | |
5998 | @kbd{set print frame-arguments} in @ref{Print Settings} for more details | |
5999 | on how to configure the way function parameter values are printed. | |
6000 | ||
585fdaa1 | 6001 | @cindex optimized out, in backtrace |
18999be5 EZ |
6002 | @cindex function call arguments, optimized out |
6003 | If your program was compiled with optimizations, some compilers will | |
6004 | optimize away arguments passed to functions if those arguments are | |
6005 | never used after the call. Such optimizations generate code that | |
6006 | passes arguments through registers, but doesn't store those arguments | |
6007 | in the stack frame. @value{GDBN} has no way of displaying such | |
6008 | arguments in stack frames other than the innermost one. Here's what | |
6009 | such a backtrace might look like: | |
6010 | ||
6011 | @smallexample | |
6012 | @group | |
6013 | #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8) | |
6014 | at builtin.c:993 | |
585fdaa1 PA |
6015 | #1 0x6e38 in expand_macro (sym=<optimized out>) at macro.c:242 |
6016 | #2 0x6840 in expand_token (obs=0x0, t=<optimized out>, td=0xf7fffb08) | |
18999be5 EZ |
6017 | at macro.c:71 |
6018 | (More stack frames follow...) | |
6019 | @end group | |
6020 | @end smallexample | |
6021 | ||
6022 | @noindent | |
6023 | The values of arguments that were not saved in their stack frames are | |
585fdaa1 | 6024 | shown as @samp{<optimized out>}. |
18999be5 EZ |
6025 | |
6026 | If you need to display the values of such optimized-out arguments, | |
6027 | either deduce that from other variables whose values depend on the one | |
6028 | you are interested in, or recompile without optimizations. | |
6029 | ||
a8f24a35 EZ |
6030 | @cindex backtrace beyond @code{main} function |
6031 | @cindex program entry point | |
6032 | @cindex startup code, and backtrace | |
25d29d70 AC |
6033 | Most programs have a standard user entry point---a place where system |
6034 | libraries and startup code transition into user code. For C this is | |
d416eeec EZ |
6035 | @code{main}@footnote{ |
6036 | Note that embedded programs (the so-called ``free-standing'' | |
6037 | environment) are not required to have a @code{main} function as the | |
6038 | entry point. They could even have multiple entry points.}. | |
6039 | When @value{GDBN} finds the entry function in a backtrace | |
25d29d70 AC |
6040 | it will terminate the backtrace, to avoid tracing into highly |
6041 | system-specific (and generally uninteresting) code. | |
6042 | ||
6043 | If you need to examine the startup code, or limit the number of levels | |
6044 | in a backtrace, you can change this behavior: | |
95f90d25 DJ |
6045 | |
6046 | @table @code | |
25d29d70 AC |
6047 | @item set backtrace past-main |
6048 | @itemx set backtrace past-main on | |
4644b6e3 | 6049 | @kindex set backtrace |
25d29d70 AC |
6050 | Backtraces will continue past the user entry point. |
6051 | ||
6052 | @item set backtrace past-main off | |
95f90d25 DJ |
6053 | Backtraces will stop when they encounter the user entry point. This is the |
6054 | default. | |
6055 | ||
25d29d70 | 6056 | @item show backtrace past-main |
4644b6e3 | 6057 | @kindex show backtrace |
25d29d70 AC |
6058 | Display the current user entry point backtrace policy. |
6059 | ||
2315ffec RC |
6060 | @item set backtrace past-entry |
6061 | @itemx set backtrace past-entry on | |
a8f24a35 | 6062 | Backtraces will continue past the internal entry point of an application. |
2315ffec RC |
6063 | This entry point is encoded by the linker when the application is built, |
6064 | and is likely before the user entry point @code{main} (or equivalent) is called. | |
6065 | ||
6066 | @item set backtrace past-entry off | |
d3e8051b | 6067 | Backtraces will stop when they encounter the internal entry point of an |
2315ffec RC |
6068 | application. This is the default. |
6069 | ||
6070 | @item show backtrace past-entry | |
6071 | Display the current internal entry point backtrace policy. | |
6072 | ||
25d29d70 AC |
6073 | @item set backtrace limit @var{n} |
6074 | @itemx set backtrace limit 0 | |
6075 | @cindex backtrace limit | |
6076 | Limit the backtrace to @var{n} levels. A value of zero means | |
6077 | unlimited. | |
95f90d25 | 6078 | |
25d29d70 AC |
6079 | @item show backtrace limit |
6080 | Display the current limit on backtrace levels. | |
95f90d25 DJ |
6081 | @end table |
6082 | ||
6d2ebf8b | 6083 | @node Selection |
79a6e687 | 6084 | @section Selecting a Frame |
c906108c SS |
6085 | |
6086 | Most commands for examining the stack and other data in your program work on | |
6087 | whichever stack frame is selected at the moment. Here are the commands for | |
6088 | selecting a stack frame; all of them finish by printing a brief description | |
6089 | of the stack frame just selected. | |
6090 | ||
6091 | @table @code | |
d4f3574e | 6092 | @kindex frame@r{, selecting} |
41afff9a | 6093 | @kindex f @r{(@code{frame})} |
c906108c SS |
6094 | @item frame @var{n} |
6095 | @itemx f @var{n} | |
6096 | Select frame number @var{n}. Recall that frame zero is the innermost | |
6097 | (currently executing) frame, frame one is the frame that called the | |
6098 | innermost one, and so on. The highest-numbered frame is the one for | |
6099 | @code{main}. | |
6100 | ||
6101 | @item frame @var{addr} | |
6102 | @itemx f @var{addr} | |
6103 | Select the frame at address @var{addr}. This is useful mainly if the | |
6104 | chaining of stack frames has been damaged by a bug, making it | |
6105 | impossible for @value{GDBN} to assign numbers properly to all frames. In | |
6106 | addition, this can be useful when your program has multiple stacks and | |
6107 | switches between them. | |
6108 | ||
c906108c SS |
6109 | On the SPARC architecture, @code{frame} needs two addresses to |
6110 | select an arbitrary frame: a frame pointer and a stack pointer. | |
6111 | ||
6112 | On the MIPS and Alpha architecture, it needs two addresses: a stack | |
6113 | pointer and a program counter. | |
6114 | ||
6115 | On the 29k architecture, it needs three addresses: a register stack | |
6116 | pointer, a program counter, and a memory stack pointer. | |
c906108c SS |
6117 | |
6118 | @kindex up | |
6119 | @item up @var{n} | |
6120 | Move @var{n} frames up the stack. For positive numbers @var{n}, this | |
6121 | advances toward the outermost frame, to higher frame numbers, to frames | |
6122 | that have existed longer. @var{n} defaults to one. | |
6123 | ||
6124 | @kindex down | |
41afff9a | 6125 | @kindex do @r{(@code{down})} |
c906108c SS |
6126 | @item down @var{n} |
6127 | Move @var{n} frames down the stack. For positive numbers @var{n}, this | |
6128 | advances toward the innermost frame, to lower frame numbers, to frames | |
6129 | that were created more recently. @var{n} defaults to one. You may | |
6130 | abbreviate @code{down} as @code{do}. | |
6131 | @end table | |
6132 | ||
6133 | All of these commands end by printing two lines of output describing the | |
6134 | frame. The first line shows the frame number, the function name, the | |
6135 | arguments, and the source file and line number of execution in that | |
5d161b24 | 6136 | frame. The second line shows the text of that source line. |
c906108c SS |
6137 | |
6138 | @need 1000 | |
6139 | For example: | |
6140 | ||
6141 | @smallexample | |
6142 | @group | |
6143 | (@value{GDBP}) up | |
6144 | #1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc) | |
6145 | at env.c:10 | |
6146 | 10 read_input_file (argv[i]); | |
6147 | @end group | |
6148 | @end smallexample | |
6149 | ||
6150 | After such a printout, the @code{list} command with no arguments | |
6151 | prints ten lines centered on the point of execution in the frame. | |
87885426 FN |
6152 | You can also edit the program at the point of execution with your favorite |
6153 | editing program by typing @code{edit}. | |
79a6e687 | 6154 | @xref{List, ,Printing Source Lines}, |
87885426 | 6155 | for details. |
c906108c SS |
6156 | |
6157 | @table @code | |
6158 | @kindex down-silently | |
6159 | @kindex up-silently | |
6160 | @item up-silently @var{n} | |
6161 | @itemx down-silently @var{n} | |
6162 | These two commands are variants of @code{up} and @code{down}, | |
6163 | respectively; they differ in that they do their work silently, without | |
6164 | causing display of the new frame. They are intended primarily for use | |
6165 | in @value{GDBN} command scripts, where the output might be unnecessary and | |
6166 | distracting. | |
6167 | @end table | |
6168 | ||
6d2ebf8b | 6169 | @node Frame Info |
79a6e687 | 6170 | @section Information About a Frame |
c906108c SS |
6171 | |
6172 | There are several other commands to print information about the selected | |
6173 | stack frame. | |
6174 | ||
6175 | @table @code | |
6176 | @item frame | |
6177 | @itemx f | |
6178 | When used without any argument, this command does not change which | |
6179 | frame is selected, but prints a brief description of the currently | |
6180 | selected stack frame. It can be abbreviated @code{f}. With an | |
6181 | argument, this command is used to select a stack frame. | |
79a6e687 | 6182 | @xref{Selection, ,Selecting a Frame}. |
c906108c SS |
6183 | |
6184 | @kindex info frame | |
41afff9a | 6185 | @kindex info f @r{(@code{info frame})} |
c906108c SS |
6186 | @item info frame |
6187 | @itemx info f | |
6188 | This command prints a verbose description of the selected stack frame, | |
6189 | including: | |
6190 | ||
6191 | @itemize @bullet | |
5d161b24 DB |
6192 | @item |
6193 | the address of the frame | |
c906108c SS |
6194 | @item |
6195 | the address of the next frame down (called by this frame) | |
6196 | @item | |
6197 | the address of the next frame up (caller of this frame) | |
6198 | @item | |
6199 | the language in which the source code corresponding to this frame is written | |
6200 | @item | |
6201 | the address of the frame's arguments | |
6202 | @item | |
d4f3574e SS |
6203 | the address of the frame's local variables |
6204 | @item | |
c906108c SS |
6205 | the program counter saved in it (the address of execution in the caller frame) |
6206 | @item | |
6207 | which registers were saved in the frame | |
6208 | @end itemize | |
6209 | ||
6210 | @noindent The verbose description is useful when | |
6211 | something has gone wrong that has made the stack format fail to fit | |
6212 | the usual conventions. | |
6213 | ||
6214 | @item info frame @var{addr} | |
6215 | @itemx info f @var{addr} | |
6216 | Print a verbose description of the frame at address @var{addr}, without | |
6217 | selecting that frame. The selected frame remains unchanged by this | |
6218 | command. This requires the same kind of address (more than one for some | |
6219 | architectures) that you specify in the @code{frame} command. | |
79a6e687 | 6220 | @xref{Selection, ,Selecting a Frame}. |
c906108c SS |
6221 | |
6222 | @kindex info args | |
6223 | @item info args | |
6224 | Print the arguments of the selected frame, each on a separate line. | |
6225 | ||
6226 | @item info locals | |
6227 | @kindex info locals | |
6228 | Print the local variables of the selected frame, each on a separate | |
6229 | line. These are all variables (declared either static or automatic) | |
6230 | accessible at the point of execution of the selected frame. | |
6231 | ||
c906108c | 6232 | @kindex info catch |
d4f3574e SS |
6233 | @cindex catch exceptions, list active handlers |
6234 | @cindex exception handlers, how to list | |
c906108c SS |
6235 | @item info catch |
6236 | Print a list of all the exception handlers that are active in the | |
6237 | current stack frame at the current point of execution. To see other | |
6238 | exception handlers, visit the associated frame (using the @code{up}, | |
6239 | @code{down}, or @code{frame} commands); then type @code{info catch}. | |
79a6e687 | 6240 | @xref{Set Catchpoints, , Setting Catchpoints}. |
53a5351d | 6241 | |
c906108c SS |
6242 | @end table |
6243 | ||
c906108c | 6244 | |
6d2ebf8b | 6245 | @node Source |
c906108c SS |
6246 | @chapter Examining Source Files |
6247 | ||
6248 | @value{GDBN} can print parts of your program's source, since the debugging | |
6249 | information recorded in the program tells @value{GDBN} what source files were | |
6250 | used to build it. When your program stops, @value{GDBN} spontaneously prints | |
6251 | the line where it stopped. Likewise, when you select a stack frame | |
79a6e687 | 6252 | (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where |
c906108c SS |
6253 | execution in that frame has stopped. You can print other portions of |
6254 | source files by explicit command. | |
6255 | ||
7a292a7a | 6256 | If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may |
d4f3574e | 6257 | prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using |
7a292a7a | 6258 | @value{GDBN} under @sc{gnu} Emacs}. |
c906108c SS |
6259 | |
6260 | @menu | |
6261 | * List:: Printing source lines | |
2a25a5ba | 6262 | * Specify Location:: How to specify code locations |
87885426 | 6263 | * Edit:: Editing source files |
c906108c | 6264 | * Search:: Searching source files |
c906108c SS |
6265 | * Source Path:: Specifying source directories |
6266 | * Machine Code:: Source and machine code | |
6267 | @end menu | |
6268 | ||
6d2ebf8b | 6269 | @node List |
79a6e687 | 6270 | @section Printing Source Lines |
c906108c SS |
6271 | |
6272 | @kindex list | |
41afff9a | 6273 | @kindex l @r{(@code{list})} |
c906108c | 6274 | To print lines from a source file, use the @code{list} command |
5d161b24 | 6275 | (abbreviated @code{l}). By default, ten lines are printed. |
2a25a5ba EZ |
6276 | There are several ways to specify what part of the file you want to |
6277 | print; see @ref{Specify Location}, for the full list. | |
c906108c SS |
6278 | |
6279 | Here are the forms of the @code{list} command most commonly used: | |
6280 | ||
6281 | @table @code | |
6282 | @item list @var{linenum} | |
6283 | Print lines centered around line number @var{linenum} in the | |
6284 | current source file. | |
6285 | ||
6286 | @item list @var{function} | |
6287 | Print lines centered around the beginning of function | |
6288 | @var{function}. | |
6289 | ||
6290 | @item list | |
6291 | Print more lines. If the last lines printed were printed with a | |
6292 | @code{list} command, this prints lines following the last lines | |
6293 | printed; however, if the last line printed was a solitary line printed | |
6294 | as part of displaying a stack frame (@pxref{Stack, ,Examining the | |
6295 | Stack}), this prints lines centered around that line. | |
6296 | ||
6297 | @item list - | |
6298 | Print lines just before the lines last printed. | |
6299 | @end table | |
6300 | ||
9c16f35a | 6301 | @cindex @code{list}, how many lines to display |
c906108c SS |
6302 | By default, @value{GDBN} prints ten source lines with any of these forms of |
6303 | the @code{list} command. You can change this using @code{set listsize}: | |
6304 | ||
6305 | @table @code | |
6306 | @kindex set listsize | |
6307 | @item set listsize @var{count} | |
6308 | Make the @code{list} command display @var{count} source lines (unless | |
6309 | the @code{list} argument explicitly specifies some other number). | |
6310 | ||
6311 | @kindex show listsize | |
6312 | @item show listsize | |
6313 | Display the number of lines that @code{list} prints. | |
6314 | @end table | |
6315 | ||
6316 | Repeating a @code{list} command with @key{RET} discards the argument, | |
6317 | so it is equivalent to typing just @code{list}. This is more useful | |
6318 | than listing the same lines again. An exception is made for an | |
6319 | argument of @samp{-}; that argument is preserved in repetition so that | |
6320 | each repetition moves up in the source file. | |
6321 | ||
c906108c SS |
6322 | In general, the @code{list} command expects you to supply zero, one or two |
6323 | @dfn{linespecs}. Linespecs specify source lines; there are several ways | |
2a25a5ba EZ |
6324 | of writing them (@pxref{Specify Location}), but the effect is always |
6325 | to specify some source line. | |
6326 | ||
c906108c SS |
6327 | Here is a complete description of the possible arguments for @code{list}: |
6328 | ||
6329 | @table @code | |
6330 | @item list @var{linespec} | |
6331 | Print lines centered around the line specified by @var{linespec}. | |
6332 | ||
6333 | @item list @var{first},@var{last} | |
6334 | Print lines from @var{first} to @var{last}. Both arguments are | |
2a25a5ba EZ |
6335 | linespecs. When a @code{list} command has two linespecs, and the |
6336 | source file of the second linespec is omitted, this refers to | |
6337 | the same source file as the first linespec. | |
c906108c SS |
6338 | |
6339 | @item list ,@var{last} | |
6340 | Print lines ending with @var{last}. | |
6341 | ||
6342 | @item list @var{first}, | |
6343 | Print lines starting with @var{first}. | |
6344 | ||
6345 | @item list + | |
6346 | Print lines just after the lines last printed. | |
6347 | ||
6348 | @item list - | |
6349 | Print lines just before the lines last printed. | |
6350 | ||
6351 | @item list | |
6352 | As described in the preceding table. | |
6353 | @end table | |
6354 | ||
2a25a5ba EZ |
6355 | @node Specify Location |
6356 | @section Specifying a Location | |
6357 | @cindex specifying location | |
6358 | @cindex linespec | |
c906108c | 6359 | |
2a25a5ba EZ |
6360 | Several @value{GDBN} commands accept arguments that specify a location |
6361 | of your program's code. Since @value{GDBN} is a source-level | |
6362 | debugger, a location usually specifies some line in the source code; | |
6363 | for that reason, locations are also known as @dfn{linespecs}. | |
c906108c | 6364 | |
2a25a5ba EZ |
6365 | Here are all the different ways of specifying a code location that |
6366 | @value{GDBN} understands: | |
c906108c | 6367 | |
2a25a5ba EZ |
6368 | @table @code |
6369 | @item @var{linenum} | |
6370 | Specifies the line number @var{linenum} of the current source file. | |
c906108c | 6371 | |
2a25a5ba EZ |
6372 | @item -@var{offset} |
6373 | @itemx +@var{offset} | |
6374 | Specifies the line @var{offset} lines before or after the @dfn{current | |
6375 | line}. For the @code{list} command, the current line is the last one | |
6376 | printed; for the breakpoint commands, this is the line at which | |
6377 | execution stopped in the currently selected @dfn{stack frame} | |
6378 | (@pxref{Frames, ,Frames}, for a description of stack frames.) When | |
6379 | used as the second of the two linespecs in a @code{list} command, | |
6380 | this specifies the line @var{offset} lines up or down from the first | |
6381 | linespec. | |
6382 | ||
6383 | @item @var{filename}:@var{linenum} | |
6384 | Specifies the line @var{linenum} in the source file @var{filename}. | |
c906108c SS |
6385 | |
6386 | @item @var{function} | |
6387 | Specifies the line that begins the body of the function @var{function}. | |
2a25a5ba | 6388 | For example, in C, this is the line with the open brace. |
c906108c | 6389 | |
9ef07c8c TT |
6390 | @item @var{function}:@var{label} |
6391 | Specifies the line where @var{label} appears in @var{function}. | |
6392 | ||
c906108c | 6393 | @item @var{filename}:@var{function} |
2a25a5ba EZ |
6394 | Specifies the line that begins the body of the function @var{function} |
6395 | in the file @var{filename}. You only need the file name with a | |
6396 | function name to avoid ambiguity when there are identically named | |
6397 | functions in different source files. | |
c906108c | 6398 | |
0f5238ed TT |
6399 | @item @var{label} |
6400 | Specifies the line at which the label named @var{label} appears. | |
6401 | @value{GDBN} searches for the label in the function corresponding to | |
6402 | the currently selected stack frame. If there is no current selected | |
6403 | stack frame (for instance, if the inferior is not running), then | |
6404 | @value{GDBN} will not search for a label. | |
6405 | ||
c906108c | 6406 | @item *@var{address} |
2a25a5ba EZ |
6407 | Specifies the program address @var{address}. For line-oriented |
6408 | commands, such as @code{list} and @code{edit}, this specifies a source | |
6409 | line that contains @var{address}. For @code{break} and other | |
6410 | breakpoint oriented commands, this can be used to set breakpoints in | |
6411 | parts of your program which do not have debugging information or | |
6412 | source files. | |
6413 | ||
6414 | Here @var{address} may be any expression valid in the current working | |
6415 | language (@pxref{Languages, working language}) that specifies a code | |
5fa54e5d EZ |
6416 | address. In addition, as a convenience, @value{GDBN} extends the |
6417 | semantics of expressions used in locations to cover the situations | |
6418 | that frequently happen during debugging. Here are the various forms | |
6419 | of @var{address}: | |
2a25a5ba EZ |
6420 | |
6421 | @table @code | |
6422 | @item @var{expression} | |
6423 | Any expression valid in the current working language. | |
6424 | ||
6425 | @item @var{funcaddr} | |
6426 | An address of a function or procedure derived from its name. In C, | |
6427 | C@t{++}, Java, Objective-C, Fortran, minimal, and assembly, this is | |
6428 | simply the function's name @var{function} (and actually a special case | |
6429 | of a valid expression). In Pascal and Modula-2, this is | |
6430 | @code{&@var{function}}. In Ada, this is @code{@var{function}'Address} | |
6431 | (although the Pascal form also works). | |
6432 | ||
6433 | This form specifies the address of the function's first instruction, | |
6434 | before the stack frame and arguments have been set up. | |
6435 | ||
6436 | @item '@var{filename}'::@var{funcaddr} | |
6437 | Like @var{funcaddr} above, but also specifies the name of the source | |
6438 | file explicitly. This is useful if the name of the function does not | |
6439 | specify the function unambiguously, e.g., if there are several | |
6440 | functions with identical names in different source files. | |
c906108c SS |
6441 | @end table |
6442 | ||
2a25a5ba EZ |
6443 | @end table |
6444 | ||
6445 | ||
87885426 | 6446 | @node Edit |
79a6e687 | 6447 | @section Editing Source Files |
87885426 FN |
6448 | @cindex editing source files |
6449 | ||
6450 | @kindex edit | |
6451 | @kindex e @r{(@code{edit})} | |
6452 | To edit the lines in a source file, use the @code{edit} command. | |
6453 | The editing program of your choice | |
6454 | is invoked with the current line set to | |
6455 | the active line in the program. | |
6456 | Alternatively, there are several ways to specify what part of the file you | |
2a25a5ba | 6457 | want to print if you want to see other parts of the program: |
87885426 FN |
6458 | |
6459 | @table @code | |
2a25a5ba EZ |
6460 | @item edit @var{location} |
6461 | Edit the source file specified by @code{location}. Editing starts at | |
6462 | that @var{location}, e.g., at the specified source line of the | |
6463 | specified file. @xref{Specify Location}, for all the possible forms | |
6464 | of the @var{location} argument; here are the forms of the @code{edit} | |
6465 | command most commonly used: | |
87885426 | 6466 | |
2a25a5ba | 6467 | @table @code |
87885426 FN |
6468 | @item edit @var{number} |
6469 | Edit the current source file with @var{number} as the active line number. | |
6470 | ||
6471 | @item edit @var{function} | |
6472 | Edit the file containing @var{function} at the beginning of its definition. | |
2a25a5ba | 6473 | @end table |
87885426 | 6474 | |
87885426 FN |
6475 | @end table |
6476 | ||
79a6e687 | 6477 | @subsection Choosing your Editor |
87885426 FN |
6478 | You can customize @value{GDBN} to use any editor you want |
6479 | @footnote{ | |
6480 | The only restriction is that your editor (say @code{ex}), recognizes the | |
6481 | following command-line syntax: | |
10998722 | 6482 | @smallexample |
87885426 | 6483 | ex +@var{number} file |
10998722 | 6484 | @end smallexample |
15387254 EZ |
6485 | The optional numeric value +@var{number} specifies the number of the line in |
6486 | the file where to start editing.}. | |
6487 | By default, it is @file{@value{EDITOR}}, but you can change this | |
10998722 AC |
6488 | by setting the environment variable @code{EDITOR} before using |
6489 | @value{GDBN}. For example, to configure @value{GDBN} to use the | |
6490 | @code{vi} editor, you could use these commands with the @code{sh} shell: | |
6491 | @smallexample | |
87885426 FN |
6492 | EDITOR=/usr/bin/vi |
6493 | export EDITOR | |
15387254 | 6494 | gdb @dots{} |
10998722 | 6495 | @end smallexample |
87885426 | 6496 | or in the @code{csh} shell, |
10998722 | 6497 | @smallexample |
87885426 | 6498 | setenv EDITOR /usr/bin/vi |
15387254 | 6499 | gdb @dots{} |
10998722 | 6500 | @end smallexample |
87885426 | 6501 | |
6d2ebf8b | 6502 | @node Search |
79a6e687 | 6503 | @section Searching Source Files |
15387254 | 6504 | @cindex searching source files |
c906108c SS |
6505 | |
6506 | There are two commands for searching through the current source file for a | |
6507 | regular expression. | |
6508 | ||
6509 | @table @code | |
6510 | @kindex search | |
6511 | @kindex forward-search | |
6512 | @item forward-search @var{regexp} | |
6513 | @itemx search @var{regexp} | |
6514 | The command @samp{forward-search @var{regexp}} checks each line, | |
6515 | starting with the one following the last line listed, for a match for | |
5d161b24 | 6516 | @var{regexp}. It lists the line that is found. You can use the |
c906108c SS |
6517 | synonym @samp{search @var{regexp}} or abbreviate the command name as |
6518 | @code{fo}. | |
6519 | ||
09d4efe1 | 6520 | @kindex reverse-search |
c906108c SS |
6521 | @item reverse-search @var{regexp} |
6522 | The command @samp{reverse-search @var{regexp}} checks each line, starting | |
6523 | with the one before the last line listed and going backward, for a match | |
6524 | for @var{regexp}. It lists the line that is found. You can abbreviate | |
6525 | this command as @code{rev}. | |
6526 | @end table | |
c906108c | 6527 | |
6d2ebf8b | 6528 | @node Source Path |
79a6e687 | 6529 | @section Specifying Source Directories |
c906108c SS |
6530 | |
6531 | @cindex source path | |
6532 | @cindex directories for source files | |
6533 | Executable programs sometimes do not record the directories of the source | |
6534 | files from which they were compiled, just the names. Even when they do, | |
6535 | the directories could be moved between the compilation and your debugging | |
6536 | session. @value{GDBN} has a list of directories to search for source files; | |
6537 | this is called the @dfn{source path}. Each time @value{GDBN} wants a source file, | |
6538 | it tries all the directories in the list, in the order they are present | |
0b66e38c EZ |
6539 | in the list, until it finds a file with the desired name. |
6540 | ||
6541 | For example, suppose an executable references the file | |
6542 | @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is | |
6543 | @file{/mnt/cross}. The file is first looked up literally; if this | |
6544 | fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this | |
6545 | fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error | |
6546 | message is printed. @value{GDBN} does not look up the parts of the | |
6547 | source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}. | |
6548 | Likewise, the subdirectories of the source path are not searched: if | |
6549 | the source path is @file{/mnt/cross}, and the binary refers to | |
6550 | @file{foo.c}, @value{GDBN} would not find it under | |
6551 | @file{/mnt/cross/usr/src/foo-1.0/lib}. | |
6552 | ||
6553 | Plain file names, relative file names with leading directories, file | |
6554 | names containing dots, etc.@: are all treated as described above; for | |
6555 | instance, if the source path is @file{/mnt/cross}, and the source file | |
6556 | is recorded as @file{../lib/foo.c}, @value{GDBN} would first try | |
6557 | @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after | |
6558 | that---@file{/mnt/cross/foo.c}. | |
6559 | ||
6560 | Note that the executable search path is @emph{not} used to locate the | |
cd852561 | 6561 | source files. |
c906108c SS |
6562 | |
6563 | Whenever you reset or rearrange the source path, @value{GDBN} clears out | |
6564 | any information it has cached about where source files are found and where | |
6565 | each line is in the file. | |
6566 | ||
6567 | @kindex directory | |
6568 | @kindex dir | |
d4f3574e SS |
6569 | When you start @value{GDBN}, its source path includes only @samp{cdir} |
6570 | and @samp{cwd}, in that order. | |
c906108c SS |
6571 | To add other directories, use the @code{directory} command. |
6572 | ||
4b505b12 AS |
6573 | The search path is used to find both program source files and @value{GDBN} |
6574 | script files (read using the @samp{-command} option and @samp{source} command). | |
6575 | ||
30daae6c JB |
6576 | In addition to the source path, @value{GDBN} provides a set of commands |
6577 | that manage a list of source path substitution rules. A @dfn{substitution | |
6578 | rule} specifies how to rewrite source directories stored in the program's | |
6579 | debug information in case the sources were moved to a different | |
6580 | directory between compilation and debugging. A rule is made of | |
6581 | two strings, the first specifying what needs to be rewritten in | |
6582 | the path, and the second specifying how it should be rewritten. | |
6583 | In @ref{set substitute-path}, we name these two parts @var{from} and | |
6584 | @var{to} respectively. @value{GDBN} does a simple string replacement | |
6585 | of @var{from} with @var{to} at the start of the directory part of the | |
6586 | source file name, and uses that result instead of the original file | |
6587 | name to look up the sources. | |
6588 | ||
6589 | Using the previous example, suppose the @file{foo-1.0} tree has been | |
6590 | moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell | |
3f94c067 | 6591 | @value{GDBN} to replace @file{/usr/src} in all source path names with |
30daae6c JB |
6592 | @file{/mnt/cross}. The first lookup will then be |
6593 | @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location | |
6594 | of @file{/usr/src/foo-1.0/lib/foo.c}. To define a source path | |
6595 | substitution rule, use the @code{set substitute-path} command | |
6596 | (@pxref{set substitute-path}). | |
6597 | ||
6598 | To avoid unexpected substitution results, a rule is applied only if the | |
6599 | @var{from} part of the directory name ends at a directory separator. | |
6600 | For instance, a rule substituting @file{/usr/source} into | |
6601 | @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but | |
6602 | not to @file{/usr/sourceware/foo-2.0}. And because the substitution | |
d3e8051b | 6603 | is applied only at the beginning of the directory name, this rule will |
30daae6c JB |
6604 | not be applied to @file{/root/usr/source/baz.c} either. |
6605 | ||
6606 | In many cases, you can achieve the same result using the @code{directory} | |
6607 | command. However, @code{set substitute-path} can be more efficient in | |
6608 | the case where the sources are organized in a complex tree with multiple | |
6609 | subdirectories. With the @code{directory} command, you need to add each | |
6610 | subdirectory of your project. If you moved the entire tree while | |
6611 | preserving its internal organization, then @code{set substitute-path} | |
6612 | allows you to direct the debugger to all the sources with one single | |
6613 | command. | |
6614 | ||
6615 | @code{set substitute-path} is also more than just a shortcut command. | |
6616 | The source path is only used if the file at the original location no | |
6617 | longer exists. On the other hand, @code{set substitute-path} modifies | |
6618 | the debugger behavior to look at the rewritten location instead. So, if | |
6619 | for any reason a source file that is not relevant to your executable is | |
6620 | located at the original location, a substitution rule is the only | |
3f94c067 | 6621 | method available to point @value{GDBN} at the new location. |
30daae6c | 6622 | |
29b0e8a2 JM |
6623 | @cindex @samp{--with-relocated-sources} |
6624 | @cindex default source path substitution | |
6625 | You can configure a default source path substitution rule by | |
6626 | configuring @value{GDBN} with the | |
6627 | @samp{--with-relocated-sources=@var{dir}} option. The @var{dir} | |
6628 | should be the name of a directory under @value{GDBN}'s configured | |
6629 | prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and | |
6630 | directory names in debug information under @var{dir} will be adjusted | |
6631 | automatically if the installed @value{GDBN} is moved to a new | |
6632 | location. This is useful if @value{GDBN}, libraries or executables | |
6633 | with debug information and corresponding source code are being moved | |
6634 | together. | |
6635 | ||
c906108c SS |
6636 | @table @code |
6637 | @item directory @var{dirname} @dots{} | |
6638 | @item dir @var{dirname} @dots{} | |
6639 | Add directory @var{dirname} to the front of the source path. Several | |
d4f3574e SS |
6640 | directory names may be given to this command, separated by @samp{:} |
6641 | (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as | |
6642 | part of absolute file names) or | |
c906108c SS |
6643 | whitespace. You may specify a directory that is already in the source |
6644 | path; this moves it forward, so @value{GDBN} searches it sooner. | |
6645 | ||
6646 | @kindex cdir | |
6647 | @kindex cwd | |
41afff9a | 6648 | @vindex $cdir@r{, convenience variable} |
d3e8051b | 6649 | @vindex $cwd@r{, convenience variable} |
c906108c SS |
6650 | @cindex compilation directory |
6651 | @cindex current directory | |
6652 | @cindex working directory | |
6653 | @cindex directory, current | |
6654 | @cindex directory, compilation | |
6655 | You can use the string @samp{$cdir} to refer to the compilation | |
6656 | directory (if one is recorded), and @samp{$cwd} to refer to the current | |
6657 | working directory. @samp{$cwd} is not the same as @samp{.}---the former | |
6658 | tracks the current working directory as it changes during your @value{GDBN} | |
6659 | session, while the latter is immediately expanded to the current | |
6660 | directory at the time you add an entry to the source path. | |
6661 | ||
6662 | @item directory | |
cd852561 | 6663 | Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems). This requires confirmation. |
c906108c SS |
6664 | |
6665 | @c RET-repeat for @code{directory} is explicitly disabled, but since | |
6666 | @c repeating it would be a no-op we do not say that. (thanks to RMS) | |
6667 | ||
99e7ae30 DE |
6668 | @item set directories @var{path-list} |
6669 | @kindex set directories | |
6670 | Set the source path to @var{path-list}. | |
6671 | @samp{$cdir:$cwd} are added if missing. | |
6672 | ||
c906108c SS |
6673 | @item show directories |
6674 | @kindex show directories | |
6675 | Print the source path: show which directories it contains. | |
30daae6c JB |
6676 | |
6677 | @anchor{set substitute-path} | |
6678 | @item set substitute-path @var{from} @var{to} | |
6679 | @kindex set substitute-path | |
6680 | Define a source path substitution rule, and add it at the end of the | |
6681 | current list of existing substitution rules. If a rule with the same | |
6682 | @var{from} was already defined, then the old rule is also deleted. | |
6683 | ||
6684 | For example, if the file @file{/foo/bar/baz.c} was moved to | |
6685 | @file{/mnt/cross/baz.c}, then the command | |
6686 | ||
6687 | @smallexample | |
6688 | (@value{GDBP}) set substitute-path /usr/src /mnt/cross | |
6689 | @end smallexample | |
6690 | ||
6691 | @noindent | |
6692 | will tell @value{GDBN} to replace @samp{/usr/src} with | |
6693 | @samp{/mnt/cross}, which will allow @value{GDBN} to find the file | |
6694 | @file{baz.c} even though it was moved. | |
6695 | ||
6696 | In the case when more than one substitution rule have been defined, | |
6697 | the rules are evaluated one by one in the order where they have been | |
6698 | defined. The first one matching, if any, is selected to perform | |
6699 | the substitution. | |
6700 | ||
6701 | For instance, if we had entered the following commands: | |
6702 | ||
6703 | @smallexample | |
6704 | (@value{GDBP}) set substitute-path /usr/src/include /mnt/include | |
6705 | (@value{GDBP}) set substitute-path /usr/src /mnt/src | |
6706 | @end smallexample | |
6707 | ||
6708 | @noindent | |
6709 | @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into | |
6710 | @file{/mnt/include/defs.h} by using the first rule. However, it would | |
6711 | use the second rule to rewrite @file{/usr/src/lib/foo.c} into | |
6712 | @file{/mnt/src/lib/foo.c}. | |
6713 | ||
6714 | ||
6715 | @item unset substitute-path [path] | |
6716 | @kindex unset substitute-path | |
6717 | If a path is specified, search the current list of substitution rules | |
6718 | for a rule that would rewrite that path. Delete that rule if found. | |
6719 | A warning is emitted by the debugger if no rule could be found. | |
6720 | ||
6721 | If no path is specified, then all substitution rules are deleted. | |
6722 | ||
6723 | @item show substitute-path [path] | |
6724 | @kindex show substitute-path | |
6725 | If a path is specified, then print the source path substitution rule | |
6726 | which would rewrite that path, if any. | |
6727 | ||
6728 | If no path is specified, then print all existing source path substitution | |
6729 | rules. | |
6730 | ||
c906108c SS |
6731 | @end table |
6732 | ||
6733 | If your source path is cluttered with directories that are no longer of | |
6734 | interest, @value{GDBN} may sometimes cause confusion by finding the wrong | |
6735 | versions of source. You can correct the situation as follows: | |
6736 | ||
6737 | @enumerate | |
6738 | @item | |
cd852561 | 6739 | Use @code{directory} with no argument to reset the source path to its default value. |
c906108c SS |
6740 | |
6741 | @item | |
6742 | Use @code{directory} with suitable arguments to reinstall the | |
6743 | directories you want in the source path. You can add all the | |
6744 | directories in one command. | |
6745 | @end enumerate | |
6746 | ||
6d2ebf8b | 6747 | @node Machine Code |
79a6e687 | 6748 | @section Source and Machine Code |
15387254 | 6749 | @cindex source line and its code address |
c906108c SS |
6750 | |
6751 | You can use the command @code{info line} to map source lines to program | |
6752 | addresses (and vice versa), and the command @code{disassemble} to display | |
91440f57 HZ |
6753 | a range of addresses as machine instructions. You can use the command |
6754 | @code{set disassemble-next-line} to set whether to disassemble next | |
6755 | source line when execution stops. When run under @sc{gnu} Emacs | |
d4f3574e | 6756 | mode, the @code{info line} command causes the arrow to point to the |
5d161b24 | 6757 | line specified. Also, @code{info line} prints addresses in symbolic form as |
c906108c SS |
6758 | well as hex. |
6759 | ||
6760 | @table @code | |
6761 | @kindex info line | |
6762 | @item info line @var{linespec} | |
6763 | Print the starting and ending addresses of the compiled code for | |
6764 | source line @var{linespec}. You can specify source lines in any of | |
2a25a5ba | 6765 | the ways documented in @ref{Specify Location}. |
c906108c SS |
6766 | @end table |
6767 | ||
6768 | For example, we can use @code{info line} to discover the location of | |
6769 | the object code for the first line of function | |
6770 | @code{m4_changequote}: | |
6771 | ||
d4f3574e SS |
6772 | @c FIXME: I think this example should also show the addresses in |
6773 | @c symbolic form, as they usually would be displayed. | |
c906108c | 6774 | @smallexample |
96a2c332 | 6775 | (@value{GDBP}) info line m4_changequote |
c906108c SS |
6776 | Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350. |
6777 | @end smallexample | |
6778 | ||
6779 | @noindent | |
15387254 | 6780 | @cindex code address and its source line |
c906108c SS |
6781 | We can also inquire (using @code{*@var{addr}} as the form for |
6782 | @var{linespec}) what source line covers a particular address: | |
6783 | @smallexample | |
6784 | (@value{GDBP}) info line *0x63ff | |
6785 | Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404. | |
6786 | @end smallexample | |
6787 | ||
6788 | @cindex @code{$_} and @code{info line} | |
15387254 | 6789 | @cindex @code{x} command, default address |
41afff9a | 6790 | @kindex x@r{(examine), and} info line |
c906108c SS |
6791 | After @code{info line}, the default address for the @code{x} command |
6792 | is changed to the starting address of the line, so that @samp{x/i} is | |
6793 | sufficient to begin examining the machine code (@pxref{Memory, | |
79a6e687 | 6794 | ,Examining Memory}). Also, this address is saved as the value of the |
c906108c | 6795 | convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience |
79a6e687 | 6796 | Variables}). |
c906108c SS |
6797 | |
6798 | @table @code | |
6799 | @kindex disassemble | |
6800 | @cindex assembly instructions | |
6801 | @cindex instructions, assembly | |
6802 | @cindex machine instructions | |
6803 | @cindex listing machine instructions | |
6804 | @item disassemble | |
d14508fe | 6805 | @itemx disassemble /m |
9b117ef3 | 6806 | @itemx disassemble /r |
c906108c | 6807 | This specialized command dumps a range of memory as machine |
d14508fe | 6808 | instructions. It can also print mixed source+disassembly by specifying |
9b117ef3 HZ |
6809 | the @code{/m} modifier and print the raw instructions in hex as well as |
6810 | in symbolic form by specifying the @code{/r}. | |
d14508fe | 6811 | The default memory range is the function surrounding the |
c906108c SS |
6812 | program counter of the selected frame. A single argument to this |
6813 | command is a program counter value; @value{GDBN} dumps the function | |
21a0512e PP |
6814 | surrounding this value. When two arguments are given, they should |
6815 | be separated by a comma, possibly surrounded by whitespace. The | |
53a71c06 CR |
6816 | arguments specify a range of addresses to dump, in one of two forms: |
6817 | ||
6818 | @table @code | |
6819 | @item @var{start},@var{end} | |
6820 | the addresses from @var{start} (inclusive) to @var{end} (exclusive) | |
6821 | @item @var{start},+@var{length} | |
6822 | the addresses from @var{start} (inclusive) to | |
6823 | @code{@var{start}+@var{length}} (exclusive). | |
6824 | @end table | |
6825 | ||
6826 | @noindent | |
6827 | When 2 arguments are specified, the name of the function is also | |
6828 | printed (since there could be several functions in the given range). | |
21a0512e PP |
6829 | |
6830 | The argument(s) can be any expression yielding a numeric value, such as | |
6831 | @samp{0x32c4}, @samp{&main+10} or @samp{$pc - 8}. | |
2b28d209 PP |
6832 | |
6833 | If the range of memory being disassembled contains current program counter, | |
6834 | the instruction at that location is shown with a @code{=>} marker. | |
c906108c SS |
6835 | @end table |
6836 | ||
c906108c SS |
6837 | The following example shows the disassembly of a range of addresses of |
6838 | HP PA-RISC 2.0 code: | |
6839 | ||
6840 | @smallexample | |
21a0512e | 6841 | (@value{GDBP}) disas 0x32c4, 0x32e4 |
c906108c | 6842 | Dump of assembler code from 0x32c4 to 0x32e4: |
2b28d209 PP |
6843 | 0x32c4 <main+204>: addil 0,dp |
6844 | 0x32c8 <main+208>: ldw 0x22c(sr0,r1),r26 | |
6845 | 0x32cc <main+212>: ldil 0x3000,r31 | |
6846 | 0x32d0 <main+216>: ble 0x3f8(sr4,r31) | |
6847 | 0x32d4 <main+220>: ldo 0(r31),rp | |
6848 | 0x32d8 <main+224>: addil -0x800,dp | |
6849 | 0x32dc <main+228>: ldo 0x588(r1),r26 | |
6850 | 0x32e0 <main+232>: ldil 0x3000,r31 | |
c906108c SS |
6851 | End of assembler dump. |
6852 | @end smallexample | |
c906108c | 6853 | |
2b28d209 PP |
6854 | Here is an example showing mixed source+assembly for Intel x86, when the |
6855 | program is stopped just after function prologue: | |
d14508fe DE |
6856 | |
6857 | @smallexample | |
6858 | (@value{GDBP}) disas /m main | |
6859 | Dump of assembler code for function main: | |
6860 | 5 @{ | |
9c419145 PP |
6861 | 0x08048330 <+0>: push %ebp |
6862 | 0x08048331 <+1>: mov %esp,%ebp | |
6863 | 0x08048333 <+3>: sub $0x8,%esp | |
6864 | 0x08048336 <+6>: and $0xfffffff0,%esp | |
6865 | 0x08048339 <+9>: sub $0x10,%esp | |
d14508fe DE |
6866 | |
6867 | 6 printf ("Hello.\n"); | |
9c419145 PP |
6868 | => 0x0804833c <+12>: movl $0x8048440,(%esp) |
6869 | 0x08048343 <+19>: call 0x8048284 <puts@@plt> | |
d14508fe DE |
6870 | |
6871 | 7 return 0; | |
6872 | 8 @} | |
9c419145 PP |
6873 | 0x08048348 <+24>: mov $0x0,%eax |
6874 | 0x0804834d <+29>: leave | |
6875 | 0x0804834e <+30>: ret | |
d14508fe DE |
6876 | |
6877 | End of assembler dump. | |
6878 | @end smallexample | |
6879 | ||
53a71c06 CR |
6880 | Here is another example showing raw instructions in hex for AMD x86-64, |
6881 | ||
6882 | @smallexample | |
6883 | (gdb) disas /r 0x400281,+10 | |
6884 | Dump of assembler code from 0x400281 to 0x40028b: | |
6885 | 0x0000000000400281: 38 36 cmp %dh,(%rsi) | |
6886 | 0x0000000000400283: 2d 36 34 2e 73 sub $0x732e3436,%eax | |
6887 | 0x0000000000400288: 6f outsl %ds:(%rsi),(%dx) | |
6888 | 0x0000000000400289: 2e 32 00 xor %cs:(%rax),%al | |
6889 | End of assembler dump. | |
6890 | @end smallexample | |
6891 | ||
c906108c SS |
6892 | Some architectures have more than one commonly-used set of instruction |
6893 | mnemonics or other syntax. | |
6894 | ||
76d17f34 EZ |
6895 | For programs that were dynamically linked and use shared libraries, |
6896 | instructions that call functions or branch to locations in the shared | |
6897 | libraries might show a seemingly bogus location---it's actually a | |
6898 | location of the relocation table. On some architectures, @value{GDBN} | |
6899 | might be able to resolve these to actual function names. | |
6900 | ||
c906108c | 6901 | @table @code |
d4f3574e | 6902 | @kindex set disassembly-flavor |
d4f3574e SS |
6903 | @cindex Intel disassembly flavor |
6904 | @cindex AT&T disassembly flavor | |
6905 | @item set disassembly-flavor @var{instruction-set} | |
c906108c SS |
6906 | Select the instruction set to use when disassembling the |
6907 | program via the @code{disassemble} or @code{x/i} commands. | |
6908 | ||
6909 | Currently this command is only defined for the Intel x86 family. You | |
d4f3574e SS |
6910 | can set @var{instruction-set} to either @code{intel} or @code{att}. |
6911 | The default is @code{att}, the AT&T flavor used by default by Unix | |
6912 | assemblers for x86-based targets. | |
9c16f35a EZ |
6913 | |
6914 | @kindex show disassembly-flavor | |
6915 | @item show disassembly-flavor | |
6916 | Show the current setting of the disassembly flavor. | |
c906108c SS |
6917 | @end table |
6918 | ||
91440f57 HZ |
6919 | @table @code |
6920 | @kindex set disassemble-next-line | |
6921 | @kindex show disassemble-next-line | |
6922 | @item set disassemble-next-line | |
6923 | @itemx show disassemble-next-line | |
32ae1842 EZ |
6924 | Control whether or not @value{GDBN} will disassemble the next source |
6925 | line or instruction when execution stops. If ON, @value{GDBN} will | |
6926 | display disassembly of the next source line when execution of the | |
6927 | program being debugged stops. This is @emph{in addition} to | |
6928 | displaying the source line itself, which @value{GDBN} always does if | |
6929 | possible. If the next source line cannot be displayed for some reason | |
6930 | (e.g., if @value{GDBN} cannot find the source file, or there's no line | |
6931 | info in the debug info), @value{GDBN} will display disassembly of the | |
6932 | next @emph{instruction} instead of showing the next source line. If | |
6933 | AUTO, @value{GDBN} will display disassembly of next instruction only | |
6934 | if the source line cannot be displayed. This setting causes | |
6935 | @value{GDBN} to display some feedback when you step through a function | |
6936 | with no line info or whose source file is unavailable. The default is | |
6937 | OFF, which means never display the disassembly of the next line or | |
6938 | instruction. | |
91440f57 HZ |
6939 | @end table |
6940 | ||
c906108c | 6941 | |
6d2ebf8b | 6942 | @node Data |
c906108c SS |
6943 | @chapter Examining Data |
6944 | ||
6945 | @cindex printing data | |
6946 | @cindex examining data | |
6947 | @kindex print | |
6948 | @kindex inspect | |
6949 | @c "inspect" is not quite a synonym if you are using Epoch, which we do not | |
6950 | @c document because it is nonstandard... Under Epoch it displays in a | |
6951 | @c different window or something like that. | |
6952 | The usual way to examine data in your program is with the @code{print} | |
7a292a7a SS |
6953 | command (abbreviated @code{p}), or its synonym @code{inspect}. It |
6954 | evaluates and prints the value of an expression of the language your | |
6955 | program is written in (@pxref{Languages, ,Using @value{GDBN} with | |
78e2826b TT |
6956 | Different Languages}). It may also print the expression using a |
6957 | Python-based pretty-printer (@pxref{Pretty Printing}). | |
c906108c SS |
6958 | |
6959 | @table @code | |
d4f3574e SS |
6960 | @item print @var{expr} |
6961 | @itemx print /@var{f} @var{expr} | |
6962 | @var{expr} is an expression (in the source language). By default the | |
6963 | value of @var{expr} is printed in a format appropriate to its data type; | |
c906108c | 6964 | you can choose a different format by specifying @samp{/@var{f}}, where |
d4f3574e | 6965 | @var{f} is a letter specifying the format; see @ref{Output Formats,,Output |
79a6e687 | 6966 | Formats}. |
c906108c SS |
6967 | |
6968 | @item print | |
6969 | @itemx print /@var{f} | |
15387254 | 6970 | @cindex reprint the last value |
d4f3574e | 6971 | If you omit @var{expr}, @value{GDBN} displays the last value again (from the |
79a6e687 | 6972 | @dfn{value history}; @pxref{Value History, ,Value History}). This allows you to |
c906108c SS |
6973 | conveniently inspect the same value in an alternative format. |
6974 | @end table | |
6975 | ||
6976 | A more low-level way of examining data is with the @code{x} command. | |
6977 | It examines data in memory at a specified address and prints it in a | |
79a6e687 | 6978 | specified format. @xref{Memory, ,Examining Memory}. |
c906108c | 6979 | |
7a292a7a | 6980 | If you are interested in information about types, or about how the |
d4f3574e SS |
6981 | fields of a struct or a class are declared, use the @code{ptype @var{exp}} |
6982 | command rather than @code{print}. @xref{Symbols, ,Examining the Symbol | |
7a292a7a | 6983 | Table}. |
c906108c SS |
6984 | |
6985 | @menu | |
6986 | * Expressions:: Expressions | |
6ba66d6a | 6987 | * Ambiguous Expressions:: Ambiguous Expressions |
c906108c SS |
6988 | * Variables:: Program variables |
6989 | * Arrays:: Artificial arrays | |
6990 | * Output Formats:: Output formats | |
6991 | * Memory:: Examining memory | |
6992 | * Auto Display:: Automatic display | |
6993 | * Print Settings:: Print settings | |
4c374409 | 6994 | * Pretty Printing:: Python pretty printing |
c906108c SS |
6995 | * Value History:: Value history |
6996 | * Convenience Vars:: Convenience variables | |
6997 | * Registers:: Registers | |
c906108c | 6998 | * Floating Point Hardware:: Floating point hardware |
53c69bd7 | 6999 | * Vector Unit:: Vector Unit |
721c2651 | 7000 | * OS Information:: Auxiliary data provided by operating system |
29e57380 | 7001 | * Memory Region Attributes:: Memory region attributes |
16d9dec6 | 7002 | * Dump/Restore Files:: Copy between memory and a file |
384ee23f | 7003 | * Core File Generation:: Cause a program dump its core |
a0eb71c5 KB |
7004 | * Character Sets:: Debugging programs that use a different |
7005 | character set than GDB does | |
09d4efe1 | 7006 | * Caching Remote Data:: Data caching for remote targets |
08388c79 | 7007 | * Searching Memory:: Searching memory for a sequence of bytes |
c906108c SS |
7008 | @end menu |
7009 | ||
6d2ebf8b | 7010 | @node Expressions |
c906108c SS |
7011 | @section Expressions |
7012 | ||
7013 | @cindex expressions | |
7014 | @code{print} and many other @value{GDBN} commands accept an expression and | |
7015 | compute its value. Any kind of constant, variable or operator defined | |
7016 | by the programming language you are using is valid in an expression in | |
e2e0bcd1 JB |
7017 | @value{GDBN}. This includes conditional expressions, function calls, |
7018 | casts, and string constants. It also includes preprocessor macros, if | |
7019 | you compiled your program to include this information; see | |
7020 | @ref{Compilation}. | |
c906108c | 7021 | |
15387254 | 7022 | @cindex arrays in expressions |
d4f3574e SS |
7023 | @value{GDBN} supports array constants in expressions input by |
7024 | the user. The syntax is @{@var{element}, @var{element}@dots{}@}. For example, | |
63092375 DJ |
7025 | you can use the command @code{print @{1, 2, 3@}} to create an array |
7026 | of three integers. If you pass an array to a function or assign it | |
7027 | to a program variable, @value{GDBN} copies the array to memory that | |
7028 | is @code{malloc}ed in the target program. | |
c906108c | 7029 | |
c906108c SS |
7030 | Because C is so widespread, most of the expressions shown in examples in |
7031 | this manual are in C. @xref{Languages, , Using @value{GDBN} with Different | |
7032 | Languages}, for information on how to use expressions in other | |
7033 | languages. | |
7034 | ||
7035 | In this section, we discuss operators that you can use in @value{GDBN} | |
7036 | expressions regardless of your programming language. | |
7037 | ||
15387254 | 7038 | @cindex casts, in expressions |
c906108c SS |
7039 | Casts are supported in all languages, not just in C, because it is so |
7040 | useful to cast a number into a pointer in order to examine a structure | |
7041 | at that address in memory. | |
7042 | @c FIXME: casts supported---Mod2 true? | |
c906108c SS |
7043 | |
7044 | @value{GDBN} supports these operators, in addition to those common | |
7045 | to programming languages: | |
7046 | ||
7047 | @table @code | |
7048 | @item @@ | |
7049 | @samp{@@} is a binary operator for treating parts of memory as arrays. | |
79a6e687 | 7050 | @xref{Arrays, ,Artificial Arrays}, for more information. |
c906108c SS |
7051 | |
7052 | @item :: | |
7053 | @samp{::} allows you to specify a variable in terms of the file or | |
79a6e687 | 7054 | function where it is defined. @xref{Variables, ,Program Variables}. |
c906108c SS |
7055 | |
7056 | @cindex @{@var{type}@} | |
7057 | @cindex type casting memory | |
7058 | @cindex memory, viewing as typed object | |
7059 | @cindex casts, to view memory | |
7060 | @item @{@var{type}@} @var{addr} | |
7061 | Refers to an object of type @var{type} stored at address @var{addr} in | |
7062 | memory. @var{addr} may be any expression whose value is an integer or | |
7063 | pointer (but parentheses are required around binary operators, just as in | |
7064 | a cast). This construct is allowed regardless of what kind of data is | |
7065 | normally supposed to reside at @var{addr}. | |
7066 | @end table | |
7067 | ||
6ba66d6a JB |
7068 | @node Ambiguous Expressions |
7069 | @section Ambiguous Expressions | |
7070 | @cindex ambiguous expressions | |
7071 | ||
7072 | Expressions can sometimes contain some ambiguous elements. For instance, | |
7073 | some programming languages (notably Ada, C@t{++} and Objective-C) permit | |
7074 | a single function name to be defined several times, for application in | |
7075 | different contexts. This is called @dfn{overloading}. Another example | |
7076 | involving Ada is generics. A @dfn{generic package} is similar to C@t{++} | |
7077 | templates and is typically instantiated several times, resulting in | |
7078 | the same function name being defined in different contexts. | |
7079 | ||
7080 | In some cases and depending on the language, it is possible to adjust | |
7081 | the expression to remove the ambiguity. For instance in C@t{++}, you | |
7082 | can specify the signature of the function you want to break on, as in | |
7083 | @kbd{break @var{function}(@var{types})}. In Ada, using the fully | |
7084 | qualified name of your function often makes the expression unambiguous | |
7085 | as well. | |
7086 | ||
7087 | When an ambiguity that needs to be resolved is detected, the debugger | |
7088 | has the capability to display a menu of numbered choices for each | |
7089 | possibility, and then waits for the selection with the prompt @samp{>}. | |
7090 | The first option is always @samp{[0] cancel}, and typing @kbd{0 @key{RET}} | |
7091 | aborts the current command. If the command in which the expression was | |
7092 | used allows more than one choice to be selected, the next option in the | |
7093 | menu is @samp{[1] all}, and typing @kbd{1 @key{RET}} selects all possible | |
7094 | choices. | |
7095 | ||
7096 | For example, the following session excerpt shows an attempt to set a | |
7097 | breakpoint at the overloaded symbol @code{String::after}. | |
7098 | We choose three particular definitions of that function name: | |
7099 | ||
7100 | @c FIXME! This is likely to change to show arg type lists, at least | |
7101 | @smallexample | |
7102 | @group | |
7103 | (@value{GDBP}) b String::after | |
7104 | [0] cancel | |
7105 | [1] all | |
7106 | [2] file:String.cc; line number:867 | |
7107 | [3] file:String.cc; line number:860 | |
7108 | [4] file:String.cc; line number:875 | |
7109 | [5] file:String.cc; line number:853 | |
7110 | [6] file:String.cc; line number:846 | |
7111 | [7] file:String.cc; line number:735 | |
7112 | > 2 4 6 | |
7113 | Breakpoint 1 at 0xb26c: file String.cc, line 867. | |
7114 | Breakpoint 2 at 0xb344: file String.cc, line 875. | |
7115 | Breakpoint 3 at 0xafcc: file String.cc, line 846. | |
7116 | Multiple breakpoints were set. | |
7117 | Use the "delete" command to delete unwanted | |
7118 | breakpoints. | |
7119 | (@value{GDBP}) | |
7120 | @end group | |
7121 | @end smallexample | |
7122 | ||
7123 | @table @code | |
7124 | @kindex set multiple-symbols | |
7125 | @item set multiple-symbols @var{mode} | |
7126 | @cindex multiple-symbols menu | |
7127 | ||
7128 | This option allows you to adjust the debugger behavior when an expression | |
7129 | is ambiguous. | |
7130 | ||
7131 | By default, @var{mode} is set to @code{all}. If the command with which | |
7132 | the expression is used allows more than one choice, then @value{GDBN} | |
7133 | automatically selects all possible choices. For instance, inserting | |
7134 | a breakpoint on a function using an ambiguous name results in a breakpoint | |
7135 | inserted on each possible match. However, if a unique choice must be made, | |
7136 | then @value{GDBN} uses the menu to help you disambiguate the expression. | |
7137 | For instance, printing the address of an overloaded function will result | |
7138 | in the use of the menu. | |
7139 | ||
7140 | When @var{mode} is set to @code{ask}, the debugger always uses the menu | |
7141 | when an ambiguity is detected. | |
7142 | ||
7143 | Finally, when @var{mode} is set to @code{cancel}, the debugger reports | |
7144 | an error due to the ambiguity and the command is aborted. | |
7145 | ||
7146 | @kindex show multiple-symbols | |
7147 | @item show multiple-symbols | |
7148 | Show the current value of the @code{multiple-symbols} setting. | |
7149 | @end table | |
7150 | ||
6d2ebf8b | 7151 | @node Variables |
79a6e687 | 7152 | @section Program Variables |
c906108c SS |
7153 | |
7154 | The most common kind of expression to use is the name of a variable | |
7155 | in your program. | |
7156 | ||
7157 | Variables in expressions are understood in the selected stack frame | |
79a6e687 | 7158 | (@pxref{Selection, ,Selecting a Frame}); they must be either: |
c906108c SS |
7159 | |
7160 | @itemize @bullet | |
7161 | @item | |
7162 | global (or file-static) | |
7163 | @end itemize | |
7164 | ||
5d161b24 | 7165 | @noindent or |
c906108c SS |
7166 | |
7167 | @itemize @bullet | |
7168 | @item | |
7169 | visible according to the scope rules of the | |
7170 | programming language from the point of execution in that frame | |
5d161b24 | 7171 | @end itemize |
c906108c SS |
7172 | |
7173 | @noindent This means that in the function | |
7174 | ||
474c8240 | 7175 | @smallexample |
c906108c SS |
7176 | foo (a) |
7177 | int a; | |
7178 | @{ | |
7179 | bar (a); | |
7180 | @{ | |
7181 | int b = test (); | |
7182 | bar (b); | |
7183 | @} | |
7184 | @} | |
474c8240 | 7185 | @end smallexample |
c906108c SS |
7186 | |
7187 | @noindent | |
7188 | you can examine and use the variable @code{a} whenever your program is | |
7189 | executing within the function @code{foo}, but you can only use or | |
7190 | examine the variable @code{b} while your program is executing inside | |
7191 | the block where @code{b} is declared. | |
7192 | ||
7193 | @cindex variable name conflict | |
7194 | There is an exception: you can refer to a variable or function whose | |
7195 | scope is a single source file even if the current execution point is not | |
7196 | in this file. But it is possible to have more than one such variable or | |
7197 | function with the same name (in different source files). If that | |
7198 | happens, referring to that name has unpredictable effects. If you wish, | |
7199 | you can specify a static variable in a particular function or file, | |
15387254 | 7200 | using the colon-colon (@code{::}) notation: |
c906108c | 7201 | |
d4f3574e | 7202 | @cindex colon-colon, context for variables/functions |
12c27660 | 7203 | @ifnotinfo |
c906108c | 7204 | @c info cannot cope with a :: index entry, but why deprive hard copy readers? |
41afff9a | 7205 | @cindex @code{::}, context for variables/functions |
12c27660 | 7206 | @end ifnotinfo |
474c8240 | 7207 | @smallexample |
c906108c SS |
7208 | @var{file}::@var{variable} |
7209 | @var{function}::@var{variable} | |
474c8240 | 7210 | @end smallexample |
c906108c SS |
7211 | |
7212 | @noindent | |
7213 | Here @var{file} or @var{function} is the name of the context for the | |
7214 | static @var{variable}. In the case of file names, you can use quotes to | |
7215 | make sure @value{GDBN} parses the file name as a single word---for example, | |
7216 | to print a global value of @code{x} defined in @file{f2.c}: | |
7217 | ||
474c8240 | 7218 | @smallexample |
c906108c | 7219 | (@value{GDBP}) p 'f2.c'::x |
474c8240 | 7220 | @end smallexample |
c906108c | 7221 | |
b37052ae | 7222 | @cindex C@t{++} scope resolution |
c906108c | 7223 | This use of @samp{::} is very rarely in conflict with the very similar |
b37052ae | 7224 | use of the same notation in C@t{++}. @value{GDBN} also supports use of the C@t{++} |
c906108c SS |
7225 | scope resolution operator in @value{GDBN} expressions. |
7226 | @c FIXME: Um, so what happens in one of those rare cases where it's in | |
7227 | @c conflict?? --mew | |
c906108c SS |
7228 | |
7229 | @cindex wrong values | |
7230 | @cindex variable values, wrong | |
15387254 EZ |
7231 | @cindex function entry/exit, wrong values of variables |
7232 | @cindex optimized code, wrong values of variables | |
c906108c SS |
7233 | @quotation |
7234 | @emph{Warning:} Occasionally, a local variable may appear to have the | |
7235 | wrong value at certain points in a function---just after entry to a new | |
7236 | scope, and just before exit. | |
7237 | @end quotation | |
7238 | You may see this problem when you are stepping by machine instructions. | |
7239 | This is because, on most machines, it takes more than one instruction to | |
7240 | set up a stack frame (including local variable definitions); if you are | |
7241 | stepping by machine instructions, variables may appear to have the wrong | |
7242 | values until the stack frame is completely built. On exit, it usually | |
7243 | also takes more than one machine instruction to destroy a stack frame; | |
7244 | after you begin stepping through that group of instructions, local | |
7245 | variable definitions may be gone. | |
7246 | ||
7247 | This may also happen when the compiler does significant optimizations. | |
7248 | To be sure of always seeing accurate values, turn off all optimization | |
7249 | when compiling. | |
7250 | ||
d4f3574e SS |
7251 | @cindex ``No symbol "foo" in current context'' |
7252 | Another possible effect of compiler optimizations is to optimize | |
7253 | unused variables out of existence, or assign variables to registers (as | |
7254 | opposed to memory addresses). Depending on the support for such cases | |
7255 | offered by the debug info format used by the compiler, @value{GDBN} | |
7256 | might not be able to display values for such local variables. If that | |
7257 | happens, @value{GDBN} will print a message like this: | |
7258 | ||
474c8240 | 7259 | @smallexample |
d4f3574e | 7260 | No symbol "foo" in current context. |
474c8240 | 7261 | @end smallexample |
d4f3574e SS |
7262 | |
7263 | To solve such problems, either recompile without optimizations, or use a | |
7264 | different debug info format, if the compiler supports several such | |
15387254 | 7265 | formats. For example, @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, |
0179ffac DC |
7266 | usually supports the @option{-gstabs+} option. @option{-gstabs+} |
7267 | produces debug info in a format that is superior to formats such as | |
7268 | COFF. You may be able to use DWARF 2 (@option{-gdwarf-2}), which is also | |
7269 | an effective form for debug info. @xref{Debugging Options,,Options | |
ce9341a1 BW |
7270 | for Debugging Your Program or GCC, gcc.info, Using the @sc{gnu} |
7271 | Compiler Collection (GCC)}. | |
79a6e687 | 7272 | @xref{C, ,C and C@t{++}}, for more information about debug info formats |
15387254 | 7273 | that are best suited to C@t{++} programs. |
d4f3574e | 7274 | |
ab1adacd EZ |
7275 | If you ask to print an object whose contents are unknown to |
7276 | @value{GDBN}, e.g., because its data type is not completely specified | |
7277 | by the debug information, @value{GDBN} will say @samp{<incomplete | |
7278 | type>}. @xref{Symbols, incomplete type}, for more about this. | |
7279 | ||
3a60f64e JK |
7280 | Strings are identified as arrays of @code{char} values without specified |
7281 | signedness. Arrays of either @code{signed char} or @code{unsigned char} get | |
7282 | printed as arrays of 1 byte sized integers. @code{-fsigned-char} or | |
7283 | @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN} | |
7284 | defines literal string type @code{"char"} as @code{char} without a sign. | |
7285 | For program code | |
7286 | ||
7287 | @smallexample | |
7288 | char var0[] = "A"; | |
7289 | signed char var1[] = "A"; | |
7290 | @end smallexample | |
7291 | ||
7292 | You get during debugging | |
7293 | @smallexample | |
7294 | (gdb) print var0 | |
7295 | $1 = "A" | |
7296 | (gdb) print var1 | |
7297 | $2 = @{65 'A', 0 '\0'@} | |
7298 | @end smallexample | |
7299 | ||
6d2ebf8b | 7300 | @node Arrays |
79a6e687 | 7301 | @section Artificial Arrays |
c906108c SS |
7302 | |
7303 | @cindex artificial array | |
15387254 | 7304 | @cindex arrays |
41afff9a | 7305 | @kindex @@@r{, referencing memory as an array} |
c906108c SS |
7306 | It is often useful to print out several successive objects of the |
7307 | same type in memory; a section of an array, or an array of | |
7308 | dynamically determined size for which only a pointer exists in the | |
7309 | program. | |
7310 | ||
7311 | You can do this by referring to a contiguous span of memory as an | |
7312 | @dfn{artificial array}, using the binary operator @samp{@@}. The left | |
7313 | operand of @samp{@@} should be the first element of the desired array | |
7314 | and be an individual object. The right operand should be the desired length | |
7315 | of the array. The result is an array value whose elements are all of | |
7316 | the type of the left argument. The first element is actually the left | |
7317 | argument; the second element comes from bytes of memory immediately | |
7318 | following those that hold the first element, and so on. Here is an | |
7319 | example. If a program says | |
7320 | ||
474c8240 | 7321 | @smallexample |
c906108c | 7322 | int *array = (int *) malloc (len * sizeof (int)); |
474c8240 | 7323 | @end smallexample |
c906108c SS |
7324 | |
7325 | @noindent | |
7326 | you can print the contents of @code{array} with | |
7327 | ||
474c8240 | 7328 | @smallexample |
c906108c | 7329 | p *array@@len |
474c8240 | 7330 | @end smallexample |
c906108c SS |
7331 | |
7332 | The left operand of @samp{@@} must reside in memory. Array values made | |
7333 | with @samp{@@} in this way behave just like other arrays in terms of | |
7334 | subscripting, and are coerced to pointers when used in expressions. | |
7335 | Artificial arrays most often appear in expressions via the value history | |
79a6e687 | 7336 | (@pxref{Value History, ,Value History}), after printing one out. |
c906108c SS |
7337 | |
7338 | Another way to create an artificial array is to use a cast. | |
7339 | This re-interprets a value as if it were an array. | |
7340 | The value need not be in memory: | |
474c8240 | 7341 | @smallexample |
c906108c SS |
7342 | (@value{GDBP}) p/x (short[2])0x12345678 |
7343 | $1 = @{0x1234, 0x5678@} | |
474c8240 | 7344 | @end smallexample |
c906108c SS |
7345 | |
7346 | As a convenience, if you leave the array length out (as in | |
c3f6f71d | 7347 | @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill |
c906108c | 7348 | the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}: |
474c8240 | 7349 | @smallexample |
c906108c SS |
7350 | (@value{GDBP}) p/x (short[])0x12345678 |
7351 | $2 = @{0x1234, 0x5678@} | |
474c8240 | 7352 | @end smallexample |
c906108c SS |
7353 | |
7354 | Sometimes the artificial array mechanism is not quite enough; in | |
7355 | moderately complex data structures, the elements of interest may not | |
7356 | actually be adjacent---for example, if you are interested in the values | |
7357 | of pointers in an array. One useful work-around in this situation is | |
7358 | to use a convenience variable (@pxref{Convenience Vars, ,Convenience | |
79a6e687 | 7359 | Variables}) as a counter in an expression that prints the first |
c906108c SS |
7360 | interesting value, and then repeat that expression via @key{RET}. For |
7361 | instance, suppose you have an array @code{dtab} of pointers to | |
7362 | structures, and you are interested in the values of a field @code{fv} | |
7363 | in each structure. Here is an example of what you might type: | |
7364 | ||
474c8240 | 7365 | @smallexample |
c906108c SS |
7366 | set $i = 0 |
7367 | p dtab[$i++]->fv | |
7368 | @key{RET} | |
7369 | @key{RET} | |
7370 | @dots{} | |
474c8240 | 7371 | @end smallexample |
c906108c | 7372 | |
6d2ebf8b | 7373 | @node Output Formats |
79a6e687 | 7374 | @section Output Formats |
c906108c SS |
7375 | |
7376 | @cindex formatted output | |
7377 | @cindex output formats | |
7378 | By default, @value{GDBN} prints a value according to its data type. Sometimes | |
7379 | this is not what you want. For example, you might want to print a number | |
7380 | in hex, or a pointer in decimal. Or you might want to view data in memory | |
7381 | at a certain address as a character string or as an instruction. To do | |
7382 | these things, specify an @dfn{output format} when you print a value. | |
7383 | ||
7384 | The simplest use of output formats is to say how to print a value | |
7385 | already computed. This is done by starting the arguments of the | |
7386 | @code{print} command with a slash and a format letter. The format | |
7387 | letters supported are: | |
7388 | ||
7389 | @table @code | |
7390 | @item x | |
7391 | Regard the bits of the value as an integer, and print the integer in | |
7392 | hexadecimal. | |
7393 | ||
7394 | @item d | |
7395 | Print as integer in signed decimal. | |
7396 | ||
7397 | @item u | |
7398 | Print as integer in unsigned decimal. | |
7399 | ||
7400 | @item o | |
7401 | Print as integer in octal. | |
7402 | ||
7403 | @item t | |
7404 | Print as integer in binary. The letter @samp{t} stands for ``two''. | |
7405 | @footnote{@samp{b} cannot be used because these format letters are also | |
7406 | used with the @code{x} command, where @samp{b} stands for ``byte''; | |
79a6e687 | 7407 | see @ref{Memory,,Examining Memory}.} |
c906108c SS |
7408 | |
7409 | @item a | |
7410 | @cindex unknown address, locating | |
3d67e040 | 7411 | @cindex locate address |
c906108c SS |
7412 | Print as an address, both absolute in hexadecimal and as an offset from |
7413 | the nearest preceding symbol. You can use this format used to discover | |
7414 | where (in what function) an unknown address is located: | |
7415 | ||
474c8240 | 7416 | @smallexample |
c906108c SS |
7417 | (@value{GDBP}) p/a 0x54320 |
7418 | $3 = 0x54320 <_initialize_vx+396> | |
474c8240 | 7419 | @end smallexample |
c906108c | 7420 | |
3d67e040 EZ |
7421 | @noindent |
7422 | The command @code{info symbol 0x54320} yields similar results. | |
7423 | @xref{Symbols, info symbol}. | |
7424 | ||
c906108c | 7425 | @item c |
51274035 EZ |
7426 | Regard as an integer and print it as a character constant. This |
7427 | prints both the numerical value and its character representation. The | |
7428 | character representation is replaced with the octal escape @samp{\nnn} | |
7429 | for characters outside the 7-bit @sc{ascii} range. | |
c906108c | 7430 | |
ea37ba09 DJ |
7431 | Without this format, @value{GDBN} displays @code{char}, |
7432 | @w{@code{unsigned char}}, and @w{@code{signed char}} data as character | |
7433 | constants. Single-byte members of vectors are displayed as integer | |
7434 | data. | |
7435 | ||
c906108c SS |
7436 | @item f |
7437 | Regard the bits of the value as a floating point number and print | |
7438 | using typical floating point syntax. | |
ea37ba09 DJ |
7439 | |
7440 | @item s | |
7441 | @cindex printing strings | |
7442 | @cindex printing byte arrays | |
7443 | Regard as a string, if possible. With this format, pointers to single-byte | |
7444 | data are displayed as null-terminated strings and arrays of single-byte data | |
7445 | are displayed as fixed-length strings. Other values are displayed in their | |
7446 | natural types. | |
7447 | ||
7448 | Without this format, @value{GDBN} displays pointers to and arrays of | |
7449 | @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as | |
7450 | strings. Single-byte members of a vector are displayed as an integer | |
7451 | array. | |
a6bac58e TT |
7452 | |
7453 | @item r | |
7454 | @cindex raw printing | |
7455 | Print using the @samp{raw} formatting. By default, @value{GDBN} will | |
78e2826b TT |
7456 | use a Python-based pretty-printer, if one is available (@pxref{Pretty |
7457 | Printing}). This typically results in a higher-level display of the | |
7458 | value's contents. The @samp{r} format bypasses any Python | |
7459 | pretty-printer which might exist. | |
c906108c SS |
7460 | @end table |
7461 | ||
7462 | For example, to print the program counter in hex (@pxref{Registers}), type | |
7463 | ||
474c8240 | 7464 | @smallexample |
c906108c | 7465 | p/x $pc |
474c8240 | 7466 | @end smallexample |
c906108c SS |
7467 | |
7468 | @noindent | |
7469 | Note that no space is required before the slash; this is because command | |
7470 | names in @value{GDBN} cannot contain a slash. | |
7471 | ||
7472 | To reprint the last value in the value history with a different format, | |
7473 | you can use the @code{print} command with just a format and no | |
7474 | expression. For example, @samp{p/x} reprints the last value in hex. | |
7475 | ||
6d2ebf8b | 7476 | @node Memory |
79a6e687 | 7477 | @section Examining Memory |
c906108c SS |
7478 | |
7479 | You can use the command @code{x} (for ``examine'') to examine memory in | |
7480 | any of several formats, independently of your program's data types. | |
7481 | ||
7482 | @cindex examining memory | |
7483 | @table @code | |
41afff9a | 7484 | @kindex x @r{(examine memory)} |
c906108c SS |
7485 | @item x/@var{nfu} @var{addr} |
7486 | @itemx x @var{addr} | |
7487 | @itemx x | |
7488 | Use the @code{x} command to examine memory. | |
7489 | @end table | |
7490 | ||
7491 | @var{n}, @var{f}, and @var{u} are all optional parameters that specify how | |
7492 | much memory to display and how to format it; @var{addr} is an | |
7493 | expression giving the address where you want to start displaying memory. | |
7494 | If you use defaults for @var{nfu}, you need not type the slash @samp{/}. | |
7495 | Several commands set convenient defaults for @var{addr}. | |
7496 | ||
7497 | @table @r | |
7498 | @item @var{n}, the repeat count | |
7499 | The repeat count is a decimal integer; the default is 1. It specifies | |
7500 | how much memory (counting by units @var{u}) to display. | |
7501 | @c This really is **decimal**; unaffected by 'set radix' as of GDB | |
7502 | @c 4.1.2. | |
7503 | ||
7504 | @item @var{f}, the display format | |
51274035 EZ |
7505 | The display format is one of the formats used by @code{print} |
7506 | (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c}, | |
ea37ba09 DJ |
7507 | @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions). |
7508 | The default is @samp{x} (hexadecimal) initially. The default changes | |
7509 | each time you use either @code{x} or @code{print}. | |
c906108c SS |
7510 | |
7511 | @item @var{u}, the unit size | |
7512 | The unit size is any of | |
7513 | ||
7514 | @table @code | |
7515 | @item b | |
7516 | Bytes. | |
7517 | @item h | |
7518 | Halfwords (two bytes). | |
7519 | @item w | |
7520 | Words (four bytes). This is the initial default. | |
7521 | @item g | |
7522 | Giant words (eight bytes). | |
7523 | @end table | |
7524 | ||
7525 | Each time you specify a unit size with @code{x}, that size becomes the | |
9a22f0d0 PM |
7526 | default unit the next time you use @code{x}. For the @samp{i} format, |
7527 | the unit size is ignored and is normally not written. For the @samp{s} format, | |
7528 | the unit size defaults to @samp{b}, unless it is explicitly given. | |
7529 | Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display | |
7530 | 32-bit strings. The next use of @kbd{x /s} will again display 8-bit strings. | |
7531 | Note that the results depend on the programming language of the | |
7532 | current compilation unit. If the language is C, the @samp{s} | |
7533 | modifier will use the UTF-16 encoding while @samp{w} will use | |
7534 | UTF-32. The encoding is set by the programming language and cannot | |
7535 | be altered. | |
c906108c SS |
7536 | |
7537 | @item @var{addr}, starting display address | |
7538 | @var{addr} is the address where you want @value{GDBN} to begin displaying | |
7539 | memory. The expression need not have a pointer value (though it may); | |
7540 | it is always interpreted as an integer address of a byte of memory. | |
7541 | @xref{Expressions, ,Expressions}, for more information on expressions. The default for | |
7542 | @var{addr} is usually just after the last address examined---but several | |
7543 | other commands also set the default address: @code{info breakpoints} (to | |
7544 | the address of the last breakpoint listed), @code{info line} (to the | |
7545 | starting address of a line), and @code{print} (if you use it to display | |
7546 | a value from memory). | |
7547 | @end table | |
7548 | ||
7549 | For example, @samp{x/3uh 0x54320} is a request to display three halfwords | |
7550 | (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}), | |
7551 | starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four | |
7552 | words (@samp{w}) of memory above the stack pointer (here, @samp{$sp}; | |
d4f3574e | 7553 | @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}). |
c906108c SS |
7554 | |
7555 | Since the letters indicating unit sizes are all distinct from the | |
7556 | letters specifying output formats, you do not have to remember whether | |
7557 | unit size or format comes first; either order works. The output | |
7558 | specifications @samp{4xw} and @samp{4wx} mean exactly the same thing. | |
7559 | (However, the count @var{n} must come first; @samp{wx4} does not work.) | |
7560 | ||
7561 | Even though the unit size @var{u} is ignored for the formats @samp{s} | |
7562 | and @samp{i}, you might still want to use a count @var{n}; for example, | |
7563 | @samp{3i} specifies that you want to see three machine instructions, | |
a4642986 MR |
7564 | including any operands. For convenience, especially when used with |
7565 | the @code{display} command, the @samp{i} format also prints branch delay | |
7566 | slot instructions, if any, beyond the count specified, which immediately | |
7567 | follow the last instruction that is within the count. The command | |
7568 | @code{disassemble} gives an alternative way of inspecting machine | |
7569 | instructions; see @ref{Machine Code,,Source and Machine Code}. | |
c906108c SS |
7570 | |
7571 | All the defaults for the arguments to @code{x} are designed to make it | |
7572 | easy to continue scanning memory with minimal specifications each time | |
7573 | you use @code{x}. For example, after you have inspected three machine | |
7574 | instructions with @samp{x/3i @var{addr}}, you can inspect the next seven | |
7575 | with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command, | |
7576 | the repeat count @var{n} is used again; the other arguments default as | |
7577 | for successive uses of @code{x}. | |
7578 | ||
2b28d209 PP |
7579 | When examining machine instructions, the instruction at current program |
7580 | counter is shown with a @code{=>} marker. For example: | |
7581 | ||
7582 | @smallexample | |
7583 | (@value{GDBP}) x/5i $pc-6 | |
7584 | 0x804837f <main+11>: mov %esp,%ebp | |
7585 | 0x8048381 <main+13>: push %ecx | |
7586 | 0x8048382 <main+14>: sub $0x4,%esp | |
7587 | => 0x8048385 <main+17>: movl $0x8048460,(%esp) | |
7588 | 0x804838c <main+24>: call 0x80482d4 <puts@@plt> | |
7589 | @end smallexample | |
7590 | ||
c906108c SS |
7591 | @cindex @code{$_}, @code{$__}, and value history |
7592 | The addresses and contents printed by the @code{x} command are not saved | |
7593 | in the value history because there is often too much of them and they | |
7594 | would get in the way. Instead, @value{GDBN} makes these values available for | |
7595 | subsequent use in expressions as values of the convenience variables | |
7596 | @code{$_} and @code{$__}. After an @code{x} command, the last address | |
7597 | examined is available for use in expressions in the convenience variable | |
7598 | @code{$_}. The contents of that address, as examined, are available in | |
7599 | the convenience variable @code{$__}. | |
7600 | ||
7601 | If the @code{x} command has a repeat count, the address and contents saved | |
7602 | are from the last memory unit printed; this is not the same as the last | |
7603 | address printed if several units were printed on the last line of output. | |
7604 | ||
09d4efe1 EZ |
7605 | @cindex remote memory comparison |
7606 | @cindex verify remote memory image | |
7607 | When you are debugging a program running on a remote target machine | |
ea35711c | 7608 | (@pxref{Remote Debugging}), you may wish to verify the program's image in the |
09d4efe1 EZ |
7609 | remote machine's memory against the executable file you downloaded to |
7610 | the target. The @code{compare-sections} command is provided for such | |
7611 | situations. | |
7612 | ||
7613 | @table @code | |
7614 | @kindex compare-sections | |
7615 | @item compare-sections @r{[}@var{section-name}@r{]} | |
7616 | Compare the data of a loadable section @var{section-name} in the | |
7617 | executable file of the program being debugged with the same section in | |
7618 | the remote machine's memory, and report any mismatches. With no | |
7619 | arguments, compares all loadable sections. This command's | |
7620 | availability depends on the target's support for the @code{"qCRC"} | |
7621 | remote request. | |
7622 | @end table | |
7623 | ||
6d2ebf8b | 7624 | @node Auto Display |
79a6e687 | 7625 | @section Automatic Display |
c906108c SS |
7626 | @cindex automatic display |
7627 | @cindex display of expressions | |
7628 | ||
7629 | If you find that you want to print the value of an expression frequently | |
7630 | (to see how it changes), you might want to add it to the @dfn{automatic | |
7631 | display list} so that @value{GDBN} prints its value each time your program stops. | |
7632 | Each expression added to the list is given a number to identify it; | |
7633 | to remove an expression from the list, you specify that number. | |
7634 | The automatic display looks like this: | |
7635 | ||
474c8240 | 7636 | @smallexample |
c906108c SS |
7637 | 2: foo = 38 |
7638 | 3: bar[5] = (struct hack *) 0x3804 | |
474c8240 | 7639 | @end smallexample |
c906108c SS |
7640 | |
7641 | @noindent | |
7642 | This display shows item numbers, expressions and their current values. As with | |
7643 | displays you request manually using @code{x} or @code{print}, you can | |
7644 | specify the output format you prefer; in fact, @code{display} decides | |
ea37ba09 DJ |
7645 | whether to use @code{print} or @code{x} depending your format |
7646 | specification---it uses @code{x} if you specify either the @samp{i} | |
7647 | or @samp{s} format, or a unit size; otherwise it uses @code{print}. | |
c906108c SS |
7648 | |
7649 | @table @code | |
7650 | @kindex display | |
d4f3574e SS |
7651 | @item display @var{expr} |
7652 | Add the expression @var{expr} to the list of expressions to display | |
c906108c SS |
7653 | each time your program stops. @xref{Expressions, ,Expressions}. |
7654 | ||
7655 | @code{display} does not repeat if you press @key{RET} again after using it. | |
7656 | ||
d4f3574e | 7657 | @item display/@var{fmt} @var{expr} |
c906108c | 7658 | For @var{fmt} specifying only a display format and not a size or |
d4f3574e | 7659 | count, add the expression @var{expr} to the auto-display list but |
c906108c | 7660 | arrange to display it each time in the specified format @var{fmt}. |
79a6e687 | 7661 | @xref{Output Formats,,Output Formats}. |
c906108c SS |
7662 | |
7663 | @item display/@var{fmt} @var{addr} | |
7664 | For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a | |
7665 | number of units, add the expression @var{addr} as a memory address to | |
7666 | be examined each time your program stops. Examining means in effect | |
79a6e687 | 7667 | doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}. |
c906108c SS |
7668 | @end table |
7669 | ||
7670 | For example, @samp{display/i $pc} can be helpful, to see the machine | |
7671 | instruction about to be executed each time execution stops (@samp{$pc} | |
d4f3574e | 7672 | is a common name for the program counter; @pxref{Registers, ,Registers}). |
c906108c SS |
7673 | |
7674 | @table @code | |
7675 | @kindex delete display | |
7676 | @kindex undisplay | |
7677 | @item undisplay @var{dnums}@dots{} | |
7678 | @itemx delete display @var{dnums}@dots{} | |
c9174737 PA |
7679 | Remove items from the list of expressions to display. Specify the |
7680 | numbers of the displays that you want affected with the command | |
7681 | argument @var{dnums}. It can be a single display number, one of the | |
7682 | numbers shown in the first field of the @samp{info display} display; | |
7683 | or it could be a range of display numbers, as in @code{2-4}. | |
c906108c SS |
7684 | |
7685 | @code{undisplay} does not repeat if you press @key{RET} after using it. | |
7686 | (Otherwise you would just get the error @samp{No display number @dots{}}.) | |
7687 | ||
7688 | @kindex disable display | |
7689 | @item disable display @var{dnums}@dots{} | |
7690 | Disable the display of item numbers @var{dnums}. A disabled display | |
7691 | item is not printed automatically, but is not forgotten. It may be | |
c9174737 PA |
7692 | enabled again later. Specify the numbers of the displays that you |
7693 | want affected with the command argument @var{dnums}. It can be a | |
7694 | single display number, one of the numbers shown in the first field of | |
7695 | the @samp{info display} display; or it could be a range of display | |
7696 | numbers, as in @code{2-4}. | |
c906108c SS |
7697 | |
7698 | @kindex enable display | |
7699 | @item enable display @var{dnums}@dots{} | |
7700 | Enable display of item numbers @var{dnums}. It becomes effective once | |
7701 | again in auto display of its expression, until you specify otherwise. | |
c9174737 PA |
7702 | Specify the numbers of the displays that you want affected with the |
7703 | command argument @var{dnums}. It can be a single display number, one | |
7704 | of the numbers shown in the first field of the @samp{info display} | |
7705 | display; or it could be a range of display numbers, as in @code{2-4}. | |
c906108c SS |
7706 | |
7707 | @item display | |
7708 | Display the current values of the expressions on the list, just as is | |
7709 | done when your program stops. | |
7710 | ||
7711 | @kindex info display | |
7712 | @item info display | |
7713 | Print the list of expressions previously set up to display | |
7714 | automatically, each one with its item number, but without showing the | |
7715 | values. This includes disabled expressions, which are marked as such. | |
7716 | It also includes expressions which would not be displayed right now | |
7717 | because they refer to automatic variables not currently available. | |
7718 | @end table | |
7719 | ||
15387254 | 7720 | @cindex display disabled out of scope |
c906108c SS |
7721 | If a display expression refers to local variables, then it does not make |
7722 | sense outside the lexical context for which it was set up. Such an | |
7723 | expression is disabled when execution enters a context where one of its | |
7724 | variables is not defined. For example, if you give the command | |
7725 | @code{display last_char} while inside a function with an argument | |
7726 | @code{last_char}, @value{GDBN} displays this argument while your program | |
7727 | continues to stop inside that function. When it stops elsewhere---where | |
7728 | there is no variable @code{last_char}---the display is disabled | |
7729 | automatically. The next time your program stops where @code{last_char} | |
7730 | is meaningful, you can enable the display expression once again. | |
7731 | ||
6d2ebf8b | 7732 | @node Print Settings |
79a6e687 | 7733 | @section Print Settings |
c906108c SS |
7734 | |
7735 | @cindex format options | |
7736 | @cindex print settings | |
7737 | @value{GDBN} provides the following ways to control how arrays, structures, | |
7738 | and symbols are printed. | |
7739 | ||
7740 | @noindent | |
7741 | These settings are useful for debugging programs in any language: | |
7742 | ||
7743 | @table @code | |
4644b6e3 | 7744 | @kindex set print |
c906108c SS |
7745 | @item set print address |
7746 | @itemx set print address on | |
4644b6e3 | 7747 | @cindex print/don't print memory addresses |
c906108c SS |
7748 | @value{GDBN} prints memory addresses showing the location of stack |
7749 | traces, structure values, pointer values, breakpoints, and so forth, | |
7750 | even when it also displays the contents of those addresses. The default | |
7751 | is @code{on}. For example, this is what a stack frame display looks like with | |
7752 | @code{set print address on}: | |
7753 | ||
7754 | @smallexample | |
7755 | @group | |
7756 | (@value{GDBP}) f | |
7757 | #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>") | |
7758 | at input.c:530 | |
7759 | 530 if (lquote != def_lquote) | |
7760 | @end group | |
7761 | @end smallexample | |
7762 | ||
7763 | @item set print address off | |
7764 | Do not print addresses when displaying their contents. For example, | |
7765 | this is the same stack frame displayed with @code{set print address off}: | |
7766 | ||
7767 | @smallexample | |
7768 | @group | |
7769 | (@value{GDBP}) set print addr off | |
7770 | (@value{GDBP}) f | |
7771 | #0 set_quotes (lq="<<", rq=">>") at input.c:530 | |
7772 | 530 if (lquote != def_lquote) | |
7773 | @end group | |
7774 | @end smallexample | |
7775 | ||
7776 | You can use @samp{set print address off} to eliminate all machine | |
7777 | dependent displays from the @value{GDBN} interface. For example, with | |
7778 | @code{print address off}, you should get the same text for backtraces on | |
7779 | all machines---whether or not they involve pointer arguments. | |
7780 | ||
4644b6e3 | 7781 | @kindex show print |
c906108c SS |
7782 | @item show print address |
7783 | Show whether or not addresses are to be printed. | |
7784 | @end table | |
7785 | ||
7786 | When @value{GDBN} prints a symbolic address, it normally prints the | |
7787 | closest earlier symbol plus an offset. If that symbol does not uniquely | |
7788 | identify the address (for example, it is a name whose scope is a single | |
7789 | source file), you may need to clarify. One way to do this is with | |
7790 | @code{info line}, for example @samp{info line *0x4537}. Alternately, | |
7791 | you can set @value{GDBN} to print the source file and line number when | |
7792 | it prints a symbolic address: | |
7793 | ||
7794 | @table @code | |
c906108c | 7795 | @item set print symbol-filename on |
9c16f35a EZ |
7796 | @cindex source file and line of a symbol |
7797 | @cindex symbol, source file and line | |
c906108c SS |
7798 | Tell @value{GDBN} to print the source file name and line number of a |
7799 | symbol in the symbolic form of an address. | |
7800 | ||
7801 | @item set print symbol-filename off | |
7802 | Do not print source file name and line number of a symbol. This is the | |
7803 | default. | |
7804 | ||
c906108c SS |
7805 | @item show print symbol-filename |
7806 | Show whether or not @value{GDBN} will print the source file name and | |
7807 | line number of a symbol in the symbolic form of an address. | |
7808 | @end table | |
7809 | ||
7810 | Another situation where it is helpful to show symbol filenames and line | |
7811 | numbers is when disassembling code; @value{GDBN} shows you the line | |
7812 | number and source file that corresponds to each instruction. | |
7813 | ||
7814 | Also, you may wish to see the symbolic form only if the address being | |
7815 | printed is reasonably close to the closest earlier symbol: | |
7816 | ||
7817 | @table @code | |
c906108c | 7818 | @item set print max-symbolic-offset @var{max-offset} |
4644b6e3 | 7819 | @cindex maximum value for offset of closest symbol |
c906108c SS |
7820 | Tell @value{GDBN} to only display the symbolic form of an address if the |
7821 | offset between the closest earlier symbol and the address is less than | |
5d161b24 | 7822 | @var{max-offset}. The default is 0, which tells @value{GDBN} |
c906108c SS |
7823 | to always print the symbolic form of an address if any symbol precedes it. |
7824 | ||
c906108c SS |
7825 | @item show print max-symbolic-offset |
7826 | Ask how large the maximum offset is that @value{GDBN} prints in a | |
7827 | symbolic address. | |
7828 | @end table | |
7829 | ||
7830 | @cindex wild pointer, interpreting | |
7831 | @cindex pointer, finding referent | |
7832 | If you have a pointer and you are not sure where it points, try | |
7833 | @samp{set print symbol-filename on}. Then you can determine the name | |
7834 | and source file location of the variable where it points, using | |
7835 | @samp{p/a @var{pointer}}. This interprets the address in symbolic form. | |
7836 | For example, here @value{GDBN} shows that a variable @code{ptt} points | |
7837 | at another variable @code{t}, defined in @file{hi2.c}: | |
7838 | ||
474c8240 | 7839 | @smallexample |
c906108c SS |
7840 | (@value{GDBP}) set print symbol-filename on |
7841 | (@value{GDBP}) p/a ptt | |
7842 | $4 = 0xe008 <t in hi2.c> | |
474c8240 | 7843 | @end smallexample |
c906108c SS |
7844 | |
7845 | @quotation | |
7846 | @emph{Warning:} For pointers that point to a local variable, @samp{p/a} | |
7847 | does not show the symbol name and filename of the referent, even with | |
7848 | the appropriate @code{set print} options turned on. | |
7849 | @end quotation | |
7850 | ||
7851 | Other settings control how different kinds of objects are printed: | |
7852 | ||
7853 | @table @code | |
c906108c SS |
7854 | @item set print array |
7855 | @itemx set print array on | |
4644b6e3 | 7856 | @cindex pretty print arrays |
c906108c SS |
7857 | Pretty print arrays. This format is more convenient to read, |
7858 | but uses more space. The default is off. | |
7859 | ||
7860 | @item set print array off | |
7861 | Return to compressed format for arrays. | |
7862 | ||
c906108c SS |
7863 | @item show print array |
7864 | Show whether compressed or pretty format is selected for displaying | |
7865 | arrays. | |
7866 | ||
3c9c013a JB |
7867 | @cindex print array indexes |
7868 | @item set print array-indexes | |
7869 | @itemx set print array-indexes on | |
7870 | Print the index of each element when displaying arrays. May be more | |
7871 | convenient to locate a given element in the array or quickly find the | |
7872 | index of a given element in that printed array. The default is off. | |
7873 | ||
7874 | @item set print array-indexes off | |
7875 | Stop printing element indexes when displaying arrays. | |
7876 | ||
7877 | @item show print array-indexes | |
7878 | Show whether the index of each element is printed when displaying | |
7879 | arrays. | |
7880 | ||
c906108c | 7881 | @item set print elements @var{number-of-elements} |
4644b6e3 | 7882 | @cindex number of array elements to print |
9c16f35a | 7883 | @cindex limit on number of printed array elements |
c906108c SS |
7884 | Set a limit on how many elements of an array @value{GDBN} will print. |
7885 | If @value{GDBN} is printing a large array, it stops printing after it has | |
7886 | printed the number of elements set by the @code{set print elements} command. | |
7887 | This limit also applies to the display of strings. | |
d4f3574e | 7888 | When @value{GDBN} starts, this limit is set to 200. |
c906108c SS |
7889 | Setting @var{number-of-elements} to zero means that the printing is unlimited. |
7890 | ||
c906108c SS |
7891 | @item show print elements |
7892 | Display the number of elements of a large array that @value{GDBN} will print. | |
7893 | If the number is 0, then the printing is unlimited. | |
7894 | ||
b4740add | 7895 | @item set print frame-arguments @var{value} |
a0381d3a | 7896 | @kindex set print frame-arguments |
b4740add JB |
7897 | @cindex printing frame argument values |
7898 | @cindex print all frame argument values | |
7899 | @cindex print frame argument values for scalars only | |
7900 | @cindex do not print frame argument values | |
7901 | This command allows to control how the values of arguments are printed | |
7902 | when the debugger prints a frame (@pxref{Frames}). The possible | |
7903 | values are: | |
7904 | ||
7905 | @table @code | |
7906 | @item all | |
4f5376b2 | 7907 | The values of all arguments are printed. |
b4740add JB |
7908 | |
7909 | @item scalars | |
7910 | Print the value of an argument only if it is a scalar. The value of more | |
7911 | complex arguments such as arrays, structures, unions, etc, is replaced | |
4f5376b2 JB |
7912 | by @code{@dots{}}. This is the default. Here is an example where |
7913 | only scalar arguments are shown: | |
b4740add JB |
7914 | |
7915 | @smallexample | |
7916 | #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green) | |
7917 | at frame-args.c:23 | |
7918 | @end smallexample | |
7919 | ||
7920 | @item none | |
7921 | None of the argument values are printed. Instead, the value of each argument | |
7922 | is replaced by @code{@dots{}}. In this case, the example above now becomes: | |
7923 | ||
7924 | @smallexample | |
7925 | #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{}) | |
7926 | at frame-args.c:23 | |
7927 | @end smallexample | |
7928 | @end table | |
7929 | ||
4f5376b2 JB |
7930 | By default, only scalar arguments are printed. This command can be used |
7931 | to configure the debugger to print the value of all arguments, regardless | |
7932 | of their type. However, it is often advantageous to not print the value | |
7933 | of more complex parameters. For instance, it reduces the amount of | |
7934 | information printed in each frame, making the backtrace more readable. | |
7935 | Also, it improves performance when displaying Ada frames, because | |
7936 | the computation of large arguments can sometimes be CPU-intensive, | |
7937 | especially in large applications. Setting @code{print frame-arguments} | |
7938 | to @code{scalars} (the default) or @code{none} avoids this computation, | |
7939 | thus speeding up the display of each Ada frame. | |
b4740add JB |
7940 | |
7941 | @item show print frame-arguments | |
7942 | Show how the value of arguments should be displayed when printing a frame. | |
7943 | ||
9c16f35a EZ |
7944 | @item set print repeats |
7945 | @cindex repeated array elements | |
7946 | Set the threshold for suppressing display of repeated array | |
d3e8051b | 7947 | elements. When the number of consecutive identical elements of an |
9c16f35a EZ |
7948 | array exceeds the threshold, @value{GDBN} prints the string |
7949 | @code{"<repeats @var{n} times>"}, where @var{n} is the number of | |
7950 | identical repetitions, instead of displaying the identical elements | |
7951 | themselves. Setting the threshold to zero will cause all elements to | |
7952 | be individually printed. The default threshold is 10. | |
7953 | ||
7954 | @item show print repeats | |
7955 | Display the current threshold for printing repeated identical | |
7956 | elements. | |
7957 | ||
c906108c | 7958 | @item set print null-stop |
4644b6e3 | 7959 | @cindex @sc{null} elements in arrays |
c906108c | 7960 | Cause @value{GDBN} to stop printing the characters of an array when the first |
d4f3574e | 7961 | @sc{null} is encountered. This is useful when large arrays actually |
c906108c | 7962 | contain only short strings. |
d4f3574e | 7963 | The default is off. |
c906108c | 7964 | |
9c16f35a EZ |
7965 | @item show print null-stop |
7966 | Show whether @value{GDBN} stops printing an array on the first | |
7967 | @sc{null} character. | |
7968 | ||
c906108c | 7969 | @item set print pretty on |
9c16f35a EZ |
7970 | @cindex print structures in indented form |
7971 | @cindex indentation in structure display | |
5d161b24 | 7972 | Cause @value{GDBN} to print structures in an indented format with one member |
c906108c SS |
7973 | per line, like this: |
7974 | ||
7975 | @smallexample | |
7976 | @group | |
7977 | $1 = @{ | |
7978 | next = 0x0, | |
7979 | flags = @{ | |
7980 | sweet = 1, | |
7981 | sour = 1 | |
7982 | @}, | |
7983 | meat = 0x54 "Pork" | |
7984 | @} | |
7985 | @end group | |
7986 | @end smallexample | |
7987 | ||
7988 | @item set print pretty off | |
7989 | Cause @value{GDBN} to print structures in a compact format, like this: | |
7990 | ||
7991 | @smallexample | |
7992 | @group | |
7993 | $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \ | |
7994 | meat = 0x54 "Pork"@} | |
7995 | @end group | |
7996 | @end smallexample | |
7997 | ||
7998 | @noindent | |
7999 | This is the default format. | |
8000 | ||
c906108c SS |
8001 | @item show print pretty |
8002 | Show which format @value{GDBN} is using to print structures. | |
8003 | ||
c906108c | 8004 | @item set print sevenbit-strings on |
4644b6e3 EZ |
8005 | @cindex eight-bit characters in strings |
8006 | @cindex octal escapes in strings | |
c906108c SS |
8007 | Print using only seven-bit characters; if this option is set, |
8008 | @value{GDBN} displays any eight-bit characters (in strings or | |
8009 | character values) using the notation @code{\}@var{nnn}. This setting is | |
8010 | best if you are working in English (@sc{ascii}) and you use the | |
8011 | high-order bit of characters as a marker or ``meta'' bit. | |
8012 | ||
8013 | @item set print sevenbit-strings off | |
8014 | Print full eight-bit characters. This allows the use of more | |
8015 | international character sets, and is the default. | |
8016 | ||
c906108c SS |
8017 | @item show print sevenbit-strings |
8018 | Show whether or not @value{GDBN} is printing only seven-bit characters. | |
8019 | ||
c906108c | 8020 | @item set print union on |
4644b6e3 | 8021 | @cindex unions in structures, printing |
9c16f35a EZ |
8022 | Tell @value{GDBN} to print unions which are contained in structures |
8023 | and other unions. This is the default setting. | |
c906108c SS |
8024 | |
8025 | @item set print union off | |
9c16f35a EZ |
8026 | Tell @value{GDBN} not to print unions which are contained in |
8027 | structures and other unions. @value{GDBN} will print @code{"@{...@}"} | |
8028 | instead. | |
c906108c | 8029 | |
c906108c SS |
8030 | @item show print union |
8031 | Ask @value{GDBN} whether or not it will print unions which are contained in | |
9c16f35a | 8032 | structures and other unions. |
c906108c SS |
8033 | |
8034 | For example, given the declarations | |
8035 | ||
8036 | @smallexample | |
8037 | typedef enum @{Tree, Bug@} Species; | |
8038 | typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms; | |
5d161b24 | 8039 | typedef enum @{Caterpillar, Cocoon, Butterfly@} |
c906108c SS |
8040 | Bug_forms; |
8041 | ||
8042 | struct thing @{ | |
8043 | Species it; | |
8044 | union @{ | |
8045 | Tree_forms tree; | |
8046 | Bug_forms bug; | |
8047 | @} form; | |
8048 | @}; | |
8049 | ||
8050 | struct thing foo = @{Tree, @{Acorn@}@}; | |
8051 | @end smallexample | |
8052 | ||
8053 | @noindent | |
8054 | with @code{set print union on} in effect @samp{p foo} would print | |
8055 | ||
8056 | @smallexample | |
8057 | $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@} | |
8058 | @end smallexample | |
8059 | ||
8060 | @noindent | |
8061 | and with @code{set print union off} in effect it would print | |
8062 | ||
8063 | @smallexample | |
8064 | $1 = @{it = Tree, form = @{...@}@} | |
8065 | @end smallexample | |
9c16f35a EZ |
8066 | |
8067 | @noindent | |
8068 | @code{set print union} affects programs written in C-like languages | |
8069 | and in Pascal. | |
c906108c SS |
8070 | @end table |
8071 | ||
c906108c SS |
8072 | @need 1000 |
8073 | @noindent | |
b37052ae | 8074 | These settings are of interest when debugging C@t{++} programs: |
c906108c SS |
8075 | |
8076 | @table @code | |
4644b6e3 | 8077 | @cindex demangling C@t{++} names |
c906108c SS |
8078 | @item set print demangle |
8079 | @itemx set print demangle on | |
b37052ae | 8080 | Print C@t{++} names in their source form rather than in the encoded |
c906108c | 8081 | (``mangled'') form passed to the assembler and linker for type-safe |
d4f3574e | 8082 | linkage. The default is on. |
c906108c | 8083 | |
c906108c | 8084 | @item show print demangle |
b37052ae | 8085 | Show whether C@t{++} names are printed in mangled or demangled form. |
c906108c | 8086 | |
c906108c SS |
8087 | @item set print asm-demangle |
8088 | @itemx set print asm-demangle on | |
b37052ae | 8089 | Print C@t{++} names in their source form rather than their mangled form, even |
c906108c SS |
8090 | in assembler code printouts such as instruction disassemblies. |
8091 | The default is off. | |
8092 | ||
c906108c | 8093 | @item show print asm-demangle |
b37052ae | 8094 | Show whether C@t{++} names in assembly listings are printed in mangled |
c906108c SS |
8095 | or demangled form. |
8096 | ||
b37052ae EZ |
8097 | @cindex C@t{++} symbol decoding style |
8098 | @cindex symbol decoding style, C@t{++} | |
a8f24a35 | 8099 | @kindex set demangle-style |
c906108c SS |
8100 | @item set demangle-style @var{style} |
8101 | Choose among several encoding schemes used by different compilers to | |
b37052ae | 8102 | represent C@t{++} names. The choices for @var{style} are currently: |
c906108c SS |
8103 | |
8104 | @table @code | |
8105 | @item auto | |
8106 | Allow @value{GDBN} to choose a decoding style by inspecting your program. | |
8107 | ||
8108 | @item gnu | |
b37052ae | 8109 | Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm. |
c906108c | 8110 | This is the default. |
c906108c SS |
8111 | |
8112 | @item hp | |
b37052ae | 8113 | Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm. |
c906108c SS |
8114 | |
8115 | @item lucid | |
b37052ae | 8116 | Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm. |
c906108c SS |
8117 | |
8118 | @item arm | |
b37052ae | 8119 | Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}. |
c906108c SS |
8120 | @strong{Warning:} this setting alone is not sufficient to allow |
8121 | debugging @code{cfront}-generated executables. @value{GDBN} would | |
8122 | require further enhancement to permit that. | |
8123 | ||
8124 | @end table | |
8125 | If you omit @var{style}, you will see a list of possible formats. | |
8126 | ||
c906108c | 8127 | @item show demangle-style |
b37052ae | 8128 | Display the encoding style currently in use for decoding C@t{++} symbols. |
c906108c | 8129 | |
c906108c SS |
8130 | @item set print object |
8131 | @itemx set print object on | |
4644b6e3 | 8132 | @cindex derived type of an object, printing |
9c16f35a | 8133 | @cindex display derived types |
c906108c SS |
8134 | When displaying a pointer to an object, identify the @emph{actual} |
8135 | (derived) type of the object rather than the @emph{declared} type, using | |
8136 | the virtual function table. | |
8137 | ||
8138 | @item set print object off | |
8139 | Display only the declared type of objects, without reference to the | |
8140 | virtual function table. This is the default setting. | |
8141 | ||
c906108c SS |
8142 | @item show print object |
8143 | Show whether actual, or declared, object types are displayed. | |
8144 | ||
c906108c SS |
8145 | @item set print static-members |
8146 | @itemx set print static-members on | |
4644b6e3 | 8147 | @cindex static members of C@t{++} objects |
b37052ae | 8148 | Print static members when displaying a C@t{++} object. The default is on. |
c906108c SS |
8149 | |
8150 | @item set print static-members off | |
b37052ae | 8151 | Do not print static members when displaying a C@t{++} object. |
c906108c | 8152 | |
c906108c | 8153 | @item show print static-members |
9c16f35a EZ |
8154 | Show whether C@t{++} static members are printed or not. |
8155 | ||
8156 | @item set print pascal_static-members | |
8157 | @itemx set print pascal_static-members on | |
d3e8051b EZ |
8158 | @cindex static members of Pascal objects |
8159 | @cindex Pascal objects, static members display | |
9c16f35a EZ |
8160 | Print static members when displaying a Pascal object. The default is on. |
8161 | ||
8162 | @item set print pascal_static-members off | |
8163 | Do not print static members when displaying a Pascal object. | |
8164 | ||
8165 | @item show print pascal_static-members | |
8166 | Show whether Pascal static members are printed or not. | |
c906108c SS |
8167 | |
8168 | @c These don't work with HP ANSI C++ yet. | |
c906108c SS |
8169 | @item set print vtbl |
8170 | @itemx set print vtbl on | |
4644b6e3 | 8171 | @cindex pretty print C@t{++} virtual function tables |
9c16f35a EZ |
8172 | @cindex virtual functions (C@t{++}) display |
8173 | @cindex VTBL display | |
b37052ae | 8174 | Pretty print C@t{++} virtual function tables. The default is off. |
c906108c | 8175 | (The @code{vtbl} commands do not work on programs compiled with the HP |
b37052ae | 8176 | ANSI C@t{++} compiler (@code{aCC}).) |
c906108c SS |
8177 | |
8178 | @item set print vtbl off | |
b37052ae | 8179 | Do not pretty print C@t{++} virtual function tables. |
c906108c | 8180 | |
c906108c | 8181 | @item show print vtbl |
b37052ae | 8182 | Show whether C@t{++} virtual function tables are pretty printed, or not. |
c906108c | 8183 | @end table |
c906108c | 8184 | |
4c374409 JK |
8185 | @node Pretty Printing |
8186 | @section Pretty Printing | |
8187 | ||
8188 | @value{GDBN} provides a mechanism to allow pretty-printing of values using | |
8189 | Python code. It greatly simplifies the display of complex objects. This | |
8190 | mechanism works for both MI and the CLI. | |
8191 | ||
7b51bc51 DE |
8192 | @menu |
8193 | * Pretty-Printer Introduction:: Introduction to pretty-printers | |
8194 | * Pretty-Printer Example:: An example pretty-printer | |
8195 | * Pretty-Printer Commands:: Pretty-printer commands | |
8196 | @end menu | |
8197 | ||
8198 | @node Pretty-Printer Introduction | |
8199 | @subsection Pretty-Printer Introduction | |
8200 | ||
8201 | When @value{GDBN} prints a value, it first sees if there is a pretty-printer | |
8202 | registered for the value. If there is then @value{GDBN} invokes the | |
8203 | pretty-printer to print the value. Otherwise the value is printed normally. | |
8204 | ||
8205 | Pretty-printers are normally named. This makes them easy to manage. | |
8206 | The @samp{info pretty-printer} command will list all the installed | |
8207 | pretty-printers with their names. | |
8208 | If a pretty-printer can handle multiple data types, then its | |
8209 | @dfn{subprinters} are the printers for the individual data types. | |
8210 | Each such subprinter has its own name. | |
4e04c971 | 8211 | The format of the name is @var{printer-name};@var{subprinter-name}. |
7b51bc51 DE |
8212 | |
8213 | Pretty-printers are installed by @dfn{registering} them with @value{GDBN}. | |
8214 | Typically they are automatically loaded and registered when the corresponding | |
8215 | debug information is loaded, thus making them available without having to | |
8216 | do anything special. | |
8217 | ||
8218 | There are three places where a pretty-printer can be registered. | |
8219 | ||
8220 | @itemize @bullet | |
8221 | @item | |
8222 | Pretty-printers registered globally are available when debugging | |
8223 | all inferiors. | |
8224 | ||
8225 | @item | |
8226 | Pretty-printers registered with a program space are available only | |
8227 | when debugging that program. | |
8228 | @xref{Progspaces In Python}, for more details on program spaces in Python. | |
8229 | ||
8230 | @item | |
8231 | Pretty-printers registered with an objfile are loaded and unloaded | |
8232 | with the corresponding objfile (e.g., shared library). | |
8233 | @xref{Objfiles In Python}, for more details on objfiles in Python. | |
8234 | @end itemize | |
8235 | ||
8236 | @xref{Selecting Pretty-Printers}, for further information on how | |
8237 | pretty-printers are selected, | |
8238 | ||
8239 | @xref{Writing a Pretty-Printer}, for implementing pretty printers | |
8240 | for new types. | |
8241 | ||
8242 | @node Pretty-Printer Example | |
8243 | @subsection Pretty-Printer Example | |
8244 | ||
8245 | Here is how a C@t{++} @code{std::string} looks without a pretty-printer: | |
4c374409 JK |
8246 | |
8247 | @smallexample | |
8248 | (@value{GDBP}) print s | |
8249 | $1 = @{ | |
8250 | static npos = 4294967295, | |
8251 | _M_dataplus = @{ | |
8252 | <std::allocator<char>> = @{ | |
8253 | <__gnu_cxx::new_allocator<char>> = @{ | |
8254 | <No data fields>@}, <No data fields> | |
8255 | @}, | |
8256 | members of std::basic_string<char, std::char_traits<char>, | |
8257 | std::allocator<char> >::_Alloc_hider: | |
8258 | _M_p = 0x804a014 "abcd" | |
8259 | @} | |
8260 | @} | |
8261 | @end smallexample | |
8262 | ||
8263 | With a pretty-printer for @code{std::string} only the contents are printed: | |
8264 | ||
8265 | @smallexample | |
8266 | (@value{GDBP}) print s | |
8267 | $2 = "abcd" | |
8268 | @end smallexample | |
8269 | ||
7b51bc51 DE |
8270 | @node Pretty-Printer Commands |
8271 | @subsection Pretty-Printer Commands | |
8272 | @cindex pretty-printer commands | |
8273 | ||
8274 | @table @code | |
8275 | @kindex info pretty-printer | |
8276 | @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]] | |
8277 | Print the list of installed pretty-printers. | |
8278 | This includes disabled pretty-printers, which are marked as such. | |
8279 | ||
8280 | @var{object-regexp} is a regular expression matching the objects | |
8281 | whose pretty-printers to list. | |
8282 | Objects can be @code{global}, the program space's file | |
8283 | (@pxref{Progspaces In Python}), | |
8284 | and the object files within that program space (@pxref{Objfiles In Python}). | |
8285 | @xref{Selecting Pretty-Printers}, for details on how @value{GDBN} | |
8286 | looks up a printer from these three objects. | |
8287 | ||
8288 | @var{name-regexp} is a regular expression matching the name of the printers | |
8289 | to list. | |
8290 | ||
8291 | @kindex disable pretty-printer | |
8292 | @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]] | |
8293 | Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}. | |
8294 | A disabled pretty-printer is not forgotten, it may be enabled again later. | |
8295 | ||
8296 | @kindex enable pretty-printer | |
8297 | @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]] | |
8298 | Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}. | |
8299 | @end table | |
8300 | ||
8301 | Example: | |
8302 | ||
8303 | Suppose we have three pretty-printers installed: one from library1.so | |
8304 | named @code{foo} that prints objects of type @code{foo}, and | |
8305 | another from library2.so named @code{bar} that prints two types of objects, | |
8306 | @code{bar1} and @code{bar2}. | |
8307 | ||
8308 | @smallexample | |
8309 | (gdb) info pretty-printer | |
8310 | library1.so: | |
8311 | foo | |
8312 | library2.so: | |
8313 | bar | |
8314 | bar1 | |
8315 | bar2 | |
8316 | (gdb) info pretty-printer library2 | |
8317 | library2.so: | |
8318 | bar | |
8319 | bar1 | |
8320 | bar2 | |
8321 | (gdb) disable pretty-printer library1 | |
8322 | 1 printer disabled | |
8323 | 2 of 3 printers enabled | |
8324 | (gdb) info pretty-printer | |
8325 | library1.so: | |
8326 | foo [disabled] | |
8327 | library2.so: | |
8328 | bar | |
8329 | bar1 | |
8330 | bar2 | |
8331 | (gdb) disable pretty-printer library2 bar:bar1 | |
8332 | 1 printer disabled | |
8333 | 1 of 3 printers enabled | |
8334 | (gdb) info pretty-printer library2 | |
8335 | library1.so: | |
8336 | foo [disabled] | |
8337 | library2.so: | |
8338 | bar | |
8339 | bar1 [disabled] | |
8340 | bar2 | |
8341 | (gdb) disable pretty-printer library2 bar | |
8342 | 1 printer disabled | |
8343 | 0 of 3 printers enabled | |
8344 | (gdb) info pretty-printer library2 | |
8345 | library1.so: | |
8346 | foo [disabled] | |
8347 | library2.so: | |
8348 | bar [disabled] | |
8349 | bar1 [disabled] | |
8350 | bar2 | |
8351 | @end smallexample | |
8352 | ||
8353 | Note that for @code{bar} the entire printer can be disabled, | |
8354 | as can each individual subprinter. | |
4c374409 | 8355 | |
6d2ebf8b | 8356 | @node Value History |
79a6e687 | 8357 | @section Value History |
c906108c SS |
8358 | |
8359 | @cindex value history | |
9c16f35a | 8360 | @cindex history of values printed by @value{GDBN} |
5d161b24 DB |
8361 | Values printed by the @code{print} command are saved in the @value{GDBN} |
8362 | @dfn{value history}. This allows you to refer to them in other expressions. | |
8363 | Values are kept until the symbol table is re-read or discarded | |
8364 | (for example with the @code{file} or @code{symbol-file} commands). | |
8365 | When the symbol table changes, the value history is discarded, | |
8366 | since the values may contain pointers back to the types defined in the | |
c906108c SS |
8367 | symbol table. |
8368 | ||
8369 | @cindex @code{$} | |
8370 | @cindex @code{$$} | |
8371 | @cindex history number | |
8372 | The values printed are given @dfn{history numbers} by which you can | |
8373 | refer to them. These are successive integers starting with one. | |
8374 | @code{print} shows you the history number assigned to a value by | |
8375 | printing @samp{$@var{num} = } before the value; here @var{num} is the | |
8376 | history number. | |
8377 | ||
8378 | To refer to any previous value, use @samp{$} followed by the value's | |
8379 | history number. The way @code{print} labels its output is designed to | |
8380 | remind you of this. Just @code{$} refers to the most recent value in | |
8381 | the history, and @code{$$} refers to the value before that. | |
8382 | @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2} | |
8383 | is the value just prior to @code{$$}, @code{$$1} is equivalent to | |
8384 | @code{$$}, and @code{$$0} is equivalent to @code{$}. | |
8385 | ||
8386 | For example, suppose you have just printed a pointer to a structure and | |
8387 | want to see the contents of the structure. It suffices to type | |
8388 | ||
474c8240 | 8389 | @smallexample |
c906108c | 8390 | p *$ |
474c8240 | 8391 | @end smallexample |
c906108c SS |
8392 | |
8393 | If you have a chain of structures where the component @code{next} points | |
8394 | to the next one, you can print the contents of the next one with this: | |
8395 | ||
474c8240 | 8396 | @smallexample |
c906108c | 8397 | p *$.next |
474c8240 | 8398 | @end smallexample |
c906108c SS |
8399 | |
8400 | @noindent | |
8401 | You can print successive links in the chain by repeating this | |
8402 | command---which you can do by just typing @key{RET}. | |
8403 | ||
8404 | Note that the history records values, not expressions. If the value of | |
8405 | @code{x} is 4 and you type these commands: | |
8406 | ||
474c8240 | 8407 | @smallexample |
c906108c SS |
8408 | print x |
8409 | set x=5 | |
474c8240 | 8410 | @end smallexample |
c906108c SS |
8411 | |
8412 | @noindent | |
8413 | then the value recorded in the value history by the @code{print} command | |
8414 | remains 4 even though the value of @code{x} has changed. | |
8415 | ||
8416 | @table @code | |
8417 | @kindex show values | |
8418 | @item show values | |
8419 | Print the last ten values in the value history, with their item numbers. | |
8420 | This is like @samp{p@ $$9} repeated ten times, except that @code{show | |
8421 | values} does not change the history. | |
8422 | ||
8423 | @item show values @var{n} | |
8424 | Print ten history values centered on history item number @var{n}. | |
8425 | ||
8426 | @item show values + | |
8427 | Print ten history values just after the values last printed. If no more | |
8428 | values are available, @code{show values +} produces no display. | |
8429 | @end table | |
8430 | ||
8431 | Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the | |
8432 | same effect as @samp{show values +}. | |
8433 | ||
6d2ebf8b | 8434 | @node Convenience Vars |
79a6e687 | 8435 | @section Convenience Variables |
c906108c SS |
8436 | |
8437 | @cindex convenience variables | |
9c16f35a | 8438 | @cindex user-defined variables |
c906108c SS |
8439 | @value{GDBN} provides @dfn{convenience variables} that you can use within |
8440 | @value{GDBN} to hold on to a value and refer to it later. These variables | |
8441 | exist entirely within @value{GDBN}; they are not part of your program, and | |
8442 | setting a convenience variable has no direct effect on further execution | |
8443 | of your program. That is why you can use them freely. | |
8444 | ||
8445 | Convenience variables are prefixed with @samp{$}. Any name preceded by | |
8446 | @samp{$} can be used for a convenience variable, unless it is one of | |
d4f3574e | 8447 | the predefined machine-specific register names (@pxref{Registers, ,Registers}). |
c906108c | 8448 | (Value history references, in contrast, are @emph{numbers} preceded |
79a6e687 | 8449 | by @samp{$}. @xref{Value History, ,Value History}.) |
c906108c SS |
8450 | |
8451 | You can save a value in a convenience variable with an assignment | |
8452 | expression, just as you would set a variable in your program. | |
8453 | For example: | |
8454 | ||
474c8240 | 8455 | @smallexample |
c906108c | 8456 | set $foo = *object_ptr |
474c8240 | 8457 | @end smallexample |
c906108c SS |
8458 | |
8459 | @noindent | |
8460 | would save in @code{$foo} the value contained in the object pointed to by | |
8461 | @code{object_ptr}. | |
8462 | ||
8463 | Using a convenience variable for the first time creates it, but its | |
8464 | value is @code{void} until you assign a new value. You can alter the | |
8465 | value with another assignment at any time. | |
8466 | ||
8467 | Convenience variables have no fixed types. You can assign a convenience | |
8468 | variable any type of value, including structures and arrays, even if | |
8469 | that variable already has a value of a different type. The convenience | |
8470 | variable, when used as an expression, has the type of its current value. | |
8471 | ||
8472 | @table @code | |
8473 | @kindex show convenience | |
9c16f35a | 8474 | @cindex show all user variables |
c906108c SS |
8475 | @item show convenience |
8476 | Print a list of convenience variables used so far, and their values. | |
d4f3574e | 8477 | Abbreviated @code{show conv}. |
53e5f3cf AS |
8478 | |
8479 | @kindex init-if-undefined | |
8480 | @cindex convenience variables, initializing | |
8481 | @item init-if-undefined $@var{variable} = @var{expression} | |
8482 | Set a convenience variable if it has not already been set. This is useful | |
8483 | for user-defined commands that keep some state. It is similar, in concept, | |
8484 | to using local static variables with initializers in C (except that | |
8485 | convenience variables are global). It can also be used to allow users to | |
8486 | override default values used in a command script. | |
8487 | ||
8488 | If the variable is already defined then the expression is not evaluated so | |
8489 | any side-effects do not occur. | |
c906108c SS |
8490 | @end table |
8491 | ||
8492 | One of the ways to use a convenience variable is as a counter to be | |
8493 | incremented or a pointer to be advanced. For example, to print | |
8494 | a field from successive elements of an array of structures: | |
8495 | ||
474c8240 | 8496 | @smallexample |
c906108c SS |
8497 | set $i = 0 |
8498 | print bar[$i++]->contents | |
474c8240 | 8499 | @end smallexample |
c906108c | 8500 | |
d4f3574e SS |
8501 | @noindent |
8502 | Repeat that command by typing @key{RET}. | |
c906108c SS |
8503 | |
8504 | Some convenience variables are created automatically by @value{GDBN} and given | |
8505 | values likely to be useful. | |
8506 | ||
8507 | @table @code | |
41afff9a | 8508 | @vindex $_@r{, convenience variable} |
c906108c SS |
8509 | @item $_ |
8510 | The variable @code{$_} is automatically set by the @code{x} command to | |
79a6e687 | 8511 | the last address examined (@pxref{Memory, ,Examining Memory}). Other |
c906108c SS |
8512 | commands which provide a default address for @code{x} to examine also |
8513 | set @code{$_} to that address; these commands include @code{info line} | |
8514 | and @code{info breakpoint}. The type of @code{$_} is @code{void *} | |
8515 | except when set by the @code{x} command, in which case it is a pointer | |
8516 | to the type of @code{$__}. | |
8517 | ||
41afff9a | 8518 | @vindex $__@r{, convenience variable} |
c906108c SS |
8519 | @item $__ |
8520 | The variable @code{$__} is automatically set by the @code{x} command | |
8521 | to the value found in the last address examined. Its type is chosen | |
8522 | to match the format in which the data was printed. | |
8523 | ||
8524 | @item $_exitcode | |
41afff9a | 8525 | @vindex $_exitcode@r{, convenience variable} |
c906108c SS |
8526 | The variable @code{$_exitcode} is automatically set to the exit code when |
8527 | the program being debugged terminates. | |
4aa995e1 | 8528 | |
0fb4aa4b PA |
8529 | @item $_sdata |
8530 | @vindex $_sdata@r{, inspect, convenience variable} | |
8531 | The variable @code{$_sdata} contains extra collected static tracepoint | |
8532 | data. @xref{Tracepoint Actions,,Tracepoint Action Lists}. Note that | |
8533 | @code{$_sdata} could be empty, if not inspecting a trace buffer, or | |
8534 | if extra static tracepoint data has not been collected. | |
8535 | ||
4aa995e1 PA |
8536 | @item $_siginfo |
8537 | @vindex $_siginfo@r{, convenience variable} | |
ec7e75e7 PP |
8538 | The variable @code{$_siginfo} contains extra signal information |
8539 | (@pxref{extra signal information}). Note that @code{$_siginfo} | |
8540 | could be empty, if the application has not yet received any signals. | |
8541 | For example, it will be empty before you execute the @code{run} command. | |
711e434b PM |
8542 | |
8543 | @item $_tlb | |
8544 | @vindex $_tlb@r{, convenience variable} | |
8545 | The variable @code{$_tlb} is automatically set when debugging | |
8546 | applications running on MS-Windows in native mode or connected to | |
8547 | gdbserver that supports the @code{qGetTIBAddr} request. | |
8548 | @xref{General Query Packets}. | |
8549 | This variable contains the address of the thread information block. | |
8550 | ||
c906108c SS |
8551 | @end table |
8552 | ||
53a5351d JM |
8553 | On HP-UX systems, if you refer to a function or variable name that |
8554 | begins with a dollar sign, @value{GDBN} searches for a user or system | |
8555 | name first, before it searches for a convenience variable. | |
c906108c | 8556 | |
bc3b79fd TJB |
8557 | @cindex convenience functions |
8558 | @value{GDBN} also supplies some @dfn{convenience functions}. These | |
8559 | have a syntax similar to convenience variables. A convenience | |
8560 | function can be used in an expression just like an ordinary function; | |
8561 | however, a convenience function is implemented internally to | |
8562 | @value{GDBN}. | |
8563 | ||
8564 | @table @code | |
8565 | @item help function | |
8566 | @kindex help function | |
8567 | @cindex show all convenience functions | |
8568 | Print a list of all convenience functions. | |
8569 | @end table | |
8570 | ||
6d2ebf8b | 8571 | @node Registers |
c906108c SS |
8572 | @section Registers |
8573 | ||
8574 | @cindex registers | |
8575 | You can refer to machine register contents, in expressions, as variables | |
8576 | with names starting with @samp{$}. The names of registers are different | |
8577 | for each machine; use @code{info registers} to see the names used on | |
8578 | your machine. | |
8579 | ||
8580 | @table @code | |
8581 | @kindex info registers | |
8582 | @item info registers | |
8583 | Print the names and values of all registers except floating-point | |
c85508ee | 8584 | and vector registers (in the selected stack frame). |
c906108c SS |
8585 | |
8586 | @kindex info all-registers | |
8587 | @cindex floating point registers | |
8588 | @item info all-registers | |
8589 | Print the names and values of all registers, including floating-point | |
c85508ee | 8590 | and vector registers (in the selected stack frame). |
c906108c SS |
8591 | |
8592 | @item info registers @var{regname} @dots{} | |
8593 | Print the @dfn{relativized} value of each specified register @var{regname}. | |
5d161b24 DB |
8594 | As discussed in detail below, register values are normally relative to |
8595 | the selected stack frame. @var{regname} may be any register name valid on | |
c906108c SS |
8596 | the machine you are using, with or without the initial @samp{$}. |
8597 | @end table | |
8598 | ||
e09f16f9 EZ |
8599 | @cindex stack pointer register |
8600 | @cindex program counter register | |
8601 | @cindex process status register | |
8602 | @cindex frame pointer register | |
8603 | @cindex standard registers | |
c906108c SS |
8604 | @value{GDBN} has four ``standard'' register names that are available (in |
8605 | expressions) on most machines---whenever they do not conflict with an | |
8606 | architecture's canonical mnemonics for registers. The register names | |
8607 | @code{$pc} and @code{$sp} are used for the program counter register and | |
8608 | the stack pointer. @code{$fp} is used for a register that contains a | |
8609 | pointer to the current stack frame, and @code{$ps} is used for a | |
8610 | register that contains the processor status. For example, | |
8611 | you could print the program counter in hex with | |
8612 | ||
474c8240 | 8613 | @smallexample |
c906108c | 8614 | p/x $pc |
474c8240 | 8615 | @end smallexample |
c906108c SS |
8616 | |
8617 | @noindent | |
8618 | or print the instruction to be executed next with | |
8619 | ||
474c8240 | 8620 | @smallexample |
c906108c | 8621 | x/i $pc |
474c8240 | 8622 | @end smallexample |
c906108c SS |
8623 | |
8624 | @noindent | |
8625 | or add four to the stack pointer@footnote{This is a way of removing | |
8626 | one word from the stack, on machines where stacks grow downward in | |
8627 | memory (most machines, nowadays). This assumes that the innermost | |
8628 | stack frame is selected; setting @code{$sp} is not allowed when other | |
8629 | stack frames are selected. To pop entire frames off the stack, | |
8630 | regardless of machine architecture, use @code{return}; | |
79a6e687 | 8631 | see @ref{Returning, ,Returning from a Function}.} with |
c906108c | 8632 | |
474c8240 | 8633 | @smallexample |
c906108c | 8634 | set $sp += 4 |
474c8240 | 8635 | @end smallexample |
c906108c SS |
8636 | |
8637 | Whenever possible, these four standard register names are available on | |
8638 | your machine even though the machine has different canonical mnemonics, | |
8639 | so long as there is no conflict. The @code{info registers} command | |
8640 | shows the canonical names. For example, on the SPARC, @code{info | |
8641 | registers} displays the processor status register as @code{$psr} but you | |
d4f3574e SS |
8642 | can also refer to it as @code{$ps}; and on x86-based machines @code{$ps} |
8643 | is an alias for the @sc{eflags} register. | |
c906108c SS |
8644 | |
8645 | @value{GDBN} always considers the contents of an ordinary register as an | |
8646 | integer when the register is examined in this way. Some machines have | |
8647 | special registers which can hold nothing but floating point; these | |
8648 | registers are considered to have floating point values. There is no way | |
8649 | to refer to the contents of an ordinary register as floating point value | |
8650 | (although you can @emph{print} it as a floating point value with | |
8651 | @samp{print/f $@var{regname}}). | |
8652 | ||
8653 | Some registers have distinct ``raw'' and ``virtual'' data formats. This | |
8654 | means that the data format in which the register contents are saved by | |
8655 | the operating system is not the same one that your program normally | |
8656 | sees. For example, the registers of the 68881 floating point | |
8657 | coprocessor are always saved in ``extended'' (raw) format, but all C | |
8658 | programs expect to work with ``double'' (virtual) format. In such | |
5d161b24 | 8659 | cases, @value{GDBN} normally works with the virtual format only (the format |
c906108c SS |
8660 | that makes sense for your program), but the @code{info registers} command |
8661 | prints the data in both formats. | |
8662 | ||
36b80e65 EZ |
8663 | @cindex SSE registers (x86) |
8664 | @cindex MMX registers (x86) | |
8665 | Some machines have special registers whose contents can be interpreted | |
8666 | in several different ways. For example, modern x86-based machines | |
8667 | have SSE and MMX registers that can hold several values packed | |
8668 | together in several different formats. @value{GDBN} refers to such | |
8669 | registers in @code{struct} notation: | |
8670 | ||
8671 | @smallexample | |
8672 | (@value{GDBP}) print $xmm1 | |
8673 | $1 = @{ | |
8674 | v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@}, | |
8675 | v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@}, | |
8676 | v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000", | |
8677 | v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@}, | |
8678 | v4_int32 = @{0, 20657912, 11, 13@}, | |
8679 | v2_int64 = @{88725056443645952, 55834574859@}, | |
8680 | uint128 = 0x0000000d0000000b013b36f800000000 | |
8681 | @} | |
8682 | @end smallexample | |
8683 | ||
8684 | @noindent | |
8685 | To set values of such registers, you need to tell @value{GDBN} which | |
8686 | view of the register you wish to change, as if you were assigning | |
8687 | value to a @code{struct} member: | |
8688 | ||
8689 | @smallexample | |
8690 | (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF | |
8691 | @end smallexample | |
8692 | ||
c906108c | 8693 | Normally, register values are relative to the selected stack frame |
79a6e687 | 8694 | (@pxref{Selection, ,Selecting a Frame}). This means that you get the |
c906108c SS |
8695 | value that the register would contain if all stack frames farther in |
8696 | were exited and their saved registers restored. In order to see the | |
8697 | true contents of hardware registers, you must select the innermost | |
8698 | frame (with @samp{frame 0}). | |
8699 | ||
8700 | However, @value{GDBN} must deduce where registers are saved, from the machine | |
8701 | code generated by your compiler. If some registers are not saved, or if | |
8702 | @value{GDBN} is unable to locate the saved registers, the selected stack | |
8703 | frame makes no difference. | |
8704 | ||
6d2ebf8b | 8705 | @node Floating Point Hardware |
79a6e687 | 8706 | @section Floating Point Hardware |
c906108c SS |
8707 | @cindex floating point |
8708 | ||
8709 | Depending on the configuration, @value{GDBN} may be able to give | |
8710 | you more information about the status of the floating point hardware. | |
8711 | ||
8712 | @table @code | |
8713 | @kindex info float | |
8714 | @item info float | |
8715 | Display hardware-dependent information about the floating | |
8716 | point unit. The exact contents and layout vary depending on the | |
8717 | floating point chip. Currently, @samp{info float} is supported on | |
8718 | the ARM and x86 machines. | |
8719 | @end table | |
c906108c | 8720 | |
e76f1f2e AC |
8721 | @node Vector Unit |
8722 | @section Vector Unit | |
8723 | @cindex vector unit | |
8724 | ||
8725 | Depending on the configuration, @value{GDBN} may be able to give you | |
8726 | more information about the status of the vector unit. | |
8727 | ||
8728 | @table @code | |
8729 | @kindex info vector | |
8730 | @item info vector | |
8731 | Display information about the vector unit. The exact contents and | |
8732 | layout vary depending on the hardware. | |
8733 | @end table | |
8734 | ||
721c2651 | 8735 | @node OS Information |
79a6e687 | 8736 | @section Operating System Auxiliary Information |
721c2651 EZ |
8737 | @cindex OS information |
8738 | ||
8739 | @value{GDBN} provides interfaces to useful OS facilities that can help | |
8740 | you debug your program. | |
8741 | ||
8742 | @cindex @code{ptrace} system call | |
8743 | @cindex @code{struct user} contents | |
8744 | When @value{GDBN} runs on a @dfn{Posix system} (such as GNU or Unix | |
8745 | machines), it interfaces with the inferior via the @code{ptrace} | |
8746 | system call. The operating system creates a special sata structure, | |
8747 | called @code{struct user}, for this interface. You can use the | |
8748 | command @code{info udot} to display the contents of this data | |
8749 | structure. | |
8750 | ||
8751 | @table @code | |
8752 | @item info udot | |
8753 | @kindex info udot | |
8754 | Display the contents of the @code{struct user} maintained by the OS | |
8755 | kernel for the program being debugged. @value{GDBN} displays the | |
8756 | contents of @code{struct user} as a list of hex numbers, similar to | |
8757 | the @code{examine} command. | |
8758 | @end table | |
8759 | ||
b383017d RM |
8760 | @cindex auxiliary vector |
8761 | @cindex vector, auxiliary | |
b383017d RM |
8762 | Some operating systems supply an @dfn{auxiliary vector} to programs at |
8763 | startup. This is akin to the arguments and environment that you | |
8764 | specify for a program, but contains a system-dependent variety of | |
8765 | binary values that tell system libraries important details about the | |
8766 | hardware, operating system, and process. Each value's purpose is | |
8767 | identified by an integer tag; the meanings are well-known but system-specific. | |
8768 | Depending on the configuration and operating system facilities, | |
9c16f35a EZ |
8769 | @value{GDBN} may be able to show you this information. For remote |
8770 | targets, this functionality may further depend on the remote stub's | |
427c3a89 DJ |
8771 | support of the @samp{qXfer:auxv:read} packet, see |
8772 | @ref{qXfer auxiliary vector read}. | |
b383017d RM |
8773 | |
8774 | @table @code | |
8775 | @kindex info auxv | |
8776 | @item info auxv | |
8777 | Display the auxiliary vector of the inferior, which can be either a | |
e4937fc1 | 8778 | live process or a core dump file. @value{GDBN} prints each tag value |
b383017d RM |
8779 | numerically, and also shows names and text descriptions for recognized |
8780 | tags. Some values in the vector are numbers, some bit masks, and some | |
e4937fc1 | 8781 | pointers to strings or other data. @value{GDBN} displays each value in the |
b383017d RM |
8782 | most appropriate form for a recognized tag, and in hexadecimal for |
8783 | an unrecognized tag. | |
8784 | @end table | |
8785 | ||
07e059b5 VP |
8786 | On some targets, @value{GDBN} can access operating-system-specific information |
8787 | and display it to user, without interpretation. For remote targets, | |
8788 | this functionality depends on the remote stub's support of the | |
8789 | @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}. | |
8790 | ||
8791 | @table @code | |
a61408f8 SS |
8792 | @kindex info os |
8793 | @item info os | |
8794 | List the types of OS information available for the target. If the | |
8795 | target does not return a list of possible types, this command will | |
8796 | report an error. | |
8797 | ||
07e059b5 VP |
8798 | @kindex info os processes |
8799 | @item info os processes | |
8800 | Display the list of processes on the target. For each process, | |
8801 | @value{GDBN} prints the process identifier, the name of the user, and | |
8802 | the command corresponding to the process. | |
8803 | @end table | |
721c2651 | 8804 | |
29e57380 | 8805 | @node Memory Region Attributes |
79a6e687 | 8806 | @section Memory Region Attributes |
29e57380 C |
8807 | @cindex memory region attributes |
8808 | ||
b383017d | 8809 | @dfn{Memory region attributes} allow you to describe special handling |
fd79ecee DJ |
8810 | required by regions of your target's memory. @value{GDBN} uses |
8811 | attributes to determine whether to allow certain types of memory | |
8812 | accesses; whether to use specific width accesses; and whether to cache | |
8813 | target memory. By default the description of memory regions is | |
8814 | fetched from the target (if the current target supports this), but the | |
8815 | user can override the fetched regions. | |
29e57380 C |
8816 | |
8817 | Defined memory regions can be individually enabled and disabled. When a | |
8818 | memory region is disabled, @value{GDBN} uses the default attributes when | |
8819 | accessing memory in that region. Similarly, if no memory regions have | |
8820 | been defined, @value{GDBN} uses the default attributes when accessing | |
8821 | all memory. | |
8822 | ||
b383017d | 8823 | When a memory region is defined, it is given a number to identify it; |
29e57380 C |
8824 | to enable, disable, or remove a memory region, you specify that number. |
8825 | ||
8826 | @table @code | |
8827 | @kindex mem | |
bfac230e | 8828 | @item mem @var{lower} @var{upper} @var{attributes}@dots{} |
09d4efe1 EZ |
8829 | Define a memory region bounded by @var{lower} and @var{upper} with |
8830 | attributes @var{attributes}@dots{}, and add it to the list of regions | |
8831 | monitored by @value{GDBN}. Note that @var{upper} == 0 is a special | |
d3e8051b | 8832 | case: it is treated as the target's maximum memory address. |
bfac230e | 8833 | (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.) |
29e57380 | 8834 | |
fd79ecee DJ |
8835 | @item mem auto |
8836 | Discard any user changes to the memory regions and use target-supplied | |
8837 | regions, if available, or no regions if the target does not support. | |
8838 | ||
29e57380 C |
8839 | @kindex delete mem |
8840 | @item delete mem @var{nums}@dots{} | |
09d4efe1 EZ |
8841 | Remove memory regions @var{nums}@dots{} from the list of regions |
8842 | monitored by @value{GDBN}. | |
29e57380 C |
8843 | |
8844 | @kindex disable mem | |
8845 | @item disable mem @var{nums}@dots{} | |
09d4efe1 | 8846 | Disable monitoring of memory regions @var{nums}@dots{}. |
b383017d | 8847 | A disabled memory region is not forgotten. |
29e57380 C |
8848 | It may be enabled again later. |
8849 | ||
8850 | @kindex enable mem | |
8851 | @item enable mem @var{nums}@dots{} | |
09d4efe1 | 8852 | Enable monitoring of memory regions @var{nums}@dots{}. |
29e57380 C |
8853 | |
8854 | @kindex info mem | |
8855 | @item info mem | |
8856 | Print a table of all defined memory regions, with the following columns | |
09d4efe1 | 8857 | for each region: |
29e57380 C |
8858 | |
8859 | @table @emph | |
8860 | @item Memory Region Number | |
8861 | @item Enabled or Disabled. | |
b383017d | 8862 | Enabled memory regions are marked with @samp{y}. |
29e57380 C |
8863 | Disabled memory regions are marked with @samp{n}. |
8864 | ||
8865 | @item Lo Address | |
8866 | The address defining the inclusive lower bound of the memory region. | |
8867 | ||
8868 | @item Hi Address | |
8869 | The address defining the exclusive upper bound of the memory region. | |
8870 | ||
8871 | @item Attributes | |
8872 | The list of attributes set for this memory region. | |
8873 | @end table | |
8874 | @end table | |
8875 | ||
8876 | ||
8877 | @subsection Attributes | |
8878 | ||
b383017d | 8879 | @subsubsection Memory Access Mode |
29e57380 C |
8880 | The access mode attributes set whether @value{GDBN} may make read or |
8881 | write accesses to a memory region. | |
8882 | ||
8883 | While these attributes prevent @value{GDBN} from performing invalid | |
8884 | memory accesses, they do nothing to prevent the target system, I/O DMA, | |
359df76b | 8885 | etc.@: from accessing memory. |
29e57380 C |
8886 | |
8887 | @table @code | |
8888 | @item ro | |
8889 | Memory is read only. | |
8890 | @item wo | |
8891 | Memory is write only. | |
8892 | @item rw | |
6ca652b0 | 8893 | Memory is read/write. This is the default. |
29e57380 C |
8894 | @end table |
8895 | ||
8896 | @subsubsection Memory Access Size | |
d3e8051b | 8897 | The access size attribute tells @value{GDBN} to use specific sized |
29e57380 C |
8898 | accesses in the memory region. Often memory mapped device registers |
8899 | require specific sized accesses. If no access size attribute is | |
8900 | specified, @value{GDBN} may use accesses of any size. | |
8901 | ||
8902 | @table @code | |
8903 | @item 8 | |
8904 | Use 8 bit memory accesses. | |
8905 | @item 16 | |
8906 | Use 16 bit memory accesses. | |
8907 | @item 32 | |
8908 | Use 32 bit memory accesses. | |
8909 | @item 64 | |
8910 | Use 64 bit memory accesses. | |
8911 | @end table | |
8912 | ||
8913 | @c @subsubsection Hardware/Software Breakpoints | |
8914 | @c The hardware/software breakpoint attributes set whether @value{GDBN} | |
8915 | @c will use hardware or software breakpoints for the internal breakpoints | |
8916 | @c used by the step, next, finish, until, etc. commands. | |
8917 | @c | |
8918 | @c @table @code | |
8919 | @c @item hwbreak | |
b383017d | 8920 | @c Always use hardware breakpoints |
29e57380 C |
8921 | @c @item swbreak (default) |
8922 | @c @end table | |
8923 | ||
8924 | @subsubsection Data Cache | |
8925 | The data cache attributes set whether @value{GDBN} will cache target | |
8926 | memory. While this generally improves performance by reducing debug | |
8927 | protocol overhead, it can lead to incorrect results because @value{GDBN} | |
8928 | does not know about volatile variables or memory mapped device | |
8929 | registers. | |
8930 | ||
8931 | @table @code | |
8932 | @item cache | |
b383017d | 8933 | Enable @value{GDBN} to cache target memory. |
6ca652b0 EZ |
8934 | @item nocache |
8935 | Disable @value{GDBN} from caching target memory. This is the default. | |
29e57380 C |
8936 | @end table |
8937 | ||
4b5752d0 VP |
8938 | @subsection Memory Access Checking |
8939 | @value{GDBN} can be instructed to refuse accesses to memory that is | |
8940 | not explicitly described. This can be useful if accessing such | |
8941 | regions has undesired effects for a specific target, or to provide | |
8942 | better error checking. The following commands control this behaviour. | |
8943 | ||
8944 | @table @code | |
8945 | @kindex set mem inaccessible-by-default | |
8946 | @item set mem inaccessible-by-default [on|off] | |
8947 | If @code{on} is specified, make @value{GDBN} treat memory not | |
8948 | explicitly described by the memory ranges as non-existent and refuse accesses | |
8949 | to such memory. The checks are only performed if there's at least one | |
8950 | memory range defined. If @code{off} is specified, make @value{GDBN} | |
8951 | treat the memory not explicitly described by the memory ranges as RAM. | |
56cf5405 | 8952 | The default value is @code{on}. |
4b5752d0 VP |
8953 | @kindex show mem inaccessible-by-default |
8954 | @item show mem inaccessible-by-default | |
8955 | Show the current handling of accesses to unknown memory. | |
8956 | @end table | |
8957 | ||
8958 | ||
29e57380 | 8959 | @c @subsubsection Memory Write Verification |
b383017d | 8960 | @c The memory write verification attributes set whether @value{GDBN} |
29e57380 C |
8961 | @c will re-reads data after each write to verify the write was successful. |
8962 | @c | |
8963 | @c @table @code | |
8964 | @c @item verify | |
8965 | @c @item noverify (default) | |
8966 | @c @end table | |
8967 | ||
16d9dec6 | 8968 | @node Dump/Restore Files |
79a6e687 | 8969 | @section Copy Between Memory and a File |
16d9dec6 MS |
8970 | @cindex dump/restore files |
8971 | @cindex append data to a file | |
8972 | @cindex dump data to a file | |
8973 | @cindex restore data from a file | |
16d9dec6 | 8974 | |
df5215a6 JB |
8975 | You can use the commands @code{dump}, @code{append}, and |
8976 | @code{restore} to copy data between target memory and a file. The | |
8977 | @code{dump} and @code{append} commands write data to a file, and the | |
8978 | @code{restore} command reads data from a file back into the inferior's | |
8979 | memory. Files may be in binary, Motorola S-record, Intel hex, or | |
8980 | Tektronix Hex format; however, @value{GDBN} can only append to binary | |
8981 | files. | |
8982 | ||
8983 | @table @code | |
8984 | ||
8985 | @kindex dump | |
8986 | @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr} | |
8987 | @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr} | |
8988 | Dump the contents of memory from @var{start_addr} to @var{end_addr}, | |
8989 | or the value of @var{expr}, to @var{filename} in the given format. | |
16d9dec6 | 8990 | |
df5215a6 | 8991 | The @var{format} parameter may be any one of: |
16d9dec6 | 8992 | @table @code |
df5215a6 JB |
8993 | @item binary |
8994 | Raw binary form. | |
8995 | @item ihex | |
8996 | Intel hex format. | |
8997 | @item srec | |
8998 | Motorola S-record format. | |
8999 | @item tekhex | |
9000 | Tektronix Hex format. | |
9001 | @end table | |
9002 | ||
9003 | @value{GDBN} uses the same definitions of these formats as the | |
9004 | @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If | |
9005 | @var{format} is omitted, @value{GDBN} dumps the data in raw binary | |
9006 | form. | |
9007 | ||
9008 | @kindex append | |
9009 | @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr} | |
9010 | @itemx append @r{[}binary@r{]} value @var{filename} @var{expr} | |
9011 | Append the contents of memory from @var{start_addr} to @var{end_addr}, | |
09d4efe1 | 9012 | or the value of @var{expr}, to the file @var{filename}, in raw binary form. |
df5215a6 JB |
9013 | (@value{GDBN} can only append data to files in raw binary form.) |
9014 | ||
9015 | @kindex restore | |
9016 | @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end} | |
9017 | Restore the contents of file @var{filename} into memory. The | |
9018 | @code{restore} command can automatically recognize any known @sc{bfd} | |
9019 | file format, except for raw binary. To restore a raw binary file you | |
9020 | must specify the optional keyword @code{binary} after the filename. | |
16d9dec6 | 9021 | |
b383017d | 9022 | If @var{bias} is non-zero, its value will be added to the addresses |
16d9dec6 MS |
9023 | contained in the file. Binary files always start at address zero, so |
9024 | they will be restored at address @var{bias}. Other bfd files have | |
9025 | a built-in location; they will be restored at offset @var{bias} | |
9026 | from that location. | |
9027 | ||
9028 | If @var{start} and/or @var{end} are non-zero, then only data between | |
9029 | file offset @var{start} and file offset @var{end} will be restored. | |
b383017d | 9030 | These offsets are relative to the addresses in the file, before |
16d9dec6 MS |
9031 | the @var{bias} argument is applied. |
9032 | ||
9033 | @end table | |
9034 | ||
384ee23f EZ |
9035 | @node Core File Generation |
9036 | @section How to Produce a Core File from Your Program | |
9037 | @cindex dump core from inferior | |
9038 | ||
9039 | A @dfn{core file} or @dfn{core dump} is a file that records the memory | |
9040 | image of a running process and its process status (register values | |
9041 | etc.). Its primary use is post-mortem debugging of a program that | |
9042 | crashed while it ran outside a debugger. A program that crashes | |
9043 | automatically produces a core file, unless this feature is disabled by | |
9044 | the user. @xref{Files}, for information on invoking @value{GDBN} in | |
9045 | the post-mortem debugging mode. | |
9046 | ||
9047 | Occasionally, you may wish to produce a core file of the program you | |
9048 | are debugging in order to preserve a snapshot of its state. | |
9049 | @value{GDBN} has a special command for that. | |
9050 | ||
9051 | @table @code | |
9052 | @kindex gcore | |
9053 | @kindex generate-core-file | |
9054 | @item generate-core-file [@var{file}] | |
9055 | @itemx gcore [@var{file}] | |
9056 | Produce a core dump of the inferior process. The optional argument | |
9057 | @var{file} specifies the file name where to put the core dump. If not | |
9058 | specified, the file name defaults to @file{core.@var{pid}}, where | |
9059 | @var{pid} is the inferior process ID. | |
9060 | ||
9061 | Note that this command is implemented only for some systems (as of | |
9062 | this writing, @sc{gnu}/Linux, FreeBSD, Solaris, Unixware, and S390). | |
9063 | @end table | |
9064 | ||
a0eb71c5 KB |
9065 | @node Character Sets |
9066 | @section Character Sets | |
9067 | @cindex character sets | |
9068 | @cindex charset | |
9069 | @cindex translating between character sets | |
9070 | @cindex host character set | |
9071 | @cindex target character set | |
9072 | ||
9073 | If the program you are debugging uses a different character set to | |
9074 | represent characters and strings than the one @value{GDBN} uses itself, | |
9075 | @value{GDBN} can automatically translate between the character sets for | |
9076 | you. The character set @value{GDBN} uses we call the @dfn{host | |
9077 | character set}; the one the inferior program uses we call the | |
9078 | @dfn{target character set}. | |
9079 | ||
9080 | For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which | |
9081 | uses the ISO Latin 1 character set, but you are using @value{GDBN}'s | |
ea35711c | 9082 | remote protocol (@pxref{Remote Debugging}) to debug a program |
a0eb71c5 KB |
9083 | running on an IBM mainframe, which uses the @sc{ebcdic} character set, |
9084 | then the host character set is Latin-1, and the target character set is | |
9085 | @sc{ebcdic}. If you give @value{GDBN} the command @code{set | |
e33d66ec | 9086 | target-charset EBCDIC-US}, then @value{GDBN} translates between |
a0eb71c5 KB |
9087 | @sc{ebcdic} and Latin 1 as you print character or string values, or use |
9088 | character and string literals in expressions. | |
9089 | ||
9090 | @value{GDBN} has no way to automatically recognize which character set | |
9091 | the inferior program uses; you must tell it, using the @code{set | |
9092 | target-charset} command, described below. | |
9093 | ||
9094 | Here are the commands for controlling @value{GDBN}'s character set | |
9095 | support: | |
9096 | ||
9097 | @table @code | |
9098 | @item set target-charset @var{charset} | |
9099 | @kindex set target-charset | |
10af6951 EZ |
9100 | Set the current target character set to @var{charset}. To display the |
9101 | list of supported target character sets, type | |
9102 | @kbd{@w{set target-charset @key{TAB}@key{TAB}}}. | |
a0eb71c5 | 9103 | |
a0eb71c5 KB |
9104 | @item set host-charset @var{charset} |
9105 | @kindex set host-charset | |
9106 | Set the current host character set to @var{charset}. | |
9107 | ||
9108 | By default, @value{GDBN} uses a host character set appropriate to the | |
9109 | system it is running on; you can override that default using the | |
732f6a93 TT |
9110 | @code{set host-charset} command. On some systems, @value{GDBN} cannot |
9111 | automatically determine the appropriate host character set. In this | |
9112 | case, @value{GDBN} uses @samp{UTF-8}. | |
a0eb71c5 KB |
9113 | |
9114 | @value{GDBN} can only use certain character sets as its host character | |
c1b6b909 | 9115 | set. If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}}, |
10af6951 | 9116 | @value{GDBN} will list the host character sets it supports. |
a0eb71c5 KB |
9117 | |
9118 | @item set charset @var{charset} | |
9119 | @kindex set charset | |
e33d66ec | 9120 | Set the current host and target character sets to @var{charset}. As |
10af6951 EZ |
9121 | above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}}, |
9122 | @value{GDBN} will list the names of the character sets that can be used | |
e33d66ec EZ |
9123 | for both host and target. |
9124 | ||
a0eb71c5 | 9125 | @item show charset |
a0eb71c5 | 9126 | @kindex show charset |
10af6951 | 9127 | Show the names of the current host and target character sets. |
e33d66ec | 9128 | |
10af6951 | 9129 | @item show host-charset |
a0eb71c5 | 9130 | @kindex show host-charset |
10af6951 | 9131 | Show the name of the current host character set. |
e33d66ec | 9132 | |
10af6951 | 9133 | @item show target-charset |
a0eb71c5 | 9134 | @kindex show target-charset |
10af6951 | 9135 | Show the name of the current target character set. |
a0eb71c5 | 9136 | |
10af6951 EZ |
9137 | @item set target-wide-charset @var{charset} |
9138 | @kindex set target-wide-charset | |
9139 | Set the current target's wide character set to @var{charset}. This is | |
9140 | the character set used by the target's @code{wchar_t} type. To | |
9141 | display the list of supported wide character sets, type | |
9142 | @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}. | |
9143 | ||
9144 | @item show target-wide-charset | |
9145 | @kindex show target-wide-charset | |
9146 | Show the name of the current target's wide character set. | |
a0eb71c5 KB |
9147 | @end table |
9148 | ||
a0eb71c5 KB |
9149 | Here is an example of @value{GDBN}'s character set support in action. |
9150 | Assume that the following source code has been placed in the file | |
9151 | @file{charset-test.c}: | |
9152 | ||
9153 | @smallexample | |
9154 | #include <stdio.h> | |
9155 | ||
9156 | char ascii_hello[] | |
9157 | = @{72, 101, 108, 108, 111, 44, 32, 119, | |
9158 | 111, 114, 108, 100, 33, 10, 0@}; | |
9159 | char ibm1047_hello[] | |
9160 | = @{200, 133, 147, 147, 150, 107, 64, 166, | |
9161 | 150, 153, 147, 132, 90, 37, 0@}; | |
9162 | ||
9163 | main () | |
9164 | @{ | |
9165 | printf ("Hello, world!\n"); | |
9166 | @} | |
10998722 | 9167 | @end smallexample |
a0eb71c5 KB |
9168 | |
9169 | In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays | |
9170 | containing the string @samp{Hello, world!} followed by a newline, | |
9171 | encoded in the @sc{ascii} and @sc{ibm1047} character sets. | |
9172 | ||
9173 | We compile the program, and invoke the debugger on it: | |
9174 | ||
9175 | @smallexample | |
9176 | $ gcc -g charset-test.c -o charset-test | |
9177 | $ gdb -nw charset-test | |
9178 | GNU gdb 2001-12-19-cvs | |
9179 | Copyright 2001 Free Software Foundation, Inc. | |
9180 | @dots{} | |
f7dc1244 | 9181 | (@value{GDBP}) |
10998722 | 9182 | @end smallexample |
a0eb71c5 KB |
9183 | |
9184 | We can use the @code{show charset} command to see what character sets | |
9185 | @value{GDBN} is currently using to interpret and display characters and | |
9186 | strings: | |
9187 | ||
9188 | @smallexample | |
f7dc1244 | 9189 | (@value{GDBP}) show charset |
e33d66ec | 9190 | The current host and target character set is `ISO-8859-1'. |
f7dc1244 | 9191 | (@value{GDBP}) |
10998722 | 9192 | @end smallexample |
a0eb71c5 KB |
9193 | |
9194 | For the sake of printing this manual, let's use @sc{ascii} as our | |
9195 | initial character set: | |
9196 | @smallexample | |
f7dc1244 EZ |
9197 | (@value{GDBP}) set charset ASCII |
9198 | (@value{GDBP}) show charset | |
e33d66ec | 9199 | The current host and target character set is `ASCII'. |
f7dc1244 | 9200 | (@value{GDBP}) |
10998722 | 9201 | @end smallexample |
a0eb71c5 KB |
9202 | |
9203 | Let's assume that @sc{ascii} is indeed the correct character set for our | |
9204 | host system --- in other words, let's assume that if @value{GDBN} prints | |
9205 | characters using the @sc{ascii} character set, our terminal will display | |
9206 | them properly. Since our current target character set is also | |
9207 | @sc{ascii}, the contents of @code{ascii_hello} print legibly: | |
9208 | ||
9209 | @smallexample | |
f7dc1244 | 9210 | (@value{GDBP}) print ascii_hello |
a0eb71c5 | 9211 | $1 = 0x401698 "Hello, world!\n" |
f7dc1244 | 9212 | (@value{GDBP}) print ascii_hello[0] |
a0eb71c5 | 9213 | $2 = 72 'H' |
f7dc1244 | 9214 | (@value{GDBP}) |
10998722 | 9215 | @end smallexample |
a0eb71c5 KB |
9216 | |
9217 | @value{GDBN} uses the target character set for character and string | |
9218 | literals you use in expressions: | |
9219 | ||
9220 | @smallexample | |
f7dc1244 | 9221 | (@value{GDBP}) print '+' |
a0eb71c5 | 9222 | $3 = 43 '+' |
f7dc1244 | 9223 | (@value{GDBP}) |
10998722 | 9224 | @end smallexample |
a0eb71c5 KB |
9225 | |
9226 | The @sc{ascii} character set uses the number 43 to encode the @samp{+} | |
9227 | character. | |
9228 | ||
9229 | @value{GDBN} relies on the user to tell it which character set the | |
9230 | target program uses. If we print @code{ibm1047_hello} while our target | |
9231 | character set is still @sc{ascii}, we get jibberish: | |
9232 | ||
9233 | @smallexample | |
f7dc1244 | 9234 | (@value{GDBP}) print ibm1047_hello |
a0eb71c5 | 9235 | $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%" |
f7dc1244 | 9236 | (@value{GDBP}) print ibm1047_hello[0] |
a0eb71c5 | 9237 | $5 = 200 '\310' |
f7dc1244 | 9238 | (@value{GDBP}) |
10998722 | 9239 | @end smallexample |
a0eb71c5 | 9240 | |
e33d66ec | 9241 | If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB}, |
a0eb71c5 KB |
9242 | @value{GDBN} tells us the character sets it supports: |
9243 | ||
9244 | @smallexample | |
f7dc1244 | 9245 | (@value{GDBP}) set target-charset |
b383017d | 9246 | ASCII EBCDIC-US IBM1047 ISO-8859-1 |
f7dc1244 | 9247 | (@value{GDBP}) set target-charset |
10998722 | 9248 | @end smallexample |
a0eb71c5 KB |
9249 | |
9250 | We can select @sc{ibm1047} as our target character set, and examine the | |
9251 | program's strings again. Now the @sc{ascii} string is wrong, but | |
9252 | @value{GDBN} translates the contents of @code{ibm1047_hello} from the | |
9253 | target character set, @sc{ibm1047}, to the host character set, | |
9254 | @sc{ascii}, and they display correctly: | |
9255 | ||
9256 | @smallexample | |
f7dc1244 EZ |
9257 | (@value{GDBP}) set target-charset IBM1047 |
9258 | (@value{GDBP}) show charset | |
e33d66ec EZ |
9259 | The current host character set is `ASCII'. |
9260 | The current target character set is `IBM1047'. | |
f7dc1244 | 9261 | (@value{GDBP}) print ascii_hello |
a0eb71c5 | 9262 | $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012" |
f7dc1244 | 9263 | (@value{GDBP}) print ascii_hello[0] |
a0eb71c5 | 9264 | $7 = 72 '\110' |
f7dc1244 | 9265 | (@value{GDBP}) print ibm1047_hello |
a0eb71c5 | 9266 | $8 = 0x4016a8 "Hello, world!\n" |
f7dc1244 | 9267 | (@value{GDBP}) print ibm1047_hello[0] |
a0eb71c5 | 9268 | $9 = 200 'H' |
f7dc1244 | 9269 | (@value{GDBP}) |
10998722 | 9270 | @end smallexample |
a0eb71c5 KB |
9271 | |
9272 | As above, @value{GDBN} uses the target character set for character and | |
9273 | string literals you use in expressions: | |
9274 | ||
9275 | @smallexample | |
f7dc1244 | 9276 | (@value{GDBP}) print '+' |
a0eb71c5 | 9277 | $10 = 78 '+' |
f7dc1244 | 9278 | (@value{GDBP}) |
10998722 | 9279 | @end smallexample |
a0eb71c5 | 9280 | |
e33d66ec | 9281 | The @sc{ibm1047} character set uses the number 78 to encode the @samp{+} |
a0eb71c5 KB |
9282 | character. |
9283 | ||
09d4efe1 EZ |
9284 | @node Caching Remote Data |
9285 | @section Caching Data of Remote Targets | |
9286 | @cindex caching data of remote targets | |
9287 | ||
4e5d721f | 9288 | @value{GDBN} caches data exchanged between the debugger and a |
ea35711c | 9289 | remote target (@pxref{Remote Debugging}). Such caching generally improves |
09d4efe1 | 9290 | performance, because it reduces the overhead of the remote protocol by |
4e5d721f DE |
9291 | bundling memory reads and writes into large chunks. Unfortunately, simply |
9292 | caching everything would lead to incorrect results, since @value{GDBN} | |
9293 | does not necessarily know anything about volatile values, memory-mapped I/O | |
29b090c0 DE |
9294 | addresses, etc. Furthermore, in non-stop mode (@pxref{Non-Stop Mode}) |
9295 | memory can be changed @emph{while} a gdb command is executing. | |
9296 | Therefore, by default, @value{GDBN} only caches data | |
9297 | known to be on the stack@footnote{In non-stop mode, it is moderately | |
9298 | rare for a running thread to modify the stack of a stopped thread | |
9299 | in a way that would interfere with a backtrace, and caching of | |
9300 | stack reads provides a significant speed up of remote backtraces.}. | |
9301 | Other regions of memory can be explicitly marked as | |
4e5d721f | 9302 | cacheable; see @pxref{Memory Region Attributes}. |
09d4efe1 EZ |
9303 | |
9304 | @table @code | |
9305 | @kindex set remotecache | |
9306 | @item set remotecache on | |
9307 | @itemx set remotecache off | |
4e5d721f DE |
9308 | This option no longer does anything; it exists for compatibility |
9309 | with old scripts. | |
09d4efe1 EZ |
9310 | |
9311 | @kindex show remotecache | |
9312 | @item show remotecache | |
4e5d721f DE |
9313 | Show the current state of the obsolete remotecache flag. |
9314 | ||
9315 | @kindex set stack-cache | |
9316 | @item set stack-cache on | |
9317 | @itemx set stack-cache off | |
9318 | Enable or disable caching of stack accesses. When @code{ON}, use | |
9319 | caching. By default, this option is @code{ON}. | |
9320 | ||
9321 | @kindex show stack-cache | |
9322 | @item show stack-cache | |
9323 | Show the current state of data caching for memory accesses. | |
09d4efe1 EZ |
9324 | |
9325 | @kindex info dcache | |
4e5d721f | 9326 | @item info dcache @r{[}line@r{]} |
09d4efe1 | 9327 | Print the information about the data cache performance. The |
4e5d721f DE |
9328 | information displayed includes the dcache width and depth, and for |
9329 | each cache line, its number, address, and how many times it was | |
9330 | referenced. This command is useful for debugging the data cache | |
9331 | operation. | |
9332 | ||
9333 | If a line number is specified, the contents of that line will be | |
9334 | printed in hex. | |
09d4efe1 EZ |
9335 | @end table |
9336 | ||
08388c79 DE |
9337 | @node Searching Memory |
9338 | @section Search Memory | |
9339 | @cindex searching memory | |
9340 | ||
9341 | Memory can be searched for a particular sequence of bytes with the | |
9342 | @code{find} command. | |
9343 | ||
9344 | @table @code | |
9345 | @kindex find | |
9346 | @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]} | |
9347 | @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]} | |
9348 | Search memory for the sequence of bytes specified by @var{val1}, @var{val2}, | |
9349 | etc. The search begins at address @var{start_addr} and continues for either | |
9350 | @var{len} bytes or through to @var{end_addr} inclusive. | |
9351 | @end table | |
9352 | ||
9353 | @var{s} and @var{n} are optional parameters. | |
9354 | They may be specified in either order, apart or together. | |
9355 | ||
9356 | @table @r | |
9357 | @item @var{s}, search query size | |
9358 | The size of each search query value. | |
9359 | ||
9360 | @table @code | |
9361 | @item b | |
9362 | bytes | |
9363 | @item h | |
9364 | halfwords (two bytes) | |
9365 | @item w | |
9366 | words (four bytes) | |
9367 | @item g | |
9368 | giant words (eight bytes) | |
9369 | @end table | |
9370 | ||
9371 | All values are interpreted in the current language. | |
9372 | This means, for example, that if the current source language is C/C@t{++} | |
9373 | then searching for the string ``hello'' includes the trailing '\0'. | |
9374 | ||
9375 | If the value size is not specified, it is taken from the | |
9376 | value's type in the current language. | |
9377 | This is useful when one wants to specify the search | |
9378 | pattern as a mixture of types. | |
9379 | Note that this means, for example, that in the case of C-like languages | |
9380 | a search for an untyped 0x42 will search for @samp{(int) 0x42} | |
9381 | which is typically four bytes. | |
9382 | ||
9383 | @item @var{n}, maximum number of finds | |
9384 | The maximum number of matches to print. The default is to print all finds. | |
9385 | @end table | |
9386 | ||
9387 | You can use strings as search values. Quote them with double-quotes | |
9388 | (@code{"}). | |
9389 | The string value is copied into the search pattern byte by byte, | |
9390 | regardless of the endianness of the target and the size specification. | |
9391 | ||
9392 | The address of each match found is printed as well as a count of the | |
9393 | number of matches found. | |
9394 | ||
9395 | The address of the last value found is stored in convenience variable | |
9396 | @samp{$_}. | |
9397 | A count of the number of matches is stored in @samp{$numfound}. | |
9398 | ||
9399 | For example, if stopped at the @code{printf} in this function: | |
9400 | ||
9401 | @smallexample | |
9402 | void | |
9403 | hello () | |
9404 | @{ | |
9405 | static char hello[] = "hello-hello"; | |
9406 | static struct @{ char c; short s; int i; @} | |
9407 | __attribute__ ((packed)) mixed | |
9408 | = @{ 'c', 0x1234, 0x87654321 @}; | |
9409 | printf ("%s\n", hello); | |
9410 | @} | |
9411 | @end smallexample | |
9412 | ||
9413 | @noindent | |
9414 | you get during debugging: | |
9415 | ||
9416 | @smallexample | |
9417 | (gdb) find &hello[0], +sizeof(hello), "hello" | |
9418 | 0x804956d <hello.1620+6> | |
9419 | 1 pattern found | |
9420 | (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o' | |
9421 | 0x8049567 <hello.1620> | |
9422 | 0x804956d <hello.1620+6> | |
9423 | 2 patterns found | |
9424 | (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l' | |
9425 | 0x8049567 <hello.1620> | |
9426 | 1 pattern found | |
9427 | (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321 | |
9428 | 0x8049560 <mixed.1625> | |
9429 | 1 pattern found | |
9430 | (gdb) print $numfound | |
9431 | $1 = 1 | |
9432 | (gdb) print $_ | |
9433 | $2 = (void *) 0x8049560 | |
9434 | @end smallexample | |
a0eb71c5 | 9435 | |
edb3359d DJ |
9436 | @node Optimized Code |
9437 | @chapter Debugging Optimized Code | |
9438 | @cindex optimized code, debugging | |
9439 | @cindex debugging optimized code | |
9440 | ||
9441 | Almost all compilers support optimization. With optimization | |
9442 | disabled, the compiler generates assembly code that corresponds | |
9443 | directly to your source code, in a simplistic way. As the compiler | |
9444 | applies more powerful optimizations, the generated assembly code | |
9445 | diverges from your original source code. With help from debugging | |
9446 | information generated by the compiler, @value{GDBN} can map from | |
9447 | the running program back to constructs from your original source. | |
9448 | ||
9449 | @value{GDBN} is more accurate with optimization disabled. If you | |
9450 | can recompile without optimization, it is easier to follow the | |
9451 | progress of your program during debugging. But, there are many cases | |
9452 | where you may need to debug an optimized version. | |
9453 | ||
9454 | When you debug a program compiled with @samp{-g -O}, remember that the | |
9455 | optimizer has rearranged your code; the debugger shows you what is | |
9456 | really there. Do not be too surprised when the execution path does not | |
9457 | exactly match your source file! An extreme example: if you define a | |
9458 | variable, but never use it, @value{GDBN} never sees that | |
9459 | variable---because the compiler optimizes it out of existence. | |
9460 | ||
9461 | Some things do not work as well with @samp{-g -O} as with just | |
9462 | @samp{-g}, particularly on machines with instruction scheduling. If in | |
9463 | doubt, recompile with @samp{-g} alone, and if this fixes the problem, | |
9464 | please report it to us as a bug (including a test case!). | |
9465 | @xref{Variables}, for more information about debugging optimized code. | |
9466 | ||
9467 | @menu | |
9468 | * Inline Functions:: How @value{GDBN} presents inlining | |
9469 | @end menu | |
9470 | ||
9471 | @node Inline Functions | |
9472 | @section Inline Functions | |
9473 | @cindex inline functions, debugging | |
9474 | ||
9475 | @dfn{Inlining} is an optimization that inserts a copy of the function | |
9476 | body directly at each call site, instead of jumping to a shared | |
9477 | routine. @value{GDBN} displays inlined functions just like | |
9478 | non-inlined functions. They appear in backtraces. You can view their | |
9479 | arguments and local variables, step into them with @code{step}, skip | |
9480 | them with @code{next}, and escape from them with @code{finish}. | |
9481 | You can check whether a function was inlined by using the | |
9482 | @code{info frame} command. | |
9483 | ||
9484 | For @value{GDBN} to support inlined functions, the compiler must | |
9485 | record information about inlining in the debug information --- | |
9486 | @value{NGCC} using the @sc{dwarf 2} format does this, and several | |
9487 | other compilers do also. @value{GDBN} only supports inlined functions | |
9488 | when using @sc{dwarf 2}. Versions of @value{NGCC} before 4.1 | |
9489 | do not emit two required attributes (@samp{DW_AT_call_file} and | |
9490 | @samp{DW_AT_call_line}); @value{GDBN} does not display inlined | |
9491 | function calls with earlier versions of @value{NGCC}. It instead | |
9492 | displays the arguments and local variables of inlined functions as | |
9493 | local variables in the caller. | |
9494 | ||
9495 | The body of an inlined function is directly included at its call site; | |
9496 | unlike a non-inlined function, there are no instructions devoted to | |
9497 | the call. @value{GDBN} still pretends that the call site and the | |
9498 | start of the inlined function are different instructions. Stepping to | |
9499 | the call site shows the call site, and then stepping again shows | |
9500 | the first line of the inlined function, even though no additional | |
9501 | instructions are executed. | |
9502 | ||
9503 | This makes source-level debugging much clearer; you can see both the | |
9504 | context of the call and then the effect of the call. Only stepping by | |
9505 | a single instruction using @code{stepi} or @code{nexti} does not do | |
9506 | this; single instruction steps always show the inlined body. | |
9507 | ||
9508 | There are some ways that @value{GDBN} does not pretend that inlined | |
9509 | function calls are the same as normal calls: | |
9510 | ||
9511 | @itemize @bullet | |
9512 | @item | |
9513 | You cannot set breakpoints on inlined functions. @value{GDBN} | |
9514 | either reports that there is no symbol with that name, or else sets the | |
9515 | breakpoint only on non-inlined copies of the function. This limitation | |
9516 | will be removed in a future version of @value{GDBN}; until then, | |
9517 | set a breakpoint by line number on the first line of the inlined | |
9518 | function instead. | |
9519 | ||
9520 | @item | |
9521 | Setting breakpoints at the call site of an inlined function may not | |
9522 | work, because the call site does not contain any code. @value{GDBN} | |
9523 | may incorrectly move the breakpoint to the next line of the enclosing | |
9524 | function, after the call. This limitation will be removed in a future | |
9525 | version of @value{GDBN}; until then, set a breakpoint on an earlier line | |
9526 | or inside the inlined function instead. | |
9527 | ||
9528 | @item | |
9529 | @value{GDBN} cannot locate the return value of inlined calls after | |
9530 | using the @code{finish} command. This is a limitation of compiler-generated | |
9531 | debugging information; after @code{finish}, you can step to the next line | |
9532 | and print a variable where your program stored the return value. | |
9533 | ||
9534 | @end itemize | |
9535 | ||
9536 | ||
e2e0bcd1 JB |
9537 | @node Macros |
9538 | @chapter C Preprocessor Macros | |
9539 | ||
49efadf5 | 9540 | Some languages, such as C and C@t{++}, provide a way to define and invoke |
e2e0bcd1 JB |
9541 | ``preprocessor macros'' which expand into strings of tokens. |
9542 | @value{GDBN} can evaluate expressions containing macro invocations, show | |
9543 | the result of macro expansion, and show a macro's definition, including | |
9544 | where it was defined. | |
9545 | ||
9546 | You may need to compile your program specially to provide @value{GDBN} | |
9547 | with information about preprocessor macros. Most compilers do not | |
9548 | include macros in their debugging information, even when you compile | |
9549 | with the @option{-g} flag. @xref{Compilation}. | |
9550 | ||
9551 | A program may define a macro at one point, remove that definition later, | |
9552 | and then provide a different definition after that. Thus, at different | |
9553 | points in the program, a macro may have different definitions, or have | |
9554 | no definition at all. If there is a current stack frame, @value{GDBN} | |
9555 | uses the macros in scope at that frame's source code line. Otherwise, | |
9556 | @value{GDBN} uses the macros in scope at the current listing location; | |
9557 | see @ref{List}. | |
9558 | ||
e2e0bcd1 JB |
9559 | Whenever @value{GDBN} evaluates an expression, it always expands any |
9560 | macro invocations present in the expression. @value{GDBN} also provides | |
9561 | the following commands for working with macros explicitly. | |
9562 | ||
9563 | @table @code | |
9564 | ||
9565 | @kindex macro expand | |
9566 | @cindex macro expansion, showing the results of preprocessor | |
9567 | @cindex preprocessor macro expansion, showing the results of | |
9568 | @cindex expanding preprocessor macros | |
9569 | @item macro expand @var{expression} | |
9570 | @itemx macro exp @var{expression} | |
9571 | Show the results of expanding all preprocessor macro invocations in | |
9572 | @var{expression}. Since @value{GDBN} simply expands macros, but does | |
9573 | not parse the result, @var{expression} need not be a valid expression; | |
9574 | it can be any string of tokens. | |
9575 | ||
09d4efe1 | 9576 | @kindex macro exp1 |
e2e0bcd1 JB |
9577 | @item macro expand-once @var{expression} |
9578 | @itemx macro exp1 @var{expression} | |
4644b6e3 | 9579 | @cindex expand macro once |
e2e0bcd1 JB |
9580 | @i{(This command is not yet implemented.)} Show the results of |
9581 | expanding those preprocessor macro invocations that appear explicitly in | |
9582 | @var{expression}. Macro invocations appearing in that expansion are | |
9583 | left unchanged. This command allows you to see the effect of a | |
9584 | particular macro more clearly, without being confused by further | |
9585 | expansions. Since @value{GDBN} simply expands macros, but does not | |
9586 | parse the result, @var{expression} need not be a valid expression; it | |
9587 | can be any string of tokens. | |
9588 | ||
475b0867 | 9589 | @kindex info macro |
e2e0bcd1 JB |
9590 | @cindex macro definition, showing |
9591 | @cindex definition, showing a macro's | |
475b0867 | 9592 | @item info macro @var{macro} |
e2e0bcd1 | 9593 | Show the definition of the macro named @var{macro}, and describe the |
484086b7 | 9594 | source location or compiler command-line where that definition was established. |
e2e0bcd1 JB |
9595 | |
9596 | @kindex macro define | |
9597 | @cindex user-defined macros | |
9598 | @cindex defining macros interactively | |
9599 | @cindex macros, user-defined | |
9600 | @item macro define @var{macro} @var{replacement-list} | |
9601 | @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list} | |
d7d9f01e TT |
9602 | Introduce a definition for a preprocessor macro named @var{macro}, |
9603 | invocations of which are replaced by the tokens given in | |
9604 | @var{replacement-list}. The first form of this command defines an | |
9605 | ``object-like'' macro, which takes no arguments; the second form | |
9606 | defines a ``function-like'' macro, which takes the arguments given in | |
9607 | @var{arglist}. | |
9608 | ||
9609 | A definition introduced by this command is in scope in every | |
9610 | expression evaluated in @value{GDBN}, until it is removed with the | |
9611 | @code{macro undef} command, described below. The definition overrides | |
9612 | all definitions for @var{macro} present in the program being debugged, | |
9613 | as well as any previous user-supplied definition. | |
e2e0bcd1 JB |
9614 | |
9615 | @kindex macro undef | |
9616 | @item macro undef @var{macro} | |
d7d9f01e TT |
9617 | Remove any user-supplied definition for the macro named @var{macro}. |
9618 | This command only affects definitions provided with the @code{macro | |
9619 | define} command, described above; it cannot remove definitions present | |
9620 | in the program being debugged. | |
e2e0bcd1 | 9621 | |
09d4efe1 EZ |
9622 | @kindex macro list |
9623 | @item macro list | |
d7d9f01e | 9624 | List all the macros defined using the @code{macro define} command. |
e2e0bcd1 JB |
9625 | @end table |
9626 | ||
9627 | @cindex macros, example of debugging with | |
9628 | Here is a transcript showing the above commands in action. First, we | |
9629 | show our source files: | |
9630 | ||
9631 | @smallexample | |
9632 | $ cat sample.c | |
9633 | #include <stdio.h> | |
9634 | #include "sample.h" | |
9635 | ||
9636 | #define M 42 | |
9637 | #define ADD(x) (M + x) | |
9638 | ||
9639 | main () | |
9640 | @{ | |
9641 | #define N 28 | |
9642 | printf ("Hello, world!\n"); | |
9643 | #undef N | |
9644 | printf ("We're so creative.\n"); | |
9645 | #define N 1729 | |
9646 | printf ("Goodbye, world!\n"); | |
9647 | @} | |
9648 | $ cat sample.h | |
9649 | #define Q < | |
9650 | $ | |
9651 | @end smallexample | |
9652 | ||
9653 | Now, we compile the program using the @sc{gnu} C compiler, @value{NGCC}. | |
9654 | We pass the @option{-gdwarf-2} and @option{-g3} flags to ensure the | |
9655 | compiler includes information about preprocessor macros in the debugging | |
9656 | information. | |
9657 | ||
9658 | @smallexample | |
9659 | $ gcc -gdwarf-2 -g3 sample.c -o sample | |
9660 | $ | |
9661 | @end smallexample | |
9662 | ||
9663 | Now, we start @value{GDBN} on our sample program: | |
9664 | ||
9665 | @smallexample | |
9666 | $ gdb -nw sample | |
9667 | GNU gdb 2002-05-06-cvs | |
9668 | Copyright 2002 Free Software Foundation, Inc. | |
9669 | GDB is free software, @dots{} | |
f7dc1244 | 9670 | (@value{GDBP}) |
e2e0bcd1 JB |
9671 | @end smallexample |
9672 | ||
9673 | We can expand macros and examine their definitions, even when the | |
9674 | program is not running. @value{GDBN} uses the current listing position | |
9675 | to decide which macro definitions are in scope: | |
9676 | ||
9677 | @smallexample | |
f7dc1244 | 9678 | (@value{GDBP}) list main |
e2e0bcd1 JB |
9679 | 3 |
9680 | 4 #define M 42 | |
9681 | 5 #define ADD(x) (M + x) | |
9682 | 6 | |
9683 | 7 main () | |
9684 | 8 @{ | |
9685 | 9 #define N 28 | |
9686 | 10 printf ("Hello, world!\n"); | |
9687 | 11 #undef N | |
9688 | 12 printf ("We're so creative.\n"); | |
f7dc1244 | 9689 | (@value{GDBP}) info macro ADD |
e2e0bcd1 JB |
9690 | Defined at /home/jimb/gdb/macros/play/sample.c:5 |
9691 | #define ADD(x) (M + x) | |
f7dc1244 | 9692 | (@value{GDBP}) info macro Q |
e2e0bcd1 JB |
9693 | Defined at /home/jimb/gdb/macros/play/sample.h:1 |
9694 | included at /home/jimb/gdb/macros/play/sample.c:2 | |
9695 | #define Q < | |
f7dc1244 | 9696 | (@value{GDBP}) macro expand ADD(1) |
e2e0bcd1 | 9697 | expands to: (42 + 1) |
f7dc1244 | 9698 | (@value{GDBP}) macro expand-once ADD(1) |
e2e0bcd1 | 9699 | expands to: once (M + 1) |
f7dc1244 | 9700 | (@value{GDBP}) |
e2e0bcd1 JB |
9701 | @end smallexample |
9702 | ||
d7d9f01e | 9703 | In the example above, note that @code{macro expand-once} expands only |
e2e0bcd1 JB |
9704 | the macro invocation explicit in the original text --- the invocation of |
9705 | @code{ADD} --- but does not expand the invocation of the macro @code{M}, | |
9706 | which was introduced by @code{ADD}. | |
9707 | ||
3f94c067 BW |
9708 | Once the program is running, @value{GDBN} uses the macro definitions in |
9709 | force at the source line of the current stack frame: | |
e2e0bcd1 JB |
9710 | |
9711 | @smallexample | |
f7dc1244 | 9712 | (@value{GDBP}) break main |
e2e0bcd1 | 9713 | Breakpoint 1 at 0x8048370: file sample.c, line 10. |
f7dc1244 | 9714 | (@value{GDBP}) run |
b383017d | 9715 | Starting program: /home/jimb/gdb/macros/play/sample |
e2e0bcd1 JB |
9716 | |
9717 | Breakpoint 1, main () at sample.c:10 | |
9718 | 10 printf ("Hello, world!\n"); | |
f7dc1244 | 9719 | (@value{GDBP}) |
e2e0bcd1 JB |
9720 | @end smallexample |
9721 | ||
9722 | At line 10, the definition of the macro @code{N} at line 9 is in force: | |
9723 | ||
9724 | @smallexample | |
f7dc1244 | 9725 | (@value{GDBP}) info macro N |
e2e0bcd1 JB |
9726 | Defined at /home/jimb/gdb/macros/play/sample.c:9 |
9727 | #define N 28 | |
f7dc1244 | 9728 | (@value{GDBP}) macro expand N Q M |
e2e0bcd1 | 9729 | expands to: 28 < 42 |
f7dc1244 | 9730 | (@value{GDBP}) print N Q M |
e2e0bcd1 | 9731 | $1 = 1 |
f7dc1244 | 9732 | (@value{GDBP}) |
e2e0bcd1 JB |
9733 | @end smallexample |
9734 | ||
9735 | As we step over directives that remove @code{N}'s definition, and then | |
9736 | give it a new definition, @value{GDBN} finds the definition (or lack | |
9737 | thereof) in force at each point: | |
9738 | ||
9739 | @smallexample | |
f7dc1244 | 9740 | (@value{GDBP}) next |
e2e0bcd1 JB |
9741 | Hello, world! |
9742 | 12 printf ("We're so creative.\n"); | |
f7dc1244 | 9743 | (@value{GDBP}) info macro N |
e2e0bcd1 JB |
9744 | The symbol `N' has no definition as a C/C++ preprocessor macro |
9745 | at /home/jimb/gdb/macros/play/sample.c:12 | |
f7dc1244 | 9746 | (@value{GDBP}) next |
e2e0bcd1 JB |
9747 | We're so creative. |
9748 | 14 printf ("Goodbye, world!\n"); | |
f7dc1244 | 9749 | (@value{GDBP}) info macro N |
e2e0bcd1 JB |
9750 | Defined at /home/jimb/gdb/macros/play/sample.c:13 |
9751 | #define N 1729 | |
f7dc1244 | 9752 | (@value{GDBP}) macro expand N Q M |
e2e0bcd1 | 9753 | expands to: 1729 < 42 |
f7dc1244 | 9754 | (@value{GDBP}) print N Q M |
e2e0bcd1 | 9755 | $2 = 0 |
f7dc1244 | 9756 | (@value{GDBP}) |
e2e0bcd1 JB |
9757 | @end smallexample |
9758 | ||
484086b7 JK |
9759 | In addition to source files, macros can be defined on the compilation command |
9760 | line using the @option{-D@var{name}=@var{value}} syntax. For macros defined in | |
9761 | such a way, @value{GDBN} displays the location of their definition as line zero | |
9762 | of the source file submitted to the compiler. | |
9763 | ||
9764 | @smallexample | |
9765 | (@value{GDBP}) info macro __STDC__ | |
9766 | Defined at /home/jimb/gdb/macros/play/sample.c:0 | |
9767 | -D__STDC__=1 | |
9768 | (@value{GDBP}) | |
9769 | @end smallexample | |
9770 | ||
e2e0bcd1 | 9771 | |
b37052ae EZ |
9772 | @node Tracepoints |
9773 | @chapter Tracepoints | |
9774 | @c This chapter is based on the documentation written by Michael | |
9775 | @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni. | |
9776 | ||
9777 | @cindex tracepoints | |
9778 | In some applications, it is not feasible for the debugger to interrupt | |
9779 | the program's execution long enough for the developer to learn | |
9780 | anything helpful about its behavior. If the program's correctness | |
9781 | depends on its real-time behavior, delays introduced by a debugger | |
9782 | might cause the program to change its behavior drastically, or perhaps | |
9783 | fail, even when the code itself is correct. It is useful to be able | |
9784 | to observe the program's behavior without interrupting it. | |
9785 | ||
9786 | Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can | |
9787 | specify locations in the program, called @dfn{tracepoints}, and | |
9788 | arbitrary expressions to evaluate when those tracepoints are reached. | |
9789 | Later, using the @code{tfind} command, you can examine the values | |
9790 | those expressions had when the program hit the tracepoints. The | |
9791 | expressions may also denote objects in memory---structures or arrays, | |
9792 | for example---whose values @value{GDBN} should record; while visiting | |
9793 | a particular tracepoint, you may inspect those objects as if they were | |
9794 | in memory at that moment. However, because @value{GDBN} records these | |
9795 | values without interacting with you, it can do so quickly and | |
9796 | unobtrusively, hopefully not disturbing the program's behavior. | |
9797 | ||
9798 | The tracepoint facility is currently available only for remote | |
9d29849a JB |
9799 | targets. @xref{Targets}. In addition, your remote target must know |
9800 | how to collect trace data. This functionality is implemented in the | |
9801 | remote stub; however, none of the stubs distributed with @value{GDBN} | |
9802 | support tracepoints as of this writing. The format of the remote | |
9803 | packets used to implement tracepoints are described in @ref{Tracepoint | |
9804 | Packets}. | |
b37052ae | 9805 | |
00bf0b85 SS |
9806 | It is also possible to get trace data from a file, in a manner reminiscent |
9807 | of corefiles; you specify the filename, and use @code{tfind} to search | |
9808 | through the file. @xref{Trace Files}, for more details. | |
9809 | ||
b37052ae EZ |
9810 | This chapter describes the tracepoint commands and features. |
9811 | ||
9812 | @menu | |
b383017d RM |
9813 | * Set Tracepoints:: |
9814 | * Analyze Collected Data:: | |
9815 | * Tracepoint Variables:: | |
00bf0b85 | 9816 | * Trace Files:: |
b37052ae EZ |
9817 | @end menu |
9818 | ||
9819 | @node Set Tracepoints | |
9820 | @section Commands to Set Tracepoints | |
9821 | ||
9822 | Before running such a @dfn{trace experiment}, an arbitrary number of | |
1042e4c0 SS |
9823 | tracepoints can be set. A tracepoint is actually a special type of |
9824 | breakpoint (@pxref{Set Breaks}), so you can manipulate it using | |
9825 | standard breakpoint commands. For instance, as with breakpoints, | |
9826 | tracepoint numbers are successive integers starting from one, and many | |
9827 | of the commands associated with tracepoints take the tracepoint number | |
9828 | as their argument, to identify which tracepoint to work on. | |
b37052ae EZ |
9829 | |
9830 | For each tracepoint, you can specify, in advance, some arbitrary set | |
9831 | of data that you want the target to collect in the trace buffer when | |
9832 | it hits that tracepoint. The collected data can include registers, | |
9833 | local variables, or global data. Later, you can use @value{GDBN} | |
9834 | commands to examine the values these data had at the time the | |
9835 | tracepoint was hit. | |
9836 | ||
7d13fe92 SS |
9837 | Tracepoints do not support every breakpoint feature. Ignore counts on |
9838 | tracepoints have no effect, and tracepoints cannot run @value{GDBN} | |
9839 | commands when they are hit. Tracepoints may not be thread-specific | |
9840 | either. | |
1042e4c0 | 9841 | |
7a697b8d SS |
9842 | @cindex fast tracepoints |
9843 | Some targets may support @dfn{fast tracepoints}, which are inserted in | |
9844 | a different way (such as with a jump instead of a trap), that is | |
9845 | faster but possibly restricted in where they may be installed. | |
9846 | ||
0fb4aa4b PA |
9847 | @cindex static tracepoints |
9848 | @cindex markers, static tracepoints | |
9849 | @cindex probing markers, static tracepoints | |
9850 | Regular and fast tracepoints are dynamic tracing facilities, meaning | |
9851 | that they can be used to insert tracepoints at (almost) any location | |
9852 | in the target. Some targets may also support controlling @dfn{static | |
9853 | tracepoints} from @value{GDBN}. With static tracing, a set of | |
9854 | instrumentation points, also known as @dfn{markers}, are embedded in | |
9855 | the target program, and can be activated or deactivated by name or | |
9856 | address. These are usually placed at locations which facilitate | |
9857 | investigating what the target is actually doing. @value{GDBN}'s | |
9858 | support for static tracing includes being able to list instrumentation | |
9859 | points, and attach them with @value{GDBN} defined high level | |
9860 | tracepoints that expose the whole range of convenience of | |
8786b2bd | 9861 | @value{GDBN}'s tracepoints support. Namely, support for collecting |
0fb4aa4b PA |
9862 | registers values and values of global or local (to the instrumentation |
9863 | point) variables; tracepoint conditions and trace state variables. | |
9864 | The act of installing a @value{GDBN} static tracepoint on an | |
9865 | instrumentation point, or marker, is referred to as @dfn{probing} a | |
9866 | static tracepoint marker. | |
9867 | ||
fa593d66 PA |
9868 | @code{gdbserver} supports tracepoints on some target systems. |
9869 | @xref{Server,,Tracepoints support in @code{gdbserver}}. | |
9870 | ||
b37052ae EZ |
9871 | This section describes commands to set tracepoints and associated |
9872 | conditions and actions. | |
9873 | ||
9874 | @menu | |
b383017d RM |
9875 | * Create and Delete Tracepoints:: |
9876 | * Enable and Disable Tracepoints:: | |
9877 | * Tracepoint Passcounts:: | |
782b2b07 | 9878 | * Tracepoint Conditions:: |
f61e138d | 9879 | * Trace State Variables:: |
b383017d RM |
9880 | * Tracepoint Actions:: |
9881 | * Listing Tracepoints:: | |
0fb4aa4b | 9882 | * Listing Static Tracepoint Markers:: |
79a6e687 | 9883 | * Starting and Stopping Trace Experiments:: |
c9429232 | 9884 | * Tracepoint Restrictions:: |
b37052ae EZ |
9885 | @end menu |
9886 | ||
9887 | @node Create and Delete Tracepoints | |
9888 | @subsection Create and Delete Tracepoints | |
9889 | ||
9890 | @table @code | |
9891 | @cindex set tracepoint | |
9892 | @kindex trace | |
1042e4c0 | 9893 | @item trace @var{location} |
b37052ae | 9894 | The @code{trace} command is very similar to the @code{break} command. |
1042e4c0 SS |
9895 | Its argument @var{location} can be a source line, a function name, or |
9896 | an address in the target program. @xref{Specify Location}. The | |
9897 | @code{trace} command defines a tracepoint, which is a point in the | |
9898 | target program where the debugger will briefly stop, collect some | |
9899 | data, and then allow the program to continue. Setting a tracepoint or | |
9900 | changing its actions doesn't take effect until the next @code{tstart} | |
9901 | command, and once a trace experiment is running, further changes will | |
9902 | not have any effect until the next trace experiment starts. | |
b37052ae EZ |
9903 | |
9904 | Here are some examples of using the @code{trace} command: | |
9905 | ||
9906 | @smallexample | |
9907 | (@value{GDBP}) @b{trace foo.c:121} // a source file and line number | |
9908 | ||
9909 | (@value{GDBP}) @b{trace +2} // 2 lines forward | |
9910 | ||
9911 | (@value{GDBP}) @b{trace my_function} // first source line of function | |
9912 | ||
9913 | (@value{GDBP}) @b{trace *my_function} // EXACT start address of function | |
9914 | ||
9915 | (@value{GDBP}) @b{trace *0x2117c4} // an address | |
9916 | @end smallexample | |
9917 | ||
9918 | @noindent | |
9919 | You can abbreviate @code{trace} as @code{tr}. | |
9920 | ||
782b2b07 SS |
9921 | @item trace @var{location} if @var{cond} |
9922 | Set a tracepoint with condition @var{cond}; evaluate the expression | |
9923 | @var{cond} each time the tracepoint is reached, and collect data only | |
9924 | if the value is nonzero---that is, if @var{cond} evaluates as true. | |
9925 | @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more | |
9926 | information on tracepoint conditions. | |
9927 | ||
7a697b8d SS |
9928 | @item ftrace @var{location} [ if @var{cond} ] |
9929 | @cindex set fast tracepoint | |
74c761c1 | 9930 | @cindex fast tracepoints, setting |
7a697b8d SS |
9931 | @kindex ftrace |
9932 | The @code{ftrace} command sets a fast tracepoint. For targets that | |
9933 | support them, fast tracepoints will use a more efficient but possibly | |
9934 | less general technique to trigger data collection, such as a jump | |
9935 | instruction instead of a trap, or some sort of hardware support. It | |
9936 | may not be possible to create a fast tracepoint at the desired | |
9937 | location, in which case the command will exit with an explanatory | |
9938 | message. | |
9939 | ||
9940 | @value{GDBN} handles arguments to @code{ftrace} exactly as for | |
9941 | @code{trace}. | |
9942 | ||
0fb4aa4b | 9943 | @item strace @var{location} [ if @var{cond} ] |
74c761c1 PA |
9944 | @cindex set static tracepoint |
9945 | @cindex static tracepoints, setting | |
9946 | @cindex probe static tracepoint marker | |
0fb4aa4b PA |
9947 | @kindex strace |
9948 | The @code{strace} command sets a static tracepoint. For targets that | |
9949 | support it, setting a static tracepoint probes a static | |
9950 | instrumentation point, or marker, found at @var{location}. It may not | |
9951 | be possible to set a static tracepoint at the desired location, in | |
9952 | which case the command will exit with an explanatory message. | |
9953 | ||
9954 | @value{GDBN} handles arguments to @code{strace} exactly as for | |
9955 | @code{trace}, with the addition that the user can also specify | |
9956 | @code{-m @var{marker}} as @var{location}. This probes the marker | |
9957 | identified by the @var{marker} string identifier. This identifier | |
9958 | depends on the static tracepoint backend library your program is | |
9959 | using. You can find all the marker identifiers in the @samp{ID} field | |
9960 | of the @code{info static-tracepoint-markers} command output. | |
9961 | @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint | |
9962 | Markers}. For example, in the following small program using the UST | |
9963 | tracing engine: | |
9964 | ||
9965 | @smallexample | |
9966 | main () | |
9967 | @{ | |
9968 | trace_mark(ust, bar33, "str %s", "FOOBAZ"); | |
9969 | @} | |
9970 | @end smallexample | |
9971 | ||
9972 | @noindent | |
9973 | the marker id is composed of joining the first two arguments to the | |
9974 | @code{trace_mark} call with a slash, which translates to: | |
9975 | ||
9976 | @smallexample | |
9977 | (@value{GDBP}) info static-tracepoint-markers | |
9978 | Cnt Enb ID Address What | |
9979 | 1 n ust/bar33 0x0000000000400ddc in main at stexample.c:22 | |
9980 | Data: "str %s" | |
9981 | [etc...] | |
9982 | @end smallexample | |
9983 | ||
9984 | @noindent | |
9985 | so you may probe the marker above with: | |
9986 | ||
9987 | @smallexample | |
9988 | (@value{GDBP}) strace -m ust/bar33 | |
9989 | @end smallexample | |
9990 | ||
9991 | Static tracepoints accept an extra collect action --- @code{collect | |
9992 | $_sdata}. This collects arbitrary user data passed in the probe point | |
9993 | call to the tracing library. In the UST example above, you'll see | |
9994 | that the third argument to @code{trace_mark} is a printf-like format | |
9995 | string. The user data is then the result of running that formating | |
9996 | string against the following arguments. Note that @code{info | |
9997 | static-tracepoint-markers} command output lists that format string in | |
9998 | the @samp{Data:} field. | |
9999 | ||
10000 | You can inspect this data when analyzing the trace buffer, by printing | |
10001 | the $_sdata variable like any other variable available to | |
10002 | @value{GDBN}. @xref{Tracepoint Actions,,Tracepoint Action Lists}. | |
10003 | ||
b37052ae EZ |
10004 | @vindex $tpnum |
10005 | @cindex last tracepoint number | |
10006 | @cindex recent tracepoint number | |
10007 | @cindex tracepoint number | |
10008 | The convenience variable @code{$tpnum} records the tracepoint number | |
10009 | of the most recently set tracepoint. | |
10010 | ||
10011 | @kindex delete tracepoint | |
10012 | @cindex tracepoint deletion | |
10013 | @item delete tracepoint @r{[}@var{num}@r{]} | |
10014 | Permanently delete one or more tracepoints. With no argument, the | |
1042e4c0 SS |
10015 | default is to delete all tracepoints. Note that the regular |
10016 | @code{delete} command can remove tracepoints also. | |
b37052ae EZ |
10017 | |
10018 | Examples: | |
10019 | ||
10020 | @smallexample | |
10021 | (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints | |
10022 | ||
10023 | (@value{GDBP}) @b{delete trace} // remove all tracepoints | |
10024 | @end smallexample | |
10025 | ||
10026 | @noindent | |
10027 | You can abbreviate this command as @code{del tr}. | |
10028 | @end table | |
10029 | ||
10030 | @node Enable and Disable Tracepoints | |
10031 | @subsection Enable and Disable Tracepoints | |
10032 | ||
1042e4c0 SS |
10033 | These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}. |
10034 | ||
b37052ae EZ |
10035 | @table @code |
10036 | @kindex disable tracepoint | |
10037 | @item disable tracepoint @r{[}@var{num}@r{]} | |
10038 | Disable tracepoint @var{num}, or all tracepoints if no argument | |
10039 | @var{num} is given. A disabled tracepoint will have no effect during | |
d248b706 | 10040 | a trace experiment, but it is not forgotten. You can re-enable |
b37052ae | 10041 | a disabled tracepoint using the @code{enable tracepoint} command. |
d248b706 KY |
10042 | If the command is issued during a trace experiment and the debug target |
10043 | has support for disabling tracepoints during a trace experiment, then the | |
10044 | change will be effective immediately. Otherwise, it will be applied to the | |
10045 | next trace experiment. | |
b37052ae EZ |
10046 | |
10047 | @kindex enable tracepoint | |
10048 | @item enable tracepoint @r{[}@var{num}@r{]} | |
d248b706 KY |
10049 | Enable tracepoint @var{num}, or all tracepoints. If this command is |
10050 | issued during a trace experiment and the debug target supports enabling | |
10051 | tracepoints during a trace experiment, then the enabled tracepoints will | |
10052 | become effective immediately. Otherwise, they will become effective the | |
10053 | next time a trace experiment is run. | |
b37052ae EZ |
10054 | @end table |
10055 | ||
10056 | @node Tracepoint Passcounts | |
10057 | @subsection Tracepoint Passcounts | |
10058 | ||
10059 | @table @code | |
10060 | @kindex passcount | |
10061 | @cindex tracepoint pass count | |
10062 | @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]} | |
10063 | Set the @dfn{passcount} of a tracepoint. The passcount is a way to | |
10064 | automatically stop a trace experiment. If a tracepoint's passcount is | |
10065 | @var{n}, then the trace experiment will be automatically stopped on | |
10066 | the @var{n}'th time that tracepoint is hit. If the tracepoint number | |
10067 | @var{num} is not specified, the @code{passcount} command sets the | |
10068 | passcount of the most recently defined tracepoint. If no passcount is | |
10069 | given, the trace experiment will run until stopped explicitly by the | |
10070 | user. | |
10071 | ||
10072 | Examples: | |
10073 | ||
10074 | @smallexample | |
b383017d | 10075 | (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of |
6826cf00 | 10076 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2} |
b37052ae EZ |
10077 | |
10078 | (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the | |
6826cf00 | 10079 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.} |
b37052ae EZ |
10080 | (@value{GDBP}) @b{trace foo} |
10081 | (@value{GDBP}) @b{pass 3} | |
10082 | (@value{GDBP}) @b{trace bar} | |
10083 | (@value{GDBP}) @b{pass 2} | |
10084 | (@value{GDBP}) @b{trace baz} | |
10085 | (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been | |
6826cf00 EZ |
10086 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has} |
10087 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times} | |
10088 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.} | |
b37052ae EZ |
10089 | @end smallexample |
10090 | @end table | |
10091 | ||
782b2b07 SS |
10092 | @node Tracepoint Conditions |
10093 | @subsection Tracepoint Conditions | |
10094 | @cindex conditional tracepoints | |
10095 | @cindex tracepoint conditions | |
10096 | ||
10097 | The simplest sort of tracepoint collects data every time your program | |
10098 | reaches a specified place. You can also specify a @dfn{condition} for | |
10099 | a tracepoint. A condition is just a Boolean expression in your | |
10100 | programming language (@pxref{Expressions, ,Expressions}). A | |
10101 | tracepoint with a condition evaluates the expression each time your | |
10102 | program reaches it, and data collection happens only if the condition | |
10103 | is true. | |
10104 | ||
10105 | Tracepoint conditions can be specified when a tracepoint is set, by | |
10106 | using @samp{if} in the arguments to the @code{trace} command. | |
10107 | @xref{Create and Delete Tracepoints, ,Setting Tracepoints}. They can | |
10108 | also be set or changed at any time with the @code{condition} command, | |
10109 | just as with breakpoints. | |
10110 | ||
10111 | Unlike breakpoint conditions, @value{GDBN} does not actually evaluate | |
10112 | the conditional expression itself. Instead, @value{GDBN} encodes the | |
6dcd5565 | 10113 | expression into an agent expression (@pxref{Agent Expressions}) |
782b2b07 SS |
10114 | suitable for execution on the target, independently of @value{GDBN}. |
10115 | Global variables become raw memory locations, locals become stack | |
10116 | accesses, and so forth. | |
10117 | ||
10118 | For instance, suppose you have a function that is usually called | |
10119 | frequently, but should not be called after an error has occurred. You | |
10120 | could use the following tracepoint command to collect data about calls | |
10121 | of that function that happen while the error code is propagating | |
10122 | through the program; an unconditional tracepoint could end up | |
10123 | collecting thousands of useless trace frames that you would have to | |
10124 | search through. | |
10125 | ||
10126 | @smallexample | |
10127 | (@value{GDBP}) @kbd{trace normal_operation if errcode > 0} | |
10128 | @end smallexample | |
10129 | ||
f61e138d SS |
10130 | @node Trace State Variables |
10131 | @subsection Trace State Variables | |
10132 | @cindex trace state variables | |
10133 | ||
10134 | A @dfn{trace state variable} is a special type of variable that is | |
10135 | created and managed by target-side code. The syntax is the same as | |
10136 | that for GDB's convenience variables (a string prefixed with ``$''), | |
10137 | but they are stored on the target. They must be created explicitly, | |
10138 | using a @code{tvariable} command. They are always 64-bit signed | |
10139 | integers. | |
10140 | ||
10141 | Trace state variables are remembered by @value{GDBN}, and downloaded | |
10142 | to the target along with tracepoint information when the trace | |
10143 | experiment starts. There are no intrinsic limits on the number of | |
10144 | trace state variables, beyond memory limitations of the target. | |
10145 | ||
10146 | @cindex convenience variables, and trace state variables | |
10147 | Although trace state variables are managed by the target, you can use | |
10148 | them in print commands and expressions as if they were convenience | |
10149 | variables; @value{GDBN} will get the current value from the target | |
10150 | while the trace experiment is running. Trace state variables share | |
10151 | the same namespace as other ``$'' variables, which means that you | |
10152 | cannot have trace state variables with names like @code{$23} or | |
10153 | @code{$pc}, nor can you have a trace state variable and a convenience | |
10154 | variable with the same name. | |
10155 | ||
10156 | @table @code | |
10157 | ||
10158 | @item tvariable $@var{name} [ = @var{expression} ] | |
10159 | @kindex tvariable | |
10160 | The @code{tvariable} command creates a new trace state variable named | |
10161 | @code{$@var{name}}, and optionally gives it an initial value of | |
10162 | @var{expression}. @var{expression} is evaluated when this command is | |
10163 | entered; the result will be converted to an integer if possible, | |
10164 | otherwise @value{GDBN} will report an error. A subsequent | |
10165 | @code{tvariable} command specifying the same name does not create a | |
10166 | variable, but instead assigns the supplied initial value to the | |
10167 | existing variable of that name, overwriting any previous initial | |
10168 | value. The default initial value is 0. | |
10169 | ||
10170 | @item info tvariables | |
10171 | @kindex info tvariables | |
10172 | List all the trace state variables along with their initial values. | |
10173 | Their current values may also be displayed, if the trace experiment is | |
10174 | currently running. | |
10175 | ||
10176 | @item delete tvariable @r{[} $@var{name} @dots{} @r{]} | |
10177 | @kindex delete tvariable | |
10178 | Delete the given trace state variables, or all of them if no arguments | |
10179 | are specified. | |
10180 | ||
10181 | @end table | |
10182 | ||
b37052ae EZ |
10183 | @node Tracepoint Actions |
10184 | @subsection Tracepoint Action Lists | |
10185 | ||
10186 | @table @code | |
10187 | @kindex actions | |
10188 | @cindex tracepoint actions | |
10189 | @item actions @r{[}@var{num}@r{]} | |
10190 | This command will prompt for a list of actions to be taken when the | |
10191 | tracepoint is hit. If the tracepoint number @var{num} is not | |
10192 | specified, this command sets the actions for the one that was most | |
10193 | recently defined (so that you can define a tracepoint and then say | |
10194 | @code{actions} without bothering about its number). You specify the | |
10195 | actions themselves on the following lines, one action at a time, and | |
10196 | terminate the actions list with a line containing just @code{end}. So | |
7d13fe92 | 10197 | far, the only defined actions are @code{collect}, @code{teval}, and |
b37052ae EZ |
10198 | @code{while-stepping}. |
10199 | ||
5a9351ae SS |
10200 | @code{actions} is actually equivalent to @code{commands} (@pxref{Break |
10201 | Commands, ,Breakpoint Command Lists}), except that only the defined | |
10202 | actions are allowed; any other @value{GDBN} command is rejected. | |
10203 | ||
b37052ae EZ |
10204 | @cindex remove actions from a tracepoint |
10205 | To remove all actions from a tracepoint, type @samp{actions @var{num}} | |
10206 | and follow it immediately with @samp{end}. | |
10207 | ||
10208 | @smallexample | |
10209 | (@value{GDBP}) @b{collect @var{data}} // collect some data | |
10210 | ||
6826cf00 | 10211 | (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data |
b37052ae | 10212 | |
6826cf00 | 10213 | (@value{GDBP}) @b{end} // signals the end of actions. |
b37052ae EZ |
10214 | @end smallexample |
10215 | ||
10216 | In the following example, the action list begins with @code{collect} | |
10217 | commands indicating the things to be collected when the tracepoint is | |
10218 | hit. Then, in order to single-step and collect additional data | |
10219 | following the tracepoint, a @code{while-stepping} command is used, | |
7d13fe92 SS |
10220 | followed by the list of things to be collected after each step in a |
10221 | sequence of single steps. The @code{while-stepping} command is | |
10222 | terminated by its own separate @code{end} command. Lastly, the action | |
10223 | list is terminated by an @code{end} command. | |
b37052ae EZ |
10224 | |
10225 | @smallexample | |
10226 | (@value{GDBP}) @b{trace foo} | |
10227 | (@value{GDBP}) @b{actions} | |
10228 | Enter actions for tracepoint 1, one per line: | |
10229 | > collect bar,baz | |
10230 | > collect $regs | |
10231 | > while-stepping 12 | |
5a9351ae | 10232 | > collect $pc, arr[i] |
b37052ae EZ |
10233 | > end |
10234 | end | |
10235 | @end smallexample | |
10236 | ||
10237 | @kindex collect @r{(tracepoints)} | |
10238 | @item collect @var{expr1}, @var{expr2}, @dots{} | |
10239 | Collect values of the given expressions when the tracepoint is hit. | |
10240 | This command accepts a comma-separated list of any valid expressions. | |
10241 | In addition to global, static, or local variables, the following | |
10242 | special arguments are supported: | |
10243 | ||
10244 | @table @code | |
10245 | @item $regs | |
0fb4aa4b | 10246 | Collect all registers. |
b37052ae EZ |
10247 | |
10248 | @item $args | |
0fb4aa4b | 10249 | Collect all function arguments. |
b37052ae EZ |
10250 | |
10251 | @item $locals | |
0fb4aa4b PA |
10252 | Collect all local variables. |
10253 | ||
10254 | @item $_sdata | |
10255 | @vindex $_sdata@r{, collect} | |
10256 | Collect static tracepoint marker specific data. Only available for | |
10257 | static tracepoints. @xref{Tracepoint Actions,,Tracepoint Action | |
10258 | Lists}. On the UST static tracepoints library backend, an | |
10259 | instrumentation point resembles a @code{printf} function call. The | |
10260 | tracing library is able to collect user specified data formatted to a | |
10261 | character string using the format provided by the programmer that | |
10262 | instrumented the program. Other backends have similar mechanisms. | |
10263 | Here's an example of a UST marker call: | |
10264 | ||
10265 | @smallexample | |
10266 | const char master_name[] = "$your_name"; | |
10267 | trace_mark(channel1, marker1, "hello %s", master_name) | |
10268 | @end smallexample | |
10269 | ||
10270 | In this case, collecting @code{$_sdata} collects the string | |
10271 | @samp{hello $yourname}. When analyzing the trace buffer, you can | |
10272 | inspect @samp{$_sdata} like any other variable available to | |
10273 | @value{GDBN}. | |
b37052ae EZ |
10274 | @end table |
10275 | ||
10276 | You can give several consecutive @code{collect} commands, each one | |
10277 | with a single argument, or one @code{collect} command with several | |
5a9351ae | 10278 | arguments separated by commas; the effect is the same. |
b37052ae | 10279 | |
f5c37c66 EZ |
10280 | The command @code{info scope} (@pxref{Symbols, info scope}) is |
10281 | particularly useful for figuring out what data to collect. | |
10282 | ||
6da95a67 SS |
10283 | @kindex teval @r{(tracepoints)} |
10284 | @item teval @var{expr1}, @var{expr2}, @dots{} | |
10285 | Evaluate the given expressions when the tracepoint is hit. This | |
10286 | command accepts a comma-separated list of expressions. The results | |
10287 | are discarded, so this is mainly useful for assigning values to trace | |
10288 | state variables (@pxref{Trace State Variables}) without adding those | |
10289 | values to the trace buffer, as would be the case if the @code{collect} | |
10290 | action were used. | |
10291 | ||
b37052ae EZ |
10292 | @kindex while-stepping @r{(tracepoints)} |
10293 | @item while-stepping @var{n} | |
c9429232 | 10294 | Perform @var{n} single-step instruction traces after the tracepoint, |
7d13fe92 | 10295 | collecting new data after each step. The @code{while-stepping} |
c9429232 SS |
10296 | command is followed by the list of what to collect while stepping |
10297 | (followed by its own @code{end} command): | |
b37052ae EZ |
10298 | |
10299 | @smallexample | |
10300 | > while-stepping 12 | |
10301 | > collect $regs, myglobal | |
10302 | > end | |
10303 | > | |
10304 | @end smallexample | |
10305 | ||
10306 | @noindent | |
7d13fe92 SS |
10307 | Note that @code{$pc} is not automatically collected by |
10308 | @code{while-stepping}; you need to explicitly collect that register if | |
10309 | you need it. You may abbreviate @code{while-stepping} as @code{ws} or | |
b37052ae | 10310 | @code{stepping}. |
236f1d4d SS |
10311 | |
10312 | @item set default-collect @var{expr1}, @var{expr2}, @dots{} | |
10313 | @kindex set default-collect | |
10314 | @cindex default collection action | |
10315 | This variable is a list of expressions to collect at each tracepoint | |
10316 | hit. It is effectively an additional @code{collect} action prepended | |
10317 | to every tracepoint action list. The expressions are parsed | |
10318 | individually for each tracepoint, so for instance a variable named | |
10319 | @code{xyz} may be interpreted as a global for one tracepoint, and a | |
10320 | local for another, as appropriate to the tracepoint's location. | |
10321 | ||
10322 | @item show default-collect | |
10323 | @kindex show default-collect | |
10324 | Show the list of expressions that are collected by default at each | |
10325 | tracepoint hit. | |
10326 | ||
b37052ae EZ |
10327 | @end table |
10328 | ||
10329 | @node Listing Tracepoints | |
10330 | @subsection Listing Tracepoints | |
10331 | ||
10332 | @table @code | |
e5a67952 MS |
10333 | @kindex info tracepoints @r{[}@var{n}@dots{}@r{]} |
10334 | @kindex info tp @r{[}@var{n}@dots{}@r{]} | |
b37052ae | 10335 | @cindex information about tracepoints |
e5a67952 | 10336 | @item info tracepoints @r{[}@var{num}@dots{}@r{]} |
1042e4c0 SS |
10337 | Display information about the tracepoint @var{num}. If you don't |
10338 | specify a tracepoint number, displays information about all the | |
10339 | tracepoints defined so far. The format is similar to that used for | |
10340 | @code{info breakpoints}; in fact, @code{info tracepoints} is the same | |
10341 | command, simply restricting itself to tracepoints. | |
10342 | ||
10343 | A tracepoint's listing may include additional information specific to | |
10344 | tracing: | |
b37052ae EZ |
10345 | |
10346 | @itemize @bullet | |
10347 | @item | |
b37052ae | 10348 | its passcount as given by the @code{passcount @var{n}} command |
b37052ae EZ |
10349 | @end itemize |
10350 | ||
10351 | @smallexample | |
10352 | (@value{GDBP}) @b{info trace} | |
1042e4c0 SS |
10353 | Num Type Disp Enb Address What |
10354 | 1 tracepoint keep y 0x0804ab57 in foo() at main.cxx:7 | |
5a9351ae SS |
10355 | while-stepping 20 |
10356 | collect globfoo, $regs | |
10357 | end | |
10358 | collect globfoo2 | |
10359 | end | |
1042e4c0 | 10360 | pass count 1200 |
b37052ae EZ |
10361 | (@value{GDBP}) |
10362 | @end smallexample | |
10363 | ||
10364 | @noindent | |
10365 | This command can be abbreviated @code{info tp}. | |
10366 | @end table | |
10367 | ||
0fb4aa4b PA |
10368 | @node Listing Static Tracepoint Markers |
10369 | @subsection Listing Static Tracepoint Markers | |
10370 | ||
10371 | @table @code | |
10372 | @kindex info static-tracepoint-markers | |
10373 | @cindex information about static tracepoint markers | |
10374 | @item info static-tracepoint-markers | |
10375 | Display information about all static tracepoint markers defined in the | |
10376 | program. | |
10377 | ||
10378 | For each marker, the following columns are printed: | |
10379 | ||
10380 | @table @emph | |
10381 | @item Count | |
10382 | An incrementing counter, output to help readability. This is not a | |
10383 | stable identifier. | |
10384 | @item ID | |
10385 | The marker ID, as reported by the target. | |
10386 | @item Enabled or Disabled | |
10387 | Probed markers are tagged with @samp{y}. @samp{n} identifies marks | |
10388 | that are not enabled. | |
10389 | @item Address | |
10390 | Where the marker is in your program, as a memory address. | |
10391 | @item What | |
10392 | Where the marker is in the source for your program, as a file and line | |
10393 | number. If the debug information included in the program does not | |
10394 | allow @value{GDBN} to locate the source of the marker, this column | |
10395 | will be left blank. | |
10396 | @end table | |
10397 | ||
10398 | @noindent | |
10399 | In addition, the following information may be printed for each marker: | |
10400 | ||
10401 | @table @emph | |
10402 | @item Data | |
10403 | User data passed to the tracing library by the marker call. In the | |
10404 | UST backend, this is the format string passed as argument to the | |
10405 | marker call. | |
10406 | @item Static tracepoints probing the marker | |
10407 | The list of static tracepoints attached to the marker. | |
10408 | @end table | |
10409 | ||
10410 | @smallexample | |
10411 | (@value{GDBP}) info static-tracepoint-markers | |
10412 | Cnt ID Enb Address What | |
10413 | 1 ust/bar2 y 0x0000000000400e1a in main at stexample.c:25 | |
10414 | Data: number1 %d number2 %d | |
10415 | Probed by static tracepoints: #2 | |
10416 | 2 ust/bar33 n 0x0000000000400c87 in main at stexample.c:24 | |
10417 | Data: str %s | |
10418 | (@value{GDBP}) | |
10419 | @end smallexample | |
10420 | @end table | |
10421 | ||
79a6e687 BW |
10422 | @node Starting and Stopping Trace Experiments |
10423 | @subsection Starting and Stopping Trace Experiments | |
b37052ae EZ |
10424 | |
10425 | @table @code | |
10426 | @kindex tstart | |
10427 | @cindex start a new trace experiment | |
10428 | @cindex collected data discarded | |
10429 | @item tstart | |
10430 | This command takes no arguments. It starts the trace experiment, and | |
10431 | begins collecting data. This has the side effect of discarding all | |
10432 | the data collected in the trace buffer during the previous trace | |
10433 | experiment. | |
10434 | ||
10435 | @kindex tstop | |
10436 | @cindex stop a running trace experiment | |
10437 | @item tstop | |
10438 | This command takes no arguments. It ends the trace experiment, and | |
10439 | stops collecting data. | |
10440 | ||
68c71a2e | 10441 | @strong{Note}: a trace experiment and data collection may stop |
b37052ae EZ |
10442 | automatically if any tracepoint's passcount is reached |
10443 | (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full. | |
10444 | ||
10445 | @kindex tstatus | |
10446 | @cindex status of trace data collection | |
10447 | @cindex trace experiment, status of | |
10448 | @item tstatus | |
10449 | This command displays the status of the current trace data | |
10450 | collection. | |
10451 | @end table | |
10452 | ||
10453 | Here is an example of the commands we described so far: | |
10454 | ||
10455 | @smallexample | |
10456 | (@value{GDBP}) @b{trace gdb_c_test} | |
10457 | (@value{GDBP}) @b{actions} | |
10458 | Enter actions for tracepoint #1, one per line. | |
10459 | > collect $regs,$locals,$args | |
10460 | > while-stepping 11 | |
10461 | > collect $regs | |
10462 | > end | |
10463 | > end | |
10464 | (@value{GDBP}) @b{tstart} | |
10465 | [time passes @dots{}] | |
10466 | (@value{GDBP}) @b{tstop} | |
10467 | @end smallexample | |
10468 | ||
03f2bd59 | 10469 | @anchor{disconnected tracing} |
d5551862 SS |
10470 | @cindex disconnected tracing |
10471 | You can choose to continue running the trace experiment even if | |
10472 | @value{GDBN} disconnects from the target, voluntarily or | |
10473 | involuntarily. For commands such as @code{detach}, the debugger will | |
10474 | ask what you want to do with the trace. But for unexpected | |
10475 | terminations (@value{GDBN} crash, network outage), it would be | |
10476 | unfortunate to lose hard-won trace data, so the variable | |
10477 | @code{disconnected-tracing} lets you decide whether the trace should | |
10478 | continue running without @value{GDBN}. | |
10479 | ||
10480 | @table @code | |
10481 | @item set disconnected-tracing on | |
10482 | @itemx set disconnected-tracing off | |
10483 | @kindex set disconnected-tracing | |
10484 | Choose whether a tracing run should continue to run if @value{GDBN} | |
10485 | has disconnected from the target. Note that @code{detach} or | |
10486 | @code{quit} will ask you directly what to do about a running trace no | |
10487 | matter what this variable's setting, so the variable is mainly useful | |
10488 | for handling unexpected situations, such as loss of the network. | |
10489 | ||
10490 | @item show disconnected-tracing | |
10491 | @kindex show disconnected-tracing | |
10492 | Show the current choice for disconnected tracing. | |
10493 | ||
10494 | @end table | |
10495 | ||
10496 | When you reconnect to the target, the trace experiment may or may not | |
10497 | still be running; it might have filled the trace buffer in the | |
10498 | meantime, or stopped for one of the other reasons. If it is running, | |
10499 | it will continue after reconnection. | |
10500 | ||
10501 | Upon reconnection, the target will upload information about the | |
10502 | tracepoints in effect. @value{GDBN} will then compare that | |
10503 | information to the set of tracepoints currently defined, and attempt | |
10504 | to match them up, allowing for the possibility that the numbers may | |
10505 | have changed due to creation and deletion in the meantime. If one of | |
10506 | the target's tracepoints does not match any in @value{GDBN}, the | |
10507 | debugger will create a new tracepoint, so that you have a number with | |
10508 | which to specify that tracepoint. This matching-up process is | |
10509 | necessarily heuristic, and it may result in useless tracepoints being | |
10510 | created; you may simply delete them if they are of no use. | |
b37052ae | 10511 | |
4daf5ac0 SS |
10512 | @cindex circular trace buffer |
10513 | If your target agent supports a @dfn{circular trace buffer}, then you | |
10514 | can run a trace experiment indefinitely without filling the trace | |
10515 | buffer; when space runs out, the agent deletes already-collected trace | |
10516 | frames, oldest first, until there is enough room to continue | |
10517 | collecting. This is especially useful if your tracepoints are being | |
10518 | hit too often, and your trace gets terminated prematurely because the | |
10519 | buffer is full. To ask for a circular trace buffer, simply set | |
81896e36 | 10520 | @samp{circular-trace-buffer} to on. You can set this at any time, |
4daf5ac0 SS |
10521 | including during tracing; if the agent can do it, it will change |
10522 | buffer handling on the fly, otherwise it will not take effect until | |
10523 | the next run. | |
10524 | ||
10525 | @table @code | |
10526 | @item set circular-trace-buffer on | |
10527 | @itemx set circular-trace-buffer off | |
10528 | @kindex set circular-trace-buffer | |
10529 | Choose whether a tracing run should use a linear or circular buffer | |
10530 | for trace data. A linear buffer will not lose any trace data, but may | |
10531 | fill up prematurely, while a circular buffer will discard old trace | |
10532 | data, but it will have always room for the latest tracepoint hits. | |
10533 | ||
10534 | @item show circular-trace-buffer | |
10535 | @kindex show circular-trace-buffer | |
10536 | Show the current choice for the trace buffer. Note that this may not | |
10537 | match the agent's current buffer handling, nor is it guaranteed to | |
10538 | match the setting that might have been in effect during a past run, | |
10539 | for instance if you are looking at frames from a trace file. | |
10540 | ||
10541 | @end table | |
10542 | ||
c9429232 SS |
10543 | @node Tracepoint Restrictions |
10544 | @subsection Tracepoint Restrictions | |
10545 | ||
10546 | @cindex tracepoint restrictions | |
10547 | There are a number of restrictions on the use of tracepoints. As | |
10548 | described above, tracepoint data gathering occurs on the target | |
10549 | without interaction from @value{GDBN}. Thus the full capabilities of | |
10550 | the debugger are not available during data gathering, and then at data | |
10551 | examination time, you will be limited by only having what was | |
10552 | collected. The following items describe some common problems, but it | |
10553 | is not exhaustive, and you may run into additional difficulties not | |
10554 | mentioned here. | |
10555 | ||
10556 | @itemize @bullet | |
10557 | ||
10558 | @item | |
10559 | Tracepoint expressions are intended to gather objects (lvalues). Thus | |
10560 | the full flexibility of GDB's expression evaluator is not available. | |
10561 | You cannot call functions, cast objects to aggregate types, access | |
10562 | convenience variables or modify values (except by assignment to trace | |
10563 | state variables). Some language features may implicitly call | |
10564 | functions (for instance Objective-C fields with accessors), and therefore | |
10565 | cannot be collected either. | |
10566 | ||
10567 | @item | |
10568 | Collection of local variables, either individually or in bulk with | |
10569 | @code{$locals} or @code{$args}, during @code{while-stepping} may | |
10570 | behave erratically. The stepping action may enter a new scope (for | |
10571 | instance by stepping into a function), or the location of the variable | |
10572 | may change (for instance it is loaded into a register). The | |
10573 | tracepoint data recorded uses the location information for the | |
10574 | variables that is correct for the tracepoint location. When the | |
10575 | tracepoint is created, it is not possible, in general, to determine | |
10576 | where the steps of a @code{while-stepping} sequence will advance the | |
10577 | program---particularly if a conditional branch is stepped. | |
10578 | ||
10579 | @item | |
10580 | Collection of an incompletely-initialized or partially-destroyed object | |
10581 | may result in something that @value{GDBN} cannot display, or displays | |
10582 | in a misleading way. | |
10583 | ||
10584 | @item | |
10585 | When @value{GDBN} displays a pointer to character it automatically | |
10586 | dereferences the pointer to also display characters of the string | |
10587 | being pointed to. However, collecting the pointer during tracing does | |
10588 | not automatically collect the string. You need to explicitly | |
10589 | dereference the pointer and provide size information if you want to | |
10590 | collect not only the pointer, but the memory pointed to. For example, | |
10591 | @code{*ptr@@50} can be used to collect the 50 element array pointed to | |
10592 | by @code{ptr}. | |
10593 | ||
10594 | @item | |
10595 | It is not possible to collect a complete stack backtrace at a | |
10596 | tracepoint. Instead, you may collect the registers and a few hundred | |
10597 | bytes from the stack pointer with something like @code{*$esp@@300} | |
10598 | (adjust to use the name of the actual stack pointer register on your | |
10599 | target architecture, and the amount of stack you wish to capture). | |
10600 | Then the @code{backtrace} command will show a partial backtrace when | |
10601 | using a trace frame. The number of stack frames that can be examined | |
10602 | depends on the sizes of the frames in the collected stack. Note that | |
10603 | if you ask for a block so large that it goes past the bottom of the | |
10604 | stack, the target agent may report an error trying to read from an | |
10605 | invalid address. | |
10606 | ||
af54718e SS |
10607 | @item |
10608 | If you do not collect registers at a tracepoint, @value{GDBN} can | |
10609 | infer that the value of @code{$pc} must be the same as the address of | |
10610 | the tracepoint and use that when you are looking at a trace frame | |
10611 | for that tracepoint. However, this cannot work if the tracepoint has | |
10612 | multiple locations (for instance if it was set in a function that was | |
10613 | inlined), or if it has a @code{while-stepping} loop. In those cases | |
10614 | @value{GDBN} will warn you that it can't infer @code{$pc}, and default | |
10615 | it to zero. | |
10616 | ||
c9429232 SS |
10617 | @end itemize |
10618 | ||
b37052ae | 10619 | @node Analyze Collected Data |
79a6e687 | 10620 | @section Using the Collected Data |
b37052ae EZ |
10621 | |
10622 | After the tracepoint experiment ends, you use @value{GDBN} commands | |
10623 | for examining the trace data. The basic idea is that each tracepoint | |
10624 | collects a trace @dfn{snapshot} every time it is hit and another | |
10625 | snapshot every time it single-steps. All these snapshots are | |
10626 | consecutively numbered from zero and go into a buffer, and you can | |
10627 | examine them later. The way you examine them is to @dfn{focus} on a | |
10628 | specific trace snapshot. When the remote stub is focused on a trace | |
10629 | snapshot, it will respond to all @value{GDBN} requests for memory and | |
10630 | registers by reading from the buffer which belongs to that snapshot, | |
10631 | rather than from @emph{real} memory or registers of the program being | |
10632 | debugged. This means that @strong{all} @value{GDBN} commands | |
10633 | (@code{print}, @code{info registers}, @code{backtrace}, etc.) will | |
10634 | behave as if we were currently debugging the program state as it was | |
10635 | when the tracepoint occurred. Any requests for data that are not in | |
10636 | the buffer will fail. | |
10637 | ||
10638 | @menu | |
10639 | * tfind:: How to select a trace snapshot | |
10640 | * tdump:: How to display all data for a snapshot | |
6149aea9 | 10641 | * save tracepoints:: How to save tracepoints for a future run |
b37052ae EZ |
10642 | @end menu |
10643 | ||
10644 | @node tfind | |
10645 | @subsection @code{tfind @var{n}} | |
10646 | ||
10647 | @kindex tfind | |
10648 | @cindex select trace snapshot | |
10649 | @cindex find trace snapshot | |
10650 | The basic command for selecting a trace snapshot from the buffer is | |
10651 | @code{tfind @var{n}}, which finds trace snapshot number @var{n}, | |
10652 | counting from zero. If no argument @var{n} is given, the next | |
10653 | snapshot is selected. | |
10654 | ||
10655 | Here are the various forms of using the @code{tfind} command. | |
10656 | ||
10657 | @table @code | |
10658 | @item tfind start | |
10659 | Find the first snapshot in the buffer. This is a synonym for | |
10660 | @code{tfind 0} (since 0 is the number of the first snapshot). | |
10661 | ||
10662 | @item tfind none | |
10663 | Stop debugging trace snapshots, resume @emph{live} debugging. | |
10664 | ||
10665 | @item tfind end | |
10666 | Same as @samp{tfind none}. | |
10667 | ||
10668 | @item tfind | |
10669 | No argument means find the next trace snapshot. | |
10670 | ||
10671 | @item tfind - | |
10672 | Find the previous trace snapshot before the current one. This permits | |
10673 | retracing earlier steps. | |
10674 | ||
10675 | @item tfind tracepoint @var{num} | |
10676 | Find the next snapshot associated with tracepoint @var{num}. Search | |
10677 | proceeds forward from the last examined trace snapshot. If no | |
10678 | argument @var{num} is given, it means find the next snapshot collected | |
10679 | for the same tracepoint as the current snapshot. | |
10680 | ||
10681 | @item tfind pc @var{addr} | |
10682 | Find the next snapshot associated with the value @var{addr} of the | |
10683 | program counter. Search proceeds forward from the last examined trace | |
10684 | snapshot. If no argument @var{addr} is given, it means find the next | |
10685 | snapshot with the same value of PC as the current snapshot. | |
10686 | ||
10687 | @item tfind outside @var{addr1}, @var{addr2} | |
10688 | Find the next snapshot whose PC is outside the given range of | |
081dfbf7 | 10689 | addresses (exclusive). |
b37052ae EZ |
10690 | |
10691 | @item tfind range @var{addr1}, @var{addr2} | |
10692 | Find the next snapshot whose PC is between @var{addr1} and | |
081dfbf7 | 10693 | @var{addr2} (inclusive). |
b37052ae EZ |
10694 | |
10695 | @item tfind line @r{[}@var{file}:@r{]}@var{n} | |
10696 | Find the next snapshot associated with the source line @var{n}. If | |
10697 | the optional argument @var{file} is given, refer to line @var{n} in | |
10698 | that source file. Search proceeds forward from the last examined | |
10699 | trace snapshot. If no argument @var{n} is given, it means find the | |
10700 | next line other than the one currently being examined; thus saying | |
10701 | @code{tfind line} repeatedly can appear to have the same effect as | |
10702 | stepping from line to line in a @emph{live} debugging session. | |
10703 | @end table | |
10704 | ||
10705 | The default arguments for the @code{tfind} commands are specifically | |
10706 | designed to make it easy to scan through the trace buffer. For | |
10707 | instance, @code{tfind} with no argument selects the next trace | |
10708 | snapshot, and @code{tfind -} with no argument selects the previous | |
10709 | trace snapshot. So, by giving one @code{tfind} command, and then | |
10710 | simply hitting @key{RET} repeatedly you can examine all the trace | |
10711 | snapshots in order. Or, by saying @code{tfind -} and then hitting | |
10712 | @key{RET} repeatedly you can examine the snapshots in reverse order. | |
10713 | The @code{tfind line} command with no argument selects the snapshot | |
10714 | for the next source line executed. The @code{tfind pc} command with | |
10715 | no argument selects the next snapshot with the same program counter | |
10716 | (PC) as the current frame. The @code{tfind tracepoint} command with | |
10717 | no argument selects the next trace snapshot collected by the same | |
10718 | tracepoint as the current one. | |
10719 | ||
10720 | In addition to letting you scan through the trace buffer manually, | |
10721 | these commands make it easy to construct @value{GDBN} scripts that | |
10722 | scan through the trace buffer and print out whatever collected data | |
10723 | you are interested in. Thus, if we want to examine the PC, FP, and SP | |
10724 | registers from each trace frame in the buffer, we can say this: | |
10725 | ||
10726 | @smallexample | |
10727 | (@value{GDBP}) @b{tfind start} | |
10728 | (@value{GDBP}) @b{while ($trace_frame != -1)} | |
10729 | > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \ | |
10730 | $trace_frame, $pc, $sp, $fp | |
10731 | > tfind | |
10732 | > end | |
10733 | ||
10734 | Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44 | |
10735 | Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44 | |
10736 | Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44 | |
10737 | Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44 | |
10738 | Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44 | |
10739 | Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44 | |
10740 | Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44 | |
10741 | Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44 | |
10742 | Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44 | |
10743 | Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44 | |
10744 | Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14 | |
10745 | @end smallexample | |
10746 | ||
10747 | Or, if we want to examine the variable @code{X} at each source line in | |
10748 | the buffer: | |
10749 | ||
10750 | @smallexample | |
10751 | (@value{GDBP}) @b{tfind start} | |
10752 | (@value{GDBP}) @b{while ($trace_frame != -1)} | |
10753 | > printf "Frame %d, X == %d\n", $trace_frame, X | |
10754 | > tfind line | |
10755 | > end | |
10756 | ||
10757 | Frame 0, X = 1 | |
10758 | Frame 7, X = 2 | |
10759 | Frame 13, X = 255 | |
10760 | @end smallexample | |
10761 | ||
10762 | @node tdump | |
10763 | @subsection @code{tdump} | |
10764 | @kindex tdump | |
10765 | @cindex dump all data collected at tracepoint | |
10766 | @cindex tracepoint data, display | |
10767 | ||
10768 | This command takes no arguments. It prints all the data collected at | |
10769 | the current trace snapshot. | |
10770 | ||
10771 | @smallexample | |
10772 | (@value{GDBP}) @b{trace 444} | |
10773 | (@value{GDBP}) @b{actions} | |
10774 | Enter actions for tracepoint #2, one per line: | |
10775 | > collect $regs, $locals, $args, gdb_long_test | |
10776 | > end | |
10777 | ||
10778 | (@value{GDBP}) @b{tstart} | |
10779 | ||
10780 | (@value{GDBP}) @b{tfind line 444} | |
10781 | #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66) | |
10782 | at gdb_test.c:444 | |
10783 | 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", ) | |
10784 | ||
10785 | (@value{GDBP}) @b{tdump} | |
10786 | Data collected at tracepoint 2, trace frame 1: | |
10787 | d0 0xc4aa0085 -995491707 | |
10788 | d1 0x18 24 | |
10789 | d2 0x80 128 | |
10790 | d3 0x33 51 | |
10791 | d4 0x71aea3d 119204413 | |
10792 | d5 0x22 34 | |
10793 | d6 0xe0 224 | |
10794 | d7 0x380035 3670069 | |
10795 | a0 0x19e24a 1696330 | |
10796 | a1 0x3000668 50333288 | |
10797 | a2 0x100 256 | |
10798 | a3 0x322000 3284992 | |
10799 | a4 0x3000698 50333336 | |
10800 | a5 0x1ad3cc 1758156 | |
10801 | fp 0x30bf3c 0x30bf3c | |
10802 | sp 0x30bf34 0x30bf34 | |
10803 | ps 0x0 0 | |
10804 | pc 0x20b2c8 0x20b2c8 | |
10805 | fpcontrol 0x0 0 | |
10806 | fpstatus 0x0 0 | |
10807 | fpiaddr 0x0 0 | |
10808 | p = 0x20e5b4 "gdb-test" | |
10809 | p1 = (void *) 0x11 | |
10810 | p2 = (void *) 0x22 | |
10811 | p3 = (void *) 0x33 | |
10812 | p4 = (void *) 0x44 | |
10813 | p5 = (void *) 0x55 | |
10814 | p6 = (void *) 0x66 | |
10815 | gdb_long_test = 17 '\021' | |
10816 | ||
10817 | (@value{GDBP}) | |
10818 | @end smallexample | |
10819 | ||
af54718e SS |
10820 | @code{tdump} works by scanning the tracepoint's current collection |
10821 | actions and printing the value of each expression listed. So | |
10822 | @code{tdump} can fail, if after a run, you change the tracepoint's | |
10823 | actions to mention variables that were not collected during the run. | |
10824 | ||
10825 | Also, for tracepoints with @code{while-stepping} loops, @code{tdump} | |
10826 | uses the collected value of @code{$pc} to distinguish between trace | |
10827 | frames that were collected at the tracepoint hit, and frames that were | |
10828 | collected while stepping. This allows it to correctly choose whether | |
10829 | to display the basic list of collections, or the collections from the | |
10830 | body of the while-stepping loop. However, if @code{$pc} was not collected, | |
10831 | then @code{tdump} will always attempt to dump using the basic collection | |
10832 | list, and may fail if a while-stepping frame does not include all the | |
10833 | same data that is collected at the tracepoint hit. | |
10834 | @c This is getting pretty arcane, example would be good. | |
10835 | ||
6149aea9 PA |
10836 | @node save tracepoints |
10837 | @subsection @code{save tracepoints @var{filename}} | |
10838 | @kindex save tracepoints | |
b37052ae EZ |
10839 | @kindex save-tracepoints |
10840 | @cindex save tracepoints for future sessions | |
10841 | ||
10842 | This command saves all current tracepoint definitions together with | |
10843 | their actions and passcounts, into a file @file{@var{filename}} | |
10844 | suitable for use in a later debugging session. To read the saved | |
10845 | tracepoint definitions, use the @code{source} command (@pxref{Command | |
6149aea9 PA |
10846 | Files}). The @w{@code{save-tracepoints}} command is a deprecated |
10847 | alias for @w{@code{save tracepoints}} | |
b37052ae EZ |
10848 | |
10849 | @node Tracepoint Variables | |
10850 | @section Convenience Variables for Tracepoints | |
10851 | @cindex tracepoint variables | |
10852 | @cindex convenience variables for tracepoints | |
10853 | ||
10854 | @table @code | |
10855 | @vindex $trace_frame | |
10856 | @item (int) $trace_frame | |
10857 | The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no | |
10858 | snapshot is selected. | |
10859 | ||
10860 | @vindex $tracepoint | |
10861 | @item (int) $tracepoint | |
10862 | The tracepoint for the current trace snapshot. | |
10863 | ||
10864 | @vindex $trace_line | |
10865 | @item (int) $trace_line | |
10866 | The line number for the current trace snapshot. | |
10867 | ||
10868 | @vindex $trace_file | |
10869 | @item (char []) $trace_file | |
10870 | The source file for the current trace snapshot. | |
10871 | ||
10872 | @vindex $trace_func | |
10873 | @item (char []) $trace_func | |
10874 | The name of the function containing @code{$tracepoint}. | |
10875 | @end table | |
10876 | ||
10877 | Note: @code{$trace_file} is not suitable for use in @code{printf}, | |
10878 | use @code{output} instead. | |
10879 | ||
10880 | Here's a simple example of using these convenience variables for | |
10881 | stepping through all the trace snapshots and printing some of their | |
f61e138d SS |
10882 | data. Note that these are not the same as trace state variables, |
10883 | which are managed by the target. | |
b37052ae EZ |
10884 | |
10885 | @smallexample | |
10886 | (@value{GDBP}) @b{tfind start} | |
10887 | ||
10888 | (@value{GDBP}) @b{while $trace_frame != -1} | |
10889 | > output $trace_file | |
10890 | > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint | |
10891 | > tfind | |
10892 | > end | |
10893 | @end smallexample | |
10894 | ||
00bf0b85 SS |
10895 | @node Trace Files |
10896 | @section Using Trace Files | |
10897 | @cindex trace files | |
10898 | ||
10899 | In some situations, the target running a trace experiment may no | |
10900 | longer be available; perhaps it crashed, or the hardware was needed | |
10901 | for a different activity. To handle these cases, you can arrange to | |
10902 | dump the trace data into a file, and later use that file as a source | |
10903 | of trace data, via the @code{target tfile} command. | |
10904 | ||
10905 | @table @code | |
10906 | ||
10907 | @kindex tsave | |
10908 | @item tsave [ -r ] @var{filename} | |
10909 | Save the trace data to @var{filename}. By default, this command | |
10910 | assumes that @var{filename} refers to the host filesystem, so if | |
10911 | necessary @value{GDBN} will copy raw trace data up from the target and | |
10912 | then save it. If the target supports it, you can also supply the | |
10913 | optional argument @code{-r} (``remote'') to direct the target to save | |
10914 | the data directly into @var{filename} in its own filesystem, which may be | |
10915 | more efficient if the trace buffer is very large. (Note, however, that | |
10916 | @code{target tfile} can only read from files accessible to the host.) | |
10917 | ||
10918 | @kindex target tfile | |
10919 | @kindex tfile | |
10920 | @item target tfile @var{filename} | |
10921 | Use the file named @var{filename} as a source of trace data. Commands | |
10922 | that examine data work as they do with a live target, but it is not | |
10923 | possible to run any new trace experiments. @code{tstatus} will report | |
10924 | the state of the trace run at the moment the data was saved, as well | |
10925 | as the current trace frame you are examining. @var{filename} must be | |
10926 | on a filesystem accessible to the host. | |
10927 | ||
10928 | @end table | |
10929 | ||
df0cd8c5 JB |
10930 | @node Overlays |
10931 | @chapter Debugging Programs That Use Overlays | |
10932 | @cindex overlays | |
10933 | ||
10934 | If your program is too large to fit completely in your target system's | |
10935 | memory, you can sometimes use @dfn{overlays} to work around this | |
10936 | problem. @value{GDBN} provides some support for debugging programs that | |
10937 | use overlays. | |
10938 | ||
10939 | @menu | |
10940 | * How Overlays Work:: A general explanation of overlays. | |
10941 | * Overlay Commands:: Managing overlays in @value{GDBN}. | |
10942 | * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are | |
10943 | mapped by asking the inferior. | |
10944 | * Overlay Sample Program:: A sample program using overlays. | |
10945 | @end menu | |
10946 | ||
10947 | @node How Overlays Work | |
10948 | @section How Overlays Work | |
10949 | @cindex mapped overlays | |
10950 | @cindex unmapped overlays | |
10951 | @cindex load address, overlay's | |
10952 | @cindex mapped address | |
10953 | @cindex overlay area | |
10954 | ||
10955 | Suppose you have a computer whose instruction address space is only 64 | |
10956 | kilobytes long, but which has much more memory which can be accessed by | |
10957 | other means: special instructions, segment registers, or memory | |
10958 | management hardware, for example. Suppose further that you want to | |
10959 | adapt a program which is larger than 64 kilobytes to run on this system. | |
10960 | ||
10961 | One solution is to identify modules of your program which are relatively | |
10962 | independent, and need not call each other directly; call these modules | |
10963 | @dfn{overlays}. Separate the overlays from the main program, and place | |
10964 | their machine code in the larger memory. Place your main program in | |
10965 | instruction memory, but leave at least enough space there to hold the | |
10966 | largest overlay as well. | |
10967 | ||
10968 | Now, to call a function located in an overlay, you must first copy that | |
10969 | overlay's machine code from the large memory into the space set aside | |
10970 | for it in the instruction memory, and then jump to its entry point | |
10971 | there. | |
10972 | ||
c928edc0 AC |
10973 | @c NB: In the below the mapped area's size is greater or equal to the |
10974 | @c size of all overlays. This is intentional to remind the developer | |
10975 | @c that overlays don't necessarily need to be the same size. | |
10976 | ||
474c8240 | 10977 | @smallexample |
df0cd8c5 | 10978 | @group |
c928edc0 AC |
10979 | Data Instruction Larger |
10980 | Address Space Address Space Address Space | |
10981 | +-----------+ +-----------+ +-----------+ | |
10982 | | | | | | | | |
10983 | +-----------+ +-----------+ +-----------+<-- overlay 1 | |
10984 | | program | | main | .----| overlay 1 | load address | |
10985 | | variables | | program | | +-----------+ | |
10986 | | and heap | | | | | | | |
10987 | +-----------+ | | | +-----------+<-- overlay 2 | |
10988 | | | +-----------+ | | | load address | |
10989 | +-----------+ | | | .-| overlay 2 | | |
10990 | | | | | | | | |
10991 | mapped --->+-----------+ | | +-----------+ | |
10992 | address | | | | | | | |
10993 | | overlay | <-' | | | | |
10994 | | area | <---' +-----------+<-- overlay 3 | |
10995 | | | <---. | | load address | |
10996 | +-----------+ `--| overlay 3 | | |
10997 | | | | | | |
10998 | +-----------+ | | | |
10999 | +-----------+ | |
11000 | | | | |
11001 | +-----------+ | |
11002 | ||
11003 | @anchor{A code overlay}A code overlay | |
df0cd8c5 | 11004 | @end group |
474c8240 | 11005 | @end smallexample |
df0cd8c5 | 11006 | |
c928edc0 AC |
11007 | The diagram (@pxref{A code overlay}) shows a system with separate data |
11008 | and instruction address spaces. To map an overlay, the program copies | |
11009 | its code from the larger address space to the instruction address space. | |
11010 | Since the overlays shown here all use the same mapped address, only one | |
11011 | may be mapped at a time. For a system with a single address space for | |
11012 | data and instructions, the diagram would be similar, except that the | |
11013 | program variables and heap would share an address space with the main | |
11014 | program and the overlay area. | |
df0cd8c5 JB |
11015 | |
11016 | An overlay loaded into instruction memory and ready for use is called a | |
11017 | @dfn{mapped} overlay; its @dfn{mapped address} is its address in the | |
11018 | instruction memory. An overlay not present (or only partially present) | |
11019 | in instruction memory is called @dfn{unmapped}; its @dfn{load address} | |
11020 | is its address in the larger memory. The mapped address is also called | |
11021 | the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also | |
11022 | called the @dfn{load memory address}, or @dfn{LMA}. | |
11023 | ||
11024 | Unfortunately, overlays are not a completely transparent way to adapt a | |
11025 | program to limited instruction memory. They introduce a new set of | |
11026 | global constraints you must keep in mind as you design your program: | |
11027 | ||
11028 | @itemize @bullet | |
11029 | ||
11030 | @item | |
11031 | Before calling or returning to a function in an overlay, your program | |
11032 | must make sure that overlay is actually mapped. Otherwise, the call or | |
11033 | return will transfer control to the right address, but in the wrong | |
11034 | overlay, and your program will probably crash. | |
11035 | ||
11036 | @item | |
11037 | If the process of mapping an overlay is expensive on your system, you | |
11038 | will need to choose your overlays carefully to minimize their effect on | |
11039 | your program's performance. | |
11040 | ||
11041 | @item | |
11042 | The executable file you load onto your system must contain each | |
11043 | overlay's instructions, appearing at the overlay's load address, not its | |
11044 | mapped address. However, each overlay's instructions must be relocated | |
11045 | and its symbols defined as if the overlay were at its mapped address. | |
11046 | You can use GNU linker scripts to specify different load and relocation | |
11047 | addresses for pieces of your program; see @ref{Overlay Description,,, | |
11048 | ld.info, Using ld: the GNU linker}. | |
11049 | ||
11050 | @item | |
11051 | The procedure for loading executable files onto your system must be able | |
11052 | to load their contents into the larger address space as well as the | |
11053 | instruction and data spaces. | |
11054 | ||
11055 | @end itemize | |
11056 | ||
11057 | The overlay system described above is rather simple, and could be | |
11058 | improved in many ways: | |
11059 | ||
11060 | @itemize @bullet | |
11061 | ||
11062 | @item | |
11063 | If your system has suitable bank switch registers or memory management | |
11064 | hardware, you could use those facilities to make an overlay's load area | |
11065 | contents simply appear at their mapped address in instruction space. | |
11066 | This would probably be faster than copying the overlay to its mapped | |
11067 | area in the usual way. | |
11068 | ||
11069 | @item | |
11070 | If your overlays are small enough, you could set aside more than one | |
11071 | overlay area, and have more than one overlay mapped at a time. | |
11072 | ||
11073 | @item | |
11074 | You can use overlays to manage data, as well as instructions. In | |
11075 | general, data overlays are even less transparent to your design than | |
11076 | code overlays: whereas code overlays only require care when you call or | |
11077 | return to functions, data overlays require care every time you access | |
11078 | the data. Also, if you change the contents of a data overlay, you | |
11079 | must copy its contents back out to its load address before you can copy a | |
11080 | different data overlay into the same mapped area. | |
11081 | ||
11082 | @end itemize | |
11083 | ||
11084 | ||
11085 | @node Overlay Commands | |
11086 | @section Overlay Commands | |
11087 | ||
11088 | To use @value{GDBN}'s overlay support, each overlay in your program must | |
11089 | correspond to a separate section of the executable file. The section's | |
11090 | virtual memory address and load memory address must be the overlay's | |
11091 | mapped and load addresses. Identifying overlays with sections allows | |
11092 | @value{GDBN} to determine the appropriate address of a function or | |
11093 | variable, depending on whether the overlay is mapped or not. | |
11094 | ||
11095 | @value{GDBN}'s overlay commands all start with the word @code{overlay}; | |
11096 | you can abbreviate this as @code{ov} or @code{ovly}. The commands are: | |
11097 | ||
11098 | @table @code | |
11099 | @item overlay off | |
4644b6e3 | 11100 | @kindex overlay |
df0cd8c5 JB |
11101 | Disable @value{GDBN}'s overlay support. When overlay support is |
11102 | disabled, @value{GDBN} assumes that all functions and variables are | |
11103 | always present at their mapped addresses. By default, @value{GDBN}'s | |
11104 | overlay support is disabled. | |
11105 | ||
11106 | @item overlay manual | |
df0cd8c5 JB |
11107 | @cindex manual overlay debugging |
11108 | Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN} | |
11109 | relies on you to tell it which overlays are mapped, and which are not, | |
11110 | using the @code{overlay map-overlay} and @code{overlay unmap-overlay} | |
11111 | commands described below. | |
11112 | ||
11113 | @item overlay map-overlay @var{overlay} | |
11114 | @itemx overlay map @var{overlay} | |
df0cd8c5 JB |
11115 | @cindex map an overlay |
11116 | Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must | |
11117 | be the name of the object file section containing the overlay. When an | |
11118 | overlay is mapped, @value{GDBN} assumes it can find the overlay's | |
11119 | functions and variables at their mapped addresses. @value{GDBN} assumes | |
11120 | that any other overlays whose mapped ranges overlap that of | |
11121 | @var{overlay} are now unmapped. | |
11122 | ||
11123 | @item overlay unmap-overlay @var{overlay} | |
11124 | @itemx overlay unmap @var{overlay} | |
df0cd8c5 JB |
11125 | @cindex unmap an overlay |
11126 | Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay} | |
11127 | must be the name of the object file section containing the overlay. | |
11128 | When an overlay is unmapped, @value{GDBN} assumes it can find the | |
11129 | overlay's functions and variables at their load addresses. | |
11130 | ||
11131 | @item overlay auto | |
df0cd8c5 JB |
11132 | Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN} |
11133 | consults a data structure the overlay manager maintains in the inferior | |
11134 | to see which overlays are mapped. For details, see @ref{Automatic | |
11135 | Overlay Debugging}. | |
11136 | ||
11137 | @item overlay load-target | |
11138 | @itemx overlay load | |
df0cd8c5 JB |
11139 | @cindex reloading the overlay table |
11140 | Re-read the overlay table from the inferior. Normally, @value{GDBN} | |
11141 | re-reads the table @value{GDBN} automatically each time the inferior | |
11142 | stops, so this command should only be necessary if you have changed the | |
11143 | overlay mapping yourself using @value{GDBN}. This command is only | |
11144 | useful when using automatic overlay debugging. | |
11145 | ||
11146 | @item overlay list-overlays | |
11147 | @itemx overlay list | |
11148 | @cindex listing mapped overlays | |
11149 | Display a list of the overlays currently mapped, along with their mapped | |
11150 | addresses, load addresses, and sizes. | |
11151 | ||
11152 | @end table | |
11153 | ||
11154 | Normally, when @value{GDBN} prints a code address, it includes the name | |
11155 | of the function the address falls in: | |
11156 | ||
474c8240 | 11157 | @smallexample |
f7dc1244 | 11158 | (@value{GDBP}) print main |
df0cd8c5 | 11159 | $3 = @{int ()@} 0x11a0 <main> |
474c8240 | 11160 | @end smallexample |
df0cd8c5 JB |
11161 | @noindent |
11162 | When overlay debugging is enabled, @value{GDBN} recognizes code in | |
11163 | unmapped overlays, and prints the names of unmapped functions with | |
11164 | asterisks around them. For example, if @code{foo} is a function in an | |
11165 | unmapped overlay, @value{GDBN} prints it this way: | |
11166 | ||
474c8240 | 11167 | @smallexample |
f7dc1244 | 11168 | (@value{GDBP}) overlay list |
df0cd8c5 | 11169 | No sections are mapped. |
f7dc1244 | 11170 | (@value{GDBP}) print foo |
df0cd8c5 | 11171 | $5 = @{int (int)@} 0x100000 <*foo*> |
474c8240 | 11172 | @end smallexample |
df0cd8c5 JB |
11173 | @noindent |
11174 | When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's | |
11175 | name normally: | |
11176 | ||
474c8240 | 11177 | @smallexample |
f7dc1244 | 11178 | (@value{GDBP}) overlay list |
b383017d | 11179 | Section .ov.foo.text, loaded at 0x100000 - 0x100034, |
df0cd8c5 | 11180 | mapped at 0x1016 - 0x104a |
f7dc1244 | 11181 | (@value{GDBP}) print foo |
df0cd8c5 | 11182 | $6 = @{int (int)@} 0x1016 <foo> |
474c8240 | 11183 | @end smallexample |
df0cd8c5 JB |
11184 | |
11185 | When overlay debugging is enabled, @value{GDBN} can find the correct | |
11186 | address for functions and variables in an overlay, whether or not the | |
11187 | overlay is mapped. This allows most @value{GDBN} commands, like | |
11188 | @code{break} and @code{disassemble}, to work normally, even on unmapped | |
11189 | code. However, @value{GDBN}'s breakpoint support has some limitations: | |
11190 | ||
11191 | @itemize @bullet | |
11192 | @item | |
11193 | @cindex breakpoints in overlays | |
11194 | @cindex overlays, setting breakpoints in | |
11195 | You can set breakpoints in functions in unmapped overlays, as long as | |
11196 | @value{GDBN} can write to the overlay at its load address. | |
11197 | @item | |
11198 | @value{GDBN} can not set hardware or simulator-based breakpoints in | |
11199 | unmapped overlays. However, if you set a breakpoint at the end of your | |
11200 | overlay manager (and tell @value{GDBN} which overlays are now mapped, if | |
11201 | you are using manual overlay management), @value{GDBN} will re-set its | |
11202 | breakpoints properly. | |
11203 | @end itemize | |
11204 | ||
11205 | ||
11206 | @node Automatic Overlay Debugging | |
11207 | @section Automatic Overlay Debugging | |
11208 | @cindex automatic overlay debugging | |
11209 | ||
11210 | @value{GDBN} can automatically track which overlays are mapped and which | |
11211 | are not, given some simple co-operation from the overlay manager in the | |
11212 | inferior. If you enable automatic overlay debugging with the | |
11213 | @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN} | |
11214 | looks in the inferior's memory for certain variables describing the | |
11215 | current state of the overlays. | |
11216 | ||
11217 | Here are the variables your overlay manager must define to support | |
11218 | @value{GDBN}'s automatic overlay debugging: | |
11219 | ||
11220 | @table @asis | |
11221 | ||
11222 | @item @code{_ovly_table}: | |
11223 | This variable must be an array of the following structures: | |
11224 | ||
474c8240 | 11225 | @smallexample |
df0cd8c5 JB |
11226 | struct |
11227 | @{ | |
11228 | /* The overlay's mapped address. */ | |
11229 | unsigned long vma; | |
11230 | ||
11231 | /* The size of the overlay, in bytes. */ | |
11232 | unsigned long size; | |
11233 | ||
11234 | /* The overlay's load address. */ | |
11235 | unsigned long lma; | |
11236 | ||
11237 | /* Non-zero if the overlay is currently mapped; | |
11238 | zero otherwise. */ | |
11239 | unsigned long mapped; | |
11240 | @} | |
474c8240 | 11241 | @end smallexample |
df0cd8c5 JB |
11242 | |
11243 | @item @code{_novlys}: | |
11244 | This variable must be a four-byte signed integer, holding the total | |
11245 | number of elements in @code{_ovly_table}. | |
11246 | ||
11247 | @end table | |
11248 | ||
11249 | To decide whether a particular overlay is mapped or not, @value{GDBN} | |
11250 | looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and | |
11251 | @code{lma} members equal the VMA and LMA of the overlay's section in the | |
11252 | executable file. When @value{GDBN} finds a matching entry, it consults | |
11253 | the entry's @code{mapped} member to determine whether the overlay is | |
11254 | currently mapped. | |
11255 | ||
81d46470 | 11256 | In addition, your overlay manager may define a function called |
def71bfa | 11257 | @code{_ovly_debug_event}. If this function is defined, @value{GDBN} |
81d46470 MS |
11258 | will silently set a breakpoint there. If the overlay manager then |
11259 | calls this function whenever it has changed the overlay table, this | |
11260 | will enable @value{GDBN} to accurately keep track of which overlays | |
11261 | are in program memory, and update any breakpoints that may be set | |
b383017d | 11262 | in overlays. This will allow breakpoints to work even if the |
81d46470 MS |
11263 | overlays are kept in ROM or other non-writable memory while they |
11264 | are not being executed. | |
df0cd8c5 JB |
11265 | |
11266 | @node Overlay Sample Program | |
11267 | @section Overlay Sample Program | |
11268 | @cindex overlay example program | |
11269 | ||
11270 | When linking a program which uses overlays, you must place the overlays | |
11271 | at their load addresses, while relocating them to run at their mapped | |
11272 | addresses. To do this, you must write a linker script (@pxref{Overlay | |
11273 | Description,,, ld.info, Using ld: the GNU linker}). Unfortunately, | |
11274 | since linker scripts are specific to a particular host system, target | |
11275 | architecture, and target memory layout, this manual cannot provide | |
11276 | portable sample code demonstrating @value{GDBN}'s overlay support. | |
11277 | ||
11278 | However, the @value{GDBN} source distribution does contain an overlaid | |
11279 | program, with linker scripts for a few systems, as part of its test | |
11280 | suite. The program consists of the following files from | |
11281 | @file{gdb/testsuite/gdb.base}: | |
11282 | ||
11283 | @table @file | |
11284 | @item overlays.c | |
11285 | The main program file. | |
11286 | @item ovlymgr.c | |
11287 | A simple overlay manager, used by @file{overlays.c}. | |
11288 | @item foo.c | |
11289 | @itemx bar.c | |
11290 | @itemx baz.c | |
11291 | @itemx grbx.c | |
11292 | Overlay modules, loaded and used by @file{overlays.c}. | |
11293 | @item d10v.ld | |
11294 | @itemx m32r.ld | |
11295 | Linker scripts for linking the test program on the @code{d10v-elf} | |
11296 | and @code{m32r-elf} targets. | |
11297 | @end table | |
11298 | ||
11299 | You can build the test program using the @code{d10v-elf} GCC | |
11300 | cross-compiler like this: | |
11301 | ||
474c8240 | 11302 | @smallexample |
df0cd8c5 JB |
11303 | $ d10v-elf-gcc -g -c overlays.c |
11304 | $ d10v-elf-gcc -g -c ovlymgr.c | |
11305 | $ d10v-elf-gcc -g -c foo.c | |
11306 | $ d10v-elf-gcc -g -c bar.c | |
11307 | $ d10v-elf-gcc -g -c baz.c | |
11308 | $ d10v-elf-gcc -g -c grbx.c | |
11309 | $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \ | |
11310 | baz.o grbx.o -Wl,-Td10v.ld -o overlays | |
474c8240 | 11311 | @end smallexample |
df0cd8c5 JB |
11312 | |
11313 | The build process is identical for any other architecture, except that | |
11314 | you must substitute the appropriate compiler and linker script for the | |
11315 | target system for @code{d10v-elf-gcc} and @code{d10v.ld}. | |
11316 | ||
11317 | ||
6d2ebf8b | 11318 | @node Languages |
c906108c SS |
11319 | @chapter Using @value{GDBN} with Different Languages |
11320 | @cindex languages | |
11321 | ||
c906108c SS |
11322 | Although programming languages generally have common aspects, they are |
11323 | rarely expressed in the same manner. For instance, in ANSI C, | |
11324 | dereferencing a pointer @code{p} is accomplished by @code{*p}, but in | |
11325 | Modula-2, it is accomplished by @code{p^}. Values can also be | |
5d161b24 | 11326 | represented (and displayed) differently. Hex numbers in C appear as |
c906108c | 11327 | @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}. |
c906108c SS |
11328 | |
11329 | @cindex working language | |
11330 | Language-specific information is built into @value{GDBN} for some languages, | |
11331 | allowing you to express operations like the above in your program's | |
11332 | native language, and allowing @value{GDBN} to output values in a manner | |
11333 | consistent with the syntax of your program's native language. The | |
11334 | language you use to build expressions is called the @dfn{working | |
11335 | language}. | |
11336 | ||
11337 | @menu | |
11338 | * Setting:: Switching between source languages | |
11339 | * Show:: Displaying the language | |
c906108c | 11340 | * Checks:: Type and range checks |
79a6e687 BW |
11341 | * Supported Languages:: Supported languages |
11342 | * Unsupported Languages:: Unsupported languages | |
c906108c SS |
11343 | @end menu |
11344 | ||
6d2ebf8b | 11345 | @node Setting |
79a6e687 | 11346 | @section Switching Between Source Languages |
c906108c SS |
11347 | |
11348 | There are two ways to control the working language---either have @value{GDBN} | |
11349 | set it automatically, or select it manually yourself. You can use the | |
11350 | @code{set language} command for either purpose. On startup, @value{GDBN} | |
11351 | defaults to setting the language automatically. The working language is | |
11352 | used to determine how expressions you type are interpreted, how values | |
11353 | are printed, etc. | |
11354 | ||
11355 | In addition to the working language, every source file that | |
11356 | @value{GDBN} knows about has its own working language. For some object | |
11357 | file formats, the compiler might indicate which language a particular | |
11358 | source file is in. However, most of the time @value{GDBN} infers the | |
11359 | language from the name of the file. The language of a source file | |
b37052ae | 11360 | controls whether C@t{++} names are demangled---this way @code{backtrace} can |
c906108c | 11361 | show each frame appropriately for its own language. There is no way to |
d4f3574e SS |
11362 | set the language of a source file from within @value{GDBN}, but you can |
11363 | set the language associated with a filename extension. @xref{Show, , | |
79a6e687 | 11364 | Displaying the Language}. |
c906108c SS |
11365 | |
11366 | This is most commonly a problem when you use a program, such | |
5d161b24 | 11367 | as @code{cfront} or @code{f2c}, that generates C but is written in |
c906108c SS |
11368 | another language. In that case, make the |
11369 | program use @code{#line} directives in its C output; that way | |
11370 | @value{GDBN} will know the correct language of the source code of the original | |
11371 | program, and will display that source code, not the generated C code. | |
11372 | ||
11373 | @menu | |
11374 | * Filenames:: Filename extensions and languages. | |
11375 | * Manually:: Setting the working language manually | |
11376 | * Automatically:: Having @value{GDBN} infer the source language | |
11377 | @end menu | |
11378 | ||
6d2ebf8b | 11379 | @node Filenames |
79a6e687 | 11380 | @subsection List of Filename Extensions and Languages |
c906108c SS |
11381 | |
11382 | If a source file name ends in one of the following extensions, then | |
11383 | @value{GDBN} infers that its language is the one indicated. | |
11384 | ||
11385 | @table @file | |
e07c999f PH |
11386 | @item .ada |
11387 | @itemx .ads | |
11388 | @itemx .adb | |
11389 | @itemx .a | |
11390 | Ada source file. | |
c906108c SS |
11391 | |
11392 | @item .c | |
11393 | C source file | |
11394 | ||
11395 | @item .C | |
11396 | @itemx .cc | |
11397 | @itemx .cp | |
11398 | @itemx .cpp | |
11399 | @itemx .cxx | |
11400 | @itemx .c++ | |
b37052ae | 11401 | C@t{++} source file |
c906108c | 11402 | |
6aecb9c2 JB |
11403 | @item .d |
11404 | D source file | |
11405 | ||
b37303ee AF |
11406 | @item .m |
11407 | Objective-C source file | |
11408 | ||
c906108c SS |
11409 | @item .f |
11410 | @itemx .F | |
11411 | Fortran source file | |
11412 | ||
c906108c SS |
11413 | @item .mod |
11414 | Modula-2 source file | |
c906108c SS |
11415 | |
11416 | @item .s | |
11417 | @itemx .S | |
11418 | Assembler source file. This actually behaves almost like C, but | |
11419 | @value{GDBN} does not skip over function prologues when stepping. | |
11420 | @end table | |
11421 | ||
11422 | In addition, you may set the language associated with a filename | |
79a6e687 | 11423 | extension. @xref{Show, , Displaying the Language}. |
c906108c | 11424 | |
6d2ebf8b | 11425 | @node Manually |
79a6e687 | 11426 | @subsection Setting the Working Language |
c906108c SS |
11427 | |
11428 | If you allow @value{GDBN} to set the language automatically, | |
11429 | expressions are interpreted the same way in your debugging session and | |
11430 | your program. | |
11431 | ||
11432 | @kindex set language | |
11433 | If you wish, you may set the language manually. To do this, issue the | |
11434 | command @samp{set language @var{lang}}, where @var{lang} is the name of | |
5d161b24 | 11435 | a language, such as |
c906108c | 11436 | @code{c} or @code{modula-2}. |
c906108c SS |
11437 | For a list of the supported languages, type @samp{set language}. |
11438 | ||
c906108c SS |
11439 | Setting the language manually prevents @value{GDBN} from updating the working |
11440 | language automatically. This can lead to confusion if you try | |
11441 | to debug a program when the working language is not the same as the | |
11442 | source language, when an expression is acceptable to both | |
11443 | languages---but means different things. For instance, if the current | |
11444 | source file were written in C, and @value{GDBN} was parsing Modula-2, a | |
11445 | command such as: | |
11446 | ||
474c8240 | 11447 | @smallexample |
c906108c | 11448 | print a = b + c |
474c8240 | 11449 | @end smallexample |
c906108c SS |
11450 | |
11451 | @noindent | |
11452 | might not have the effect you intended. In C, this means to add | |
11453 | @code{b} and @code{c} and place the result in @code{a}. The result | |
11454 | printed would be the value of @code{a}. In Modula-2, this means to compare | |
11455 | @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value. | |
c906108c | 11456 | |
6d2ebf8b | 11457 | @node Automatically |
79a6e687 | 11458 | @subsection Having @value{GDBN} Infer the Source Language |
c906108c SS |
11459 | |
11460 | To have @value{GDBN} set the working language automatically, use | |
11461 | @samp{set language local} or @samp{set language auto}. @value{GDBN} | |
11462 | then infers the working language. That is, when your program stops in a | |
11463 | frame (usually by encountering a breakpoint), @value{GDBN} sets the | |
11464 | working language to the language recorded for the function in that | |
11465 | frame. If the language for a frame is unknown (that is, if the function | |
11466 | or block corresponding to the frame was defined in a source file that | |
11467 | does not have a recognized extension), the current working language is | |
11468 | not changed, and @value{GDBN} issues a warning. | |
11469 | ||
11470 | This may not seem necessary for most programs, which are written | |
11471 | entirely in one source language. However, program modules and libraries | |
11472 | written in one source language can be used by a main program written in | |
11473 | a different source language. Using @samp{set language auto} in this | |
11474 | case frees you from having to set the working language manually. | |
11475 | ||
6d2ebf8b | 11476 | @node Show |
79a6e687 | 11477 | @section Displaying the Language |
c906108c SS |
11478 | |
11479 | The following commands help you find out which language is the | |
11480 | working language, and also what language source files were written in. | |
11481 | ||
c906108c SS |
11482 | @table @code |
11483 | @item show language | |
9c16f35a | 11484 | @kindex show language |
c906108c SS |
11485 | Display the current working language. This is the |
11486 | language you can use with commands such as @code{print} to | |
11487 | build and compute expressions that may involve variables in your program. | |
11488 | ||
11489 | @item info frame | |
4644b6e3 | 11490 | @kindex info frame@r{, show the source language} |
5d161b24 | 11491 | Display the source language for this frame. This language becomes the |
c906108c | 11492 | working language if you use an identifier from this frame. |
79a6e687 | 11493 | @xref{Frame Info, ,Information about a Frame}, to identify the other |
c906108c SS |
11494 | information listed here. |
11495 | ||
11496 | @item info source | |
4644b6e3 | 11497 | @kindex info source@r{, show the source language} |
c906108c | 11498 | Display the source language of this source file. |
5d161b24 | 11499 | @xref{Symbols, ,Examining the Symbol Table}, to identify the other |
c906108c SS |
11500 | information listed here. |
11501 | @end table | |
11502 | ||
11503 | In unusual circumstances, you may have source files with extensions | |
11504 | not in the standard list. You can then set the extension associated | |
11505 | with a language explicitly: | |
11506 | ||
c906108c | 11507 | @table @code |
09d4efe1 | 11508 | @item set extension-language @var{ext} @var{language} |
9c16f35a | 11509 | @kindex set extension-language |
09d4efe1 EZ |
11510 | Tell @value{GDBN} that source files with extension @var{ext} are to be |
11511 | assumed as written in the source language @var{language}. | |
c906108c SS |
11512 | |
11513 | @item info extensions | |
9c16f35a | 11514 | @kindex info extensions |
c906108c SS |
11515 | List all the filename extensions and the associated languages. |
11516 | @end table | |
11517 | ||
6d2ebf8b | 11518 | @node Checks |
79a6e687 | 11519 | @section Type and Range Checking |
c906108c SS |
11520 | |
11521 | @quotation | |
11522 | @emph{Warning:} In this release, the @value{GDBN} commands for type and range | |
11523 | checking are included, but they do not yet have any effect. This | |
11524 | section documents the intended facilities. | |
11525 | @end quotation | |
11526 | @c FIXME remove warning when type/range code added | |
11527 | ||
11528 | Some languages are designed to guard you against making seemingly common | |
11529 | errors through a series of compile- and run-time checks. These include | |
11530 | checking the type of arguments to functions and operators, and making | |
11531 | sure mathematical overflows are caught at run time. Checks such as | |
11532 | these help to ensure a program's correctness once it has been compiled | |
11533 | by eliminating type mismatches, and providing active checks for range | |
11534 | errors when your program is running. | |
11535 | ||
11536 | @value{GDBN} can check for conditions like the above if you wish. | |
9c16f35a EZ |
11537 | Although @value{GDBN} does not check the statements in your program, |
11538 | it can check expressions entered directly into @value{GDBN} for | |
11539 | evaluation via the @code{print} command, for example. As with the | |
11540 | working language, @value{GDBN} can also decide whether or not to check | |
11541 | automatically based on your program's source language. | |
79a6e687 | 11542 | @xref{Supported Languages, ,Supported Languages}, for the default |
9c16f35a | 11543 | settings of supported languages. |
c906108c SS |
11544 | |
11545 | @menu | |
11546 | * Type Checking:: An overview of type checking | |
11547 | * Range Checking:: An overview of range checking | |
11548 | @end menu | |
11549 | ||
11550 | @cindex type checking | |
11551 | @cindex checks, type | |
6d2ebf8b | 11552 | @node Type Checking |
79a6e687 | 11553 | @subsection An Overview of Type Checking |
c906108c SS |
11554 | |
11555 | Some languages, such as Modula-2, are strongly typed, meaning that the | |
11556 | arguments to operators and functions have to be of the correct type, | |
11557 | otherwise an error occurs. These checks prevent type mismatch | |
11558 | errors from ever causing any run-time problems. For example, | |
11559 | ||
11560 | @smallexample | |
11561 | 1 + 2 @result{} 3 | |
11562 | @exdent but | |
11563 | @error{} 1 + 2.3 | |
11564 | @end smallexample | |
11565 | ||
11566 | The second example fails because the @code{CARDINAL} 1 is not | |
11567 | type-compatible with the @code{REAL} 2.3. | |
11568 | ||
5d161b24 DB |
11569 | For the expressions you use in @value{GDBN} commands, you can tell the |
11570 | @value{GDBN} type checker to skip checking; | |
11571 | to treat any mismatches as errors and abandon the expression; | |
11572 | or to only issue warnings when type mismatches occur, | |
c906108c SS |
11573 | but evaluate the expression anyway. When you choose the last of |
11574 | these, @value{GDBN} evaluates expressions like the second example above, but | |
11575 | also issues a warning. | |
11576 | ||
5d161b24 DB |
11577 | Even if you turn type checking off, there may be other reasons |
11578 | related to type that prevent @value{GDBN} from evaluating an expression. | |
11579 | For instance, @value{GDBN} does not know how to add an @code{int} and | |
11580 | a @code{struct foo}. These particular type errors have nothing to do | |
11581 | with the language in use, and usually arise from expressions, such as | |
c906108c SS |
11582 | the one described above, which make little sense to evaluate anyway. |
11583 | ||
11584 | Each language defines to what degree it is strict about type. For | |
11585 | instance, both Modula-2 and C require the arguments to arithmetical | |
11586 | operators to be numbers. In C, enumerated types and pointers can be | |
11587 | represented as numbers, so that they are valid arguments to mathematical | |
79a6e687 | 11588 | operators. @xref{Supported Languages, ,Supported Languages}, for further |
c906108c SS |
11589 | details on specific languages. |
11590 | ||
11591 | @value{GDBN} provides some additional commands for controlling the type checker: | |
11592 | ||
c906108c SS |
11593 | @kindex set check type |
11594 | @kindex show check type | |
11595 | @table @code | |
11596 | @item set check type auto | |
11597 | Set type checking on or off based on the current working language. | |
79a6e687 | 11598 | @xref{Supported Languages, ,Supported Languages}, for the default settings for |
c906108c SS |
11599 | each language. |
11600 | ||
11601 | @item set check type on | |
11602 | @itemx set check type off | |
11603 | Set type checking on or off, overriding the default setting for the | |
11604 | current working language. Issue a warning if the setting does not | |
11605 | match the language default. If any type mismatches occur in | |
d4f3574e | 11606 | evaluating an expression while type checking is on, @value{GDBN} prints a |
c906108c SS |
11607 | message and aborts evaluation of the expression. |
11608 | ||
11609 | @item set check type warn | |
11610 | Cause the type checker to issue warnings, but to always attempt to | |
11611 | evaluate the expression. Evaluating the expression may still | |
11612 | be impossible for other reasons. For example, @value{GDBN} cannot add | |
11613 | numbers and structures. | |
11614 | ||
11615 | @item show type | |
5d161b24 | 11616 | Show the current setting of the type checker, and whether or not @value{GDBN} |
c906108c SS |
11617 | is setting it automatically. |
11618 | @end table | |
11619 | ||
11620 | @cindex range checking | |
11621 | @cindex checks, range | |
6d2ebf8b | 11622 | @node Range Checking |
79a6e687 | 11623 | @subsection An Overview of Range Checking |
c906108c SS |
11624 | |
11625 | In some languages (such as Modula-2), it is an error to exceed the | |
11626 | bounds of a type; this is enforced with run-time checks. Such range | |
11627 | checking is meant to ensure program correctness by making sure | |
11628 | computations do not overflow, or indices on an array element access do | |
11629 | not exceed the bounds of the array. | |
11630 | ||
11631 | For expressions you use in @value{GDBN} commands, you can tell | |
11632 | @value{GDBN} to treat range errors in one of three ways: ignore them, | |
11633 | always treat them as errors and abandon the expression, or issue | |
11634 | warnings but evaluate the expression anyway. | |
11635 | ||
11636 | A range error can result from numerical overflow, from exceeding an | |
11637 | array index bound, or when you type a constant that is not a member | |
11638 | of any type. Some languages, however, do not treat overflows as an | |
11639 | error. In many implementations of C, mathematical overflow causes the | |
11640 | result to ``wrap around'' to lower values---for example, if @var{m} is | |
11641 | the largest integer value, and @var{s} is the smallest, then | |
11642 | ||
474c8240 | 11643 | @smallexample |
c906108c | 11644 | @var{m} + 1 @result{} @var{s} |
474c8240 | 11645 | @end smallexample |
c906108c SS |
11646 | |
11647 | This, too, is specific to individual languages, and in some cases | |
79a6e687 BW |
11648 | specific to individual compilers or machines. @xref{Supported Languages, , |
11649 | Supported Languages}, for further details on specific languages. | |
c906108c SS |
11650 | |
11651 | @value{GDBN} provides some additional commands for controlling the range checker: | |
11652 | ||
c906108c SS |
11653 | @kindex set check range |
11654 | @kindex show check range | |
11655 | @table @code | |
11656 | @item set check range auto | |
11657 | Set range checking on or off based on the current working language. | |
79a6e687 | 11658 | @xref{Supported Languages, ,Supported Languages}, for the default settings for |
c906108c SS |
11659 | each language. |
11660 | ||
11661 | @item set check range on | |
11662 | @itemx set check range off | |
11663 | Set range checking on or off, overriding the default setting for the | |
11664 | current working language. A warning is issued if the setting does not | |
c3f6f71d JM |
11665 | match the language default. If a range error occurs and range checking is on, |
11666 | then a message is printed and evaluation of the expression is aborted. | |
c906108c SS |
11667 | |
11668 | @item set check range warn | |
11669 | Output messages when the @value{GDBN} range checker detects a range error, | |
11670 | but attempt to evaluate the expression anyway. Evaluating the | |
11671 | expression may still be impossible for other reasons, such as accessing | |
11672 | memory that the process does not own (a typical example from many Unix | |
11673 | systems). | |
11674 | ||
11675 | @item show range | |
11676 | Show the current setting of the range checker, and whether or not it is | |
11677 | being set automatically by @value{GDBN}. | |
11678 | @end table | |
c906108c | 11679 | |
79a6e687 BW |
11680 | @node Supported Languages |
11681 | @section Supported Languages | |
c906108c | 11682 | |
f4b8a18d | 11683 | @value{GDBN} supports C, C@t{++}, D, Objective-C, Fortran, Java, OpenCL C, Pascal, |
9c16f35a | 11684 | assembly, Modula-2, and Ada. |
cce74817 | 11685 | @c This is false ... |
c906108c SS |
11686 | Some @value{GDBN} features may be used in expressions regardless of the |
11687 | language you use: the @value{GDBN} @code{@@} and @code{::} operators, | |
11688 | and the @samp{@{type@}addr} construct (@pxref{Expressions, | |
11689 | ,Expressions}) can be used with the constructs of any supported | |
11690 | language. | |
11691 | ||
11692 | The following sections detail to what degree each source language is | |
11693 | supported by @value{GDBN}. These sections are not meant to be language | |
11694 | tutorials or references, but serve only as a reference guide to what the | |
11695 | @value{GDBN} expression parser accepts, and what input and output | |
11696 | formats should look like for different languages. There are many good | |
11697 | books written on each of these languages; please look to these for a | |
11698 | language reference or tutorial. | |
11699 | ||
c906108c | 11700 | @menu |
b37303ee | 11701 | * C:: C and C@t{++} |
6aecb9c2 | 11702 | * D:: D |
b383017d | 11703 | * Objective-C:: Objective-C |
f4b8a18d | 11704 | * OpenCL C:: OpenCL C |
09d4efe1 | 11705 | * Fortran:: Fortran |
9c16f35a | 11706 | * Pascal:: Pascal |
b37303ee | 11707 | * Modula-2:: Modula-2 |
e07c999f | 11708 | * Ada:: Ada |
c906108c SS |
11709 | @end menu |
11710 | ||
6d2ebf8b | 11711 | @node C |
b37052ae | 11712 | @subsection C and C@t{++} |
7a292a7a | 11713 | |
b37052ae EZ |
11714 | @cindex C and C@t{++} |
11715 | @cindex expressions in C or C@t{++} | |
c906108c | 11716 | |
b37052ae | 11717 | Since C and C@t{++} are so closely related, many features of @value{GDBN} apply |
c906108c SS |
11718 | to both languages. Whenever this is the case, we discuss those languages |
11719 | together. | |
11720 | ||
41afff9a EZ |
11721 | @cindex C@t{++} |
11722 | @cindex @code{g++}, @sc{gnu} C@t{++} compiler | |
b37052ae EZ |
11723 | @cindex @sc{gnu} C@t{++} |
11724 | The C@t{++} debugging facilities are jointly implemented by the C@t{++} | |
11725 | compiler and @value{GDBN}. Therefore, to debug your C@t{++} code | |
11726 | effectively, you must compile your C@t{++} programs with a supported | |
11727 | C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++} | |
c906108c SS |
11728 | compiler (@code{aCC}). |
11729 | ||
0179ffac DC |
11730 | For best results when using @sc{gnu} C@t{++}, use the DWARF 2 debugging |
11731 | format; if it doesn't work on your system, try the stabs+ debugging | |
11732 | format. You can select those formats explicitly with the @code{g++} | |
11733 | command-line options @option{-gdwarf-2} and @option{-gstabs+}. | |
ce9341a1 BW |
11734 | @xref{Debugging Options,,Options for Debugging Your Program or GCC, |
11735 | gcc.info, Using the @sc{gnu} Compiler Collection (GCC)}. | |
c906108c | 11736 | |
c906108c | 11737 | @menu |
b37052ae EZ |
11738 | * C Operators:: C and C@t{++} operators |
11739 | * C Constants:: C and C@t{++} constants | |
79a6e687 | 11740 | * C Plus Plus Expressions:: C@t{++} expressions |
b37052ae EZ |
11741 | * C Defaults:: Default settings for C and C@t{++} |
11742 | * C Checks:: C and C@t{++} type and range checks | |
c906108c | 11743 | * Debugging C:: @value{GDBN} and C |
79a6e687 | 11744 | * Debugging C Plus Plus:: @value{GDBN} features for C@t{++} |
febe4383 | 11745 | * Decimal Floating Point:: Numbers in Decimal Floating Point format |
c906108c | 11746 | @end menu |
c906108c | 11747 | |
6d2ebf8b | 11748 | @node C Operators |
79a6e687 | 11749 | @subsubsection C and C@t{++} Operators |
7a292a7a | 11750 | |
b37052ae | 11751 | @cindex C and C@t{++} operators |
c906108c SS |
11752 | |
11753 | Operators must be defined on values of specific types. For instance, | |
11754 | @code{+} is defined on numbers, but not on structures. Operators are | |
5d161b24 | 11755 | often defined on groups of types. |
c906108c | 11756 | |
b37052ae | 11757 | For the purposes of C and C@t{++}, the following definitions hold: |
c906108c SS |
11758 | |
11759 | @itemize @bullet | |
53a5351d | 11760 | |
c906108c | 11761 | @item |
c906108c | 11762 | @emph{Integral types} include @code{int} with any of its storage-class |
b37052ae | 11763 | specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}. |
c906108c SS |
11764 | |
11765 | @item | |
d4f3574e SS |
11766 | @emph{Floating-point types} include @code{float}, @code{double}, and |
11767 | @code{long double} (if supported by the target platform). | |
c906108c SS |
11768 | |
11769 | @item | |
53a5351d | 11770 | @emph{Pointer types} include all types defined as @code{(@var{type} *)}. |
c906108c SS |
11771 | |
11772 | @item | |
11773 | @emph{Scalar types} include all of the above. | |
53a5351d | 11774 | |
c906108c SS |
11775 | @end itemize |
11776 | ||
11777 | @noindent | |
11778 | The following operators are supported. They are listed here | |
11779 | in order of increasing precedence: | |
11780 | ||
11781 | @table @code | |
11782 | @item , | |
11783 | The comma or sequencing operator. Expressions in a comma-separated list | |
11784 | are evaluated from left to right, with the result of the entire | |
11785 | expression being the last expression evaluated. | |
11786 | ||
11787 | @item = | |
11788 | Assignment. The value of an assignment expression is the value | |
11789 | assigned. Defined on scalar types. | |
11790 | ||
11791 | @item @var{op}= | |
11792 | Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}}, | |
11793 | and translated to @w{@code{@var{a} = @var{a op b}}}. | |
d4f3574e | 11794 | @w{@code{@var{op}=}} and @code{=} have the same precedence. |
c906108c SS |
11795 | @var{op} is any one of the operators @code{|}, @code{^}, @code{&}, |
11796 | @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}. | |
11797 | ||
11798 | @item ?: | |
11799 | The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought | |
11800 | of as: if @var{a} then @var{b} else @var{c}. @var{a} should be of an | |
11801 | integral type. | |
11802 | ||
11803 | @item || | |
11804 | Logical @sc{or}. Defined on integral types. | |
11805 | ||
11806 | @item && | |
11807 | Logical @sc{and}. Defined on integral types. | |
11808 | ||
11809 | @item | | |
11810 | Bitwise @sc{or}. Defined on integral types. | |
11811 | ||
11812 | @item ^ | |
11813 | Bitwise exclusive-@sc{or}. Defined on integral types. | |
11814 | ||
11815 | @item & | |
11816 | Bitwise @sc{and}. Defined on integral types. | |
11817 | ||
11818 | @item ==@r{, }!= | |
11819 | Equality and inequality. Defined on scalar types. The value of these | |
11820 | expressions is 0 for false and non-zero for true. | |
11821 | ||
11822 | @item <@r{, }>@r{, }<=@r{, }>= | |
11823 | Less than, greater than, less than or equal, greater than or equal. | |
11824 | Defined on scalar types. The value of these expressions is 0 for false | |
11825 | and non-zero for true. | |
11826 | ||
11827 | @item <<@r{, }>> | |
11828 | left shift, and right shift. Defined on integral types. | |
11829 | ||
11830 | @item @@ | |
11831 | The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}). | |
11832 | ||
11833 | @item +@r{, }- | |
11834 | Addition and subtraction. Defined on integral types, floating-point types and | |
11835 | pointer types. | |
11836 | ||
11837 | @item *@r{, }/@r{, }% | |
11838 | Multiplication, division, and modulus. Multiplication and division are | |
11839 | defined on integral and floating-point types. Modulus is defined on | |
11840 | integral types. | |
11841 | ||
11842 | @item ++@r{, }-- | |
11843 | Increment and decrement. When appearing before a variable, the | |
11844 | operation is performed before the variable is used in an expression; | |
11845 | when appearing after it, the variable's value is used before the | |
11846 | operation takes place. | |
11847 | ||
11848 | @item * | |
11849 | Pointer dereferencing. Defined on pointer types. Same precedence as | |
11850 | @code{++}. | |
11851 | ||
11852 | @item & | |
11853 | Address operator. Defined on variables. Same precedence as @code{++}. | |
11854 | ||
b37052ae EZ |
11855 | For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is |
11856 | allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})} | |
b17828ca | 11857 | to examine the address |
b37052ae | 11858 | where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is |
c906108c | 11859 | stored. |
c906108c SS |
11860 | |
11861 | @item - | |
11862 | Negative. Defined on integral and floating-point types. Same | |
11863 | precedence as @code{++}. | |
11864 | ||
11865 | @item ! | |
11866 | Logical negation. Defined on integral types. Same precedence as | |
11867 | @code{++}. | |
11868 | ||
11869 | @item ~ | |
11870 | Bitwise complement operator. Defined on integral types. Same precedence as | |
11871 | @code{++}. | |
11872 | ||
11873 | ||
11874 | @item .@r{, }-> | |
11875 | Structure member, and pointer-to-structure member. For convenience, | |
11876 | @value{GDBN} regards the two as equivalent, choosing whether to dereference a | |
11877 | pointer based on the stored type information. | |
11878 | Defined on @code{struct} and @code{union} data. | |
11879 | ||
c906108c SS |
11880 | @item .*@r{, }->* |
11881 | Dereferences of pointers to members. | |
c906108c SS |
11882 | |
11883 | @item [] | |
11884 | Array indexing. @code{@var{a}[@var{i}]} is defined as | |
11885 | @code{*(@var{a}+@var{i})}. Same precedence as @code{->}. | |
11886 | ||
11887 | @item () | |
11888 | Function parameter list. Same precedence as @code{->}. | |
11889 | ||
c906108c | 11890 | @item :: |
b37052ae | 11891 | C@t{++} scope resolution operator. Defined on @code{struct}, @code{union}, |
7a292a7a | 11892 | and @code{class} types. |
c906108c SS |
11893 | |
11894 | @item :: | |
7a292a7a SS |
11895 | Doubled colons also represent the @value{GDBN} scope operator |
11896 | (@pxref{Expressions, ,Expressions}). Same precedence as @code{::}, | |
11897 | above. | |
c906108c SS |
11898 | @end table |
11899 | ||
c906108c SS |
11900 | If an operator is redefined in the user code, @value{GDBN} usually |
11901 | attempts to invoke the redefined version instead of using the operator's | |
11902 | predefined meaning. | |
c906108c | 11903 | |
6d2ebf8b | 11904 | @node C Constants |
79a6e687 | 11905 | @subsubsection C and C@t{++} Constants |
c906108c | 11906 | |
b37052ae | 11907 | @cindex C and C@t{++} constants |
c906108c | 11908 | |
b37052ae | 11909 | @value{GDBN} allows you to express the constants of C and C@t{++} in the |
c906108c | 11910 | following ways: |
c906108c SS |
11911 | |
11912 | @itemize @bullet | |
11913 | @item | |
11914 | Integer constants are a sequence of digits. Octal constants are | |
6ca652b0 EZ |
11915 | specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants |
11916 | by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter | |
c906108c SS |
11917 | @samp{l}, specifying that the constant should be treated as a |
11918 | @code{long} value. | |
11919 | ||
11920 | @item | |
11921 | Floating point constants are a sequence of digits, followed by a decimal | |
11922 | point, followed by a sequence of digits, and optionally followed by an | |
11923 | exponent. An exponent is of the form: | |
11924 | @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another | |
11925 | sequence of digits. The @samp{+} is optional for positive exponents. | |
d4f3574e SS |
11926 | A floating-point constant may also end with a letter @samp{f} or |
11927 | @samp{F}, specifying that the constant should be treated as being of | |
11928 | the @code{float} (as opposed to the default @code{double}) type; or with | |
11929 | a letter @samp{l} or @samp{L}, which specifies a @code{long double} | |
11930 | constant. | |
c906108c SS |
11931 | |
11932 | @item | |
11933 | Enumerated constants consist of enumerated identifiers, or their | |
11934 | integral equivalents. | |
11935 | ||
11936 | @item | |
11937 | Character constants are a single character surrounded by single quotes | |
11938 | (@code{'}), or a number---the ordinal value of the corresponding character | |
d4f3574e | 11939 | (usually its @sc{ascii} value). Within quotes, the single character may |
c906108c SS |
11940 | be represented by a letter or by @dfn{escape sequences}, which are of |
11941 | the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation | |
11942 | of the character's ordinal value; or of the form @samp{\@var{x}}, where | |
11943 | @samp{@var{x}} is a predefined special character---for example, | |
11944 | @samp{\n} for newline. | |
11945 | ||
11946 | @item | |
96a2c332 SS |
11947 | String constants are a sequence of character constants surrounded by |
11948 | double quotes (@code{"}). Any valid character constant (as described | |
11949 | above) may appear. Double quotes within the string must be preceded by | |
11950 | a backslash, so for instance @samp{"a\"b'c"} is a string of five | |
11951 | characters. | |
c906108c SS |
11952 | |
11953 | @item | |
11954 | Pointer constants are an integral value. You can also write pointers | |
11955 | to constants using the C operator @samp{&}. | |
11956 | ||
11957 | @item | |
11958 | Array constants are comma-separated lists surrounded by braces @samp{@{} | |
11959 | and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of | |
11960 | integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array, | |
11961 | and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers. | |
11962 | @end itemize | |
11963 | ||
79a6e687 BW |
11964 | @node C Plus Plus Expressions |
11965 | @subsubsection C@t{++} Expressions | |
b37052ae EZ |
11966 | |
11967 | @cindex expressions in C@t{++} | |
11968 | @value{GDBN} expression handling can interpret most C@t{++} expressions. | |
11969 | ||
0179ffac DC |
11970 | @cindex debugging C@t{++} programs |
11971 | @cindex C@t{++} compilers | |
11972 | @cindex debug formats and C@t{++} | |
11973 | @cindex @value{NGCC} and C@t{++} | |
c906108c | 11974 | @quotation |
b37052ae | 11975 | @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use the |
0179ffac DC |
11976 | proper compiler and the proper debug format. Currently, @value{GDBN} |
11977 | works best when debugging C@t{++} code that is compiled with | |
11978 | @value{NGCC} 2.95.3 or with @value{NGCC} 3.1 or newer, using the options | |
11979 | @option{-gdwarf-2} or @option{-gstabs+}. DWARF 2 is preferred over | |
11980 | stabs+. Most configurations of @value{NGCC} emit either DWARF 2 or | |
11981 | stabs+ as their default debug format, so you usually don't need to | |
11982 | specify a debug format explicitly. Other compilers and/or debug formats | |
11983 | are likely to work badly or not at all when using @value{GDBN} to debug | |
11984 | C@t{++} code. | |
c906108c | 11985 | @end quotation |
c906108c SS |
11986 | |
11987 | @enumerate | |
11988 | ||
11989 | @cindex member functions | |
11990 | @item | |
11991 | Member function calls are allowed; you can use expressions like | |
11992 | ||
474c8240 | 11993 | @smallexample |
c906108c | 11994 | count = aml->GetOriginal(x, y) |
474c8240 | 11995 | @end smallexample |
c906108c | 11996 | |
41afff9a | 11997 | @vindex this@r{, inside C@t{++} member functions} |
b37052ae | 11998 | @cindex namespace in C@t{++} |
c906108c SS |
11999 | @item |
12000 | While a member function is active (in the selected stack frame), your | |
12001 | expressions have the same namespace available as the member function; | |
12002 | that is, @value{GDBN} allows implicit references to the class instance | |
b37052ae | 12003 | pointer @code{this} following the same rules as C@t{++}. |
c906108c | 12004 | |
c906108c | 12005 | @cindex call overloaded functions |
d4f3574e | 12006 | @cindex overloaded functions, calling |
b37052ae | 12007 | @cindex type conversions in C@t{++} |
c906108c SS |
12008 | @item |
12009 | You can call overloaded functions; @value{GDBN} resolves the function | |
d4f3574e | 12010 | call to the right definition, with some restrictions. @value{GDBN} does not |
c906108c SS |
12011 | perform overload resolution involving user-defined type conversions, |
12012 | calls to constructors, or instantiations of templates that do not exist | |
12013 | in the program. It also cannot handle ellipsis argument lists or | |
12014 | default arguments. | |
12015 | ||
12016 | It does perform integral conversions and promotions, floating-point | |
12017 | promotions, arithmetic conversions, pointer conversions, conversions of | |
12018 | class objects to base classes, and standard conversions such as those of | |
12019 | functions or arrays to pointers; it requires an exact match on the | |
12020 | number of function arguments. | |
12021 | ||
12022 | Overload resolution is always performed, unless you have specified | |
79a6e687 BW |
12023 | @code{set overload-resolution off}. @xref{Debugging C Plus Plus, |
12024 | ,@value{GDBN} Features for C@t{++}}. | |
c906108c | 12025 | |
d4f3574e | 12026 | You must specify @code{set overload-resolution off} in order to use an |
c906108c SS |
12027 | explicit function signature to call an overloaded function, as in |
12028 | @smallexample | |
12029 | p 'foo(char,int)'('x', 13) | |
12030 | @end smallexample | |
d4f3574e | 12031 | |
c906108c | 12032 | The @value{GDBN} command-completion facility can simplify this; |
79a6e687 | 12033 | see @ref{Completion, ,Command Completion}. |
c906108c | 12034 | |
c906108c SS |
12035 | @cindex reference declarations |
12036 | @item | |
b37052ae EZ |
12037 | @value{GDBN} understands variables declared as C@t{++} references; you can use |
12038 | them in expressions just as you do in C@t{++} source---they are automatically | |
c906108c SS |
12039 | dereferenced. |
12040 | ||
12041 | In the parameter list shown when @value{GDBN} displays a frame, the values of | |
12042 | reference variables are not displayed (unlike other variables); this | |
12043 | avoids clutter, since references are often used for large structures. | |
12044 | The @emph{address} of a reference variable is always shown, unless | |
12045 | you have specified @samp{set print address off}. | |
12046 | ||
12047 | @item | |
b37052ae | 12048 | @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your |
c906108c SS |
12049 | expressions can use it just as expressions in your program do. Since |
12050 | one scope may be defined in another, you can use @code{::} repeatedly if | |
12051 | necessary, for example in an expression like | |
12052 | @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows | |
b37052ae | 12053 | resolving name scope by reference to source files, in both C and C@t{++} |
79a6e687 | 12054 | debugging (@pxref{Variables, ,Program Variables}). |
c906108c SS |
12055 | @end enumerate |
12056 | ||
b37052ae | 12057 | In addition, when used with HP's C@t{++} compiler, @value{GDBN} supports |
53a5351d JM |
12058 | calling virtual functions correctly, printing out virtual bases of |
12059 | objects, calling functions in a base subobject, casting objects, and | |
12060 | invoking user-defined operators. | |
c906108c | 12061 | |
6d2ebf8b | 12062 | @node C Defaults |
79a6e687 | 12063 | @subsubsection C and C@t{++} Defaults |
7a292a7a | 12064 | |
b37052ae | 12065 | @cindex C and C@t{++} defaults |
c906108c | 12066 | |
c906108c SS |
12067 | If you allow @value{GDBN} to set type and range checking automatically, they |
12068 | both default to @code{off} whenever the working language changes to | |
b37052ae | 12069 | C or C@t{++}. This happens regardless of whether you or @value{GDBN} |
c906108c | 12070 | selects the working language. |
c906108c SS |
12071 | |
12072 | If you allow @value{GDBN} to set the language automatically, it | |
12073 | recognizes source files whose names end with @file{.c}, @file{.C}, or | |
12074 | @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of | |
b37052ae | 12075 | these files, it sets the working language to C or C@t{++}. |
79a6e687 | 12076 | @xref{Automatically, ,Having @value{GDBN} Infer the Source Language}, |
c906108c SS |
12077 | for further details. |
12078 | ||
c906108c SS |
12079 | @c Type checking is (a) primarily motivated by Modula-2, and (b) |
12080 | @c unimplemented. If (b) changes, it might make sense to let this node | |
12081 | @c appear even if Mod-2 does not, but meanwhile ignore it. roland 16jul93. | |
7a292a7a | 12082 | |
6d2ebf8b | 12083 | @node C Checks |
79a6e687 | 12084 | @subsubsection C and C@t{++} Type and Range Checks |
7a292a7a | 12085 | |
b37052ae | 12086 | @cindex C and C@t{++} checks |
c906108c | 12087 | |
b37052ae | 12088 | By default, when @value{GDBN} parses C or C@t{++} expressions, type checking |
c906108c SS |
12089 | is not used. However, if you turn type checking on, @value{GDBN} |
12090 | considers two variables type equivalent if: | |
12091 | ||
12092 | @itemize @bullet | |
12093 | @item | |
12094 | The two variables are structured and have the same structure, union, or | |
12095 | enumerated tag. | |
12096 | ||
12097 | @item | |
12098 | The two variables have the same type name, or types that have been | |
12099 | declared equivalent through @code{typedef}. | |
12100 | ||
12101 | @ignore | |
12102 | @c leaving this out because neither J Gilmore nor R Pesch understand it. | |
12103 | @c FIXME--beers? | |
12104 | @item | |
12105 | The two @code{struct}, @code{union}, or @code{enum} variables are | |
12106 | declared in the same declaration. (Note: this may not be true for all C | |
12107 | compilers.) | |
12108 | @end ignore | |
12109 | @end itemize | |
12110 | ||
12111 | Range checking, if turned on, is done on mathematical operations. Array | |
12112 | indices are not checked, since they are often used to index a pointer | |
12113 | that is not itself an array. | |
c906108c | 12114 | |
6d2ebf8b | 12115 | @node Debugging C |
c906108c | 12116 | @subsubsection @value{GDBN} and C |
c906108c SS |
12117 | |
12118 | The @code{set print union} and @code{show print union} commands apply to | |
12119 | the @code{union} type. When set to @samp{on}, any @code{union} that is | |
7a292a7a SS |
12120 | inside a @code{struct} or @code{class} is also printed. Otherwise, it |
12121 | appears as @samp{@{...@}}. | |
c906108c SS |
12122 | |
12123 | The @code{@@} operator aids in the debugging of dynamic arrays, formed | |
12124 | with pointers and a memory allocation function. @xref{Expressions, | |
12125 | ,Expressions}. | |
12126 | ||
79a6e687 BW |
12127 | @node Debugging C Plus Plus |
12128 | @subsubsection @value{GDBN} Features for C@t{++} | |
c906108c | 12129 | |
b37052ae | 12130 | @cindex commands for C@t{++} |
7a292a7a | 12131 | |
b37052ae EZ |
12132 | Some @value{GDBN} commands are particularly useful with C@t{++}, and some are |
12133 | designed specifically for use with C@t{++}. Here is a summary: | |
c906108c SS |
12134 | |
12135 | @table @code | |
12136 | @cindex break in overloaded functions | |
12137 | @item @r{breakpoint menus} | |
12138 | When you want a breakpoint in a function whose name is overloaded, | |
6ba66d6a JB |
12139 | @value{GDBN} has the capability to display a menu of possible breakpoint |
12140 | locations to help you specify which function definition you want. | |
12141 | @xref{Ambiguous Expressions,,Ambiguous Expressions}. | |
c906108c | 12142 | |
b37052ae | 12143 | @cindex overloading in C@t{++} |
c906108c SS |
12144 | @item rbreak @var{regex} |
12145 | Setting breakpoints using regular expressions is helpful for setting | |
12146 | breakpoints on overloaded functions that are not members of any special | |
12147 | classes. | |
79a6e687 | 12148 | @xref{Set Breaks, ,Setting Breakpoints}. |
c906108c | 12149 | |
b37052ae | 12150 | @cindex C@t{++} exception handling |
c906108c SS |
12151 | @item catch throw |
12152 | @itemx catch catch | |
b37052ae | 12153 | Debug C@t{++} exception handling using these commands. @xref{Set |
79a6e687 | 12154 | Catchpoints, , Setting Catchpoints}. |
c906108c SS |
12155 | |
12156 | @cindex inheritance | |
12157 | @item ptype @var{typename} | |
12158 | Print inheritance relationships as well as other information for type | |
12159 | @var{typename}. | |
12160 | @xref{Symbols, ,Examining the Symbol Table}. | |
12161 | ||
b37052ae | 12162 | @cindex C@t{++} symbol display |
c906108c SS |
12163 | @item set print demangle |
12164 | @itemx show print demangle | |
12165 | @itemx set print asm-demangle | |
12166 | @itemx show print asm-demangle | |
b37052ae EZ |
12167 | Control whether C@t{++} symbols display in their source form, both when |
12168 | displaying code as C@t{++} source and when displaying disassemblies. | |
79a6e687 | 12169 | @xref{Print Settings, ,Print Settings}. |
c906108c SS |
12170 | |
12171 | @item set print object | |
12172 | @itemx show print object | |
12173 | Choose whether to print derived (actual) or declared types of objects. | |
79a6e687 | 12174 | @xref{Print Settings, ,Print Settings}. |
c906108c SS |
12175 | |
12176 | @item set print vtbl | |
12177 | @itemx show print vtbl | |
12178 | Control the format for printing virtual function tables. | |
79a6e687 | 12179 | @xref{Print Settings, ,Print Settings}. |
c906108c | 12180 | (The @code{vtbl} commands do not work on programs compiled with the HP |
b37052ae | 12181 | ANSI C@t{++} compiler (@code{aCC}).) |
c906108c SS |
12182 | |
12183 | @kindex set overload-resolution | |
d4f3574e | 12184 | @cindex overloaded functions, overload resolution |
c906108c | 12185 | @item set overload-resolution on |
b37052ae | 12186 | Enable overload resolution for C@t{++} expression evaluation. The default |
c906108c SS |
12187 | is on. For overloaded functions, @value{GDBN} evaluates the arguments |
12188 | and searches for a function whose signature matches the argument types, | |
79a6e687 BW |
12189 | using the standard C@t{++} conversion rules (see @ref{C Plus Plus |
12190 | Expressions, ,C@t{++} Expressions}, for details). | |
12191 | If it cannot find a match, it emits a message. | |
c906108c SS |
12192 | |
12193 | @item set overload-resolution off | |
b37052ae | 12194 | Disable overload resolution for C@t{++} expression evaluation. For |
c906108c SS |
12195 | overloaded functions that are not class member functions, @value{GDBN} |
12196 | chooses the first function of the specified name that it finds in the | |
12197 | symbol table, whether or not its arguments are of the correct type. For | |
12198 | overloaded functions that are class member functions, @value{GDBN} | |
12199 | searches for a function whose signature @emph{exactly} matches the | |
12200 | argument types. | |
c906108c | 12201 | |
9c16f35a EZ |
12202 | @kindex show overload-resolution |
12203 | @item show overload-resolution | |
12204 | Show the current setting of overload resolution. | |
12205 | ||
c906108c SS |
12206 | @item @r{Overloaded symbol names} |
12207 | You can specify a particular definition of an overloaded symbol, using | |
b37052ae | 12208 | the same notation that is used to declare such symbols in C@t{++}: type |
c906108c SS |
12209 | @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can |
12210 | also use the @value{GDBN} command-line word completion facilities to list the | |
12211 | available choices, or to finish the type list for you. | |
79a6e687 | 12212 | @xref{Completion,, Command Completion}, for details on how to do this. |
c906108c | 12213 | @end table |
c906108c | 12214 | |
febe4383 TJB |
12215 | @node Decimal Floating Point |
12216 | @subsubsection Decimal Floating Point format | |
12217 | @cindex decimal floating point format | |
12218 | ||
12219 | @value{GDBN} can examine, set and perform computations with numbers in | |
12220 | decimal floating point format, which in the C language correspond to the | |
12221 | @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as | |
12222 | specified by the extension to support decimal floating-point arithmetic. | |
12223 | ||
12224 | There are two encodings in use, depending on the architecture: BID (Binary | |
12225 | Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for | |
99e008fe | 12226 | PowerPC. @value{GDBN} will use the appropriate encoding for the configured |
febe4383 TJB |
12227 | target. |
12228 | ||
12229 | Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN} | |
12230 | to manipulate decimal floating point numbers, it is not possible to convert | |
12231 | (using a cast, for example) integers wider than 32-bit to decimal float. | |
12232 | ||
12233 | In addition, in order to imitate @value{GDBN}'s behaviour with binary floating | |
12234 | point computations, error checking in decimal float operations ignores | |
12235 | underflow, overflow and divide by zero exceptions. | |
12236 | ||
4acd40f3 | 12237 | In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers |
99e008fe EZ |
12238 | to inspect @code{_Decimal128} values stored in floating point registers. |
12239 | See @ref{PowerPC,,PowerPC} for more details. | |
4acd40f3 | 12240 | |
6aecb9c2 JB |
12241 | @node D |
12242 | @subsection D | |
12243 | ||
12244 | @cindex D | |
12245 | @value{GDBN} can be used to debug programs written in D and compiled with | |
12246 | GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D | |
12247 | specific feature --- dynamic arrays. | |
12248 | ||
b37303ee AF |
12249 | @node Objective-C |
12250 | @subsection Objective-C | |
12251 | ||
12252 | @cindex Objective-C | |
12253 | This section provides information about some commands and command | |
721c2651 EZ |
12254 | options that are useful for debugging Objective-C code. See also |
12255 | @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a | |
12256 | few more commands specific to Objective-C support. | |
b37303ee AF |
12257 | |
12258 | @menu | |
b383017d RM |
12259 | * Method Names in Commands:: |
12260 | * The Print Command with Objective-C:: | |
b37303ee AF |
12261 | @end menu |
12262 | ||
c8f4133a | 12263 | @node Method Names in Commands |
b37303ee AF |
12264 | @subsubsection Method Names in Commands |
12265 | ||
12266 | The following commands have been extended to accept Objective-C method | |
12267 | names as line specifications: | |
12268 | ||
12269 | @kindex clear@r{, and Objective-C} | |
12270 | @kindex break@r{, and Objective-C} | |
12271 | @kindex info line@r{, and Objective-C} | |
12272 | @kindex jump@r{, and Objective-C} | |
12273 | @kindex list@r{, and Objective-C} | |
12274 | @itemize | |
12275 | @item @code{clear} | |
12276 | @item @code{break} | |
12277 | @item @code{info line} | |
12278 | @item @code{jump} | |
12279 | @item @code{list} | |
12280 | @end itemize | |
12281 | ||
12282 | A fully qualified Objective-C method name is specified as | |
12283 | ||
12284 | @smallexample | |
12285 | -[@var{Class} @var{methodName}] | |
12286 | @end smallexample | |
12287 | ||
c552b3bb JM |
12288 | where the minus sign is used to indicate an instance method and a |
12289 | plus sign (not shown) is used to indicate a class method. The class | |
12290 | name @var{Class} and method name @var{methodName} are enclosed in | |
12291 | brackets, similar to the way messages are specified in Objective-C | |
12292 | source code. For example, to set a breakpoint at the @code{create} | |
12293 | instance method of class @code{Fruit} in the program currently being | |
12294 | debugged, enter: | |
b37303ee AF |
12295 | |
12296 | @smallexample | |
12297 | break -[Fruit create] | |
12298 | @end smallexample | |
12299 | ||
12300 | To list ten program lines around the @code{initialize} class method, | |
12301 | enter: | |
12302 | ||
12303 | @smallexample | |
12304 | list +[NSText initialize] | |
12305 | @end smallexample | |
12306 | ||
c552b3bb JM |
12307 | In the current version of @value{GDBN}, the plus or minus sign is |
12308 | required. In future versions of @value{GDBN}, the plus or minus | |
12309 | sign will be optional, but you can use it to narrow the search. It | |
12310 | is also possible to specify just a method name: | |
b37303ee AF |
12311 | |
12312 | @smallexample | |
12313 | break create | |
12314 | @end smallexample | |
12315 | ||
12316 | You must specify the complete method name, including any colons. If | |
12317 | your program's source files contain more than one @code{create} method, | |
12318 | you'll be presented with a numbered list of classes that implement that | |
12319 | method. Indicate your choice by number, or type @samp{0} to exit if | |
12320 | none apply. | |
12321 | ||
12322 | As another example, to clear a breakpoint established at the | |
12323 | @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter: | |
12324 | ||
12325 | @smallexample | |
12326 | clear -[NSWindow makeKeyAndOrderFront:] | |
12327 | @end smallexample | |
12328 | ||
12329 | @node The Print Command with Objective-C | |
12330 | @subsubsection The Print Command With Objective-C | |
721c2651 | 12331 | @cindex Objective-C, print objects |
c552b3bb JM |
12332 | @kindex print-object |
12333 | @kindex po @r{(@code{print-object})} | |
b37303ee | 12334 | |
c552b3bb | 12335 | The print command has also been extended to accept methods. For example: |
b37303ee AF |
12336 | |
12337 | @smallexample | |
c552b3bb | 12338 | print -[@var{object} hash] |
b37303ee AF |
12339 | @end smallexample |
12340 | ||
12341 | @cindex print an Objective-C object description | |
c552b3bb JM |
12342 | @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects |
12343 | @noindent | |
12344 | will tell @value{GDBN} to send the @code{hash} message to @var{object} | |
12345 | and print the result. Also, an additional command has been added, | |
12346 | @code{print-object} or @code{po} for short, which is meant to print | |
12347 | the description of an object. However, this command may only work | |
12348 | with certain Objective-C libraries that have a particular hook | |
12349 | function, @code{_NSPrintForDebugger}, defined. | |
b37303ee | 12350 | |
f4b8a18d KW |
12351 | @node OpenCL C |
12352 | @subsection OpenCL C | |
12353 | ||
12354 | @cindex OpenCL C | |
12355 | This section provides information about @value{GDBN}s OpenCL C support. | |
12356 | ||
12357 | @menu | |
12358 | * OpenCL C Datatypes:: | |
12359 | * OpenCL C Expressions:: | |
12360 | * OpenCL C Operators:: | |
12361 | @end menu | |
12362 | ||
12363 | @node OpenCL C Datatypes | |
12364 | @subsubsection OpenCL C Datatypes | |
12365 | ||
12366 | @cindex OpenCL C Datatypes | |
12367 | @value{GDBN} supports the builtin scalar and vector datatypes specified | |
12368 | by OpenCL 1.1. In addition the half- and double-precision floating point | |
12369 | data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL | |
12370 | extensions are also known to @value{GDBN}. | |
12371 | ||
12372 | @node OpenCL C Expressions | |
12373 | @subsubsection OpenCL C Expressions | |
12374 | ||
12375 | @cindex OpenCL C Expressions | |
12376 | @value{GDBN} supports accesses to vector components including the access as | |
12377 | lvalue where possible. Since OpenCL C is based on C99 most C expressions | |
12378 | supported by @value{GDBN} can be used as well. | |
12379 | ||
12380 | @node OpenCL C Operators | |
12381 | @subsubsection OpenCL C Operators | |
12382 | ||
12383 | @cindex OpenCL C Operators | |
12384 | @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and | |
12385 | vector data types. | |
12386 | ||
09d4efe1 EZ |
12387 | @node Fortran |
12388 | @subsection Fortran | |
12389 | @cindex Fortran-specific support in @value{GDBN} | |
12390 | ||
814e32d7 WZ |
12391 | @value{GDBN} can be used to debug programs written in Fortran, but it |
12392 | currently supports only the features of Fortran 77 language. | |
12393 | ||
12394 | @cindex trailing underscore, in Fortran symbols | |
12395 | Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers | |
12396 | among them) append an underscore to the names of variables and | |
12397 | functions. When you debug programs compiled by those compilers, you | |
12398 | will need to refer to variables and functions with a trailing | |
12399 | underscore. | |
12400 | ||
12401 | @menu | |
12402 | * Fortran Operators:: Fortran operators and expressions | |
12403 | * Fortran Defaults:: Default settings for Fortran | |
79a6e687 | 12404 | * Special Fortran Commands:: Special @value{GDBN} commands for Fortran |
814e32d7 WZ |
12405 | @end menu |
12406 | ||
12407 | @node Fortran Operators | |
79a6e687 | 12408 | @subsubsection Fortran Operators and Expressions |
814e32d7 WZ |
12409 | |
12410 | @cindex Fortran operators and expressions | |
12411 | ||
12412 | Operators must be defined on values of specific types. For instance, | |
12413 | @code{+} is defined on numbers, but not on characters or other non- | |
ff2587ec | 12414 | arithmetic types. Operators are often defined on groups of types. |
814e32d7 WZ |
12415 | |
12416 | @table @code | |
12417 | @item ** | |
99e008fe | 12418 | The exponentiation operator. It raises the first operand to the power |
814e32d7 WZ |
12419 | of the second one. |
12420 | ||
12421 | @item : | |
12422 | The range operator. Normally used in the form of array(low:high) to | |
12423 | represent a section of array. | |
68837c9d MD |
12424 | |
12425 | @item % | |
12426 | The access component operator. Normally used to access elements in derived | |
12427 | types. Also suitable for unions. As unions aren't part of regular Fortran, | |
12428 | this can only happen when accessing a register that uses a gdbarch-defined | |
12429 | union type. | |
814e32d7 WZ |
12430 | @end table |
12431 | ||
12432 | @node Fortran Defaults | |
12433 | @subsubsection Fortran Defaults | |
12434 | ||
12435 | @cindex Fortran Defaults | |
12436 | ||
12437 | Fortran symbols are usually case-insensitive, so @value{GDBN} by | |
12438 | default uses case-insensitive matches for Fortran symbols. You can | |
12439 | change that with the @samp{set case-insensitive} command, see | |
12440 | @ref{Symbols}, for the details. | |
12441 | ||
79a6e687 BW |
12442 | @node Special Fortran Commands |
12443 | @subsubsection Special Fortran Commands | |
814e32d7 WZ |
12444 | |
12445 | @cindex Special Fortran commands | |
12446 | ||
db2e3e2e BW |
12447 | @value{GDBN} has some commands to support Fortran-specific features, |
12448 | such as displaying common blocks. | |
814e32d7 | 12449 | |
09d4efe1 EZ |
12450 | @table @code |
12451 | @cindex @code{COMMON} blocks, Fortran | |
12452 | @kindex info common | |
12453 | @item info common @r{[}@var{common-name}@r{]} | |
12454 | This command prints the values contained in the Fortran @code{COMMON} | |
12455 | block whose name is @var{common-name}. With no argument, the names of | |
d52fb0e9 | 12456 | all @code{COMMON} blocks visible at the current program location are |
09d4efe1 EZ |
12457 | printed. |
12458 | @end table | |
12459 | ||
9c16f35a EZ |
12460 | @node Pascal |
12461 | @subsection Pascal | |
12462 | ||
12463 | @cindex Pascal support in @value{GDBN}, limitations | |
12464 | Debugging Pascal programs which use sets, subranges, file variables, or | |
12465 | nested functions does not currently work. @value{GDBN} does not support | |
12466 | entering expressions, printing values, or similar features using Pascal | |
12467 | syntax. | |
12468 | ||
12469 | The Pascal-specific command @code{set print pascal_static-members} | |
12470 | controls whether static members of Pascal objects are displayed. | |
12471 | @xref{Print Settings, pascal_static-members}. | |
12472 | ||
09d4efe1 | 12473 | @node Modula-2 |
c906108c | 12474 | @subsection Modula-2 |
7a292a7a | 12475 | |
d4f3574e | 12476 | @cindex Modula-2, @value{GDBN} support |
c906108c SS |
12477 | |
12478 | The extensions made to @value{GDBN} to support Modula-2 only support | |
12479 | output from the @sc{gnu} Modula-2 compiler (which is currently being | |
12480 | developed). Other Modula-2 compilers are not currently supported, and | |
12481 | attempting to debug executables produced by them is most likely | |
12482 | to give an error as @value{GDBN} reads in the executable's symbol | |
12483 | table. | |
12484 | ||
12485 | @cindex expressions in Modula-2 | |
12486 | @menu | |
12487 | * M2 Operators:: Built-in operators | |
12488 | * Built-In Func/Proc:: Built-in functions and procedures | |
12489 | * M2 Constants:: Modula-2 constants | |
72019c9c | 12490 | * M2 Types:: Modula-2 types |
c906108c SS |
12491 | * M2 Defaults:: Default settings for Modula-2 |
12492 | * Deviations:: Deviations from standard Modula-2 | |
12493 | * M2 Checks:: Modula-2 type and range checks | |
12494 | * M2 Scope:: The scope operators @code{::} and @code{.} | |
12495 | * GDB/M2:: @value{GDBN} and Modula-2 | |
12496 | @end menu | |
12497 | ||
6d2ebf8b | 12498 | @node M2 Operators |
c906108c SS |
12499 | @subsubsection Operators |
12500 | @cindex Modula-2 operators | |
12501 | ||
12502 | Operators must be defined on values of specific types. For instance, | |
12503 | @code{+} is defined on numbers, but not on structures. Operators are | |
12504 | often defined on groups of types. For the purposes of Modula-2, the | |
12505 | following definitions hold: | |
12506 | ||
12507 | @itemize @bullet | |
12508 | ||
12509 | @item | |
12510 | @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and | |
12511 | their subranges. | |
12512 | ||
12513 | @item | |
12514 | @emph{Character types} consist of @code{CHAR} and its subranges. | |
12515 | ||
12516 | @item | |
12517 | @emph{Floating-point types} consist of @code{REAL}. | |
12518 | ||
12519 | @item | |
12520 | @emph{Pointer types} consist of anything declared as @code{POINTER TO | |
12521 | @var{type}}. | |
12522 | ||
12523 | @item | |
12524 | @emph{Scalar types} consist of all of the above. | |
12525 | ||
12526 | @item | |
12527 | @emph{Set types} consist of @code{SET} and @code{BITSET} types. | |
12528 | ||
12529 | @item | |
12530 | @emph{Boolean types} consist of @code{BOOLEAN}. | |
12531 | @end itemize | |
12532 | ||
12533 | @noindent | |
12534 | The following operators are supported, and appear in order of | |
12535 | increasing precedence: | |
12536 | ||
12537 | @table @code | |
12538 | @item , | |
12539 | Function argument or array index separator. | |
12540 | ||
12541 | @item := | |
12542 | Assignment. The value of @var{var} @code{:=} @var{value} is | |
12543 | @var{value}. | |
12544 | ||
12545 | @item <@r{, }> | |
12546 | Less than, greater than on integral, floating-point, or enumerated | |
12547 | types. | |
12548 | ||
12549 | @item <=@r{, }>= | |
96a2c332 | 12550 | Less than or equal to, greater than or equal to |
c906108c SS |
12551 | on integral, floating-point and enumerated types, or set inclusion on |
12552 | set types. Same precedence as @code{<}. | |
12553 | ||
12554 | @item =@r{, }<>@r{, }# | |
12555 | Equality and two ways of expressing inequality, valid on scalar types. | |
12556 | Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is | |
12557 | available for inequality, since @code{#} conflicts with the script | |
12558 | comment character. | |
12559 | ||
12560 | @item IN | |
12561 | Set membership. Defined on set types and the types of their members. | |
12562 | Same precedence as @code{<}. | |
12563 | ||
12564 | @item OR | |
12565 | Boolean disjunction. Defined on boolean types. | |
12566 | ||
12567 | @item AND@r{, }& | |
d4f3574e | 12568 | Boolean conjunction. Defined on boolean types. |
c906108c SS |
12569 | |
12570 | @item @@ | |
12571 | The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}). | |
12572 | ||
12573 | @item +@r{, }- | |
12574 | Addition and subtraction on integral and floating-point types, or union | |
12575 | and difference on set types. | |
12576 | ||
12577 | @item * | |
12578 | Multiplication on integral and floating-point types, or set intersection | |
12579 | on set types. | |
12580 | ||
12581 | @item / | |
12582 | Division on floating-point types, or symmetric set difference on set | |
12583 | types. Same precedence as @code{*}. | |
12584 | ||
12585 | @item DIV@r{, }MOD | |
12586 | Integer division and remainder. Defined on integral types. Same | |
12587 | precedence as @code{*}. | |
12588 | ||
12589 | @item - | |
99e008fe | 12590 | Negative. Defined on @code{INTEGER} and @code{REAL} data. |
c906108c SS |
12591 | |
12592 | @item ^ | |
12593 | Pointer dereferencing. Defined on pointer types. | |
12594 | ||
12595 | @item NOT | |
12596 | Boolean negation. Defined on boolean types. Same precedence as | |
12597 | @code{^}. | |
12598 | ||
12599 | @item . | |
12600 | @code{RECORD} field selector. Defined on @code{RECORD} data. Same | |
12601 | precedence as @code{^}. | |
12602 | ||
12603 | @item [] | |
12604 | Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}. | |
12605 | ||
12606 | @item () | |
12607 | Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence | |
12608 | as @code{^}. | |
12609 | ||
12610 | @item ::@r{, }. | |
12611 | @value{GDBN} and Modula-2 scope operators. | |
12612 | @end table | |
12613 | ||
12614 | @quotation | |
72019c9c | 12615 | @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN} |
c906108c SS |
12616 | treats the use of the operator @code{IN}, or the use of operators |
12617 | @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#}, | |
12618 | @code{<=}, and @code{>=} on sets as an error. | |
12619 | @end quotation | |
12620 | ||
cb51c4e0 | 12621 | |
6d2ebf8b | 12622 | @node Built-In Func/Proc |
79a6e687 | 12623 | @subsubsection Built-in Functions and Procedures |
cb51c4e0 | 12624 | @cindex Modula-2 built-ins |
c906108c SS |
12625 | |
12626 | Modula-2 also makes available several built-in procedures and functions. | |
12627 | In describing these, the following metavariables are used: | |
12628 | ||
12629 | @table @var | |
12630 | ||
12631 | @item a | |
12632 | represents an @code{ARRAY} variable. | |
12633 | ||
12634 | @item c | |
12635 | represents a @code{CHAR} constant or variable. | |
12636 | ||
12637 | @item i | |
12638 | represents a variable or constant of integral type. | |
12639 | ||
12640 | @item m | |
12641 | represents an identifier that belongs to a set. Generally used in the | |
12642 | same function with the metavariable @var{s}. The type of @var{s} should | |
12643 | be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}). | |
12644 | ||
12645 | @item n | |
12646 | represents a variable or constant of integral or floating-point type. | |
12647 | ||
12648 | @item r | |
12649 | represents a variable or constant of floating-point type. | |
12650 | ||
12651 | @item t | |
12652 | represents a type. | |
12653 | ||
12654 | @item v | |
12655 | represents a variable. | |
12656 | ||
12657 | @item x | |
12658 | represents a variable or constant of one of many types. See the | |
12659 | explanation of the function for details. | |
12660 | @end table | |
12661 | ||
12662 | All Modula-2 built-in procedures also return a result, described below. | |
12663 | ||
12664 | @table @code | |
12665 | @item ABS(@var{n}) | |
12666 | Returns the absolute value of @var{n}. | |
12667 | ||
12668 | @item CAP(@var{c}) | |
12669 | If @var{c} is a lower case letter, it returns its upper case | |
c3f6f71d | 12670 | equivalent, otherwise it returns its argument. |
c906108c SS |
12671 | |
12672 | @item CHR(@var{i}) | |
12673 | Returns the character whose ordinal value is @var{i}. | |
12674 | ||
12675 | @item DEC(@var{v}) | |
c3f6f71d | 12676 | Decrements the value in the variable @var{v} by one. Returns the new value. |
c906108c SS |
12677 | |
12678 | @item DEC(@var{v},@var{i}) | |
12679 | Decrements the value in the variable @var{v} by @var{i}. Returns the | |
12680 | new value. | |
12681 | ||
12682 | @item EXCL(@var{m},@var{s}) | |
12683 | Removes the element @var{m} from the set @var{s}. Returns the new | |
12684 | set. | |
12685 | ||
12686 | @item FLOAT(@var{i}) | |
12687 | Returns the floating point equivalent of the integer @var{i}. | |
12688 | ||
12689 | @item HIGH(@var{a}) | |
12690 | Returns the index of the last member of @var{a}. | |
12691 | ||
12692 | @item INC(@var{v}) | |
c3f6f71d | 12693 | Increments the value in the variable @var{v} by one. Returns the new value. |
c906108c SS |
12694 | |
12695 | @item INC(@var{v},@var{i}) | |
12696 | Increments the value in the variable @var{v} by @var{i}. Returns the | |
12697 | new value. | |
12698 | ||
12699 | @item INCL(@var{m},@var{s}) | |
12700 | Adds the element @var{m} to the set @var{s} if it is not already | |
12701 | there. Returns the new set. | |
12702 | ||
12703 | @item MAX(@var{t}) | |
12704 | Returns the maximum value of the type @var{t}. | |
12705 | ||
12706 | @item MIN(@var{t}) | |
12707 | Returns the minimum value of the type @var{t}. | |
12708 | ||
12709 | @item ODD(@var{i}) | |
12710 | Returns boolean TRUE if @var{i} is an odd number. | |
12711 | ||
12712 | @item ORD(@var{x}) | |
12713 | Returns the ordinal value of its argument. For example, the ordinal | |
c3f6f71d JM |
12714 | value of a character is its @sc{ascii} value (on machines supporting the |
12715 | @sc{ascii} character set). @var{x} must be of an ordered type, which include | |
c906108c SS |
12716 | integral, character and enumerated types. |
12717 | ||
12718 | @item SIZE(@var{x}) | |
12719 | Returns the size of its argument. @var{x} can be a variable or a type. | |
12720 | ||
12721 | @item TRUNC(@var{r}) | |
12722 | Returns the integral part of @var{r}. | |
12723 | ||
844781a1 GM |
12724 | @item TSIZE(@var{x}) |
12725 | Returns the size of its argument. @var{x} can be a variable or a type. | |
12726 | ||
c906108c SS |
12727 | @item VAL(@var{t},@var{i}) |
12728 | Returns the member of the type @var{t} whose ordinal value is @var{i}. | |
12729 | @end table | |
12730 | ||
12731 | @quotation | |
12732 | @emph{Warning:} Sets and their operations are not yet supported, so | |
12733 | @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as | |
12734 | an error. | |
12735 | @end quotation | |
12736 | ||
12737 | @cindex Modula-2 constants | |
6d2ebf8b | 12738 | @node M2 Constants |
c906108c SS |
12739 | @subsubsection Constants |
12740 | ||
12741 | @value{GDBN} allows you to express the constants of Modula-2 in the following | |
12742 | ways: | |
12743 | ||
12744 | @itemize @bullet | |
12745 | ||
12746 | @item | |
12747 | Integer constants are simply a sequence of digits. When used in an | |
12748 | expression, a constant is interpreted to be type-compatible with the | |
12749 | rest of the expression. Hexadecimal integers are specified by a | |
12750 | trailing @samp{H}, and octal integers by a trailing @samp{B}. | |
12751 | ||
12752 | @item | |
12753 | Floating point constants appear as a sequence of digits, followed by a | |
12754 | decimal point and another sequence of digits. An optional exponent can | |
12755 | then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where | |
12756 | @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the | |
12757 | digits of the floating point constant must be valid decimal (base 10) | |
12758 | digits. | |
12759 | ||
12760 | @item | |
12761 | Character constants consist of a single character enclosed by a pair of | |
12762 | like quotes, either single (@code{'}) or double (@code{"}). They may | |
c3f6f71d | 12763 | also be expressed by their ordinal value (their @sc{ascii} value, usually) |
c906108c SS |
12764 | followed by a @samp{C}. |
12765 | ||
12766 | @item | |
12767 | String constants consist of a sequence of characters enclosed by a | |
12768 | pair of like quotes, either single (@code{'}) or double (@code{"}). | |
12769 | Escape sequences in the style of C are also allowed. @xref{C | |
79a6e687 | 12770 | Constants, ,C and C@t{++} Constants}, for a brief explanation of escape |
c906108c SS |
12771 | sequences. |
12772 | ||
12773 | @item | |
12774 | Enumerated constants consist of an enumerated identifier. | |
12775 | ||
12776 | @item | |
12777 | Boolean constants consist of the identifiers @code{TRUE} and | |
12778 | @code{FALSE}. | |
12779 | ||
12780 | @item | |
12781 | Pointer constants consist of integral values only. | |
12782 | ||
12783 | @item | |
12784 | Set constants are not yet supported. | |
12785 | @end itemize | |
12786 | ||
72019c9c GM |
12787 | @node M2 Types |
12788 | @subsubsection Modula-2 Types | |
12789 | @cindex Modula-2 types | |
12790 | ||
12791 | Currently @value{GDBN} can print the following data types in Modula-2 | |
12792 | syntax: array types, record types, set types, pointer types, procedure | |
12793 | types, enumerated types, subrange types and base types. You can also | |
12794 | print the contents of variables declared using these type. | |
12795 | This section gives a number of simple source code examples together with | |
12796 | sample @value{GDBN} sessions. | |
12797 | ||
12798 | The first example contains the following section of code: | |
12799 | ||
12800 | @smallexample | |
12801 | VAR | |
12802 | s: SET OF CHAR ; | |
12803 | r: [20..40] ; | |
12804 | @end smallexample | |
12805 | ||
12806 | @noindent | |
12807 | and you can request @value{GDBN} to interrogate the type and value of | |
12808 | @code{r} and @code{s}. | |
12809 | ||
12810 | @smallexample | |
12811 | (@value{GDBP}) print s | |
12812 | @{'A'..'C', 'Z'@} | |
12813 | (@value{GDBP}) ptype s | |
12814 | SET OF CHAR | |
12815 | (@value{GDBP}) print r | |
12816 | 21 | |
12817 | (@value{GDBP}) ptype r | |
12818 | [20..40] | |
12819 | @end smallexample | |
12820 | ||
12821 | @noindent | |
12822 | Likewise if your source code declares @code{s} as: | |
12823 | ||
12824 | @smallexample | |
12825 | VAR | |
12826 | s: SET ['A'..'Z'] ; | |
12827 | @end smallexample | |
12828 | ||
12829 | @noindent | |
12830 | then you may query the type of @code{s} by: | |
12831 | ||
12832 | @smallexample | |
12833 | (@value{GDBP}) ptype s | |
12834 | type = SET ['A'..'Z'] | |
12835 | @end smallexample | |
12836 | ||
12837 | @noindent | |
12838 | Note that at present you cannot interactively manipulate set | |
12839 | expressions using the debugger. | |
12840 | ||
12841 | The following example shows how you might declare an array in Modula-2 | |
12842 | and how you can interact with @value{GDBN} to print its type and contents: | |
12843 | ||
12844 | @smallexample | |
12845 | VAR | |
12846 | s: ARRAY [-10..10] OF CHAR ; | |
12847 | @end smallexample | |
12848 | ||
12849 | @smallexample | |
12850 | (@value{GDBP}) ptype s | |
12851 | ARRAY [-10..10] OF CHAR | |
12852 | @end smallexample | |
12853 | ||
12854 | Note that the array handling is not yet complete and although the type | |
12855 | is printed correctly, expression handling still assumes that all | |
12856 | arrays have a lower bound of zero and not @code{-10} as in the example | |
844781a1 | 12857 | above. |
72019c9c GM |
12858 | |
12859 | Here are some more type related Modula-2 examples: | |
12860 | ||
12861 | @smallexample | |
12862 | TYPE | |
12863 | colour = (blue, red, yellow, green) ; | |
12864 | t = [blue..yellow] ; | |
12865 | VAR | |
12866 | s: t ; | |
12867 | BEGIN | |
12868 | s := blue ; | |
12869 | @end smallexample | |
12870 | ||
12871 | @noindent | |
12872 | The @value{GDBN} interaction shows how you can query the data type | |
12873 | and value of a variable. | |
12874 | ||
12875 | @smallexample | |
12876 | (@value{GDBP}) print s | |
12877 | $1 = blue | |
12878 | (@value{GDBP}) ptype t | |
12879 | type = [blue..yellow] | |
12880 | @end smallexample | |
12881 | ||
12882 | @noindent | |
12883 | In this example a Modula-2 array is declared and its contents | |
12884 | displayed. Observe that the contents are written in the same way as | |
12885 | their @code{C} counterparts. | |
12886 | ||
12887 | @smallexample | |
12888 | VAR | |
12889 | s: ARRAY [1..5] OF CARDINAL ; | |
12890 | BEGIN | |
12891 | s[1] := 1 ; | |
12892 | @end smallexample | |
12893 | ||
12894 | @smallexample | |
12895 | (@value{GDBP}) print s | |
12896 | $1 = @{1, 0, 0, 0, 0@} | |
12897 | (@value{GDBP}) ptype s | |
12898 | type = ARRAY [1..5] OF CARDINAL | |
12899 | @end smallexample | |
12900 | ||
12901 | The Modula-2 language interface to @value{GDBN} also understands | |
12902 | pointer types as shown in this example: | |
12903 | ||
12904 | @smallexample | |
12905 | VAR | |
12906 | s: POINTER TO ARRAY [1..5] OF CARDINAL ; | |
12907 | BEGIN | |
12908 | NEW(s) ; | |
12909 | s^[1] := 1 ; | |
12910 | @end smallexample | |
12911 | ||
12912 | @noindent | |
12913 | and you can request that @value{GDBN} describes the type of @code{s}. | |
12914 | ||
12915 | @smallexample | |
12916 | (@value{GDBP}) ptype s | |
12917 | type = POINTER TO ARRAY [1..5] OF CARDINAL | |
12918 | @end smallexample | |
12919 | ||
12920 | @value{GDBN} handles compound types as we can see in this example. | |
12921 | Here we combine array types, record types, pointer types and subrange | |
12922 | types: | |
12923 | ||
12924 | @smallexample | |
12925 | TYPE | |
12926 | foo = RECORD | |
12927 | f1: CARDINAL ; | |
12928 | f2: CHAR ; | |
12929 | f3: myarray ; | |
12930 | END ; | |
12931 | ||
12932 | myarray = ARRAY myrange OF CARDINAL ; | |
12933 | myrange = [-2..2] ; | |
12934 | VAR | |
12935 | s: POINTER TO ARRAY myrange OF foo ; | |
12936 | @end smallexample | |
12937 | ||
12938 | @noindent | |
12939 | and you can ask @value{GDBN} to describe the type of @code{s} as shown | |
12940 | below. | |
12941 | ||
12942 | @smallexample | |
12943 | (@value{GDBP}) ptype s | |
12944 | type = POINTER TO ARRAY [-2..2] OF foo = RECORD | |
12945 | f1 : CARDINAL; | |
12946 | f2 : CHAR; | |
12947 | f3 : ARRAY [-2..2] OF CARDINAL; | |
12948 | END | |
12949 | @end smallexample | |
12950 | ||
6d2ebf8b | 12951 | @node M2 Defaults |
79a6e687 | 12952 | @subsubsection Modula-2 Defaults |
c906108c SS |
12953 | @cindex Modula-2 defaults |
12954 | ||
12955 | If type and range checking are set automatically by @value{GDBN}, they | |
12956 | both default to @code{on} whenever the working language changes to | |
d4f3574e | 12957 | Modula-2. This happens regardless of whether you or @value{GDBN} |
c906108c SS |
12958 | selected the working language. |
12959 | ||
12960 | If you allow @value{GDBN} to set the language automatically, then entering | |
12961 | code compiled from a file whose name ends with @file{.mod} sets the | |
79a6e687 BW |
12962 | working language to Modula-2. @xref{Automatically, ,Having @value{GDBN} |
12963 | Infer the Source Language}, for further details. | |
c906108c | 12964 | |
6d2ebf8b | 12965 | @node Deviations |
79a6e687 | 12966 | @subsubsection Deviations from Standard Modula-2 |
c906108c SS |
12967 | @cindex Modula-2, deviations from |
12968 | ||
12969 | A few changes have been made to make Modula-2 programs easier to debug. | |
12970 | This is done primarily via loosening its type strictness: | |
12971 | ||
12972 | @itemize @bullet | |
12973 | @item | |
12974 | Unlike in standard Modula-2, pointer constants can be formed by | |
12975 | integers. This allows you to modify pointer variables during | |
12976 | debugging. (In standard Modula-2, the actual address contained in a | |
12977 | pointer variable is hidden from you; it can only be modified | |
12978 | through direct assignment to another pointer variable or expression that | |
12979 | returned a pointer.) | |
12980 | ||
12981 | @item | |
12982 | C escape sequences can be used in strings and characters to represent | |
12983 | non-printable characters. @value{GDBN} prints out strings with these | |
12984 | escape sequences embedded. Single non-printable characters are | |
12985 | printed using the @samp{CHR(@var{nnn})} format. | |
12986 | ||
12987 | @item | |
12988 | The assignment operator (@code{:=}) returns the value of its right-hand | |
12989 | argument. | |
12990 | ||
12991 | @item | |
12992 | All built-in procedures both modify @emph{and} return their argument. | |
12993 | @end itemize | |
12994 | ||
6d2ebf8b | 12995 | @node M2 Checks |
79a6e687 | 12996 | @subsubsection Modula-2 Type and Range Checks |
c906108c SS |
12997 | @cindex Modula-2 checks |
12998 | ||
12999 | @quotation | |
13000 | @emph{Warning:} in this release, @value{GDBN} does not yet perform type or | |
13001 | range checking. | |
13002 | @end quotation | |
13003 | @c FIXME remove warning when type/range checks added | |
13004 | ||
13005 | @value{GDBN} considers two Modula-2 variables type equivalent if: | |
13006 | ||
13007 | @itemize @bullet | |
13008 | @item | |
13009 | They are of types that have been declared equivalent via a @code{TYPE | |
13010 | @var{t1} = @var{t2}} statement | |
13011 | ||
13012 | @item | |
13013 | They have been declared on the same line. (Note: This is true of the | |
13014 | @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.) | |
13015 | @end itemize | |
13016 | ||
13017 | As long as type checking is enabled, any attempt to combine variables | |
13018 | whose types are not equivalent is an error. | |
13019 | ||
13020 | Range checking is done on all mathematical operations, assignment, array | |
13021 | index bounds, and all built-in functions and procedures. | |
13022 | ||
6d2ebf8b | 13023 | @node M2 Scope |
79a6e687 | 13024 | @subsubsection The Scope Operators @code{::} and @code{.} |
c906108c | 13025 | @cindex scope |
41afff9a | 13026 | @cindex @code{.}, Modula-2 scope operator |
c906108c SS |
13027 | @cindex colon, doubled as scope operator |
13028 | @ifinfo | |
41afff9a | 13029 | @vindex colon-colon@r{, in Modula-2} |
c906108c SS |
13030 | @c Info cannot handle :: but TeX can. |
13031 | @end ifinfo | |
a67ec3f4 | 13032 | @ifnotinfo |
41afff9a | 13033 | @vindex ::@r{, in Modula-2} |
a67ec3f4 | 13034 | @end ifnotinfo |
c906108c SS |
13035 | |
13036 | There are a few subtle differences between the Modula-2 scope operator | |
13037 | (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have | |
13038 | similar syntax: | |
13039 | ||
474c8240 | 13040 | @smallexample |
c906108c SS |
13041 | |
13042 | @var{module} . @var{id} | |
13043 | @var{scope} :: @var{id} | |
474c8240 | 13044 | @end smallexample |
c906108c SS |
13045 | |
13046 | @noindent | |
13047 | where @var{scope} is the name of a module or a procedure, | |
13048 | @var{module} the name of a module, and @var{id} is any declared | |
13049 | identifier within your program, except another module. | |
13050 | ||
13051 | Using the @code{::} operator makes @value{GDBN} search the scope | |
13052 | specified by @var{scope} for the identifier @var{id}. If it is not | |
13053 | found in the specified scope, then @value{GDBN} searches all scopes | |
13054 | enclosing the one specified by @var{scope}. | |
13055 | ||
13056 | Using the @code{.} operator makes @value{GDBN} search the current scope for | |
13057 | the identifier specified by @var{id} that was imported from the | |
13058 | definition module specified by @var{module}. With this operator, it is | |
13059 | an error if the identifier @var{id} was not imported from definition | |
13060 | module @var{module}, or if @var{id} is not an identifier in | |
13061 | @var{module}. | |
13062 | ||
6d2ebf8b | 13063 | @node GDB/M2 |
c906108c SS |
13064 | @subsubsection @value{GDBN} and Modula-2 |
13065 | ||
13066 | Some @value{GDBN} commands have little use when debugging Modula-2 programs. | |
13067 | Five subcommands of @code{set print} and @code{show print} apply | |
b37052ae | 13068 | specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle}, |
c906108c | 13069 | @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four |
b37052ae | 13070 | apply to C@t{++}, and the last to the C @code{union} type, which has no direct |
c906108c SS |
13071 | analogue in Modula-2. |
13072 | ||
13073 | The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available | |
d4f3574e | 13074 | with any language, is not useful with Modula-2. Its |
c906108c | 13075 | intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be |
b37052ae | 13076 | created in Modula-2 as they can in C or C@t{++}. However, because an |
c906108c | 13077 | address can be specified by an integral constant, the construct |
d4f3574e | 13078 | @samp{@{@var{type}@}@var{adrexp}} is still useful. |
c906108c SS |
13079 | |
13080 | @cindex @code{#} in Modula-2 | |
13081 | In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is | |
13082 | interpreted as the beginning of a comment. Use @code{<>} instead. | |
c906108c | 13083 | |
e07c999f PH |
13084 | @node Ada |
13085 | @subsection Ada | |
13086 | @cindex Ada | |
13087 | ||
13088 | The extensions made to @value{GDBN} for Ada only support | |
13089 | output from the @sc{gnu} Ada (GNAT) compiler. | |
13090 | Other Ada compilers are not currently supported, and | |
13091 | attempting to debug executables produced by them is most likely | |
13092 | to be difficult. | |
13093 | ||
13094 | ||
13095 | @cindex expressions in Ada | |
13096 | @menu | |
13097 | * Ada Mode Intro:: General remarks on the Ada syntax | |
13098 | and semantics supported by Ada mode | |
13099 | in @value{GDBN}. | |
13100 | * Omissions from Ada:: Restrictions on the Ada expression syntax. | |
13101 | * Additions to Ada:: Extensions of the Ada expression syntax. | |
13102 | * Stopping Before Main Program:: Debugging the program during elaboration. | |
20924a55 JB |
13103 | * Ada Tasks:: Listing and setting breakpoints in tasks. |
13104 | * Ada Tasks and Core Files:: Tasking Support when Debugging Core Files | |
6e1bb179 JB |
13105 | * Ravenscar Profile:: Tasking Support when using the Ravenscar |
13106 | Profile | |
e07c999f PH |
13107 | * Ada Glitches:: Known peculiarities of Ada mode. |
13108 | @end menu | |
13109 | ||
13110 | @node Ada Mode Intro | |
13111 | @subsubsection Introduction | |
13112 | @cindex Ada mode, general | |
13113 | ||
13114 | The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression | |
13115 | syntax, with some extensions. | |
13116 | The philosophy behind the design of this subset is | |
13117 | ||
13118 | @itemize @bullet | |
13119 | @item | |
13120 | That @value{GDBN} should provide basic literals and access to operations for | |
13121 | arithmetic, dereferencing, field selection, indexing, and subprogram calls, | |
13122 | leaving more sophisticated computations to subprograms written into the | |
13123 | program (which therefore may be called from @value{GDBN}). | |
13124 | ||
13125 | @item | |
13126 | That type safety and strict adherence to Ada language restrictions | |
13127 | are not particularly important to the @value{GDBN} user. | |
13128 | ||
13129 | @item | |
13130 | That brevity is important to the @value{GDBN} user. | |
13131 | @end itemize | |
13132 | ||
f3a2dd1a JB |
13133 | Thus, for brevity, the debugger acts as if all names declared in |
13134 | user-written packages are directly visible, even if they are not visible | |
13135 | according to Ada rules, thus making it unnecessary to fully qualify most | |
13136 | names with their packages, regardless of context. Where this causes | |
13137 | ambiguity, @value{GDBN} asks the user's intent. | |
e07c999f PH |
13138 | |
13139 | The debugger will start in Ada mode if it detects an Ada main program. | |
13140 | As for other languages, it will enter Ada mode when stopped in a program that | |
13141 | was translated from an Ada source file. | |
13142 | ||
13143 | While in Ada mode, you may use `@t{--}' for comments. This is useful | |
13144 | mostly for documenting command files. The standard @value{GDBN} comment | |
13145 | (@samp{#}) still works at the beginning of a line in Ada mode, but not in the | |
13146 | middle (to allow based literals). | |
13147 | ||
13148 | The debugger supports limited overloading. Given a subprogram call in which | |
13149 | the function symbol has multiple definitions, it will use the number of | |
13150 | actual parameters and some information about their types to attempt to narrow | |
13151 | the set of definitions. It also makes very limited use of context, preferring | |
13152 | procedures to functions in the context of the @code{call} command, and | |
13153 | functions to procedures elsewhere. | |
13154 | ||
13155 | @node Omissions from Ada | |
13156 | @subsubsection Omissions from Ada | |
13157 | @cindex Ada, omissions from | |
13158 | ||
13159 | Here are the notable omissions from the subset: | |
13160 | ||
13161 | @itemize @bullet | |
13162 | @item | |
13163 | Only a subset of the attributes are supported: | |
13164 | ||
13165 | @itemize @minus | |
13166 | @item | |
13167 | @t{'First}, @t{'Last}, and @t{'Length} | |
13168 | on array objects (not on types and subtypes). | |
13169 | ||
13170 | @item | |
13171 | @t{'Min} and @t{'Max}. | |
13172 | ||
13173 | @item | |
13174 | @t{'Pos} and @t{'Val}. | |
13175 | ||
13176 | @item | |
13177 | @t{'Tag}. | |
13178 | ||
13179 | @item | |
13180 | @t{'Range} on array objects (not subtypes), but only as the right | |
13181 | operand of the membership (@code{in}) operator. | |
13182 | ||
13183 | @item | |
13184 | @t{'Access}, @t{'Unchecked_Access}, and | |
13185 | @t{'Unrestricted_Access} (a GNAT extension). | |
13186 | ||
13187 | @item | |
13188 | @t{'Address}. | |
13189 | @end itemize | |
13190 | ||
13191 | @item | |
13192 | The names in | |
13193 | @code{Characters.Latin_1} are not available and | |
13194 | concatenation is not implemented. Thus, escape characters in strings are | |
13195 | not currently available. | |
13196 | ||
13197 | @item | |
13198 | Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise | |
13199 | equality of representations. They will generally work correctly | |
13200 | for strings and arrays whose elements have integer or enumeration types. | |
13201 | They may not work correctly for arrays whose element | |
13202 | types have user-defined equality, for arrays of real values | |
13203 | (in particular, IEEE-conformant floating point, because of negative | |
13204 | zeroes and NaNs), and for arrays whose elements contain unused bits with | |
13205 | indeterminate values. | |
13206 | ||
13207 | @item | |
13208 | The other component-by-component array operations (@code{and}, @code{or}, | |
13209 | @code{xor}, @code{not}, and relational tests other than equality) | |
13210 | are not implemented. | |
13211 | ||
13212 | @item | |
860701dc PH |
13213 | @cindex array aggregates (Ada) |
13214 | @cindex record aggregates (Ada) | |
13215 | @cindex aggregates (Ada) | |
13216 | There is limited support for array and record aggregates. They are | |
13217 | permitted only on the right sides of assignments, as in these examples: | |
13218 | ||
13219 | @smallexample | |
077e0a52 JB |
13220 | (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6) |
13221 | (@value{GDBP}) set An_Array := (1, others => 0) | |
13222 | (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6) | |
13223 | (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9)) | |
13224 | (@value{GDBP}) set A_Record := (1, "Peter", True); | |
13225 | (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True) | |
860701dc PH |
13226 | @end smallexample |
13227 | ||
13228 | Changing a | |
13229 | discriminant's value by assigning an aggregate has an | |
13230 | undefined effect if that discriminant is used within the record. | |
13231 | However, you can first modify discriminants by directly assigning to | |
13232 | them (which normally would not be allowed in Ada), and then performing an | |
13233 | aggregate assignment. For example, given a variable @code{A_Rec} | |
13234 | declared to have a type such as: | |
13235 | ||
13236 | @smallexample | |
13237 | type Rec (Len : Small_Integer := 0) is record | |
13238 | Id : Integer; | |
13239 | Vals : IntArray (1 .. Len); | |
13240 | end record; | |
13241 | @end smallexample | |
13242 | ||
13243 | you can assign a value with a different size of @code{Vals} with two | |
13244 | assignments: | |
13245 | ||
13246 | @smallexample | |
077e0a52 JB |
13247 | (@value{GDBP}) set A_Rec.Len := 4 |
13248 | (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4)) | |
860701dc PH |
13249 | @end smallexample |
13250 | ||
13251 | As this example also illustrates, @value{GDBN} is very loose about the usual | |
13252 | rules concerning aggregates. You may leave out some of the | |
13253 | components of an array or record aggregate (such as the @code{Len} | |
13254 | component in the assignment to @code{A_Rec} above); they will retain their | |
13255 | original values upon assignment. You may freely use dynamic values as | |
13256 | indices in component associations. You may even use overlapping or | |
13257 | redundant component associations, although which component values are | |
13258 | assigned in such cases is not defined. | |
e07c999f PH |
13259 | |
13260 | @item | |
13261 | Calls to dispatching subprograms are not implemented. | |
13262 | ||
13263 | @item | |
13264 | The overloading algorithm is much more limited (i.e., less selective) | |
ae21e955 BW |
13265 | than that of real Ada. It makes only limited use of the context in |
13266 | which a subexpression appears to resolve its meaning, and it is much | |
13267 | looser in its rules for allowing type matches. As a result, some | |
13268 | function calls will be ambiguous, and the user will be asked to choose | |
13269 | the proper resolution. | |
e07c999f PH |
13270 | |
13271 | @item | |
13272 | The @code{new} operator is not implemented. | |
13273 | ||
13274 | @item | |
13275 | Entry calls are not implemented. | |
13276 | ||
13277 | @item | |
13278 | Aside from printing, arithmetic operations on the native VAX floating-point | |
13279 | formats are not supported. | |
13280 | ||
13281 | @item | |
13282 | It is not possible to slice a packed array. | |
158c7665 PH |
13283 | |
13284 | @item | |
13285 | The names @code{True} and @code{False}, when not part of a qualified name, | |
13286 | are interpreted as if implicitly prefixed by @code{Standard}, regardless of | |
13287 | context. | |
13288 | Should your program | |
13289 | redefine these names in a package or procedure (at best a dubious practice), | |
13290 | you will have to use fully qualified names to access their new definitions. | |
e07c999f PH |
13291 | @end itemize |
13292 | ||
13293 | @node Additions to Ada | |
13294 | @subsubsection Additions to Ada | |
13295 | @cindex Ada, deviations from | |
13296 | ||
13297 | As it does for other languages, @value{GDBN} makes certain generic | |
13298 | extensions to Ada (@pxref{Expressions}): | |
13299 | ||
13300 | @itemize @bullet | |
13301 | @item | |
ae21e955 BW |
13302 | If the expression @var{E} is a variable residing in memory (typically |
13303 | a local variable or array element) and @var{N} is a positive integer, | |
13304 | then @code{@var{E}@@@var{N}} displays the values of @var{E} and the | |
13305 | @var{N}-1 adjacent variables following it in memory as an array. In | |
13306 | Ada, this operator is generally not necessary, since its prime use is | |
13307 | in displaying parts of an array, and slicing will usually do this in | |
13308 | Ada. However, there are occasional uses when debugging programs in | |
13309 | which certain debugging information has been optimized away. | |
e07c999f PH |
13310 | |
13311 | @item | |
ae21e955 BW |
13312 | @code{@var{B}::@var{var}} means ``the variable named @var{var} that |
13313 | appears in function or file @var{B}.'' When @var{B} is a file name, | |
13314 | you must typically surround it in single quotes. | |
e07c999f PH |
13315 | |
13316 | @item | |
13317 | The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type | |
13318 | @var{type} that appears at address @var{addr}.'' | |
13319 | ||
13320 | @item | |
13321 | A name starting with @samp{$} is a convenience variable | |
13322 | (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}). | |
13323 | @end itemize | |
13324 | ||
ae21e955 BW |
13325 | In addition, @value{GDBN} provides a few other shortcuts and outright |
13326 | additions specific to Ada: | |
e07c999f PH |
13327 | |
13328 | @itemize @bullet | |
13329 | @item | |
13330 | The assignment statement is allowed as an expression, returning | |
13331 | its right-hand operand as its value. Thus, you may enter | |
13332 | ||
13333 | @smallexample | |
077e0a52 JB |
13334 | (@value{GDBP}) set x := y + 3 |
13335 | (@value{GDBP}) print A(tmp := y + 1) | |
e07c999f PH |
13336 | @end smallexample |
13337 | ||
13338 | @item | |
13339 | The semicolon is allowed as an ``operator,'' returning as its value | |
13340 | the value of its right-hand operand. | |
13341 | This allows, for example, | |
13342 | complex conditional breaks: | |
13343 | ||
13344 | @smallexample | |
077e0a52 JB |
13345 | (@value{GDBP}) break f |
13346 | (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100) | |
e07c999f PH |
13347 | @end smallexample |
13348 | ||
13349 | @item | |
13350 | Rather than use catenation and symbolic character names to introduce special | |
13351 | characters into strings, one may instead use a special bracket notation, | |
13352 | which is also used to print strings. A sequence of characters of the form | |
13353 | @samp{["@var{XX}"]} within a string or character literal denotes the | |
13354 | (single) character whose numeric encoding is @var{XX} in hexadecimal. The | |
13355 | sequence of characters @samp{["""]} also denotes a single quotation mark | |
13356 | in strings. For example, | |
13357 | @smallexample | |
13358 | "One line.["0a"]Next line.["0a"]" | |
13359 | @end smallexample | |
13360 | @noindent | |
ae21e955 BW |
13361 | contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF}) |
13362 | after each period. | |
e07c999f PH |
13363 | |
13364 | @item | |
13365 | The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and | |
13366 | @t{'Max} is optional (and is ignored in any case). For example, it is valid | |
13367 | to write | |
13368 | ||
13369 | @smallexample | |
077e0a52 | 13370 | (@value{GDBP}) print 'max(x, y) |
e07c999f PH |
13371 | @end smallexample |
13372 | ||
13373 | @item | |
13374 | When printing arrays, @value{GDBN} uses positional notation when the | |
13375 | array has a lower bound of 1, and uses a modified named notation otherwise. | |
ae21e955 BW |
13376 | For example, a one-dimensional array of three integers with a lower bound |
13377 | of 3 might print as | |
e07c999f PH |
13378 | |
13379 | @smallexample | |
13380 | (3 => 10, 17, 1) | |
13381 | @end smallexample | |
13382 | ||
13383 | @noindent | |
13384 | That is, in contrast to valid Ada, only the first component has a @code{=>} | |
13385 | clause. | |
13386 | ||
13387 | @item | |
13388 | You may abbreviate attributes in expressions with any unique, | |
13389 | multi-character subsequence of | |
13390 | their names (an exact match gets preference). | |
13391 | For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh} | |
13392 | in place of @t{a'length}. | |
13393 | ||
13394 | @item | |
13395 | @cindex quoting Ada internal identifiers | |
13396 | Since Ada is case-insensitive, the debugger normally maps identifiers you type | |
13397 | to lower case. The GNAT compiler uses upper-case characters for | |
13398 | some of its internal identifiers, which are normally of no interest to users. | |
13399 | For the rare occasions when you actually have to look at them, | |
13400 | enclose them in angle brackets to avoid the lower-case mapping. | |
13401 | For example, | |
13402 | @smallexample | |
077e0a52 | 13403 | (@value{GDBP}) print <JMPBUF_SAVE>[0] |
e07c999f PH |
13404 | @end smallexample |
13405 | ||
13406 | @item | |
13407 | Printing an object of class-wide type or dereferencing an | |
13408 | access-to-class-wide value will display all the components of the object's | |
13409 | specific type (as indicated by its run-time tag). Likewise, component | |
13410 | selection on such a value will operate on the specific type of the | |
13411 | object. | |
13412 | ||
13413 | @end itemize | |
13414 | ||
13415 | @node Stopping Before Main Program | |
13416 | @subsubsection Stopping at the Very Beginning | |
13417 | ||
13418 | @cindex breakpointing Ada elaboration code | |
13419 | It is sometimes necessary to debug the program during elaboration, and | |
13420 | before reaching the main procedure. | |
13421 | As defined in the Ada Reference | |
13422 | Manual, the elaboration code is invoked from a procedure called | |
13423 | @code{adainit}. To run your program up to the beginning of | |
13424 | elaboration, simply use the following two commands: | |
13425 | @code{tbreak adainit} and @code{run}. | |
13426 | ||
20924a55 JB |
13427 | @node Ada Tasks |
13428 | @subsubsection Extensions for Ada Tasks | |
13429 | @cindex Ada, tasking | |
13430 | ||
13431 | Support for Ada tasks is analogous to that for threads (@pxref{Threads}). | |
13432 | @value{GDBN} provides the following task-related commands: | |
13433 | ||
13434 | @table @code | |
13435 | @kindex info tasks | |
13436 | @item info tasks | |
13437 | This command shows a list of current Ada tasks, as in the following example: | |
13438 | ||
13439 | ||
13440 | @smallexample | |
13441 | @iftex | |
13442 | @leftskip=0.5cm | |
13443 | @end iftex | |
13444 | (@value{GDBP}) info tasks | |
13445 | ID TID P-ID Pri State Name | |
13446 | 1 8088000 0 15 Child Activation Wait main_task | |
13447 | 2 80a4000 1 15 Accept Statement b | |
13448 | 3 809a800 1 15 Child Activation Wait a | |
32cd1edc | 13449 | * 4 80ae800 3 15 Runnable c |
20924a55 JB |
13450 | |
13451 | @end smallexample | |
13452 | ||
13453 | @noindent | |
13454 | In this listing, the asterisk before the last task indicates it to be the | |
13455 | task currently being inspected. | |
13456 | ||
13457 | @table @asis | |
13458 | @item ID | |
13459 | Represents @value{GDBN}'s internal task number. | |
13460 | ||
13461 | @item TID | |
13462 | The Ada task ID. | |
13463 | ||
13464 | @item P-ID | |
13465 | The parent's task ID (@value{GDBN}'s internal task number). | |
13466 | ||
13467 | @item Pri | |
13468 | The base priority of the task. | |
13469 | ||
13470 | @item State | |
13471 | Current state of the task. | |
13472 | ||
13473 | @table @code | |
13474 | @item Unactivated | |
13475 | The task has been created but has not been activated. It cannot be | |
13476 | executing. | |
13477 | ||
20924a55 JB |
13478 | @item Runnable |
13479 | The task is not blocked for any reason known to Ada. (It may be waiting | |
13480 | for a mutex, though.) It is conceptually "executing" in normal mode. | |
13481 | ||
13482 | @item Terminated | |
13483 | The task is terminated, in the sense of ARM 9.3 (5). Any dependents | |
13484 | that were waiting on terminate alternatives have been awakened and have | |
13485 | terminated themselves. | |
13486 | ||
13487 | @item Child Activation Wait | |
13488 | The task is waiting for created tasks to complete activation. | |
13489 | ||
13490 | @item Accept Statement | |
13491 | The task is waiting on an accept or selective wait statement. | |
13492 | ||
13493 | @item Waiting on entry call | |
13494 | The task is waiting on an entry call. | |
13495 | ||
13496 | @item Async Select Wait | |
13497 | The task is waiting to start the abortable part of an asynchronous | |
13498 | select statement. | |
13499 | ||
13500 | @item Delay Sleep | |
13501 | The task is waiting on a select statement with only a delay | |
13502 | alternative open. | |
13503 | ||
13504 | @item Child Termination Wait | |
13505 | The task is sleeping having completed a master within itself, and is | |
13506 | waiting for the tasks dependent on that master to become terminated or | |
13507 | waiting on a terminate Phase. | |
13508 | ||
13509 | @item Wait Child in Term Alt | |
13510 | The task is sleeping waiting for tasks on terminate alternatives to | |
13511 | finish terminating. | |
13512 | ||
13513 | @item Accepting RV with @var{taskno} | |
13514 | The task is accepting a rendez-vous with the task @var{taskno}. | |
13515 | @end table | |
13516 | ||
13517 | @item Name | |
13518 | Name of the task in the program. | |
13519 | ||
13520 | @end table | |
13521 | ||
13522 | @kindex info task @var{taskno} | |
13523 | @item info task @var{taskno} | |
13524 | This command shows detailled informations on the specified task, as in | |
13525 | the following example: | |
13526 | @smallexample | |
13527 | @iftex | |
13528 | @leftskip=0.5cm | |
13529 | @end iftex | |
13530 | (@value{GDBP}) info tasks | |
13531 | ID TID P-ID Pri State Name | |
13532 | 1 8077880 0 15 Child Activation Wait main_task | |
32cd1edc | 13533 | * 2 807c468 1 15 Runnable task_1 |
20924a55 JB |
13534 | (@value{GDBP}) info task 2 |
13535 | Ada Task: 0x807c468 | |
13536 | Name: task_1 | |
13537 | Thread: 0x807f378 | |
13538 | Parent: 1 (main_task) | |
13539 | Base Priority: 15 | |
13540 | State: Runnable | |
13541 | @end smallexample | |
13542 | ||
13543 | @item task | |
13544 | @kindex task@r{ (Ada)} | |
13545 | @cindex current Ada task ID | |
13546 | This command prints the ID of the current task. | |
13547 | ||
13548 | @smallexample | |
13549 | @iftex | |
13550 | @leftskip=0.5cm | |
13551 | @end iftex | |
13552 | (@value{GDBP}) info tasks | |
13553 | ID TID P-ID Pri State Name | |
13554 | 1 8077870 0 15 Child Activation Wait main_task | |
32cd1edc | 13555 | * 2 807c458 1 15 Runnable t |
20924a55 JB |
13556 | (@value{GDBP}) task |
13557 | [Current task is 2] | |
13558 | @end smallexample | |
13559 | ||
13560 | @item task @var{taskno} | |
13561 | @cindex Ada task switching | |
13562 | This command is like the @code{thread @var{threadno}} | |
13563 | command (@pxref{Threads}). It switches the context of debugging | |
13564 | from the current task to the given task. | |
13565 | ||
13566 | @smallexample | |
13567 | @iftex | |
13568 | @leftskip=0.5cm | |
13569 | @end iftex | |
13570 | (@value{GDBP}) info tasks | |
13571 | ID TID P-ID Pri State Name | |
13572 | 1 8077870 0 15 Child Activation Wait main_task | |
32cd1edc | 13573 | * 2 807c458 1 15 Runnable t |
20924a55 JB |
13574 | (@value{GDBP}) task 1 |
13575 | [Switching to task 1] | |
13576 | #0 0x8067726 in pthread_cond_wait () | |
13577 | (@value{GDBP}) bt | |
13578 | #0 0x8067726 in pthread_cond_wait () | |
13579 | #1 0x8056714 in system.os_interface.pthread_cond_wait () | |
13580 | #2 0x805cb63 in system.task_primitives.operations.sleep () | |
13581 | #3 0x806153e in system.tasking.stages.activate_tasks () | |
13582 | #4 0x804aacc in un () at un.adb:5 | |
13583 | @end smallexample | |
13584 | ||
45ac276d JB |
13585 | @item break @var{linespec} task @var{taskno} |
13586 | @itemx break @var{linespec} task @var{taskno} if @dots{} | |
13587 | @cindex breakpoints and tasks, in Ada | |
13588 | @cindex task breakpoints, in Ada | |
13589 | @kindex break @dots{} task @var{taskno}@r{ (Ada)} | |
13590 | These commands are like the @code{break @dots{} thread @dots{}} | |
13591 | command (@pxref{Thread Stops}). | |
13592 | @var{linespec} specifies source lines, as described | |
13593 | in @ref{Specify Location}. | |
13594 | ||
13595 | Use the qualifier @samp{task @var{taskno}} with a breakpoint command | |
13596 | to specify that you only want @value{GDBN} to stop the program when a | |
13597 | particular Ada task reaches this breakpoint. @var{taskno} is one of the | |
13598 | numeric task identifiers assigned by @value{GDBN}, shown in the first | |
13599 | column of the @samp{info tasks} display. | |
13600 | ||
13601 | If you do not specify @samp{task @var{taskno}} when you set a | |
13602 | breakpoint, the breakpoint applies to @emph{all} tasks of your | |
13603 | program. | |
13604 | ||
13605 | You can use the @code{task} qualifier on conditional breakpoints as | |
13606 | well; in this case, place @samp{task @var{taskno}} before the | |
13607 | breakpoint condition (before the @code{if}). | |
13608 | ||
13609 | For example, | |
13610 | ||
13611 | @smallexample | |
13612 | @iftex | |
13613 | @leftskip=0.5cm | |
13614 | @end iftex | |
13615 | (@value{GDBP}) info tasks | |
13616 | ID TID P-ID Pri State Name | |
13617 | 1 140022020 0 15 Child Activation Wait main_task | |
13618 | 2 140045060 1 15 Accept/Select Wait t2 | |
13619 | 3 140044840 1 15 Runnable t1 | |
13620 | * 4 140056040 1 15 Runnable t3 | |
13621 | (@value{GDBP}) b 15 task 2 | |
13622 | Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15. | |
13623 | (@value{GDBP}) cont | |
13624 | Continuing. | |
13625 | task # 1 running | |
13626 | task # 2 running | |
13627 | ||
13628 | Breakpoint 5, test_task_debug () at test_task_debug.adb:15 | |
13629 | 15 flush; | |
13630 | (@value{GDBP}) info tasks | |
13631 | ID TID P-ID Pri State Name | |
13632 | 1 140022020 0 15 Child Activation Wait main_task | |
13633 | * 2 140045060 1 15 Runnable t2 | |
13634 | 3 140044840 1 15 Runnable t1 | |
13635 | 4 140056040 1 15 Delay Sleep t3 | |
13636 | @end smallexample | |
20924a55 JB |
13637 | @end table |
13638 | ||
13639 | @node Ada Tasks and Core Files | |
13640 | @subsubsection Tasking Support when Debugging Core Files | |
13641 | @cindex Ada tasking and core file debugging | |
13642 | ||
13643 | When inspecting a core file, as opposed to debugging a live program, | |
13644 | tasking support may be limited or even unavailable, depending on | |
13645 | the platform being used. | |
13646 | For instance, on x86-linux, the list of tasks is available, but task | |
13647 | switching is not supported. On Tru64, however, task switching will work | |
13648 | as usual. | |
13649 | ||
13650 | On certain platforms, including Tru64, the debugger needs to perform some | |
13651 | memory writes in order to provide Ada tasking support. When inspecting | |
13652 | a core file, this means that the core file must be opened with read-write | |
13653 | privileges, using the command @samp{"set write on"} (@pxref{Patching}). | |
13654 | Under these circumstances, you should make a backup copy of the core | |
13655 | file before inspecting it with @value{GDBN}. | |
13656 | ||
6e1bb179 JB |
13657 | @node Ravenscar Profile |
13658 | @subsubsection Tasking Support when using the Ravenscar Profile | |
13659 | @cindex Ravenscar Profile | |
13660 | ||
13661 | The @dfn{Ravenscar Profile} is a subset of the Ada tasking features, | |
13662 | specifically designed for systems with safety-critical real-time | |
13663 | requirements. | |
13664 | ||
13665 | @table @code | |
13666 | @kindex set ravenscar task-switching on | |
13667 | @cindex task switching with program using Ravenscar Profile | |
13668 | @item set ravenscar task-switching on | |
13669 | Allows task switching when debugging a program that uses the Ravenscar | |
13670 | Profile. This is the default. | |
13671 | ||
13672 | @kindex set ravenscar task-switching off | |
13673 | @item set ravenscar task-switching off | |
13674 | Turn off task switching when debugging a program that uses the Ravenscar | |
13675 | Profile. This is mostly intended to disable the code that adds support | |
13676 | for the Ravenscar Profile, in case a bug in either @value{GDBN} or in | |
13677 | the Ravenscar runtime is preventing @value{GDBN} from working properly. | |
13678 | To be effective, this command should be run before the program is started. | |
13679 | ||
13680 | @kindex show ravenscar task-switching | |
13681 | @item show ravenscar task-switching | |
13682 | Show whether it is possible to switch from task to task in a program | |
13683 | using the Ravenscar Profile. | |
13684 | ||
13685 | @end table | |
13686 | ||
e07c999f PH |
13687 | @node Ada Glitches |
13688 | @subsubsection Known Peculiarities of Ada Mode | |
13689 | @cindex Ada, problems | |
13690 | ||
13691 | Besides the omissions listed previously (@pxref{Omissions from Ada}), | |
13692 | we know of several problems with and limitations of Ada mode in | |
13693 | @value{GDBN}, | |
13694 | some of which will be fixed with planned future releases of the debugger | |
13695 | and the GNU Ada compiler. | |
13696 | ||
13697 | @itemize @bullet | |
e07c999f PH |
13698 | @item |
13699 | Static constants that the compiler chooses not to materialize as objects in | |
13700 | storage are invisible to the debugger. | |
13701 | ||
13702 | @item | |
13703 | Named parameter associations in function argument lists are ignored (the | |
13704 | argument lists are treated as positional). | |
13705 | ||
13706 | @item | |
13707 | Many useful library packages are currently invisible to the debugger. | |
13708 | ||
13709 | @item | |
13710 | Fixed-point arithmetic, conversions, input, and output is carried out using | |
13711 | floating-point arithmetic, and may give results that only approximate those on | |
13712 | the host machine. | |
13713 | ||
e07c999f PH |
13714 | @item |
13715 | The GNAT compiler never generates the prefix @code{Standard} for any of | |
13716 | the standard symbols defined by the Ada language. @value{GDBN} knows about | |
13717 | this: it will strip the prefix from names when you use it, and will never | |
13718 | look for a name you have so qualified among local symbols, nor match against | |
13719 | symbols in other packages or subprograms. If you have | |
13720 | defined entities anywhere in your program other than parameters and | |
13721 | local variables whose simple names match names in @code{Standard}, | |
13722 | GNAT's lack of qualification here can cause confusion. When this happens, | |
13723 | you can usually resolve the confusion | |
13724 | by qualifying the problematic names with package | |
13725 | @code{Standard} explicitly. | |
13726 | @end itemize | |
13727 | ||
95433b34 JB |
13728 | Older versions of the compiler sometimes generate erroneous debugging |
13729 | information, resulting in the debugger incorrectly printing the value | |
13730 | of affected entities. In some cases, the debugger is able to work | |
13731 | around an issue automatically. In other cases, the debugger is able | |
13732 | to work around the issue, but the work-around has to be specifically | |
13733 | enabled. | |
13734 | ||
13735 | @kindex set ada trust-PAD-over-XVS | |
13736 | @kindex show ada trust-PAD-over-XVS | |
13737 | @table @code | |
13738 | ||
13739 | @item set ada trust-PAD-over-XVS on | |
13740 | Configure GDB to strictly follow the GNAT encoding when computing the | |
13741 | value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS} | |
13742 | types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for | |
13743 | a complete description of the encoding used by the GNAT compiler). | |
13744 | This is the default. | |
13745 | ||
13746 | @item set ada trust-PAD-over-XVS off | |
13747 | This is related to the encoding using by the GNAT compiler. If @value{GDBN} | |
13748 | sometimes prints the wrong value for certain entities, changing @code{ada | |
13749 | trust-PAD-over-XVS} to @code{off} activates a work-around which may fix | |
13750 | the issue. It is always safe to set @code{ada trust-PAD-over-XVS} to | |
13751 | @code{off}, but this incurs a slight performance penalty, so it is | |
13752 | recommended to leave this setting to @code{on} unless necessary. | |
13753 | ||
13754 | @end table | |
13755 | ||
79a6e687 BW |
13756 | @node Unsupported Languages |
13757 | @section Unsupported Languages | |
4e562065 JB |
13758 | |
13759 | @cindex unsupported languages | |
13760 | @cindex minimal language | |
13761 | In addition to the other fully-supported programming languages, | |
13762 | @value{GDBN} also provides a pseudo-language, called @code{minimal}. | |
13763 | It does not represent a real programming language, but provides a set | |
13764 | of capabilities close to what the C or assembly languages provide. | |
13765 | This should allow most simple operations to be performed while debugging | |
13766 | an application that uses a language currently not supported by @value{GDBN}. | |
13767 | ||
13768 | If the language is set to @code{auto}, @value{GDBN} will automatically | |
13769 | select this language if the current frame corresponds to an unsupported | |
13770 | language. | |
13771 | ||
6d2ebf8b | 13772 | @node Symbols |
c906108c SS |
13773 | @chapter Examining the Symbol Table |
13774 | ||
d4f3574e | 13775 | The commands described in this chapter allow you to inquire about the |
c906108c SS |
13776 | symbols (names of variables, functions and types) defined in your |
13777 | program. This information is inherent in the text of your program and | |
13778 | does not change as your program executes. @value{GDBN} finds it in your | |
13779 | program's symbol table, in the file indicated when you started @value{GDBN} | |
79a6e687 BW |
13780 | (@pxref{File Options, ,Choosing Files}), or by one of the |
13781 | file-management commands (@pxref{Files, ,Commands to Specify Files}). | |
c906108c SS |
13782 | |
13783 | @cindex symbol names | |
13784 | @cindex names of symbols | |
13785 | @cindex quoting names | |
13786 | Occasionally, you may need to refer to symbols that contain unusual | |
13787 | characters, which @value{GDBN} ordinarily treats as word delimiters. The | |
13788 | most frequent case is in referring to static variables in other | |
79a6e687 | 13789 | source files (@pxref{Variables,,Program Variables}). File names |
c906108c SS |
13790 | are recorded in object files as debugging symbols, but @value{GDBN} would |
13791 | ordinarily parse a typical file name, like @file{foo.c}, as the three words | |
13792 | @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize | |
13793 | @samp{foo.c} as a single symbol, enclose it in single quotes; for example, | |
13794 | ||
474c8240 | 13795 | @smallexample |
c906108c | 13796 | p 'foo.c'::x |
474c8240 | 13797 | @end smallexample |
c906108c SS |
13798 | |
13799 | @noindent | |
13800 | looks up the value of @code{x} in the scope of the file @file{foo.c}. | |
13801 | ||
13802 | @table @code | |
a8f24a35 EZ |
13803 | @cindex case-insensitive symbol names |
13804 | @cindex case sensitivity in symbol names | |
13805 | @kindex set case-sensitive | |
13806 | @item set case-sensitive on | |
13807 | @itemx set case-sensitive off | |
13808 | @itemx set case-sensitive auto | |
13809 | Normally, when @value{GDBN} looks up symbols, it matches their names | |
13810 | with case sensitivity determined by the current source language. | |
13811 | Occasionally, you may wish to control that. The command @code{set | |
13812 | case-sensitive} lets you do that by specifying @code{on} for | |
13813 | case-sensitive matches or @code{off} for case-insensitive ones. If | |
13814 | you specify @code{auto}, case sensitivity is reset to the default | |
13815 | suitable for the source language. The default is case-sensitive | |
13816 | matches for all languages except for Fortran, for which the default is | |
13817 | case-insensitive matches. | |
13818 | ||
9c16f35a EZ |
13819 | @kindex show case-sensitive |
13820 | @item show case-sensitive | |
a8f24a35 EZ |
13821 | This command shows the current setting of case sensitivity for symbols |
13822 | lookups. | |
13823 | ||
c906108c | 13824 | @kindex info address |
b37052ae | 13825 | @cindex address of a symbol |
c906108c SS |
13826 | @item info address @var{symbol} |
13827 | Describe where the data for @var{symbol} is stored. For a register | |
13828 | variable, this says which register it is kept in. For a non-register | |
13829 | local variable, this prints the stack-frame offset at which the variable | |
13830 | is always stored. | |
13831 | ||
13832 | Note the contrast with @samp{print &@var{symbol}}, which does not work | |
13833 | at all for a register variable, and for a stack local variable prints | |
13834 | the exact address of the current instantiation of the variable. | |
13835 | ||
3d67e040 | 13836 | @kindex info symbol |
b37052ae | 13837 | @cindex symbol from address |
9c16f35a | 13838 | @cindex closest symbol and offset for an address |
3d67e040 EZ |
13839 | @item info symbol @var{addr} |
13840 | Print the name of a symbol which is stored at the address @var{addr}. | |
13841 | If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the | |
13842 | nearest symbol and an offset from it: | |
13843 | ||
474c8240 | 13844 | @smallexample |
3d67e040 EZ |
13845 | (@value{GDBP}) info symbol 0x54320 |
13846 | _initialize_vx + 396 in section .text | |
474c8240 | 13847 | @end smallexample |
3d67e040 EZ |
13848 | |
13849 | @noindent | |
13850 | This is the opposite of the @code{info address} command. You can use | |
13851 | it to find out the name of a variable or a function given its address. | |
13852 | ||
c14c28ba PP |
13853 | For dynamically linked executables, the name of executable or shared |
13854 | library containing the symbol is also printed: | |
13855 | ||
13856 | @smallexample | |
13857 | (@value{GDBP}) info symbol 0x400225 | |
13858 | _start + 5 in section .text of /tmp/a.out | |
13859 | (@value{GDBP}) info symbol 0x2aaaac2811cf | |
13860 | __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6 | |
13861 | @end smallexample | |
13862 | ||
c906108c | 13863 | @kindex whatis |
62f3a2ba FF |
13864 | @item whatis [@var{arg}] |
13865 | Print the data type of @var{arg}, which can be either an expression or | |
13866 | a data type. With no argument, print the data type of @code{$}, the | |
13867 | last value in the value history. If @var{arg} is an expression, it is | |
13868 | not actually evaluated, and any side-effecting operations (such as | |
13869 | assignments or function calls) inside it do not take place. If | |
13870 | @var{arg} is a type name, it may be the name of a type or typedef, or | |
13871 | for C code it may have the form @samp{class @var{class-name}}, | |
13872 | @samp{struct @var{struct-tag}}, @samp{union @var{union-tag}} or | |
13873 | @samp{enum @var{enum-tag}}. | |
c906108c SS |
13874 | @xref{Expressions, ,Expressions}. |
13875 | ||
c906108c | 13876 | @kindex ptype |
62f3a2ba FF |
13877 | @item ptype [@var{arg}] |
13878 | @code{ptype} accepts the same arguments as @code{whatis}, but prints a | |
13879 | detailed description of the type, instead of just the name of the type. | |
13880 | @xref{Expressions, ,Expressions}. | |
c906108c SS |
13881 | |
13882 | For example, for this variable declaration: | |
13883 | ||
474c8240 | 13884 | @smallexample |
c906108c | 13885 | struct complex @{double real; double imag;@} v; |
474c8240 | 13886 | @end smallexample |
c906108c SS |
13887 | |
13888 | @noindent | |
13889 | the two commands give this output: | |
13890 | ||
474c8240 | 13891 | @smallexample |
c906108c SS |
13892 | @group |
13893 | (@value{GDBP}) whatis v | |
13894 | type = struct complex | |
13895 | (@value{GDBP}) ptype v | |
13896 | type = struct complex @{ | |
13897 | double real; | |
13898 | double imag; | |
13899 | @} | |
13900 | @end group | |
474c8240 | 13901 | @end smallexample |
c906108c SS |
13902 | |
13903 | @noindent | |
13904 | As with @code{whatis}, using @code{ptype} without an argument refers to | |
13905 | the type of @code{$}, the last value in the value history. | |
13906 | ||
ab1adacd EZ |
13907 | @cindex incomplete type |
13908 | Sometimes, programs use opaque data types or incomplete specifications | |
13909 | of complex data structure. If the debug information included in the | |
13910 | program does not allow @value{GDBN} to display a full declaration of | |
13911 | the data type, it will say @samp{<incomplete type>}. For example, | |
13912 | given these declarations: | |
13913 | ||
13914 | @smallexample | |
13915 | struct foo; | |
13916 | struct foo *fooptr; | |
13917 | @end smallexample | |
13918 | ||
13919 | @noindent | |
13920 | but no definition for @code{struct foo} itself, @value{GDBN} will say: | |
13921 | ||
13922 | @smallexample | |
ddb50cd7 | 13923 | (@value{GDBP}) ptype foo |
ab1adacd EZ |
13924 | $1 = <incomplete type> |
13925 | @end smallexample | |
13926 | ||
13927 | @noindent | |
13928 | ``Incomplete type'' is C terminology for data types that are not | |
13929 | completely specified. | |
13930 | ||
c906108c SS |
13931 | @kindex info types |
13932 | @item info types @var{regexp} | |
13933 | @itemx info types | |
09d4efe1 EZ |
13934 | Print a brief description of all types whose names match the regular |
13935 | expression @var{regexp} (or all types in your program, if you supply | |
13936 | no argument). Each complete typename is matched as though it were a | |
13937 | complete line; thus, @samp{i type value} gives information on all | |
13938 | types in your program whose names include the string @code{value}, but | |
13939 | @samp{i type ^value$} gives information only on types whose complete | |
13940 | name is @code{value}. | |
c906108c SS |
13941 | |
13942 | This command differs from @code{ptype} in two ways: first, like | |
13943 | @code{whatis}, it does not print a detailed description; second, it | |
13944 | lists all source files where a type is defined. | |
13945 | ||
b37052ae EZ |
13946 | @kindex info scope |
13947 | @cindex local variables | |
09d4efe1 | 13948 | @item info scope @var{location} |
b37052ae | 13949 | List all the variables local to a particular scope. This command |
09d4efe1 EZ |
13950 | accepts a @var{location} argument---a function name, a source line, or |
13951 | an address preceded by a @samp{*}, and prints all the variables local | |
2a25a5ba EZ |
13952 | to the scope defined by that location. (@xref{Specify Location}, for |
13953 | details about supported forms of @var{location}.) For example: | |
b37052ae EZ |
13954 | |
13955 | @smallexample | |
13956 | (@value{GDBP}) @b{info scope command_line_handler} | |
13957 | Scope for command_line_handler: | |
13958 | Symbol rl is an argument at stack/frame offset 8, length 4. | |
13959 | Symbol linebuffer is in static storage at address 0x150a18, length 4. | |
13960 | Symbol linelength is in static storage at address 0x150a1c, length 4. | |
13961 | Symbol p is a local variable in register $esi, length 4. | |
13962 | Symbol p1 is a local variable in register $ebx, length 4. | |
13963 | Symbol nline is a local variable in register $edx, length 4. | |
13964 | Symbol repeat is a local variable at frame offset -8, length 4. | |
13965 | @end smallexample | |
13966 | ||
f5c37c66 EZ |
13967 | @noindent |
13968 | This command is especially useful for determining what data to collect | |
13969 | during a @dfn{trace experiment}, see @ref{Tracepoint Actions, | |
13970 | collect}. | |
13971 | ||
c906108c SS |
13972 | @kindex info source |
13973 | @item info source | |
919d772c JB |
13974 | Show information about the current source file---that is, the source file for |
13975 | the function containing the current point of execution: | |
13976 | @itemize @bullet | |
13977 | @item | |
13978 | the name of the source file, and the directory containing it, | |
13979 | @item | |
13980 | the directory it was compiled in, | |
13981 | @item | |
13982 | its length, in lines, | |
13983 | @item | |
13984 | which programming language it is written in, | |
13985 | @item | |
13986 | whether the executable includes debugging information for that file, and | |
13987 | if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and | |
13988 | @item | |
13989 | whether the debugging information includes information about | |
13990 | preprocessor macros. | |
13991 | @end itemize | |
13992 | ||
c906108c SS |
13993 | |
13994 | @kindex info sources | |
13995 | @item info sources | |
13996 | Print the names of all source files in your program for which there is | |
13997 | debugging information, organized into two lists: files whose symbols | |
13998 | have already been read, and files whose symbols will be read when needed. | |
13999 | ||
14000 | @kindex info functions | |
14001 | @item info functions | |
14002 | Print the names and data types of all defined functions. | |
14003 | ||
14004 | @item info functions @var{regexp} | |
14005 | Print the names and data types of all defined functions | |
14006 | whose names contain a match for regular expression @var{regexp}. | |
14007 | Thus, @samp{info fun step} finds all functions whose names | |
14008 | include @code{step}; @samp{info fun ^step} finds those whose names | |
b383017d | 14009 | start with @code{step}. If a function name contains characters |
c1468174 | 14010 | that conflict with the regular expression language (e.g.@: |
1c5dfdad | 14011 | @samp{operator*()}), they may be quoted with a backslash. |
c906108c SS |
14012 | |
14013 | @kindex info variables | |
14014 | @item info variables | |
0fe7935b | 14015 | Print the names and data types of all variables that are defined |
6ca652b0 | 14016 | outside of functions (i.e.@: excluding local variables). |
c906108c SS |
14017 | |
14018 | @item info variables @var{regexp} | |
14019 | Print the names and data types of all variables (except for local | |
14020 | variables) whose names contain a match for regular expression | |
14021 | @var{regexp}. | |
14022 | ||
b37303ee | 14023 | @kindex info classes |
721c2651 | 14024 | @cindex Objective-C, classes and selectors |
b37303ee AF |
14025 | @item info classes |
14026 | @itemx info classes @var{regexp} | |
14027 | Display all Objective-C classes in your program, or | |
14028 | (with the @var{regexp} argument) all those matching a particular regular | |
14029 | expression. | |
14030 | ||
14031 | @kindex info selectors | |
14032 | @item info selectors | |
14033 | @itemx info selectors @var{regexp} | |
14034 | Display all Objective-C selectors in your program, or | |
14035 | (with the @var{regexp} argument) all those matching a particular regular | |
14036 | expression. | |
14037 | ||
c906108c SS |
14038 | @ignore |
14039 | This was never implemented. | |
14040 | @kindex info methods | |
14041 | @item info methods | |
14042 | @itemx info methods @var{regexp} | |
14043 | The @code{info methods} command permits the user to examine all defined | |
b37052ae EZ |
14044 | methods within C@t{++} program, or (with the @var{regexp} argument) a |
14045 | specific set of methods found in the various C@t{++} classes. Many | |
14046 | C@t{++} classes provide a large number of methods. Thus, the output | |
c906108c SS |
14047 | from the @code{ptype} command can be overwhelming and hard to use. The |
14048 | @code{info-methods} command filters the methods, printing only those | |
14049 | which match the regular-expression @var{regexp}. | |
14050 | @end ignore | |
14051 | ||
c906108c SS |
14052 | @cindex reloading symbols |
14053 | Some systems allow individual object files that make up your program to | |
7a292a7a SS |
14054 | be replaced without stopping and restarting your program. For example, |
14055 | in VxWorks you can simply recompile a defective object file and keep on | |
14056 | running. If you are running on one of these systems, you can allow | |
14057 | @value{GDBN} to reload the symbols for automatically relinked modules: | |
c906108c SS |
14058 | |
14059 | @table @code | |
14060 | @kindex set symbol-reloading | |
14061 | @item set symbol-reloading on | |
14062 | Replace symbol definitions for the corresponding source file when an | |
14063 | object file with a particular name is seen again. | |
14064 | ||
14065 | @item set symbol-reloading off | |
6d2ebf8b SS |
14066 | Do not replace symbol definitions when encountering object files of the |
14067 | same name more than once. This is the default state; if you are not | |
14068 | running on a system that permits automatic relinking of modules, you | |
14069 | should leave @code{symbol-reloading} off, since otherwise @value{GDBN} | |
14070 | may discard symbols when linking large programs, that may contain | |
14071 | several modules (from different directories or libraries) with the same | |
14072 | name. | |
c906108c SS |
14073 | |
14074 | @kindex show symbol-reloading | |
14075 | @item show symbol-reloading | |
14076 | Show the current @code{on} or @code{off} setting. | |
14077 | @end table | |
c906108c | 14078 | |
9c16f35a | 14079 | @cindex opaque data types |
c906108c SS |
14080 | @kindex set opaque-type-resolution |
14081 | @item set opaque-type-resolution on | |
14082 | Tell @value{GDBN} to resolve opaque types. An opaque type is a type | |
14083 | declared as a pointer to a @code{struct}, @code{class}, or | |
14084 | @code{union}---for example, @code{struct MyType *}---that is used in one | |
14085 | source file although the full declaration of @code{struct MyType} is in | |
14086 | another source file. The default is on. | |
14087 | ||
14088 | A change in the setting of this subcommand will not take effect until | |
14089 | the next time symbols for a file are loaded. | |
14090 | ||
14091 | @item set opaque-type-resolution off | |
14092 | Tell @value{GDBN} not to resolve opaque types. In this case, the type | |
14093 | is printed as follows: | |
14094 | @smallexample | |
14095 | @{<no data fields>@} | |
14096 | @end smallexample | |
14097 | ||
14098 | @kindex show opaque-type-resolution | |
14099 | @item show opaque-type-resolution | |
14100 | Show whether opaque types are resolved or not. | |
c906108c SS |
14101 | |
14102 | @kindex maint print symbols | |
14103 | @cindex symbol dump | |
14104 | @kindex maint print psymbols | |
14105 | @cindex partial symbol dump | |
14106 | @item maint print symbols @var{filename} | |
14107 | @itemx maint print psymbols @var{filename} | |
14108 | @itemx maint print msymbols @var{filename} | |
14109 | Write a dump of debugging symbol data into the file @var{filename}. | |
14110 | These commands are used to debug the @value{GDBN} symbol-reading code. Only | |
14111 | symbols with debugging data are included. If you use @samp{maint print | |
14112 | symbols}, @value{GDBN} includes all the symbols for which it has already | |
14113 | collected full details: that is, @var{filename} reflects symbols for | |
14114 | only those files whose symbols @value{GDBN} has read. You can use the | |
14115 | command @code{info sources} to find out which files these are. If you | |
14116 | use @samp{maint print psymbols} instead, the dump shows information about | |
14117 | symbols that @value{GDBN} only knows partially---that is, symbols defined in | |
14118 | files that @value{GDBN} has skimmed, but not yet read completely. Finally, | |
14119 | @samp{maint print msymbols} dumps just the minimal symbol information | |
14120 | required for each object file from which @value{GDBN} has read some symbols. | |
79a6e687 | 14121 | @xref{Files, ,Commands to Specify Files}, for a discussion of how |
c906108c | 14122 | @value{GDBN} reads symbols (in the description of @code{symbol-file}). |
44ea7b70 | 14123 | |
5e7b2f39 JB |
14124 | @kindex maint info symtabs |
14125 | @kindex maint info psymtabs | |
44ea7b70 JB |
14126 | @cindex listing @value{GDBN}'s internal symbol tables |
14127 | @cindex symbol tables, listing @value{GDBN}'s internal | |
14128 | @cindex full symbol tables, listing @value{GDBN}'s internal | |
14129 | @cindex partial symbol tables, listing @value{GDBN}'s internal | |
5e7b2f39 JB |
14130 | @item maint info symtabs @r{[} @var{regexp} @r{]} |
14131 | @itemx maint info psymtabs @r{[} @var{regexp} @r{]} | |
44ea7b70 JB |
14132 | |
14133 | List the @code{struct symtab} or @code{struct partial_symtab} | |
14134 | structures whose names match @var{regexp}. If @var{regexp} is not | |
14135 | given, list them all. The output includes expressions which you can | |
14136 | copy into a @value{GDBN} debugging this one to examine a particular | |
14137 | structure in more detail. For example: | |
14138 | ||
14139 | @smallexample | |
5e7b2f39 | 14140 | (@value{GDBP}) maint info psymtabs dwarf2read |
44ea7b70 JB |
14141 | @{ objfile /home/gnu/build/gdb/gdb |
14142 | ((struct objfile *) 0x82e69d0) | |
b383017d | 14143 | @{ psymtab /home/gnu/src/gdb/dwarf2read.c |
44ea7b70 JB |
14144 | ((struct partial_symtab *) 0x8474b10) |
14145 | readin no | |
14146 | fullname (null) | |
14147 | text addresses 0x814d3c8 -- 0x8158074 | |
14148 | globals (* (struct partial_symbol **) 0x8507a08 @@ 9) | |
14149 | statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882) | |
14150 | dependencies (none) | |
14151 | @} | |
14152 | @} | |
5e7b2f39 | 14153 | (@value{GDBP}) maint info symtabs |
44ea7b70 JB |
14154 | (@value{GDBP}) |
14155 | @end smallexample | |
14156 | @noindent | |
14157 | We see that there is one partial symbol table whose filename contains | |
14158 | the string @samp{dwarf2read}, belonging to the @samp{gdb} executable; | |
14159 | and we see that @value{GDBN} has not read in any symtabs yet at all. | |
14160 | If we set a breakpoint on a function, that will cause @value{GDBN} to | |
14161 | read the symtab for the compilation unit containing that function: | |
14162 | ||
14163 | @smallexample | |
14164 | (@value{GDBP}) break dwarf2_psymtab_to_symtab | |
14165 | Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c, | |
14166 | line 1574. | |
5e7b2f39 | 14167 | (@value{GDBP}) maint info symtabs |
b383017d | 14168 | @{ objfile /home/gnu/build/gdb/gdb |
44ea7b70 | 14169 | ((struct objfile *) 0x82e69d0) |
b383017d | 14170 | @{ symtab /home/gnu/src/gdb/dwarf2read.c |
44ea7b70 JB |
14171 | ((struct symtab *) 0x86c1f38) |
14172 | dirname (null) | |
14173 | fullname (null) | |
14174 | blockvector ((struct blockvector *) 0x86c1bd0) (primary) | |
1b39d5c0 | 14175 | linetable ((struct linetable *) 0x8370fa0) |
44ea7b70 JB |
14176 | debugformat DWARF 2 |
14177 | @} | |
14178 | @} | |
b383017d | 14179 | (@value{GDBP}) |
44ea7b70 | 14180 | @end smallexample |
c906108c SS |
14181 | @end table |
14182 | ||
44ea7b70 | 14183 | |
6d2ebf8b | 14184 | @node Altering |
c906108c SS |
14185 | @chapter Altering Execution |
14186 | ||
14187 | Once you think you have found an error in your program, you might want to | |
14188 | find out for certain whether correcting the apparent error would lead to | |
14189 | correct results in the rest of the run. You can find the answer by | |
14190 | experiment, using the @value{GDBN} features for altering execution of the | |
14191 | program. | |
14192 | ||
14193 | For example, you can store new values into variables or memory | |
7a292a7a SS |
14194 | locations, give your program a signal, restart it at a different |
14195 | address, or even return prematurely from a function. | |
c906108c SS |
14196 | |
14197 | @menu | |
14198 | * Assignment:: Assignment to variables | |
14199 | * Jumping:: Continuing at a different address | |
c906108c | 14200 | * Signaling:: Giving your program a signal |
c906108c SS |
14201 | * Returning:: Returning from a function |
14202 | * Calling:: Calling your program's functions | |
14203 | * Patching:: Patching your program | |
14204 | @end menu | |
14205 | ||
6d2ebf8b | 14206 | @node Assignment |
79a6e687 | 14207 | @section Assignment to Variables |
c906108c SS |
14208 | |
14209 | @cindex assignment | |
14210 | @cindex setting variables | |
14211 | To alter the value of a variable, evaluate an assignment expression. | |
14212 | @xref{Expressions, ,Expressions}. For example, | |
14213 | ||
474c8240 | 14214 | @smallexample |
c906108c | 14215 | print x=4 |
474c8240 | 14216 | @end smallexample |
c906108c SS |
14217 | |
14218 | @noindent | |
14219 | stores the value 4 into the variable @code{x}, and then prints the | |
5d161b24 | 14220 | value of the assignment expression (which is 4). |
c906108c SS |
14221 | @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more |
14222 | information on operators in supported languages. | |
c906108c SS |
14223 | |
14224 | @kindex set variable | |
14225 | @cindex variables, setting | |
14226 | If you are not interested in seeing the value of the assignment, use the | |
14227 | @code{set} command instead of the @code{print} command. @code{set} is | |
14228 | really the same as @code{print} except that the expression's value is | |
14229 | not printed and is not put in the value history (@pxref{Value History, | |
79a6e687 | 14230 | ,Value History}). The expression is evaluated only for its effects. |
c906108c | 14231 | |
c906108c SS |
14232 | If the beginning of the argument string of the @code{set} command |
14233 | appears identical to a @code{set} subcommand, use the @code{set | |
14234 | variable} command instead of just @code{set}. This command is identical | |
14235 | to @code{set} except for its lack of subcommands. For example, if your | |
14236 | program has a variable @code{width}, you get an error if you try to set | |
14237 | a new value with just @samp{set width=13}, because @value{GDBN} has the | |
14238 | command @code{set width}: | |
14239 | ||
474c8240 | 14240 | @smallexample |
c906108c SS |
14241 | (@value{GDBP}) whatis width |
14242 | type = double | |
14243 | (@value{GDBP}) p width | |
14244 | $4 = 13 | |
14245 | (@value{GDBP}) set width=47 | |
14246 | Invalid syntax in expression. | |
474c8240 | 14247 | @end smallexample |
c906108c SS |
14248 | |
14249 | @noindent | |
14250 | The invalid expression, of course, is @samp{=47}. In | |
14251 | order to actually set the program's variable @code{width}, use | |
14252 | ||
474c8240 | 14253 | @smallexample |
c906108c | 14254 | (@value{GDBP}) set var width=47 |
474c8240 | 14255 | @end smallexample |
53a5351d | 14256 | |
c906108c SS |
14257 | Because the @code{set} command has many subcommands that can conflict |
14258 | with the names of program variables, it is a good idea to use the | |
14259 | @code{set variable} command instead of just @code{set}. For example, if | |
14260 | your program has a variable @code{g}, you run into problems if you try | |
14261 | to set a new value with just @samp{set g=4}, because @value{GDBN} has | |
14262 | the command @code{set gnutarget}, abbreviated @code{set g}: | |
14263 | ||
474c8240 | 14264 | @smallexample |
c906108c SS |
14265 | @group |
14266 | (@value{GDBP}) whatis g | |
14267 | type = double | |
14268 | (@value{GDBP}) p g | |
14269 | $1 = 1 | |
14270 | (@value{GDBP}) set g=4 | |
2df3850c | 14271 | (@value{GDBP}) p g |
c906108c SS |
14272 | $2 = 1 |
14273 | (@value{GDBP}) r | |
14274 | The program being debugged has been started already. | |
14275 | Start it from the beginning? (y or n) y | |
14276 | Starting program: /home/smith/cc_progs/a.out | |
6d2ebf8b SS |
14277 | "/home/smith/cc_progs/a.out": can't open to read symbols: |
14278 | Invalid bfd target. | |
c906108c SS |
14279 | (@value{GDBP}) show g |
14280 | The current BFD target is "=4". | |
14281 | @end group | |
474c8240 | 14282 | @end smallexample |
c906108c SS |
14283 | |
14284 | @noindent | |
14285 | The program variable @code{g} did not change, and you silently set the | |
14286 | @code{gnutarget} to an invalid value. In order to set the variable | |
14287 | @code{g}, use | |
14288 | ||
474c8240 | 14289 | @smallexample |
c906108c | 14290 | (@value{GDBP}) set var g=4 |
474c8240 | 14291 | @end smallexample |
c906108c SS |
14292 | |
14293 | @value{GDBN} allows more implicit conversions in assignments than C; you can | |
14294 | freely store an integer value into a pointer variable or vice versa, | |
14295 | and you can convert any structure to any other structure that is the | |
14296 | same length or shorter. | |
14297 | @comment FIXME: how do structs align/pad in these conversions? | |
14298 | @comment /doc@cygnus.com 18dec1990 | |
14299 | ||
14300 | To store values into arbitrary places in memory, use the @samp{@{@dots{}@}} | |
14301 | construct to generate a value of specified type at a specified address | |
14302 | (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers | |
14303 | to memory location @code{0x83040} as an integer (which implies a certain size | |
14304 | and representation in memory), and | |
14305 | ||
474c8240 | 14306 | @smallexample |
c906108c | 14307 | set @{int@}0x83040 = 4 |
474c8240 | 14308 | @end smallexample |
c906108c SS |
14309 | |
14310 | @noindent | |
14311 | stores the value 4 into that memory location. | |
14312 | ||
6d2ebf8b | 14313 | @node Jumping |
79a6e687 | 14314 | @section Continuing at a Different Address |
c906108c SS |
14315 | |
14316 | Ordinarily, when you continue your program, you do so at the place where | |
14317 | it stopped, with the @code{continue} command. You can instead continue at | |
14318 | an address of your own choosing, with the following commands: | |
14319 | ||
14320 | @table @code | |
14321 | @kindex jump | |
14322 | @item jump @var{linespec} | |
2a25a5ba EZ |
14323 | @itemx jump @var{location} |
14324 | Resume execution at line @var{linespec} or at address given by | |
14325 | @var{location}. Execution stops again immediately if there is a | |
14326 | breakpoint there. @xref{Specify Location}, for a description of the | |
14327 | different forms of @var{linespec} and @var{location}. It is common | |
14328 | practice to use the @code{tbreak} command in conjunction with | |
14329 | @code{jump}. @xref{Set Breaks, ,Setting Breakpoints}. | |
c906108c SS |
14330 | |
14331 | The @code{jump} command does not change the current stack frame, or | |
14332 | the stack pointer, or the contents of any memory location or any | |
14333 | register other than the program counter. If line @var{linespec} is in | |
14334 | a different function from the one currently executing, the results may | |
14335 | be bizarre if the two functions expect different patterns of arguments or | |
14336 | of local variables. For this reason, the @code{jump} command requests | |
14337 | confirmation if the specified line is not in the function currently | |
14338 | executing. However, even bizarre results are predictable if you are | |
14339 | well acquainted with the machine-language code of your program. | |
c906108c SS |
14340 | @end table |
14341 | ||
c906108c | 14342 | @c Doesn't work on HP-UX; have to set $pcoqh and $pcoqt. |
53a5351d JM |
14343 | On many systems, you can get much the same effect as the @code{jump} |
14344 | command by storing a new value into the register @code{$pc}. The | |
14345 | difference is that this does not start your program running; it only | |
14346 | changes the address of where it @emph{will} run when you continue. For | |
14347 | example, | |
c906108c | 14348 | |
474c8240 | 14349 | @smallexample |
c906108c | 14350 | set $pc = 0x485 |
474c8240 | 14351 | @end smallexample |
c906108c SS |
14352 | |
14353 | @noindent | |
14354 | makes the next @code{continue} command or stepping command execute at | |
14355 | address @code{0x485}, rather than at the address where your program stopped. | |
79a6e687 | 14356 | @xref{Continuing and Stepping, ,Continuing and Stepping}. |
c906108c SS |
14357 | |
14358 | The most common occasion to use the @code{jump} command is to back | |
14359 | up---perhaps with more breakpoints set---over a portion of a program | |
14360 | that has already executed, in order to examine its execution in more | |
14361 | detail. | |
14362 | ||
c906108c | 14363 | @c @group |
6d2ebf8b | 14364 | @node Signaling |
79a6e687 | 14365 | @section Giving your Program a Signal |
9c16f35a | 14366 | @cindex deliver a signal to a program |
c906108c SS |
14367 | |
14368 | @table @code | |
14369 | @kindex signal | |
14370 | @item signal @var{signal} | |
14371 | Resume execution where your program stopped, but immediately give it the | |
14372 | signal @var{signal}. @var{signal} can be the name or the number of a | |
14373 | signal. For example, on many systems @code{signal 2} and @code{signal | |
14374 | SIGINT} are both ways of sending an interrupt signal. | |
14375 | ||
14376 | Alternatively, if @var{signal} is zero, continue execution without | |
14377 | giving a signal. This is useful when your program stopped on account of | |
14378 | a signal and would ordinary see the signal when resumed with the | |
14379 | @code{continue} command; @samp{signal 0} causes it to resume without a | |
14380 | signal. | |
14381 | ||
14382 | @code{signal} does not repeat when you press @key{RET} a second time | |
14383 | after executing the command. | |
14384 | @end table | |
14385 | @c @end group | |
14386 | ||
14387 | Invoking the @code{signal} command is not the same as invoking the | |
14388 | @code{kill} utility from the shell. Sending a signal with @code{kill} | |
14389 | causes @value{GDBN} to decide what to do with the signal depending on | |
14390 | the signal handling tables (@pxref{Signals}). The @code{signal} command | |
14391 | passes the signal directly to your program. | |
14392 | ||
c906108c | 14393 | |
6d2ebf8b | 14394 | @node Returning |
79a6e687 | 14395 | @section Returning from a Function |
c906108c SS |
14396 | |
14397 | @table @code | |
14398 | @cindex returning from a function | |
14399 | @kindex return | |
14400 | @item return | |
14401 | @itemx return @var{expression} | |
14402 | You can cancel execution of a function call with the @code{return} | |
14403 | command. If you give an | |
14404 | @var{expression} argument, its value is used as the function's return | |
14405 | value. | |
14406 | @end table | |
14407 | ||
14408 | When you use @code{return}, @value{GDBN} discards the selected stack frame | |
14409 | (and all frames within it). You can think of this as making the | |
14410 | discarded frame return prematurely. If you wish to specify a value to | |
14411 | be returned, give that value as the argument to @code{return}. | |
14412 | ||
14413 | This pops the selected stack frame (@pxref{Selection, ,Selecting a | |
79a6e687 | 14414 | Frame}), and any other frames inside of it, leaving its caller as the |
c906108c SS |
14415 | innermost remaining frame. That frame becomes selected. The |
14416 | specified value is stored in the registers used for returning values | |
14417 | of functions. | |
14418 | ||
14419 | The @code{return} command does not resume execution; it leaves the | |
14420 | program stopped in the state that would exist if the function had just | |
14421 | returned. In contrast, the @code{finish} command (@pxref{Continuing | |
79a6e687 | 14422 | and Stepping, ,Continuing and Stepping}) resumes execution until the |
c906108c SS |
14423 | selected stack frame returns naturally. |
14424 | ||
61ff14c6 JK |
14425 | @value{GDBN} needs to know how the @var{expression} argument should be set for |
14426 | the inferior. The concrete registers assignment depends on the OS ABI and the | |
14427 | type being returned by the selected stack frame. For example it is common for | |
14428 | OS ABI to return floating point values in FPU registers while integer values in | |
14429 | CPU registers. Still some ABIs return even floating point values in CPU | |
14430 | registers. Larger integer widths (such as @code{long long int}) also have | |
14431 | specific placement rules. @value{GDBN} already knows the OS ABI from its | |
14432 | current target so it needs to find out also the type being returned to make the | |
14433 | assignment into the right register(s). | |
14434 | ||
14435 | Normally, the selected stack frame has debug info. @value{GDBN} will always | |
14436 | use the debug info instead of the implicit type of @var{expression} when the | |
14437 | debug info is available. For example, if you type @kbd{return -1}, and the | |
14438 | function in the current stack frame is declared to return a @code{long long | |
14439 | int}, @value{GDBN} transparently converts the implicit @code{int} value of -1 | |
14440 | into a @code{long long int}: | |
14441 | ||
14442 | @smallexample | |
14443 | Breakpoint 1, func () at gdb.base/return-nodebug.c:29 | |
14444 | 29 return 31; | |
14445 | (@value{GDBP}) return -1 | |
14446 | Make func return now? (y or n) y | |
14447 | #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43 | |
14448 | 43 printf ("result=%lld\n", func ()); | |
14449 | (@value{GDBP}) | |
14450 | @end smallexample | |
14451 | ||
14452 | However, if the selected stack frame does not have a debug info, e.g., if the | |
14453 | function was compiled without debug info, @value{GDBN} has to find out the type | |
14454 | to return from user. Specifying a different type by mistake may set the value | |
14455 | in different inferior registers than the caller code expects. For example, | |
14456 | typing @kbd{return -1} with its implicit type @code{int} would set only a part | |
14457 | of a @code{long long int} result for a debug info less function (on 32-bit | |
14458 | architectures). Therefore the user is required to specify the return type by | |
14459 | an appropriate cast explicitly: | |
14460 | ||
14461 | @smallexample | |
14462 | Breakpoint 2, 0x0040050b in func () | |
14463 | (@value{GDBP}) return -1 | |
14464 | Return value type not available for selected stack frame. | |
14465 | Please use an explicit cast of the value to return. | |
14466 | (@value{GDBP}) return (long long int) -1 | |
14467 | Make selected stack frame return now? (y or n) y | |
14468 | #0 0x00400526 in main () | |
14469 | (@value{GDBP}) | |
14470 | @end smallexample | |
14471 | ||
6d2ebf8b | 14472 | @node Calling |
79a6e687 | 14473 | @section Calling Program Functions |
c906108c | 14474 | |
f8568604 | 14475 | @table @code |
c906108c | 14476 | @cindex calling functions |
f8568604 EZ |
14477 | @cindex inferior functions, calling |
14478 | @item print @var{expr} | |
d3e8051b | 14479 | Evaluate the expression @var{expr} and display the resulting value. |
f8568604 EZ |
14480 | @var{expr} may include calls to functions in the program being |
14481 | debugged. | |
14482 | ||
c906108c | 14483 | @kindex call |
c906108c SS |
14484 | @item call @var{expr} |
14485 | Evaluate the expression @var{expr} without displaying @code{void} | |
14486 | returned values. | |
c906108c SS |
14487 | |
14488 | You can use this variant of the @code{print} command if you want to | |
f8568604 EZ |
14489 | execute a function from your program that does not return anything |
14490 | (a.k.a.@: @dfn{a void function}), but without cluttering the output | |
14491 | with @code{void} returned values that @value{GDBN} will otherwise | |
14492 | print. If the result is not void, it is printed and saved in the | |
14493 | value history. | |
14494 | @end table | |
14495 | ||
9c16f35a EZ |
14496 | It is possible for the function you call via the @code{print} or |
14497 | @code{call} command to generate a signal (e.g., if there's a bug in | |
14498 | the function, or if you passed it incorrect arguments). What happens | |
14499 | in that case is controlled by the @code{set unwindonsignal} command. | |
14500 | ||
7cd1089b PM |
14501 | Similarly, with a C@t{++} program it is possible for the function you |
14502 | call via the @code{print} or @code{call} command to generate an | |
14503 | exception that is not handled due to the constraints of the dummy | |
14504 | frame. In this case, any exception that is raised in the frame, but has | |
14505 | an out-of-frame exception handler will not be found. GDB builds a | |
14506 | dummy-frame for the inferior function call, and the unwinder cannot | |
14507 | seek for exception handlers outside of this dummy-frame. What happens | |
14508 | in that case is controlled by the | |
14509 | @code{set unwind-on-terminating-exception} command. | |
14510 | ||
9c16f35a EZ |
14511 | @table @code |
14512 | @item set unwindonsignal | |
14513 | @kindex set unwindonsignal | |
14514 | @cindex unwind stack in called functions | |
14515 | @cindex call dummy stack unwinding | |
14516 | Set unwinding of the stack if a signal is received while in a function | |
14517 | that @value{GDBN} called in the program being debugged. If set to on, | |
14518 | @value{GDBN} unwinds the stack it created for the call and restores | |
14519 | the context to what it was before the call. If set to off (the | |
14520 | default), @value{GDBN} stops in the frame where the signal was | |
14521 | received. | |
14522 | ||
14523 | @item show unwindonsignal | |
14524 | @kindex show unwindonsignal | |
14525 | Show the current setting of stack unwinding in the functions called by | |
14526 | @value{GDBN}. | |
7cd1089b PM |
14527 | |
14528 | @item set unwind-on-terminating-exception | |
14529 | @kindex set unwind-on-terminating-exception | |
14530 | @cindex unwind stack in called functions with unhandled exceptions | |
14531 | @cindex call dummy stack unwinding on unhandled exception. | |
14532 | Set unwinding of the stack if a C@t{++} exception is raised, but left | |
14533 | unhandled while in a function that @value{GDBN} called in the program being | |
14534 | debugged. If set to on (the default), @value{GDBN} unwinds the stack | |
14535 | it created for the call and restores the context to what it was before | |
14536 | the call. If set to off, @value{GDBN} the exception is delivered to | |
14537 | the default C@t{++} exception handler and the inferior terminated. | |
14538 | ||
14539 | @item show unwind-on-terminating-exception | |
14540 | @kindex show unwind-on-terminating-exception | |
14541 | Show the current setting of stack unwinding in the functions called by | |
14542 | @value{GDBN}. | |
14543 | ||
9c16f35a EZ |
14544 | @end table |
14545 | ||
f8568604 EZ |
14546 | @cindex weak alias functions |
14547 | Sometimes, a function you wish to call is actually a @dfn{weak alias} | |
14548 | for another function. In such case, @value{GDBN} might not pick up | |
14549 | the type information, including the types of the function arguments, | |
14550 | which causes @value{GDBN} to call the inferior function incorrectly. | |
14551 | As a result, the called function will function erroneously and may | |
14552 | even crash. A solution to that is to use the name of the aliased | |
14553 | function instead. | |
c906108c | 14554 | |
6d2ebf8b | 14555 | @node Patching |
79a6e687 | 14556 | @section Patching Programs |
7a292a7a | 14557 | |
c906108c SS |
14558 | @cindex patching binaries |
14559 | @cindex writing into executables | |
c906108c | 14560 | @cindex writing into corefiles |
c906108c | 14561 | |
7a292a7a SS |
14562 | By default, @value{GDBN} opens the file containing your program's |
14563 | executable code (or the corefile) read-only. This prevents accidental | |
14564 | alterations to machine code; but it also prevents you from intentionally | |
14565 | patching your program's binary. | |
c906108c SS |
14566 | |
14567 | If you'd like to be able to patch the binary, you can specify that | |
14568 | explicitly with the @code{set write} command. For example, you might | |
14569 | want to turn on internal debugging flags, or even to make emergency | |
14570 | repairs. | |
14571 | ||
14572 | @table @code | |
14573 | @kindex set write | |
14574 | @item set write on | |
14575 | @itemx set write off | |
7a292a7a | 14576 | If you specify @samp{set write on}, @value{GDBN} opens executable and |
20924a55 | 14577 | core files for both reading and writing; if you specify @kbd{set write |
c906108c SS |
14578 | off} (the default), @value{GDBN} opens them read-only. |
14579 | ||
14580 | If you have already loaded a file, you must load it again (using the | |
7a292a7a SS |
14581 | @code{exec-file} or @code{core-file} command) after changing @code{set |
14582 | write}, for your new setting to take effect. | |
c906108c SS |
14583 | |
14584 | @item show write | |
14585 | @kindex show write | |
7a292a7a SS |
14586 | Display whether executable files and core files are opened for writing |
14587 | as well as reading. | |
c906108c SS |
14588 | @end table |
14589 | ||
6d2ebf8b | 14590 | @node GDB Files |
c906108c SS |
14591 | @chapter @value{GDBN} Files |
14592 | ||
7a292a7a SS |
14593 | @value{GDBN} needs to know the file name of the program to be debugged, |
14594 | both in order to read its symbol table and in order to start your | |
14595 | program. To debug a core dump of a previous run, you must also tell | |
14596 | @value{GDBN} the name of the core dump file. | |
c906108c SS |
14597 | |
14598 | @menu | |
14599 | * Files:: Commands to specify files | |
5b5d99cf | 14600 | * Separate Debug Files:: Debugging information in separate files |
9291a0cd | 14601 | * Index Files:: Index files speed up GDB |
c906108c | 14602 | * Symbol Errors:: Errors reading symbol files |
b14b1491 | 14603 | * Data Files:: GDB data files |
c906108c SS |
14604 | @end menu |
14605 | ||
6d2ebf8b | 14606 | @node Files |
79a6e687 | 14607 | @section Commands to Specify Files |
c906108c | 14608 | |
7a292a7a | 14609 | @cindex symbol table |
c906108c | 14610 | @cindex core dump file |
7a292a7a SS |
14611 | |
14612 | You may want to specify executable and core dump file names. The usual | |
14613 | way to do this is at start-up time, using the arguments to | |
14614 | @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and | |
14615 | Out of @value{GDBN}}). | |
c906108c SS |
14616 | |
14617 | Occasionally it is necessary to change to a different file during a | |
397ca115 EZ |
14618 | @value{GDBN} session. Or you may run @value{GDBN} and forget to |
14619 | specify a file you want to use. Or you are debugging a remote target | |
79a6e687 BW |
14620 | via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver} |
14621 | Program}). In these situations the @value{GDBN} commands to specify | |
0869d01b | 14622 | new files are useful. |
c906108c SS |
14623 | |
14624 | @table @code | |
14625 | @cindex executable file | |
14626 | @kindex file | |
14627 | @item file @var{filename} | |
14628 | Use @var{filename} as the program to be debugged. It is read for its | |
14629 | symbols and for the contents of pure memory. It is also the program | |
14630 | executed when you use the @code{run} command. If you do not specify a | |
5d161b24 DB |
14631 | directory and the file is not found in the @value{GDBN} working directory, |
14632 | @value{GDBN} uses the environment variable @code{PATH} as a list of | |
14633 | directories to search, just as the shell does when looking for a program | |
14634 | to run. You can change the value of this variable, for both @value{GDBN} | |
c906108c SS |
14635 | and your program, using the @code{path} command. |
14636 | ||
fc8be69e EZ |
14637 | @cindex unlinked object files |
14638 | @cindex patching object files | |
14639 | You can load unlinked object @file{.o} files into @value{GDBN} using | |
14640 | the @code{file} command. You will not be able to ``run'' an object | |
14641 | file, but you can disassemble functions and inspect variables. Also, | |
14642 | if the underlying BFD functionality supports it, you could use | |
14643 | @kbd{gdb -write} to patch object files using this technique. Note | |
14644 | that @value{GDBN} can neither interpret nor modify relocations in this | |
14645 | case, so branches and some initialized variables will appear to go to | |
14646 | the wrong place. But this feature is still handy from time to time. | |
14647 | ||
c906108c SS |
14648 | @item file |
14649 | @code{file} with no argument makes @value{GDBN} discard any information it | |
14650 | has on both executable file and the symbol table. | |
14651 | ||
14652 | @kindex exec-file | |
14653 | @item exec-file @r{[} @var{filename} @r{]} | |
14654 | Specify that the program to be run (but not the symbol table) is found | |
14655 | in @var{filename}. @value{GDBN} searches the environment variable @code{PATH} | |
14656 | if necessary to locate your program. Omitting @var{filename} means to | |
14657 | discard information on the executable file. | |
14658 | ||
14659 | @kindex symbol-file | |
14660 | @item symbol-file @r{[} @var{filename} @r{]} | |
14661 | Read symbol table information from file @var{filename}. @code{PATH} is | |
14662 | searched when necessary. Use the @code{file} command to get both symbol | |
14663 | table and program to run from the same file. | |
14664 | ||
14665 | @code{symbol-file} with no argument clears out @value{GDBN} information on your | |
14666 | program's symbol table. | |
14667 | ||
ae5a43e0 DJ |
14668 | The @code{symbol-file} command causes @value{GDBN} to forget the contents of |
14669 | some breakpoints and auto-display expressions. This is because they may | |
14670 | contain pointers to the internal data recording symbols and data types, | |
14671 | which are part of the old symbol table data being discarded inside | |
14672 | @value{GDBN}. | |
c906108c SS |
14673 | |
14674 | @code{symbol-file} does not repeat if you press @key{RET} again after | |
14675 | executing it once. | |
14676 | ||
14677 | When @value{GDBN} is configured for a particular environment, it | |
14678 | understands debugging information in whatever format is the standard | |
14679 | generated for that environment; you may use either a @sc{gnu} compiler, or | |
14680 | other compilers that adhere to the local conventions. | |
c906108c | 14681 | Best results are usually obtained from @sc{gnu} compilers; for example, |
e22ea452 | 14682 | using @code{@value{NGCC}} you can generate debugging information for |
c906108c | 14683 | optimized code. |
c906108c SS |
14684 | |
14685 | For most kinds of object files, with the exception of old SVR3 systems | |
14686 | using COFF, the @code{symbol-file} command does not normally read the | |
14687 | symbol table in full right away. Instead, it scans the symbol table | |
14688 | quickly to find which source files and which symbols are present. The | |
14689 | details are read later, one source file at a time, as they are needed. | |
14690 | ||
14691 | The purpose of this two-stage reading strategy is to make @value{GDBN} | |
14692 | start up faster. For the most part, it is invisible except for | |
14693 | occasional pauses while the symbol table details for a particular source | |
14694 | file are being read. (The @code{set verbose} command can turn these | |
14695 | pauses into messages if desired. @xref{Messages/Warnings, ,Optional | |
79a6e687 | 14696 | Warnings and Messages}.) |
c906108c | 14697 | |
c906108c SS |
14698 | We have not implemented the two-stage strategy for COFF yet. When the |
14699 | symbol table is stored in COFF format, @code{symbol-file} reads the | |
14700 | symbol table data in full right away. Note that ``stabs-in-COFF'' | |
14701 | still does the two-stage strategy, since the debug info is actually | |
14702 | in stabs format. | |
14703 | ||
14704 | @kindex readnow | |
14705 | @cindex reading symbols immediately | |
14706 | @cindex symbols, reading immediately | |
6ac33a4e TT |
14707 | @item symbol-file @r{[} -readnow @r{]} @var{filename} |
14708 | @itemx file @r{[} -readnow @r{]} @var{filename} | |
c906108c SS |
14709 | You can override the @value{GDBN} two-stage strategy for reading symbol |
14710 | tables by using the @samp{-readnow} option with any of the commands that | |
14711 | load symbol table information, if you want to be sure @value{GDBN} has the | |
5d161b24 | 14712 | entire symbol table available. |
c906108c | 14713 | |
c906108c SS |
14714 | @c FIXME: for now no mention of directories, since this seems to be in |
14715 | @c flux. 13mar1992 status is that in theory GDB would look either in | |
14716 | @c current dir or in same dir as myprog; but issues like competing | |
14717 | @c GDB's, or clutter in system dirs, mean that in practice right now | |
14718 | @c only current dir is used. FFish says maybe a special GDB hierarchy | |
14719 | @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol | |
14720 | @c files. | |
14721 | ||
c906108c | 14722 | @kindex core-file |
09d4efe1 | 14723 | @item core-file @r{[}@var{filename}@r{]} |
4644b6e3 | 14724 | @itemx core |
c906108c SS |
14725 | Specify the whereabouts of a core dump file to be used as the ``contents |
14726 | of memory''. Traditionally, core files contain only some parts of the | |
14727 | address space of the process that generated them; @value{GDBN} can access the | |
14728 | executable file itself for other parts. | |
14729 | ||
14730 | @code{core-file} with no argument specifies that no core file is | |
14731 | to be used. | |
14732 | ||
14733 | Note that the core file is ignored when your program is actually running | |
7a292a7a SS |
14734 | under @value{GDBN}. So, if you have been running your program and you |
14735 | wish to debug a core file instead, you must kill the subprocess in which | |
14736 | the program is running. To do this, use the @code{kill} command | |
79a6e687 | 14737 | (@pxref{Kill Process, ,Killing the Child Process}). |
c906108c | 14738 | |
c906108c SS |
14739 | @kindex add-symbol-file |
14740 | @cindex dynamic linking | |
14741 | @item add-symbol-file @var{filename} @var{address} | |
a94ab193 | 14742 | @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]} |
17d9d558 | 14743 | @itemx add-symbol-file @var{filename} @r{-s}@var{section} @var{address} @dots{} |
96a2c332 SS |
14744 | The @code{add-symbol-file} command reads additional symbol table |
14745 | information from the file @var{filename}. You would use this command | |
14746 | when @var{filename} has been dynamically loaded (by some other means) | |
14747 | into the program that is running. @var{address} should be the memory | |
14748 | address at which the file has been loaded; @value{GDBN} cannot figure | |
d167840f EZ |
14749 | this out for itself. You can additionally specify an arbitrary number |
14750 | of @samp{@r{-s}@var{section} @var{address}} pairs, to give an explicit | |
14751 | section name and base address for that section. You can specify any | |
14752 | @var{address} as an expression. | |
c906108c SS |
14753 | |
14754 | The symbol table of the file @var{filename} is added to the symbol table | |
14755 | originally read with the @code{symbol-file} command. You can use the | |
96a2c332 SS |
14756 | @code{add-symbol-file} command any number of times; the new symbol data |
14757 | thus read keeps adding to the old. To discard all old symbol data | |
14758 | instead, use the @code{symbol-file} command without any arguments. | |
c906108c | 14759 | |
17d9d558 JB |
14760 | @cindex relocatable object files, reading symbols from |
14761 | @cindex object files, relocatable, reading symbols from | |
14762 | @cindex reading symbols from relocatable object files | |
14763 | @cindex symbols, reading from relocatable object files | |
14764 | @cindex @file{.o} files, reading symbols from | |
14765 | Although @var{filename} is typically a shared library file, an | |
14766 | executable file, or some other object file which has been fully | |
14767 | relocated for loading into a process, you can also load symbolic | |
14768 | information from relocatable @file{.o} files, as long as: | |
14769 | ||
14770 | @itemize @bullet | |
14771 | @item | |
14772 | the file's symbolic information refers only to linker symbols defined in | |
14773 | that file, not to symbols defined by other object files, | |
14774 | @item | |
14775 | every section the file's symbolic information refers to has actually | |
14776 | been loaded into the inferior, as it appears in the file, and | |
14777 | @item | |
14778 | you can determine the address at which every section was loaded, and | |
14779 | provide these to the @code{add-symbol-file} command. | |
14780 | @end itemize | |
14781 | ||
14782 | @noindent | |
14783 | Some embedded operating systems, like Sun Chorus and VxWorks, can load | |
14784 | relocatable files into an already running program; such systems | |
14785 | typically make the requirements above easy to meet. However, it's | |
14786 | important to recognize that many native systems use complex link | |
49efadf5 | 14787 | procedures (@code{.linkonce} section factoring and C@t{++} constructor table |
17d9d558 JB |
14788 | assembly, for example) that make the requirements difficult to meet. In |
14789 | general, one cannot assume that using @code{add-symbol-file} to read a | |
14790 | relocatable object file's symbolic information will have the same effect | |
14791 | as linking the relocatable object file into the program in the normal | |
14792 | way. | |
14793 | ||
c906108c SS |
14794 | @code{add-symbol-file} does not repeat if you press @key{RET} after using it. |
14795 | ||
c45da7e6 EZ |
14796 | @kindex add-symbol-file-from-memory |
14797 | @cindex @code{syscall DSO} | |
14798 | @cindex load symbols from memory | |
14799 | @item add-symbol-file-from-memory @var{address} | |
14800 | Load symbols from the given @var{address} in a dynamically loaded | |
14801 | object file whose image is mapped directly into the inferior's memory. | |
14802 | For example, the Linux kernel maps a @code{syscall DSO} into each | |
14803 | process's address space; this DSO provides kernel-specific code for | |
14804 | some system calls. The argument can be any expression whose | |
14805 | evaluation yields the address of the file's shared object file header. | |
14806 | For this command to work, you must have used @code{symbol-file} or | |
14807 | @code{exec-file} commands in advance. | |
14808 | ||
09d4efe1 EZ |
14809 | @kindex add-shared-symbol-files |
14810 | @kindex assf | |
14811 | @item add-shared-symbol-files @var{library-file} | |
14812 | @itemx assf @var{library-file} | |
14813 | The @code{add-shared-symbol-files} command can currently be used only | |
14814 | in the Cygwin build of @value{GDBN} on MS-Windows OS, where it is an | |
14815 | alias for the @code{dll-symbols} command (@pxref{Cygwin Native}). | |
14816 | @value{GDBN} automatically looks for shared libraries, however if | |
14817 | @value{GDBN} does not find yours, you can invoke | |
14818 | @code{add-shared-symbol-files}. It takes one argument: the shared | |
14819 | library's file name. @code{assf} is a shorthand alias for | |
14820 | @code{add-shared-symbol-files}. | |
c906108c | 14821 | |
c906108c | 14822 | @kindex section |
09d4efe1 EZ |
14823 | @item section @var{section} @var{addr} |
14824 | The @code{section} command changes the base address of the named | |
14825 | @var{section} of the exec file to @var{addr}. This can be used if the | |
14826 | exec file does not contain section addresses, (such as in the | |
14827 | @code{a.out} format), or when the addresses specified in the file | |
14828 | itself are wrong. Each section must be changed separately. The | |
14829 | @code{info files} command, described below, lists all the sections and | |
14830 | their addresses. | |
c906108c SS |
14831 | |
14832 | @kindex info files | |
14833 | @kindex info target | |
14834 | @item info files | |
14835 | @itemx info target | |
7a292a7a SS |
14836 | @code{info files} and @code{info target} are synonymous; both print the |
14837 | current target (@pxref{Targets, ,Specifying a Debugging Target}), | |
14838 | including the names of the executable and core dump files currently in | |
14839 | use by @value{GDBN}, and the files from which symbols were loaded. The | |
14840 | command @code{help target} lists all possible targets rather than | |
14841 | current ones. | |
14842 | ||
fe95c787 MS |
14843 | @kindex maint info sections |
14844 | @item maint info sections | |
14845 | Another command that can give you extra information about program sections | |
14846 | is @code{maint info sections}. In addition to the section information | |
14847 | displayed by @code{info files}, this command displays the flags and file | |
14848 | offset of each section in the executable and core dump files. In addition, | |
14849 | @code{maint info sections} provides the following command options (which | |
14850 | may be arbitrarily combined): | |
14851 | ||
14852 | @table @code | |
14853 | @item ALLOBJ | |
14854 | Display sections for all loaded object files, including shared libraries. | |
14855 | @item @var{sections} | |
6600abed | 14856 | Display info only for named @var{sections}. |
fe95c787 MS |
14857 | @item @var{section-flags} |
14858 | Display info only for sections for which @var{section-flags} are true. | |
14859 | The section flags that @value{GDBN} currently knows about are: | |
14860 | @table @code | |
14861 | @item ALLOC | |
14862 | Section will have space allocated in the process when loaded. | |
14863 | Set for all sections except those containing debug information. | |
14864 | @item LOAD | |
14865 | Section will be loaded from the file into the child process memory. | |
14866 | Set for pre-initialized code and data, clear for @code{.bss} sections. | |
14867 | @item RELOC | |
14868 | Section needs to be relocated before loading. | |
14869 | @item READONLY | |
14870 | Section cannot be modified by the child process. | |
14871 | @item CODE | |
14872 | Section contains executable code only. | |
6600abed | 14873 | @item DATA |
fe95c787 MS |
14874 | Section contains data only (no executable code). |
14875 | @item ROM | |
14876 | Section will reside in ROM. | |
14877 | @item CONSTRUCTOR | |
14878 | Section contains data for constructor/destructor lists. | |
14879 | @item HAS_CONTENTS | |
14880 | Section is not empty. | |
14881 | @item NEVER_LOAD | |
14882 | An instruction to the linker to not output the section. | |
14883 | @item COFF_SHARED_LIBRARY | |
14884 | A notification to the linker that the section contains | |
14885 | COFF shared library information. | |
14886 | @item IS_COMMON | |
14887 | Section contains common symbols. | |
14888 | @end table | |
14889 | @end table | |
6763aef9 | 14890 | @kindex set trust-readonly-sections |
9c16f35a | 14891 | @cindex read-only sections |
6763aef9 MS |
14892 | @item set trust-readonly-sections on |
14893 | Tell @value{GDBN} that readonly sections in your object file | |
6ca652b0 | 14894 | really are read-only (i.e.@: that their contents will not change). |
6763aef9 MS |
14895 | In that case, @value{GDBN} can fetch values from these sections |
14896 | out of the object file, rather than from the target program. | |
14897 | For some targets (notably embedded ones), this can be a significant | |
14898 | enhancement to debugging performance. | |
14899 | ||
14900 | The default is off. | |
14901 | ||
14902 | @item set trust-readonly-sections off | |
15110bc3 | 14903 | Tell @value{GDBN} not to trust readonly sections. This means that |
6763aef9 MS |
14904 | the contents of the section might change while the program is running, |
14905 | and must therefore be fetched from the target when needed. | |
9c16f35a EZ |
14906 | |
14907 | @item show trust-readonly-sections | |
14908 | Show the current setting of trusting readonly sections. | |
c906108c SS |
14909 | @end table |
14910 | ||
14911 | All file-specifying commands allow both absolute and relative file names | |
14912 | as arguments. @value{GDBN} always converts the file name to an absolute file | |
14913 | name and remembers it that way. | |
14914 | ||
c906108c | 14915 | @cindex shared libraries |
9cceb671 DJ |
14916 | @anchor{Shared Libraries} |
14917 | @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, HP-UX, SunOS, SVr4, Irix, | |
9c16f35a | 14918 | and IBM RS/6000 AIX shared libraries. |
53a5351d | 14919 | |
9cceb671 DJ |
14920 | On MS-Windows @value{GDBN} must be linked with the Expat library to support |
14921 | shared libraries. @xref{Expat}. | |
14922 | ||
c906108c SS |
14923 | @value{GDBN} automatically loads symbol definitions from shared libraries |
14924 | when you use the @code{run} command, or when you examine a core file. | |
14925 | (Before you issue the @code{run} command, @value{GDBN} does not understand | |
14926 | references to a function in a shared library, however---unless you are | |
14927 | debugging a core file). | |
53a5351d JM |
14928 | |
14929 | On HP-UX, if the program loads a library explicitly, @value{GDBN} | |
14930 | automatically loads the symbols at the time of the @code{shl_load} call. | |
14931 | ||
c906108c SS |
14932 | @c FIXME: some @value{GDBN} release may permit some refs to undef |
14933 | @c FIXME...symbols---eg in a break cmd---assuming they are from a shared | |
14934 | @c FIXME...lib; check this from time to time when updating manual | |
14935 | ||
b7209cb4 FF |
14936 | There are times, however, when you may wish to not automatically load |
14937 | symbol definitions from shared libraries, such as when they are | |
14938 | particularly large or there are many of them. | |
14939 | ||
14940 | To control the automatic loading of shared library symbols, use the | |
14941 | commands: | |
14942 | ||
14943 | @table @code | |
14944 | @kindex set auto-solib-add | |
14945 | @item set auto-solib-add @var{mode} | |
14946 | If @var{mode} is @code{on}, symbols from all shared object libraries | |
14947 | will be loaded automatically when the inferior begins execution, you | |
14948 | attach to an independently started inferior, or when the dynamic linker | |
14949 | informs @value{GDBN} that a new library has been loaded. If @var{mode} | |
14950 | is @code{off}, symbols must be loaded manually, using the | |
14951 | @code{sharedlibrary} command. The default value is @code{on}. | |
14952 | ||
dcaf7c2c EZ |
14953 | @cindex memory used for symbol tables |
14954 | If your program uses lots of shared libraries with debug info that | |
14955 | takes large amounts of memory, you can decrease the @value{GDBN} | |
14956 | memory footprint by preventing it from automatically loading the | |
14957 | symbols from shared libraries. To that end, type @kbd{set | |
14958 | auto-solib-add off} before running the inferior, then load each | |
14959 | library whose debug symbols you do need with @kbd{sharedlibrary | |
d3e8051b | 14960 | @var{regexp}}, where @var{regexp} is a regular expression that matches |
dcaf7c2c EZ |
14961 | the libraries whose symbols you want to be loaded. |
14962 | ||
b7209cb4 FF |
14963 | @kindex show auto-solib-add |
14964 | @item show auto-solib-add | |
14965 | Display the current autoloading mode. | |
14966 | @end table | |
14967 | ||
c45da7e6 | 14968 | @cindex load shared library |
b7209cb4 FF |
14969 | To explicitly load shared library symbols, use the @code{sharedlibrary} |
14970 | command: | |
14971 | ||
c906108c SS |
14972 | @table @code |
14973 | @kindex info sharedlibrary | |
14974 | @kindex info share | |
55333a84 DE |
14975 | @item info share @var{regex} |
14976 | @itemx info sharedlibrary @var{regex} | |
14977 | Print the names of the shared libraries which are currently loaded | |
14978 | that match @var{regex}. If @var{regex} is omitted then print | |
14979 | all shared libraries that are loaded. | |
c906108c SS |
14980 | |
14981 | @kindex sharedlibrary | |
14982 | @kindex share | |
14983 | @item sharedlibrary @var{regex} | |
14984 | @itemx share @var{regex} | |
c906108c SS |
14985 | Load shared object library symbols for files matching a |
14986 | Unix regular expression. | |
14987 | As with files loaded automatically, it only loads shared libraries | |
14988 | required by your program for a core file or after typing @code{run}. If | |
14989 | @var{regex} is omitted all shared libraries required by your program are | |
14990 | loaded. | |
c45da7e6 EZ |
14991 | |
14992 | @item nosharedlibrary | |
14993 | @kindex nosharedlibrary | |
14994 | @cindex unload symbols from shared libraries | |
14995 | Unload all shared object library symbols. This discards all symbols | |
14996 | that have been loaded from all shared libraries. Symbols from shared | |
14997 | libraries that were loaded by explicit user requests are not | |
14998 | discarded. | |
c906108c SS |
14999 | @end table |
15000 | ||
721c2651 EZ |
15001 | Sometimes you may wish that @value{GDBN} stops and gives you control |
15002 | when any of shared library events happen. Use the @code{set | |
15003 | stop-on-solib-events} command for this: | |
15004 | ||
15005 | @table @code | |
15006 | @item set stop-on-solib-events | |
15007 | @kindex set stop-on-solib-events | |
15008 | This command controls whether @value{GDBN} should give you control | |
15009 | when the dynamic linker notifies it about some shared library event. | |
15010 | The most common event of interest is loading or unloading of a new | |
15011 | shared library. | |
15012 | ||
15013 | @item show stop-on-solib-events | |
15014 | @kindex show stop-on-solib-events | |
15015 | Show whether @value{GDBN} stops and gives you control when shared | |
15016 | library events happen. | |
15017 | @end table | |
15018 | ||
f5ebfba0 | 15019 | Shared libraries are also supported in many cross or remote debugging |
f1838a98 UW |
15020 | configurations. @value{GDBN} needs to have access to the target's libraries; |
15021 | this can be accomplished either by providing copies of the libraries | |
15022 | on the host system, or by asking @value{GDBN} to automatically retrieve the | |
15023 | libraries from the target. If copies of the target libraries are | |
15024 | provided, they need to be the same as the target libraries, although the | |
f5ebfba0 DJ |
15025 | copies on the target can be stripped as long as the copies on the host are |
15026 | not. | |
15027 | ||
59b7b46f EZ |
15028 | @cindex where to look for shared libraries |
15029 | For remote debugging, you need to tell @value{GDBN} where the target | |
15030 | libraries are, so that it can load the correct copies---otherwise, it | |
15031 | may try to load the host's libraries. @value{GDBN} has two variables | |
15032 | to specify the search directories for target libraries. | |
f5ebfba0 DJ |
15033 | |
15034 | @table @code | |
59b7b46f | 15035 | @cindex prefix for shared library file names |
f822c95b | 15036 | @cindex system root, alternate |
f5ebfba0 | 15037 | @kindex set solib-absolute-prefix |
f822c95b DJ |
15038 | @kindex set sysroot |
15039 | @item set sysroot @var{path} | |
15040 | Use @var{path} as the system root for the program being debugged. Any | |
15041 | absolute shared library paths will be prefixed with @var{path}; many | |
15042 | runtime loaders store the absolute paths to the shared library in the | |
15043 | target program's memory. If you use @code{set sysroot} to find shared | |
15044 | libraries, they need to be laid out in the same way that they are on | |
15045 | the target, with e.g.@: a @file{/lib} and @file{/usr/lib} hierarchy | |
15046 | under @var{path}. | |
15047 | ||
f1838a98 UW |
15048 | If @var{path} starts with the sequence @file{remote:}, @value{GDBN} will |
15049 | retrieve the target libraries from the remote system. This is only | |
15050 | supported when using a remote target that supports the @code{remote get} | |
15051 | command (@pxref{File Transfer,,Sending files to a remote system}). | |
15052 | The part of @var{path} following the initial @file{remote:} | |
15053 | (if present) is used as system root prefix on the remote file system. | |
15054 | @footnote{If you want to specify a local system root using a directory | |
15055 | that happens to be named @file{remote:}, you need to use some equivalent | |
15056 | variant of the name like @file{./remote:}.} | |
15057 | ||
ab38a727 PA |
15058 | For targets with an MS-DOS based filesystem, such as MS-Windows and |
15059 | SymbianOS, @value{GDBN} tries prefixing a few variants of the target | |
15060 | absolute file name with @var{path}. But first, on Unix hosts, | |
15061 | @value{GDBN} converts all backslash directory separators into forward | |
15062 | slashes, because the backslash is not a directory separator on Unix: | |
15063 | ||
15064 | @smallexample | |
15065 | c:\foo\bar.dll @result{} c:/foo/bar.dll | |
15066 | @end smallexample | |
15067 | ||
15068 | Then, @value{GDBN} attempts prefixing the target file name with | |
15069 | @var{path}, and looks for the resulting file name in the host file | |
15070 | system: | |
15071 | ||
15072 | @smallexample | |
15073 | c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll | |
15074 | @end smallexample | |
15075 | ||
15076 | If that does not find the shared library, @value{GDBN} tries removing | |
15077 | the @samp{:} character from the drive spec, both for convenience, and, | |
15078 | for the case of the host file system not supporting file names with | |
15079 | colons: | |
15080 | ||
15081 | @smallexample | |
15082 | c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll | |
15083 | @end smallexample | |
15084 | ||
15085 | This makes it possible to have a system root that mirrors a target | |
15086 | with more than one drive. E.g., you may want to setup your local | |
15087 | copies of the target system shared libraries like so (note @samp{c} vs | |
15088 | @samp{z}): | |
15089 | ||
15090 | @smallexample | |
15091 | @file{/path/to/sysroot/c/sys/bin/foo.dll} | |
15092 | @file{/path/to/sysroot/c/sys/bin/bar.dll} | |
15093 | @file{/path/to/sysroot/z/sys/bin/bar.dll} | |
15094 | @end smallexample | |
15095 | ||
15096 | @noindent | |
15097 | and point the system root at @file{/path/to/sysroot}, so that | |
15098 | @value{GDBN} can find the correct copies of both | |
15099 | @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}. | |
15100 | ||
15101 | If that still does not find the shared library, @value{GDBN} tries | |
15102 | removing the whole drive spec from the target file name: | |
15103 | ||
15104 | @smallexample | |
15105 | c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll | |
15106 | @end smallexample | |
15107 | ||
15108 | This last lookup makes it possible to not care about the drive name, | |
15109 | if you don't want or need to. | |
15110 | ||
f822c95b DJ |
15111 | The @code{set solib-absolute-prefix} command is an alias for @code{set |
15112 | sysroot}. | |
15113 | ||
15114 | @cindex default system root | |
59b7b46f | 15115 | @cindex @samp{--with-sysroot} |
f822c95b DJ |
15116 | You can set the default system root by using the configure-time |
15117 | @samp{--with-sysroot} option. If the system root is inside | |
15118 | @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or | |
15119 | @samp{--exec-prefix}), then the default system root will be updated | |
15120 | automatically if the installed @value{GDBN} is moved to a new | |
15121 | location. | |
15122 | ||
15123 | @kindex show sysroot | |
15124 | @item show sysroot | |
f5ebfba0 DJ |
15125 | Display the current shared library prefix. |
15126 | ||
15127 | @kindex set solib-search-path | |
15128 | @item set solib-search-path @var{path} | |
f822c95b DJ |
15129 | If this variable is set, @var{path} is a colon-separated list of |
15130 | directories to search for shared libraries. @samp{solib-search-path} | |
15131 | is used after @samp{sysroot} fails to locate the library, or if the | |
15132 | path to the library is relative instead of absolute. If you want to | |
15133 | use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set | |
d3e8051b | 15134 | @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from |
f822c95b | 15135 | finding your host's libraries. @samp{sysroot} is preferred; setting |
d3e8051b | 15136 | it to a nonexistent directory may interfere with automatic loading |
f822c95b | 15137 | of shared library symbols. |
f5ebfba0 DJ |
15138 | |
15139 | @kindex show solib-search-path | |
15140 | @item show solib-search-path | |
15141 | Display the current shared library search path. | |
ab38a727 PA |
15142 | |
15143 | @cindex DOS file-name semantics of file names. | |
15144 | @kindex set target-file-system-kind (unix|dos-based|auto) | |
15145 | @kindex show target-file-system-kind | |
15146 | @item set target-file-system-kind @var{kind} | |
15147 | Set assumed file system kind for target reported file names. | |
15148 | ||
15149 | Shared library file names as reported by the target system may not | |
15150 | make sense as is on the system @value{GDBN} is running on. For | |
15151 | example, when remote debugging a target that has MS-DOS based file | |
15152 | system semantics, from a Unix host, the target may be reporting to | |
15153 | @value{GDBN} a list of loaded shared libraries with file names such as | |
15154 | @file{c:\Windows\kernel32.dll}. On Unix hosts, there's no concept of | |
15155 | drive letters, so the @samp{c:\} prefix is not normally understood as | |
15156 | indicating an absolute file name, and neither is the backslash | |
15157 | normally considered a directory separator character. In that case, | |
15158 | the native file system would interpret this whole absolute file name | |
15159 | as a relative file name with no directory components. This would make | |
15160 | it impossible to point @value{GDBN} at a copy of the remote target's | |
15161 | shared libraries on the host using @code{set sysroot}, and impractical | |
15162 | with @code{set solib-search-path}. Setting | |
15163 | @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN} | |
15164 | to interpret such file names similarly to how the target would, and to | |
15165 | map them to file names valid on @value{GDBN}'s native file system | |
15166 | semantics. The value of @var{kind} can be @code{"auto"}, in addition | |
15167 | to one of the supported file system kinds. In that case, @value{GDBN} | |
15168 | tries to determine the appropriate file system variant based on the | |
15169 | current target's operating system (@pxref{ABI, ,Configuring the | |
15170 | Current ABI}). The supported file system settings are: | |
15171 | ||
15172 | @table @code | |
15173 | @item unix | |
15174 | Instruct @value{GDBN} to assume the target file system is of Unix | |
15175 | kind. Only file names starting the forward slash (@samp{/}) character | |
15176 | are considered absolute, and the directory separator character is also | |
15177 | the forward slash. | |
15178 | ||
15179 | @item dos-based | |
15180 | Instruct @value{GDBN} to assume the target file system is DOS based. | |
15181 | File names starting with either a forward slash, or a drive letter | |
15182 | followed by a colon (e.g., @samp{c:}), are considered absolute, and | |
15183 | both the slash (@samp{/}) and the backslash (@samp{\\}) characters are | |
15184 | considered directory separators. | |
15185 | ||
15186 | @item auto | |
15187 | Instruct @value{GDBN} to use the file system kind associated with the | |
15188 | target operating system (@pxref{ABI, ,Configuring the Current ABI}). | |
15189 | This is the default. | |
15190 | @end table | |
f5ebfba0 DJ |
15191 | @end table |
15192 | ||
5b5d99cf JB |
15193 | |
15194 | @node Separate Debug Files | |
15195 | @section Debugging Information in Separate Files | |
15196 | @cindex separate debugging information files | |
15197 | @cindex debugging information in separate files | |
15198 | @cindex @file{.debug} subdirectories | |
15199 | @cindex debugging information directory, global | |
15200 | @cindex global debugging information directory | |
c7e83d54 EZ |
15201 | @cindex build ID, and separate debugging files |
15202 | @cindex @file{.build-id} directory | |
5b5d99cf JB |
15203 | |
15204 | @value{GDBN} allows you to put a program's debugging information in a | |
15205 | file separate from the executable itself, in a way that allows | |
15206 | @value{GDBN} to find and load the debugging information automatically. | |
c7e83d54 EZ |
15207 | Since debugging information can be very large---sometimes larger |
15208 | than the executable code itself---some systems distribute debugging | |
5b5d99cf JB |
15209 | information for their executables in separate files, which users can |
15210 | install only when they need to debug a problem. | |
15211 | ||
c7e83d54 EZ |
15212 | @value{GDBN} supports two ways of specifying the separate debug info |
15213 | file: | |
5b5d99cf JB |
15214 | |
15215 | @itemize @bullet | |
15216 | @item | |
c7e83d54 EZ |
15217 | The executable contains a @dfn{debug link} that specifies the name of |
15218 | the separate debug info file. The separate debug file's name is | |
15219 | usually @file{@var{executable}.debug}, where @var{executable} is the | |
15220 | name of the corresponding executable file without leading directories | |
15221 | (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the | |
99e008fe EZ |
15222 | debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC) |
15223 | checksum for the debug file, which @value{GDBN} uses to validate that | |
15224 | the executable and the debug file came from the same build. | |
c7e83d54 EZ |
15225 | |
15226 | @item | |
7e27a47a | 15227 | The executable contains a @dfn{build ID}, a unique bit string that is |
c7e83d54 | 15228 | also present in the corresponding debug info file. (This is supported |
7e27a47a EZ |
15229 | only on some operating systems, notably those which use the ELF format |
15230 | for binary files and the @sc{gnu} Binutils.) For more details about | |
15231 | this feature, see the description of the @option{--build-id} | |
15232 | command-line option in @ref{Options, , Command Line Options, ld.info, | |
15233 | The GNU Linker}. The debug info file's name is not specified | |
15234 | explicitly by the build ID, but can be computed from the build ID, see | |
15235 | below. | |
d3750b24 JK |
15236 | @end itemize |
15237 | ||
c7e83d54 EZ |
15238 | Depending on the way the debug info file is specified, @value{GDBN} |
15239 | uses two different methods of looking for the debug file: | |
d3750b24 JK |
15240 | |
15241 | @itemize @bullet | |
15242 | @item | |
c7e83d54 EZ |
15243 | For the ``debug link'' method, @value{GDBN} looks up the named file in |
15244 | the directory of the executable file, then in a subdirectory of that | |
15245 | directory named @file{.debug}, and finally under the global debug | |
15246 | directory, in a subdirectory whose name is identical to the leading | |
15247 | directories of the executable's absolute file name. | |
15248 | ||
15249 | @item | |
83f83d7f | 15250 | For the ``build ID'' method, @value{GDBN} looks in the |
c7e83d54 EZ |
15251 | @file{.build-id} subdirectory of the global debug directory for a file |
15252 | named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the | |
7e27a47a EZ |
15253 | first 2 hex characters of the build ID bit string, and @var{nnnnnnnn} |
15254 | are the rest of the bit string. (Real build ID strings are 32 or more | |
15255 | hex characters, not 10.) | |
c7e83d54 EZ |
15256 | @end itemize |
15257 | ||
15258 | So, for example, suppose you ask @value{GDBN} to debug | |
7e27a47a EZ |
15259 | @file{/usr/bin/ls}, which has a debug link that specifies the |
15260 | file @file{ls.debug}, and a build ID whose value in hex is | |
c7e83d54 EZ |
15261 | @code{abcdef1234}. If the global debug directory is |
15262 | @file{/usr/lib/debug}, then @value{GDBN} will look for the following | |
15263 | debug information files, in the indicated order: | |
15264 | ||
15265 | @itemize @minus | |
15266 | @item | |
15267 | @file{/usr/lib/debug/.build-id/ab/cdef1234.debug} | |
d3750b24 | 15268 | @item |
c7e83d54 | 15269 | @file{/usr/bin/ls.debug} |
5b5d99cf | 15270 | @item |
c7e83d54 | 15271 | @file{/usr/bin/.debug/ls.debug} |
5b5d99cf | 15272 | @item |
c7e83d54 | 15273 | @file{/usr/lib/debug/usr/bin/ls.debug}. |
5b5d99cf | 15274 | @end itemize |
5b5d99cf JB |
15275 | |
15276 | You can set the global debugging info directory's name, and view the | |
15277 | name @value{GDBN} is currently using. | |
15278 | ||
15279 | @table @code | |
15280 | ||
15281 | @kindex set debug-file-directory | |
24ddea62 JK |
15282 | @item set debug-file-directory @var{directories} |
15283 | Set the directories which @value{GDBN} searches for separate debugging | |
15284 | information files to @var{directory}. Multiple directory components can be set | |
15285 | concatenating them by a directory separator. | |
5b5d99cf JB |
15286 | |
15287 | @kindex show debug-file-directory | |
15288 | @item show debug-file-directory | |
24ddea62 | 15289 | Show the directories @value{GDBN} searches for separate debugging |
5b5d99cf JB |
15290 | information files. |
15291 | ||
15292 | @end table | |
15293 | ||
15294 | @cindex @code{.gnu_debuglink} sections | |
c7e83d54 | 15295 | @cindex debug link sections |
5b5d99cf JB |
15296 | A debug link is a special section of the executable file named |
15297 | @code{.gnu_debuglink}. The section must contain: | |
15298 | ||
15299 | @itemize | |
15300 | @item | |
15301 | A filename, with any leading directory components removed, followed by | |
15302 | a zero byte, | |
15303 | @item | |
15304 | zero to three bytes of padding, as needed to reach the next four-byte | |
15305 | boundary within the section, and | |
15306 | @item | |
15307 | a four-byte CRC checksum, stored in the same endianness used for the | |
15308 | executable file itself. The checksum is computed on the debugging | |
15309 | information file's full contents by the function given below, passing | |
15310 | zero as the @var{crc} argument. | |
15311 | @end itemize | |
15312 | ||
15313 | Any executable file format can carry a debug link, as long as it can | |
15314 | contain a section named @code{.gnu_debuglink} with the contents | |
15315 | described above. | |
15316 | ||
d3750b24 | 15317 | @cindex @code{.note.gnu.build-id} sections |
c7e83d54 | 15318 | @cindex build ID sections |
7e27a47a EZ |
15319 | The build ID is a special section in the executable file (and in other |
15320 | ELF binary files that @value{GDBN} may consider). This section is | |
15321 | often named @code{.note.gnu.build-id}, but that name is not mandatory. | |
15322 | It contains unique identification for the built files---the ID remains | |
15323 | the same across multiple builds of the same build tree. The default | |
15324 | algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the | |
15325 | content for the build ID string. The same section with an identical | |
15326 | value is present in the original built binary with symbols, in its | |
15327 | stripped variant, and in the separate debugging information file. | |
d3750b24 | 15328 | |
5b5d99cf JB |
15329 | The debugging information file itself should be an ordinary |
15330 | executable, containing a full set of linker symbols, sections, and | |
15331 | debugging information. The sections of the debugging information file | |
c7e83d54 EZ |
15332 | should have the same names, addresses, and sizes as the original file, |
15333 | but they need not contain any data---much like a @code{.bss} section | |
5b5d99cf JB |
15334 | in an ordinary executable. |
15335 | ||
7e27a47a | 15336 | The @sc{gnu} binary utilities (Binutils) package includes the |
c7e83d54 EZ |
15337 | @samp{objcopy} utility that can produce |
15338 | the separated executable / debugging information file pairs using the | |
15339 | following commands: | |
15340 | ||
15341 | @smallexample | |
15342 | @kbd{objcopy --only-keep-debug foo foo.debug} | |
15343 | @kbd{strip -g foo} | |
c7e83d54 EZ |
15344 | @end smallexample |
15345 | ||
15346 | @noindent | |
15347 | These commands remove the debugging | |
83f83d7f JK |
15348 | information from the executable file @file{foo} and place it in the file |
15349 | @file{foo.debug}. You can use the first, second or both methods to link the | |
15350 | two files: | |
15351 | ||
15352 | @itemize @bullet | |
15353 | @item | |
15354 | The debug link method needs the following additional command to also leave | |
15355 | behind a debug link in @file{foo}: | |
15356 | ||
15357 | @smallexample | |
15358 | @kbd{objcopy --add-gnu-debuglink=foo.debug foo} | |
15359 | @end smallexample | |
15360 | ||
15361 | Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains | |
d3750b24 | 15362 | a version of the @code{strip} command such that the command @kbd{strip foo -f |
83f83d7f JK |
15363 | foo.debug} has the same functionality as the two @code{objcopy} commands and |
15364 | the @code{ln -s} command above, together. | |
15365 | ||
15366 | @item | |
15367 | Build ID gets embedded into the main executable using @code{ld --build-id} or | |
15368 | the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus | |
15369 | compatibility fixes for debug files separation are present in @sc{gnu} binary | |
7e27a47a | 15370 | utilities (Binutils) package since version 2.18. |
83f83d7f JK |
15371 | @end itemize |
15372 | ||
15373 | @noindent | |
d3750b24 | 15374 | |
99e008fe EZ |
15375 | @cindex CRC algorithm definition |
15376 | The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in | |
15377 | IEEE 802.3 using the polynomial: | |
15378 | ||
15379 | @c TexInfo requires naked braces for multi-digit exponents for Tex | |
15380 | @c output, but this causes HTML output to barf. HTML has to be set using | |
15381 | @c raw commands. So we end up having to specify this equation in 2 | |
15382 | @c different ways! | |
15383 | @ifhtml | |
15384 | @display | |
15385 | @html | |
15386 | <em>x</em><sup>32</sup> + <em>x</em><sup>26</sup> + <em>x</em><sup>23</sup> + <em>x</em><sup>22</sup> + <em>x</em><sup>16</sup> + <em>x</em><sup>12</sup> + <em>x</em><sup>11</sup> | |
15387 | + <em>x</em><sup>10</sup> + <em>x</em><sup>8</sup> + <em>x</em><sup>7</sup> + <em>x</em><sup>5</sup> + <em>x</em><sup>4</sup> + <em>x</em><sup>2</sup> + <em>x</em> + 1 | |
15388 | @end html | |
15389 | @end display | |
15390 | @end ifhtml | |
15391 | @ifnothtml | |
15392 | @display | |
15393 | @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}} | |
15394 | @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1} | |
15395 | @end display | |
15396 | @end ifnothtml | |
15397 | ||
15398 | The function is computed byte at a time, taking the least | |
15399 | significant bit of each byte first. The initial pattern | |
15400 | @code{0xffffffff} is used, to ensure leading zeros affect the CRC and | |
15401 | the final result is inverted to ensure trailing zeros also affect the | |
15402 | CRC. | |
15403 | ||
15404 | @emph{Note:} This is the same CRC polynomial as used in handling the | |
15405 | @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{Remote Protocol, | |
15406 | , @value{GDBN} Remote Serial Protocol}). However in the | |
15407 | case of the Remote Serial Protocol, the CRC is computed @emph{most} | |
15408 | significant bit first, and the result is not inverted, so trailing | |
15409 | zeros have no effect on the CRC value. | |
15410 | ||
15411 | To complete the description, we show below the code of the function | |
15412 | which produces the CRC used in @code{.gnu_debuglink}. Inverting the | |
15413 | initially supplied @code{crc} argument means that an initial call to | |
15414 | this function passing in zero will start computing the CRC using | |
15415 | @code{0xffffffff}. | |
5b5d99cf | 15416 | |
4644b6e3 | 15417 | @kindex gnu_debuglink_crc32 |
5b5d99cf JB |
15418 | @smallexample |
15419 | unsigned long | |
15420 | gnu_debuglink_crc32 (unsigned long crc, | |
15421 | unsigned char *buf, size_t len) | |
15422 | @{ | |
15423 | static const unsigned long crc32_table[256] = | |
15424 | @{ | |
15425 | 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, | |
15426 | 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, | |
15427 | 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, | |
15428 | 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, | |
15429 | 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856, | |
15430 | 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, | |
15431 | 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, | |
15432 | 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, | |
15433 | 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, | |
15434 | 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, | |
15435 | 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, | |
15436 | 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, | |
15437 | 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, | |
15438 | 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, | |
15439 | 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, | |
15440 | 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, | |
15441 | 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, | |
15442 | 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, | |
15443 | 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, | |
15444 | 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, | |
15445 | 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, | |
15446 | 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, | |
15447 | 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010, | |
15448 | 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, | |
15449 | 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, | |
15450 | 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, | |
15451 | 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, | |
15452 | 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, | |
15453 | 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, | |
15454 | 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, | |
15455 | 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, | |
15456 | 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, | |
15457 | 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, | |
15458 | 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c, | |
15459 | 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, | |
15460 | 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, | |
15461 | 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, | |
15462 | 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, | |
15463 | 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c, | |
15464 | 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, | |
15465 | 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, | |
15466 | 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, | |
15467 | 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, | |
15468 | 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, | |
15469 | 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278, | |
15470 | 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, | |
15471 | 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, | |
15472 | 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, | |
15473 | 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, | |
15474 | 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, | |
15475 | 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, | |
15476 | 0x2d02ef8d | |
15477 | @}; | |
15478 | unsigned char *end; | |
15479 | ||
15480 | crc = ~crc & 0xffffffff; | |
15481 | for (end = buf + len; buf < end; ++buf) | |
15482 | crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8); | |
e7a3abfc | 15483 | return ~crc & 0xffffffff; |
5b5d99cf JB |
15484 | @} |
15485 | @end smallexample | |
15486 | ||
c7e83d54 EZ |
15487 | @noindent |
15488 | This computation does not apply to the ``build ID'' method. | |
15489 | ||
5b5d99cf | 15490 | |
9291a0cd TT |
15491 | @node Index Files |
15492 | @section Index Files Speed Up @value{GDBN} | |
15493 | @cindex index files | |
15494 | @cindex @samp{.gdb_index} section | |
15495 | ||
15496 | When @value{GDBN} finds a symbol file, it scans the symbols in the | |
15497 | file in order to construct an internal symbol table. This lets most | |
15498 | @value{GDBN} operations work quickly---at the cost of a delay early | |
15499 | on. For large programs, this delay can be quite lengthy, so | |
15500 | @value{GDBN} provides a way to build an index, which speeds up | |
15501 | startup. | |
15502 | ||
15503 | The index is stored as a section in the symbol file. @value{GDBN} can | |
15504 | write the index to a file, then you can put it into the symbol file | |
15505 | using @command{objcopy}. | |
15506 | ||
15507 | To create an index file, use the @code{save gdb-index} command: | |
15508 | ||
15509 | @table @code | |
15510 | @item save gdb-index @var{directory} | |
15511 | @kindex save gdb-index | |
15512 | Create an index file for each symbol file currently known by | |
15513 | @value{GDBN}. Each file is named after its corresponding symbol file, | |
15514 | with @samp{.gdb-index} appended, and is written into the given | |
15515 | @var{directory}. | |
15516 | @end table | |
15517 | ||
15518 | Once you have created an index file you can merge it into your symbol | |
15519 | file, here named @file{symfile}, using @command{objcopy}: | |
15520 | ||
15521 | @smallexample | |
15522 | $ objcopy --add-section .gdb_index=symfile.gdb-index \ | |
15523 | --set-section-flags .gdb_index=readonly symfile symfile | |
15524 | @end smallexample | |
15525 | ||
15526 | There are currently some limitation on indices. They only work when | |
15527 | for DWARF debugging information, not stabs. And, they do not | |
15528 | currently work for programs using Ada. | |
15529 | ||
6d2ebf8b | 15530 | @node Symbol Errors |
79a6e687 | 15531 | @section Errors Reading Symbol Files |
c906108c SS |
15532 | |
15533 | While reading a symbol file, @value{GDBN} occasionally encounters problems, | |
15534 | such as symbol types it does not recognize, or known bugs in compiler | |
15535 | output. By default, @value{GDBN} does not notify you of such problems, since | |
15536 | they are relatively common and primarily of interest to people | |
15537 | debugging compilers. If you are interested in seeing information | |
15538 | about ill-constructed symbol tables, you can either ask @value{GDBN} to print | |
15539 | only one message about each such type of problem, no matter how many | |
15540 | times the problem occurs; or you can ask @value{GDBN} to print more messages, | |
15541 | to see how many times the problems occur, with the @code{set | |
79a6e687 BW |
15542 | complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and |
15543 | Messages}). | |
c906108c SS |
15544 | |
15545 | The messages currently printed, and their meanings, include: | |
15546 | ||
15547 | @table @code | |
15548 | @item inner block not inside outer block in @var{symbol} | |
15549 | ||
15550 | The symbol information shows where symbol scopes begin and end | |
15551 | (such as at the start of a function or a block of statements). This | |
15552 | error indicates that an inner scope block is not fully contained | |
15553 | in its outer scope blocks. | |
15554 | ||
15555 | @value{GDBN} circumvents the problem by treating the inner block as if it had | |
15556 | the same scope as the outer block. In the error message, @var{symbol} | |
15557 | may be shown as ``@code{(don't know)}'' if the outer block is not a | |
15558 | function. | |
15559 | ||
15560 | @item block at @var{address} out of order | |
15561 | ||
15562 | The symbol information for symbol scope blocks should occur in | |
15563 | order of increasing addresses. This error indicates that it does not | |
15564 | do so. | |
15565 | ||
15566 | @value{GDBN} does not circumvent this problem, and has trouble | |
15567 | locating symbols in the source file whose symbols it is reading. (You | |
15568 | can often determine what source file is affected by specifying | |
79a6e687 BW |
15569 | @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and |
15570 | Messages}.) | |
c906108c SS |
15571 | |
15572 | @item bad block start address patched | |
15573 | ||
15574 | The symbol information for a symbol scope block has a start address | |
15575 | smaller than the address of the preceding source line. This is known | |
15576 | to occur in the SunOS 4.1.1 (and earlier) C compiler. | |
15577 | ||
15578 | @value{GDBN} circumvents the problem by treating the symbol scope block as | |
15579 | starting on the previous source line. | |
15580 | ||
15581 | @item bad string table offset in symbol @var{n} | |
15582 | ||
15583 | @cindex foo | |
15584 | Symbol number @var{n} contains a pointer into the string table which is | |
15585 | larger than the size of the string table. | |
15586 | ||
15587 | @value{GDBN} circumvents the problem by considering the symbol to have the | |
15588 | name @code{foo}, which may cause other problems if many symbols end up | |
15589 | with this name. | |
15590 | ||
15591 | @item unknown symbol type @code{0x@var{nn}} | |
15592 | ||
7a292a7a SS |
15593 | The symbol information contains new data types that @value{GDBN} does |
15594 | not yet know how to read. @code{0x@var{nn}} is the symbol type of the | |
d4f3574e | 15595 | uncomprehended information, in hexadecimal. |
c906108c | 15596 | |
7a292a7a SS |
15597 | @value{GDBN} circumvents the error by ignoring this symbol information. |
15598 | This usually allows you to debug your program, though certain symbols | |
c906108c | 15599 | are not accessible. If you encounter such a problem and feel like |
7a292a7a SS |
15600 | debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint |
15601 | on @code{complain}, then go up to the function @code{read_dbx_symtab} | |
15602 | and examine @code{*bufp} to see the symbol. | |
c906108c SS |
15603 | |
15604 | @item stub type has NULL name | |
c906108c | 15605 | |
7a292a7a | 15606 | @value{GDBN} could not find the full definition for a struct or class. |
c906108c | 15607 | |
7a292a7a | 15608 | @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{} |
b37052ae | 15609 | The symbol information for a C@t{++} member function is missing some |
7a292a7a SS |
15610 | information that recent versions of the compiler should have output for |
15611 | it. | |
c906108c SS |
15612 | |
15613 | @item info mismatch between compiler and debugger | |
15614 | ||
15615 | @value{GDBN} could not parse a type specification output by the compiler. | |
7a292a7a | 15616 | |
c906108c SS |
15617 | @end table |
15618 | ||
b14b1491 TT |
15619 | @node Data Files |
15620 | @section GDB Data Files | |
15621 | ||
15622 | @cindex prefix for data files | |
15623 | @value{GDBN} will sometimes read an auxiliary data file. These files | |
15624 | are kept in a directory known as the @dfn{data directory}. | |
15625 | ||
15626 | You can set the data directory's name, and view the name @value{GDBN} | |
15627 | is currently using. | |
15628 | ||
15629 | @table @code | |
15630 | @kindex set data-directory | |
15631 | @item set data-directory @var{directory} | |
15632 | Set the directory which @value{GDBN} searches for auxiliary data files | |
15633 | to @var{directory}. | |
15634 | ||
15635 | @kindex show data-directory | |
15636 | @item show data-directory | |
15637 | Show the directory @value{GDBN} searches for auxiliary data files. | |
15638 | @end table | |
15639 | ||
15640 | @cindex default data directory | |
15641 | @cindex @samp{--with-gdb-datadir} | |
15642 | You can set the default data directory by using the configure-time | |
15643 | @samp{--with-gdb-datadir} option. If the data directory is inside | |
15644 | @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or | |
15645 | @samp{--exec-prefix}), then the default data directory will be updated | |
15646 | automatically if the installed @value{GDBN} is moved to a new | |
15647 | location. | |
15648 | ||
aae1c79a DE |
15649 | The data directory may also be specified with the |
15650 | @code{--data-directory} command line option. | |
15651 | @xref{Mode Options}. | |
15652 | ||
6d2ebf8b | 15653 | @node Targets |
c906108c | 15654 | @chapter Specifying a Debugging Target |
7a292a7a | 15655 | |
c906108c | 15656 | @cindex debugging target |
c906108c | 15657 | A @dfn{target} is the execution environment occupied by your program. |
53a5351d JM |
15658 | |
15659 | Often, @value{GDBN} runs in the same host environment as your program; | |
15660 | in that case, the debugging target is specified as a side effect when | |
15661 | you use the @code{file} or @code{core} commands. When you need more | |
c906108c SS |
15662 | flexibility---for example, running @value{GDBN} on a physically separate |
15663 | host, or controlling a standalone system over a serial port or a | |
53a5351d JM |
15664 | realtime system over a TCP/IP connection---you can use the @code{target} |
15665 | command to specify one of the target types configured for @value{GDBN} | |
79a6e687 | 15666 | (@pxref{Target Commands, ,Commands for Managing Targets}). |
c906108c | 15667 | |
a8f24a35 EZ |
15668 | @cindex target architecture |
15669 | It is possible to build @value{GDBN} for several different @dfn{target | |
15670 | architectures}. When @value{GDBN} is built like that, you can choose | |
15671 | one of the available architectures with the @kbd{set architecture} | |
15672 | command. | |
15673 | ||
15674 | @table @code | |
15675 | @kindex set architecture | |
15676 | @kindex show architecture | |
15677 | @item set architecture @var{arch} | |
15678 | This command sets the current target architecture to @var{arch}. The | |
15679 | value of @var{arch} can be @code{"auto"}, in addition to one of the | |
15680 | supported architectures. | |
15681 | ||
15682 | @item show architecture | |
15683 | Show the current target architecture. | |
9c16f35a EZ |
15684 | |
15685 | @item set processor | |
15686 | @itemx processor | |
15687 | @kindex set processor | |
15688 | @kindex show processor | |
15689 | These are alias commands for, respectively, @code{set architecture} | |
15690 | and @code{show architecture}. | |
a8f24a35 EZ |
15691 | @end table |
15692 | ||
c906108c SS |
15693 | @menu |
15694 | * Active Targets:: Active targets | |
15695 | * Target Commands:: Commands for managing targets | |
c906108c | 15696 | * Byte Order:: Choosing target byte order |
c906108c SS |
15697 | @end menu |
15698 | ||
6d2ebf8b | 15699 | @node Active Targets |
79a6e687 | 15700 | @section Active Targets |
7a292a7a | 15701 | |
c906108c SS |
15702 | @cindex stacking targets |
15703 | @cindex active targets | |
15704 | @cindex multiple targets | |
15705 | ||
8ea5bce5 | 15706 | There are multiple classes of targets such as: processes, executable files or |
c0edd9ed JK |
15707 | recording sessions. Core files belong to the process class, making core file |
15708 | and process mutually exclusive. Otherwise, @value{GDBN} can work concurrently | |
15709 | on multiple active targets, one in each class. This allows you to (for | |
15710 | example) start a process and inspect its activity, while still having access to | |
15711 | the executable file after the process finishes. Or if you start process | |
15712 | recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are | |
15713 | presented a virtual layer of the recording target, while the process target | |
15714 | remains stopped at the chronologically last point of the process execution. | |
15715 | ||
15716 | Use the @code{core-file} and @code{exec-file} commands to select a new core | |
15717 | file or executable target (@pxref{Files, ,Commands to Specify Files}). To | |
15718 | specify as a target a process that is already running, use the @code{attach} | |
15719 | command (@pxref{Attach, ,Debugging an Already-running Process}). | |
c906108c | 15720 | |
6d2ebf8b | 15721 | @node Target Commands |
79a6e687 | 15722 | @section Commands for Managing Targets |
c906108c SS |
15723 | |
15724 | @table @code | |
15725 | @item target @var{type} @var{parameters} | |
7a292a7a SS |
15726 | Connects the @value{GDBN} host environment to a target machine or |
15727 | process. A target is typically a protocol for talking to debugging | |
15728 | facilities. You use the argument @var{type} to specify the type or | |
15729 | protocol of the target machine. | |
c906108c SS |
15730 | |
15731 | Further @var{parameters} are interpreted by the target protocol, but | |
15732 | typically include things like device names or host names to connect | |
15733 | with, process numbers, and baud rates. | |
c906108c SS |
15734 | |
15735 | The @code{target} command does not repeat if you press @key{RET} again | |
15736 | after executing the command. | |
15737 | ||
15738 | @kindex help target | |
15739 | @item help target | |
15740 | Displays the names of all targets available. To display targets | |
15741 | currently selected, use either @code{info target} or @code{info files} | |
79a6e687 | 15742 | (@pxref{Files, ,Commands to Specify Files}). |
c906108c SS |
15743 | |
15744 | @item help target @var{name} | |
15745 | Describe a particular target, including any parameters necessary to | |
15746 | select it. | |
15747 | ||
15748 | @kindex set gnutarget | |
15749 | @item set gnutarget @var{args} | |
5d161b24 | 15750 | @value{GDBN} uses its own library BFD to read your files. @value{GDBN} |
c906108c | 15751 | knows whether it is reading an @dfn{executable}, |
5d161b24 DB |
15752 | a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format |
15753 | with the @code{set gnutarget} command. Unlike most @code{target} commands, | |
c906108c SS |
15754 | with @code{gnutarget} the @code{target} refers to a program, not a machine. |
15755 | ||
d4f3574e | 15756 | @quotation |
c906108c SS |
15757 | @emph{Warning:} To specify a file format with @code{set gnutarget}, |
15758 | you must know the actual BFD name. | |
d4f3574e | 15759 | @end quotation |
c906108c | 15760 | |
d4f3574e | 15761 | @noindent |
79a6e687 | 15762 | @xref{Files, , Commands to Specify Files}. |
c906108c | 15763 | |
5d161b24 | 15764 | @kindex show gnutarget |
c906108c SS |
15765 | @item show gnutarget |
15766 | Use the @code{show gnutarget} command to display what file format | |
15767 | @code{gnutarget} is set to read. If you have not set @code{gnutarget}, | |
15768 | @value{GDBN} will determine the file format for each file automatically, | |
15769 | and @code{show gnutarget} displays @samp{The current BDF target is "auto"}. | |
15770 | @end table | |
15771 | ||
4644b6e3 | 15772 | @cindex common targets |
c906108c SS |
15773 | Here are some common targets (available, or not, depending on the GDB |
15774 | configuration): | |
c906108c SS |
15775 | |
15776 | @table @code | |
4644b6e3 | 15777 | @kindex target |
c906108c | 15778 | @item target exec @var{program} |
4644b6e3 | 15779 | @cindex executable file target |
c906108c SS |
15780 | An executable file. @samp{target exec @var{program}} is the same as |
15781 | @samp{exec-file @var{program}}. | |
15782 | ||
c906108c | 15783 | @item target core @var{filename} |
4644b6e3 | 15784 | @cindex core dump file target |
c906108c SS |
15785 | A core dump file. @samp{target core @var{filename}} is the same as |
15786 | @samp{core-file @var{filename}}. | |
c906108c | 15787 | |
1a10341b | 15788 | @item target remote @var{medium} |
4644b6e3 | 15789 | @cindex remote target |
1a10341b JB |
15790 | A remote system connected to @value{GDBN} via a serial line or network |
15791 | connection. This command tells @value{GDBN} to use its own remote | |
15792 | protocol over @var{medium} for debugging. @xref{Remote Debugging}. | |
15793 | ||
15794 | For example, if you have a board connected to @file{/dev/ttya} on the | |
15795 | machine running @value{GDBN}, you could say: | |
15796 | ||
15797 | @smallexample | |
15798 | target remote /dev/ttya | |
15799 | @end smallexample | |
15800 | ||
15801 | @code{target remote} supports the @code{load} command. This is only | |
15802 | useful if you have some other way of getting the stub to the target | |
15803 | system, and you can put it somewhere in memory where it won't get | |
15804 | clobbered by the download. | |
c906108c | 15805 | |
ee8e71d4 | 15806 | @item target sim @r{[}@var{simargs}@r{]} @dots{} |
4644b6e3 | 15807 | @cindex built-in simulator target |
2df3850c | 15808 | Builtin CPU simulator. @value{GDBN} includes simulators for most architectures. |
104c1213 | 15809 | In general, |
474c8240 | 15810 | @smallexample |
104c1213 JM |
15811 | target sim |
15812 | load | |
15813 | run | |
474c8240 | 15814 | @end smallexample |
d4f3574e | 15815 | @noindent |
104c1213 | 15816 | works; however, you cannot assume that a specific memory map, device |
d4f3574e | 15817 | drivers, or even basic I/O is available, although some simulators do |
104c1213 JM |
15818 | provide these. For info about any processor-specific simulator details, |
15819 | see the appropriate section in @ref{Embedded Processors, ,Embedded | |
15820 | Processors}. | |
15821 | ||
c906108c SS |
15822 | @end table |
15823 | ||
104c1213 | 15824 | Some configurations may include these targets as well: |
c906108c SS |
15825 | |
15826 | @table @code | |
15827 | ||
c906108c | 15828 | @item target nrom @var{dev} |
4644b6e3 | 15829 | @cindex NetROM ROM emulator target |
c906108c SS |
15830 | NetROM ROM emulator. This target only supports downloading. |
15831 | ||
c906108c SS |
15832 | @end table |
15833 | ||
5d161b24 | 15834 | Different targets are available on different configurations of @value{GDBN}; |
c906108c | 15835 | your configuration may have more or fewer targets. |
c906108c | 15836 | |
721c2651 EZ |
15837 | Many remote targets require you to download the executable's code once |
15838 | you've successfully established a connection. You may wish to control | |
3d00d119 DJ |
15839 | various aspects of this process. |
15840 | ||
15841 | @table @code | |
721c2651 EZ |
15842 | |
15843 | @item set hash | |
15844 | @kindex set hash@r{, for remote monitors} | |
15845 | @cindex hash mark while downloading | |
15846 | This command controls whether a hash mark @samp{#} is displayed while | |
15847 | downloading a file to the remote monitor. If on, a hash mark is | |
15848 | displayed after each S-record is successfully downloaded to the | |
15849 | monitor. | |
15850 | ||
15851 | @item show hash | |
15852 | @kindex show hash@r{, for remote monitors} | |
15853 | Show the current status of displaying the hash mark. | |
15854 | ||
15855 | @item set debug monitor | |
15856 | @kindex set debug monitor | |
15857 | @cindex display remote monitor communications | |
15858 | Enable or disable display of communications messages between | |
15859 | @value{GDBN} and the remote monitor. | |
15860 | ||
15861 | @item show debug monitor | |
15862 | @kindex show debug monitor | |
15863 | Show the current status of displaying communications between | |
15864 | @value{GDBN} and the remote monitor. | |
a8f24a35 | 15865 | @end table |
c906108c SS |
15866 | |
15867 | @table @code | |
15868 | ||
15869 | @kindex load @var{filename} | |
15870 | @item load @var{filename} | |
8edfe269 | 15871 | @anchor{load} |
c906108c SS |
15872 | Depending on what remote debugging facilities are configured into |
15873 | @value{GDBN}, the @code{load} command may be available. Where it exists, it | |
15874 | is meant to make @var{filename} (an executable) available for debugging | |
15875 | on the remote system---by downloading, or dynamic linking, for example. | |
15876 | @code{load} also records the @var{filename} symbol table in @value{GDBN}, like | |
15877 | the @code{add-symbol-file} command. | |
15878 | ||
15879 | If your @value{GDBN} does not have a @code{load} command, attempting to | |
15880 | execute it gets the error message ``@code{You can't do that when your | |
15881 | target is @dots{}}'' | |
c906108c SS |
15882 | |
15883 | The file is loaded at whatever address is specified in the executable. | |
15884 | For some object file formats, you can specify the load address when you | |
15885 | link the program; for other formats, like a.out, the object file format | |
15886 | specifies a fixed address. | |
15887 | @c FIXME! This would be a good place for an xref to the GNU linker doc. | |
15888 | ||
68437a39 DJ |
15889 | Depending on the remote side capabilities, @value{GDBN} may be able to |
15890 | load programs into flash memory. | |
15891 | ||
c906108c SS |
15892 | @code{load} does not repeat if you press @key{RET} again after using it. |
15893 | @end table | |
15894 | ||
6d2ebf8b | 15895 | @node Byte Order |
79a6e687 | 15896 | @section Choosing Target Byte Order |
7a292a7a | 15897 | |
c906108c SS |
15898 | @cindex choosing target byte order |
15899 | @cindex target byte order | |
c906108c | 15900 | |
172c2a43 | 15901 | Some types of processors, such as the MIPS, PowerPC, and Renesas SH, |
c906108c SS |
15902 | offer the ability to run either big-endian or little-endian byte |
15903 | orders. Usually the executable or symbol will include a bit to | |
15904 | designate the endian-ness, and you will not need to worry about | |
15905 | which to use. However, you may still find it useful to adjust | |
d4f3574e | 15906 | @value{GDBN}'s idea of processor endian-ness manually. |
c906108c SS |
15907 | |
15908 | @table @code | |
4644b6e3 | 15909 | @kindex set endian |
c906108c SS |
15910 | @item set endian big |
15911 | Instruct @value{GDBN} to assume the target is big-endian. | |
15912 | ||
c906108c SS |
15913 | @item set endian little |
15914 | Instruct @value{GDBN} to assume the target is little-endian. | |
15915 | ||
c906108c SS |
15916 | @item set endian auto |
15917 | Instruct @value{GDBN} to use the byte order associated with the | |
15918 | executable. | |
15919 | ||
15920 | @item show endian | |
15921 | Display @value{GDBN}'s current idea of the target byte order. | |
15922 | ||
15923 | @end table | |
15924 | ||
15925 | Note that these commands merely adjust interpretation of symbolic | |
15926 | data on the host, and that they have absolutely no effect on the | |
15927 | target system. | |
15928 | ||
ea35711c DJ |
15929 | |
15930 | @node Remote Debugging | |
15931 | @chapter Debugging Remote Programs | |
c906108c SS |
15932 | @cindex remote debugging |
15933 | ||
15934 | If you are trying to debug a program running on a machine that cannot run | |
5d161b24 DB |
15935 | @value{GDBN} in the usual way, it is often useful to use remote debugging. |
15936 | For example, you might use remote debugging on an operating system kernel, | |
c906108c SS |
15937 | or on a small system which does not have a general purpose operating system |
15938 | powerful enough to run a full-featured debugger. | |
15939 | ||
15940 | Some configurations of @value{GDBN} have special serial or TCP/IP interfaces | |
15941 | to make this work with particular debugging targets. In addition, | |
5d161b24 | 15942 | @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN}, |
c906108c SS |
15943 | but not specific to any particular target system) which you can use if you |
15944 | write the remote stubs---the code that runs on the remote system to | |
15945 | communicate with @value{GDBN}. | |
15946 | ||
15947 | Other remote targets may be available in your | |
15948 | configuration of @value{GDBN}; use @code{help target} to list them. | |
c906108c | 15949 | |
6b2f586d | 15950 | @menu |
07f31aa6 | 15951 | * Connecting:: Connecting to a remote target |
a6b151f1 | 15952 | * File Transfer:: Sending files to a remote system |
6b2f586d | 15953 | * Server:: Using the gdbserver program |
79a6e687 BW |
15954 | * Remote Configuration:: Remote configuration |
15955 | * Remote Stub:: Implementing a remote stub | |
6b2f586d AC |
15956 | @end menu |
15957 | ||
07f31aa6 | 15958 | @node Connecting |
79a6e687 | 15959 | @section Connecting to a Remote Target |
07f31aa6 DJ |
15960 | |
15961 | On the @value{GDBN} host machine, you will need an unstripped copy of | |
d3e8051b | 15962 | your program, since @value{GDBN} needs symbol and debugging information. |
07f31aa6 DJ |
15963 | Start up @value{GDBN} as usual, using the name of the local copy of your |
15964 | program as the first argument. | |
15965 | ||
86941c27 JB |
15966 | @cindex @code{target remote} |
15967 | @value{GDBN} can communicate with the target over a serial line, or | |
15968 | over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In | |
15969 | each case, @value{GDBN} uses the same protocol for debugging your | |
15970 | program; only the medium carrying the debugging packets varies. The | |
15971 | @code{target remote} command establishes a connection to the target. | |
15972 | Its arguments indicate which medium to use: | |
15973 | ||
15974 | @table @code | |
15975 | ||
15976 | @item target remote @var{serial-device} | |
07f31aa6 | 15977 | @cindex serial line, @code{target remote} |
86941c27 JB |
15978 | Use @var{serial-device} to communicate with the target. For example, |
15979 | to use a serial line connected to the device named @file{/dev/ttyb}: | |
15980 | ||
15981 | @smallexample | |
15982 | target remote /dev/ttyb | |
15983 | @end smallexample | |
15984 | ||
07f31aa6 DJ |
15985 | If you're using a serial line, you may want to give @value{GDBN} the |
15986 | @w{@samp{--baud}} option, or use the @code{set remotebaud} command | |
79a6e687 | 15987 | (@pxref{Remote Configuration, set remotebaud}) before the |
9c16f35a | 15988 | @code{target} command. |
07f31aa6 | 15989 | |
86941c27 JB |
15990 | @item target remote @code{@var{host}:@var{port}} |
15991 | @itemx target remote @code{tcp:@var{host}:@var{port}} | |
15992 | @cindex @acronym{TCP} port, @code{target remote} | |
15993 | Debug using a @acronym{TCP} connection to @var{port} on @var{host}. | |
15994 | The @var{host} may be either a host name or a numeric @acronym{IP} | |
15995 | address; @var{port} must be a decimal number. The @var{host} could be | |
15996 | the target machine itself, if it is directly connected to the net, or | |
15997 | it might be a terminal server which in turn has a serial line to the | |
15998 | target. | |
07f31aa6 | 15999 | |
86941c27 JB |
16000 | For example, to connect to port 2828 on a terminal server named |
16001 | @code{manyfarms}: | |
07f31aa6 DJ |
16002 | |
16003 | @smallexample | |
16004 | target remote manyfarms:2828 | |
16005 | @end smallexample | |
16006 | ||
86941c27 JB |
16007 | If your remote target is actually running on the same machine as your |
16008 | debugger session (e.g.@: a simulator for your target running on the | |
16009 | same host), you can omit the hostname. For example, to connect to | |
16010 | port 1234 on your local machine: | |
07f31aa6 DJ |
16011 | |
16012 | @smallexample | |
16013 | target remote :1234 | |
16014 | @end smallexample | |
16015 | @noindent | |
16016 | ||
16017 | Note that the colon is still required here. | |
16018 | ||
86941c27 JB |
16019 | @item target remote @code{udp:@var{host}:@var{port}} |
16020 | @cindex @acronym{UDP} port, @code{target remote} | |
16021 | Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to | |
16022 | connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}: | |
07f31aa6 DJ |
16023 | |
16024 | @smallexample | |
16025 | target remote udp:manyfarms:2828 | |
16026 | @end smallexample | |
16027 | ||
86941c27 JB |
16028 | When using a @acronym{UDP} connection for remote debugging, you should |
16029 | keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP} | |
16030 | can silently drop packets on busy or unreliable networks, which will | |
16031 | cause havoc with your debugging session. | |
16032 | ||
66b8c7f6 JB |
16033 | @item target remote | @var{command} |
16034 | @cindex pipe, @code{target remote} to | |
16035 | Run @var{command} in the background and communicate with it using a | |
16036 | pipe. The @var{command} is a shell command, to be parsed and expanded | |
16037 | by the system's command shell, @code{/bin/sh}; it should expect remote | |
16038 | protocol packets on its standard input, and send replies on its | |
16039 | standard output. You could use this to run a stand-alone simulator | |
16040 | that speaks the remote debugging protocol, to make net connections | |
16041 | using programs like @code{ssh}, or for other similar tricks. | |
16042 | ||
16043 | If @var{command} closes its standard output (perhaps by exiting), | |
16044 | @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the | |
16045 | program has already exited, this will have no effect.) | |
16046 | ||
86941c27 | 16047 | @end table |
07f31aa6 | 16048 | |
86941c27 | 16049 | Once the connection has been established, you can use all the usual |
8edfe269 DJ |
16050 | commands to examine and change data. The remote program is already |
16051 | running; you can use @kbd{step} and @kbd{continue}, and you do not | |
16052 | need to use @kbd{run}. | |
07f31aa6 DJ |
16053 | |
16054 | @cindex interrupting remote programs | |
16055 | @cindex remote programs, interrupting | |
16056 | Whenever @value{GDBN} is waiting for the remote program, if you type the | |
c8aa23ab | 16057 | interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the |
07f31aa6 DJ |
16058 | program. This may or may not succeed, depending in part on the hardware |
16059 | and the serial drivers the remote system uses. If you type the | |
16060 | interrupt character once again, @value{GDBN} displays this prompt: | |
16061 | ||
16062 | @smallexample | |
16063 | Interrupted while waiting for the program. | |
16064 | Give up (and stop debugging it)? (y or n) | |
16065 | @end smallexample | |
16066 | ||
16067 | If you type @kbd{y}, @value{GDBN} abandons the remote debugging session. | |
16068 | (If you decide you want to try again later, you can use @samp{target | |
16069 | remote} again to connect once more.) If you type @kbd{n}, @value{GDBN} | |
16070 | goes back to waiting. | |
16071 | ||
16072 | @table @code | |
16073 | @kindex detach (remote) | |
16074 | @item detach | |
16075 | When you have finished debugging the remote program, you can use the | |
16076 | @code{detach} command to release it from @value{GDBN} control. | |
16077 | Detaching from the target normally resumes its execution, but the results | |
16078 | will depend on your particular remote stub. After the @code{detach} | |
16079 | command, @value{GDBN} is free to connect to another target. | |
16080 | ||
16081 | @kindex disconnect | |
16082 | @item disconnect | |
16083 | The @code{disconnect} command behaves like @code{detach}, except that | |
16084 | the target is generally not resumed. It will wait for @value{GDBN} | |
16085 | (this instance or another one) to connect and continue debugging. After | |
16086 | the @code{disconnect} command, @value{GDBN} is again free to connect to | |
16087 | another target. | |
09d4efe1 EZ |
16088 | |
16089 | @cindex send command to remote monitor | |
fad38dfa EZ |
16090 | @cindex extend @value{GDBN} for remote targets |
16091 | @cindex add new commands for external monitor | |
09d4efe1 EZ |
16092 | @kindex monitor |
16093 | @item monitor @var{cmd} | |
fad38dfa EZ |
16094 | This command allows you to send arbitrary commands directly to the |
16095 | remote monitor. Since @value{GDBN} doesn't care about the commands it | |
16096 | sends like this, this command is the way to extend @value{GDBN}---you | |
16097 | can add new commands that only the external monitor will understand | |
16098 | and implement. | |
07f31aa6 DJ |
16099 | @end table |
16100 | ||
a6b151f1 DJ |
16101 | @node File Transfer |
16102 | @section Sending files to a remote system | |
16103 | @cindex remote target, file transfer | |
16104 | @cindex file transfer | |
16105 | @cindex sending files to remote systems | |
16106 | ||
16107 | Some remote targets offer the ability to transfer files over the same | |
16108 | connection used to communicate with @value{GDBN}. This is convenient | |
16109 | for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems | |
16110 | running @code{gdbserver} over a network interface. For other targets, | |
16111 | e.g.@: embedded devices with only a single serial port, this may be | |
16112 | the only way to upload or download files. | |
16113 | ||
16114 | Not all remote targets support these commands. | |
16115 | ||
16116 | @table @code | |
16117 | @kindex remote put | |
16118 | @item remote put @var{hostfile} @var{targetfile} | |
16119 | Copy file @var{hostfile} from the host system (the machine running | |
16120 | @value{GDBN}) to @var{targetfile} on the target system. | |
16121 | ||
16122 | @kindex remote get | |
16123 | @item remote get @var{targetfile} @var{hostfile} | |
16124 | Copy file @var{targetfile} from the target system to @var{hostfile} | |
16125 | on the host system. | |
16126 | ||
16127 | @kindex remote delete | |
16128 | @item remote delete @var{targetfile} | |
16129 | Delete @var{targetfile} from the target system. | |
16130 | ||
16131 | @end table | |
16132 | ||
6f05cf9f | 16133 | @node Server |
79a6e687 | 16134 | @section Using the @code{gdbserver} Program |
6f05cf9f AC |
16135 | |
16136 | @kindex gdbserver | |
16137 | @cindex remote connection without stubs | |
16138 | @code{gdbserver} is a control program for Unix-like systems, which | |
16139 | allows you to connect your program with a remote @value{GDBN} via | |
16140 | @code{target remote}---but without linking in the usual debugging stub. | |
16141 | ||
16142 | @code{gdbserver} is not a complete replacement for the debugging stubs, | |
16143 | because it requires essentially the same operating-system facilities | |
16144 | that @value{GDBN} itself does. In fact, a system that can run | |
16145 | @code{gdbserver} to connect to a remote @value{GDBN} could also run | |
16146 | @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless, | |
16147 | because it is a much smaller program than @value{GDBN} itself. It is | |
16148 | also easier to port than all of @value{GDBN}, so you may be able to get | |
16149 | started more quickly on a new system by using @code{gdbserver}. | |
16150 | Finally, if you develop code for real-time systems, you may find that | |
16151 | the tradeoffs involved in real-time operation make it more convenient to | |
16152 | do as much development work as possible on another system, for example | |
16153 | by cross-compiling. You can use @code{gdbserver} to make a similar | |
16154 | choice for debugging. | |
16155 | ||
16156 | @value{GDBN} and @code{gdbserver} communicate via either a serial line | |
16157 | or a TCP connection, using the standard @value{GDBN} remote serial | |
16158 | protocol. | |
16159 | ||
2d717e4f DJ |
16160 | @quotation |
16161 | @emph{Warning:} @code{gdbserver} does not have any built-in security. | |
16162 | Do not run @code{gdbserver} connected to any public network; a | |
16163 | @value{GDBN} connection to @code{gdbserver} provides access to the | |
16164 | target system with the same privileges as the user running | |
16165 | @code{gdbserver}. | |
16166 | @end quotation | |
16167 | ||
16168 | @subsection Running @code{gdbserver} | |
16169 | @cindex arguments, to @code{gdbserver} | |
d9b1a651 | 16170 | @cindex @code{gdbserver}, command-line arguments |
2d717e4f DJ |
16171 | |
16172 | Run @code{gdbserver} on the target system. You need a copy of the | |
16173 | program you want to debug, including any libraries it requires. | |
6f05cf9f AC |
16174 | @code{gdbserver} does not need your program's symbol table, so you can |
16175 | strip the program if necessary to save space. @value{GDBN} on the host | |
16176 | system does all the symbol handling. | |
16177 | ||
16178 | To use the server, you must tell it how to communicate with @value{GDBN}; | |
56460a61 | 16179 | the name of your program; and the arguments for your program. The usual |
6f05cf9f AC |
16180 | syntax is: |
16181 | ||
16182 | @smallexample | |
16183 | target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ] | |
16184 | @end smallexample | |
16185 | ||
16186 | @var{comm} is either a device name (to use a serial line) or a TCP | |
16187 | hostname and portnumber. For example, to debug Emacs with the argument | |
16188 | @samp{foo.txt} and communicate with @value{GDBN} over the serial port | |
16189 | @file{/dev/com1}: | |
16190 | ||
16191 | @smallexample | |
16192 | target> gdbserver /dev/com1 emacs foo.txt | |
16193 | @end smallexample | |
16194 | ||
16195 | @code{gdbserver} waits passively for the host @value{GDBN} to communicate | |
16196 | with it. | |
16197 | ||
16198 | To use a TCP connection instead of a serial line: | |
16199 | ||
16200 | @smallexample | |
16201 | target> gdbserver host:2345 emacs foo.txt | |
16202 | @end smallexample | |
16203 | ||
16204 | The only difference from the previous example is the first argument, | |
16205 | specifying that you are communicating with the host @value{GDBN} via | |
16206 | TCP. The @samp{host:2345} argument means that @code{gdbserver} is to | |
16207 | expect a TCP connection from machine @samp{host} to local TCP port 2345. | |
16208 | (Currently, the @samp{host} part is ignored.) You can choose any number | |
16209 | you want for the port number as long as it does not conflict with any | |
16210 | TCP ports already in use on the target system (for example, @code{23} is | |
16211 | reserved for @code{telnet}).@footnote{If you choose a port number that | |
16212 | conflicts with another service, @code{gdbserver} prints an error message | |
16213 | and exits.} You must use the same port number with the host @value{GDBN} | |
16214 | @code{target remote} command. | |
16215 | ||
2d717e4f | 16216 | @subsubsection Attaching to a Running Program |
d9b1a651 EZ |
16217 | @cindex attach to a program, @code{gdbserver} |
16218 | @cindex @option{--attach}, @code{gdbserver} option | |
2d717e4f | 16219 | |
56460a61 DJ |
16220 | On some targets, @code{gdbserver} can also attach to running programs. |
16221 | This is accomplished via the @code{--attach} argument. The syntax is: | |
16222 | ||
16223 | @smallexample | |
2d717e4f | 16224 | target> gdbserver --attach @var{comm} @var{pid} |
56460a61 DJ |
16225 | @end smallexample |
16226 | ||
16227 | @var{pid} is the process ID of a currently running process. It isn't necessary | |
16228 | to point @code{gdbserver} at a binary for the running process. | |
16229 | ||
b1fe9455 | 16230 | @pindex pidof |
b1fe9455 DJ |
16231 | You can debug processes by name instead of process ID if your target has the |
16232 | @code{pidof} utility: | |
16233 | ||
16234 | @smallexample | |
2d717e4f | 16235 | target> gdbserver --attach @var{comm} `pidof @var{program}` |
b1fe9455 DJ |
16236 | @end smallexample |
16237 | ||
f822c95b | 16238 | In case more than one copy of @var{program} is running, or @var{program} |
b1fe9455 DJ |
16239 | has multiple threads, most versions of @code{pidof} support the |
16240 | @code{-s} option to only return the first process ID. | |
16241 | ||
2d717e4f | 16242 | @subsubsection Multi-Process Mode for @code{gdbserver} |
d9b1a651 EZ |
16243 | @cindex @code{gdbserver}, multiple processes |
16244 | @cindex multiple processes with @code{gdbserver} | |
2d717e4f DJ |
16245 | |
16246 | When you connect to @code{gdbserver} using @code{target remote}, | |
16247 | @code{gdbserver} debugs the specified program only once. When the | |
16248 | program exits, or you detach from it, @value{GDBN} closes the connection | |
16249 | and @code{gdbserver} exits. | |
16250 | ||
6e6c6f50 | 16251 | If you connect using @kbd{target extended-remote}, @code{gdbserver} |
2d717e4f DJ |
16252 | enters multi-process mode. When the debugged program exits, or you |
16253 | detach from it, @value{GDBN} stays connected to @code{gdbserver} even | |
16254 | though no program is running. The @code{run} and @code{attach} | |
16255 | commands instruct @code{gdbserver} to run or attach to a new program. | |
16256 | The @code{run} command uses @code{set remote exec-file} (@pxref{set | |
16257 | remote exec-file}) to select the program to run. Command line | |
16258 | arguments are supported, except for wildcard expansion and I/O | |
16259 | redirection (@pxref{Arguments}). | |
16260 | ||
d9b1a651 | 16261 | @cindex @option{--multi}, @code{gdbserver} option |
2d717e4f DJ |
16262 | To start @code{gdbserver} without supplying an initial command to run |
16263 | or process ID to attach, use the @option{--multi} command line option. | |
6e6c6f50 | 16264 | Then you can connect using @kbd{target extended-remote} and start |
2d717e4f DJ |
16265 | the program you want to debug. |
16266 | ||
03f2bd59 JK |
16267 | In multi-process mode @code{gdbserver} does not automatically exit unless you |
16268 | use the option @option{--once}. You can terminate it by using | |
16269 | @code{monitor exit} (@pxref{Monitor Commands for gdbserver}). Note that the | |
16270 | conditions under which @code{gdbserver} terminates depend on how @value{GDBN} | |
16271 | connects to it (@kbd{target remote} or @kbd{target extended-remote}). The | |
16272 | @option{--multi} option to @code{gdbserver} has no influence on that. | |
16273 | ||
16274 | @subsubsection TCP port allocation lifecycle of @code{gdbserver} | |
16275 | ||
16276 | This section applies only when @code{gdbserver} is run to listen on a TCP port. | |
16277 | ||
16278 | @code{gdbserver} normally terminates after all of its debugged processes have | |
16279 | terminated in @kbd{target remote} mode. On the other hand, for @kbd{target | |
16280 | extended-remote}, @code{gdbserver} stays running even with no processes left. | |
16281 | @value{GDBN} normally terminates the spawned debugged process on its exit, | |
16282 | which normally also terminates @code{gdbserver} in the @kbd{target remote} | |
16283 | mode. Therefore, when the connection drops unexpectedly, and @value{GDBN} | |
16284 | cannot ask @code{gdbserver} to kill its debugged processes, @code{gdbserver} | |
16285 | stays running even in the @kbd{target remote} mode. | |
16286 | ||
16287 | When @code{gdbserver} stays running, @value{GDBN} can connect to it again later. | |
16288 | Such reconnecting is useful for features like @ref{disconnected tracing}. For | |
16289 | completeness, at most one @value{GDBN} can be connected at a time. | |
16290 | ||
16291 | @cindex @option{--once}, @code{gdbserver} option | |
16292 | By default, @code{gdbserver} keeps the listening TCP port open, so that | |
16293 | additional connections are possible. However, if you start @code{gdbserver} | |
16294 | with the @option{--once} option, it will stop listening for any further | |
16295 | connection attempts after connecting to the first @value{GDBN} session. This | |
16296 | means no further connections to @code{gdbserver} will be possible after the | |
16297 | first one. It also means @code{gdbserver} will terminate after the first | |
16298 | connection with remote @value{GDBN} has closed, even for unexpectedly closed | |
16299 | connections and even in the @kbd{target extended-remote} mode. The | |
16300 | @option{--once} option allows reusing the same port number for connecting to | |
16301 | multiple instances of @code{gdbserver} running on the same host, since each | |
16302 | instance closes its port after the first connection. | |
2d717e4f DJ |
16303 | |
16304 | @subsubsection Other Command-Line Arguments for @code{gdbserver} | |
16305 | ||
d9b1a651 | 16306 | @cindex @option{--debug}, @code{gdbserver} option |
62709adf | 16307 | The @option{--debug} option tells @code{gdbserver} to display extra |
d9b1a651 EZ |
16308 | status information about the debugging process. |
16309 | @cindex @option{--remote-debug}, @code{gdbserver} option | |
16310 | The @option{--remote-debug} option tells @code{gdbserver} to display | |
62709adf PA |
16311 | remote protocol debug output. These options are intended for |
16312 | @code{gdbserver} development and for bug reports to the developers. | |
2d717e4f | 16313 | |
d9b1a651 | 16314 | @cindex @option{--wrapper}, @code{gdbserver} option |
ccd213ac DJ |
16315 | The @option{--wrapper} option specifies a wrapper to launch programs |
16316 | for debugging. The option should be followed by the name of the | |
16317 | wrapper, then any command-line arguments to pass to the wrapper, then | |
16318 | @kbd{--} indicating the end of the wrapper arguments. | |
16319 | ||
16320 | @code{gdbserver} runs the specified wrapper program with a combined | |
16321 | command line including the wrapper arguments, then the name of the | |
16322 | program to debug, then any arguments to the program. The wrapper | |
16323 | runs until it executes your program, and then @value{GDBN} gains control. | |
16324 | ||
16325 | You can use any program that eventually calls @code{execve} with | |
16326 | its arguments as a wrapper. Several standard Unix utilities do | |
16327 | this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending | |
16328 | with @code{exec "$@@"} will also work. | |
16329 | ||
16330 | For example, you can use @code{env} to pass an environment variable to | |
16331 | the debugged program, without setting the variable in @code{gdbserver}'s | |
16332 | environment: | |
16333 | ||
16334 | @smallexample | |
16335 | $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog | |
16336 | @end smallexample | |
16337 | ||
2d717e4f DJ |
16338 | @subsection Connecting to @code{gdbserver} |
16339 | ||
16340 | Run @value{GDBN} on the host system. | |
16341 | ||
16342 | First make sure you have the necessary symbol files. Load symbols for | |
f822c95b DJ |
16343 | your application using the @code{file} command before you connect. Use |
16344 | @code{set sysroot} to locate target libraries (unless your @value{GDBN} | |
2d717e4f | 16345 | was compiled with the correct sysroot using @code{--with-sysroot}). |
f822c95b DJ |
16346 | |
16347 | The symbol file and target libraries must exactly match the executable | |
16348 | and libraries on the target, with one exception: the files on the host | |
16349 | system should not be stripped, even if the files on the target system | |
16350 | are. Mismatched or missing files will lead to confusing results | |
16351 | during debugging. On @sc{gnu}/Linux targets, mismatched or missing | |
16352 | files may also prevent @code{gdbserver} from debugging multi-threaded | |
16353 | programs. | |
16354 | ||
79a6e687 | 16355 | Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}). |
6f05cf9f AC |
16356 | For TCP connections, you must start up @code{gdbserver} prior to using |
16357 | the @code{target remote} command. Otherwise you may get an error whose | |
16358 | text depends on the host system, but which usually looks something like | |
2d717e4f | 16359 | @samp{Connection refused}. Don't use the @code{load} |
397ca115 | 16360 | command in @value{GDBN} when using @code{gdbserver}, since the program is |
f822c95b | 16361 | already on the target. |
07f31aa6 | 16362 | |
79a6e687 | 16363 | @subsection Monitor Commands for @code{gdbserver} |
c74d0ad8 | 16364 | @cindex monitor commands, for @code{gdbserver} |
2d717e4f | 16365 | @anchor{Monitor Commands for gdbserver} |
c74d0ad8 DJ |
16366 | |
16367 | During a @value{GDBN} session using @code{gdbserver}, you can use the | |
16368 | @code{monitor} command to send special requests to @code{gdbserver}. | |
2d717e4f | 16369 | Here are the available commands. |
c74d0ad8 DJ |
16370 | |
16371 | @table @code | |
16372 | @item monitor help | |
16373 | List the available monitor commands. | |
16374 | ||
16375 | @item monitor set debug 0 | |
16376 | @itemx monitor set debug 1 | |
16377 | Disable or enable general debugging messages. | |
16378 | ||
16379 | @item monitor set remote-debug 0 | |
16380 | @itemx monitor set remote-debug 1 | |
16381 | Disable or enable specific debugging messages associated with the remote | |
16382 | protocol (@pxref{Remote Protocol}). | |
16383 | ||
cdbfd419 PP |
16384 | @item monitor set libthread-db-search-path [PATH] |
16385 | @cindex gdbserver, search path for @code{libthread_db} | |
16386 | When this command is issued, @var{path} is a colon-separated list of | |
16387 | directories to search for @code{libthread_db} (@pxref{Threads,,set | |
16388 | libthread-db-search-path}). If you omit @var{path}, | |
84e578fb | 16389 | @samp{libthread-db-search-path} will be reset to its default value. |
cdbfd419 | 16390 | |
98a5dd13 DE |
16391 | The special entry @samp{$pdir} for @samp{libthread-db-search-path} is |
16392 | not supported in @code{gdbserver}. | |
16393 | ||
2d717e4f DJ |
16394 | @item monitor exit |
16395 | Tell gdbserver to exit immediately. This command should be followed by | |
16396 | @code{disconnect} to close the debugging session. @code{gdbserver} will | |
16397 | detach from any attached processes and kill any processes it created. | |
16398 | Use @code{monitor exit} to terminate @code{gdbserver} at the end | |
16399 | of a multi-process mode debug session. | |
16400 | ||
c74d0ad8 DJ |
16401 | @end table |
16402 | ||
fa593d66 PA |
16403 | @subsection Tracepoints support in @code{gdbserver} |
16404 | @cindex tracepoints support in @code{gdbserver} | |
16405 | ||
0fb4aa4b PA |
16406 | On some targets, @code{gdbserver} supports tracepoints, fast |
16407 | tracepoints and static tracepoints. | |
fa593d66 | 16408 | |
0fb4aa4b | 16409 | For fast or static tracepoints to work, a special library called the |
fa593d66 PA |
16410 | @dfn{in-process agent} (IPA), must be loaded in the inferior process. |
16411 | This library is built and distributed as an integral part of | |
0fb4aa4b PA |
16412 | @code{gdbserver}. In addition, support for static tracepoints |
16413 | requires building the in-process agent library with static tracepoints | |
16414 | support. At present, the UST (LTTng Userspace Tracer, | |
16415 | @url{http://lttng.org/ust}) tracing engine is supported. This support | |
16416 | is automatically available if UST development headers are found in the | |
16417 | standard include path when @code{gdbserver} is built, or if | |
16418 | @code{gdbserver} was explicitly configured using @option{--with-ust} | |
16419 | to point at such headers. You can explicitly disable the support | |
16420 | using @option{--with-ust=no}. | |
fa593d66 PA |
16421 | |
16422 | There are several ways to load the in-process agent in your program: | |
16423 | ||
16424 | @table @code | |
16425 | @item Specifying it as dependency at link time | |
16426 | ||
16427 | You can link your program dynamically with the in-process agent | |
16428 | library. On most systems, this is accomplished by adding | |
16429 | @code{-linproctrace} to the link command. | |
16430 | ||
16431 | @item Using the system's preloading mechanisms | |
16432 | ||
16433 | You can force loading the in-process agent at startup time by using | |
16434 | your system's support for preloading shared libraries. Many Unixes | |
16435 | support the concept of preloading user defined libraries. In most | |
16436 | cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so} | |
16437 | in the environment. See also the description of @code{gdbserver}'s | |
16438 | @option{--wrapper} command line option. | |
16439 | ||
16440 | @item Using @value{GDBN} to force loading the agent at run time | |
16441 | ||
16442 | On some systems, you can force the inferior to load a shared library, | |
16443 | by calling a dynamic loader function in the inferior that takes care | |
16444 | of dynamically looking up and loading a shared library. On most Unix | |
16445 | systems, the function is @code{dlopen}. You'll use the @code{call} | |
16446 | command for that. For example: | |
16447 | ||
16448 | @smallexample | |
16449 | (@value{GDBP}) call dlopen ("libinproctrace.so", ...) | |
16450 | @end smallexample | |
16451 | ||
16452 | Note that on most Unix systems, for the @code{dlopen} function to be | |
16453 | available, the program needs to be linked with @code{-ldl}. | |
16454 | @end table | |
16455 | ||
16456 | On systems that have a userspace dynamic loader, like most Unix | |
16457 | systems, when you connect to @code{gdbserver} using @code{target | |
16458 | remote}, you'll find that the program is stopped at the dynamic | |
16459 | loader's entry point, and no shared library has been loaded in the | |
16460 | program's address space yet, including the in-process agent. In that | |
0fb4aa4b PA |
16461 | case, before being able to use any of the fast or static tracepoints |
16462 | features, you need to let the loader run and load the shared | |
16463 | libraries. The simplest way to do that is to run the program to the | |
16464 | main procedure. E.g., if debugging a C or C@t{++} program, start | |
fa593d66 PA |
16465 | @code{gdbserver} like so: |
16466 | ||
16467 | @smallexample | |
16468 | $ gdbserver :9999 myprogram | |
16469 | @end smallexample | |
16470 | ||
16471 | Start GDB and connect to @code{gdbserver} like so, and run to main: | |
16472 | ||
16473 | @smallexample | |
16474 | $ gdb myprogram | |
16475 | (@value{GDBP}) target remote myhost:9999 | |
16476 | 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2 | |
16477 | (@value{GDBP}) b main | |
16478 | (@value{GDBP}) continue | |
16479 | @end smallexample | |
16480 | ||
16481 | The in-process tracing agent library should now be loaded into the | |
16482 | process; you can confirm it with the @code{info sharedlibrary} | |
16483 | command, which will list @file{libinproctrace.so} as loaded in the | |
0fb4aa4b PA |
16484 | process. You are now ready to install fast tracepoints, list static |
16485 | tracepoint markers, probe static tracepoints markers, and start | |
fa593d66 PA |
16486 | tracing. |
16487 | ||
79a6e687 BW |
16488 | @node Remote Configuration |
16489 | @section Remote Configuration | |
501eef12 | 16490 | |
9c16f35a EZ |
16491 | @kindex set remote |
16492 | @kindex show remote | |
16493 | This section documents the configuration options available when | |
16494 | debugging remote programs. For the options related to the File I/O | |
fc320d37 | 16495 | extensions of the remote protocol, see @ref{system, |
9c16f35a | 16496 | system-call-allowed}. |
501eef12 AC |
16497 | |
16498 | @table @code | |
9c16f35a | 16499 | @item set remoteaddresssize @var{bits} |
d3e8051b | 16500 | @cindex address size for remote targets |
9c16f35a EZ |
16501 | @cindex bits in remote address |
16502 | Set the maximum size of address in a memory packet to the specified | |
16503 | number of bits. @value{GDBN} will mask off the address bits above | |
16504 | that number, when it passes addresses to the remote target. The | |
16505 | default value is the number of bits in the target's address. | |
16506 | ||
16507 | @item show remoteaddresssize | |
16508 | Show the current value of remote address size in bits. | |
16509 | ||
16510 | @item set remotebaud @var{n} | |
16511 | @cindex baud rate for remote targets | |
16512 | Set the baud rate for the remote serial I/O to @var{n} baud. The | |
16513 | value is used to set the speed of the serial port used for debugging | |
16514 | remote targets. | |
16515 | ||
16516 | @item show remotebaud | |
16517 | Show the current speed of the remote connection. | |
16518 | ||
16519 | @item set remotebreak | |
16520 | @cindex interrupt remote programs | |
16521 | @cindex BREAK signal instead of Ctrl-C | |
9a6253be | 16522 | @anchor{set remotebreak} |
9c16f35a | 16523 | If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote |
c8aa23ab | 16524 | when you type @kbd{Ctrl-c} to interrupt the program running |
9a7a1b36 | 16525 | on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C} |
9c16f35a EZ |
16526 | character instead. The default is off, since most remote systems |
16527 | expect to see @samp{Ctrl-C} as the interrupt signal. | |
16528 | ||
16529 | @item show remotebreak | |
16530 | Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to | |
16531 | interrupt the remote program. | |
16532 | ||
23776285 MR |
16533 | @item set remoteflow on |
16534 | @itemx set remoteflow off | |
16535 | @kindex set remoteflow | |
16536 | Enable or disable hardware flow control (@code{RTS}/@code{CTS}) | |
16537 | on the serial port used to communicate to the remote target. | |
16538 | ||
16539 | @item show remoteflow | |
16540 | @kindex show remoteflow | |
16541 | Show the current setting of hardware flow control. | |
16542 | ||
9c16f35a EZ |
16543 | @item set remotelogbase @var{base} |
16544 | Set the base (a.k.a.@: radix) of logging serial protocol | |
16545 | communications to @var{base}. Supported values of @var{base} are: | |
16546 | @code{ascii}, @code{octal}, and @code{hex}. The default is | |
16547 | @code{ascii}. | |
16548 | ||
16549 | @item show remotelogbase | |
16550 | Show the current setting of the radix for logging remote serial | |
16551 | protocol. | |
16552 | ||
16553 | @item set remotelogfile @var{file} | |
16554 | @cindex record serial communications on file | |
16555 | Record remote serial communications on the named @var{file}. The | |
16556 | default is not to record at all. | |
16557 | ||
16558 | @item show remotelogfile. | |
16559 | Show the current setting of the file name on which to record the | |
16560 | serial communications. | |
16561 | ||
16562 | @item set remotetimeout @var{num} | |
16563 | @cindex timeout for serial communications | |
16564 | @cindex remote timeout | |
16565 | Set the timeout limit to wait for the remote target to respond to | |
16566 | @var{num} seconds. The default is 2 seconds. | |
16567 | ||
16568 | @item show remotetimeout | |
16569 | Show the current number of seconds to wait for the remote target | |
16570 | responses. | |
16571 | ||
16572 | @cindex limit hardware breakpoints and watchpoints | |
16573 | @cindex remote target, limit break- and watchpoints | |
501eef12 AC |
16574 | @anchor{set remote hardware-watchpoint-limit} |
16575 | @anchor{set remote hardware-breakpoint-limit} | |
16576 | @item set remote hardware-watchpoint-limit @var{limit} | |
16577 | @itemx set remote hardware-breakpoint-limit @var{limit} | |
16578 | Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or | |
16579 | watchpoints. A limit of -1, the default, is treated as unlimited. | |
2d717e4f DJ |
16580 | |
16581 | @item set remote exec-file @var{filename} | |
16582 | @itemx show remote exec-file | |
16583 | @anchor{set remote exec-file} | |
16584 | @cindex executable file, for remote target | |
16585 | Select the file used for @code{run} with @code{target | |
16586 | extended-remote}. This should be set to a filename valid on the | |
16587 | target system. If it is not set, the target will use a default | |
16588 | filename (e.g.@: the last program run). | |
84603566 | 16589 | |
9a7071a8 JB |
16590 | @item set remote interrupt-sequence |
16591 | @cindex interrupt remote programs | |
16592 | @cindex select Ctrl-C, BREAK or BREAK-g | |
16593 | Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or | |
16594 | @samp{BREAK-g} as the | |
16595 | sequence to the remote target in order to interrupt the execution. | |
16596 | @samp{Ctrl-C} is a default. Some system prefers @code{BREAK} which | |
16597 | is high level of serial line for some certain time. | |
16598 | Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g. | |
16599 | It is @code{BREAK} signal followed by character @code{g}. | |
16600 | ||
16601 | @item show interrupt-sequence | |
16602 | Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g} | |
16603 | is sent by @value{GDBN} to interrupt the remote program. | |
16604 | @code{BREAK-g} is BREAK signal followed by @code{g} and | |
16605 | also known as Magic SysRq g. | |
16606 | ||
16607 | @item set remote interrupt-on-connect | |
16608 | @cindex send interrupt-sequence on start | |
16609 | Specify whether interrupt-sequence is sent to remote target when | |
16610 | @value{GDBN} connects to it. This is mostly needed when you debug | |
16611 | Linux kernel. Linux kernel expects @code{BREAK} followed by @code{g} | |
16612 | which is known as Magic SysRq g in order to connect @value{GDBN}. | |
16613 | ||
16614 | @item show interrupt-on-connect | |
16615 | Show whether interrupt-sequence is sent | |
16616 | to remote target when @value{GDBN} connects to it. | |
16617 | ||
84603566 SL |
16618 | @kindex set tcp |
16619 | @kindex show tcp | |
16620 | @item set tcp auto-retry on | |
16621 | @cindex auto-retry, for remote TCP target | |
16622 | Enable auto-retry for remote TCP connections. This is useful if the remote | |
16623 | debugging agent is launched in parallel with @value{GDBN}; there is a race | |
16624 | condition because the agent may not become ready to accept the connection | |
16625 | before @value{GDBN} attempts to connect. When auto-retry is | |
16626 | enabled, if the initial attempt to connect fails, @value{GDBN} reattempts | |
16627 | to establish the connection using the timeout specified by | |
16628 | @code{set tcp connect-timeout}. | |
16629 | ||
16630 | @item set tcp auto-retry off | |
16631 | Do not auto-retry failed TCP connections. | |
16632 | ||
16633 | @item show tcp auto-retry | |
16634 | Show the current auto-retry setting. | |
16635 | ||
16636 | @item set tcp connect-timeout @var{seconds} | |
16637 | @cindex connection timeout, for remote TCP target | |
16638 | @cindex timeout, for remote target connection | |
16639 | Set the timeout for establishing a TCP connection to the remote target to | |
16640 | @var{seconds}. The timeout affects both polling to retry failed connections | |
16641 | (enabled by @code{set tcp auto-retry on}) and waiting for connections | |
16642 | that are merely slow to complete, and represents an approximate cumulative | |
16643 | value. | |
16644 | ||
16645 | @item show tcp connect-timeout | |
16646 | Show the current connection timeout setting. | |
501eef12 AC |
16647 | @end table |
16648 | ||
427c3a89 DJ |
16649 | @cindex remote packets, enabling and disabling |
16650 | The @value{GDBN} remote protocol autodetects the packets supported by | |
16651 | your debugging stub. If you need to override the autodetection, you | |
16652 | can use these commands to enable or disable individual packets. Each | |
16653 | packet can be set to @samp{on} (the remote target supports this | |
16654 | packet), @samp{off} (the remote target does not support this packet), | |
16655 | or @samp{auto} (detect remote target support for this packet). They | |
16656 | all default to @samp{auto}. For more information about each packet, | |
16657 | see @ref{Remote Protocol}. | |
16658 | ||
16659 | During normal use, you should not have to use any of these commands. | |
16660 | If you do, that may be a bug in your remote debugging stub, or a bug | |
16661 | in @value{GDBN}. You may want to report the problem to the | |
16662 | @value{GDBN} developers. | |
16663 | ||
cfa9d6d9 DJ |
16664 | For each packet @var{name}, the command to enable or disable the |
16665 | packet is @code{set remote @var{name}-packet}. The available settings | |
16666 | are: | |
427c3a89 | 16667 | |
cfa9d6d9 | 16668 | @multitable @columnfractions 0.28 0.32 0.25 |
427c3a89 DJ |
16669 | @item Command Name |
16670 | @tab Remote Packet | |
16671 | @tab Related Features | |
16672 | ||
cfa9d6d9 | 16673 | @item @code{fetch-register} |
427c3a89 DJ |
16674 | @tab @code{p} |
16675 | @tab @code{info registers} | |
16676 | ||
cfa9d6d9 | 16677 | @item @code{set-register} |
427c3a89 DJ |
16678 | @tab @code{P} |
16679 | @tab @code{set} | |
16680 | ||
cfa9d6d9 | 16681 | @item @code{binary-download} |
427c3a89 DJ |
16682 | @tab @code{X} |
16683 | @tab @code{load}, @code{set} | |
16684 | ||
cfa9d6d9 | 16685 | @item @code{read-aux-vector} |
427c3a89 DJ |
16686 | @tab @code{qXfer:auxv:read} |
16687 | @tab @code{info auxv} | |
16688 | ||
cfa9d6d9 | 16689 | @item @code{symbol-lookup} |
427c3a89 DJ |
16690 | @tab @code{qSymbol} |
16691 | @tab Detecting multiple threads | |
16692 | ||
2d717e4f DJ |
16693 | @item @code{attach} |
16694 | @tab @code{vAttach} | |
16695 | @tab @code{attach} | |
16696 | ||
cfa9d6d9 | 16697 | @item @code{verbose-resume} |
427c3a89 DJ |
16698 | @tab @code{vCont} |
16699 | @tab Stepping or resuming multiple threads | |
16700 | ||
2d717e4f DJ |
16701 | @item @code{run} |
16702 | @tab @code{vRun} | |
16703 | @tab @code{run} | |
16704 | ||
cfa9d6d9 | 16705 | @item @code{software-breakpoint} |
427c3a89 DJ |
16706 | @tab @code{Z0} |
16707 | @tab @code{break} | |
16708 | ||
cfa9d6d9 | 16709 | @item @code{hardware-breakpoint} |
427c3a89 DJ |
16710 | @tab @code{Z1} |
16711 | @tab @code{hbreak} | |
16712 | ||
cfa9d6d9 | 16713 | @item @code{write-watchpoint} |
427c3a89 DJ |
16714 | @tab @code{Z2} |
16715 | @tab @code{watch} | |
16716 | ||
cfa9d6d9 | 16717 | @item @code{read-watchpoint} |
427c3a89 DJ |
16718 | @tab @code{Z3} |
16719 | @tab @code{rwatch} | |
16720 | ||
cfa9d6d9 | 16721 | @item @code{access-watchpoint} |
427c3a89 DJ |
16722 | @tab @code{Z4} |
16723 | @tab @code{awatch} | |
16724 | ||
cfa9d6d9 DJ |
16725 | @item @code{target-features} |
16726 | @tab @code{qXfer:features:read} | |
16727 | @tab @code{set architecture} | |
16728 | ||
16729 | @item @code{library-info} | |
16730 | @tab @code{qXfer:libraries:read} | |
16731 | @tab @code{info sharedlibrary} | |
16732 | ||
16733 | @item @code{memory-map} | |
16734 | @tab @code{qXfer:memory-map:read} | |
16735 | @tab @code{info mem} | |
16736 | ||
0fb4aa4b PA |
16737 | @item @code{read-sdata-object} |
16738 | @tab @code{qXfer:sdata:read} | |
16739 | @tab @code{print $_sdata} | |
16740 | ||
cfa9d6d9 DJ |
16741 | @item @code{read-spu-object} |
16742 | @tab @code{qXfer:spu:read} | |
16743 | @tab @code{info spu} | |
16744 | ||
16745 | @item @code{write-spu-object} | |
16746 | @tab @code{qXfer:spu:write} | |
16747 | @tab @code{info spu} | |
16748 | ||
4aa995e1 PA |
16749 | @item @code{read-siginfo-object} |
16750 | @tab @code{qXfer:siginfo:read} | |
16751 | @tab @code{print $_siginfo} | |
16752 | ||
16753 | @item @code{write-siginfo-object} | |
16754 | @tab @code{qXfer:siginfo:write} | |
16755 | @tab @code{set $_siginfo} | |
16756 | ||
dc146f7c VP |
16757 | @item @code{threads} |
16758 | @tab @code{qXfer:threads:read} | |
16759 | @tab @code{info threads} | |
16760 | ||
cfa9d6d9 | 16761 | @item @code{get-thread-local-@*storage-address} |
427c3a89 DJ |
16762 | @tab @code{qGetTLSAddr} |
16763 | @tab Displaying @code{__thread} variables | |
16764 | ||
711e434b PM |
16765 | @item @code{get-thread-information-block-address} |
16766 | @tab @code{qGetTIBAddr} | |
16767 | @tab Display MS-Windows Thread Information Block. | |
16768 | ||
08388c79 DE |
16769 | @item @code{search-memory} |
16770 | @tab @code{qSearch:memory} | |
16771 | @tab @code{find} | |
16772 | ||
427c3a89 DJ |
16773 | @item @code{supported-packets} |
16774 | @tab @code{qSupported} | |
16775 | @tab Remote communications parameters | |
16776 | ||
cfa9d6d9 | 16777 | @item @code{pass-signals} |
89be2091 DJ |
16778 | @tab @code{QPassSignals} |
16779 | @tab @code{handle @var{signal}} | |
16780 | ||
a6b151f1 DJ |
16781 | @item @code{hostio-close-packet} |
16782 | @tab @code{vFile:close} | |
16783 | @tab @code{remote get}, @code{remote put} | |
16784 | ||
16785 | @item @code{hostio-open-packet} | |
16786 | @tab @code{vFile:open} | |
16787 | @tab @code{remote get}, @code{remote put} | |
16788 | ||
16789 | @item @code{hostio-pread-packet} | |
16790 | @tab @code{vFile:pread} | |
16791 | @tab @code{remote get}, @code{remote put} | |
16792 | ||
16793 | @item @code{hostio-pwrite-packet} | |
16794 | @tab @code{vFile:pwrite} | |
16795 | @tab @code{remote get}, @code{remote put} | |
16796 | ||
16797 | @item @code{hostio-unlink-packet} | |
16798 | @tab @code{vFile:unlink} | |
16799 | @tab @code{remote delete} | |
a6f3e723 SL |
16800 | |
16801 | @item @code{noack-packet} | |
16802 | @tab @code{QStartNoAckMode} | |
16803 | @tab Packet acknowledgment | |
07e059b5 VP |
16804 | |
16805 | @item @code{osdata} | |
16806 | @tab @code{qXfer:osdata:read} | |
16807 | @tab @code{info os} | |
0b16c5cf PA |
16808 | |
16809 | @item @code{query-attached} | |
16810 | @tab @code{qAttached} | |
16811 | @tab Querying remote process attach state. | |
b3b9301e PA |
16812 | |
16813 | @item @code{traceframe-info} | |
16814 | @tab @code{qXfer:traceframe-info:read} | |
16815 | @tab Traceframe info | |
427c3a89 DJ |
16816 | @end multitable |
16817 | ||
79a6e687 BW |
16818 | @node Remote Stub |
16819 | @section Implementing a Remote Stub | |
7a292a7a | 16820 | |
8e04817f AC |
16821 | @cindex debugging stub, example |
16822 | @cindex remote stub, example | |
16823 | @cindex stub example, remote debugging | |
16824 | The stub files provided with @value{GDBN} implement the target side of the | |
16825 | communication protocol, and the @value{GDBN} side is implemented in the | |
16826 | @value{GDBN} source file @file{remote.c}. Normally, you can simply allow | |
16827 | these subroutines to communicate, and ignore the details. (If you're | |
16828 | implementing your own stub file, you can still ignore the details: start | |
16829 | with one of the existing stub files. @file{sparc-stub.c} is the best | |
16830 | organized, and therefore the easiest to read.) | |
16831 | ||
104c1213 JM |
16832 | @cindex remote serial debugging, overview |
16833 | To debug a program running on another machine (the debugging | |
16834 | @dfn{target} machine), you must first arrange for all the usual | |
16835 | prerequisites for the program to run by itself. For example, for a C | |
16836 | program, you need: | |
c906108c | 16837 | |
104c1213 JM |
16838 | @enumerate |
16839 | @item | |
16840 | A startup routine to set up the C runtime environment; these usually | |
16841 | have a name like @file{crt0}. The startup routine may be supplied by | |
16842 | your hardware supplier, or you may have to write your own. | |
96baa820 | 16843 | |
5d161b24 | 16844 | @item |
d4f3574e | 16845 | A C subroutine library to support your program's |
104c1213 | 16846 | subroutine calls, notably managing input and output. |
96baa820 | 16847 | |
104c1213 JM |
16848 | @item |
16849 | A way of getting your program to the other machine---for example, a | |
16850 | download program. These are often supplied by the hardware | |
16851 | manufacturer, but you may have to write your own from hardware | |
16852 | documentation. | |
16853 | @end enumerate | |
96baa820 | 16854 | |
104c1213 JM |
16855 | The next step is to arrange for your program to use a serial port to |
16856 | communicate with the machine where @value{GDBN} is running (the @dfn{host} | |
16857 | machine). In general terms, the scheme looks like this: | |
96baa820 | 16858 | |
104c1213 JM |
16859 | @table @emph |
16860 | @item On the host, | |
16861 | @value{GDBN} already understands how to use this protocol; when everything | |
16862 | else is set up, you can simply use the @samp{target remote} command | |
16863 | (@pxref{Targets,,Specifying a Debugging Target}). | |
16864 | ||
16865 | @item On the target, | |
16866 | you must link with your program a few special-purpose subroutines that | |
16867 | implement the @value{GDBN} remote serial protocol. The file containing these | |
16868 | subroutines is called a @dfn{debugging stub}. | |
16869 | ||
16870 | On certain remote targets, you can use an auxiliary program | |
16871 | @code{gdbserver} instead of linking a stub into your program. | |
79a6e687 | 16872 | @xref{Server,,Using the @code{gdbserver} Program}, for details. |
104c1213 | 16873 | @end table |
96baa820 | 16874 | |
104c1213 JM |
16875 | The debugging stub is specific to the architecture of the remote |
16876 | machine; for example, use @file{sparc-stub.c} to debug programs on | |
16877 | @sc{sparc} boards. | |
96baa820 | 16878 | |
104c1213 JM |
16879 | @cindex remote serial stub list |
16880 | These working remote stubs are distributed with @value{GDBN}: | |
96baa820 | 16881 | |
104c1213 JM |
16882 | @table @code |
16883 | ||
16884 | @item i386-stub.c | |
41afff9a | 16885 | @cindex @file{i386-stub.c} |
104c1213 JM |
16886 | @cindex Intel |
16887 | @cindex i386 | |
16888 | For Intel 386 and compatible architectures. | |
16889 | ||
16890 | @item m68k-stub.c | |
41afff9a | 16891 | @cindex @file{m68k-stub.c} |
104c1213 JM |
16892 | @cindex Motorola 680x0 |
16893 | @cindex m680x0 | |
16894 | For Motorola 680x0 architectures. | |
16895 | ||
16896 | @item sh-stub.c | |
41afff9a | 16897 | @cindex @file{sh-stub.c} |
172c2a43 | 16898 | @cindex Renesas |
104c1213 | 16899 | @cindex SH |
172c2a43 | 16900 | For Renesas SH architectures. |
104c1213 JM |
16901 | |
16902 | @item sparc-stub.c | |
41afff9a | 16903 | @cindex @file{sparc-stub.c} |
104c1213 JM |
16904 | @cindex Sparc |
16905 | For @sc{sparc} architectures. | |
16906 | ||
16907 | @item sparcl-stub.c | |
41afff9a | 16908 | @cindex @file{sparcl-stub.c} |
104c1213 JM |
16909 | @cindex Fujitsu |
16910 | @cindex SparcLite | |
16911 | For Fujitsu @sc{sparclite} architectures. | |
16912 | ||
16913 | @end table | |
16914 | ||
16915 | The @file{README} file in the @value{GDBN} distribution may list other | |
16916 | recently added stubs. | |
16917 | ||
16918 | @menu | |
16919 | * Stub Contents:: What the stub can do for you | |
16920 | * Bootstrapping:: What you must do for the stub | |
16921 | * Debug Session:: Putting it all together | |
104c1213 JM |
16922 | @end menu |
16923 | ||
6d2ebf8b | 16924 | @node Stub Contents |
79a6e687 | 16925 | @subsection What the Stub Can Do for You |
104c1213 JM |
16926 | |
16927 | @cindex remote serial stub | |
16928 | The debugging stub for your architecture supplies these three | |
16929 | subroutines: | |
16930 | ||
16931 | @table @code | |
16932 | @item set_debug_traps | |
4644b6e3 | 16933 | @findex set_debug_traps |
104c1213 JM |
16934 | @cindex remote serial stub, initialization |
16935 | This routine arranges for @code{handle_exception} to run when your | |
16936 | program stops. You must call this subroutine explicitly near the | |
16937 | beginning of your program. | |
16938 | ||
16939 | @item handle_exception | |
4644b6e3 | 16940 | @findex handle_exception |
104c1213 JM |
16941 | @cindex remote serial stub, main routine |
16942 | This is the central workhorse, but your program never calls it | |
16943 | explicitly---the setup code arranges for @code{handle_exception} to | |
16944 | run when a trap is triggered. | |
16945 | ||
16946 | @code{handle_exception} takes control when your program stops during | |
16947 | execution (for example, on a breakpoint), and mediates communications | |
16948 | with @value{GDBN} on the host machine. This is where the communications | |
16949 | protocol is implemented; @code{handle_exception} acts as the @value{GDBN} | |
d4f3574e | 16950 | representative on the target machine. It begins by sending summary |
104c1213 JM |
16951 | information on the state of your program, then continues to execute, |
16952 | retrieving and transmitting any information @value{GDBN} needs, until you | |
16953 | execute a @value{GDBN} command that makes your program resume; at that point, | |
16954 | @code{handle_exception} returns control to your own code on the target | |
5d161b24 | 16955 | machine. |
104c1213 JM |
16956 | |
16957 | @item breakpoint | |
16958 | @cindex @code{breakpoint} subroutine, remote | |
16959 | Use this auxiliary subroutine to make your program contain a | |
16960 | breakpoint. Depending on the particular situation, this may be the only | |
16961 | way for @value{GDBN} to get control. For instance, if your target | |
16962 | machine has some sort of interrupt button, you won't need to call this; | |
16963 | pressing the interrupt button transfers control to | |
16964 | @code{handle_exception}---in effect, to @value{GDBN}. On some machines, | |
16965 | simply receiving characters on the serial port may also trigger a trap; | |
16966 | again, in that situation, you don't need to call @code{breakpoint} from | |
16967 | your own program---simply running @samp{target remote} from the host | |
5d161b24 | 16968 | @value{GDBN} session gets control. |
104c1213 JM |
16969 | |
16970 | Call @code{breakpoint} if none of these is true, or if you simply want | |
16971 | to make certain your program stops at a predetermined point for the | |
16972 | start of your debugging session. | |
16973 | @end table | |
16974 | ||
6d2ebf8b | 16975 | @node Bootstrapping |
79a6e687 | 16976 | @subsection What You Must Do for the Stub |
104c1213 JM |
16977 | |
16978 | @cindex remote stub, support routines | |
16979 | The debugging stubs that come with @value{GDBN} are set up for a particular | |
16980 | chip architecture, but they have no information about the rest of your | |
16981 | debugging target machine. | |
16982 | ||
16983 | First of all you need to tell the stub how to communicate with the | |
16984 | serial port. | |
16985 | ||
16986 | @table @code | |
16987 | @item int getDebugChar() | |
4644b6e3 | 16988 | @findex getDebugChar |
104c1213 JM |
16989 | Write this subroutine to read a single character from the serial port. |
16990 | It may be identical to @code{getchar} for your target system; a | |
16991 | different name is used to allow you to distinguish the two if you wish. | |
16992 | ||
16993 | @item void putDebugChar(int) | |
4644b6e3 | 16994 | @findex putDebugChar |
104c1213 | 16995 | Write this subroutine to write a single character to the serial port. |
5d161b24 | 16996 | It may be identical to @code{putchar} for your target system; a |
104c1213 JM |
16997 | different name is used to allow you to distinguish the two if you wish. |
16998 | @end table | |
16999 | ||
17000 | @cindex control C, and remote debugging | |
17001 | @cindex interrupting remote targets | |
17002 | If you want @value{GDBN} to be able to stop your program while it is | |
17003 | running, you need to use an interrupt-driven serial driver, and arrange | |
17004 | for it to stop when it receives a @code{^C} (@samp{\003}, the control-C | |
17005 | character). That is the character which @value{GDBN} uses to tell the | |
17006 | remote system to stop. | |
17007 | ||
17008 | Getting the debugging target to return the proper status to @value{GDBN} | |
17009 | probably requires changes to the standard stub; one quick and dirty way | |
17010 | is to just execute a breakpoint instruction (the ``dirty'' part is that | |
17011 | @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}). | |
17012 | ||
17013 | Other routines you need to supply are: | |
17014 | ||
17015 | @table @code | |
17016 | @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address}) | |
4644b6e3 | 17017 | @findex exceptionHandler |
104c1213 JM |
17018 | Write this function to install @var{exception_address} in the exception |
17019 | handling tables. You need to do this because the stub does not have any | |
17020 | way of knowing what the exception handling tables on your target system | |
17021 | are like (for example, the processor's table might be in @sc{rom}, | |
17022 | containing entries which point to a table in @sc{ram}). | |
17023 | @var{exception_number} is the exception number which should be changed; | |
17024 | its meaning is architecture-dependent (for example, different numbers | |
17025 | might represent divide by zero, misaligned access, etc). When this | |
17026 | exception occurs, control should be transferred directly to | |
17027 | @var{exception_address}, and the processor state (stack, registers, | |
17028 | and so on) should be just as it is when a processor exception occurs. So if | |
17029 | you want to use a jump instruction to reach @var{exception_address}, it | |
17030 | should be a simple jump, not a jump to subroutine. | |
17031 | ||
17032 | For the 386, @var{exception_address} should be installed as an interrupt | |
17033 | gate so that interrupts are masked while the handler runs. The gate | |
17034 | should be at privilege level 0 (the most privileged level). The | |
17035 | @sc{sparc} and 68k stubs are able to mask interrupts themselves without | |
17036 | help from @code{exceptionHandler}. | |
17037 | ||
17038 | @item void flush_i_cache() | |
4644b6e3 | 17039 | @findex flush_i_cache |
d4f3574e | 17040 | On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the |
104c1213 JM |
17041 | instruction cache, if any, on your target machine. If there is no |
17042 | instruction cache, this subroutine may be a no-op. | |
17043 | ||
17044 | On target machines that have instruction caches, @value{GDBN} requires this | |
17045 | function to make certain that the state of your program is stable. | |
17046 | @end table | |
17047 | ||
17048 | @noindent | |
17049 | You must also make sure this library routine is available: | |
17050 | ||
17051 | @table @code | |
17052 | @item void *memset(void *, int, int) | |
4644b6e3 | 17053 | @findex memset |
104c1213 JM |
17054 | This is the standard library function @code{memset} that sets an area of |
17055 | memory to a known value. If you have one of the free versions of | |
17056 | @code{libc.a}, @code{memset} can be found there; otherwise, you must | |
17057 | either obtain it from your hardware manufacturer, or write your own. | |
17058 | @end table | |
17059 | ||
17060 | If you do not use the GNU C compiler, you may need other standard | |
17061 | library subroutines as well; this varies from one stub to another, | |
17062 | but in general the stubs are likely to use any of the common library | |
e22ea452 | 17063 | subroutines which @code{@value{NGCC}} generates as inline code. |
104c1213 JM |
17064 | |
17065 | ||
6d2ebf8b | 17066 | @node Debug Session |
79a6e687 | 17067 | @subsection Putting it All Together |
104c1213 JM |
17068 | |
17069 | @cindex remote serial debugging summary | |
17070 | In summary, when your program is ready to debug, you must follow these | |
17071 | steps. | |
17072 | ||
17073 | @enumerate | |
17074 | @item | |
6d2ebf8b | 17075 | Make sure you have defined the supporting low-level routines |
79a6e687 | 17076 | (@pxref{Bootstrapping,,What You Must Do for the Stub}): |
104c1213 JM |
17077 | @display |
17078 | @code{getDebugChar}, @code{putDebugChar}, | |
17079 | @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}. | |
17080 | @end display | |
17081 | ||
17082 | @item | |
17083 | Insert these lines near the top of your program: | |
17084 | ||
474c8240 | 17085 | @smallexample |
104c1213 JM |
17086 | set_debug_traps(); |
17087 | breakpoint(); | |
474c8240 | 17088 | @end smallexample |
104c1213 JM |
17089 | |
17090 | @item | |
17091 | For the 680x0 stub only, you need to provide a variable called | |
17092 | @code{exceptionHook}. Normally you just use: | |
17093 | ||
474c8240 | 17094 | @smallexample |
104c1213 | 17095 | void (*exceptionHook)() = 0; |
474c8240 | 17096 | @end smallexample |
104c1213 | 17097 | |
d4f3574e | 17098 | @noindent |
104c1213 | 17099 | but if before calling @code{set_debug_traps}, you set it to point to a |
598ca718 | 17100 | function in your program, that function is called when |
104c1213 JM |
17101 | @code{@value{GDBN}} continues after stopping on a trap (for example, bus |
17102 | error). The function indicated by @code{exceptionHook} is called with | |
17103 | one parameter: an @code{int} which is the exception number. | |
17104 | ||
17105 | @item | |
17106 | Compile and link together: your program, the @value{GDBN} debugging stub for | |
17107 | your target architecture, and the supporting subroutines. | |
17108 | ||
17109 | @item | |
17110 | Make sure you have a serial connection between your target machine and | |
17111 | the @value{GDBN} host, and identify the serial port on the host. | |
17112 | ||
17113 | @item | |
17114 | @c The "remote" target now provides a `load' command, so we should | |
17115 | @c document that. FIXME. | |
17116 | Download your program to your target machine (or get it there by | |
17117 | whatever means the manufacturer provides), and start it. | |
17118 | ||
17119 | @item | |
07f31aa6 | 17120 | Start @value{GDBN} on the host, and connect to the target |
79a6e687 | 17121 | (@pxref{Connecting,,Connecting to a Remote Target}). |
9db8d71f | 17122 | |
104c1213 JM |
17123 | @end enumerate |
17124 | ||
8e04817f AC |
17125 | @node Configurations |
17126 | @chapter Configuration-Specific Information | |
104c1213 | 17127 | |
8e04817f AC |
17128 | While nearly all @value{GDBN} commands are available for all native and |
17129 | cross versions of the debugger, there are some exceptions. This chapter | |
17130 | describes things that are only available in certain configurations. | |
104c1213 | 17131 | |
8e04817f AC |
17132 | There are three major categories of configurations: native |
17133 | configurations, where the host and target are the same, embedded | |
17134 | operating system configurations, which are usually the same for several | |
17135 | different processor architectures, and bare embedded processors, which | |
17136 | are quite different from each other. | |
104c1213 | 17137 | |
8e04817f AC |
17138 | @menu |
17139 | * Native:: | |
17140 | * Embedded OS:: | |
17141 | * Embedded Processors:: | |
17142 | * Architectures:: | |
17143 | @end menu | |
104c1213 | 17144 | |
8e04817f AC |
17145 | @node Native |
17146 | @section Native | |
104c1213 | 17147 | |
8e04817f AC |
17148 | This section describes details specific to particular native |
17149 | configurations. | |
6cf7e474 | 17150 | |
8e04817f AC |
17151 | @menu |
17152 | * HP-UX:: HP-UX | |
7561d450 | 17153 | * BSD libkvm Interface:: Debugging BSD kernel memory images |
8e04817f AC |
17154 | * SVR4 Process Information:: SVR4 process information |
17155 | * DJGPP Native:: Features specific to the DJGPP port | |
78c47bea | 17156 | * Cygwin Native:: Features specific to the Cygwin port |
14d6dd68 | 17157 | * Hurd Native:: Features specific to @sc{gnu} Hurd |
a64548ea | 17158 | * Neutrino:: Features specific to QNX Neutrino |
a80b95ba | 17159 | * Darwin:: Features specific to Darwin |
8e04817f | 17160 | @end menu |
6cf7e474 | 17161 | |
8e04817f AC |
17162 | @node HP-UX |
17163 | @subsection HP-UX | |
104c1213 | 17164 | |
8e04817f AC |
17165 | On HP-UX systems, if you refer to a function or variable name that |
17166 | begins with a dollar sign, @value{GDBN} searches for a user or system | |
17167 | name first, before it searches for a convenience variable. | |
104c1213 | 17168 | |
9c16f35a | 17169 | |
7561d450 MK |
17170 | @node BSD libkvm Interface |
17171 | @subsection BSD libkvm Interface | |
17172 | ||
17173 | @cindex libkvm | |
17174 | @cindex kernel memory image | |
17175 | @cindex kernel crash dump | |
17176 | ||
17177 | BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory | |
17178 | interface that provides a uniform interface for accessing kernel virtual | |
17179 | memory images, including live systems and crash dumps. @value{GDBN} | |
17180 | uses this interface to allow you to debug live kernels and kernel crash | |
17181 | dumps on many native BSD configurations. This is implemented as a | |
17182 | special @code{kvm} debugging target. For debugging a live system, load | |
17183 | the currently running kernel into @value{GDBN} and connect to the | |
17184 | @code{kvm} target: | |
17185 | ||
17186 | @smallexample | |
17187 | (@value{GDBP}) @b{target kvm} | |
17188 | @end smallexample | |
17189 | ||
17190 | For debugging crash dumps, provide the file name of the crash dump as an | |
17191 | argument: | |
17192 | ||
17193 | @smallexample | |
17194 | (@value{GDBP}) @b{target kvm /var/crash/bsd.0} | |
17195 | @end smallexample | |
17196 | ||
17197 | Once connected to the @code{kvm} target, the following commands are | |
17198 | available: | |
17199 | ||
17200 | @table @code | |
17201 | @kindex kvm | |
17202 | @item kvm pcb | |
721c2651 | 17203 | Set current context from the @dfn{Process Control Block} (PCB) address. |
7561d450 MK |
17204 | |
17205 | @item kvm proc | |
17206 | Set current context from proc address. This command isn't available on | |
17207 | modern FreeBSD systems. | |
17208 | @end table | |
17209 | ||
8e04817f | 17210 | @node SVR4 Process Information |
79a6e687 | 17211 | @subsection SVR4 Process Information |
60bf7e09 EZ |
17212 | @cindex /proc |
17213 | @cindex examine process image | |
17214 | @cindex process info via @file{/proc} | |
104c1213 | 17215 | |
60bf7e09 EZ |
17216 | Many versions of SVR4 and compatible systems provide a facility called |
17217 | @samp{/proc} that can be used to examine the image of a running | |
17218 | process using file-system subroutines. If @value{GDBN} is configured | |
17219 | for an operating system with this facility, the command @code{info | |
17220 | proc} is available to report information about the process running | |
17221 | your program, or about any process running on your system. @code{info | |
17222 | proc} works only on SVR4 systems that include the @code{procfs} code. | |
17223 | This includes, as of this writing, @sc{gnu}/Linux, OSF/1 (Digital | |
17224 | Unix), Solaris, Irix, and Unixware, but not HP-UX, for example. | |
104c1213 | 17225 | |
8e04817f AC |
17226 | @table @code |
17227 | @kindex info proc | |
60bf7e09 | 17228 | @cindex process ID |
8e04817f | 17229 | @item info proc |
60bf7e09 EZ |
17230 | @itemx info proc @var{process-id} |
17231 | Summarize available information about any running process. If a | |
17232 | process ID is specified by @var{process-id}, display information about | |
17233 | that process; otherwise display information about the program being | |
17234 | debugged. The summary includes the debugged process ID, the command | |
17235 | line used to invoke it, its current working directory, and its | |
17236 | executable file's absolute file name. | |
17237 | ||
17238 | On some systems, @var{process-id} can be of the form | |
17239 | @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID | |
17240 | within a process. If the optional @var{pid} part is missing, it means | |
17241 | a thread from the process being debugged (the leading @samp{/} still | |
17242 | needs to be present, or else @value{GDBN} will interpret the number as | |
17243 | a process ID rather than a thread ID). | |
6cf7e474 | 17244 | |
8e04817f | 17245 | @item info proc mappings |
60bf7e09 EZ |
17246 | @cindex memory address space mappings |
17247 | Report the memory address space ranges accessible in the program, with | |
17248 | information on whether the process has read, write, or execute access | |
17249 | rights to each range. On @sc{gnu}/Linux systems, each memory range | |
17250 | includes the object file which is mapped to that range, instead of the | |
17251 | memory access rights to that range. | |
17252 | ||
17253 | @item info proc stat | |
17254 | @itemx info proc status | |
17255 | @cindex process detailed status information | |
17256 | These subcommands are specific to @sc{gnu}/Linux systems. They show | |
17257 | the process-related information, including the user ID and group ID; | |
17258 | how many threads are there in the process; its virtual memory usage; | |
17259 | the signals that are pending, blocked, and ignored; its TTY; its | |
17260 | consumption of system and user time; its stack size; its @samp{nice} | |
2eecc4ab | 17261 | value; etc. For more information, see the @samp{proc} man page |
60bf7e09 EZ |
17262 | (type @kbd{man 5 proc} from your shell prompt). |
17263 | ||
17264 | @item info proc all | |
17265 | Show all the information about the process described under all of the | |
17266 | above @code{info proc} subcommands. | |
17267 | ||
8e04817f AC |
17268 | @ignore |
17269 | @comment These sub-options of 'info proc' were not included when | |
17270 | @comment procfs.c was re-written. Keep their descriptions around | |
17271 | @comment against the day when someone finds the time to put them back in. | |
17272 | @kindex info proc times | |
17273 | @item info proc times | |
17274 | Starting time, user CPU time, and system CPU time for your program and | |
17275 | its children. | |
6cf7e474 | 17276 | |
8e04817f AC |
17277 | @kindex info proc id |
17278 | @item info proc id | |
17279 | Report on the process IDs related to your program: its own process ID, | |
17280 | the ID of its parent, the process group ID, and the session ID. | |
8e04817f | 17281 | @end ignore |
721c2651 EZ |
17282 | |
17283 | @item set procfs-trace | |
17284 | @kindex set procfs-trace | |
17285 | @cindex @code{procfs} API calls | |
17286 | This command enables and disables tracing of @code{procfs} API calls. | |
17287 | ||
17288 | @item show procfs-trace | |
17289 | @kindex show procfs-trace | |
17290 | Show the current state of @code{procfs} API call tracing. | |
17291 | ||
17292 | @item set procfs-file @var{file} | |
17293 | @kindex set procfs-file | |
17294 | Tell @value{GDBN} to write @code{procfs} API trace to the named | |
17295 | @var{file}. @value{GDBN} appends the trace info to the previous | |
17296 | contents of the file. The default is to display the trace on the | |
17297 | standard output. | |
17298 | ||
17299 | @item show procfs-file | |
17300 | @kindex show procfs-file | |
17301 | Show the file to which @code{procfs} API trace is written. | |
17302 | ||
17303 | @item proc-trace-entry | |
17304 | @itemx proc-trace-exit | |
17305 | @itemx proc-untrace-entry | |
17306 | @itemx proc-untrace-exit | |
17307 | @kindex proc-trace-entry | |
17308 | @kindex proc-trace-exit | |
17309 | @kindex proc-untrace-entry | |
17310 | @kindex proc-untrace-exit | |
17311 | These commands enable and disable tracing of entries into and exits | |
17312 | from the @code{syscall} interface. | |
17313 | ||
17314 | @item info pidlist | |
17315 | @kindex info pidlist | |
17316 | @cindex process list, QNX Neutrino | |
17317 | For QNX Neutrino only, this command displays the list of all the | |
17318 | processes and all the threads within each process. | |
17319 | ||
17320 | @item info meminfo | |
17321 | @kindex info meminfo | |
17322 | @cindex mapinfo list, QNX Neutrino | |
17323 | For QNX Neutrino only, this command displays the list of all mapinfos. | |
8e04817f | 17324 | @end table |
104c1213 | 17325 | |
8e04817f AC |
17326 | @node DJGPP Native |
17327 | @subsection Features for Debugging @sc{djgpp} Programs | |
17328 | @cindex @sc{djgpp} debugging | |
17329 | @cindex native @sc{djgpp} debugging | |
17330 | @cindex MS-DOS-specific commands | |
104c1213 | 17331 | |
514c4d71 EZ |
17332 | @cindex DPMI |
17333 | @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and | |
8e04817f AC |
17334 | MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs |
17335 | that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on | |
17336 | top of real-mode DOS systems and their emulations. | |
104c1213 | 17337 | |
8e04817f AC |
17338 | @value{GDBN} supports native debugging of @sc{djgpp} programs, and |
17339 | defines a few commands specific to the @sc{djgpp} port. This | |
17340 | subsection describes those commands. | |
104c1213 | 17341 | |
8e04817f AC |
17342 | @table @code |
17343 | @kindex info dos | |
17344 | @item info dos | |
17345 | This is a prefix of @sc{djgpp}-specific commands which print | |
17346 | information about the target system and important OS structures. | |
f1251bdd | 17347 | |
8e04817f AC |
17348 | @kindex sysinfo |
17349 | @cindex MS-DOS system info | |
17350 | @cindex free memory information (MS-DOS) | |
17351 | @item info dos sysinfo | |
17352 | This command displays assorted information about the underlying | |
17353 | platform: the CPU type and features, the OS version and flavor, the | |
17354 | DPMI version, and the available conventional and DPMI memory. | |
104c1213 | 17355 | |
8e04817f AC |
17356 | @cindex GDT |
17357 | @cindex LDT | |
17358 | @cindex IDT | |
17359 | @cindex segment descriptor tables | |
17360 | @cindex descriptor tables display | |
17361 | @item info dos gdt | |
17362 | @itemx info dos ldt | |
17363 | @itemx info dos idt | |
17364 | These 3 commands display entries from, respectively, Global, Local, | |
17365 | and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor | |
17366 | tables are data structures which store a descriptor for each segment | |
17367 | that is currently in use. The segment's selector is an index into a | |
17368 | descriptor table; the table entry for that index holds the | |
17369 | descriptor's base address and limit, and its attributes and access | |
17370 | rights. | |
104c1213 | 17371 | |
8e04817f AC |
17372 | A typical @sc{djgpp} program uses 3 segments: a code segment, a data |
17373 | segment (used for both data and the stack), and a DOS segment (which | |
17374 | allows access to DOS/BIOS data structures and absolute addresses in | |
17375 | conventional memory). However, the DPMI host will usually define | |
17376 | additional segments in order to support the DPMI environment. | |
d4f3574e | 17377 | |
8e04817f AC |
17378 | @cindex garbled pointers |
17379 | These commands allow to display entries from the descriptor tables. | |
17380 | Without an argument, all entries from the specified table are | |
17381 | displayed. An argument, which should be an integer expression, means | |
17382 | display a single entry whose index is given by the argument. For | |
17383 | example, here's a convenient way to display information about the | |
17384 | debugged program's data segment: | |
104c1213 | 17385 | |
8e04817f AC |
17386 | @smallexample |
17387 | @exdent @code{(@value{GDBP}) info dos ldt $ds} | |
17388 | @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)} | |
17389 | @end smallexample | |
104c1213 | 17390 | |
8e04817f AC |
17391 | @noindent |
17392 | This comes in handy when you want to see whether a pointer is outside | |
17393 | the data segment's limit (i.e.@: @dfn{garbled}). | |
104c1213 | 17394 | |
8e04817f AC |
17395 | @cindex page tables display (MS-DOS) |
17396 | @item info dos pde | |
17397 | @itemx info dos pte | |
17398 | These two commands display entries from, respectively, the Page | |
17399 | Directory and the Page Tables. Page Directories and Page Tables are | |
17400 | data structures which control how virtual memory addresses are mapped | |
17401 | into physical addresses. A Page Table includes an entry for every | |
17402 | page of memory that is mapped into the program's address space; there | |
17403 | may be several Page Tables, each one holding up to 4096 entries. A | |
17404 | Page Directory has up to 4096 entries, one each for every Page Table | |
17405 | that is currently in use. | |
104c1213 | 17406 | |
8e04817f AC |
17407 | Without an argument, @kbd{info dos pde} displays the entire Page |
17408 | Directory, and @kbd{info dos pte} displays all the entries in all of | |
17409 | the Page Tables. An argument, an integer expression, given to the | |
17410 | @kbd{info dos pde} command means display only that entry from the Page | |
17411 | Directory table. An argument given to the @kbd{info dos pte} command | |
17412 | means display entries from a single Page Table, the one pointed to by | |
17413 | the specified entry in the Page Directory. | |
104c1213 | 17414 | |
8e04817f AC |
17415 | @cindex direct memory access (DMA) on MS-DOS |
17416 | These commands are useful when your program uses @dfn{DMA} (Direct | |
17417 | Memory Access), which needs physical addresses to program the DMA | |
17418 | controller. | |
104c1213 | 17419 | |
8e04817f | 17420 | These commands are supported only with some DPMI servers. |
104c1213 | 17421 | |
8e04817f AC |
17422 | @cindex physical address from linear address |
17423 | @item info dos address-pte @var{addr} | |
17424 | This command displays the Page Table entry for a specified linear | |
514c4d71 EZ |
17425 | address. The argument @var{addr} is a linear address which should |
17426 | already have the appropriate segment's base address added to it, | |
17427 | because this command accepts addresses which may belong to @emph{any} | |
17428 | segment. For example, here's how to display the Page Table entry for | |
17429 | the page where a variable @code{i} is stored: | |
104c1213 | 17430 | |
b383017d | 17431 | @smallexample |
8e04817f AC |
17432 | @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i} |
17433 | @exdent @code{Page Table entry for address 0x11a00d30:} | |
b383017d | 17434 | @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30} |
8e04817f | 17435 | @end smallexample |
104c1213 | 17436 | |
8e04817f AC |
17437 | @noindent |
17438 | This says that @code{i} is stored at offset @code{0xd30} from the page | |
514c4d71 | 17439 | whose physical base address is @code{0x02698000}, and shows all the |
8e04817f | 17440 | attributes of that page. |
104c1213 | 17441 | |
8e04817f AC |
17442 | Note that you must cast the addresses of variables to a @code{char *}, |
17443 | since otherwise the value of @code{__djgpp_base_address}, the base | |
17444 | address of all variables and functions in a @sc{djgpp} program, will | |
17445 | be added using the rules of C pointer arithmetics: if @code{i} is | |
17446 | declared an @code{int}, @value{GDBN} will add 4 times the value of | |
17447 | @code{__djgpp_base_address} to the address of @code{i}. | |
104c1213 | 17448 | |
8e04817f AC |
17449 | Here's another example, it displays the Page Table entry for the |
17450 | transfer buffer: | |
104c1213 | 17451 | |
8e04817f AC |
17452 | @smallexample |
17453 | @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)} | |
17454 | @exdent @code{Page Table entry for address 0x29110:} | |
17455 | @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110} | |
17456 | @end smallexample | |
104c1213 | 17457 | |
8e04817f AC |
17458 | @noindent |
17459 | (The @code{+ 3} offset is because the transfer buffer's address is the | |
514c4d71 EZ |
17460 | 3rd member of the @code{_go32_info_block} structure.) The output |
17461 | clearly shows that this DPMI server maps the addresses in conventional | |
17462 | memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and | |
17463 | linear (@code{0x29110}) addresses are identical. | |
104c1213 | 17464 | |
8e04817f AC |
17465 | This command is supported only with some DPMI servers. |
17466 | @end table | |
104c1213 | 17467 | |
c45da7e6 | 17468 | @cindex DOS serial data link, remote debugging |
a8f24a35 EZ |
17469 | In addition to native debugging, the DJGPP port supports remote |
17470 | debugging via a serial data link. The following commands are specific | |
17471 | to remote serial debugging in the DJGPP port of @value{GDBN}. | |
17472 | ||
17473 | @table @code | |
17474 | @kindex set com1base | |
17475 | @kindex set com1irq | |
17476 | @kindex set com2base | |
17477 | @kindex set com2irq | |
17478 | @kindex set com3base | |
17479 | @kindex set com3irq | |
17480 | @kindex set com4base | |
17481 | @kindex set com4irq | |
17482 | @item set com1base @var{addr} | |
17483 | This command sets the base I/O port address of the @file{COM1} serial | |
17484 | port. | |
17485 | ||
17486 | @item set com1irq @var{irq} | |
17487 | This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use | |
17488 | for the @file{COM1} serial port. | |
17489 | ||
17490 | There are similar commands @samp{set com2base}, @samp{set com3irq}, | |
17491 | etc.@: for setting the port address and the @code{IRQ} lines for the | |
17492 | other 3 COM ports. | |
17493 | ||
17494 | @kindex show com1base | |
17495 | @kindex show com1irq | |
17496 | @kindex show com2base | |
17497 | @kindex show com2irq | |
17498 | @kindex show com3base | |
17499 | @kindex show com3irq | |
17500 | @kindex show com4base | |
17501 | @kindex show com4irq | |
17502 | The related commands @samp{show com1base}, @samp{show com1irq} etc.@: | |
17503 | display the current settings of the base address and the @code{IRQ} | |
17504 | lines used by the COM ports. | |
c45da7e6 EZ |
17505 | |
17506 | @item info serial | |
17507 | @kindex info serial | |
17508 | @cindex DOS serial port status | |
17509 | This command prints the status of the 4 DOS serial ports. For each | |
17510 | port, it prints whether it's active or not, its I/O base address and | |
17511 | IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the | |
17512 | counts of various errors encountered so far. | |
a8f24a35 EZ |
17513 | @end table |
17514 | ||
17515 | ||
78c47bea | 17516 | @node Cygwin Native |
79a6e687 | 17517 | @subsection Features for Debugging MS Windows PE Executables |
78c47bea PM |
17518 | @cindex MS Windows debugging |
17519 | @cindex native Cygwin debugging | |
17520 | @cindex Cygwin-specific commands | |
17521 | ||
be448670 | 17522 | @value{GDBN} supports native debugging of MS Windows programs, including |
cbb8f428 EZ |
17523 | DLLs with and without symbolic debugging information. |
17524 | ||
17525 | @cindex Ctrl-BREAK, MS-Windows | |
17526 | @cindex interrupt debuggee on MS-Windows | |
17527 | MS-Windows programs that call @code{SetConsoleMode} to switch off the | |
17528 | special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted | |
17529 | by typing @kbd{C-c}. For this reason, @value{GDBN} on MS-Windows | |
17530 | supports @kbd{C-@key{BREAK}} as an alternative interrupt key | |
17531 | sequence, which can be used to interrupt the debuggee even if it | |
17532 | ignores @kbd{C-c}. | |
17533 | ||
17534 | There are various additional Cygwin-specific commands, described in | |
17535 | this section. Working with DLLs that have no debugging symbols is | |
17536 | described in @ref{Non-debug DLL Symbols}. | |
78c47bea PM |
17537 | |
17538 | @table @code | |
17539 | @kindex info w32 | |
17540 | @item info w32 | |
db2e3e2e | 17541 | This is a prefix of MS Windows-specific commands which print |
78c47bea PM |
17542 | information about the target system and important OS structures. |
17543 | ||
17544 | @item info w32 selector | |
17545 | This command displays information returned by | |
17546 | the Win32 API @code{GetThreadSelectorEntry} function. | |
17547 | It takes an optional argument that is evaluated to | |
17548 | a long value to give the information about this given selector. | |
17549 | Without argument, this command displays information | |
d3e8051b | 17550 | about the six segment registers. |
78c47bea | 17551 | |
711e434b PM |
17552 | @item info w32 thread-information-block |
17553 | This command displays thread specific information stored in the | |
17554 | Thread Information Block (readable on the X86 CPU family using @code{$fs} | |
17555 | selector for 32-bit programs and @code{$gs} for 64-bit programs). | |
17556 | ||
78c47bea PM |
17557 | @kindex info dll |
17558 | @item info dll | |
db2e3e2e | 17559 | This is a Cygwin-specific alias of @code{info shared}. |
78c47bea PM |
17560 | |
17561 | @kindex dll-symbols | |
17562 | @item dll-symbols | |
17563 | This command loads symbols from a dll similarly to | |
17564 | add-sym command but without the need to specify a base address. | |
17565 | ||
be90c084 | 17566 | @kindex set cygwin-exceptions |
e16b02ee EZ |
17567 | @cindex debugging the Cygwin DLL |
17568 | @cindex Cygwin DLL, debugging | |
be90c084 | 17569 | @item set cygwin-exceptions @var{mode} |
e16b02ee EZ |
17570 | If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that |
17571 | happen inside the Cygwin DLL. If @var{mode} is @code{off}, | |
17572 | @value{GDBN} will delay recognition of exceptions, and may ignore some | |
17573 | exceptions which seem to be caused by internal Cygwin DLL | |
17574 | ``bookkeeping''. This option is meant primarily for debugging the | |
17575 | Cygwin DLL itself; the default value is @code{off} to avoid annoying | |
17576 | @value{GDBN} users with false @code{SIGSEGV} signals. | |
be90c084 CF |
17577 | |
17578 | @kindex show cygwin-exceptions | |
17579 | @item show cygwin-exceptions | |
e16b02ee EZ |
17580 | Displays whether @value{GDBN} will break on exceptions that happen |
17581 | inside the Cygwin DLL itself. | |
be90c084 | 17582 | |
b383017d | 17583 | @kindex set new-console |
78c47bea | 17584 | @item set new-console @var{mode} |
b383017d | 17585 | If @var{mode} is @code{on} the debuggee will |
78c47bea | 17586 | be started in a new console on next start. |
e03e5e7b | 17587 | If @var{mode} is @code{off}, the debuggee will |
78c47bea PM |
17588 | be started in the same console as the debugger. |
17589 | ||
17590 | @kindex show new-console | |
17591 | @item show new-console | |
17592 | Displays whether a new console is used | |
17593 | when the debuggee is started. | |
17594 | ||
17595 | @kindex set new-group | |
17596 | @item set new-group @var{mode} | |
17597 | This boolean value controls whether the debuggee should | |
17598 | start a new group or stay in the same group as the debugger. | |
17599 | This affects the way the Windows OS handles | |
c8aa23ab | 17600 | @samp{Ctrl-C}. |
78c47bea PM |
17601 | |
17602 | @kindex show new-group | |
17603 | @item show new-group | |
17604 | Displays current value of new-group boolean. | |
17605 | ||
17606 | @kindex set debugevents | |
17607 | @item set debugevents | |
219eec71 EZ |
17608 | This boolean value adds debug output concerning kernel events related |
17609 | to the debuggee seen by the debugger. This includes events that | |
17610 | signal thread and process creation and exit, DLL loading and | |
17611 | unloading, console interrupts, and debugging messages produced by the | |
17612 | Windows @code{OutputDebugString} API call. | |
78c47bea PM |
17613 | |
17614 | @kindex set debugexec | |
17615 | @item set debugexec | |
b383017d | 17616 | This boolean value adds debug output concerning execute events |
219eec71 | 17617 | (such as resume thread) seen by the debugger. |
78c47bea PM |
17618 | |
17619 | @kindex set debugexceptions | |
17620 | @item set debugexceptions | |
219eec71 EZ |
17621 | This boolean value adds debug output concerning exceptions in the |
17622 | debuggee seen by the debugger. | |
78c47bea PM |
17623 | |
17624 | @kindex set debugmemory | |
17625 | @item set debugmemory | |
219eec71 EZ |
17626 | This boolean value adds debug output concerning debuggee memory reads |
17627 | and writes by the debugger. | |
78c47bea PM |
17628 | |
17629 | @kindex set shell | |
17630 | @item set shell | |
17631 | This boolean values specifies whether the debuggee is called | |
17632 | via a shell or directly (default value is on). | |
17633 | ||
17634 | @kindex show shell | |
17635 | @item show shell | |
17636 | Displays if the debuggee will be started with a shell. | |
17637 | ||
17638 | @end table | |
17639 | ||
be448670 | 17640 | @menu |
79a6e687 | 17641 | * Non-debug DLL Symbols:: Support for DLLs without debugging symbols |
be448670 CF |
17642 | @end menu |
17643 | ||
79a6e687 BW |
17644 | @node Non-debug DLL Symbols |
17645 | @subsubsection Support for DLLs without Debugging Symbols | |
be448670 CF |
17646 | @cindex DLLs with no debugging symbols |
17647 | @cindex Minimal symbols and DLLs | |
17648 | ||
17649 | Very often on windows, some of the DLLs that your program relies on do | |
17650 | not include symbolic debugging information (for example, | |
db2e3e2e | 17651 | @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging |
be448670 | 17652 | symbols in a DLL, it relies on the minimal amount of symbolic |
db2e3e2e | 17653 | information contained in the DLL's export table. This section |
be448670 CF |
17654 | describes working with such symbols, known internally to @value{GDBN} as |
17655 | ``minimal symbols''. | |
17656 | ||
17657 | Note that before the debugged program has started execution, no DLLs | |
db2e3e2e | 17658 | will have been loaded. The easiest way around this problem is simply to |
be448670 | 17659 | start the program --- either by setting a breakpoint or letting the |
db2e3e2e | 17660 | program run once to completion. It is also possible to force |
be448670 | 17661 | @value{GDBN} to load a particular DLL before starting the executable --- |
12c27660 | 17662 | see the shared library information in @ref{Files}, or the |
db2e3e2e | 17663 | @code{dll-symbols} command in @ref{Cygwin Native}. Currently, |
be448670 CF |
17664 | explicitly loading symbols from a DLL with no debugging information will |
17665 | cause the symbol names to be duplicated in @value{GDBN}'s lookup table, | |
17666 | which may adversely affect symbol lookup performance. | |
17667 | ||
79a6e687 | 17668 | @subsubsection DLL Name Prefixes |
be448670 CF |
17669 | |
17670 | In keeping with the naming conventions used by the Microsoft debugging | |
17671 | tools, DLL export symbols are made available with a prefix based on the | |
17672 | DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is | |
17673 | also entered into the symbol table, so @code{CreateFileA} is often | |
99e008fe | 17674 | sufficient. In some cases there will be name clashes within a program |
be448670 CF |
17675 | (particularly if the executable itself includes full debugging symbols) |
17676 | necessitating the use of the fully qualified name when referring to the | |
99e008fe | 17677 | contents of the DLL. Use single-quotes around the name to avoid the |
be448670 CF |
17678 | exclamation mark (``!'') being interpreted as a language operator. |
17679 | ||
17680 | Note that the internal name of the DLL may be all upper-case, even | |
99e008fe | 17681 | though the file name of the DLL is lower-case, or vice-versa. Since |
be448670 CF |
17682 | symbols within @value{GDBN} are @emph{case-sensitive} this may cause |
17683 | some confusion. If in doubt, try the @code{info functions} and | |
0869d01b NR |
17684 | @code{info variables} commands or even @code{maint print msymbols} |
17685 | (@pxref{Symbols}). Here's an example: | |
be448670 CF |
17686 | |
17687 | @smallexample | |
f7dc1244 | 17688 | (@value{GDBP}) info function CreateFileA |
be448670 CF |
17689 | All functions matching regular expression "CreateFileA": |
17690 | ||
17691 | Non-debugging symbols: | |
17692 | 0x77e885f4 CreateFileA | |
17693 | 0x77e885f4 KERNEL32!CreateFileA | |
17694 | @end smallexample | |
17695 | ||
17696 | @smallexample | |
f7dc1244 | 17697 | (@value{GDBP}) info function ! |
be448670 CF |
17698 | All functions matching regular expression "!": |
17699 | ||
17700 | Non-debugging symbols: | |
17701 | 0x6100114c cygwin1!__assert | |
17702 | 0x61004034 cygwin1!_dll_crt0@@0 | |
17703 | 0x61004240 cygwin1!dll_crt0(per_process *) | |
17704 | [etc...] | |
17705 | @end smallexample | |
17706 | ||
79a6e687 | 17707 | @subsubsection Working with Minimal Symbols |
be448670 CF |
17708 | |
17709 | Symbols extracted from a DLL's export table do not contain very much | |
17710 | type information. All that @value{GDBN} can do is guess whether a symbol | |
17711 | refers to a function or variable depending on the linker section that | |
17712 | contains the symbol. Also note that the actual contents of the memory | |
17713 | contained in a DLL are not available unless the program is running. This | |
17714 | means that you cannot examine the contents of a variable or disassemble | |
17715 | a function within a DLL without a running program. | |
17716 | ||
17717 | Variables are generally treated as pointers and dereferenced | |
17718 | automatically. For this reason, it is often necessary to prefix a | |
17719 | variable name with the address-of operator (``&'') and provide explicit | |
17720 | type information in the command. Here's an example of the type of | |
17721 | problem: | |
17722 | ||
17723 | @smallexample | |
f7dc1244 | 17724 | (@value{GDBP}) print 'cygwin1!__argv' |
be448670 CF |
17725 | $1 = 268572168 |
17726 | @end smallexample | |
17727 | ||
17728 | @smallexample | |
f7dc1244 | 17729 | (@value{GDBP}) x 'cygwin1!__argv' |
be448670 CF |
17730 | 0x10021610: "\230y\"" |
17731 | @end smallexample | |
17732 | ||
17733 | And two possible solutions: | |
17734 | ||
17735 | @smallexample | |
f7dc1244 | 17736 | (@value{GDBP}) print ((char **)'cygwin1!__argv')[0] |
be448670 CF |
17737 | $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram" |
17738 | @end smallexample | |
17739 | ||
17740 | @smallexample | |
f7dc1244 | 17741 | (@value{GDBP}) x/2x &'cygwin1!__argv' |
be448670 | 17742 | 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000 |
f7dc1244 | 17743 | (@value{GDBP}) x/x 0x10021608 |
be448670 | 17744 | 0x10021608: 0x0022fd98 |
f7dc1244 | 17745 | (@value{GDBP}) x/s 0x0022fd98 |
be448670 CF |
17746 | 0x22fd98: "/cygdrive/c/mydirectory/myprogram" |
17747 | @end smallexample | |
17748 | ||
17749 | Setting a break point within a DLL is possible even before the program | |
17750 | starts execution. However, under these circumstances, @value{GDBN} can't | |
17751 | examine the initial instructions of the function in order to skip the | |
17752 | function's frame set-up code. You can work around this by using ``*&'' | |
17753 | to set the breakpoint at a raw memory address: | |
17754 | ||
17755 | @smallexample | |
f7dc1244 | 17756 | (@value{GDBP}) break *&'python22!PyOS_Readline' |
be448670 CF |
17757 | Breakpoint 1 at 0x1e04eff0 |
17758 | @end smallexample | |
17759 | ||
17760 | The author of these extensions is not entirely convinced that setting a | |
17761 | break point within a shared DLL like @file{kernel32.dll} is completely | |
17762 | safe. | |
17763 | ||
14d6dd68 | 17764 | @node Hurd Native |
79a6e687 | 17765 | @subsection Commands Specific to @sc{gnu} Hurd Systems |
14d6dd68 EZ |
17766 | @cindex @sc{gnu} Hurd debugging |
17767 | ||
17768 | This subsection describes @value{GDBN} commands specific to the | |
17769 | @sc{gnu} Hurd native debugging. | |
17770 | ||
17771 | @table @code | |
17772 | @item set signals | |
17773 | @itemx set sigs | |
17774 | @kindex set signals@r{, Hurd command} | |
17775 | @kindex set sigs@r{, Hurd command} | |
17776 | This command toggles the state of inferior signal interception by | |
17777 | @value{GDBN}. Mach exceptions, such as breakpoint traps, are not | |
17778 | affected by this command. @code{sigs} is a shorthand alias for | |
17779 | @code{signals}. | |
17780 | ||
17781 | @item show signals | |
17782 | @itemx show sigs | |
17783 | @kindex show signals@r{, Hurd command} | |
17784 | @kindex show sigs@r{, Hurd command} | |
17785 | Show the current state of intercepting inferior's signals. | |
17786 | ||
17787 | @item set signal-thread | |
17788 | @itemx set sigthread | |
17789 | @kindex set signal-thread | |
17790 | @kindex set sigthread | |
17791 | This command tells @value{GDBN} which thread is the @code{libc} signal | |
17792 | thread. That thread is run when a signal is delivered to a running | |
17793 | process. @code{set sigthread} is the shorthand alias of @code{set | |
17794 | signal-thread}. | |
17795 | ||
17796 | @item show signal-thread | |
17797 | @itemx show sigthread | |
17798 | @kindex show signal-thread | |
17799 | @kindex show sigthread | |
17800 | These two commands show which thread will run when the inferior is | |
17801 | delivered a signal. | |
17802 | ||
17803 | @item set stopped | |
17804 | @kindex set stopped@r{, Hurd command} | |
17805 | This commands tells @value{GDBN} that the inferior process is stopped, | |
17806 | as with the @code{SIGSTOP} signal. The stopped process can be | |
17807 | continued by delivering a signal to it. | |
17808 | ||
17809 | @item show stopped | |
17810 | @kindex show stopped@r{, Hurd command} | |
17811 | This command shows whether @value{GDBN} thinks the debuggee is | |
17812 | stopped. | |
17813 | ||
17814 | @item set exceptions | |
17815 | @kindex set exceptions@r{, Hurd command} | |
17816 | Use this command to turn off trapping of exceptions in the inferior. | |
17817 | When exception trapping is off, neither breakpoints nor | |
17818 | single-stepping will work. To restore the default, set exception | |
17819 | trapping on. | |
17820 | ||
17821 | @item show exceptions | |
17822 | @kindex show exceptions@r{, Hurd command} | |
17823 | Show the current state of trapping exceptions in the inferior. | |
17824 | ||
17825 | @item set task pause | |
17826 | @kindex set task@r{, Hurd commands} | |
17827 | @cindex task attributes (@sc{gnu} Hurd) | |
17828 | @cindex pause current task (@sc{gnu} Hurd) | |
17829 | This command toggles task suspension when @value{GDBN} has control. | |
17830 | Setting it to on takes effect immediately, and the task is suspended | |
17831 | whenever @value{GDBN} gets control. Setting it to off will take | |
17832 | effect the next time the inferior is continued. If this option is set | |
17833 | to off, you can use @code{set thread default pause on} or @code{set | |
17834 | thread pause on} (see below) to pause individual threads. | |
17835 | ||
17836 | @item show task pause | |
17837 | @kindex show task@r{, Hurd commands} | |
17838 | Show the current state of task suspension. | |
17839 | ||
17840 | @item set task detach-suspend-count | |
17841 | @cindex task suspend count | |
17842 | @cindex detach from task, @sc{gnu} Hurd | |
17843 | This command sets the suspend count the task will be left with when | |
17844 | @value{GDBN} detaches from it. | |
17845 | ||
17846 | @item show task detach-suspend-count | |
17847 | Show the suspend count the task will be left with when detaching. | |
17848 | ||
17849 | @item set task exception-port | |
17850 | @itemx set task excp | |
17851 | @cindex task exception port, @sc{gnu} Hurd | |
17852 | This command sets the task exception port to which @value{GDBN} will | |
17853 | forward exceptions. The argument should be the value of the @dfn{send | |
17854 | rights} of the task. @code{set task excp} is a shorthand alias. | |
17855 | ||
17856 | @item set noninvasive | |
17857 | @cindex noninvasive task options | |
17858 | This command switches @value{GDBN} to a mode that is the least | |
17859 | invasive as far as interfering with the inferior is concerned. This | |
17860 | is the same as using @code{set task pause}, @code{set exceptions}, and | |
17861 | @code{set signals} to values opposite to the defaults. | |
17862 | ||
17863 | @item info send-rights | |
17864 | @itemx info receive-rights | |
17865 | @itemx info port-rights | |
17866 | @itemx info port-sets | |
17867 | @itemx info dead-names | |
17868 | @itemx info ports | |
17869 | @itemx info psets | |
17870 | @cindex send rights, @sc{gnu} Hurd | |
17871 | @cindex receive rights, @sc{gnu} Hurd | |
17872 | @cindex port rights, @sc{gnu} Hurd | |
17873 | @cindex port sets, @sc{gnu} Hurd | |
17874 | @cindex dead names, @sc{gnu} Hurd | |
17875 | These commands display information about, respectively, send rights, | |
17876 | receive rights, port rights, port sets, and dead names of a task. | |
17877 | There are also shorthand aliases: @code{info ports} for @code{info | |
17878 | port-rights} and @code{info psets} for @code{info port-sets}. | |
17879 | ||
17880 | @item set thread pause | |
17881 | @kindex set thread@r{, Hurd command} | |
17882 | @cindex thread properties, @sc{gnu} Hurd | |
17883 | @cindex pause current thread (@sc{gnu} Hurd) | |
17884 | This command toggles current thread suspension when @value{GDBN} has | |
17885 | control. Setting it to on takes effect immediately, and the current | |
17886 | thread is suspended whenever @value{GDBN} gets control. Setting it to | |
17887 | off will take effect the next time the inferior is continued. | |
17888 | Normally, this command has no effect, since when @value{GDBN} has | |
17889 | control, the whole task is suspended. However, if you used @code{set | |
17890 | task pause off} (see above), this command comes in handy to suspend | |
17891 | only the current thread. | |
17892 | ||
17893 | @item show thread pause | |
17894 | @kindex show thread@r{, Hurd command} | |
17895 | This command shows the state of current thread suspension. | |
17896 | ||
17897 | @item set thread run | |
d3e8051b | 17898 | This command sets whether the current thread is allowed to run. |
14d6dd68 EZ |
17899 | |
17900 | @item show thread run | |
17901 | Show whether the current thread is allowed to run. | |
17902 | ||
17903 | @item set thread detach-suspend-count | |
17904 | @cindex thread suspend count, @sc{gnu} Hurd | |
17905 | @cindex detach from thread, @sc{gnu} Hurd | |
17906 | This command sets the suspend count @value{GDBN} will leave on a | |
17907 | thread when detaching. This number is relative to the suspend count | |
17908 | found by @value{GDBN} when it notices the thread; use @code{set thread | |
17909 | takeover-suspend-count} to force it to an absolute value. | |
17910 | ||
17911 | @item show thread detach-suspend-count | |
17912 | Show the suspend count @value{GDBN} will leave on the thread when | |
17913 | detaching. | |
17914 | ||
17915 | @item set thread exception-port | |
17916 | @itemx set thread excp | |
17917 | Set the thread exception port to which to forward exceptions. This | |
17918 | overrides the port set by @code{set task exception-port} (see above). | |
17919 | @code{set thread excp} is the shorthand alias. | |
17920 | ||
17921 | @item set thread takeover-suspend-count | |
17922 | Normally, @value{GDBN}'s thread suspend counts are relative to the | |
17923 | value @value{GDBN} finds when it notices each thread. This command | |
17924 | changes the suspend counts to be absolute instead. | |
17925 | ||
17926 | @item set thread default | |
17927 | @itemx show thread default | |
17928 | @cindex thread default settings, @sc{gnu} Hurd | |
17929 | Each of the above @code{set thread} commands has a @code{set thread | |
17930 | default} counterpart (e.g., @code{set thread default pause}, @code{set | |
17931 | thread default exception-port}, etc.). The @code{thread default} | |
17932 | variety of commands sets the default thread properties for all | |
17933 | threads; you can then change the properties of individual threads with | |
17934 | the non-default commands. | |
17935 | @end table | |
17936 | ||
17937 | ||
a64548ea EZ |
17938 | @node Neutrino |
17939 | @subsection QNX Neutrino | |
17940 | @cindex QNX Neutrino | |
17941 | ||
17942 | @value{GDBN} provides the following commands specific to the QNX | |
17943 | Neutrino target: | |
17944 | ||
17945 | @table @code | |
17946 | @item set debug nto-debug | |
17947 | @kindex set debug nto-debug | |
17948 | When set to on, enables debugging messages specific to the QNX | |
17949 | Neutrino support. | |
17950 | ||
17951 | @item show debug nto-debug | |
17952 | @kindex show debug nto-debug | |
17953 | Show the current state of QNX Neutrino messages. | |
17954 | @end table | |
17955 | ||
a80b95ba TG |
17956 | @node Darwin |
17957 | @subsection Darwin | |
17958 | @cindex Darwin | |
17959 | ||
17960 | @value{GDBN} provides the following commands specific to the Darwin target: | |
17961 | ||
17962 | @table @code | |
17963 | @item set debug darwin @var{num} | |
17964 | @kindex set debug darwin | |
17965 | When set to a non zero value, enables debugging messages specific to | |
17966 | the Darwin support. Higher values produce more verbose output. | |
17967 | ||
17968 | @item show debug darwin | |
17969 | @kindex show debug darwin | |
17970 | Show the current state of Darwin messages. | |
17971 | ||
17972 | @item set debug mach-o @var{num} | |
17973 | @kindex set debug mach-o | |
17974 | When set to a non zero value, enables debugging messages while | |
17975 | @value{GDBN} is reading Darwin object files. (@dfn{Mach-O} is the | |
17976 | file format used on Darwin for object and executable files.) Higher | |
17977 | values produce more verbose output. This is a command to diagnose | |
17978 | problems internal to @value{GDBN} and should not be needed in normal | |
17979 | usage. | |
17980 | ||
17981 | @item show debug mach-o | |
17982 | @kindex show debug mach-o | |
17983 | Show the current state of Mach-O file messages. | |
17984 | ||
17985 | @item set mach-exceptions on | |
17986 | @itemx set mach-exceptions off | |
17987 | @kindex set mach-exceptions | |
17988 | On Darwin, faults are first reported as a Mach exception and are then | |
17989 | mapped to a Posix signal. Use this command to turn on trapping of | |
17990 | Mach exceptions in the inferior. This might be sometimes useful to | |
17991 | better understand the cause of a fault. The default is off. | |
17992 | ||
17993 | @item show mach-exceptions | |
17994 | @kindex show mach-exceptions | |
17995 | Show the current state of exceptions trapping. | |
17996 | @end table | |
17997 | ||
a64548ea | 17998 | |
8e04817f AC |
17999 | @node Embedded OS |
18000 | @section Embedded Operating Systems | |
104c1213 | 18001 | |
8e04817f AC |
18002 | This section describes configurations involving the debugging of |
18003 | embedded operating systems that are available for several different | |
18004 | architectures. | |
d4f3574e | 18005 | |
8e04817f AC |
18006 | @menu |
18007 | * VxWorks:: Using @value{GDBN} with VxWorks | |
18008 | @end menu | |
104c1213 | 18009 | |
8e04817f AC |
18010 | @value{GDBN} includes the ability to debug programs running on |
18011 | various real-time operating systems. | |
104c1213 | 18012 | |
8e04817f AC |
18013 | @node VxWorks |
18014 | @subsection Using @value{GDBN} with VxWorks | |
104c1213 | 18015 | |
8e04817f | 18016 | @cindex VxWorks |
104c1213 | 18017 | |
8e04817f | 18018 | @table @code |
104c1213 | 18019 | |
8e04817f AC |
18020 | @kindex target vxworks |
18021 | @item target vxworks @var{machinename} | |
18022 | A VxWorks system, attached via TCP/IP. The argument @var{machinename} | |
18023 | is the target system's machine name or IP address. | |
104c1213 | 18024 | |
8e04817f | 18025 | @end table |
104c1213 | 18026 | |
8e04817f AC |
18027 | On VxWorks, @code{load} links @var{filename} dynamically on the |
18028 | current target system as well as adding its symbols in @value{GDBN}. | |
104c1213 | 18029 | |
8e04817f AC |
18030 | @value{GDBN} enables developers to spawn and debug tasks running on networked |
18031 | VxWorks targets from a Unix host. Already-running tasks spawned from | |
18032 | the VxWorks shell can also be debugged. @value{GDBN} uses code that runs on | |
18033 | both the Unix host and on the VxWorks target. The program | |
18034 | @code{@value{GDBP}} is installed and executed on the Unix host. (It may be | |
18035 | installed with the name @code{vxgdb}, to distinguish it from a | |
18036 | @value{GDBN} for debugging programs on the host itself.) | |
104c1213 | 18037 | |
8e04817f AC |
18038 | @table @code |
18039 | @item VxWorks-timeout @var{args} | |
18040 | @kindex vxworks-timeout | |
18041 | All VxWorks-based targets now support the option @code{vxworks-timeout}. | |
18042 | This option is set by the user, and @var{args} represents the number of | |
18043 | seconds @value{GDBN} waits for responses to rpc's. You might use this if | |
18044 | your VxWorks target is a slow software simulator or is on the far side | |
18045 | of a thin network line. | |
18046 | @end table | |
104c1213 | 18047 | |
8e04817f AC |
18048 | The following information on connecting to VxWorks was current when |
18049 | this manual was produced; newer releases of VxWorks may use revised | |
18050 | procedures. | |
104c1213 | 18051 | |
4644b6e3 | 18052 | @findex INCLUDE_RDB |
8e04817f AC |
18053 | To use @value{GDBN} with VxWorks, you must rebuild your VxWorks kernel |
18054 | to include the remote debugging interface routines in the VxWorks | |
18055 | library @file{rdb.a}. To do this, define @code{INCLUDE_RDB} in the | |
18056 | VxWorks configuration file @file{configAll.h} and rebuild your VxWorks | |
18057 | kernel. The resulting kernel contains @file{rdb.a}, and spawns the | |
18058 | source debugging task @code{tRdbTask} when VxWorks is booted. For more | |
18059 | information on configuring and remaking VxWorks, see the manufacturer's | |
18060 | manual. | |
18061 | @c VxWorks, see the @cite{VxWorks Programmer's Guide}. | |
104c1213 | 18062 | |
8e04817f AC |
18063 | Once you have included @file{rdb.a} in your VxWorks system image and set |
18064 | your Unix execution search path to find @value{GDBN}, you are ready to | |
18065 | run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} (or | |
18066 | @code{vxgdb}, depending on your installation). | |
104c1213 | 18067 | |
8e04817f | 18068 | @value{GDBN} comes up showing the prompt: |
104c1213 | 18069 | |
474c8240 | 18070 | @smallexample |
8e04817f | 18071 | (vxgdb) |
474c8240 | 18072 | @end smallexample |
104c1213 | 18073 | |
8e04817f AC |
18074 | @menu |
18075 | * VxWorks Connection:: Connecting to VxWorks | |
18076 | * VxWorks Download:: VxWorks download | |
18077 | * VxWorks Attach:: Running tasks | |
18078 | @end menu | |
104c1213 | 18079 | |
8e04817f AC |
18080 | @node VxWorks Connection |
18081 | @subsubsection Connecting to VxWorks | |
104c1213 | 18082 | |
8e04817f AC |
18083 | The @value{GDBN} command @code{target} lets you connect to a VxWorks target on the |
18084 | network. To connect to a target whose host name is ``@code{tt}'', type: | |
104c1213 | 18085 | |
474c8240 | 18086 | @smallexample |
8e04817f | 18087 | (vxgdb) target vxworks tt |
474c8240 | 18088 | @end smallexample |
104c1213 | 18089 | |
8e04817f AC |
18090 | @need 750 |
18091 | @value{GDBN} displays messages like these: | |
104c1213 | 18092 | |
8e04817f AC |
18093 | @smallexample |
18094 | Attaching remote machine across net... | |
18095 | Connected to tt. | |
18096 | @end smallexample | |
104c1213 | 18097 | |
8e04817f AC |
18098 | @need 1000 |
18099 | @value{GDBN} then attempts to read the symbol tables of any object modules | |
18100 | loaded into the VxWorks target since it was last booted. @value{GDBN} locates | |
18101 | these files by searching the directories listed in the command search | |
79a6e687 | 18102 | path (@pxref{Environment, ,Your Program's Environment}); if it fails |
8e04817f | 18103 | to find an object file, it displays a message such as: |
5d161b24 | 18104 | |
474c8240 | 18105 | @smallexample |
8e04817f | 18106 | prog.o: No such file or directory. |
474c8240 | 18107 | @end smallexample |
104c1213 | 18108 | |
8e04817f AC |
18109 | When this happens, add the appropriate directory to the search path with |
18110 | the @value{GDBN} command @code{path}, and execute the @code{target} | |
18111 | command again. | |
104c1213 | 18112 | |
8e04817f | 18113 | @node VxWorks Download |
79a6e687 | 18114 | @subsubsection VxWorks Download |
104c1213 | 18115 | |
8e04817f AC |
18116 | @cindex download to VxWorks |
18117 | If you have connected to the VxWorks target and you want to debug an | |
18118 | object that has not yet been loaded, you can use the @value{GDBN} | |
18119 | @code{load} command to download a file from Unix to VxWorks | |
18120 | incrementally. The object file given as an argument to the @code{load} | |
18121 | command is actually opened twice: first by the VxWorks target in order | |
18122 | to download the code, then by @value{GDBN} in order to read the symbol | |
18123 | table. This can lead to problems if the current working directories on | |
18124 | the two systems differ. If both systems have NFS mounted the same | |
18125 | filesystems, you can avoid these problems by using absolute paths. | |
18126 | Otherwise, it is simplest to set the working directory on both systems | |
18127 | to the directory in which the object file resides, and then to reference | |
18128 | the file by its name, without any path. For instance, a program | |
18129 | @file{prog.o} may reside in @file{@var{vxpath}/vw/demo/rdb} in VxWorks | |
18130 | and in @file{@var{hostpath}/vw/demo/rdb} on the host. To load this | |
18131 | program, type this on VxWorks: | |
104c1213 | 18132 | |
474c8240 | 18133 | @smallexample |
8e04817f | 18134 | -> cd "@var{vxpath}/vw/demo/rdb" |
474c8240 | 18135 | @end smallexample |
104c1213 | 18136 | |
8e04817f AC |
18137 | @noindent |
18138 | Then, in @value{GDBN}, type: | |
104c1213 | 18139 | |
474c8240 | 18140 | @smallexample |
8e04817f AC |
18141 | (vxgdb) cd @var{hostpath}/vw/demo/rdb |
18142 | (vxgdb) load prog.o | |
474c8240 | 18143 | @end smallexample |
104c1213 | 18144 | |
8e04817f | 18145 | @value{GDBN} displays a response similar to this: |
104c1213 | 18146 | |
8e04817f AC |
18147 | @smallexample |
18148 | Reading symbol data from wherever/vw/demo/rdb/prog.o... done. | |
18149 | @end smallexample | |
104c1213 | 18150 | |
8e04817f AC |
18151 | You can also use the @code{load} command to reload an object module |
18152 | after editing and recompiling the corresponding source file. Note that | |
18153 | this makes @value{GDBN} delete all currently-defined breakpoints, | |
18154 | auto-displays, and convenience variables, and to clear the value | |
18155 | history. (This is necessary in order to preserve the integrity of | |
18156 | debugger's data structures that reference the target system's symbol | |
18157 | table.) | |
104c1213 | 18158 | |
8e04817f | 18159 | @node VxWorks Attach |
79a6e687 | 18160 | @subsubsection Running Tasks |
104c1213 JM |
18161 | |
18162 | @cindex running VxWorks tasks | |
18163 | You can also attach to an existing task using the @code{attach} command as | |
18164 | follows: | |
18165 | ||
474c8240 | 18166 | @smallexample |
104c1213 | 18167 | (vxgdb) attach @var{task} |
474c8240 | 18168 | @end smallexample |
104c1213 JM |
18169 | |
18170 | @noindent | |
18171 | where @var{task} is the VxWorks hexadecimal task ID. The task can be running | |
18172 | or suspended when you attach to it. Running tasks are suspended at | |
18173 | the time of attachment. | |
18174 | ||
6d2ebf8b | 18175 | @node Embedded Processors |
104c1213 JM |
18176 | @section Embedded Processors |
18177 | ||
18178 | This section goes into details specific to particular embedded | |
18179 | configurations. | |
18180 | ||
c45da7e6 EZ |
18181 | @cindex send command to simulator |
18182 | Whenever a specific embedded processor has a simulator, @value{GDBN} | |
18183 | allows to send an arbitrary command to the simulator. | |
18184 | ||
18185 | @table @code | |
18186 | @item sim @var{command} | |
18187 | @kindex sim@r{, a command} | |
18188 | Send an arbitrary @var{command} string to the simulator. Consult the | |
18189 | documentation for the specific simulator in use for information about | |
18190 | acceptable commands. | |
18191 | @end table | |
18192 | ||
7d86b5d5 | 18193 | |
104c1213 | 18194 | @menu |
c45da7e6 | 18195 | * ARM:: ARM RDI |
172c2a43 | 18196 | * M32R/D:: Renesas M32R/D |
104c1213 | 18197 | * M68K:: Motorola M68K |
08be9d71 | 18198 | * MicroBlaze:: Xilinx MicroBlaze |
104c1213 | 18199 | * MIPS Embedded:: MIPS Embedded |
a37295f9 | 18200 | * OpenRISC 1000:: OpenRisc 1000 |
104c1213 | 18201 | * PA:: HP PA Embedded |
4acd40f3 | 18202 | * PowerPC Embedded:: PowerPC Embedded |
104c1213 JM |
18203 | * Sparclet:: Tsqware Sparclet |
18204 | * Sparclite:: Fujitsu Sparclite | |
104c1213 | 18205 | * Z8000:: Zilog Z8000 |
a64548ea EZ |
18206 | * AVR:: Atmel AVR |
18207 | * CRIS:: CRIS | |
18208 | * Super-H:: Renesas Super-H | |
104c1213 JM |
18209 | @end menu |
18210 | ||
6d2ebf8b | 18211 | @node ARM |
104c1213 | 18212 | @subsection ARM |
c45da7e6 | 18213 | @cindex ARM RDI |
104c1213 JM |
18214 | |
18215 | @table @code | |
8e04817f AC |
18216 | @kindex target rdi |
18217 | @item target rdi @var{dev} | |
18218 | ARM Angel monitor, via RDI library interface to ADP protocol. You may | |
18219 | use this target to communicate with both boards running the Angel | |
18220 | monitor, or with the EmbeddedICE JTAG debug device. | |
18221 | ||
18222 | @kindex target rdp | |
18223 | @item target rdp @var{dev} | |
18224 | ARM Demon monitor. | |
18225 | ||
18226 | @end table | |
18227 | ||
e2f4edfd EZ |
18228 | @value{GDBN} provides the following ARM-specific commands: |
18229 | ||
18230 | @table @code | |
18231 | @item set arm disassembler | |
18232 | @kindex set arm | |
18233 | This commands selects from a list of disassembly styles. The | |
18234 | @code{"std"} style is the standard style. | |
18235 | ||
18236 | @item show arm disassembler | |
18237 | @kindex show arm | |
18238 | Show the current disassembly style. | |
18239 | ||
18240 | @item set arm apcs32 | |
18241 | @cindex ARM 32-bit mode | |
18242 | This command toggles ARM operation mode between 32-bit and 26-bit. | |
18243 | ||
18244 | @item show arm apcs32 | |
18245 | Display the current usage of the ARM 32-bit mode. | |
18246 | ||
18247 | @item set arm fpu @var{fputype} | |
18248 | This command sets the ARM floating-point unit (FPU) type. The | |
18249 | argument @var{fputype} can be one of these: | |
18250 | ||
18251 | @table @code | |
18252 | @item auto | |
18253 | Determine the FPU type by querying the OS ABI. | |
18254 | @item softfpa | |
18255 | Software FPU, with mixed-endian doubles on little-endian ARM | |
18256 | processors. | |
18257 | @item fpa | |
18258 | GCC-compiled FPA co-processor. | |
18259 | @item softvfp | |
18260 | Software FPU with pure-endian doubles. | |
18261 | @item vfp | |
18262 | VFP co-processor. | |
18263 | @end table | |
18264 | ||
18265 | @item show arm fpu | |
18266 | Show the current type of the FPU. | |
18267 | ||
18268 | @item set arm abi | |
18269 | This command forces @value{GDBN} to use the specified ABI. | |
18270 | ||
18271 | @item show arm abi | |
18272 | Show the currently used ABI. | |
18273 | ||
0428b8f5 DJ |
18274 | @item set arm fallback-mode (arm|thumb|auto) |
18275 | @value{GDBN} uses the symbol table, when available, to determine | |
18276 | whether instructions are ARM or Thumb. This command controls | |
18277 | @value{GDBN}'s default behavior when the symbol table is not | |
18278 | available. The default is @samp{auto}, which causes @value{GDBN} to | |
18279 | use the current execution mode (from the @code{T} bit in the @code{CPSR} | |
18280 | register). | |
18281 | ||
18282 | @item show arm fallback-mode | |
18283 | Show the current fallback instruction mode. | |
18284 | ||
18285 | @item set arm force-mode (arm|thumb|auto) | |
18286 | This command overrides use of the symbol table to determine whether | |
18287 | instructions are ARM or Thumb. The default is @samp{auto}, which | |
18288 | causes @value{GDBN} to use the symbol table and then the setting | |
18289 | of @samp{set arm fallback-mode}. | |
18290 | ||
18291 | @item show arm force-mode | |
18292 | Show the current forced instruction mode. | |
18293 | ||
e2f4edfd EZ |
18294 | @item set debug arm |
18295 | Toggle whether to display ARM-specific debugging messages from the ARM | |
18296 | target support subsystem. | |
18297 | ||
18298 | @item show debug arm | |
18299 | Show whether ARM-specific debugging messages are enabled. | |
18300 | @end table | |
18301 | ||
c45da7e6 EZ |
18302 | The following commands are available when an ARM target is debugged |
18303 | using the RDI interface: | |
18304 | ||
18305 | @table @code | |
18306 | @item rdilogfile @r{[}@var{file}@r{]} | |
18307 | @kindex rdilogfile | |
18308 | @cindex ADP (Angel Debugger Protocol) logging | |
18309 | Set the filename for the ADP (Angel Debugger Protocol) packet log. | |
18310 | With an argument, sets the log file to the specified @var{file}. With | |
18311 | no argument, show the current log file name. The default log file is | |
18312 | @file{rdi.log}. | |
18313 | ||
18314 | @item rdilogenable @r{[}@var{arg}@r{]} | |
18315 | @kindex rdilogenable | |
18316 | Control logging of ADP packets. With an argument of 1 or @code{"yes"} | |
18317 | enables logging, with an argument 0 or @code{"no"} disables it. With | |
18318 | no arguments displays the current setting. When logging is enabled, | |
18319 | ADP packets exchanged between @value{GDBN} and the RDI target device | |
18320 | are logged to a file. | |
18321 | ||
18322 | @item set rdiromatzero | |
18323 | @kindex set rdiromatzero | |
18324 | @cindex ROM at zero address, RDI | |
18325 | Tell @value{GDBN} whether the target has ROM at address 0. If on, | |
18326 | vector catching is disabled, so that zero address can be used. If off | |
18327 | (the default), vector catching is enabled. For this command to take | |
18328 | effect, it needs to be invoked prior to the @code{target rdi} command. | |
18329 | ||
18330 | @item show rdiromatzero | |
18331 | @kindex show rdiromatzero | |
18332 | Show the current setting of ROM at zero address. | |
18333 | ||
18334 | @item set rdiheartbeat | |
18335 | @kindex set rdiheartbeat | |
18336 | @cindex RDI heartbeat | |
18337 | Enable or disable RDI heartbeat packets. It is not recommended to | |
18338 | turn on this option, since it confuses ARM and EPI JTAG interface, as | |
18339 | well as the Angel monitor. | |
18340 | ||
18341 | @item show rdiheartbeat | |
18342 | @kindex show rdiheartbeat | |
18343 | Show the setting of RDI heartbeat packets. | |
18344 | @end table | |
18345 | ||
ee8e71d4 EZ |
18346 | @table @code |
18347 | @item target sim @r{[}@var{simargs}@r{]} @dots{} | |
18348 | The @value{GDBN} ARM simulator accepts the following optional arguments. | |
18349 | ||
18350 | @table @code | |
18351 | @item --swi-support=@var{type} | |
18352 | Tell the simulator which SWI interfaces to support. | |
18353 | @var{type} may be a comma separated list of the following values. | |
18354 | The default value is @code{all}. | |
18355 | ||
18356 | @table @code | |
18357 | @item none | |
18358 | @item demon | |
18359 | @item angel | |
18360 | @item redboot | |
18361 | @item all | |
18362 | @end table | |
18363 | @end table | |
18364 | @end table | |
e2f4edfd | 18365 | |
8e04817f | 18366 | @node M32R/D |
ba04e063 | 18367 | @subsection Renesas M32R/D and M32R/SDI |
8e04817f AC |
18368 | |
18369 | @table @code | |
8e04817f AC |
18370 | @kindex target m32r |
18371 | @item target m32r @var{dev} | |
172c2a43 | 18372 | Renesas M32R/D ROM monitor. |
8e04817f | 18373 | |
fb3e19c0 KI |
18374 | @kindex target m32rsdi |
18375 | @item target m32rsdi @var{dev} | |
18376 | Renesas M32R SDI server, connected via parallel port to the board. | |
721c2651 EZ |
18377 | @end table |
18378 | ||
18379 | The following @value{GDBN} commands are specific to the M32R monitor: | |
18380 | ||
18381 | @table @code | |
18382 | @item set download-path @var{path} | |
18383 | @kindex set download-path | |
18384 | @cindex find downloadable @sc{srec} files (M32R) | |
d3e8051b | 18385 | Set the default path for finding downloadable @sc{srec} files. |
721c2651 EZ |
18386 | |
18387 | @item show download-path | |
18388 | @kindex show download-path | |
18389 | Show the default path for downloadable @sc{srec} files. | |
fb3e19c0 | 18390 | |
721c2651 EZ |
18391 | @item set board-address @var{addr} |
18392 | @kindex set board-address | |
18393 | @cindex M32-EVA target board address | |
18394 | Set the IP address for the M32R-EVA target board. | |
18395 | ||
18396 | @item show board-address | |
18397 | @kindex show board-address | |
18398 | Show the current IP address of the target board. | |
18399 | ||
18400 | @item set server-address @var{addr} | |
18401 | @kindex set server-address | |
18402 | @cindex download server address (M32R) | |
18403 | Set the IP address for the download server, which is the @value{GDBN}'s | |
18404 | host machine. | |
18405 | ||
18406 | @item show server-address | |
18407 | @kindex show server-address | |
18408 | Display the IP address of the download server. | |
18409 | ||
18410 | @item upload @r{[}@var{file}@r{]} | |
18411 | @kindex upload@r{, M32R} | |
18412 | Upload the specified @sc{srec} @var{file} via the monitor's Ethernet | |
18413 | upload capability. If no @var{file} argument is given, the current | |
18414 | executable file is uploaded. | |
18415 | ||
18416 | @item tload @r{[}@var{file}@r{]} | |
18417 | @kindex tload@r{, M32R} | |
18418 | Test the @code{upload} command. | |
8e04817f AC |
18419 | @end table |
18420 | ||
ba04e063 EZ |
18421 | The following commands are available for M32R/SDI: |
18422 | ||
18423 | @table @code | |
18424 | @item sdireset | |
18425 | @kindex sdireset | |
18426 | @cindex reset SDI connection, M32R | |
18427 | This command resets the SDI connection. | |
18428 | ||
18429 | @item sdistatus | |
18430 | @kindex sdistatus | |
18431 | This command shows the SDI connection status. | |
18432 | ||
18433 | @item debug_chaos | |
18434 | @kindex debug_chaos | |
18435 | @cindex M32R/Chaos debugging | |
18436 | Instructs the remote that M32R/Chaos debugging is to be used. | |
18437 | ||
18438 | @item use_debug_dma | |
18439 | @kindex use_debug_dma | |
18440 | Instructs the remote to use the DEBUG_DMA method of accessing memory. | |
18441 | ||
18442 | @item use_mon_code | |
18443 | @kindex use_mon_code | |
18444 | Instructs the remote to use the MON_CODE method of accessing memory. | |
18445 | ||
18446 | @item use_ib_break | |
18447 | @kindex use_ib_break | |
18448 | Instructs the remote to set breakpoints by IB break. | |
18449 | ||
18450 | @item use_dbt_break | |
18451 | @kindex use_dbt_break | |
18452 | Instructs the remote to set breakpoints by DBT. | |
18453 | @end table | |
18454 | ||
8e04817f AC |
18455 | @node M68K |
18456 | @subsection M68k | |
18457 | ||
7ce59000 DJ |
18458 | The Motorola m68k configuration includes ColdFire support, and a |
18459 | target command for the following ROM monitor. | |
8e04817f AC |
18460 | |
18461 | @table @code | |
18462 | ||
8e04817f AC |
18463 | @kindex target dbug |
18464 | @item target dbug @var{dev} | |
18465 | dBUG ROM monitor for Motorola ColdFire. | |
18466 | ||
8e04817f AC |
18467 | @end table |
18468 | ||
08be9d71 ME |
18469 | @node MicroBlaze |
18470 | @subsection MicroBlaze | |
18471 | @cindex Xilinx MicroBlaze | |
18472 | @cindex XMD, Xilinx Microprocessor Debugger | |
18473 | ||
18474 | The MicroBlaze is a soft-core processor supported on various Xilinx | |
18475 | FPGAs, such as Spartan or Virtex series. Boards with these processors | |
18476 | usually have JTAG ports which connect to a host system running the Xilinx | |
18477 | Embedded Development Kit (EDK) or Software Development Kit (SDK). | |
18478 | This host system is used to download the configuration bitstream to | |
18479 | the target FPGA. The Xilinx Microprocessor Debugger (XMD) program | |
18480 | communicates with the target board using the JTAG interface and | |
18481 | presents a @code{gdbserver} interface to the board. By default | |
18482 | @code{xmd} uses port @code{1234}. (While it is possible to change | |
18483 | this default port, it requires the use of undocumented @code{xmd} | |
18484 | commands. Contact Xilinx support if you need to do this.) | |
18485 | ||
18486 | Use these GDB commands to connect to the MicroBlaze target processor. | |
18487 | ||
18488 | @table @code | |
18489 | @item target remote :1234 | |
18490 | Use this command to connect to the target if you are running @value{GDBN} | |
18491 | on the same system as @code{xmd}. | |
18492 | ||
18493 | @item target remote @var{xmd-host}:1234 | |
18494 | Use this command to connect to the target if it is connected to @code{xmd} | |
18495 | running on a different system named @var{xmd-host}. | |
18496 | ||
18497 | @item load | |
18498 | Use this command to download a program to the MicroBlaze target. | |
18499 | ||
18500 | @item set debug microblaze @var{n} | |
18501 | Enable MicroBlaze-specific debugging messages if non-zero. | |
18502 | ||
18503 | @item show debug microblaze @var{n} | |
18504 | Show MicroBlaze-specific debugging level. | |
18505 | @end table | |
18506 | ||
8e04817f AC |
18507 | @node MIPS Embedded |
18508 | @subsection MIPS Embedded | |
18509 | ||
18510 | @cindex MIPS boards | |
18511 | @value{GDBN} can use the MIPS remote debugging protocol to talk to a | |
18512 | MIPS board attached to a serial line. This is available when | |
18513 | you configure @value{GDBN} with @samp{--target=mips-idt-ecoff}. | |
104c1213 | 18514 | |
8e04817f AC |
18515 | @need 1000 |
18516 | Use these @value{GDBN} commands to specify the connection to your target board: | |
104c1213 | 18517 | |
8e04817f AC |
18518 | @table @code |
18519 | @item target mips @var{port} | |
18520 | @kindex target mips @var{port} | |
18521 | To run a program on the board, start up @code{@value{GDBP}} with the | |
18522 | name of your program as the argument. To connect to the board, use the | |
18523 | command @samp{target mips @var{port}}, where @var{port} is the name of | |
18524 | the serial port connected to the board. If the program has not already | |
18525 | been downloaded to the board, you may use the @code{load} command to | |
18526 | download it. You can then use all the usual @value{GDBN} commands. | |
104c1213 | 18527 | |
8e04817f AC |
18528 | For example, this sequence connects to the target board through a serial |
18529 | port, and loads and runs a program called @var{prog} through the | |
18530 | debugger: | |
104c1213 | 18531 | |
474c8240 | 18532 | @smallexample |
8e04817f AC |
18533 | host$ @value{GDBP} @var{prog} |
18534 | @value{GDBN} is free software and @dots{} | |
18535 | (@value{GDBP}) target mips /dev/ttyb | |
18536 | (@value{GDBP}) load @var{prog} | |
18537 | (@value{GDBP}) run | |
474c8240 | 18538 | @end smallexample |
104c1213 | 18539 | |
8e04817f AC |
18540 | @item target mips @var{hostname}:@var{portnumber} |
18541 | On some @value{GDBN} host configurations, you can specify a TCP | |
18542 | connection (for instance, to a serial line managed by a terminal | |
18543 | concentrator) instead of a serial port, using the syntax | |
18544 | @samp{@var{hostname}:@var{portnumber}}. | |
104c1213 | 18545 | |
8e04817f AC |
18546 | @item target pmon @var{port} |
18547 | @kindex target pmon @var{port} | |
18548 | PMON ROM monitor. | |
104c1213 | 18549 | |
8e04817f AC |
18550 | @item target ddb @var{port} |
18551 | @kindex target ddb @var{port} | |
18552 | NEC's DDB variant of PMON for Vr4300. | |
104c1213 | 18553 | |
8e04817f AC |
18554 | @item target lsi @var{port} |
18555 | @kindex target lsi @var{port} | |
18556 | LSI variant of PMON. | |
104c1213 | 18557 | |
8e04817f AC |
18558 | @kindex target r3900 |
18559 | @item target r3900 @var{dev} | |
18560 | Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips. | |
104c1213 | 18561 | |
8e04817f AC |
18562 | @kindex target array |
18563 | @item target array @var{dev} | |
18564 | Array Tech LSI33K RAID controller board. | |
104c1213 | 18565 | |
8e04817f | 18566 | @end table |
104c1213 | 18567 | |
104c1213 | 18568 | |
8e04817f AC |
18569 | @noindent |
18570 | @value{GDBN} also supports these special commands for MIPS targets: | |
104c1213 | 18571 | |
8e04817f | 18572 | @table @code |
8e04817f AC |
18573 | @item set mipsfpu double |
18574 | @itemx set mipsfpu single | |
18575 | @itemx set mipsfpu none | |
a64548ea | 18576 | @itemx set mipsfpu auto |
8e04817f AC |
18577 | @itemx show mipsfpu |
18578 | @kindex set mipsfpu | |
18579 | @kindex show mipsfpu | |
18580 | @cindex MIPS remote floating point | |
18581 | @cindex floating point, MIPS remote | |
18582 | If your target board does not support the MIPS floating point | |
18583 | coprocessor, you should use the command @samp{set mipsfpu none} (if you | |
18584 | need this, you may wish to put the command in your @value{GDBN} init | |
18585 | file). This tells @value{GDBN} how to find the return value of | |
18586 | functions which return floating point values. It also allows | |
18587 | @value{GDBN} to avoid saving the floating point registers when calling | |
18588 | functions on the board. If you are using a floating point coprocessor | |
18589 | with only single precision floating point support, as on the @sc{r4650} | |
18590 | processor, use the command @samp{set mipsfpu single}. The default | |
18591 | double precision floating point coprocessor may be selected using | |
18592 | @samp{set mipsfpu double}. | |
104c1213 | 18593 | |
8e04817f AC |
18594 | In previous versions the only choices were double precision or no |
18595 | floating point, so @samp{set mipsfpu on} will select double precision | |
18596 | and @samp{set mipsfpu off} will select no floating point. | |
104c1213 | 18597 | |
8e04817f AC |
18598 | As usual, you can inquire about the @code{mipsfpu} variable with |
18599 | @samp{show mipsfpu}. | |
104c1213 | 18600 | |
8e04817f AC |
18601 | @item set timeout @var{seconds} |
18602 | @itemx set retransmit-timeout @var{seconds} | |
18603 | @itemx show timeout | |
18604 | @itemx show retransmit-timeout | |
18605 | @cindex @code{timeout}, MIPS protocol | |
18606 | @cindex @code{retransmit-timeout}, MIPS protocol | |
18607 | @kindex set timeout | |
18608 | @kindex show timeout | |
18609 | @kindex set retransmit-timeout | |
18610 | @kindex show retransmit-timeout | |
18611 | You can control the timeout used while waiting for a packet, in the MIPS | |
18612 | remote protocol, with the @code{set timeout @var{seconds}} command. The | |
18613 | default is 5 seconds. Similarly, you can control the timeout used while | |
a6f3e723 | 18614 | waiting for an acknowledgment of a packet with the @code{set |
8e04817f AC |
18615 | retransmit-timeout @var{seconds}} command. The default is 3 seconds. |
18616 | You can inspect both values with @code{show timeout} and @code{show | |
18617 | retransmit-timeout}. (These commands are @emph{only} available when | |
18618 | @value{GDBN} is configured for @samp{--target=mips-idt-ecoff}.) | |
104c1213 | 18619 | |
8e04817f AC |
18620 | The timeout set by @code{set timeout} does not apply when @value{GDBN} |
18621 | is waiting for your program to stop. In that case, @value{GDBN} waits | |
18622 | forever because it has no way of knowing how long the program is going | |
18623 | to run before stopping. | |
ba04e063 EZ |
18624 | |
18625 | @item set syn-garbage-limit @var{num} | |
18626 | @kindex set syn-garbage-limit@r{, MIPS remote} | |
18627 | @cindex synchronize with remote MIPS target | |
18628 | Limit the maximum number of characters @value{GDBN} should ignore when | |
18629 | it tries to synchronize with the remote target. The default is 10 | |
18630 | characters. Setting the limit to -1 means there's no limit. | |
18631 | ||
18632 | @item show syn-garbage-limit | |
18633 | @kindex show syn-garbage-limit@r{, MIPS remote} | |
18634 | Show the current limit on the number of characters to ignore when | |
18635 | trying to synchronize with the remote system. | |
18636 | ||
18637 | @item set monitor-prompt @var{prompt} | |
18638 | @kindex set monitor-prompt@r{, MIPS remote} | |
18639 | @cindex remote monitor prompt | |
18640 | Tell @value{GDBN} to expect the specified @var{prompt} string from the | |
18641 | remote monitor. The default depends on the target: | |
18642 | @table @asis | |
18643 | @item pmon target | |
18644 | @samp{PMON} | |
18645 | @item ddb target | |
18646 | @samp{NEC010} | |
18647 | @item lsi target | |
18648 | @samp{PMON>} | |
18649 | @end table | |
18650 | ||
18651 | @item show monitor-prompt | |
18652 | @kindex show monitor-prompt@r{, MIPS remote} | |
18653 | Show the current strings @value{GDBN} expects as the prompt from the | |
18654 | remote monitor. | |
18655 | ||
18656 | @item set monitor-warnings | |
18657 | @kindex set monitor-warnings@r{, MIPS remote} | |
18658 | Enable or disable monitor warnings about hardware breakpoints. This | |
18659 | has effect only for the @code{lsi} target. When on, @value{GDBN} will | |
18660 | display warning messages whose codes are returned by the @code{lsi} | |
18661 | PMON monitor for breakpoint commands. | |
18662 | ||
18663 | @item show monitor-warnings | |
18664 | @kindex show monitor-warnings@r{, MIPS remote} | |
18665 | Show the current setting of printing monitor warnings. | |
18666 | ||
18667 | @item pmon @var{command} | |
18668 | @kindex pmon@r{, MIPS remote} | |
18669 | @cindex send PMON command | |
18670 | This command allows sending an arbitrary @var{command} string to the | |
18671 | monitor. The monitor must be in debug mode for this to work. | |
8e04817f | 18672 | @end table |
104c1213 | 18673 | |
a37295f9 MM |
18674 | @node OpenRISC 1000 |
18675 | @subsection OpenRISC 1000 | |
18676 | @cindex OpenRISC 1000 | |
18677 | ||
18678 | @cindex or1k boards | |
18679 | See OR1k Architecture document (@uref{www.opencores.org}) for more information | |
18680 | about platform and commands. | |
18681 | ||
18682 | @table @code | |
18683 | ||
18684 | @kindex target jtag | |
18685 | @item target jtag jtag://@var{host}:@var{port} | |
18686 | ||
18687 | Connects to remote JTAG server. | |
18688 | JTAG remote server can be either an or1ksim or JTAG server, | |
18689 | connected via parallel port to the board. | |
18690 | ||
18691 | Example: @code{target jtag jtag://localhost:9999} | |
18692 | ||
18693 | @kindex or1ksim | |
18694 | @item or1ksim @var{command} | |
18695 | If connected to @code{or1ksim} OpenRISC 1000 Architectural | |
18696 | Simulator, proprietary commands can be executed. | |
18697 | ||
18698 | @kindex info or1k spr | |
18699 | @item info or1k spr | |
18700 | Displays spr groups. | |
18701 | ||
18702 | @item info or1k spr @var{group} | |
18703 | @itemx info or1k spr @var{groupno} | |
18704 | Displays register names in selected group. | |
18705 | ||
18706 | @item info or1k spr @var{group} @var{register} | |
18707 | @itemx info or1k spr @var{register} | |
18708 | @itemx info or1k spr @var{groupno} @var{registerno} | |
18709 | @itemx info or1k spr @var{registerno} | |
18710 | Shows information about specified spr register. | |
18711 | ||
18712 | @kindex spr | |
18713 | @item spr @var{group} @var{register} @var{value} | |
18714 | @itemx spr @var{register @var{value}} | |
18715 | @itemx spr @var{groupno} @var{registerno @var{value}} | |
18716 | @itemx spr @var{registerno @var{value}} | |
18717 | Writes @var{value} to specified spr register. | |
18718 | @end table | |
18719 | ||
18720 | Some implementations of OpenRISC 1000 Architecture also have hardware trace. | |
18721 | It is very similar to @value{GDBN} trace, except it does not interfere with normal | |
18722 | program execution and is thus much faster. Hardware breakpoints/watchpoint | |
18723 | triggers can be set using: | |
18724 | @table @code | |
18725 | @item $LEA/$LDATA | |
18726 | Load effective address/data | |
18727 | @item $SEA/$SDATA | |
18728 | Store effective address/data | |
18729 | @item $AEA/$ADATA | |
18730 | Access effective address ($SEA or $LEA) or data ($SDATA/$LDATA) | |
18731 | @item $FETCH | |
18732 | Fetch data | |
18733 | @end table | |
18734 | ||
18735 | When triggered, it can capture low level data, like: @code{PC}, @code{LSEA}, | |
18736 | @code{LDATA}, @code{SDATA}, @code{READSPR}, @code{WRITESPR}, @code{INSTR}. | |
18737 | ||
18738 | @code{htrace} commands: | |
18739 | @cindex OpenRISC 1000 htrace | |
18740 | @table @code | |
18741 | @kindex hwatch | |
18742 | @item hwatch @var{conditional} | |
d3e8051b | 18743 | Set hardware watchpoint on combination of Load/Store Effective Address(es) |
a37295f9 MM |
18744 | or Data. For example: |
18745 | ||
18746 | @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)} | |
18747 | ||
18748 | @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)} | |
18749 | ||
4644b6e3 | 18750 | @kindex htrace |
a37295f9 MM |
18751 | @item htrace info |
18752 | Display information about current HW trace configuration. | |
18753 | ||
a37295f9 MM |
18754 | @item htrace trigger @var{conditional} |
18755 | Set starting criteria for HW trace. | |
18756 | ||
a37295f9 MM |
18757 | @item htrace qualifier @var{conditional} |
18758 | Set acquisition qualifier for HW trace. | |
18759 | ||
a37295f9 MM |
18760 | @item htrace stop @var{conditional} |
18761 | Set HW trace stopping criteria. | |
18762 | ||
f153cc92 | 18763 | @item htrace record [@var{data}]* |
a37295f9 MM |
18764 | Selects the data to be recorded, when qualifier is met and HW trace was |
18765 | triggered. | |
18766 | ||
a37295f9 | 18767 | @item htrace enable |
a37295f9 MM |
18768 | @itemx htrace disable |
18769 | Enables/disables the HW trace. | |
18770 | ||
f153cc92 | 18771 | @item htrace rewind [@var{filename}] |
a37295f9 MM |
18772 | Clears currently recorded trace data. |
18773 | ||
18774 | If filename is specified, new trace file is made and any newly collected data | |
18775 | will be written there. | |
18776 | ||
f153cc92 | 18777 | @item htrace print [@var{start} [@var{len}]] |
a37295f9 MM |
18778 | Prints trace buffer, using current record configuration. |
18779 | ||
a37295f9 MM |
18780 | @item htrace mode continuous |
18781 | Set continuous trace mode. | |
18782 | ||
a37295f9 MM |
18783 | @item htrace mode suspend |
18784 | Set suspend trace mode. | |
18785 | ||
18786 | @end table | |
18787 | ||
4acd40f3 TJB |
18788 | @node PowerPC Embedded |
18789 | @subsection PowerPC Embedded | |
104c1213 | 18790 | |
66b73624 TJB |
18791 | @cindex DVC register |
18792 | @value{GDBN} supports using the DVC (Data Value Compare) register to | |
18793 | implement in hardware simple hardware watchpoint conditions of the form: | |
18794 | ||
18795 | @smallexample | |
18796 | (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \ | |
18797 | if @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION} | |
18798 | @end smallexample | |
18799 | ||
e09342b5 TJB |
18800 | The DVC register will be automatically used when @value{GDBN} detects |
18801 | such pattern in a condition expression, and the created watchpoint uses one | |
18802 | debug register (either the @code{exact-watchpoints} option is on and the | |
18803 | variable is scalar, or the variable has a length of one byte). This feature | |
18804 | is available in native @value{GDBN} running on a Linux kernel version 2.6.34 | |
18805 | or newer. | |
18806 | ||
18807 | When running on PowerPC embedded processors, @value{GDBN} automatically uses | |
18808 | ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on, | |
18809 | in which case watchpoints using only one debug register are created when | |
18810 | watching variables of scalar types. | |
18811 | ||
18812 | You can create an artificial array to watch an arbitrary memory | |
18813 | region using one of the following commands (@pxref{Expressions}): | |
18814 | ||
18815 | @smallexample | |
18816 | (@value{GDBP}) watch *((char *) @var{address})@@@var{length} | |
18817 | (@value{GDBP}) watch @{char[@var{length}]@} @var{address} | |
18818 | @end smallexample | |
66b73624 | 18819 | |
9c06b0b4 TJB |
18820 | PowerPC embedded processors support masked watchpoints. See the discussion |
18821 | about the @code{mask} argument in @ref{Set Watchpoints}. | |
18822 | ||
f1310107 TJB |
18823 | @cindex ranged breakpoint |
18824 | PowerPC embedded processors support hardware accelerated | |
18825 | @dfn{ranged breakpoints}. A ranged breakpoint stops execution of | |
18826 | the inferior whenever it executes an instruction at any address within | |
18827 | the range it specifies. To set a ranged breakpoint in @value{GDBN}, | |
18828 | use the @code{break-range} command. | |
18829 | ||
55eddb0f DJ |
18830 | @value{GDBN} provides the following PowerPC-specific commands: |
18831 | ||
104c1213 | 18832 | @table @code |
f1310107 TJB |
18833 | @kindex break-range |
18834 | @item break-range @var{start-location}, @var{end-location} | |
18835 | Set a breakpoint for an address range. | |
18836 | @var{start-location} and @var{end-location} can specify a function name, | |
18837 | a line number, an offset of lines from the current line or from the start | |
18838 | location, or an address of an instruction (see @ref{Specify Location}, | |
18839 | for a list of all the possible ways to specify a @var{location}.) | |
18840 | The breakpoint will stop execution of the inferior whenever it | |
18841 | executes an instruction at any address within the specified range, | |
18842 | (including @var{start-location} and @var{end-location}.) | |
18843 | ||
55eddb0f DJ |
18844 | @kindex set powerpc |
18845 | @item set powerpc soft-float | |
18846 | @itemx show powerpc soft-float | |
18847 | Force @value{GDBN} to use (or not use) a software floating point calling | |
18848 | convention. By default, @value{GDBN} selects the calling convention based | |
18849 | on the selected architecture and the provided executable file. | |
18850 | ||
18851 | @item set powerpc vector-abi | |
18852 | @itemx show powerpc vector-abi | |
18853 | Force @value{GDBN} to use the specified calling convention for vector | |
18854 | arguments and return values. The valid options are @samp{auto}; | |
18855 | @samp{generic}, to avoid vector registers even if they are present; | |
18856 | @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE | |
18857 | registers. By default, @value{GDBN} selects the calling convention | |
18858 | based on the selected architecture and the provided executable file. | |
18859 | ||
e09342b5 TJB |
18860 | @item set powerpc exact-watchpoints |
18861 | @itemx show powerpc exact-watchpoints | |
18862 | Allow @value{GDBN} to use only one debug register when watching a variable | |
18863 | of scalar type, thus assuming that the variable is accessed through the | |
18864 | address of its first byte. | |
18865 | ||
8e04817f AC |
18866 | @kindex target dink32 |
18867 | @item target dink32 @var{dev} | |
18868 | DINK32 ROM monitor. | |
104c1213 | 18869 | |
8e04817f AC |
18870 | @kindex target ppcbug |
18871 | @item target ppcbug @var{dev} | |
18872 | @kindex target ppcbug1 | |
18873 | @item target ppcbug1 @var{dev} | |
18874 | PPCBUG ROM monitor for PowerPC. | |
104c1213 | 18875 | |
8e04817f AC |
18876 | @kindex target sds |
18877 | @item target sds @var{dev} | |
18878 | SDS monitor, running on a PowerPC board (such as Motorola's ADS). | |
c45da7e6 | 18879 | @end table |
8e04817f | 18880 | |
c45da7e6 | 18881 | @cindex SDS protocol |
d52fb0e9 | 18882 | The following commands specific to the SDS protocol are supported |
55eddb0f | 18883 | by @value{GDBN}: |
c45da7e6 EZ |
18884 | |
18885 | @table @code | |
18886 | @item set sdstimeout @var{nsec} | |
18887 | @kindex set sdstimeout | |
18888 | Set the timeout for SDS protocol reads to be @var{nsec} seconds. The | |
18889 | default is 2 seconds. | |
18890 | ||
18891 | @item show sdstimeout | |
18892 | @kindex show sdstimeout | |
18893 | Show the current value of the SDS timeout. | |
18894 | ||
18895 | @item sds @var{command} | |
18896 | @kindex sds@r{, a command} | |
18897 | Send the specified @var{command} string to the SDS monitor. | |
8e04817f AC |
18898 | @end table |
18899 | ||
c45da7e6 | 18900 | |
8e04817f AC |
18901 | @node PA |
18902 | @subsection HP PA Embedded | |
104c1213 JM |
18903 | |
18904 | @table @code | |
18905 | ||
8e04817f AC |
18906 | @kindex target op50n |
18907 | @item target op50n @var{dev} | |
18908 | OP50N monitor, running on an OKI HPPA board. | |
18909 | ||
18910 | @kindex target w89k | |
18911 | @item target w89k @var{dev} | |
18912 | W89K monitor, running on a Winbond HPPA board. | |
104c1213 JM |
18913 | |
18914 | @end table | |
18915 | ||
8e04817f AC |
18916 | @node Sparclet |
18917 | @subsection Tsqware Sparclet | |
104c1213 | 18918 | |
8e04817f AC |
18919 | @cindex Sparclet |
18920 | ||
18921 | @value{GDBN} enables developers to debug tasks running on | |
18922 | Sparclet targets from a Unix host. | |
18923 | @value{GDBN} uses code that runs on | |
18924 | both the Unix host and on the Sparclet target. The program | |
18925 | @code{@value{GDBP}} is installed and executed on the Unix host. | |
104c1213 | 18926 | |
8e04817f AC |
18927 | @table @code |
18928 | @item remotetimeout @var{args} | |
18929 | @kindex remotetimeout | |
18930 | @value{GDBN} supports the option @code{remotetimeout}. | |
18931 | This option is set by the user, and @var{args} represents the number of | |
18932 | seconds @value{GDBN} waits for responses. | |
104c1213 JM |
18933 | @end table |
18934 | ||
8e04817f AC |
18935 | @cindex compiling, on Sparclet |
18936 | When compiling for debugging, include the options @samp{-g} to get debug | |
18937 | information and @samp{-Ttext} to relocate the program to where you wish to | |
18938 | load it on the target. You may also want to add the options @samp{-n} or | |
18939 | @samp{-N} in order to reduce the size of the sections. Example: | |
104c1213 | 18940 | |
474c8240 | 18941 | @smallexample |
8e04817f | 18942 | sparclet-aout-gcc prog.c -Ttext 0x12010000 -g -o prog -N |
474c8240 | 18943 | @end smallexample |
104c1213 | 18944 | |
8e04817f | 18945 | You can use @code{objdump} to verify that the addresses are what you intended: |
104c1213 | 18946 | |
474c8240 | 18947 | @smallexample |
8e04817f | 18948 | sparclet-aout-objdump --headers --syms prog |
474c8240 | 18949 | @end smallexample |
104c1213 | 18950 | |
8e04817f AC |
18951 | @cindex running, on Sparclet |
18952 | Once you have set | |
18953 | your Unix execution search path to find @value{GDBN}, you are ready to | |
18954 | run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} | |
18955 | (or @code{sparclet-aout-gdb}, depending on your installation). | |
104c1213 | 18956 | |
8e04817f AC |
18957 | @value{GDBN} comes up showing the prompt: |
18958 | ||
474c8240 | 18959 | @smallexample |
8e04817f | 18960 | (gdbslet) |
474c8240 | 18961 | @end smallexample |
104c1213 JM |
18962 | |
18963 | @menu | |
8e04817f AC |
18964 | * Sparclet File:: Setting the file to debug |
18965 | * Sparclet Connection:: Connecting to Sparclet | |
18966 | * Sparclet Download:: Sparclet download | |
18967 | * Sparclet Execution:: Running and debugging | |
104c1213 JM |
18968 | @end menu |
18969 | ||
8e04817f | 18970 | @node Sparclet File |
79a6e687 | 18971 | @subsubsection Setting File to Debug |
104c1213 | 18972 | |
8e04817f | 18973 | The @value{GDBN} command @code{file} lets you choose with program to debug. |
104c1213 | 18974 | |
474c8240 | 18975 | @smallexample |
8e04817f | 18976 | (gdbslet) file prog |
474c8240 | 18977 | @end smallexample |
104c1213 | 18978 | |
8e04817f AC |
18979 | @need 1000 |
18980 | @value{GDBN} then attempts to read the symbol table of @file{prog}. | |
18981 | @value{GDBN} locates | |
18982 | the file by searching the directories listed in the command search | |
18983 | path. | |
12c27660 | 18984 | If the file was compiled with debug information (option @samp{-g}), source |
8e04817f AC |
18985 | files will be searched as well. |
18986 | @value{GDBN} locates | |
18987 | the source files by searching the directories listed in the directory search | |
79a6e687 | 18988 | path (@pxref{Environment, ,Your Program's Environment}). |
8e04817f AC |
18989 | If it fails |
18990 | to find a file, it displays a message such as: | |
104c1213 | 18991 | |
474c8240 | 18992 | @smallexample |
8e04817f | 18993 | prog: No such file or directory. |
474c8240 | 18994 | @end smallexample |
104c1213 | 18995 | |
8e04817f AC |
18996 | When this happens, add the appropriate directories to the search paths with |
18997 | the @value{GDBN} commands @code{path} and @code{dir}, and execute the | |
18998 | @code{target} command again. | |
104c1213 | 18999 | |
8e04817f AC |
19000 | @node Sparclet Connection |
19001 | @subsubsection Connecting to Sparclet | |
104c1213 | 19002 | |
8e04817f AC |
19003 | The @value{GDBN} command @code{target} lets you connect to a Sparclet target. |
19004 | To connect to a target on serial port ``@code{ttya}'', type: | |
104c1213 | 19005 | |
474c8240 | 19006 | @smallexample |
8e04817f AC |
19007 | (gdbslet) target sparclet /dev/ttya |
19008 | Remote target sparclet connected to /dev/ttya | |
19009 | main () at ../prog.c:3 | |
474c8240 | 19010 | @end smallexample |
104c1213 | 19011 | |
8e04817f AC |
19012 | @need 750 |
19013 | @value{GDBN} displays messages like these: | |
104c1213 | 19014 | |
474c8240 | 19015 | @smallexample |
8e04817f | 19016 | Connected to ttya. |
474c8240 | 19017 | @end smallexample |
104c1213 | 19018 | |
8e04817f | 19019 | @node Sparclet Download |
79a6e687 | 19020 | @subsubsection Sparclet Download |
104c1213 | 19021 | |
8e04817f AC |
19022 | @cindex download to Sparclet |
19023 | Once connected to the Sparclet target, | |
19024 | you can use the @value{GDBN} | |
19025 | @code{load} command to download the file from the host to the target. | |
19026 | The file name and load offset should be given as arguments to the @code{load} | |
19027 | command. | |
19028 | Since the file format is aout, the program must be loaded to the starting | |
19029 | address. You can use @code{objdump} to find out what this value is. The load | |
19030 | offset is an offset which is added to the VMA (virtual memory address) | |
19031 | of each of the file's sections. | |
19032 | For instance, if the program | |
19033 | @file{prog} was linked to text address 0x1201000, with data at 0x12010160 | |
19034 | and bss at 0x12010170, in @value{GDBN}, type: | |
104c1213 | 19035 | |
474c8240 | 19036 | @smallexample |
8e04817f AC |
19037 | (gdbslet) load prog 0x12010000 |
19038 | Loading section .text, size 0xdb0 vma 0x12010000 | |
474c8240 | 19039 | @end smallexample |
104c1213 | 19040 | |
8e04817f AC |
19041 | If the code is loaded at a different address then what the program was linked |
19042 | to, you may need to use the @code{section} and @code{add-symbol-file} commands | |
19043 | to tell @value{GDBN} where to map the symbol table. | |
19044 | ||
19045 | @node Sparclet Execution | |
79a6e687 | 19046 | @subsubsection Running and Debugging |
8e04817f AC |
19047 | |
19048 | @cindex running and debugging Sparclet programs | |
19049 | You can now begin debugging the task using @value{GDBN}'s execution control | |
19050 | commands, @code{b}, @code{step}, @code{run}, etc. See the @value{GDBN} | |
19051 | manual for the list of commands. | |
19052 | ||
474c8240 | 19053 | @smallexample |
8e04817f AC |
19054 | (gdbslet) b main |
19055 | Breakpoint 1 at 0x12010000: file prog.c, line 3. | |
19056 | (gdbslet) run | |
19057 | Starting program: prog | |
19058 | Breakpoint 1, main (argc=1, argv=0xeffff21c) at prog.c:3 | |
19059 | 3 char *symarg = 0; | |
19060 | (gdbslet) step | |
19061 | 4 char *execarg = "hello!"; | |
19062 | (gdbslet) | |
474c8240 | 19063 | @end smallexample |
8e04817f AC |
19064 | |
19065 | @node Sparclite | |
19066 | @subsection Fujitsu Sparclite | |
104c1213 JM |
19067 | |
19068 | @table @code | |
19069 | ||
8e04817f AC |
19070 | @kindex target sparclite |
19071 | @item target sparclite @var{dev} | |
19072 | Fujitsu sparclite boards, used only for the purpose of loading. | |
19073 | You must use an additional command to debug the program. | |
19074 | For example: target remote @var{dev} using @value{GDBN} standard | |
19075 | remote protocol. | |
104c1213 JM |
19076 | |
19077 | @end table | |
19078 | ||
8e04817f AC |
19079 | @node Z8000 |
19080 | @subsection Zilog Z8000 | |
104c1213 | 19081 | |
8e04817f AC |
19082 | @cindex Z8000 |
19083 | @cindex simulator, Z8000 | |
19084 | @cindex Zilog Z8000 simulator | |
104c1213 | 19085 | |
8e04817f AC |
19086 | When configured for debugging Zilog Z8000 targets, @value{GDBN} includes |
19087 | a Z8000 simulator. | |
19088 | ||
19089 | For the Z8000 family, @samp{target sim} simulates either the Z8002 (the | |
19090 | unsegmented variant of the Z8000 architecture) or the Z8001 (the | |
19091 | segmented variant). The simulator recognizes which architecture is | |
19092 | appropriate by inspecting the object code. | |
104c1213 | 19093 | |
8e04817f AC |
19094 | @table @code |
19095 | @item target sim @var{args} | |
19096 | @kindex sim | |
19097 | @kindex target sim@r{, with Z8000} | |
19098 | Debug programs on a simulated CPU. If the simulator supports setup | |
19099 | options, specify them via @var{args}. | |
104c1213 JM |
19100 | @end table |
19101 | ||
8e04817f AC |
19102 | @noindent |
19103 | After specifying this target, you can debug programs for the simulated | |
19104 | CPU in the same style as programs for your host computer; use the | |
19105 | @code{file} command to load a new program image, the @code{run} command | |
19106 | to run your program, and so on. | |
19107 | ||
19108 | As well as making available all the usual machine registers | |
19109 | (@pxref{Registers, ,Registers}), the Z8000 simulator provides three | |
19110 | additional items of information as specially named registers: | |
104c1213 JM |
19111 | |
19112 | @table @code | |
19113 | ||
8e04817f AC |
19114 | @item cycles |
19115 | Counts clock-ticks in the simulator. | |
104c1213 | 19116 | |
8e04817f AC |
19117 | @item insts |
19118 | Counts instructions run in the simulator. | |
104c1213 | 19119 | |
8e04817f AC |
19120 | @item time |
19121 | Execution time in 60ths of a second. | |
104c1213 | 19122 | |
8e04817f | 19123 | @end table |
104c1213 | 19124 | |
8e04817f AC |
19125 | You can refer to these values in @value{GDBN} expressions with the usual |
19126 | conventions; for example, @w{@samp{b fputc if $cycles>5000}} sets a | |
19127 | conditional breakpoint that suspends only after at least 5000 | |
19128 | simulated clock ticks. | |
104c1213 | 19129 | |
a64548ea EZ |
19130 | @node AVR |
19131 | @subsection Atmel AVR | |
19132 | @cindex AVR | |
19133 | ||
19134 | When configured for debugging the Atmel AVR, @value{GDBN} supports the | |
19135 | following AVR-specific commands: | |
19136 | ||
19137 | @table @code | |
19138 | @item info io_registers | |
19139 | @kindex info io_registers@r{, AVR} | |
19140 | @cindex I/O registers (Atmel AVR) | |
19141 | This command displays information about the AVR I/O registers. For | |
19142 | each register, @value{GDBN} prints its number and value. | |
19143 | @end table | |
19144 | ||
19145 | @node CRIS | |
19146 | @subsection CRIS | |
19147 | @cindex CRIS | |
19148 | ||
19149 | When configured for debugging CRIS, @value{GDBN} provides the | |
19150 | following CRIS-specific commands: | |
19151 | ||
19152 | @table @code | |
19153 | @item set cris-version @var{ver} | |
19154 | @cindex CRIS version | |
e22e55c9 OF |
19155 | Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}. |
19156 | The CRIS version affects register names and sizes. This command is useful in | |
19157 | case autodetection of the CRIS version fails. | |
a64548ea EZ |
19158 | |
19159 | @item show cris-version | |
19160 | Show the current CRIS version. | |
19161 | ||
19162 | @item set cris-dwarf2-cfi | |
19163 | @cindex DWARF-2 CFI and CRIS | |
e22e55c9 OF |
19164 | Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}. |
19165 | Change to @samp{off} when using @code{gcc-cris} whose version is below | |
19166 | @code{R59}. | |
a64548ea EZ |
19167 | |
19168 | @item show cris-dwarf2-cfi | |
19169 | Show the current state of using DWARF-2 CFI. | |
e22e55c9 OF |
19170 | |
19171 | @item set cris-mode @var{mode} | |
19172 | @cindex CRIS mode | |
19173 | Set the current CRIS mode to @var{mode}. It should only be changed when | |
19174 | debugging in guru mode, in which case it should be set to | |
19175 | @samp{guru} (the default is @samp{normal}). | |
19176 | ||
19177 | @item show cris-mode | |
19178 | Show the current CRIS mode. | |
a64548ea EZ |
19179 | @end table |
19180 | ||
19181 | @node Super-H | |
19182 | @subsection Renesas Super-H | |
19183 | @cindex Super-H | |
19184 | ||
19185 | For the Renesas Super-H processor, @value{GDBN} provides these | |
19186 | commands: | |
19187 | ||
19188 | @table @code | |
19189 | @item regs | |
19190 | @kindex regs@r{, Super-H} | |
19191 | Show the values of all Super-H registers. | |
c055b101 CV |
19192 | |
19193 | @item set sh calling-convention @var{convention} | |
19194 | @kindex set sh calling-convention | |
19195 | Set the calling-convention used when calling functions from @value{GDBN}. | |
19196 | Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}. | |
19197 | With the @samp{gcc} setting, functions are called using the @value{NGCC} calling | |
19198 | convention. If the DWARF-2 information of the called function specifies | |
19199 | that the function follows the Renesas calling convention, the function | |
19200 | is called using the Renesas calling convention. If the calling convention | |
19201 | is set to @samp{renesas}, the Renesas calling convention is always used, | |
19202 | regardless of the DWARF-2 information. This can be used to override the | |
19203 | default of @samp{gcc} if debug information is missing, or the compiler | |
19204 | does not emit the DWARF-2 calling convention entry for a function. | |
19205 | ||
19206 | @item show sh calling-convention | |
19207 | @kindex show sh calling-convention | |
19208 | Show the current calling convention setting. | |
19209 | ||
a64548ea EZ |
19210 | @end table |
19211 | ||
19212 | ||
8e04817f AC |
19213 | @node Architectures |
19214 | @section Architectures | |
104c1213 | 19215 | |
8e04817f AC |
19216 | This section describes characteristics of architectures that affect |
19217 | all uses of @value{GDBN} with the architecture, both native and cross. | |
104c1213 | 19218 | |
8e04817f | 19219 | @menu |
9c16f35a | 19220 | * i386:: |
8e04817f AC |
19221 | * A29K:: |
19222 | * Alpha:: | |
19223 | * MIPS:: | |
a64548ea | 19224 | * HPPA:: HP PA architecture |
23d964e7 | 19225 | * SPU:: Cell Broadband Engine SPU architecture |
4acd40f3 | 19226 | * PowerPC:: |
8e04817f | 19227 | @end menu |
104c1213 | 19228 | |
9c16f35a | 19229 | @node i386 |
db2e3e2e | 19230 | @subsection x86 Architecture-specific Issues |
9c16f35a EZ |
19231 | |
19232 | @table @code | |
19233 | @item set struct-convention @var{mode} | |
19234 | @kindex set struct-convention | |
19235 | @cindex struct return convention | |
19236 | @cindex struct/union returned in registers | |
19237 | Set the convention used by the inferior to return @code{struct}s and | |
19238 | @code{union}s from functions to @var{mode}. Possible values of | |
19239 | @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the | |
19240 | default). @code{"default"} or @code{"pcc"} means that @code{struct}s | |
19241 | are returned on the stack, while @code{"reg"} means that a | |
19242 | @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will | |
19243 | be returned in a register. | |
19244 | ||
19245 | @item show struct-convention | |
19246 | @kindex show struct-convention | |
19247 | Show the current setting of the convention to return @code{struct}s | |
19248 | from functions. | |
19249 | @end table | |
19250 | ||
8e04817f AC |
19251 | @node A29K |
19252 | @subsection A29K | |
104c1213 JM |
19253 | |
19254 | @table @code | |
104c1213 | 19255 | |
8e04817f AC |
19256 | @kindex set rstack_high_address |
19257 | @cindex AMD 29K register stack | |
19258 | @cindex register stack, AMD29K | |
19259 | @item set rstack_high_address @var{address} | |
19260 | On AMD 29000 family processors, registers are saved in a separate | |
19261 | @dfn{register stack}. There is no way for @value{GDBN} to determine the | |
19262 | extent of this stack. Normally, @value{GDBN} just assumes that the | |
19263 | stack is ``large enough''. This may result in @value{GDBN} referencing | |
19264 | memory locations that do not exist. If necessary, you can get around | |
19265 | this problem by specifying the ending address of the register stack with | |
19266 | the @code{set rstack_high_address} command. The argument should be an | |
19267 | address, which you probably want to precede with @samp{0x} to specify in | |
19268 | hexadecimal. | |
104c1213 | 19269 | |
8e04817f AC |
19270 | @kindex show rstack_high_address |
19271 | @item show rstack_high_address | |
19272 | Display the current limit of the register stack, on AMD 29000 family | |
19273 | processors. | |
104c1213 | 19274 | |
8e04817f | 19275 | @end table |
104c1213 | 19276 | |
8e04817f AC |
19277 | @node Alpha |
19278 | @subsection Alpha | |
104c1213 | 19279 | |
8e04817f | 19280 | See the following section. |
104c1213 | 19281 | |
8e04817f AC |
19282 | @node MIPS |
19283 | @subsection MIPS | |
104c1213 | 19284 | |
8e04817f AC |
19285 | @cindex stack on Alpha |
19286 | @cindex stack on MIPS | |
19287 | @cindex Alpha stack | |
19288 | @cindex MIPS stack | |
19289 | Alpha- and MIPS-based computers use an unusual stack frame, which | |
19290 | sometimes requires @value{GDBN} to search backward in the object code to | |
19291 | find the beginning of a function. | |
104c1213 | 19292 | |
8e04817f AC |
19293 | @cindex response time, MIPS debugging |
19294 | To improve response time (especially for embedded applications, where | |
19295 | @value{GDBN} may be restricted to a slow serial line for this search) | |
19296 | you may want to limit the size of this search, using one of these | |
19297 | commands: | |
104c1213 | 19298 | |
8e04817f AC |
19299 | @table @code |
19300 | @cindex @code{heuristic-fence-post} (Alpha, MIPS) | |
19301 | @item set heuristic-fence-post @var{limit} | |
19302 | Restrict @value{GDBN} to examining at most @var{limit} bytes in its | |
19303 | search for the beginning of a function. A value of @var{0} (the | |
19304 | default) means there is no limit. However, except for @var{0}, the | |
19305 | larger the limit the more bytes @code{heuristic-fence-post} must search | |
e2f4edfd EZ |
19306 | and therefore the longer it takes to run. You should only need to use |
19307 | this command when debugging a stripped executable. | |
104c1213 | 19308 | |
8e04817f AC |
19309 | @item show heuristic-fence-post |
19310 | Display the current limit. | |
19311 | @end table | |
104c1213 JM |
19312 | |
19313 | @noindent | |
8e04817f AC |
19314 | These commands are available @emph{only} when @value{GDBN} is configured |
19315 | for debugging programs on Alpha or MIPS processors. | |
104c1213 | 19316 | |
a64548ea EZ |
19317 | Several MIPS-specific commands are available when debugging MIPS |
19318 | programs: | |
19319 | ||
19320 | @table @code | |
a64548ea EZ |
19321 | @item set mips abi @var{arg} |
19322 | @kindex set mips abi | |
19323 | @cindex set ABI for MIPS | |
19324 | Tell @value{GDBN} which MIPS ABI is used by the inferior. Possible | |
19325 | values of @var{arg} are: | |
19326 | ||
19327 | @table @samp | |
19328 | @item auto | |
19329 | The default ABI associated with the current binary (this is the | |
19330 | default). | |
19331 | @item o32 | |
19332 | @item o64 | |
19333 | @item n32 | |
19334 | @item n64 | |
19335 | @item eabi32 | |
19336 | @item eabi64 | |
19337 | @item auto | |
19338 | @end table | |
19339 | ||
19340 | @item show mips abi | |
19341 | @kindex show mips abi | |
19342 | Show the MIPS ABI used by @value{GDBN} to debug the inferior. | |
19343 | ||
19344 | @item set mipsfpu | |
19345 | @itemx show mipsfpu | |
19346 | @xref{MIPS Embedded, set mipsfpu}. | |
19347 | ||
19348 | @item set mips mask-address @var{arg} | |
19349 | @kindex set mips mask-address | |
19350 | @cindex MIPS addresses, masking | |
19351 | This command determines whether the most-significant 32 bits of 64-bit | |
19352 | MIPS addresses are masked off. The argument @var{arg} can be | |
19353 | @samp{on}, @samp{off}, or @samp{auto}. The latter is the default | |
19354 | setting, which lets @value{GDBN} determine the correct value. | |
19355 | ||
19356 | @item show mips mask-address | |
19357 | @kindex show mips mask-address | |
19358 | Show whether the upper 32 bits of MIPS addresses are masked off or | |
19359 | not. | |
19360 | ||
19361 | @item set remote-mips64-transfers-32bit-regs | |
19362 | @kindex set remote-mips64-transfers-32bit-regs | |
19363 | This command controls compatibility with 64-bit MIPS targets that | |
19364 | transfer data in 32-bit quantities. If you have an old MIPS 64 target | |
19365 | that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr}, | |
19366 | and 64 bits for other registers, set this option to @samp{on}. | |
19367 | ||
19368 | @item show remote-mips64-transfers-32bit-regs | |
19369 | @kindex show remote-mips64-transfers-32bit-regs | |
19370 | Show the current setting of compatibility with older MIPS 64 targets. | |
19371 | ||
19372 | @item set debug mips | |
19373 | @kindex set debug mips | |
19374 | This command turns on and off debugging messages for the MIPS-specific | |
19375 | target code in @value{GDBN}. | |
19376 | ||
19377 | @item show debug mips | |
19378 | @kindex show debug mips | |
19379 | Show the current setting of MIPS debugging messages. | |
19380 | @end table | |
19381 | ||
19382 | ||
19383 | @node HPPA | |
19384 | @subsection HPPA | |
19385 | @cindex HPPA support | |
19386 | ||
d3e8051b | 19387 | When @value{GDBN} is debugging the HP PA architecture, it provides the |
a64548ea EZ |
19388 | following special commands: |
19389 | ||
19390 | @table @code | |
19391 | @item set debug hppa | |
19392 | @kindex set debug hppa | |
db2e3e2e | 19393 | This command determines whether HPPA architecture-specific debugging |
a64548ea EZ |
19394 | messages are to be displayed. |
19395 | ||
19396 | @item show debug hppa | |
19397 | Show whether HPPA debugging messages are displayed. | |
19398 | ||
19399 | @item maint print unwind @var{address} | |
19400 | @kindex maint print unwind@r{, HPPA} | |
19401 | This command displays the contents of the unwind table entry at the | |
19402 | given @var{address}. | |
19403 | ||
19404 | @end table | |
19405 | ||
104c1213 | 19406 | |
23d964e7 UW |
19407 | @node SPU |
19408 | @subsection Cell Broadband Engine SPU architecture | |
19409 | @cindex Cell Broadband Engine | |
19410 | @cindex SPU | |
19411 | ||
19412 | When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture, | |
19413 | it provides the following special commands: | |
19414 | ||
19415 | @table @code | |
19416 | @item info spu event | |
19417 | @kindex info spu | |
19418 | Display SPU event facility status. Shows current event mask | |
19419 | and pending event status. | |
19420 | ||
19421 | @item info spu signal | |
19422 | Display SPU signal notification facility status. Shows pending | |
19423 | signal-control word and signal notification mode of both signal | |
19424 | notification channels. | |
19425 | ||
19426 | @item info spu mailbox | |
19427 | Display SPU mailbox facility status. Shows all pending entries, | |
19428 | in order of processing, in each of the SPU Write Outbound, | |
19429 | SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes. | |
19430 | ||
19431 | @item info spu dma | |
19432 | Display MFC DMA status. Shows all pending commands in the MFC | |
19433 | DMA queue. For each entry, opcode, tag, class IDs, effective | |
19434 | and local store addresses and transfer size are shown. | |
19435 | ||
19436 | @item info spu proxydma | |
19437 | Display MFC Proxy-DMA status. Shows all pending commands in the MFC | |
19438 | Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective | |
19439 | and local store addresses and transfer size are shown. | |
19440 | ||
19441 | @end table | |
19442 | ||
3285f3fe UW |
19443 | When @value{GDBN} is debugging a combined PowerPC/SPU application |
19444 | on the Cell Broadband Engine, it provides in addition the following | |
19445 | special commands: | |
19446 | ||
19447 | @table @code | |
19448 | @item set spu stop-on-load @var{arg} | |
19449 | @kindex set spu | |
19450 | Set whether to stop for new SPE threads. When set to @code{on}, @value{GDBN} | |
19451 | will give control to the user when a new SPE thread enters its @code{main} | |
19452 | function. The default is @code{off}. | |
19453 | ||
19454 | @item show spu stop-on-load | |
19455 | @kindex show spu | |
19456 | Show whether to stop for new SPE threads. | |
19457 | ||
ff1a52c6 UW |
19458 | @item set spu auto-flush-cache @var{arg} |
19459 | Set whether to automatically flush the software-managed cache. When set to | |
19460 | @code{on}, @value{GDBN} will automatically cause the SPE software-managed | |
19461 | cache to be flushed whenever SPE execution stops. This provides a consistent | |
19462 | view of PowerPC memory that is accessed via the cache. If an application | |
19463 | does not use the software-managed cache, this option has no effect. | |
19464 | ||
19465 | @item show spu auto-flush-cache | |
19466 | Show whether to automatically flush the software-managed cache. | |
19467 | ||
3285f3fe UW |
19468 | @end table |
19469 | ||
4acd40f3 TJB |
19470 | @node PowerPC |
19471 | @subsection PowerPC | |
19472 | @cindex PowerPC architecture | |
19473 | ||
19474 | When @value{GDBN} is debugging the PowerPC architecture, it provides a set of | |
19475 | pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point | |
19476 | numbers stored in the floating point registers. These values must be stored | |
19477 | in two consecutive registers, always starting at an even register like | |
19478 | @code{f0} or @code{f2}. | |
19479 | ||
19480 | The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed | |
19481 | by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0}, | |
19482 | @code{f2} and @code{f3} for @code{$dl1} and so on. | |
19483 | ||
aeac0ff9 | 19484 | For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit |
677c5bb1 LM |
19485 | wide Extended Floating Point Registers (@samp{f32} through @samp{f63}). |
19486 | ||
23d964e7 | 19487 | |
8e04817f AC |
19488 | @node Controlling GDB |
19489 | @chapter Controlling @value{GDBN} | |
19490 | ||
19491 | You can alter the way @value{GDBN} interacts with you by using the | |
19492 | @code{set} command. For commands controlling how @value{GDBN} displays | |
79a6e687 | 19493 | data, see @ref{Print Settings, ,Print Settings}. Other settings are |
8e04817f AC |
19494 | described here. |
19495 | ||
19496 | @menu | |
19497 | * Prompt:: Prompt | |
19498 | * Editing:: Command editing | |
d620b259 | 19499 | * Command History:: Command history |
8e04817f AC |
19500 | * Screen Size:: Screen size |
19501 | * Numbers:: Numbers | |
1e698235 | 19502 | * ABI:: Configuring the current ABI |
8e04817f AC |
19503 | * Messages/Warnings:: Optional warnings and messages |
19504 | * Debugging Output:: Optional messages about internal happenings | |
14fb1bac | 19505 | * Other Misc Settings:: Other Miscellaneous Settings |
8e04817f AC |
19506 | @end menu |
19507 | ||
19508 | @node Prompt | |
19509 | @section Prompt | |
104c1213 | 19510 | |
8e04817f | 19511 | @cindex prompt |
104c1213 | 19512 | |
8e04817f AC |
19513 | @value{GDBN} indicates its readiness to read a command by printing a string |
19514 | called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You | |
19515 | can change the prompt string with the @code{set prompt} command. For | |
19516 | instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change | |
19517 | the prompt in one of the @value{GDBN} sessions so that you can always tell | |
19518 | which one you are talking to. | |
104c1213 | 19519 | |
8e04817f AC |
19520 | @emph{Note:} @code{set prompt} does not add a space for you after the |
19521 | prompt you set. This allows you to set a prompt which ends in a space | |
19522 | or a prompt that does not. | |
104c1213 | 19523 | |
8e04817f AC |
19524 | @table @code |
19525 | @kindex set prompt | |
19526 | @item set prompt @var{newprompt} | |
19527 | Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth. | |
104c1213 | 19528 | |
8e04817f AC |
19529 | @kindex show prompt |
19530 | @item show prompt | |
19531 | Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}} | |
104c1213 JM |
19532 | @end table |
19533 | ||
8e04817f | 19534 | @node Editing |
79a6e687 | 19535 | @section Command Editing |
8e04817f AC |
19536 | @cindex readline |
19537 | @cindex command line editing | |
104c1213 | 19538 | |
703663ab | 19539 | @value{GDBN} reads its input commands via the @dfn{Readline} interface. This |
8e04817f AC |
19540 | @sc{gnu} library provides consistent behavior for programs which provide a |
19541 | command line interface to the user. Advantages are @sc{gnu} Emacs-style | |
19542 | or @dfn{vi}-style inline editing of commands, @code{csh}-like history | |
19543 | substitution, and a storage and recall of command history across | |
19544 | debugging sessions. | |
104c1213 | 19545 | |
8e04817f AC |
19546 | You may control the behavior of command line editing in @value{GDBN} with the |
19547 | command @code{set}. | |
104c1213 | 19548 | |
8e04817f AC |
19549 | @table @code |
19550 | @kindex set editing | |
19551 | @cindex editing | |
19552 | @item set editing | |
19553 | @itemx set editing on | |
19554 | Enable command line editing (enabled by default). | |
104c1213 | 19555 | |
8e04817f AC |
19556 | @item set editing off |
19557 | Disable command line editing. | |
104c1213 | 19558 | |
8e04817f AC |
19559 | @kindex show editing |
19560 | @item show editing | |
19561 | Show whether command line editing is enabled. | |
104c1213 JM |
19562 | @end table |
19563 | ||
39037522 TT |
19564 | @ifset SYSTEM_READLINE |
19565 | @xref{Command Line Editing, , , rluserman, GNU Readline Library}, | |
19566 | @end ifset | |
19567 | @ifclear SYSTEM_READLINE | |
19568 | @xref{Command Line Editing}, | |
19569 | @end ifclear | |
19570 | for more details about the Readline | |
703663ab EZ |
19571 | interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are |
19572 | encouraged to read that chapter. | |
19573 | ||
d620b259 | 19574 | @node Command History |
79a6e687 | 19575 | @section Command History |
703663ab | 19576 | @cindex command history |
8e04817f AC |
19577 | |
19578 | @value{GDBN} can keep track of the commands you type during your | |
19579 | debugging sessions, so that you can be certain of precisely what | |
19580 | happened. Use these commands to manage the @value{GDBN} command | |
19581 | history facility. | |
104c1213 | 19582 | |
703663ab | 19583 | @value{GDBN} uses the @sc{gnu} History library, a part of the Readline |
39037522 TT |
19584 | package, to provide the history facility. |
19585 | @ifset SYSTEM_READLINE | |
19586 | @xref{Using History Interactively, , , history, GNU History Library}, | |
19587 | @end ifset | |
19588 | @ifclear SYSTEM_READLINE | |
19589 | @xref{Using History Interactively}, | |
19590 | @end ifclear | |
19591 | for the detailed description of the History library. | |
703663ab | 19592 | |
d620b259 | 19593 | To issue a command to @value{GDBN} without affecting certain aspects of |
9e6c4bd5 NR |
19594 | the state which is seen by users, prefix it with @samp{server } |
19595 | (@pxref{Server Prefix}). This | |
d620b259 NR |
19596 | means that this command will not affect the command history, nor will it |
19597 | affect @value{GDBN}'s notion of which command to repeat if @key{RET} is | |
19598 | pressed on a line by itself. | |
19599 | ||
19600 | @cindex @code{server}, command prefix | |
19601 | The server prefix does not affect the recording of values into the value | |
19602 | history; to print a value without recording it into the value history, | |
19603 | use the @code{output} command instead of the @code{print} command. | |
19604 | ||
703663ab EZ |
19605 | Here is the description of @value{GDBN} commands related to command |
19606 | history. | |
19607 | ||
104c1213 | 19608 | @table @code |
8e04817f AC |
19609 | @cindex history substitution |
19610 | @cindex history file | |
19611 | @kindex set history filename | |
4644b6e3 | 19612 | @cindex @env{GDBHISTFILE}, environment variable |
8e04817f AC |
19613 | @item set history filename @var{fname} |
19614 | Set the name of the @value{GDBN} command history file to @var{fname}. | |
19615 | This is the file where @value{GDBN} reads an initial command history | |
19616 | list, and where it writes the command history from this session when it | |
19617 | exits. You can access this list through history expansion or through | |
19618 | the history command editing characters listed below. This file defaults | |
19619 | to the value of the environment variable @code{GDBHISTFILE}, or to | |
19620 | @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable | |
19621 | is not set. | |
104c1213 | 19622 | |
9c16f35a EZ |
19623 | @cindex save command history |
19624 | @kindex set history save | |
8e04817f AC |
19625 | @item set history save |
19626 | @itemx set history save on | |
19627 | Record command history in a file, whose name may be specified with the | |
19628 | @code{set history filename} command. By default, this option is disabled. | |
104c1213 | 19629 | |
8e04817f AC |
19630 | @item set history save off |
19631 | Stop recording command history in a file. | |
104c1213 | 19632 | |
8e04817f | 19633 | @cindex history size |
9c16f35a | 19634 | @kindex set history size |
6fc08d32 | 19635 | @cindex @env{HISTSIZE}, environment variable |
8e04817f AC |
19636 | @item set history size @var{size} |
19637 | Set the number of commands which @value{GDBN} keeps in its history list. | |
19638 | This defaults to the value of the environment variable | |
19639 | @code{HISTSIZE}, or to 256 if this variable is not set. | |
104c1213 JM |
19640 | @end table |
19641 | ||
8e04817f | 19642 | History expansion assigns special meaning to the character @kbd{!}. |
39037522 TT |
19643 | @ifset SYSTEM_READLINE |
19644 | @xref{Event Designators, , , history, GNU History Library}, | |
19645 | @end ifset | |
19646 | @ifclear SYSTEM_READLINE | |
19647 | @xref{Event Designators}, | |
19648 | @end ifclear | |
19649 | for more details. | |
8e04817f | 19650 | |
703663ab | 19651 | @cindex history expansion, turn on/off |
8e04817f AC |
19652 | Since @kbd{!} is also the logical not operator in C, history expansion |
19653 | is off by default. If you decide to enable history expansion with the | |
19654 | @code{set history expansion on} command, you may sometimes need to | |
19655 | follow @kbd{!} (when it is used as logical not, in an expression) with | |
19656 | a space or a tab to prevent it from being expanded. The readline | |
19657 | history facilities do not attempt substitution on the strings | |
19658 | @kbd{!=} and @kbd{!(}, even when history expansion is enabled. | |
19659 | ||
19660 | The commands to control history expansion are: | |
104c1213 JM |
19661 | |
19662 | @table @code | |
8e04817f AC |
19663 | @item set history expansion on |
19664 | @itemx set history expansion | |
703663ab | 19665 | @kindex set history expansion |
8e04817f | 19666 | Enable history expansion. History expansion is off by default. |
104c1213 | 19667 | |
8e04817f AC |
19668 | @item set history expansion off |
19669 | Disable history expansion. | |
104c1213 | 19670 | |
8e04817f AC |
19671 | @c @group |
19672 | @kindex show history | |
19673 | @item show history | |
19674 | @itemx show history filename | |
19675 | @itemx show history save | |
19676 | @itemx show history size | |
19677 | @itemx show history expansion | |
19678 | These commands display the state of the @value{GDBN} history parameters. | |
19679 | @code{show history} by itself displays all four states. | |
19680 | @c @end group | |
19681 | @end table | |
19682 | ||
19683 | @table @code | |
9c16f35a EZ |
19684 | @kindex show commands |
19685 | @cindex show last commands | |
19686 | @cindex display command history | |
8e04817f AC |
19687 | @item show commands |
19688 | Display the last ten commands in the command history. | |
104c1213 | 19689 | |
8e04817f AC |
19690 | @item show commands @var{n} |
19691 | Print ten commands centered on command number @var{n}. | |
19692 | ||
19693 | @item show commands + | |
19694 | Print ten commands just after the commands last printed. | |
104c1213 JM |
19695 | @end table |
19696 | ||
8e04817f | 19697 | @node Screen Size |
79a6e687 | 19698 | @section Screen Size |
8e04817f AC |
19699 | @cindex size of screen |
19700 | @cindex pauses in output | |
104c1213 | 19701 | |
8e04817f AC |
19702 | Certain commands to @value{GDBN} may produce large amounts of |
19703 | information output to the screen. To help you read all of it, | |
19704 | @value{GDBN} pauses and asks you for input at the end of each page of | |
19705 | output. Type @key{RET} when you want to continue the output, or @kbd{q} | |
19706 | to discard the remaining output. Also, the screen width setting | |
19707 | determines when to wrap lines of output. Depending on what is being | |
19708 | printed, @value{GDBN} tries to break the line at a readable place, | |
19709 | rather than simply letting it overflow onto the following line. | |
19710 | ||
19711 | Normally @value{GDBN} knows the size of the screen from the terminal | |
19712 | driver software. For example, on Unix @value{GDBN} uses the termcap data base | |
19713 | together with the value of the @code{TERM} environment variable and the | |
19714 | @code{stty rows} and @code{stty cols} settings. If this is not correct, | |
19715 | you can override it with the @code{set height} and @code{set | |
19716 | width} commands: | |
19717 | ||
19718 | @table @code | |
19719 | @kindex set height | |
19720 | @kindex set width | |
19721 | @kindex show width | |
19722 | @kindex show height | |
19723 | @item set height @var{lpp} | |
19724 | @itemx show height | |
19725 | @itemx set width @var{cpl} | |
19726 | @itemx show width | |
19727 | These @code{set} commands specify a screen height of @var{lpp} lines and | |
19728 | a screen width of @var{cpl} characters. The associated @code{show} | |
19729 | commands display the current settings. | |
104c1213 | 19730 | |
8e04817f AC |
19731 | If you specify a height of zero lines, @value{GDBN} does not pause during |
19732 | output no matter how long the output is. This is useful if output is to a | |
19733 | file or to an editor buffer. | |
104c1213 | 19734 | |
8e04817f AC |
19735 | Likewise, you can specify @samp{set width 0} to prevent @value{GDBN} |
19736 | from wrapping its output. | |
9c16f35a EZ |
19737 | |
19738 | @item set pagination on | |
19739 | @itemx set pagination off | |
19740 | @kindex set pagination | |
19741 | Turn the output pagination on or off; the default is on. Turning | |
7c953934 TT |
19742 | pagination off is the alternative to @code{set height 0}. Note that |
19743 | running @value{GDBN} with the @option{--batch} option (@pxref{Mode | |
19744 | Options, -batch}) also automatically disables pagination. | |
9c16f35a EZ |
19745 | |
19746 | @item show pagination | |
19747 | @kindex show pagination | |
19748 | Show the current pagination mode. | |
104c1213 JM |
19749 | @end table |
19750 | ||
8e04817f AC |
19751 | @node Numbers |
19752 | @section Numbers | |
19753 | @cindex number representation | |
19754 | @cindex entering numbers | |
104c1213 | 19755 | |
8e04817f AC |
19756 | You can always enter numbers in octal, decimal, or hexadecimal in |
19757 | @value{GDBN} by the usual conventions: octal numbers begin with | |
19758 | @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers | |
eb2dae08 EZ |
19759 | begin with @samp{0x}. Numbers that neither begin with @samp{0} or |
19760 | @samp{0x}, nor end with a @samp{.} are, by default, entered in base | |
19761 | 10; likewise, the default display for numbers---when no particular | |
19762 | format is specified---is base 10. You can change the default base for | |
19763 | both input and output with the commands described below. | |
104c1213 | 19764 | |
8e04817f AC |
19765 | @table @code |
19766 | @kindex set input-radix | |
19767 | @item set input-radix @var{base} | |
19768 | Set the default base for numeric input. Supported choices | |
19769 | for @var{base} are decimal 8, 10, or 16. @var{base} must itself be | |
eb2dae08 | 19770 | specified either unambiguously or using the current input radix; for |
8e04817f | 19771 | example, any of |
104c1213 | 19772 | |
8e04817f | 19773 | @smallexample |
9c16f35a EZ |
19774 | set input-radix 012 |
19775 | set input-radix 10. | |
19776 | set input-radix 0xa | |
8e04817f | 19777 | @end smallexample |
104c1213 | 19778 | |
8e04817f | 19779 | @noindent |
9c16f35a | 19780 | sets the input base to decimal. On the other hand, @samp{set input-radix 10} |
eb2dae08 EZ |
19781 | leaves the input radix unchanged, no matter what it was, since |
19782 | @samp{10}, being without any leading or trailing signs of its base, is | |
19783 | interpreted in the current radix. Thus, if the current radix is 16, | |
19784 | @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't | |
19785 | change the radix. | |
104c1213 | 19786 | |
8e04817f AC |
19787 | @kindex set output-radix |
19788 | @item set output-radix @var{base} | |
19789 | Set the default base for numeric display. Supported choices | |
19790 | for @var{base} are decimal 8, 10, or 16. @var{base} must itself be | |
eb2dae08 | 19791 | specified either unambiguously or using the current input radix. |
104c1213 | 19792 | |
8e04817f AC |
19793 | @kindex show input-radix |
19794 | @item show input-radix | |
19795 | Display the current default base for numeric input. | |
104c1213 | 19796 | |
8e04817f AC |
19797 | @kindex show output-radix |
19798 | @item show output-radix | |
19799 | Display the current default base for numeric display. | |
9c16f35a EZ |
19800 | |
19801 | @item set radix @r{[}@var{base}@r{]} | |
19802 | @itemx show radix | |
19803 | @kindex set radix | |
19804 | @kindex show radix | |
19805 | These commands set and show the default base for both input and output | |
19806 | of numbers. @code{set radix} sets the radix of input and output to | |
19807 | the same base; without an argument, it resets the radix back to its | |
19808 | default value of 10. | |
19809 | ||
8e04817f | 19810 | @end table |
104c1213 | 19811 | |
1e698235 | 19812 | @node ABI |
79a6e687 | 19813 | @section Configuring the Current ABI |
1e698235 DJ |
19814 | |
19815 | @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your | |
19816 | application automatically. However, sometimes you need to override its | |
19817 | conclusions. Use these commands to manage @value{GDBN}'s view of the | |
19818 | current ABI. | |
19819 | ||
98b45e30 DJ |
19820 | @cindex OS ABI |
19821 | @kindex set osabi | |
b4e9345d | 19822 | @kindex show osabi |
98b45e30 DJ |
19823 | |
19824 | One @value{GDBN} configuration can debug binaries for multiple operating | |
b383017d | 19825 | system targets, either via remote debugging or native emulation. |
98b45e30 DJ |
19826 | @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use, |
19827 | but you can override its conclusion using the @code{set osabi} command. | |
19828 | One example where this is useful is in debugging of binaries which use | |
19829 | an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does | |
19830 | not have the same identifying marks that the standard C library for your | |
19831 | platform provides. | |
19832 | ||
19833 | @table @code | |
19834 | @item show osabi | |
19835 | Show the OS ABI currently in use. | |
19836 | ||
19837 | @item set osabi | |
19838 | With no argument, show the list of registered available OS ABI's. | |
19839 | ||
19840 | @item set osabi @var{abi} | |
19841 | Set the current OS ABI to @var{abi}. | |
19842 | @end table | |
19843 | ||
1e698235 | 19844 | @cindex float promotion |
1e698235 DJ |
19845 | |
19846 | Generally, the way that an argument of type @code{float} is passed to a | |
19847 | function depends on whether the function is prototyped. For a prototyped | |
19848 | (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged, | |
19849 | according to the architecture's convention for @code{float}. For unprototyped | |
19850 | (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type | |
19851 | @code{double} and then passed. | |
19852 | ||
19853 | Unfortunately, some forms of debug information do not reliably indicate whether | |
19854 | a function is prototyped. If @value{GDBN} calls a function that is not marked | |
19855 | as prototyped, it consults @kbd{set coerce-float-to-double}. | |
19856 | ||
19857 | @table @code | |
a8f24a35 | 19858 | @kindex set coerce-float-to-double |
1e698235 DJ |
19859 | @item set coerce-float-to-double |
19860 | @itemx set coerce-float-to-double on | |
19861 | Arguments of type @code{float} will be promoted to @code{double} when passed | |
19862 | to an unprototyped function. This is the default setting. | |
19863 | ||
19864 | @item set coerce-float-to-double off | |
19865 | Arguments of type @code{float} will be passed directly to unprototyped | |
19866 | functions. | |
9c16f35a EZ |
19867 | |
19868 | @kindex show coerce-float-to-double | |
19869 | @item show coerce-float-to-double | |
19870 | Show the current setting of promoting @code{float} to @code{double}. | |
1e698235 DJ |
19871 | @end table |
19872 | ||
f1212245 DJ |
19873 | @kindex set cp-abi |
19874 | @kindex show cp-abi | |
19875 | @value{GDBN} needs to know the ABI used for your program's C@t{++} | |
19876 | objects. The correct C@t{++} ABI depends on which C@t{++} compiler was | |
19877 | used to build your application. @value{GDBN} only fully supports | |
19878 | programs with a single C@t{++} ABI; if your program contains code using | |
19879 | multiple C@t{++} ABI's or if @value{GDBN} can not identify your | |
19880 | program's ABI correctly, you can tell @value{GDBN} which ABI to use. | |
19881 | Currently supported ABI's include ``gnu-v2'', for @code{g++} versions | |
19882 | before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and | |
19883 | ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may | |
19884 | use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is | |
19885 | ``auto''. | |
19886 | ||
19887 | @table @code | |
19888 | @item show cp-abi | |
19889 | Show the C@t{++} ABI currently in use. | |
19890 | ||
19891 | @item set cp-abi | |
19892 | With no argument, show the list of supported C@t{++} ABI's. | |
19893 | ||
19894 | @item set cp-abi @var{abi} | |
19895 | @itemx set cp-abi auto | |
19896 | Set the current C@t{++} ABI to @var{abi}, or return to automatic detection. | |
19897 | @end table | |
19898 | ||
8e04817f | 19899 | @node Messages/Warnings |
79a6e687 | 19900 | @section Optional Warnings and Messages |
104c1213 | 19901 | |
9c16f35a EZ |
19902 | @cindex verbose operation |
19903 | @cindex optional warnings | |
8e04817f AC |
19904 | By default, @value{GDBN} is silent about its inner workings. If you are |
19905 | running on a slow machine, you may want to use the @code{set verbose} | |
19906 | command. This makes @value{GDBN} tell you when it does a lengthy | |
19907 | internal operation, so you will not think it has crashed. | |
104c1213 | 19908 | |
8e04817f AC |
19909 | Currently, the messages controlled by @code{set verbose} are those |
19910 | which announce that the symbol table for a source file is being read; | |
79a6e687 | 19911 | see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}. |
104c1213 | 19912 | |
8e04817f AC |
19913 | @table @code |
19914 | @kindex set verbose | |
19915 | @item set verbose on | |
19916 | Enables @value{GDBN} output of certain informational messages. | |
104c1213 | 19917 | |
8e04817f AC |
19918 | @item set verbose off |
19919 | Disables @value{GDBN} output of certain informational messages. | |
104c1213 | 19920 | |
8e04817f AC |
19921 | @kindex show verbose |
19922 | @item show verbose | |
19923 | Displays whether @code{set verbose} is on or off. | |
19924 | @end table | |
104c1213 | 19925 | |
8e04817f AC |
19926 | By default, if @value{GDBN} encounters bugs in the symbol table of an |
19927 | object file, it is silent; but if you are debugging a compiler, you may | |
79a6e687 BW |
19928 | find this information useful (@pxref{Symbol Errors, ,Errors Reading |
19929 | Symbol Files}). | |
104c1213 | 19930 | |
8e04817f | 19931 | @table @code |
104c1213 | 19932 | |
8e04817f AC |
19933 | @kindex set complaints |
19934 | @item set complaints @var{limit} | |
19935 | Permits @value{GDBN} to output @var{limit} complaints about each type of | |
19936 | unusual symbols before becoming silent about the problem. Set | |
19937 | @var{limit} to zero to suppress all complaints; set it to a large number | |
19938 | to prevent complaints from being suppressed. | |
104c1213 | 19939 | |
8e04817f AC |
19940 | @kindex show complaints |
19941 | @item show complaints | |
19942 | Displays how many symbol complaints @value{GDBN} is permitted to produce. | |
104c1213 | 19943 | |
8e04817f | 19944 | @end table |
104c1213 | 19945 | |
d837706a | 19946 | @anchor{confirmation requests} |
8e04817f AC |
19947 | By default, @value{GDBN} is cautious, and asks what sometimes seems to be a |
19948 | lot of stupid questions to confirm certain commands. For example, if | |
19949 | you try to run a program which is already running: | |
104c1213 | 19950 | |
474c8240 | 19951 | @smallexample |
8e04817f AC |
19952 | (@value{GDBP}) run |
19953 | The program being debugged has been started already. | |
19954 | Start it from the beginning? (y or n) | |
474c8240 | 19955 | @end smallexample |
104c1213 | 19956 | |
8e04817f AC |
19957 | If you are willing to unflinchingly face the consequences of your own |
19958 | commands, you can disable this ``feature'': | |
104c1213 | 19959 | |
8e04817f | 19960 | @table @code |
104c1213 | 19961 | |
8e04817f AC |
19962 | @kindex set confirm |
19963 | @cindex flinching | |
19964 | @cindex confirmation | |
19965 | @cindex stupid questions | |
19966 | @item set confirm off | |
7c953934 TT |
19967 | Disables confirmation requests. Note that running @value{GDBN} with |
19968 | the @option{--batch} option (@pxref{Mode Options, -batch}) also | |
19969 | automatically disables confirmation requests. | |
104c1213 | 19970 | |
8e04817f AC |
19971 | @item set confirm on |
19972 | Enables confirmation requests (the default). | |
104c1213 | 19973 | |
8e04817f AC |
19974 | @kindex show confirm |
19975 | @item show confirm | |
19976 | Displays state of confirmation requests. | |
19977 | ||
19978 | @end table | |
104c1213 | 19979 | |
16026cd7 AS |
19980 | @cindex command tracing |
19981 | If you need to debug user-defined commands or sourced files you may find it | |
19982 | useful to enable @dfn{command tracing}. In this mode each command will be | |
19983 | printed as it is executed, prefixed with one or more @samp{+} symbols, the | |
19984 | quantity denoting the call depth of each command. | |
19985 | ||
19986 | @table @code | |
19987 | @kindex set trace-commands | |
19988 | @cindex command scripts, debugging | |
19989 | @item set trace-commands on | |
19990 | Enable command tracing. | |
19991 | @item set trace-commands off | |
19992 | Disable command tracing. | |
19993 | @item show trace-commands | |
19994 | Display the current state of command tracing. | |
19995 | @end table | |
19996 | ||
8e04817f | 19997 | @node Debugging Output |
79a6e687 | 19998 | @section Optional Messages about Internal Happenings |
4644b6e3 EZ |
19999 | @cindex optional debugging messages |
20000 | ||
da316a69 EZ |
20001 | @value{GDBN} has commands that enable optional debugging messages from |
20002 | various @value{GDBN} subsystems; normally these commands are of | |
20003 | interest to @value{GDBN} maintainers, or when reporting a bug. This | |
20004 | section documents those commands. | |
20005 | ||
104c1213 | 20006 | @table @code |
a8f24a35 EZ |
20007 | @kindex set exec-done-display |
20008 | @item set exec-done-display | |
20009 | Turns on or off the notification of asynchronous commands' | |
20010 | completion. When on, @value{GDBN} will print a message when an | |
20011 | asynchronous command finishes its execution. The default is off. | |
20012 | @kindex show exec-done-display | |
20013 | @item show exec-done-display | |
20014 | Displays the current setting of asynchronous command completion | |
20015 | notification. | |
4644b6e3 EZ |
20016 | @kindex set debug |
20017 | @cindex gdbarch debugging info | |
a8f24a35 | 20018 | @cindex architecture debugging info |
8e04817f | 20019 | @item set debug arch |
a8f24a35 | 20020 | Turns on or off display of gdbarch debugging info. The default is off |
4644b6e3 | 20021 | @kindex show debug |
8e04817f AC |
20022 | @item show debug arch |
20023 | Displays the current state of displaying gdbarch debugging info. | |
721c2651 EZ |
20024 | @item set debug aix-thread |
20025 | @cindex AIX threads | |
20026 | Display debugging messages about inner workings of the AIX thread | |
20027 | module. | |
20028 | @item show debug aix-thread | |
20029 | Show the current state of AIX thread debugging info display. | |
d97bc12b DE |
20030 | @item set debug dwarf2-die |
20031 | @cindex DWARF2 DIEs | |
20032 | Dump DWARF2 DIEs after they are read in. | |
20033 | The value is the number of nesting levels to print. | |
20034 | A value of zero turns off the display. | |
20035 | @item show debug dwarf2-die | |
20036 | Show the current state of DWARF2 DIE debugging. | |
237fc4c9 PA |
20037 | @item set debug displaced |
20038 | @cindex displaced stepping debugging info | |
20039 | Turns on or off display of @value{GDBN} debugging info for the | |
20040 | displaced stepping support. The default is off. | |
20041 | @item show debug displaced | |
20042 | Displays the current state of displaying @value{GDBN} debugging info | |
20043 | related to displaced stepping. | |
8e04817f | 20044 | @item set debug event |
4644b6e3 | 20045 | @cindex event debugging info |
a8f24a35 | 20046 | Turns on or off display of @value{GDBN} event debugging info. The |
8e04817f | 20047 | default is off. |
8e04817f AC |
20048 | @item show debug event |
20049 | Displays the current state of displaying @value{GDBN} event debugging | |
20050 | info. | |
8e04817f | 20051 | @item set debug expression |
4644b6e3 | 20052 | @cindex expression debugging info |
721c2651 EZ |
20053 | Turns on or off display of debugging info about @value{GDBN} |
20054 | expression parsing. The default is off. | |
8e04817f | 20055 | @item show debug expression |
721c2651 EZ |
20056 | Displays the current state of displaying debugging info about |
20057 | @value{GDBN} expression parsing. | |
7453dc06 | 20058 | @item set debug frame |
4644b6e3 | 20059 | @cindex frame debugging info |
7453dc06 AC |
20060 | Turns on or off display of @value{GDBN} frame debugging info. The |
20061 | default is off. | |
7453dc06 AC |
20062 | @item show debug frame |
20063 | Displays the current state of displaying @value{GDBN} frame debugging | |
20064 | info. | |
cbe54154 PA |
20065 | @item set debug gnu-nat |
20066 | @cindex @sc{gnu}/Hurd debug messages | |
20067 | Turns on or off debugging messages from the @sc{gnu}/Hurd debug support. | |
20068 | @item show debug gnu-nat | |
20069 | Show the current state of @sc{gnu}/Hurd debugging messages. | |
30e91e0b RC |
20070 | @item set debug infrun |
20071 | @cindex inferior debugging info | |
20072 | Turns on or off display of @value{GDBN} debugging info for running the inferior. | |
20073 | The default is off. @file{infrun.c} contains GDB's runtime state machine used | |
20074 | for implementing operations such as single-stepping the inferior. | |
20075 | @item show debug infrun | |
20076 | Displays the current state of @value{GDBN} inferior debugging. | |
a255712f PP |
20077 | @item set debug jit |
20078 | @cindex just-in-time compilation, debugging messages | |
20079 | Turns on or off debugging messages from JIT debug support. | |
20080 | @item show debug jit | |
20081 | Displays the current state of @value{GDBN} JIT debugging. | |
da316a69 EZ |
20082 | @item set debug lin-lwp |
20083 | @cindex @sc{gnu}/Linux LWP debug messages | |
20084 | @cindex Linux lightweight processes | |
721c2651 | 20085 | Turns on or off debugging messages from the Linux LWP debug support. |
da316a69 EZ |
20086 | @item show debug lin-lwp |
20087 | Show the current state of Linux LWP debugging messages. | |
2b4855ab | 20088 | @item set debug observer |
4644b6e3 | 20089 | @cindex observer debugging info |
2b4855ab AC |
20090 | Turns on or off display of @value{GDBN} observer debugging. This |
20091 | includes info such as the notification of observable events. | |
2b4855ab AC |
20092 | @item show debug observer |
20093 | Displays the current state of observer debugging. | |
8e04817f | 20094 | @item set debug overload |
4644b6e3 | 20095 | @cindex C@t{++} overload debugging info |
8e04817f | 20096 | Turns on or off display of @value{GDBN} C@t{++} overload debugging |
359df76b | 20097 | info. This includes info such as ranking of functions, etc. The default |
8e04817f | 20098 | is off. |
8e04817f AC |
20099 | @item show debug overload |
20100 | Displays the current state of displaying @value{GDBN} C@t{++} overload | |
20101 | debugging info. | |
92981e24 TT |
20102 | @cindex expression parser, debugging info |
20103 | @cindex debug expression parser | |
20104 | @item set debug parser | |
20105 | Turns on or off the display of expression parser debugging output. | |
20106 | Internally, this sets the @code{yydebug} variable in the expression | |
20107 | parser. @xref{Tracing, , Tracing Your Parser, bison, Bison}, for | |
20108 | details. The default is off. | |
20109 | @item show debug parser | |
20110 | Show the current state of expression parser debugging. | |
8e04817f AC |
20111 | @cindex packets, reporting on stdout |
20112 | @cindex serial connections, debugging | |
605a56cb DJ |
20113 | @cindex debug remote protocol |
20114 | @cindex remote protocol debugging | |
20115 | @cindex display remote packets | |
8e04817f AC |
20116 | @item set debug remote |
20117 | Turns on or off display of reports on all packets sent back and forth across | |
20118 | the serial line to the remote machine. The info is printed on the | |
20119 | @value{GDBN} standard output stream. The default is off. | |
8e04817f AC |
20120 | @item show debug remote |
20121 | Displays the state of display of remote packets. | |
8e04817f AC |
20122 | @item set debug serial |
20123 | Turns on or off display of @value{GDBN} serial debugging info. The | |
20124 | default is off. | |
8e04817f AC |
20125 | @item show debug serial |
20126 | Displays the current state of displaying @value{GDBN} serial debugging | |
20127 | info. | |
c45da7e6 EZ |
20128 | @item set debug solib-frv |
20129 | @cindex FR-V shared-library debugging | |
20130 | Turns on or off debugging messages for FR-V shared-library code. | |
20131 | @item show debug solib-frv | |
20132 | Display the current state of FR-V shared-library code debugging | |
20133 | messages. | |
8e04817f | 20134 | @item set debug target |
4644b6e3 | 20135 | @cindex target debugging info |
8e04817f AC |
20136 | Turns on or off display of @value{GDBN} target debugging info. This info |
20137 | includes what is going on at the target level of GDB, as it happens. The | |
701b08bb DJ |
20138 | default is 0. Set it to 1 to track events, and to 2 to also track the |
20139 | value of large memory transfers. Changes to this flag do not take effect | |
20140 | until the next time you connect to a target or use the @code{run} command. | |
8e04817f AC |
20141 | @item show debug target |
20142 | Displays the current state of displaying @value{GDBN} target debugging | |
20143 | info. | |
75feb17d DJ |
20144 | @item set debug timestamp |
20145 | @cindex timestampping debugging info | |
20146 | Turns on or off display of timestamps with @value{GDBN} debugging info. | |
20147 | When enabled, seconds and microseconds are displayed before each debugging | |
20148 | message. | |
20149 | @item show debug timestamp | |
20150 | Displays the current state of displaying timestamps with @value{GDBN} | |
20151 | debugging info. | |
c45da7e6 | 20152 | @item set debugvarobj |
4644b6e3 | 20153 | @cindex variable object debugging info |
8e04817f AC |
20154 | Turns on or off display of @value{GDBN} variable object debugging |
20155 | info. The default is off. | |
c45da7e6 | 20156 | @item show debugvarobj |
8e04817f AC |
20157 | Displays the current state of displaying @value{GDBN} variable object |
20158 | debugging info. | |
e776119f DJ |
20159 | @item set debug xml |
20160 | @cindex XML parser debugging | |
20161 | Turns on or off debugging messages for built-in XML parsers. | |
20162 | @item show debug xml | |
20163 | Displays the current state of XML debugging messages. | |
8e04817f | 20164 | @end table |
104c1213 | 20165 | |
14fb1bac JB |
20166 | @node Other Misc Settings |
20167 | @section Other Miscellaneous Settings | |
20168 | @cindex miscellaneous settings | |
20169 | ||
20170 | @table @code | |
20171 | @kindex set interactive-mode | |
20172 | @item set interactive-mode | |
7bfc9434 JB |
20173 | If @code{on}, forces @value{GDBN} to assume that GDB was started |
20174 | in a terminal. In practice, this means that @value{GDBN} should wait | |
20175 | for the user to answer queries generated by commands entered at | |
20176 | the command prompt. If @code{off}, forces @value{GDBN} to operate | |
20177 | in the opposite mode, and it uses the default answers to all queries. | |
20178 | If @code{auto} (the default), @value{GDBN} tries to determine whether | |
20179 | its standard input is a terminal, and works in interactive-mode if it | |
20180 | is, non-interactively otherwise. | |
14fb1bac JB |
20181 | |
20182 | In the vast majority of cases, the debugger should be able to guess | |
20183 | correctly which mode should be used. But this setting can be useful | |
20184 | in certain specific cases, such as running a MinGW @value{GDBN} | |
20185 | inside a cygwin window. | |
20186 | ||
20187 | @kindex show interactive-mode | |
20188 | @item show interactive-mode | |
20189 | Displays whether the debugger is operating in interactive mode or not. | |
20190 | @end table | |
20191 | ||
d57a3c85 TJB |
20192 | @node Extending GDB |
20193 | @chapter Extending @value{GDBN} | |
20194 | @cindex extending GDB | |
20195 | ||
20196 | @value{GDBN} provides two mechanisms for extension. The first is based | |
20197 | on composition of @value{GDBN} commands, and the second is based on the | |
20198 | Python scripting language. | |
20199 | ||
95433b34 JB |
20200 | To facilitate the use of these extensions, @value{GDBN} is capable |
20201 | of evaluating the contents of a file. When doing so, @value{GDBN} | |
20202 | can recognize which scripting language is being used by looking at | |
20203 | the filename extension. Files with an unrecognized filename extension | |
20204 | are always treated as a @value{GDBN} Command Files. | |
20205 | @xref{Command Files,, Command files}. | |
20206 | ||
20207 | You can control how @value{GDBN} evaluates these files with the following | |
20208 | setting: | |
20209 | ||
20210 | @table @code | |
20211 | @kindex set script-extension | |
20212 | @kindex show script-extension | |
20213 | @item set script-extension off | |
20214 | All scripts are always evaluated as @value{GDBN} Command Files. | |
20215 | ||
20216 | @item set script-extension soft | |
20217 | The debugger determines the scripting language based on filename | |
20218 | extension. If this scripting language is supported, @value{GDBN} | |
20219 | evaluates the script using that language. Otherwise, it evaluates | |
20220 | the file as a @value{GDBN} Command File. | |
20221 | ||
20222 | @item set script-extension strict | |
20223 | The debugger determines the scripting language based on filename | |
20224 | extension, and evaluates the script using that language. If the | |
20225 | language is not supported, then the evaluation fails. | |
20226 | ||
20227 | @item show script-extension | |
20228 | Display the current value of the @code{script-extension} option. | |
20229 | ||
20230 | @end table | |
20231 | ||
d57a3c85 TJB |
20232 | @menu |
20233 | * Sequences:: Canned Sequences of Commands | |
20234 | * Python:: Scripting @value{GDBN} using Python | |
20235 | @end menu | |
20236 | ||
8e04817f | 20237 | @node Sequences |
d57a3c85 | 20238 | @section Canned Sequences of Commands |
104c1213 | 20239 | |
8e04817f | 20240 | Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint |
79a6e687 | 20241 | Command Lists}), @value{GDBN} provides two ways to store sequences of |
8e04817f AC |
20242 | commands for execution as a unit: user-defined commands and command |
20243 | files. | |
104c1213 | 20244 | |
8e04817f | 20245 | @menu |
fcc73fe3 EZ |
20246 | * Define:: How to define your own commands |
20247 | * Hooks:: Hooks for user-defined commands | |
20248 | * Command Files:: How to write scripts of commands to be stored in a file | |
20249 | * Output:: Commands for controlled output | |
8e04817f | 20250 | @end menu |
104c1213 | 20251 | |
8e04817f | 20252 | @node Define |
d57a3c85 | 20253 | @subsection User-defined Commands |
104c1213 | 20254 | |
8e04817f | 20255 | @cindex user-defined command |
fcc73fe3 | 20256 | @cindex arguments, to user-defined commands |
8e04817f AC |
20257 | A @dfn{user-defined command} is a sequence of @value{GDBN} commands to |
20258 | which you assign a new name as a command. This is done with the | |
20259 | @code{define} command. User commands may accept up to 10 arguments | |
20260 | separated by whitespace. Arguments are accessed within the user command | |
c03c782f | 20261 | via @code{$arg0@dots{}$arg9}. A trivial example: |
104c1213 | 20262 | |
8e04817f AC |
20263 | @smallexample |
20264 | define adder | |
20265 | print $arg0 + $arg1 + $arg2 | |
c03c782f | 20266 | end |
8e04817f | 20267 | @end smallexample |
104c1213 JM |
20268 | |
20269 | @noindent | |
8e04817f | 20270 | To execute the command use: |
104c1213 | 20271 | |
8e04817f AC |
20272 | @smallexample |
20273 | adder 1 2 3 | |
20274 | @end smallexample | |
104c1213 | 20275 | |
8e04817f AC |
20276 | @noindent |
20277 | This defines the command @code{adder}, which prints the sum of | |
20278 | its three arguments. Note the arguments are text substitutions, so they may | |
20279 | reference variables, use complex expressions, or even perform inferior | |
20280 | functions calls. | |
104c1213 | 20281 | |
fcc73fe3 EZ |
20282 | @cindex argument count in user-defined commands |
20283 | @cindex how many arguments (user-defined commands) | |
c03c782f AS |
20284 | In addition, @code{$argc} may be used to find out how many arguments have |
20285 | been passed. This expands to a number in the range 0@dots{}10. | |
20286 | ||
20287 | @smallexample | |
20288 | define adder | |
20289 | if $argc == 2 | |
20290 | print $arg0 + $arg1 | |
20291 | end | |
20292 | if $argc == 3 | |
20293 | print $arg0 + $arg1 + $arg2 | |
20294 | end | |
20295 | end | |
20296 | @end smallexample | |
20297 | ||
104c1213 | 20298 | @table @code |
104c1213 | 20299 | |
8e04817f AC |
20300 | @kindex define |
20301 | @item define @var{commandname} | |
20302 | Define a command named @var{commandname}. If there is already a command | |
20303 | by that name, you are asked to confirm that you want to redefine it. | |
adb483fe DJ |
20304 | @var{commandname} may be a bare command name consisting of letters, |
20305 | numbers, dashes, and underscores. It may also start with any predefined | |
20306 | prefix command. For example, @samp{define target my-target} creates | |
20307 | a user-defined @samp{target my-target} command. | |
104c1213 | 20308 | |
8e04817f AC |
20309 | The definition of the command is made up of other @value{GDBN} command lines, |
20310 | which are given following the @code{define} command. The end of these | |
20311 | commands is marked by a line containing @code{end}. | |
104c1213 | 20312 | |
8e04817f | 20313 | @kindex document |
ca91424e | 20314 | @kindex end@r{ (user-defined commands)} |
8e04817f AC |
20315 | @item document @var{commandname} |
20316 | Document the user-defined command @var{commandname}, so that it can be | |
20317 | accessed by @code{help}. The command @var{commandname} must already be | |
20318 | defined. This command reads lines of documentation just as @code{define} | |
20319 | reads the lines of the command definition, ending with @code{end}. | |
20320 | After the @code{document} command is finished, @code{help} on command | |
20321 | @var{commandname} displays the documentation you have written. | |
104c1213 | 20322 | |
8e04817f AC |
20323 | You may use the @code{document} command again to change the |
20324 | documentation of a command. Redefining the command with @code{define} | |
20325 | does not change the documentation. | |
104c1213 | 20326 | |
c45da7e6 EZ |
20327 | @kindex dont-repeat |
20328 | @cindex don't repeat command | |
20329 | @item dont-repeat | |
20330 | Used inside a user-defined command, this tells @value{GDBN} that this | |
20331 | command should not be repeated when the user hits @key{RET} | |
20332 | (@pxref{Command Syntax, repeat last command}). | |
20333 | ||
8e04817f AC |
20334 | @kindex help user-defined |
20335 | @item help user-defined | |
20336 | List all user-defined commands, with the first line of the documentation | |
20337 | (if any) for each. | |
104c1213 | 20338 | |
8e04817f AC |
20339 | @kindex show user |
20340 | @item show user | |
20341 | @itemx show user @var{commandname} | |
20342 | Display the @value{GDBN} commands used to define @var{commandname} (but | |
20343 | not its documentation). If no @var{commandname} is given, display the | |
20344 | definitions for all user-defined commands. | |
104c1213 | 20345 | |
fcc73fe3 | 20346 | @cindex infinite recursion in user-defined commands |
20f01a46 DH |
20347 | @kindex show max-user-call-depth |
20348 | @kindex set max-user-call-depth | |
20349 | @item show max-user-call-depth | |
5ca0cb28 DH |
20350 | @itemx set max-user-call-depth |
20351 | The value of @code{max-user-call-depth} controls how many recursion | |
3f94c067 | 20352 | levels are allowed in user-defined commands before @value{GDBN} suspects an |
5ca0cb28 | 20353 | infinite recursion and aborts the command. |
104c1213 JM |
20354 | @end table |
20355 | ||
fcc73fe3 EZ |
20356 | In addition to the above commands, user-defined commands frequently |
20357 | use control flow commands, described in @ref{Command Files}. | |
20358 | ||
8e04817f AC |
20359 | When user-defined commands are executed, the |
20360 | commands of the definition are not printed. An error in any command | |
20361 | stops execution of the user-defined command. | |
104c1213 | 20362 | |
8e04817f AC |
20363 | If used interactively, commands that would ask for confirmation proceed |
20364 | without asking when used inside a user-defined command. Many @value{GDBN} | |
20365 | commands that normally print messages to say what they are doing omit the | |
20366 | messages when used in a user-defined command. | |
104c1213 | 20367 | |
8e04817f | 20368 | @node Hooks |
d57a3c85 | 20369 | @subsection User-defined Command Hooks |
8e04817f AC |
20370 | @cindex command hooks |
20371 | @cindex hooks, for commands | |
20372 | @cindex hooks, pre-command | |
104c1213 | 20373 | |
8e04817f | 20374 | @kindex hook |
8e04817f AC |
20375 | You may define @dfn{hooks}, which are a special kind of user-defined |
20376 | command. Whenever you run the command @samp{foo}, if the user-defined | |
20377 | command @samp{hook-foo} exists, it is executed (with no arguments) | |
20378 | before that command. | |
104c1213 | 20379 | |
8e04817f AC |
20380 | @cindex hooks, post-command |
20381 | @kindex hookpost | |
8e04817f AC |
20382 | A hook may also be defined which is run after the command you executed. |
20383 | Whenever you run the command @samp{foo}, if the user-defined command | |
20384 | @samp{hookpost-foo} exists, it is executed (with no arguments) after | |
20385 | that command. Post-execution hooks may exist simultaneously with | |
20386 | pre-execution hooks, for the same command. | |
104c1213 | 20387 | |
8e04817f | 20388 | It is valid for a hook to call the command which it hooks. If this |
9f1c6395 | 20389 | occurs, the hook is not re-executed, thereby avoiding infinite recursion. |
104c1213 | 20390 | |
8e04817f AC |
20391 | @c It would be nice if hookpost could be passed a parameter indicating |
20392 | @c if the command it hooks executed properly or not. FIXME! | |
104c1213 | 20393 | |
8e04817f AC |
20394 | @kindex stop@r{, a pseudo-command} |
20395 | In addition, a pseudo-command, @samp{stop} exists. Defining | |
20396 | (@samp{hook-stop}) makes the associated commands execute every time | |
20397 | execution stops in your program: before breakpoint commands are run, | |
20398 | displays are printed, or the stack frame is printed. | |
104c1213 | 20399 | |
8e04817f AC |
20400 | For example, to ignore @code{SIGALRM} signals while |
20401 | single-stepping, but treat them normally during normal execution, | |
20402 | you could define: | |
104c1213 | 20403 | |
474c8240 | 20404 | @smallexample |
8e04817f AC |
20405 | define hook-stop |
20406 | handle SIGALRM nopass | |
20407 | end | |
104c1213 | 20408 | |
8e04817f AC |
20409 | define hook-run |
20410 | handle SIGALRM pass | |
20411 | end | |
104c1213 | 20412 | |
8e04817f | 20413 | define hook-continue |
d3e8051b | 20414 | handle SIGALRM pass |
8e04817f | 20415 | end |
474c8240 | 20416 | @end smallexample |
104c1213 | 20417 | |
d3e8051b | 20418 | As a further example, to hook at the beginning and end of the @code{echo} |
b383017d | 20419 | command, and to add extra text to the beginning and end of the message, |
8e04817f | 20420 | you could define: |
104c1213 | 20421 | |
474c8240 | 20422 | @smallexample |
8e04817f AC |
20423 | define hook-echo |
20424 | echo <<<--- | |
20425 | end | |
104c1213 | 20426 | |
8e04817f AC |
20427 | define hookpost-echo |
20428 | echo --->>>\n | |
20429 | end | |
104c1213 | 20430 | |
8e04817f AC |
20431 | (@value{GDBP}) echo Hello World |
20432 | <<<---Hello World--->>> | |
20433 | (@value{GDBP}) | |
104c1213 | 20434 | |
474c8240 | 20435 | @end smallexample |
104c1213 | 20436 | |
8e04817f AC |
20437 | You can define a hook for any single-word command in @value{GDBN}, but |
20438 | not for command aliases; you should define a hook for the basic command | |
c1468174 | 20439 | name, e.g.@: @code{backtrace} rather than @code{bt}. |
8e04817f AC |
20440 | @c FIXME! So how does Joe User discover whether a command is an alias |
20441 | @c or not? | |
adb483fe DJ |
20442 | You can hook a multi-word command by adding @code{hook-} or |
20443 | @code{hookpost-} to the last word of the command, e.g.@: | |
20444 | @samp{define target hook-remote} to add a hook to @samp{target remote}. | |
20445 | ||
8e04817f AC |
20446 | If an error occurs during the execution of your hook, execution of |
20447 | @value{GDBN} commands stops and @value{GDBN} issues a prompt | |
20448 | (before the command that you actually typed had a chance to run). | |
104c1213 | 20449 | |
8e04817f AC |
20450 | If you try to define a hook which does not match any known command, you |
20451 | get a warning from the @code{define} command. | |
c906108c | 20452 | |
8e04817f | 20453 | @node Command Files |
d57a3c85 | 20454 | @subsection Command Files |
c906108c | 20455 | |
8e04817f | 20456 | @cindex command files |
fcc73fe3 | 20457 | @cindex scripting commands |
6fc08d32 EZ |
20458 | A command file for @value{GDBN} is a text file made of lines that are |
20459 | @value{GDBN} commands. Comments (lines starting with @kbd{#}) may | |
20460 | also be included. An empty line in a command file does nothing; it | |
20461 | does not mean to repeat the last command, as it would from the | |
20462 | terminal. | |
c906108c | 20463 | |
6fc08d32 | 20464 | You can request the execution of a command file with the @code{source} |
95433b34 JB |
20465 | command. Note that the @code{source} command is also used to evaluate |
20466 | scripts that are not Command Files. The exact behavior can be configured | |
20467 | using the @code{script-extension} setting. | |
20468 | @xref{Extending GDB,, Extending GDB}. | |
c906108c | 20469 | |
8e04817f AC |
20470 | @table @code |
20471 | @kindex source | |
ca91424e | 20472 | @cindex execute commands from a file |
3f7b2faa | 20473 | @item source [-s] [-v] @var{filename} |
8e04817f | 20474 | Execute the command file @var{filename}. |
c906108c SS |
20475 | @end table |
20476 | ||
fcc73fe3 EZ |
20477 | The lines in a command file are generally executed sequentially, |
20478 | unless the order of execution is changed by one of the | |
20479 | @emph{flow-control commands} described below. The commands are not | |
a71ec265 DH |
20480 | printed as they are executed. An error in any command terminates |
20481 | execution of the command file and control is returned to the console. | |
c906108c | 20482 | |
08001717 DE |
20483 | @value{GDBN} first searches for @var{filename} in the current directory. |
20484 | If the file is not found there, and @var{filename} does not specify a | |
20485 | directory, then @value{GDBN} also looks for the file on the source search path | |
20486 | (specified with the @samp{directory} command); | |
20487 | except that @file{$cdir} is not searched because the compilation directory | |
20488 | is not relevant to scripts. | |
4b505b12 | 20489 | |
3f7b2faa DE |
20490 | If @code{-s} is specified, then @value{GDBN} searches for @var{filename} |
20491 | on the search path even if @var{filename} specifies a directory. | |
20492 | The search is done by appending @var{filename} to each element of the | |
20493 | search path. So, for example, if @var{filename} is @file{mylib/myscript} | |
20494 | and the search path contains @file{/home/user} then @value{GDBN} will | |
20495 | look for the script @file{/home/user/mylib/myscript}. | |
20496 | The search is also done if @var{filename} is an absolute path. | |
20497 | For example, if @var{filename} is @file{/tmp/myscript} and | |
20498 | the search path contains @file{/home/user} then @value{GDBN} will | |
20499 | look for the script @file{/home/user/tmp/myscript}. | |
20500 | For DOS-like systems, if @var{filename} contains a drive specification, | |
20501 | it is stripped before concatenation. For example, if @var{filename} is | |
20502 | @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN} | |
20503 | will look for the script @file{c:/tmp/myscript}. | |
20504 | ||
16026cd7 AS |
20505 | If @code{-v}, for verbose mode, is given then @value{GDBN} displays |
20506 | each command as it is executed. The option must be given before | |
20507 | @var{filename}, and is interpreted as part of the filename anywhere else. | |
20508 | ||
8e04817f AC |
20509 | Commands that would ask for confirmation if used interactively proceed |
20510 | without asking when used in a command file. Many @value{GDBN} commands that | |
20511 | normally print messages to say what they are doing omit the messages | |
20512 | when called from command files. | |
c906108c | 20513 | |
8e04817f AC |
20514 | @value{GDBN} also accepts command input from standard input. In this |
20515 | mode, normal output goes to standard output and error output goes to | |
20516 | standard error. Errors in a command file supplied on standard input do | |
6fc08d32 | 20517 | not terminate execution of the command file---execution continues with |
8e04817f | 20518 | the next command. |
c906108c | 20519 | |
474c8240 | 20520 | @smallexample |
8e04817f | 20521 | gdb < cmds > log 2>&1 |
474c8240 | 20522 | @end smallexample |
c906108c | 20523 | |
8e04817f AC |
20524 | (The syntax above will vary depending on the shell used.) This example |
20525 | will execute commands from the file @file{cmds}. All output and errors | |
20526 | would be directed to @file{log}. | |
c906108c | 20527 | |
fcc73fe3 EZ |
20528 | Since commands stored on command files tend to be more general than |
20529 | commands typed interactively, they frequently need to deal with | |
20530 | complicated situations, such as different or unexpected values of | |
20531 | variables and symbols, changes in how the program being debugged is | |
20532 | built, etc. @value{GDBN} provides a set of flow-control commands to | |
20533 | deal with these complexities. Using these commands, you can write | |
20534 | complex scripts that loop over data structures, execute commands | |
20535 | conditionally, etc. | |
20536 | ||
20537 | @table @code | |
20538 | @kindex if | |
20539 | @kindex else | |
20540 | @item if | |
20541 | @itemx else | |
20542 | This command allows to include in your script conditionally executed | |
20543 | commands. The @code{if} command takes a single argument, which is an | |
20544 | expression to evaluate. It is followed by a series of commands that | |
20545 | are executed only if the expression is true (its value is nonzero). | |
20546 | There can then optionally be an @code{else} line, followed by a series | |
20547 | of commands that are only executed if the expression was false. The | |
20548 | end of the list is marked by a line containing @code{end}. | |
20549 | ||
20550 | @kindex while | |
20551 | @item while | |
20552 | This command allows to write loops. Its syntax is similar to | |
20553 | @code{if}: the command takes a single argument, which is an expression | |
20554 | to evaluate, and must be followed by the commands to execute, one per | |
20555 | line, terminated by an @code{end}. These commands are called the | |
20556 | @dfn{body} of the loop. The commands in the body of @code{while} are | |
20557 | executed repeatedly as long as the expression evaluates to true. | |
20558 | ||
20559 | @kindex loop_break | |
20560 | @item loop_break | |
20561 | This command exits the @code{while} loop in whose body it is included. | |
20562 | Execution of the script continues after that @code{while}s @code{end} | |
20563 | line. | |
20564 | ||
20565 | @kindex loop_continue | |
20566 | @item loop_continue | |
20567 | This command skips the execution of the rest of the body of commands | |
20568 | in the @code{while} loop in whose body it is included. Execution | |
20569 | branches to the beginning of the @code{while} loop, where it evaluates | |
20570 | the controlling expression. | |
ca91424e EZ |
20571 | |
20572 | @kindex end@r{ (if/else/while commands)} | |
20573 | @item end | |
20574 | Terminate the block of commands that are the body of @code{if}, | |
20575 | @code{else}, or @code{while} flow-control commands. | |
fcc73fe3 EZ |
20576 | @end table |
20577 | ||
20578 | ||
8e04817f | 20579 | @node Output |
d57a3c85 | 20580 | @subsection Commands for Controlled Output |
c906108c | 20581 | |
8e04817f AC |
20582 | During the execution of a command file or a user-defined command, normal |
20583 | @value{GDBN} output is suppressed; the only output that appears is what is | |
20584 | explicitly printed by the commands in the definition. This section | |
20585 | describes three commands useful for generating exactly the output you | |
20586 | want. | |
c906108c SS |
20587 | |
20588 | @table @code | |
8e04817f AC |
20589 | @kindex echo |
20590 | @item echo @var{text} | |
20591 | @c I do not consider backslash-space a standard C escape sequence | |
20592 | @c because it is not in ANSI. | |
20593 | Print @var{text}. Nonprinting characters can be included in | |
20594 | @var{text} using C escape sequences, such as @samp{\n} to print a | |
20595 | newline. @strong{No newline is printed unless you specify one.} | |
20596 | In addition to the standard C escape sequences, a backslash followed | |
20597 | by a space stands for a space. This is useful for displaying a | |
20598 | string with spaces at the beginning or the end, since leading and | |
20599 | trailing spaces are otherwise trimmed from all arguments. | |
20600 | To print @samp{@w{ }and foo =@w{ }}, use the command | |
20601 | @samp{echo \@w{ }and foo = \@w{ }}. | |
c906108c | 20602 | |
8e04817f AC |
20603 | A backslash at the end of @var{text} can be used, as in C, to continue |
20604 | the command onto subsequent lines. For example, | |
c906108c | 20605 | |
474c8240 | 20606 | @smallexample |
8e04817f AC |
20607 | echo This is some text\n\ |
20608 | which is continued\n\ | |
20609 | onto several lines.\n | |
474c8240 | 20610 | @end smallexample |
c906108c | 20611 | |
8e04817f | 20612 | produces the same output as |
c906108c | 20613 | |
474c8240 | 20614 | @smallexample |
8e04817f AC |
20615 | echo This is some text\n |
20616 | echo which is continued\n | |
20617 | echo onto several lines.\n | |
474c8240 | 20618 | @end smallexample |
c906108c | 20619 | |
8e04817f AC |
20620 | @kindex output |
20621 | @item output @var{expression} | |
20622 | Print the value of @var{expression} and nothing but that value: no | |
20623 | newlines, no @samp{$@var{nn} = }. The value is not entered in the | |
20624 | value history either. @xref{Expressions, ,Expressions}, for more information | |
20625 | on expressions. | |
c906108c | 20626 | |
8e04817f AC |
20627 | @item output/@var{fmt} @var{expression} |
20628 | Print the value of @var{expression} in format @var{fmt}. You can use | |
20629 | the same formats as for @code{print}. @xref{Output Formats,,Output | |
79a6e687 | 20630 | Formats}, for more information. |
c906108c | 20631 | |
8e04817f | 20632 | @kindex printf |
82160952 EZ |
20633 | @item printf @var{template}, @var{expressions}@dots{} |
20634 | Print the values of one or more @var{expressions} under the control of | |
20635 | the string @var{template}. To print several values, make | |
20636 | @var{expressions} be a comma-separated list of individual expressions, | |
20637 | which may be either numbers or pointers. Their values are printed as | |
20638 | specified by @var{template}, exactly as a C program would do by | |
20639 | executing the code below: | |
c906108c | 20640 | |
474c8240 | 20641 | @smallexample |
82160952 | 20642 | printf (@var{template}, @var{expressions}@dots{}); |
474c8240 | 20643 | @end smallexample |
c906108c | 20644 | |
82160952 EZ |
20645 | As in @code{C} @code{printf}, ordinary characters in @var{template} |
20646 | are printed verbatim, while @dfn{conversion specification} introduced | |
20647 | by the @samp{%} character cause subsequent @var{expressions} to be | |
20648 | evaluated, their values converted and formatted according to type and | |
20649 | style information encoded in the conversion specifications, and then | |
20650 | printed. | |
20651 | ||
8e04817f | 20652 | For example, you can print two values in hex like this: |
c906108c | 20653 | |
8e04817f AC |
20654 | @smallexample |
20655 | printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo | |
20656 | @end smallexample | |
c906108c | 20657 | |
82160952 EZ |
20658 | @code{printf} supports all the standard @code{C} conversion |
20659 | specifications, including the flags and modifiers between the @samp{%} | |
20660 | character and the conversion letter, with the following exceptions: | |
20661 | ||
20662 | @itemize @bullet | |
20663 | @item | |
20664 | The argument-ordering modifiers, such as @samp{2$}, are not supported. | |
20665 | ||
20666 | @item | |
20667 | The modifier @samp{*} is not supported for specifying precision or | |
20668 | width. | |
20669 | ||
20670 | @item | |
20671 | The @samp{'} flag (for separation of digits into groups according to | |
20672 | @code{LC_NUMERIC'}) is not supported. | |
20673 | ||
20674 | @item | |
20675 | The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not | |
20676 | supported. | |
20677 | ||
20678 | @item | |
20679 | The conversion letter @samp{n} (as in @samp{%n}) is not supported. | |
20680 | ||
20681 | @item | |
20682 | The conversion letters @samp{a} and @samp{A} are not supported. | |
20683 | @end itemize | |
20684 | ||
20685 | @noindent | |
20686 | Note that the @samp{ll} type modifier is supported only if the | |
20687 | underlying @code{C} implementation used to build @value{GDBN} supports | |
20688 | the @code{long long int} type, and the @samp{L} type modifier is | |
20689 | supported only if @code{long double} type is available. | |
20690 | ||
20691 | As in @code{C}, @code{printf} supports simple backslash-escape | |
20692 | sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"}, | |
20693 | @samp{\a}, and @samp{\f}, that consist of backslash followed by a | |
20694 | single character. Octal and hexadecimal escape sequences are not | |
20695 | supported. | |
1a619819 LM |
20696 | |
20697 | Additionally, @code{printf} supports conversion specifications for DFP | |
0aea4bf3 LM |
20698 | (@dfn{Decimal Floating Point}) types using the following length modifiers |
20699 | together with a floating point specifier. | |
1a619819 LM |
20700 | letters: |
20701 | ||
20702 | @itemize @bullet | |
20703 | @item | |
20704 | @samp{H} for printing @code{Decimal32} types. | |
20705 | ||
20706 | @item | |
20707 | @samp{D} for printing @code{Decimal64} types. | |
20708 | ||
20709 | @item | |
20710 | @samp{DD} for printing @code{Decimal128} types. | |
20711 | @end itemize | |
20712 | ||
20713 | If the underlying @code{C} implementation used to build @value{GDBN} has | |
0aea4bf3 | 20714 | support for the three length modifiers for DFP types, other modifiers |
3b784c4f | 20715 | such as width and precision will also be available for @value{GDBN} to use. |
1a619819 LM |
20716 | |
20717 | In case there is no such @code{C} support, no additional modifiers will be | |
20718 | available and the value will be printed in the standard way. | |
20719 | ||
20720 | Here's an example of printing DFP types using the above conversion letters: | |
20721 | @smallexample | |
0aea4bf3 | 20722 | printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl |
1a619819 LM |
20723 | @end smallexample |
20724 | ||
f1421989 HZ |
20725 | @kindex eval |
20726 | @item eval @var{template}, @var{expressions}@dots{} | |
20727 | Convert the values of one or more @var{expressions} under the control of | |
20728 | the string @var{template} to a command line, and call it. | |
20729 | ||
c906108c SS |
20730 | @end table |
20731 | ||
d57a3c85 TJB |
20732 | @node Python |
20733 | @section Scripting @value{GDBN} using Python | |
20734 | @cindex python scripting | |
20735 | @cindex scripting with python | |
20736 | ||
20737 | You can script @value{GDBN} using the @uref{http://www.python.org/, | |
20738 | Python programming language}. This feature is available only if | |
20739 | @value{GDBN} was configured using @option{--with-python}. | |
20740 | ||
9279c692 JB |
20741 | @cindex python directory |
20742 | Python scripts used by @value{GDBN} should be installed in | |
20743 | @file{@var{data-directory}/python}, where @var{data-directory} is | |
9eeee977 DE |
20744 | the data directory as determined at @value{GDBN} startup (@pxref{Data Files}). |
20745 | This directory, known as the @dfn{python directory}, | |
9279c692 JB |
20746 | is automatically added to the Python Search Path in order to allow |
20747 | the Python interpreter to locate all scripts installed at this location. | |
20748 | ||
d57a3c85 TJB |
20749 | @menu |
20750 | * Python Commands:: Accessing Python from @value{GDBN}. | |
20751 | * Python API:: Accessing @value{GDBN} from Python. | |
8a1ea21f | 20752 | * Auto-loading:: Automatically loading Python code. |
0e3509db | 20753 | * Python modules:: Python modules provided by @value{GDBN}. |
d57a3c85 TJB |
20754 | @end menu |
20755 | ||
20756 | @node Python Commands | |
20757 | @subsection Python Commands | |
20758 | @cindex python commands | |
20759 | @cindex commands to access python | |
20760 | ||
20761 | @value{GDBN} provides one command for accessing the Python interpreter, | |
20762 | and one related setting: | |
20763 | ||
20764 | @table @code | |
20765 | @kindex python | |
20766 | @item python @r{[}@var{code}@r{]} | |
20767 | The @code{python} command can be used to evaluate Python code. | |
20768 | ||
20769 | If given an argument, the @code{python} command will evaluate the | |
20770 | argument as a Python command. For example: | |
20771 | ||
20772 | @smallexample | |
20773 | (@value{GDBP}) python print 23 | |
20774 | 23 | |
20775 | @end smallexample | |
20776 | ||
20777 | If you do not provide an argument to @code{python}, it will act as a | |
20778 | multi-line command, like @code{define}. In this case, the Python | |
20779 | script is made up of subsequent command lines, given after the | |
20780 | @code{python} command. This command list is terminated using a line | |
20781 | containing @code{end}. For example: | |
20782 | ||
20783 | @smallexample | |
20784 | (@value{GDBP}) python | |
20785 | Type python script | |
20786 | End with a line saying just "end". | |
20787 | >print 23 | |
20788 | >end | |
20789 | 23 | |
20790 | @end smallexample | |
20791 | ||
20792 | @kindex maint set python print-stack | |
20793 | @item maint set python print-stack | |
20794 | By default, @value{GDBN} will print a stack trace when an error occurs | |
20795 | in a Python script. This can be controlled using @code{maint set | |
20796 | python print-stack}: if @code{on}, the default, then Python stack | |
20797 | printing is enabled; if @code{off}, then Python stack printing is | |
20798 | disabled. | |
20799 | @end table | |
20800 | ||
95433b34 JB |
20801 | It is also possible to execute a Python script from the @value{GDBN} |
20802 | interpreter: | |
20803 | ||
20804 | @table @code | |
20805 | @item source @file{script-name} | |
20806 | The script name must end with @samp{.py} and @value{GDBN} must be configured | |
20807 | to recognize the script language based on filename extension using | |
20808 | the @code{script-extension} setting. @xref{Extending GDB, ,Extending GDB}. | |
20809 | ||
20810 | @item python execfile ("script-name") | |
20811 | This method is based on the @code{execfile} Python built-in function, | |
20812 | and thus is always available. | |
20813 | @end table | |
20814 | ||
d57a3c85 TJB |
20815 | @node Python API |
20816 | @subsection Python API | |
20817 | @cindex python api | |
20818 | @cindex programming in python | |
20819 | ||
20820 | @cindex python stdout | |
20821 | @cindex python pagination | |
20822 | At startup, @value{GDBN} overrides Python's @code{sys.stdout} and | |
20823 | @code{sys.stderr} to print using @value{GDBN}'s output-paging streams. | |
20824 | A Python program which outputs to one of these streams may have its | |
20825 | output interrupted by the user (@pxref{Screen Size}). In this | |
20826 | situation, a Python @code{KeyboardInterrupt} exception is thrown. | |
20827 | ||
20828 | @menu | |
20829 | * Basic Python:: Basic Python Functions. | |
06e65f44 TT |
20830 | * Exception Handling:: How Python exceptions are translated. |
20831 | * Values From Inferior:: Python representation of values. | |
4c374409 JK |
20832 | * Types In Python:: Python representation of types. |
20833 | * Pretty Printing API:: Pretty-printing values. | |
a6bac58e | 20834 | * Selecting Pretty-Printers:: How GDB chooses a pretty-printer. |
7b51bc51 | 20835 | * Writing a Pretty-Printer:: Writing a Pretty-Printer. |
595939de | 20836 | * Inferiors In Python:: Python representation of inferiors (processes) |
505500db | 20837 | * Events In Python:: Listening for events from @value{GDBN}. |
595939de | 20838 | * Threads In Python:: Accessing inferior threads from Python. |
d8906c6f | 20839 | * Commands In Python:: Implementing new commands in Python. |
d7b32ed3 | 20840 | * Parameters In Python:: Adding new @value{GDBN} parameters. |
bc3b79fd | 20841 | * Functions In Python:: Writing new convenience functions. |
fa33c3cd | 20842 | * Progspaces In Python:: Program spaces. |
89c73ade | 20843 | * Objfiles In Python:: Object files. |
f3e9a817 PM |
20844 | * Frames In Python:: Accessing inferior stack frames from Python. |
20845 | * Blocks In Python:: Accessing frame blocks from Python. | |
20846 | * Symbols In Python:: Python representation of symbols. | |
20847 | * Symbol Tables In Python:: Python representation of symbol tables. | |
be759fcf | 20848 | * Lazy Strings In Python:: Python representation of lazy strings. |
adc36818 | 20849 | * Breakpoints In Python:: Manipulating breakpoints using Python. |
d57a3c85 TJB |
20850 | @end menu |
20851 | ||
20852 | @node Basic Python | |
20853 | @subsubsection Basic Python | |
20854 | ||
20855 | @cindex python functions | |
20856 | @cindex python module | |
20857 | @cindex gdb module | |
20858 | @value{GDBN} introduces a new Python module, named @code{gdb}. All | |
20859 | methods and classes added by @value{GDBN} are placed in this module. | |
20860 | @value{GDBN} automatically @code{import}s the @code{gdb} module for | |
20861 | use in all scripts evaluated by the @code{python} command. | |
20862 | ||
9279c692 JB |
20863 | @findex gdb.PYTHONDIR |
20864 | @defvar PYTHONDIR | |
20865 | A string containing the python directory (@pxref{Python}). | |
20866 | @end defvar | |
20867 | ||
d57a3c85 | 20868 | @findex gdb.execute |
bc9f0842 | 20869 | @defun execute command [from_tty] [to_string] |
d57a3c85 TJB |
20870 | Evaluate @var{command}, a string, as a @value{GDBN} CLI command. |
20871 | If a GDB exception happens while @var{command} runs, it is | |
20872 | translated as described in @ref{Exception Handling,,Exception Handling}. | |
12453b93 TJB |
20873 | |
20874 | @var{from_tty} specifies whether @value{GDBN} ought to consider this | |
20875 | command as having originated from the user invoking it interactively. | |
20876 | It must be a boolean value. If omitted, it defaults to @code{False}. | |
bc9f0842 TT |
20877 | |
20878 | By default, any output produced by @var{command} is sent to | |
20879 | @value{GDBN}'s standard output. If the @var{to_string} parameter is | |
20880 | @code{True}, then output will be collected by @code{gdb.execute} and | |
20881 | returned as a string. The default is @code{False}, in which case the | |
5da1313b JK |
20882 | return value is @code{None}. If @var{to_string} is @code{True}, the |
20883 | @value{GDBN} virtual terminal will be temporarily set to unlimited width | |
20884 | and height, and its pagination will be disabled; @pxref{Screen Size}. | |
d57a3c85 TJB |
20885 | @end defun |
20886 | ||
adc36818 PM |
20887 | @findex gdb.breakpoints |
20888 | @defun breakpoints | |
20889 | Return a sequence holding all of @value{GDBN}'s breakpoints. | |
20890 | @xref{Breakpoints In Python}, for more information. | |
20891 | @end defun | |
20892 | ||
8f500870 TT |
20893 | @findex gdb.parameter |
20894 | @defun parameter parameter | |
d57a3c85 TJB |
20895 | Return the value of a @value{GDBN} parameter. @var{parameter} is a |
20896 | string naming the parameter to look up; @var{parameter} may contain | |
20897 | spaces if the parameter has a multi-part name. For example, | |
20898 | @samp{print object} is a valid parameter name. | |
20899 | ||
20900 | If the named parameter does not exist, this function throws a | |
621c8364 TT |
20901 | @code{gdb.error} (@pxref{Exception Handling}). Otherwise, the |
20902 | parameter's value is converted to a Python value of the appropriate | |
20903 | type, and returned. | |
d57a3c85 TJB |
20904 | @end defun |
20905 | ||
08c637de TJB |
20906 | @findex gdb.history |
20907 | @defun history number | |
20908 | Return a value from @value{GDBN}'s value history (@pxref{Value | |
20909 | History}). @var{number} indicates which history element to return. | |
20910 | If @var{number} is negative, then @value{GDBN} will take its absolute value | |
20911 | and count backward from the last element (i.e., the most recent element) to | |
20912 | find the value to return. If @var{number} is zero, then @value{GDBN} will | |
a0c36267 | 20913 | return the most recent element. If the element specified by @var{number} |
621c8364 | 20914 | doesn't exist in the value history, a @code{gdb.error} exception will be |
08c637de TJB |
20915 | raised. |
20916 | ||
20917 | If no exception is raised, the return value is always an instance of | |
20918 | @code{gdb.Value} (@pxref{Values From Inferior}). | |
20919 | @end defun | |
20920 | ||
57a1d736 TT |
20921 | @findex gdb.parse_and_eval |
20922 | @defun parse_and_eval expression | |
20923 | Parse @var{expression} as an expression in the current language, | |
20924 | evaluate it, and return the result as a @code{gdb.Value}. | |
20925 | @var{expression} must be a string. | |
20926 | ||
20927 | This function can be useful when implementing a new command | |
20928 | (@pxref{Commands In Python}), as it provides a way to parse the | |
20929 | command's argument as an expression. It is also useful simply to | |
20930 | compute values, for example, it is the only way to get the value of a | |
20931 | convenience variable (@pxref{Convenience Vars}) as a @code{gdb.Value}. | |
20932 | @end defun | |
20933 | ||
ca5c20b6 PM |
20934 | @findex gdb.post_event |
20935 | @defun post_event event | |
20936 | Put @var{event}, a callable object taking no arguments, into | |
20937 | @value{GDBN}'s internal event queue. This callable will be invoked at | |
20938 | some later point, during @value{GDBN}'s event processing. Events | |
20939 | posted using @code{post_event} will be run in the order in which they | |
20940 | were posted; however, there is no way to know when they will be | |
20941 | processed relative to other events inside @value{GDBN}. | |
20942 | ||
20943 | @value{GDBN} is not thread-safe. If your Python program uses multiple | |
20944 | threads, you must be careful to only call @value{GDBN}-specific | |
20945 | functions in the main @value{GDBN} thread. @code{post_event} ensures | |
20946 | this. For example: | |
20947 | ||
20948 | @smallexample | |
20949 | (@value{GDBP}) python | |
20950 | >import threading | |
20951 | > | |
20952 | >class Writer(): | |
20953 | > def __init__(self, message): | |
20954 | > self.message = message; | |
20955 | > def __call__(self): | |
20956 | > gdb.write(self.message) | |
20957 | > | |
20958 | >class MyThread1 (threading.Thread): | |
20959 | > def run (self): | |
20960 | > gdb.post_event(Writer("Hello ")) | |
20961 | > | |
20962 | >class MyThread2 (threading.Thread): | |
20963 | > def run (self): | |
20964 | > gdb.post_event(Writer("World\n")) | |
20965 | > | |
20966 | >MyThread1().start() | |
20967 | >MyThread2().start() | |
20968 | >end | |
20969 | (@value{GDBP}) Hello World | |
20970 | @end smallexample | |
20971 | @end defun | |
20972 | ||
99c3dc11 PM |
20973 | @findex gdb.write |
20974 | @defun write string @r{[}stream{]} | |
20975 | Print a string to @value{GDBN}'s paginated output stream. The | |
20976 | optional @var{stream} determines the stream to print to. The default | |
20977 | stream is @value{GDBN}'s standard output stream. Possible stream | |
20978 | values are: | |
20979 | ||
20980 | @table @code | |
20981 | @findex STDOUT | |
20982 | @findex gdb.STDOUT | |
20983 | @item STDOUT | |
20984 | @value{GDBN}'s standard output stream. | |
20985 | ||
20986 | @findex STDERR | |
20987 | @findex gdb.STDERR | |
20988 | @item STDERR | |
20989 | @value{GDBN}'s standard error stream. | |
20990 | ||
20991 | @findex STDLOG | |
20992 | @findex gdb.STDLOG | |
20993 | @item STDLOG | |
20994 | @value{GDBN}'s log stream (@pxref{Logging Output}). | |
20995 | @end table | |
20996 | ||
d57a3c85 | 20997 | Writing to @code{sys.stdout} or @code{sys.stderr} will automatically |
99c3dc11 PM |
20998 | call this function and will automatically direct the output to the |
20999 | relevant stream. | |
d57a3c85 TJB |
21000 | @end defun |
21001 | ||
21002 | @findex gdb.flush | |
21003 | @defun flush | |
99c3dc11 PM |
21004 | Flush the buffer of a @value{GDBN} paginated stream so that the |
21005 | contents are displayed immediately. @value{GDBN} will flush the | |
21006 | contents of a stream automatically when it encounters a newline in the | |
21007 | buffer. The optional @var{stream} determines the stream to flush. The | |
21008 | default stream is @value{GDBN}'s standard output stream. Possible | |
21009 | stream values are: | |
21010 | ||
21011 | @table @code | |
21012 | @findex STDOUT | |
21013 | @findex gdb.STDOUT | |
21014 | @item STDOUT | |
21015 | @value{GDBN}'s standard output stream. | |
21016 | ||
21017 | @findex STDERR | |
21018 | @findex gdb.STDERR | |
21019 | @item STDERR | |
21020 | @value{GDBN}'s standard error stream. | |
21021 | ||
21022 | @findex STDLOG | |
21023 | @findex gdb.STDLOG | |
21024 | @item STDLOG | |
21025 | @value{GDBN}'s log stream (@pxref{Logging Output}). | |
21026 | ||
21027 | @end table | |
21028 | ||
21029 | Flushing @code{sys.stdout} or @code{sys.stderr} will automatically | |
21030 | call this function for the relevant stream. | |
d57a3c85 TJB |
21031 | @end defun |
21032 | ||
f870a310 TT |
21033 | @findex gdb.target_charset |
21034 | @defun target_charset | |
21035 | Return the name of the current target character set (@pxref{Character | |
21036 | Sets}). This differs from @code{gdb.parameter('target-charset')} in | |
21037 | that @samp{auto} is never returned. | |
21038 | @end defun | |
21039 | ||
21040 | @findex gdb.target_wide_charset | |
21041 | @defun target_wide_charset | |
21042 | Return the name of the current target wide character set | |
21043 | (@pxref{Character Sets}). This differs from | |
21044 | @code{gdb.parameter('target-wide-charset')} in that @samp{auto} is | |
21045 | never returned. | |
21046 | @end defun | |
21047 | ||
cb2e07a6 PM |
21048 | @findex gdb.solib_name |
21049 | @defun solib_name address | |
21050 | Return the name of the shared library holding the given @var{address} | |
21051 | as a string, or @code{None}. | |
21052 | @end defun | |
21053 | ||
21054 | @findex gdb.decode_line | |
21055 | @defun decode_line @r{[}expression@r{]} | |
21056 | Return locations of the line specified by @var{expression}, or of the | |
21057 | current line if no argument was given. This function returns a Python | |
21058 | tuple containing two elements. The first element contains a string | |
21059 | holding any unparsed section of @var{expression} (or @code{None} if | |
21060 | the expression has been fully parsed). The second element contains | |
21061 | either @code{None} or another tuple that contains all the locations | |
21062 | that match the expression represented as @code{gdb.Symtab_and_line} | |
21063 | objects (@pxref{Symbol Tables In Python}). If @var{expression} is | |
21064 | provided, it is decoded the way that @value{GDBN}'s inbuilt | |
21065 | @code{break} or @code{edit} commands do (@pxref{Specify Location}). | |
21066 | @end defun | |
21067 | ||
d57a3c85 TJB |
21068 | @node Exception Handling |
21069 | @subsubsection Exception Handling | |
21070 | @cindex python exceptions | |
21071 | @cindex exceptions, python | |
21072 | ||
21073 | When executing the @code{python} command, Python exceptions | |
21074 | uncaught within the Python code are translated to calls to | |
21075 | @value{GDBN} error-reporting mechanism. If the command that called | |
21076 | @code{python} does not handle the error, @value{GDBN} will | |
21077 | terminate it and print an error message containing the Python | |
21078 | exception name, the associated value, and the Python call stack | |
21079 | backtrace at the point where the exception was raised. Example: | |
21080 | ||
21081 | @smallexample | |
21082 | (@value{GDBP}) python print foo | |
21083 | Traceback (most recent call last): | |
21084 | File "<string>", line 1, in <module> | |
21085 | NameError: name 'foo' is not defined | |
21086 | @end smallexample | |
21087 | ||
621c8364 TT |
21088 | @value{GDBN} errors that happen in @value{GDBN} commands invoked by |
21089 | Python code are converted to Python exceptions. The type of the | |
21090 | Python exception depends on the error. | |
21091 | ||
21092 | @ftable @code | |
21093 | @item gdb.error | |
21094 | This is the base class for most exceptions generated by @value{GDBN}. | |
21095 | It is derived from @code{RuntimeError}, for compatibility with earlier | |
21096 | versions of @value{GDBN}. | |
21097 | ||
21098 | If an error occurring in @value{GDBN} does not fit into some more | |
21099 | specific category, then the generated exception will have this type. | |
21100 | ||
21101 | @item gdb.MemoryError | |
21102 | This is a subclass of @code{gdb.error} which is thrown when an | |
21103 | operation tried to access invalid memory in the inferior. | |
21104 | ||
21105 | @item KeyboardInterrupt | |
21106 | User interrupt (via @kbd{C-c} or by typing @kbd{q} at a pagination | |
21107 | prompt) is translated to a Python @code{KeyboardInterrupt} exception. | |
21108 | @end ftable | |
21109 | ||
21110 | In all cases, your exception handler will see the @value{GDBN} error | |
21111 | message as its value and the Python call stack backtrace at the Python | |
21112 | statement closest to where the @value{GDBN} error occured as the | |
d57a3c85 TJB |
21113 | traceback. |
21114 | ||
07ca107c DE |
21115 | @findex gdb.GdbError |
21116 | When implementing @value{GDBN} commands in Python via @code{gdb.Command}, | |
21117 | it is useful to be able to throw an exception that doesn't cause a | |
21118 | traceback to be printed. For example, the user may have invoked the | |
21119 | command incorrectly. Use the @code{gdb.GdbError} exception | |
21120 | to handle this case. Example: | |
21121 | ||
21122 | @smallexample | |
21123 | (gdb) python | |
21124 | >class HelloWorld (gdb.Command): | |
21125 | > """Greet the whole world.""" | |
21126 | > def __init__ (self): | |
21127 | > super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_OBSCURE) | |
21128 | > def invoke (self, args, from_tty): | |
21129 | > argv = gdb.string_to_argv (args) | |
21130 | > if len (argv) != 0: | |
21131 | > raise gdb.GdbError ("hello-world takes no arguments") | |
21132 | > print "Hello, World!" | |
21133 | >HelloWorld () | |
21134 | >end | |
21135 | (gdb) hello-world 42 | |
21136 | hello-world takes no arguments | |
21137 | @end smallexample | |
21138 | ||
a08702d6 TJB |
21139 | @node Values From Inferior |
21140 | @subsubsection Values From Inferior | |
21141 | @cindex values from inferior, with Python | |
21142 | @cindex python, working with values from inferior | |
21143 | ||
21144 | @cindex @code{gdb.Value} | |
21145 | @value{GDBN} provides values it obtains from the inferior program in | |
21146 | an object of type @code{gdb.Value}. @value{GDBN} uses this object | |
21147 | for its internal bookkeeping of the inferior's values, and for | |
21148 | fetching values when necessary. | |
21149 | ||
21150 | Inferior values that are simple scalars can be used directly in | |
21151 | Python expressions that are valid for the value's data type. Here's | |
21152 | an example for an integer or floating-point value @code{some_val}: | |
21153 | ||
21154 | @smallexample | |
21155 | bar = some_val + 2 | |
21156 | @end smallexample | |
21157 | ||
21158 | @noindent | |
21159 | As result of this, @code{bar} will also be a @code{gdb.Value} object | |
21160 | whose values are of the same type as those of @code{some_val}. | |
21161 | ||
21162 | Inferior values that are structures or instances of some class can | |
21163 | be accessed using the Python @dfn{dictionary syntax}. For example, if | |
21164 | @code{some_val} is a @code{gdb.Value} instance holding a structure, you | |
21165 | can access its @code{foo} element with: | |
21166 | ||
21167 | @smallexample | |
21168 | bar = some_val['foo'] | |
21169 | @end smallexample | |
21170 | ||
21171 | Again, @code{bar} will also be a @code{gdb.Value} object. | |
21172 | ||
5374244e PM |
21173 | A @code{gdb.Value} that represents a function can be executed via |
21174 | inferior function call. Any arguments provided to the call must match | |
21175 | the function's prototype, and must be provided in the order specified | |
21176 | by that prototype. | |
21177 | ||
21178 | For example, @code{some_val} is a @code{gdb.Value} instance | |
21179 | representing a function that takes two integers as arguments. To | |
21180 | execute this function, call it like so: | |
21181 | ||
21182 | @smallexample | |
21183 | result = some_val (10,20) | |
21184 | @end smallexample | |
21185 | ||
21186 | Any values returned from a function call will be stored as a | |
21187 | @code{gdb.Value}. | |
21188 | ||
c0c6f777 | 21189 | The following attributes are provided: |
a08702d6 | 21190 | |
def2b000 | 21191 | @table @code |
2c74e833 | 21192 | @defivar Value address |
c0c6f777 TJB |
21193 | If this object is addressable, this read-only attribute holds a |
21194 | @code{gdb.Value} object representing the address. Otherwise, | |
21195 | this attribute holds @code{None}. | |
2c74e833 | 21196 | @end defivar |
c0c6f777 | 21197 | |
def2b000 | 21198 | @cindex optimized out value in Python |
2c74e833 | 21199 | @defivar Value is_optimized_out |
def2b000 TJB |
21200 | This read-only boolean attribute is true if the compiler optimized out |
21201 | this value, thus it is not available for fetching from the inferior. | |
2c74e833 TT |
21202 | @end defivar |
21203 | ||
21204 | @defivar Value type | |
21205 | The type of this @code{gdb.Value}. The value of this attribute is a | |
44592cc4 | 21206 | @code{gdb.Type} object (@pxref{Types In Python}). |
2c74e833 | 21207 | @end defivar |
03f17ccf TT |
21208 | |
21209 | @defivar Value dynamic_type | |
21210 | The dynamic type of this @code{gdb.Value}. This uses C@t{++} run-time | |
fccd1d1e EZ |
21211 | type information (@acronym{RTTI}) to determine the dynamic type of the |
21212 | value. If this value is of class type, it will return the class in | |
21213 | which the value is embedded, if any. If this value is of pointer or | |
21214 | reference to a class type, it will compute the dynamic type of the | |
21215 | referenced object, and return a pointer or reference to that type, | |
21216 | respectively. In all other cases, it will return the value's static | |
21217 | type. | |
21218 | ||
21219 | Note that this feature will only work when debugging a C@t{++} program | |
21220 | that includes @acronym{RTTI} for the object in question. Otherwise, | |
21221 | it will just return the static type of the value as in @kbd{ptype foo} | |
21222 | (@pxref{Symbols, ptype}). | |
03f17ccf | 21223 | @end defivar |
def2b000 TJB |
21224 | @end table |
21225 | ||
21226 | The following methods are provided: | |
21227 | ||
21228 | @table @code | |
e8467610 TT |
21229 | @defmethod Value __init__ @var{val} |
21230 | Many Python values can be converted directly to a @code{gdb.Value} via | |
21231 | this object initializer. Specifically: | |
21232 | ||
21233 | @table @asis | |
21234 | @item Python boolean | |
21235 | A Python boolean is converted to the boolean type from the current | |
21236 | language. | |
21237 | ||
21238 | @item Python integer | |
21239 | A Python integer is converted to the C @code{long} type for the | |
21240 | current architecture. | |
21241 | ||
21242 | @item Python long | |
21243 | A Python long is converted to the C @code{long long} type for the | |
21244 | current architecture. | |
21245 | ||
21246 | @item Python float | |
21247 | A Python float is converted to the C @code{double} type for the | |
21248 | current architecture. | |
21249 | ||
21250 | @item Python string | |
21251 | A Python string is converted to a target string, using the current | |
21252 | target encoding. | |
21253 | ||
21254 | @item @code{gdb.Value} | |
21255 | If @code{val} is a @code{gdb.Value}, then a copy of the value is made. | |
21256 | ||
21257 | @item @code{gdb.LazyString} | |
21258 | If @code{val} is a @code{gdb.LazyString} (@pxref{Lazy Strings In | |
21259 | Python}), then the lazy string's @code{value} method is called, and | |
21260 | its result is used. | |
21261 | @end table | |
21262 | @end defmethod | |
21263 | ||
14ff2235 PM |
21264 | @defmethod Value cast type |
21265 | Return a new instance of @code{gdb.Value} that is the result of | |
21266 | casting this instance to the type described by @var{type}, which must | |
21267 | be a @code{gdb.Type} object. If the cast cannot be performed for some | |
21268 | reason, this method throws an exception. | |
21269 | @end defmethod | |
21270 | ||
a08702d6 | 21271 | @defmethod Value dereference |
def2b000 TJB |
21272 | For pointer data types, this method returns a new @code{gdb.Value} object |
21273 | whose contents is the object pointed to by the pointer. For example, if | |
21274 | @code{foo} is a C pointer to an @code{int}, declared in your C program as | |
a08702d6 TJB |
21275 | |
21276 | @smallexample | |
21277 | int *foo; | |
21278 | @end smallexample | |
21279 | ||
21280 | @noindent | |
21281 | then you can use the corresponding @code{gdb.Value} to access what | |
21282 | @code{foo} points to like this: | |
21283 | ||
21284 | @smallexample | |
21285 | bar = foo.dereference () | |
21286 | @end smallexample | |
21287 | ||
21288 | The result @code{bar} will be a @code{gdb.Value} object holding the | |
21289 | value pointed to by @code{foo}. | |
21290 | @end defmethod | |
21291 | ||
f9ffd4bb TT |
21292 | @defmethod Value dynamic_cast type |
21293 | Like @code{Value.cast}, but works as if the C@t{++} @code{dynamic_cast} | |
21294 | operator were used. Consult a C@t{++} reference for details. | |
21295 | @end defmethod | |
21296 | ||
21297 | @defmethod Value reinterpret_cast type | |
21298 | Like @code{Value.cast}, but works as if the C@t{++} @code{reinterpret_cast} | |
21299 | operator were used. Consult a C@t{++} reference for details. | |
21300 | @end defmethod | |
21301 | ||
fbb8f299 | 21302 | @defmethod Value string @r{[}encoding@r{]} @r{[}errors@r{]} @r{[}length@r{]} |
b6cb8e7d TJB |
21303 | If this @code{gdb.Value} represents a string, then this method |
21304 | converts the contents to a Python string. Otherwise, this method will | |
21305 | throw an exception. | |
21306 | ||
21307 | Strings are recognized in a language-specific way; whether a given | |
21308 | @code{gdb.Value} represents a string is determined by the current | |
21309 | language. | |
21310 | ||
21311 | For C-like languages, a value is a string if it is a pointer to or an | |
21312 | array of characters or ints. The string is assumed to be terminated | |
fbb8f299 PM |
21313 | by a zero of the appropriate width. However if the optional length |
21314 | argument is given, the string will be converted to that given length, | |
21315 | ignoring any embedded zeros that the string may contain. | |
b6cb8e7d TJB |
21316 | |
21317 | If the optional @var{encoding} argument is given, it must be a string | |
21318 | naming the encoding of the string in the @code{gdb.Value}, such as | |
21319 | @code{"ascii"}, @code{"iso-8859-6"} or @code{"utf-8"}. It accepts | |
21320 | the same encodings as the corresponding argument to Python's | |
21321 | @code{string.decode} method, and the Python codec machinery will be used | |
21322 | to convert the string. If @var{encoding} is not given, or if | |
21323 | @var{encoding} is the empty string, then either the @code{target-charset} | |
21324 | (@pxref{Character Sets}) will be used, or a language-specific encoding | |
21325 | will be used, if the current language is able to supply one. | |
21326 | ||
21327 | The optional @var{errors} argument is the same as the corresponding | |
21328 | argument to Python's @code{string.decode} method. | |
fbb8f299 PM |
21329 | |
21330 | If the optional @var{length} argument is given, the string will be | |
21331 | fetched and converted to the given length. | |
b6cb8e7d | 21332 | @end defmethod |
be759fcf PM |
21333 | |
21334 | @defmethod Value lazy_string @r{[}encoding@r{]} @r{[}length@r{]} | |
21335 | If this @code{gdb.Value} represents a string, then this method | |
21336 | converts the contents to a @code{gdb.LazyString} (@pxref{Lazy Strings | |
21337 | In Python}). Otherwise, this method will throw an exception. | |
21338 | ||
21339 | If the optional @var{encoding} argument is given, it must be a string | |
21340 | naming the encoding of the @code{gdb.LazyString}. Some examples are: | |
21341 | @samp{ascii}, @samp{iso-8859-6} or @samp{utf-8}. If the | |
21342 | @var{encoding} argument is an encoding that @value{GDBN} does | |
21343 | recognize, @value{GDBN} will raise an error. | |
21344 | ||
21345 | When a lazy string is printed, the @value{GDBN} encoding machinery is | |
21346 | used to convert the string during printing. If the optional | |
21347 | @var{encoding} argument is not provided, or is an empty string, | |
21348 | @value{GDBN} will automatically select the encoding most suitable for | |
21349 | the string type. For further information on encoding in @value{GDBN} | |
21350 | please see @ref{Character Sets}. | |
21351 | ||
21352 | If the optional @var{length} argument is given, the string will be | |
21353 | fetched and encoded to the length of characters specified. If | |
21354 | the @var{length} argument is not provided, the string will be fetched | |
21355 | and encoded until a null of appropriate width is found. | |
21356 | @end defmethod | |
def2b000 | 21357 | @end table |
b6cb8e7d | 21358 | |
2c74e833 TT |
21359 | @node Types In Python |
21360 | @subsubsection Types In Python | |
21361 | @cindex types in Python | |
21362 | @cindex Python, working with types | |
21363 | ||
21364 | @tindex gdb.Type | |
21365 | @value{GDBN} represents types from the inferior using the class | |
21366 | @code{gdb.Type}. | |
21367 | ||
21368 | The following type-related functions are available in the @code{gdb} | |
21369 | module: | |
21370 | ||
21371 | @findex gdb.lookup_type | |
21372 | @defun lookup_type name [block] | |
21373 | This function looks up a type by name. @var{name} is the name of the | |
21374 | type to look up. It must be a string. | |
21375 | ||
5107b149 PM |
21376 | If @var{block} is given, then @var{name} is looked up in that scope. |
21377 | Otherwise, it is searched for globally. | |
21378 | ||
2c74e833 TT |
21379 | Ordinarily, this function will return an instance of @code{gdb.Type}. |
21380 | If the named type cannot be found, it will throw an exception. | |
21381 | @end defun | |
21382 | ||
21383 | An instance of @code{Type} has the following attributes: | |
21384 | ||
21385 | @table @code | |
21386 | @defivar Type code | |
21387 | The type code for this type. The type code will be one of the | |
21388 | @code{TYPE_CODE_} constants defined below. | |
21389 | @end defivar | |
21390 | ||
21391 | @defivar Type sizeof | |
21392 | The size of this type, in target @code{char} units. Usually, a | |
21393 | target's @code{char} type will be an 8-bit byte. However, on some | |
21394 | unusual platforms, this type may have a different size. | |
21395 | @end defivar | |
21396 | ||
21397 | @defivar Type tag | |
21398 | The tag name for this type. The tag name is the name after | |
21399 | @code{struct}, @code{union}, or @code{enum} in C and C@t{++}; not all | |
21400 | languages have this concept. If this type has no tag name, then | |
21401 | @code{None} is returned. | |
21402 | @end defivar | |
21403 | @end table | |
21404 | ||
21405 | The following methods are provided: | |
21406 | ||
21407 | @table @code | |
21408 | @defmethod Type fields | |
21409 | For structure and union types, this method returns the fields. Range | |
21410 | types have two fields, the minimum and maximum values. Enum types | |
21411 | have one field per enum constant. Function and method types have one | |
21412 | field per parameter. The base types of C@t{++} classes are also | |
21413 | represented as fields. If the type has no fields, or does not fit | |
21414 | into one of these categories, an empty sequence will be returned. | |
21415 | ||
21416 | Each field is an object, with some pre-defined attributes: | |
21417 | @table @code | |
21418 | @item bitpos | |
21419 | This attribute is not available for @code{static} fields (as in | |
21420 | C@t{++} or Java). For non-@code{static} fields, the value is the bit | |
21421 | position of the field. | |
21422 | ||
21423 | @item name | |
21424 | The name of the field, or @code{None} for anonymous fields. | |
21425 | ||
21426 | @item artificial | |
21427 | This is @code{True} if the field is artificial, usually meaning that | |
21428 | it was provided by the compiler and not the user. This attribute is | |
21429 | always provided, and is @code{False} if the field is not artificial. | |
21430 | ||
bfd31e71 PM |
21431 | @item is_base_class |
21432 | This is @code{True} if the field represents a base class of a C@t{++} | |
21433 | structure. This attribute is always provided, and is @code{False} | |
21434 | if the field is not a base class of the type that is the argument of | |
21435 | @code{fields}, or if that type was not a C@t{++} class. | |
21436 | ||
2c74e833 TT |
21437 | @item bitsize |
21438 | If the field is packed, or is a bitfield, then this will have a | |
21439 | non-zero value, which is the size of the field in bits. Otherwise, | |
21440 | this will be zero; in this case the field's size is given by its type. | |
21441 | ||
21442 | @item type | |
21443 | The type of the field. This is usually an instance of @code{Type}, | |
21444 | but it can be @code{None} in some situations. | |
21445 | @end table | |
21446 | @end defmethod | |
21447 | ||
702c2711 TT |
21448 | @defmethod Type array @var{n1} @r{[}@var{n2}@r{]} |
21449 | Return a new @code{gdb.Type} object which represents an array of this | |
21450 | type. If one argument is given, it is the inclusive upper bound of | |
21451 | the array; in this case the lower bound is zero. If two arguments are | |
21452 | given, the first argument is the lower bound of the array, and the | |
21453 | second argument is the upper bound of the array. An array's length | |
21454 | must not be negative, but the bounds can be. | |
21455 | @end defmethod | |
21456 | ||
2c74e833 TT |
21457 | @defmethod Type const |
21458 | Return a new @code{gdb.Type} object which represents a | |
21459 | @code{const}-qualified variant of this type. | |
21460 | @end defmethod | |
21461 | ||
21462 | @defmethod Type volatile | |
21463 | Return a new @code{gdb.Type} object which represents a | |
21464 | @code{volatile}-qualified variant of this type. | |
21465 | @end defmethod | |
21466 | ||
21467 | @defmethod Type unqualified | |
21468 | Return a new @code{gdb.Type} object which represents an unqualified | |
21469 | variant of this type. That is, the result is neither @code{const} nor | |
21470 | @code{volatile}. | |
21471 | @end defmethod | |
21472 | ||
361ae042 PM |
21473 | @defmethod Type range |
21474 | Return a Python @code{Tuple} object that contains two elements: the | |
21475 | low bound of the argument type and the high bound of that type. If | |
21476 | the type does not have a range, @value{GDBN} will raise a | |
621c8364 | 21477 | @code{gdb.error} exception (@pxref{Exception Handling}). |
361ae042 PM |
21478 | @end defmethod |
21479 | ||
2c74e833 TT |
21480 | @defmethod Type reference |
21481 | Return a new @code{gdb.Type} object which represents a reference to this | |
21482 | type. | |
21483 | @end defmethod | |
21484 | ||
7a6973ad TT |
21485 | @defmethod Type pointer |
21486 | Return a new @code{gdb.Type} object which represents a pointer to this | |
21487 | type. | |
21488 | @end defmethod | |
21489 | ||
2c74e833 TT |
21490 | @defmethod Type strip_typedefs |
21491 | Return a new @code{gdb.Type} that represents the real type, | |
21492 | after removing all layers of typedefs. | |
21493 | @end defmethod | |
21494 | ||
21495 | @defmethod Type target | |
21496 | Return a new @code{gdb.Type} object which represents the target type | |
21497 | of this type. | |
21498 | ||
21499 | For a pointer type, the target type is the type of the pointed-to | |
21500 | object. For an array type (meaning C-like arrays), the target type is | |
21501 | the type of the elements of the array. For a function or method type, | |
21502 | the target type is the type of the return value. For a complex type, | |
21503 | the target type is the type of the elements. For a typedef, the | |
21504 | target type is the aliased type. | |
21505 | ||
21506 | If the type does not have a target, this method will throw an | |
21507 | exception. | |
21508 | @end defmethod | |
21509 | ||
5107b149 | 21510 | @defmethod Type template_argument n [block] |
2c74e833 TT |
21511 | If this @code{gdb.Type} is an instantiation of a template, this will |
21512 | return a new @code{gdb.Type} which represents the type of the | |
21513 | @var{n}th template argument. | |
21514 | ||
21515 | If this @code{gdb.Type} is not a template type, this will throw an | |
21516 | exception. Ordinarily, only C@t{++} code will have template types. | |
21517 | ||
5107b149 PM |
21518 | If @var{block} is given, then @var{name} is looked up in that scope. |
21519 | Otherwise, it is searched for globally. | |
2c74e833 TT |
21520 | @end defmethod |
21521 | @end table | |
21522 | ||
21523 | ||
21524 | Each type has a code, which indicates what category this type falls | |
21525 | into. The available type categories are represented by constants | |
21526 | defined in the @code{gdb} module: | |
21527 | ||
21528 | @table @code | |
21529 | @findex TYPE_CODE_PTR | |
21530 | @findex gdb.TYPE_CODE_PTR | |
21531 | @item TYPE_CODE_PTR | |
21532 | The type is a pointer. | |
21533 | ||
21534 | @findex TYPE_CODE_ARRAY | |
21535 | @findex gdb.TYPE_CODE_ARRAY | |
21536 | @item TYPE_CODE_ARRAY | |
21537 | The type is an array. | |
21538 | ||
21539 | @findex TYPE_CODE_STRUCT | |
21540 | @findex gdb.TYPE_CODE_STRUCT | |
21541 | @item TYPE_CODE_STRUCT | |
21542 | The type is a structure. | |
21543 | ||
21544 | @findex TYPE_CODE_UNION | |
21545 | @findex gdb.TYPE_CODE_UNION | |
21546 | @item TYPE_CODE_UNION | |
21547 | The type is a union. | |
21548 | ||
21549 | @findex TYPE_CODE_ENUM | |
21550 | @findex gdb.TYPE_CODE_ENUM | |
21551 | @item TYPE_CODE_ENUM | |
21552 | The type is an enum. | |
21553 | ||
21554 | @findex TYPE_CODE_FLAGS | |
21555 | @findex gdb.TYPE_CODE_FLAGS | |
21556 | @item TYPE_CODE_FLAGS | |
21557 | A bit flags type, used for things such as status registers. | |
21558 | ||
21559 | @findex TYPE_CODE_FUNC | |
21560 | @findex gdb.TYPE_CODE_FUNC | |
21561 | @item TYPE_CODE_FUNC | |
21562 | The type is a function. | |
21563 | ||
21564 | @findex TYPE_CODE_INT | |
21565 | @findex gdb.TYPE_CODE_INT | |
21566 | @item TYPE_CODE_INT | |
21567 | The type is an integer type. | |
21568 | ||
21569 | @findex TYPE_CODE_FLT | |
21570 | @findex gdb.TYPE_CODE_FLT | |
21571 | @item TYPE_CODE_FLT | |
21572 | A floating point type. | |
21573 | ||
21574 | @findex TYPE_CODE_VOID | |
21575 | @findex gdb.TYPE_CODE_VOID | |
21576 | @item TYPE_CODE_VOID | |
21577 | The special type @code{void}. | |
21578 | ||
21579 | @findex TYPE_CODE_SET | |
21580 | @findex gdb.TYPE_CODE_SET | |
21581 | @item TYPE_CODE_SET | |
21582 | A Pascal set type. | |
21583 | ||
21584 | @findex TYPE_CODE_RANGE | |
21585 | @findex gdb.TYPE_CODE_RANGE | |
21586 | @item TYPE_CODE_RANGE | |
21587 | A range type, that is, an integer type with bounds. | |
21588 | ||
21589 | @findex TYPE_CODE_STRING | |
21590 | @findex gdb.TYPE_CODE_STRING | |
21591 | @item TYPE_CODE_STRING | |
21592 | A string type. Note that this is only used for certain languages with | |
21593 | language-defined string types; C strings are not represented this way. | |
21594 | ||
21595 | @findex TYPE_CODE_BITSTRING | |
21596 | @findex gdb.TYPE_CODE_BITSTRING | |
21597 | @item TYPE_CODE_BITSTRING | |
21598 | A string of bits. | |
21599 | ||
21600 | @findex TYPE_CODE_ERROR | |
21601 | @findex gdb.TYPE_CODE_ERROR | |
21602 | @item TYPE_CODE_ERROR | |
21603 | An unknown or erroneous type. | |
21604 | ||
21605 | @findex TYPE_CODE_METHOD | |
21606 | @findex gdb.TYPE_CODE_METHOD | |
21607 | @item TYPE_CODE_METHOD | |
21608 | A method type, as found in C@t{++} or Java. | |
21609 | ||
21610 | @findex TYPE_CODE_METHODPTR | |
21611 | @findex gdb.TYPE_CODE_METHODPTR | |
21612 | @item TYPE_CODE_METHODPTR | |
21613 | A pointer-to-member-function. | |
21614 | ||
21615 | @findex TYPE_CODE_MEMBERPTR | |
21616 | @findex gdb.TYPE_CODE_MEMBERPTR | |
21617 | @item TYPE_CODE_MEMBERPTR | |
21618 | A pointer-to-member. | |
21619 | ||
21620 | @findex TYPE_CODE_REF | |
21621 | @findex gdb.TYPE_CODE_REF | |
21622 | @item TYPE_CODE_REF | |
21623 | A reference type. | |
21624 | ||
21625 | @findex TYPE_CODE_CHAR | |
21626 | @findex gdb.TYPE_CODE_CHAR | |
21627 | @item TYPE_CODE_CHAR | |
21628 | A character type. | |
21629 | ||
21630 | @findex TYPE_CODE_BOOL | |
21631 | @findex gdb.TYPE_CODE_BOOL | |
21632 | @item TYPE_CODE_BOOL | |
21633 | A boolean type. | |
21634 | ||
21635 | @findex TYPE_CODE_COMPLEX | |
21636 | @findex gdb.TYPE_CODE_COMPLEX | |
21637 | @item TYPE_CODE_COMPLEX | |
21638 | A complex float type. | |
21639 | ||
21640 | @findex TYPE_CODE_TYPEDEF | |
21641 | @findex gdb.TYPE_CODE_TYPEDEF | |
21642 | @item TYPE_CODE_TYPEDEF | |
21643 | A typedef to some other type. | |
21644 | ||
21645 | @findex TYPE_CODE_NAMESPACE | |
21646 | @findex gdb.TYPE_CODE_NAMESPACE | |
21647 | @item TYPE_CODE_NAMESPACE | |
21648 | A C@t{++} namespace. | |
21649 | ||
21650 | @findex TYPE_CODE_DECFLOAT | |
21651 | @findex gdb.TYPE_CODE_DECFLOAT | |
21652 | @item TYPE_CODE_DECFLOAT | |
21653 | A decimal floating point type. | |
21654 | ||
21655 | @findex TYPE_CODE_INTERNAL_FUNCTION | |
21656 | @findex gdb.TYPE_CODE_INTERNAL_FUNCTION | |
21657 | @item TYPE_CODE_INTERNAL_FUNCTION | |
21658 | A function internal to @value{GDBN}. This is the type used to represent | |
21659 | convenience functions. | |
21660 | @end table | |
21661 | ||
0e3509db DE |
21662 | Further support for types is provided in the @code{gdb.types} |
21663 | Python module (@pxref{gdb.types}). | |
21664 | ||
4c374409 JK |
21665 | @node Pretty Printing API |
21666 | @subsubsection Pretty Printing API | |
a6bac58e | 21667 | |
4c374409 | 21668 | An example output is provided (@pxref{Pretty Printing}). |
a6bac58e TT |
21669 | |
21670 | A pretty-printer is just an object that holds a value and implements a | |
21671 | specific interface, defined here. | |
21672 | ||
21673 | @defop Operation {pretty printer} children (self) | |
21674 | @value{GDBN} will call this method on a pretty-printer to compute the | |
21675 | children of the pretty-printer's value. | |
21676 | ||
21677 | This method must return an object conforming to the Python iterator | |
21678 | protocol. Each item returned by the iterator must be a tuple holding | |
21679 | two elements. The first element is the ``name'' of the child; the | |
21680 | second element is the child's value. The value can be any Python | |
21681 | object which is convertible to a @value{GDBN} value. | |
21682 | ||
21683 | This method is optional. If it does not exist, @value{GDBN} will act | |
21684 | as though the value has no children. | |
21685 | @end defop | |
21686 | ||
21687 | @defop Operation {pretty printer} display_hint (self) | |
21688 | The CLI may call this method and use its result to change the | |
21689 | formatting of a value. The result will also be supplied to an MI | |
21690 | consumer as a @samp{displayhint} attribute of the variable being | |
21691 | printed. | |
21692 | ||
21693 | This method is optional. If it does exist, this method must return a | |
21694 | string. | |
21695 | ||
21696 | Some display hints are predefined by @value{GDBN}: | |
21697 | ||
21698 | @table @samp | |
21699 | @item array | |
21700 | Indicate that the object being printed is ``array-like''. The CLI | |
21701 | uses this to respect parameters such as @code{set print elements} and | |
21702 | @code{set print array}. | |
21703 | ||
21704 | @item map | |
21705 | Indicate that the object being printed is ``map-like'', and that the | |
21706 | children of this value can be assumed to alternate between keys and | |
21707 | values. | |
21708 | ||
21709 | @item string | |
21710 | Indicate that the object being printed is ``string-like''. If the | |
21711 | printer's @code{to_string} method returns a Python string of some | |
21712 | kind, then @value{GDBN} will call its internal language-specific | |
21713 | string-printing function to format the string. For the CLI this means | |
21714 | adding quotation marks, possibly escaping some characters, respecting | |
21715 | @code{set print elements}, and the like. | |
21716 | @end table | |
21717 | @end defop | |
21718 | ||
21719 | @defop Operation {pretty printer} to_string (self) | |
21720 | @value{GDBN} will call this method to display the string | |
21721 | representation of the value passed to the object's constructor. | |
21722 | ||
21723 | When printing from the CLI, if the @code{to_string} method exists, | |
21724 | then @value{GDBN} will prepend its result to the values returned by | |
21725 | @code{children}. Exactly how this formatting is done is dependent on | |
21726 | the display hint, and may change as more hints are added. Also, | |
21727 | depending on the print settings (@pxref{Print Settings}), the CLI may | |
21728 | print just the result of @code{to_string} in a stack trace, omitting | |
21729 | the result of @code{children}. | |
21730 | ||
21731 | If this method returns a string, it is printed verbatim. | |
21732 | ||
21733 | Otherwise, if this method returns an instance of @code{gdb.Value}, | |
21734 | then @value{GDBN} prints this value. This may result in a call to | |
21735 | another pretty-printer. | |
21736 | ||
21737 | If instead the method returns a Python value which is convertible to a | |
21738 | @code{gdb.Value}, then @value{GDBN} performs the conversion and prints | |
21739 | the resulting value. Again, this may result in a call to another | |
21740 | pretty-printer. Python scalars (integers, floats, and booleans) and | |
21741 | strings are convertible to @code{gdb.Value}; other types are not. | |
21742 | ||
79f283fe PM |
21743 | Finally, if this method returns @code{None} then no further operations |
21744 | are peformed in this method and nothing is printed. | |
21745 | ||
a6bac58e TT |
21746 | If the result is not one of these types, an exception is raised. |
21747 | @end defop | |
21748 | ||
464b3efb TT |
21749 | @value{GDBN} provides a function which can be used to look up the |
21750 | default pretty-printer for a @code{gdb.Value}: | |
21751 | ||
21752 | @findex gdb.default_visualizer | |
21753 | @defun default_visualizer value | |
21754 | This function takes a @code{gdb.Value} object as an argument. If a | |
21755 | pretty-printer for this value exists, then it is returned. If no such | |
21756 | printer exists, then this returns @code{None}. | |
21757 | @end defun | |
21758 | ||
a6bac58e TT |
21759 | @node Selecting Pretty-Printers |
21760 | @subsubsection Selecting Pretty-Printers | |
21761 | ||
21762 | The Python list @code{gdb.pretty_printers} contains an array of | |
967cf477 | 21763 | functions or callable objects that have been registered via addition |
7b51bc51 DE |
21764 | as a pretty-printer. Printers in this list are called @code{global} |
21765 | printers, they're available when debugging all inferiors. | |
fa33c3cd | 21766 | Each @code{gdb.Progspace} contains a @code{pretty_printers} attribute. |
a6bac58e TT |
21767 | Each @code{gdb.Objfile} also contains a @code{pretty_printers} |
21768 | attribute. | |
21769 | ||
7b51bc51 | 21770 | Each function on these lists is passed a single @code{gdb.Value} |
a6bac58e | 21771 | argument and should return a pretty-printer object conforming to the |
4c374409 | 21772 | interface definition above (@pxref{Pretty Printing API}). If a function |
a6bac58e TT |
21773 | cannot create a pretty-printer for the value, it should return |
21774 | @code{None}. | |
21775 | ||
21776 | @value{GDBN} first checks the @code{pretty_printers} attribute of each | |
fa33c3cd | 21777 | @code{gdb.Objfile} in the current program space and iteratively calls |
7b51bc51 DE |
21778 | each enabled lookup routine in the list for that @code{gdb.Objfile} |
21779 | until it receives a pretty-printer object. | |
fa33c3cd DE |
21780 | If no pretty-printer is found in the objfile lists, @value{GDBN} then |
21781 | searches the pretty-printer list of the current program space, | |
967cf477 | 21782 | calling each enabled function until an object is returned. |
a6bac58e | 21783 | After these lists have been exhausted, it tries the global |
967cf477 | 21784 | @code{gdb.pretty_printers} list, again calling each enabled function until an |
a6bac58e TT |
21785 | object is returned. |
21786 | ||
21787 | The order in which the objfiles are searched is not specified. For a | |
21788 | given list, functions are always invoked from the head of the list, | |
21789 | and iterated over sequentially until the end of the list, or a printer | |
21790 | object is returned. | |
21791 | ||
7b51bc51 DE |
21792 | For various reasons a pretty-printer may not work. |
21793 | For example, the underlying data structure may have changed and | |
21794 | the pretty-printer is out of date. | |
21795 | ||
21796 | The consequences of a broken pretty-printer are severe enough that | |
21797 | @value{GDBN} provides support for enabling and disabling individual | |
21798 | printers. For example, if @code{print frame-arguments} is on, | |
21799 | a backtrace can become highly illegible if any argument is printed | |
21800 | with a broken printer. | |
21801 | ||
21802 | Pretty-printers are enabled and disabled by attaching an @code{enabled} | |
21803 | attribute to the registered function or callable object. If this attribute | |
21804 | is present and its value is @code{False}, the printer is disabled, otherwise | |
21805 | the printer is enabled. | |
21806 | ||
21807 | @node Writing a Pretty-Printer | |
21808 | @subsubsection Writing a Pretty-Printer | |
21809 | @cindex writing a pretty-printer | |
21810 | ||
21811 | A pretty-printer consists of two parts: a lookup function to detect | |
21812 | if the type is supported, and the printer itself. | |
21813 | ||
a6bac58e | 21814 | Here is an example showing how a @code{std::string} printer might be |
7b51bc51 DE |
21815 | written. @xref{Pretty Printing API}, for details on the API this class |
21816 | must provide. | |
a6bac58e TT |
21817 | |
21818 | @smallexample | |
7b51bc51 | 21819 | class StdStringPrinter(object): |
a6bac58e TT |
21820 | "Print a std::string" |
21821 | ||
7b51bc51 | 21822 | def __init__(self, val): |
a6bac58e TT |
21823 | self.val = val |
21824 | ||
7b51bc51 | 21825 | def to_string(self): |
a6bac58e TT |
21826 | return self.val['_M_dataplus']['_M_p'] |
21827 | ||
7b51bc51 | 21828 | def display_hint(self): |
a6bac58e TT |
21829 | return 'string' |
21830 | @end smallexample | |
21831 | ||
21832 | And here is an example showing how a lookup function for the printer | |
21833 | example above might be written. | |
21834 | ||
21835 | @smallexample | |
7b51bc51 | 21836 | def str_lookup_function(val): |
a6bac58e | 21837 | lookup_tag = val.type.tag |
a6bac58e TT |
21838 | if lookup_tag == None: |
21839 | return None | |
7b51bc51 DE |
21840 | regex = re.compile("^std::basic_string<char,.*>$") |
21841 | if regex.match(lookup_tag): | |
21842 | return StdStringPrinter(val) | |
a6bac58e TT |
21843 | return None |
21844 | @end smallexample | |
21845 | ||
21846 | The example lookup function extracts the value's type, and attempts to | |
21847 | match it to a type that it can pretty-print. If it is a type the | |
21848 | printer can pretty-print, it will return a printer object. If not, it | |
21849 | returns @code{None}. | |
21850 | ||
21851 | We recommend that you put your core pretty-printers into a Python | |
21852 | package. If your pretty-printers are for use with a library, we | |
21853 | further recommend embedding a version number into the package name. | |
21854 | This practice will enable @value{GDBN} to load multiple versions of | |
21855 | your pretty-printers at the same time, because they will have | |
21856 | different names. | |
21857 | ||
21858 | You should write auto-loaded code (@pxref{Auto-loading}) such that it | |
21859 | can be evaluated multiple times without changing its meaning. An | |
21860 | ideal auto-load file will consist solely of @code{import}s of your | |
21861 | printer modules, followed by a call to a register pretty-printers with | |
21862 | the current objfile. | |
21863 | ||
21864 | Taken as a whole, this approach will scale nicely to multiple | |
21865 | inferiors, each potentially using a different library version. | |
21866 | Embedding a version number in the Python package name will ensure that | |
21867 | @value{GDBN} is able to load both sets of printers simultaneously. | |
21868 | Then, because the search for pretty-printers is done by objfile, and | |
21869 | because your auto-loaded code took care to register your library's | |
21870 | printers with a specific objfile, @value{GDBN} will find the correct | |
21871 | printers for the specific version of the library used by each | |
21872 | inferior. | |
21873 | ||
4c374409 | 21874 | To continue the @code{std::string} example (@pxref{Pretty Printing API}), |
a6bac58e TT |
21875 | this code might appear in @code{gdb.libstdcxx.v6}: |
21876 | ||
21877 | @smallexample | |
7b51bc51 DE |
21878 | def register_printers(objfile): |
21879 | objfile.pretty_printers.add(str_lookup_function) | |
a6bac58e TT |
21880 | @end smallexample |
21881 | ||
21882 | @noindent | |
21883 | And then the corresponding contents of the auto-load file would be: | |
21884 | ||
21885 | @smallexample | |
21886 | import gdb.libstdcxx.v6 | |
7b51bc51 | 21887 | gdb.libstdcxx.v6.register_printers(gdb.current_objfile()) |
a6bac58e TT |
21888 | @end smallexample |
21889 | ||
7b51bc51 DE |
21890 | The previous example illustrates a basic pretty-printer. |
21891 | There are a few things that can be improved on. | |
21892 | The printer doesn't have a name, making it hard to identify in a | |
21893 | list of installed printers. The lookup function has a name, but | |
21894 | lookup functions can have arbitrary, even identical, names. | |
967cf477 | 21895 | |
7b51bc51 DE |
21896 | Second, the printer only handles one type, whereas a library typically has |
21897 | several types. One could install a lookup function for each desired type | |
21898 | in the library, but one could also have a single lookup function recognize | |
21899 | several types. The latter is the conventional way this is handled. | |
21900 | If a pretty-printer can handle multiple data types, then its | |
21901 | @dfn{subprinters} are the printers for the individual data types. | |
967cf477 | 21902 | |
7b51bc51 DE |
21903 | The @code{gdb.printing} module provides a formal way of solving these |
21904 | problems (@pxref{gdb.printing}). | |
21905 | Here is another example that handles multiple types. | |
967cf477 | 21906 | |
7b51bc51 DE |
21907 | These are the types we are going to pretty-print: |
21908 | ||
21909 | @smallexample | |
21910 | struct foo @{ int a, b; @}; | |
21911 | struct bar @{ struct foo x, y; @}; | |
21912 | @end smallexample | |
21913 | ||
21914 | Here are the printers: | |
21915 | ||
21916 | @smallexample | |
21917 | class fooPrinter: | |
21918 | """Print a foo object.""" | |
21919 | ||
21920 | def __init__(self, val): | |
21921 | self.val = val | |
21922 | ||
21923 | def to_string(self): | |
21924 | return ("a=<" + str(self.val["a"]) + | |
21925 | "> b=<" + str(self.val["b"]) + ">") | |
21926 | ||
21927 | class barPrinter: | |
21928 | """Print a bar object.""" | |
21929 | ||
21930 | def __init__(self, val): | |
21931 | self.val = val | |
21932 | ||
21933 | def to_string(self): | |
21934 | return ("x=<" + str(self.val["x"]) + | |
21935 | "> y=<" + str(self.val["y"]) + ">") | |
21936 | @end smallexample | |
21937 | ||
21938 | This example doesn't need a lookup function, that is handled by the | |
21939 | @code{gdb.printing} module. Instead a function is provided to build up | |
21940 | the object that handles the lookup. | |
21941 | ||
21942 | @smallexample | |
21943 | import gdb.printing | |
21944 | ||
21945 | def build_pretty_printer(): | |
21946 | pp = gdb.printing.RegexpCollectionPrettyPrinter( | |
21947 | "my_library") | |
21948 | pp.add_printer('foo', '^foo$', fooPrinter) | |
21949 | pp.add_printer('bar', '^bar$', barPrinter) | |
21950 | return pp | |
21951 | @end smallexample | |
21952 | ||
21953 | And here is the autoload support: | |
21954 | ||
21955 | @smallexample | |
21956 | import gdb.printing | |
21957 | import my_library | |
21958 | gdb.printing.register_pretty_printer( | |
21959 | gdb.current_objfile(), | |
21960 | my_library.build_pretty_printer()) | |
21961 | @end smallexample | |
21962 | ||
21963 | Finally, when this printer is loaded into @value{GDBN}, here is the | |
21964 | corresponding output of @samp{info pretty-printer}: | |
21965 | ||
21966 | @smallexample | |
21967 | (gdb) info pretty-printer | |
21968 | my_library.so: | |
21969 | my_library | |
21970 | foo | |
21971 | bar | |
21972 | @end smallexample | |
967cf477 | 21973 | |
595939de PM |
21974 | @node Inferiors In Python |
21975 | @subsubsection Inferiors In Python | |
505500db | 21976 | @cindex inferiors in Python |
595939de PM |
21977 | |
21978 | @findex gdb.Inferior | |
21979 | Programs which are being run under @value{GDBN} are called inferiors | |
21980 | (@pxref{Inferiors and Programs}). Python scripts can access | |
21981 | information about and manipulate inferiors controlled by @value{GDBN} | |
21982 | via objects of the @code{gdb.Inferior} class. | |
21983 | ||
21984 | The following inferior-related functions are available in the @code{gdb} | |
21985 | module: | |
21986 | ||
21987 | @defun inferiors | |
21988 | Return a tuple containing all inferior objects. | |
21989 | @end defun | |
21990 | ||
21991 | A @code{gdb.Inferior} object has the following attributes: | |
21992 | ||
21993 | @table @code | |
21994 | @defivar Inferior num | |
21995 | ID of inferior, as assigned by GDB. | |
21996 | @end defivar | |
21997 | ||
21998 | @defivar Inferior pid | |
21999 | Process ID of the inferior, as assigned by the underlying operating | |
22000 | system. | |
22001 | @end defivar | |
22002 | ||
22003 | @defivar Inferior was_attached | |
22004 | Boolean signaling whether the inferior was created using `attach', or | |
22005 | started by @value{GDBN} itself. | |
22006 | @end defivar | |
22007 | @end table | |
22008 | ||
22009 | A @code{gdb.Inferior} object has the following methods: | |
22010 | ||
22011 | @table @code | |
29703da4 PM |
22012 | @defmethod Inferior is_valid |
22013 | Returns @code{True} if the @code{gdb.Inferior} object is valid, | |
22014 | @code{False} if not. A @code{gdb.Inferior} object will become invalid | |
22015 | if the inferior no longer exists within @value{GDBN}. All other | |
22016 | @code{gdb.Inferior} methods will throw an exception if it is invalid | |
22017 | at the time the method is called. | |
22018 | @end defmethod | |
22019 | ||
595939de PM |
22020 | @defmethod Inferior threads |
22021 | This method returns a tuple holding all the threads which are valid | |
22022 | when it is called. If there are no valid threads, the method will | |
22023 | return an empty tuple. | |
22024 | @end defmethod | |
22025 | ||
22026 | @findex gdb.read_memory | |
22027 | @defmethod Inferior read_memory address length | |
22028 | Read @var{length} bytes of memory from the inferior, starting at | |
22029 | @var{address}. Returns a buffer object, which behaves much like an array | |
22030 | or a string. It can be modified and given to the @code{gdb.write_memory} | |
22031 | function. | |
22032 | @end defmethod | |
22033 | ||
22034 | @findex gdb.write_memory | |
22035 | @defmethod Inferior write_memory address buffer @r{[}length@r{]} | |
22036 | Write the contents of @var{buffer} to the inferior, starting at | |
22037 | @var{address}. The @var{buffer} parameter must be a Python object | |
22038 | which supports the buffer protocol, i.e., a string, an array or the | |
22039 | object returned from @code{gdb.read_memory}. If given, @var{length} | |
22040 | determines the number of bytes from @var{buffer} to be written. | |
22041 | @end defmethod | |
22042 | ||
22043 | @findex gdb.search_memory | |
22044 | @defmethod Inferior search_memory address length pattern | |
22045 | Search a region of the inferior memory starting at @var{address} with | |
22046 | the given @var{length} using the search pattern supplied in | |
22047 | @var{pattern}. The @var{pattern} parameter must be a Python object | |
22048 | which supports the buffer protocol, i.e., a string, an array or the | |
22049 | object returned from @code{gdb.read_memory}. Returns a Python @code{Long} | |
22050 | containing the address where the pattern was found, or @code{None} if | |
22051 | the pattern could not be found. | |
22052 | @end defmethod | |
22053 | @end table | |
22054 | ||
505500db SW |
22055 | @node Events In Python |
22056 | @subsubsection Events In Python | |
22057 | @cindex inferior events in Python | |
22058 | ||
22059 | @value{GDBN} provides a general event facility so that Python code can be | |
22060 | notified of various state changes, particularly changes that occur in | |
22061 | the inferior. | |
22062 | ||
22063 | An @dfn{event} is just an object that describes some state change. The | |
22064 | type of the object and its attributes will vary depending on the details | |
22065 | of the change. All the existing events are described below. | |
22066 | ||
22067 | In order to be notified of an event, you must register an event handler | |
22068 | with an @dfn{event registry}. An event registry is an object in the | |
22069 | @code{gdb.events} module which dispatches particular events. A registry | |
22070 | provides methods to register and unregister event handlers: | |
22071 | ||
22072 | @table @code | |
22073 | @defmethod EventRegistry connect object | |
22074 | Add the given callable @var{object} to the registry. This object will be | |
22075 | called when an event corresponding to this registry occurs. | |
22076 | @end defmethod | |
22077 | ||
22078 | @defmethod EventRegistry disconnect object | |
22079 | Remove the given @var{object} from the registry. Once removed, the object | |
22080 | will no longer receive notifications of events. | |
22081 | @end defmethod | |
22082 | @end table | |
22083 | ||
22084 | Here is an example: | |
22085 | ||
22086 | @smallexample | |
22087 | def exit_handler (event): | |
22088 | print "event type: exit" | |
22089 | print "exit code: %d" % (event.exit_code) | |
22090 | ||
22091 | gdb.events.exited.connect (exit_handler) | |
22092 | @end smallexample | |
22093 | ||
22094 | In the above example we connect our handler @code{exit_handler} to the | |
22095 | registry @code{events.exited}. Once connected, @code{exit_handler} gets | |
22096 | called when the inferior exits. The argument @dfn{event} in this example is | |
22097 | of type @code{gdb.ExitedEvent}. As you can see in the example the | |
22098 | @code{ExitedEvent} object has an attribute which indicates the exit code of | |
22099 | the inferior. | |
22100 | ||
22101 | The following is a listing of the event registries that are available and | |
22102 | details of the events they emit: | |
22103 | ||
22104 | @table @code | |
22105 | ||
22106 | @item events.cont | |
22107 | Emits @code{gdb.ThreadEvent}. | |
22108 | ||
22109 | Some events can be thread specific when @value{GDBN} is running in non-stop | |
22110 | mode. When represented in Python, these events all extend | |
22111 | @code{gdb.ThreadEvent}. Note, this event is not emitted directly; instead, | |
22112 | events which are emitted by this or other modules might extend this event. | |
22113 | Examples of these events are @code{gdb.BreakpointEvent} and | |
22114 | @code{gdb.ContinueEvent}. | |
22115 | ||
22116 | @table @code | |
22117 | @defivar ThreadEvent inferior_thread | |
22118 | In non-stop mode this attribute will be set to the specific thread which was | |
22119 | involved in the emitted event. Otherwise, it will be set to @code{None}. | |
22120 | @end defivar | |
22121 | @end table | |
22122 | ||
22123 | Emits @code{gdb.ContinueEvent} which extends @code{gdb.ThreadEvent}. | |
22124 | ||
22125 | This event indicates that the inferior has been continued after a stop. For | |
22126 | inherited attribute refer to @code{gdb.ThreadEvent} above. | |
22127 | ||
22128 | @item events.exited | |
22129 | Emits @code{events.ExitedEvent} which indicates that the inferior has exited. | |
22130 | @code{events.ExitedEvent} has one attribute: | |
22131 | @table @code | |
22132 | @defivar ExitedEvent exit_code | |
22133 | An integer representing the exit code which the inferior has returned. | |
22134 | @end defivar | |
22135 | @end table | |
22136 | ||
22137 | @item events.stop | |
22138 | Emits @code{gdb.StopEvent} which extends @code{gdb.ThreadEvent}. | |
22139 | ||
22140 | Indicates that the inferior has stopped. All events emitted by this registry | |
22141 | extend StopEvent. As a child of @code{gdb.ThreadEvent}, @code{gdb.StopEvent} | |
22142 | will indicate the stopped thread when @value{GDBN} is running in non-stop | |
22143 | mode. Refer to @code{gdb.ThreadEvent} above for more details. | |
22144 | ||
22145 | Emits @code{gdb.SignalEvent} which extends @code{gdb.StopEvent}. | |
22146 | ||
22147 | This event indicates that the inferior or one of its threads has received as | |
22148 | signal. @code{gdb.SignalEvent} has the following attributes: | |
22149 | ||
22150 | @table @code | |
22151 | @defivar SignalEvent stop_signal | |
22152 | A string representing the signal received by the inferior. A list of possible | |
22153 | signal values can be obtained by running the command @code{info signals} in | |
22154 | the @value{GDBN} command prompt. | |
22155 | @end defivar | |
22156 | @end table | |
22157 | ||
22158 | Also emits @code{gdb.BreakpointEvent} which extends @code{gdb.StopEvent}. | |
22159 | ||
22160 | @code{gdb.BreakpointEvent} event indicates that a breakpoint has been hit, and | |
22161 | has the following attributes: | |
22162 | ||
22163 | @table @code | |
22164 | @defivar BreakpointEvent breakpoint | |
22165 | A reference to the breakpoint that was hit of type @code{gdb.Breakpoint}. | |
22166 | @xref{Breakpoints In Python}, for details of the @code{gdb.Breakpoint} object. | |
22167 | @end defivar | |
22168 | @end table | |
22169 | ||
22170 | @end table | |
22171 | ||
595939de PM |
22172 | @node Threads In Python |
22173 | @subsubsection Threads In Python | |
22174 | @cindex threads in python | |
22175 | ||
22176 | @findex gdb.InferiorThread | |
22177 | Python scripts can access information about, and manipulate inferior threads | |
22178 | controlled by @value{GDBN}, via objects of the @code{gdb.InferiorThread} class. | |
22179 | ||
22180 | The following thread-related functions are available in the @code{gdb} | |
22181 | module: | |
22182 | ||
22183 | @findex gdb.selected_thread | |
22184 | @defun selected_thread | |
22185 | This function returns the thread object for the selected thread. If there | |
22186 | is no selected thread, this will return @code{None}. | |
22187 | @end defun | |
22188 | ||
22189 | A @code{gdb.InferiorThread} object has the following attributes: | |
22190 | ||
22191 | @table @code | |
4694da01 TT |
22192 | @defivar InferiorThread name |
22193 | The name of the thread. If the user specified a name using | |
22194 | @code{thread name}, then this returns that name. Otherwise, if an | |
22195 | OS-supplied name is available, then it is returned. Otherwise, this | |
22196 | returns @code{None}. | |
22197 | ||
22198 | This attribute can be assigned to. The new value must be a string | |
22199 | object, which sets the new name, or @code{None}, which removes any | |
22200 | user-specified thread name. | |
22201 | @end defivar | |
22202 | ||
595939de PM |
22203 | @defivar InferiorThread num |
22204 | ID of the thread, as assigned by GDB. | |
22205 | @end defivar | |
22206 | ||
22207 | @defivar InferiorThread ptid | |
22208 | ID of the thread, as assigned by the operating system. This attribute is a | |
22209 | tuple containing three integers. The first is the Process ID (PID); the second | |
22210 | is the Lightweight Process ID (LWPID), and the third is the Thread ID (TID). | |
22211 | Either the LWPID or TID may be 0, which indicates that the operating system | |
22212 | does not use that identifier. | |
22213 | @end defivar | |
22214 | @end table | |
22215 | ||
22216 | A @code{gdb.InferiorThread} object has the following methods: | |
22217 | ||
dc3b15be | 22218 | @table @code |
29703da4 PM |
22219 | @defmethod InferiorThread is_valid |
22220 | Returns @code{True} if the @code{gdb.InferiorThread} object is valid, | |
22221 | @code{False} if not. A @code{gdb.InferiorThread} object will become | |
22222 | invalid if the thread exits, or the inferior that the thread belongs | |
22223 | is deleted. All other @code{gdb.InferiorThread} methods will throw an | |
22224 | exception if it is invalid at the time the method is called. | |
22225 | @end defmethod | |
22226 | ||
595939de PM |
22227 | @defmethod InferiorThread switch |
22228 | This changes @value{GDBN}'s currently selected thread to the one represented | |
22229 | by this object. | |
22230 | @end defmethod | |
22231 | ||
22232 | @defmethod InferiorThread is_stopped | |
22233 | Return a Boolean indicating whether the thread is stopped. | |
22234 | @end defmethod | |
22235 | ||
22236 | @defmethod InferiorThread is_running | |
22237 | Return a Boolean indicating whether the thread is running. | |
22238 | @end defmethod | |
22239 | ||
22240 | @defmethod InferiorThread is_exited | |
22241 | Return a Boolean indicating whether the thread is exited. | |
22242 | @end defmethod | |
22243 | @end table | |
22244 | ||
d8906c6f TJB |
22245 | @node Commands In Python |
22246 | @subsubsection Commands In Python | |
22247 | ||
22248 | @cindex commands in python | |
22249 | @cindex python commands | |
d8906c6f TJB |
22250 | You can implement new @value{GDBN} CLI commands in Python. A CLI |
22251 | command is implemented using an instance of the @code{gdb.Command} | |
22252 | class, most commonly using a subclass. | |
22253 | ||
cc924cad | 22254 | @defmethod Command __init__ name @var{command_class} @r{[}@var{completer_class}@r{]} @r{[}@var{prefix}@r{]} |
d8906c6f TJB |
22255 | The object initializer for @code{Command} registers the new command |
22256 | with @value{GDBN}. This initializer is normally invoked from the | |
22257 | subclass' own @code{__init__} method. | |
22258 | ||
22259 | @var{name} is the name of the command. If @var{name} consists of | |
22260 | multiple words, then the initial words are looked for as prefix | |
22261 | commands. In this case, if one of the prefix commands does not exist, | |
22262 | an exception is raised. | |
22263 | ||
22264 | There is no support for multi-line commands. | |
22265 | ||
cc924cad | 22266 | @var{command_class} should be one of the @samp{COMMAND_} constants |
d8906c6f TJB |
22267 | defined below. This argument tells @value{GDBN} how to categorize the |
22268 | new command in the help system. | |
22269 | ||
cc924cad | 22270 | @var{completer_class} is an optional argument. If given, it should be |
d8906c6f TJB |
22271 | one of the @samp{COMPLETE_} constants defined below. This argument |
22272 | tells @value{GDBN} how to perform completion for this command. If not | |
22273 | given, @value{GDBN} will attempt to complete using the object's | |
22274 | @code{complete} method (see below); if no such method is found, an | |
22275 | error will occur when completion is attempted. | |
22276 | ||
22277 | @var{prefix} is an optional argument. If @code{True}, then the new | |
22278 | command is a prefix command; sub-commands of this command may be | |
22279 | registered. | |
22280 | ||
22281 | The help text for the new command is taken from the Python | |
22282 | documentation string for the command's class, if there is one. If no | |
22283 | documentation string is provided, the default value ``This command is | |
22284 | not documented.'' is used. | |
22285 | @end defmethod | |
22286 | ||
a0c36267 | 22287 | @cindex don't repeat Python command |
d8906c6f TJB |
22288 | @defmethod Command dont_repeat |
22289 | By default, a @value{GDBN} command is repeated when the user enters a | |
22290 | blank line at the command prompt. A command can suppress this | |
22291 | behavior by invoking the @code{dont_repeat} method. This is similar | |
22292 | to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}. | |
22293 | @end defmethod | |
22294 | ||
22295 | @defmethod Command invoke argument from_tty | |
22296 | This method is called by @value{GDBN} when this command is invoked. | |
22297 | ||
22298 | @var{argument} is a string. It is the argument to the command, after | |
22299 | leading and trailing whitespace has been stripped. | |
22300 | ||
22301 | @var{from_tty} is a boolean argument. When true, this means that the | |
22302 | command was entered by the user at the terminal; when false it means | |
22303 | that the command came from elsewhere. | |
22304 | ||
22305 | If this method throws an exception, it is turned into a @value{GDBN} | |
22306 | @code{error} call. Otherwise, the return value is ignored. | |
07ca107c DE |
22307 | |
22308 | @findex gdb.string_to_argv | |
22309 | To break @var{argument} up into an argv-like string use | |
22310 | @code{gdb.string_to_argv}. This function behaves identically to | |
22311 | @value{GDBN}'s internal argument lexer @code{buildargv}. | |
22312 | It is recommended to use this for consistency. | |
22313 | Arguments are separated by spaces and may be quoted. | |
22314 | Example: | |
22315 | ||
22316 | @smallexample | |
22317 | print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"") | |
22318 | ['1', '2 "3', '4 "5', "6 '7"] | |
22319 | @end smallexample | |
22320 | ||
d8906c6f TJB |
22321 | @end defmethod |
22322 | ||
a0c36267 | 22323 | @cindex completion of Python commands |
d8906c6f TJB |
22324 | @defmethod Command complete text word |
22325 | This method is called by @value{GDBN} when the user attempts | |
22326 | completion on this command. All forms of completion are handled by | |
a0c36267 EZ |
22327 | this method, that is, the @key{TAB} and @key{M-?} key bindings |
22328 | (@pxref{Completion}), and the @code{complete} command (@pxref{Help, | |
22329 | complete}). | |
d8906c6f TJB |
22330 | |
22331 | The arguments @var{text} and @var{word} are both strings. @var{text} | |
22332 | holds the complete command line up to the cursor's location. | |
22333 | @var{word} holds the last word of the command line; this is computed | |
22334 | using a word-breaking heuristic. | |
22335 | ||
22336 | The @code{complete} method can return several values: | |
22337 | @itemize @bullet | |
22338 | @item | |
22339 | If the return value is a sequence, the contents of the sequence are | |
22340 | used as the completions. It is up to @code{complete} to ensure that the | |
22341 | contents actually do complete the word. A zero-length sequence is | |
22342 | allowed, it means that there were no completions available. Only | |
22343 | string elements of the sequence are used; other elements in the | |
22344 | sequence are ignored. | |
22345 | ||
22346 | @item | |
22347 | If the return value is one of the @samp{COMPLETE_} constants defined | |
22348 | below, then the corresponding @value{GDBN}-internal completion | |
22349 | function is invoked, and its result is used. | |
22350 | ||
22351 | @item | |
22352 | All other results are treated as though there were no available | |
22353 | completions. | |
22354 | @end itemize | |
22355 | @end defmethod | |
22356 | ||
d8906c6f TJB |
22357 | When a new command is registered, it must be declared as a member of |
22358 | some general class of commands. This is used to classify top-level | |
22359 | commands in the on-line help system; note that prefix commands are not | |
22360 | listed under their own category but rather that of their top-level | |
22361 | command. The available classifications are represented by constants | |
22362 | defined in the @code{gdb} module: | |
22363 | ||
22364 | @table @code | |
22365 | @findex COMMAND_NONE | |
22366 | @findex gdb.COMMAND_NONE | |
22367 | @item COMMAND_NONE | |
22368 | The command does not belong to any particular class. A command in | |
22369 | this category will not be displayed in any of the help categories. | |
22370 | ||
22371 | @findex COMMAND_RUNNING | |
22372 | @findex gdb.COMMAND_RUNNING | |
a0c36267 | 22373 | @item COMMAND_RUNNING |
d8906c6f TJB |
22374 | The command is related to running the inferior. For example, |
22375 | @code{start}, @code{step}, and @code{continue} are in this category. | |
a0c36267 | 22376 | Type @kbd{help running} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22377 | commands in this category. |
22378 | ||
22379 | @findex COMMAND_DATA | |
22380 | @findex gdb.COMMAND_DATA | |
a0c36267 | 22381 | @item COMMAND_DATA |
d8906c6f TJB |
22382 | The command is related to data or variables. For example, |
22383 | @code{call}, @code{find}, and @code{print} are in this category. Type | |
a0c36267 | 22384 | @kbd{help data} at the @value{GDBN} prompt to see a list of commands |
d8906c6f TJB |
22385 | in this category. |
22386 | ||
22387 | @findex COMMAND_STACK | |
22388 | @findex gdb.COMMAND_STACK | |
22389 | @item COMMAND_STACK | |
22390 | The command has to do with manipulation of the stack. For example, | |
22391 | @code{backtrace}, @code{frame}, and @code{return} are in this | |
a0c36267 | 22392 | category. Type @kbd{help stack} at the @value{GDBN} prompt to see a |
d8906c6f TJB |
22393 | list of commands in this category. |
22394 | ||
22395 | @findex COMMAND_FILES | |
22396 | @findex gdb.COMMAND_FILES | |
22397 | @item COMMAND_FILES | |
22398 | This class is used for file-related commands. For example, | |
22399 | @code{file}, @code{list} and @code{section} are in this category. | |
a0c36267 | 22400 | Type @kbd{help files} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22401 | commands in this category. |
22402 | ||
22403 | @findex COMMAND_SUPPORT | |
22404 | @findex gdb.COMMAND_SUPPORT | |
22405 | @item COMMAND_SUPPORT | |
22406 | This should be used for ``support facilities'', generally meaning | |
22407 | things that are useful to the user when interacting with @value{GDBN}, | |
22408 | but not related to the state of the inferior. For example, | |
22409 | @code{help}, @code{make}, and @code{shell} are in this category. Type | |
a0c36267 | 22410 | @kbd{help support} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22411 | commands in this category. |
22412 | ||
22413 | @findex COMMAND_STATUS | |
22414 | @findex gdb.COMMAND_STATUS | |
a0c36267 | 22415 | @item COMMAND_STATUS |
d8906c6f TJB |
22416 | The command is an @samp{info}-related command, that is, related to the |
22417 | state of @value{GDBN} itself. For example, @code{info}, @code{macro}, | |
a0c36267 | 22418 | and @code{show} are in this category. Type @kbd{help status} at the |
d8906c6f TJB |
22419 | @value{GDBN} prompt to see a list of commands in this category. |
22420 | ||
22421 | @findex COMMAND_BREAKPOINTS | |
22422 | @findex gdb.COMMAND_BREAKPOINTS | |
a0c36267 | 22423 | @item COMMAND_BREAKPOINTS |
d8906c6f | 22424 | The command has to do with breakpoints. For example, @code{break}, |
a0c36267 | 22425 | @code{clear}, and @code{delete} are in this category. Type @kbd{help |
d8906c6f TJB |
22426 | breakpoints} at the @value{GDBN} prompt to see a list of commands in |
22427 | this category. | |
22428 | ||
22429 | @findex COMMAND_TRACEPOINTS | |
22430 | @findex gdb.COMMAND_TRACEPOINTS | |
a0c36267 | 22431 | @item COMMAND_TRACEPOINTS |
d8906c6f TJB |
22432 | The command has to do with tracepoints. For example, @code{trace}, |
22433 | @code{actions}, and @code{tfind} are in this category. Type | |
a0c36267 | 22434 | @kbd{help tracepoints} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22435 | commands in this category. |
22436 | ||
22437 | @findex COMMAND_OBSCURE | |
22438 | @findex gdb.COMMAND_OBSCURE | |
22439 | @item COMMAND_OBSCURE | |
22440 | The command is only used in unusual circumstances, or is not of | |
22441 | general interest to users. For example, @code{checkpoint}, | |
a0c36267 | 22442 | @code{fork}, and @code{stop} are in this category. Type @kbd{help |
d8906c6f TJB |
22443 | obscure} at the @value{GDBN} prompt to see a list of commands in this |
22444 | category. | |
22445 | ||
22446 | @findex COMMAND_MAINTENANCE | |
22447 | @findex gdb.COMMAND_MAINTENANCE | |
22448 | @item COMMAND_MAINTENANCE | |
22449 | The command is only useful to @value{GDBN} maintainers. The | |
22450 | @code{maintenance} and @code{flushregs} commands are in this category. | |
a0c36267 | 22451 | Type @kbd{help internals} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22452 | commands in this category. |
22453 | @end table | |
22454 | ||
d8906c6f TJB |
22455 | A new command can use a predefined completion function, either by |
22456 | specifying it via an argument at initialization, or by returning it | |
22457 | from the @code{complete} method. These predefined completion | |
22458 | constants are all defined in the @code{gdb} module: | |
22459 | ||
22460 | @table @code | |
22461 | @findex COMPLETE_NONE | |
22462 | @findex gdb.COMPLETE_NONE | |
22463 | @item COMPLETE_NONE | |
22464 | This constant means that no completion should be done. | |
22465 | ||
22466 | @findex COMPLETE_FILENAME | |
22467 | @findex gdb.COMPLETE_FILENAME | |
22468 | @item COMPLETE_FILENAME | |
22469 | This constant means that filename completion should be performed. | |
22470 | ||
22471 | @findex COMPLETE_LOCATION | |
22472 | @findex gdb.COMPLETE_LOCATION | |
22473 | @item COMPLETE_LOCATION | |
22474 | This constant means that location completion should be done. | |
22475 | @xref{Specify Location}. | |
22476 | ||
22477 | @findex COMPLETE_COMMAND | |
22478 | @findex gdb.COMPLETE_COMMAND | |
22479 | @item COMPLETE_COMMAND | |
22480 | This constant means that completion should examine @value{GDBN} | |
22481 | command names. | |
22482 | ||
22483 | @findex COMPLETE_SYMBOL | |
22484 | @findex gdb.COMPLETE_SYMBOL | |
22485 | @item COMPLETE_SYMBOL | |
22486 | This constant means that completion should be done using symbol names | |
22487 | as the source. | |
22488 | @end table | |
22489 | ||
22490 | The following code snippet shows how a trivial CLI command can be | |
22491 | implemented in Python: | |
22492 | ||
22493 | @smallexample | |
22494 | class HelloWorld (gdb.Command): | |
22495 | """Greet the whole world.""" | |
22496 | ||
22497 | def __init__ (self): | |
22498 | super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_OBSCURE) | |
22499 | ||
22500 | def invoke (self, arg, from_tty): | |
22501 | print "Hello, World!" | |
22502 | ||
22503 | HelloWorld () | |
22504 | @end smallexample | |
22505 | ||
22506 | The last line instantiates the class, and is necessary to trigger the | |
22507 | registration of the command with @value{GDBN}. Depending on how the | |
22508 | Python code is read into @value{GDBN}, you may need to import the | |
22509 | @code{gdb} module explicitly. | |
22510 | ||
d7b32ed3 PM |
22511 | @node Parameters In Python |
22512 | @subsubsection Parameters In Python | |
22513 | ||
22514 | @cindex parameters in python | |
22515 | @cindex python parameters | |
22516 | @tindex gdb.Parameter | |
22517 | @tindex Parameter | |
22518 | You can implement new @value{GDBN} parameters using Python. A new | |
22519 | parameter is implemented as an instance of the @code{gdb.Parameter} | |
22520 | class. | |
22521 | ||
22522 | Parameters are exposed to the user via the @code{set} and | |
22523 | @code{show} commands. @xref{Help}. | |
22524 | ||
22525 | There are many parameters that already exist and can be set in | |
22526 | @value{GDBN}. Two examples are: @code{set follow fork} and | |
22527 | @code{set charset}. Setting these parameters influences certain | |
22528 | behavior in @value{GDBN}. Similarly, you can define parameters that | |
22529 | can be used to influence behavior in custom Python scripts and commands. | |
22530 | ||
22531 | @defmethod Parameter __init__ name @var{command-class} @var{parameter-class} @r{[}@var{enum-sequence}@r{]} | |
22532 | The object initializer for @code{Parameter} registers the new | |
22533 | parameter with @value{GDBN}. This initializer is normally invoked | |
22534 | from the subclass' own @code{__init__} method. | |
22535 | ||
22536 | @var{name} is the name of the new parameter. If @var{name} consists | |
22537 | of multiple words, then the initial words are looked for as prefix | |
22538 | parameters. An example of this can be illustrated with the | |
22539 | @code{set print} set of parameters. If @var{name} is | |
22540 | @code{print foo}, then @code{print} will be searched as the prefix | |
22541 | parameter. In this case the parameter can subsequently be accessed in | |
22542 | @value{GDBN} as @code{set print foo}. | |
22543 | ||
22544 | If @var{name} consists of multiple words, and no prefix parameter group | |
22545 | can be found, an exception is raised. | |
22546 | ||
22547 | @var{command-class} should be one of the @samp{COMMAND_} constants | |
22548 | (@pxref{Commands In Python}). This argument tells @value{GDBN} how to | |
22549 | categorize the new parameter in the help system. | |
22550 | ||
22551 | @var{parameter-class} should be one of the @samp{PARAM_} constants | |
22552 | defined below. This argument tells @value{GDBN} the type of the new | |
22553 | parameter; this information is used for input validation and | |
22554 | completion. | |
22555 | ||
22556 | If @var{parameter-class} is @code{PARAM_ENUM}, then | |
22557 | @var{enum-sequence} must be a sequence of strings. These strings | |
22558 | represent the possible values for the parameter. | |
22559 | ||
22560 | If @var{parameter-class} is not @code{PARAM_ENUM}, then the presence | |
22561 | of a fourth argument will cause an exception to be thrown. | |
22562 | ||
22563 | The help text for the new parameter is taken from the Python | |
22564 | documentation string for the parameter's class, if there is one. If | |
22565 | there is no documentation string, a default value is used. | |
22566 | @end defmethod | |
22567 | ||
22568 | @defivar Parameter set_doc | |
22569 | If this attribute exists, and is a string, then its value is used as | |
22570 | the help text for this parameter's @code{set} command. The value is | |
22571 | examined when @code{Parameter.__init__} is invoked; subsequent changes | |
22572 | have no effect. | |
22573 | @end defivar | |
22574 | ||
22575 | @defivar Parameter show_doc | |
22576 | If this attribute exists, and is a string, then its value is used as | |
22577 | the help text for this parameter's @code{show} command. The value is | |
22578 | examined when @code{Parameter.__init__} is invoked; subsequent changes | |
22579 | have no effect. | |
22580 | @end defivar | |
22581 | ||
22582 | @defivar Parameter value | |
22583 | The @code{value} attribute holds the underlying value of the | |
22584 | parameter. It can be read and assigned to just as any other | |
22585 | attribute. @value{GDBN} does validation when assignments are made. | |
22586 | @end defivar | |
22587 | ||
ecec24e6 PM |
22588 | There are two methods that should be implemented in any |
22589 | @code{Parameter} class. These are: | |
22590 | ||
22591 | @defop Operation {parameter} get_set_string self | |
22592 | @value{GDBN} will call this method when a @var{parameter}'s value has | |
22593 | been changed via the @code{set} API (for example, @kbd{set foo off}). | |
22594 | The @code{value} attribute has already been populated with the new | |
22595 | value and may be used in output. This method must return a string. | |
22596 | @end defop | |
22597 | ||
22598 | @defop Operation {parameter} get_show_string self svalue | |
22599 | @value{GDBN} will call this method when a @var{parameter}'s | |
22600 | @code{show} API has been invoked (for example, @kbd{show foo}). The | |
22601 | argument @code{svalue} receives the string representation of the | |
22602 | current value. This method must return a string. | |
22603 | @end defop | |
d7b32ed3 PM |
22604 | |
22605 | When a new parameter is defined, its type must be specified. The | |
22606 | available types are represented by constants defined in the @code{gdb} | |
22607 | module: | |
22608 | ||
22609 | @table @code | |
22610 | @findex PARAM_BOOLEAN | |
22611 | @findex gdb.PARAM_BOOLEAN | |
22612 | @item PARAM_BOOLEAN | |
22613 | The value is a plain boolean. The Python boolean values, @code{True} | |
22614 | and @code{False} are the only valid values. | |
22615 | ||
22616 | @findex PARAM_AUTO_BOOLEAN | |
22617 | @findex gdb.PARAM_AUTO_BOOLEAN | |
22618 | @item PARAM_AUTO_BOOLEAN | |
22619 | The value has three possible states: true, false, and @samp{auto}. In | |
22620 | Python, true and false are represented using boolean constants, and | |
22621 | @samp{auto} is represented using @code{None}. | |
22622 | ||
22623 | @findex PARAM_UINTEGER | |
22624 | @findex gdb.PARAM_UINTEGER | |
22625 | @item PARAM_UINTEGER | |
22626 | The value is an unsigned integer. The value of 0 should be | |
22627 | interpreted to mean ``unlimited''. | |
22628 | ||
22629 | @findex PARAM_INTEGER | |
22630 | @findex gdb.PARAM_INTEGER | |
22631 | @item PARAM_INTEGER | |
22632 | The value is a signed integer. The value of 0 should be interpreted | |
22633 | to mean ``unlimited''. | |
22634 | ||
22635 | @findex PARAM_STRING | |
22636 | @findex gdb.PARAM_STRING | |
22637 | @item PARAM_STRING | |
22638 | The value is a string. When the user modifies the string, any escape | |
22639 | sequences, such as @samp{\t}, @samp{\f}, and octal escapes, are | |
22640 | translated into corresponding characters and encoded into the current | |
22641 | host charset. | |
22642 | ||
22643 | @findex PARAM_STRING_NOESCAPE | |
22644 | @findex gdb.PARAM_STRING_NOESCAPE | |
22645 | @item PARAM_STRING_NOESCAPE | |
22646 | The value is a string. When the user modifies the string, escapes are | |
22647 | passed through untranslated. | |
22648 | ||
22649 | @findex PARAM_OPTIONAL_FILENAME | |
22650 | @findex gdb.PARAM_OPTIONAL_FILENAME | |
22651 | @item PARAM_OPTIONAL_FILENAME | |
22652 | The value is a either a filename (a string), or @code{None}. | |
22653 | ||
22654 | @findex PARAM_FILENAME | |
22655 | @findex gdb.PARAM_FILENAME | |
22656 | @item PARAM_FILENAME | |
22657 | The value is a filename. This is just like | |
22658 | @code{PARAM_STRING_NOESCAPE}, but uses file names for completion. | |
22659 | ||
22660 | @findex PARAM_ZINTEGER | |
22661 | @findex gdb.PARAM_ZINTEGER | |
22662 | @item PARAM_ZINTEGER | |
22663 | The value is an integer. This is like @code{PARAM_INTEGER}, except 0 | |
22664 | is interpreted as itself. | |
22665 | ||
22666 | @findex PARAM_ENUM | |
22667 | @findex gdb.PARAM_ENUM | |
22668 | @item PARAM_ENUM | |
22669 | The value is a string, which must be one of a collection string | |
22670 | constants provided when the parameter is created. | |
22671 | @end table | |
22672 | ||
bc3b79fd TJB |
22673 | @node Functions In Python |
22674 | @subsubsection Writing new convenience functions | |
22675 | ||
22676 | @cindex writing convenience functions | |
22677 | @cindex convenience functions in python | |
22678 | @cindex python convenience functions | |
22679 | @tindex gdb.Function | |
22680 | @tindex Function | |
22681 | You can implement new convenience functions (@pxref{Convenience Vars}) | |
22682 | in Python. A convenience function is an instance of a subclass of the | |
22683 | class @code{gdb.Function}. | |
22684 | ||
22685 | @defmethod Function __init__ name | |
22686 | The initializer for @code{Function} registers the new function with | |
22687 | @value{GDBN}. The argument @var{name} is the name of the function, | |
22688 | a string. The function will be visible to the user as a convenience | |
22689 | variable of type @code{internal function}, whose name is the same as | |
22690 | the given @var{name}. | |
22691 | ||
22692 | The documentation for the new function is taken from the documentation | |
22693 | string for the new class. | |
22694 | @end defmethod | |
22695 | ||
22696 | @defmethod Function invoke @var{*args} | |
22697 | When a convenience function is evaluated, its arguments are converted | |
22698 | to instances of @code{gdb.Value}, and then the function's | |
22699 | @code{invoke} method is called. Note that @value{GDBN} does not | |
22700 | predetermine the arity of convenience functions. Instead, all | |
22701 | available arguments are passed to @code{invoke}, following the | |
22702 | standard Python calling convention. In particular, a convenience | |
22703 | function can have default values for parameters without ill effect. | |
22704 | ||
22705 | The return value of this method is used as its value in the enclosing | |
22706 | expression. If an ordinary Python value is returned, it is converted | |
22707 | to a @code{gdb.Value} following the usual rules. | |
22708 | @end defmethod | |
22709 | ||
22710 | The following code snippet shows how a trivial convenience function can | |
22711 | be implemented in Python: | |
22712 | ||
22713 | @smallexample | |
22714 | class Greet (gdb.Function): | |
22715 | """Return string to greet someone. | |
22716 | Takes a name as argument.""" | |
22717 | ||
22718 | def __init__ (self): | |
22719 | super (Greet, self).__init__ ("greet") | |
22720 | ||
22721 | def invoke (self, name): | |
22722 | return "Hello, %s!" % name.string () | |
22723 | ||
22724 | Greet () | |
22725 | @end smallexample | |
22726 | ||
22727 | The last line instantiates the class, and is necessary to trigger the | |
22728 | registration of the function with @value{GDBN}. Depending on how the | |
22729 | Python code is read into @value{GDBN}, you may need to import the | |
22730 | @code{gdb} module explicitly. | |
22731 | ||
fa33c3cd DE |
22732 | @node Progspaces In Python |
22733 | @subsubsection Program Spaces In Python | |
22734 | ||
22735 | @cindex progspaces in python | |
22736 | @tindex gdb.Progspace | |
22737 | @tindex Progspace | |
22738 | A program space, or @dfn{progspace}, represents a symbolic view | |
22739 | of an address space. | |
22740 | It consists of all of the objfiles of the program. | |
22741 | @xref{Objfiles In Python}. | |
22742 | @xref{Inferiors and Programs, program spaces}, for more details | |
22743 | about program spaces. | |
22744 | ||
22745 | The following progspace-related functions are available in the | |
22746 | @code{gdb} module: | |
22747 | ||
22748 | @findex gdb.current_progspace | |
22749 | @defun current_progspace | |
22750 | This function returns the program space of the currently selected inferior. | |
22751 | @xref{Inferiors and Programs}. | |
22752 | @end defun | |
22753 | ||
22754 | @findex gdb.progspaces | |
22755 | @defun progspaces | |
22756 | Return a sequence of all the progspaces currently known to @value{GDBN}. | |
22757 | @end defun | |
22758 | ||
22759 | Each progspace is represented by an instance of the @code{gdb.Progspace} | |
22760 | class. | |
22761 | ||
22762 | @defivar Progspace filename | |
22763 | The file name of the progspace as a string. | |
22764 | @end defivar | |
22765 | ||
22766 | @defivar Progspace pretty_printers | |
22767 | The @code{pretty_printers} attribute is a list of functions. It is | |
22768 | used to look up pretty-printers. A @code{Value} is passed to each | |
22769 | function in order; if the function returns @code{None}, then the | |
22770 | search continues. Otherwise, the return value should be an object | |
4c374409 | 22771 | which is used to format the value. @xref{Pretty Printing API}, for more |
fa33c3cd DE |
22772 | information. |
22773 | @end defivar | |
22774 | ||
89c73ade TT |
22775 | @node Objfiles In Python |
22776 | @subsubsection Objfiles In Python | |
22777 | ||
22778 | @cindex objfiles in python | |
22779 | @tindex gdb.Objfile | |
22780 | @tindex Objfile | |
22781 | @value{GDBN} loads symbols for an inferior from various | |
22782 | symbol-containing files (@pxref{Files}). These include the primary | |
22783 | executable file, any shared libraries used by the inferior, and any | |
22784 | separate debug info files (@pxref{Separate Debug Files}). | |
22785 | @value{GDBN} calls these symbol-containing files @dfn{objfiles}. | |
22786 | ||
22787 | The following objfile-related functions are available in the | |
22788 | @code{gdb} module: | |
22789 | ||
22790 | @findex gdb.current_objfile | |
22791 | @defun current_objfile | |
22792 | When auto-loading a Python script (@pxref{Auto-loading}), @value{GDBN} | |
22793 | sets the ``current objfile'' to the corresponding objfile. This | |
22794 | function returns the current objfile. If there is no current objfile, | |
22795 | this function returns @code{None}. | |
22796 | @end defun | |
22797 | ||
22798 | @findex gdb.objfiles | |
22799 | @defun objfiles | |
22800 | Return a sequence of all the objfiles current known to @value{GDBN}. | |
22801 | @xref{Objfiles In Python}. | |
22802 | @end defun | |
22803 | ||
22804 | Each objfile is represented by an instance of the @code{gdb.Objfile} | |
22805 | class. | |
22806 | ||
22807 | @defivar Objfile filename | |
22808 | The file name of the objfile as a string. | |
22809 | @end defivar | |
22810 | ||
22811 | @defivar Objfile pretty_printers | |
22812 | The @code{pretty_printers} attribute is a list of functions. It is | |
22813 | used to look up pretty-printers. A @code{Value} is passed to each | |
22814 | function in order; if the function returns @code{None}, then the | |
22815 | search continues. Otherwise, the return value should be an object | |
4c374409 | 22816 | which is used to format the value. @xref{Pretty Printing API}, for more |
a6bac58e | 22817 | information. |
89c73ade TT |
22818 | @end defivar |
22819 | ||
29703da4 PM |
22820 | A @code{gdb.Objfile} object has the following methods: |
22821 | ||
22822 | @defmethod Objfile is_valid | |
22823 | Returns @code{True} if the @code{gdb.Objfile} object is valid, | |
22824 | @code{False} if not. A @code{gdb.Objfile} object can become invalid | |
22825 | if the object file it refers to is not loaded in @value{GDBN} any | |
22826 | longer. All other @code{gdb.Objfile} methods will throw an exception | |
22827 | if it is invalid at the time the method is called. | |
22828 | @end defmethod | |
22829 | ||
f8f6f20b | 22830 | @node Frames In Python |
f3e9a817 | 22831 | @subsubsection Accessing inferior stack frames from Python. |
f8f6f20b TJB |
22832 | |
22833 | @cindex frames in python | |
22834 | When the debugged program stops, @value{GDBN} is able to analyze its call | |
22835 | stack (@pxref{Frames,,Stack frames}). The @code{gdb.Frame} class | |
22836 | represents a frame in the stack. A @code{gdb.Frame} object is only valid | |
22837 | while its corresponding frame exists in the inferior's stack. If you try | |
621c8364 TT |
22838 | to use an invalid frame object, @value{GDBN} will throw a @code{gdb.error} |
22839 | exception (@pxref{Exception Handling}). | |
f8f6f20b TJB |
22840 | |
22841 | Two @code{gdb.Frame} objects can be compared for equality with the @code{==} | |
22842 | operator, like: | |
22843 | ||
22844 | @smallexample | |
22845 | (@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame () | |
22846 | True | |
22847 | @end smallexample | |
22848 | ||
22849 | The following frame-related functions are available in the @code{gdb} module: | |
22850 | ||
22851 | @findex gdb.selected_frame | |
22852 | @defun selected_frame | |
22853 | Return the selected frame object. (@pxref{Selection,,Selecting a Frame}). | |
22854 | @end defun | |
22855 | ||
d8e22779 TT |
22856 | @findex gdb.newest_frame |
22857 | @defun newest_frame | |
22858 | Return the newest frame object for the selected thread. | |
22859 | @end defun | |
22860 | ||
f8f6f20b TJB |
22861 | @defun frame_stop_reason_string reason |
22862 | Return a string explaining the reason why @value{GDBN} stopped unwinding | |
22863 | frames, as expressed by the given @var{reason} code (an integer, see the | |
22864 | @code{unwind_stop_reason} method further down in this section). | |
22865 | @end defun | |
22866 | ||
22867 | A @code{gdb.Frame} object has the following methods: | |
22868 | ||
22869 | @table @code | |
22870 | @defmethod Frame is_valid | |
22871 | Returns true if the @code{gdb.Frame} object is valid, false if not. | |
22872 | A frame object can become invalid if the frame it refers to doesn't | |
22873 | exist anymore in the inferior. All @code{gdb.Frame} methods will throw | |
22874 | an exception if it is invalid at the time the method is called. | |
22875 | @end defmethod | |
22876 | ||
22877 | @defmethod Frame name | |
22878 | Returns the function name of the frame, or @code{None} if it can't be | |
22879 | obtained. | |
22880 | @end defmethod | |
22881 | ||
22882 | @defmethod Frame type | |
ccfc3d6e TT |
22883 | Returns the type of the frame. The value can be one of: |
22884 | @table @code | |
22885 | @item gdb.NORMAL_FRAME | |
22886 | An ordinary stack frame. | |
22887 | ||
22888 | @item gdb.DUMMY_FRAME | |
22889 | A fake stack frame that was created by @value{GDBN} when performing an | |
22890 | inferior function call. | |
22891 | ||
22892 | @item gdb.INLINE_FRAME | |
22893 | A frame representing an inlined function. The function was inlined | |
22894 | into a @code{gdb.NORMAL_FRAME} that is older than this one. | |
22895 | ||
22896 | @item gdb.SIGTRAMP_FRAME | |
22897 | A signal trampoline frame. This is the frame created by the OS when | |
22898 | it calls into a signal handler. | |
22899 | ||
22900 | @item gdb.ARCH_FRAME | |
22901 | A fake stack frame representing a cross-architecture call. | |
22902 | ||
22903 | @item gdb.SENTINEL_FRAME | |
22904 | This is like @code{gdb.NORMAL_FRAME}, but it is only used for the | |
22905 | newest frame. | |
22906 | @end table | |
f8f6f20b TJB |
22907 | @end defmethod |
22908 | ||
22909 | @defmethod Frame unwind_stop_reason | |
22910 | Return an integer representing the reason why it's not possible to find | |
22911 | more frames toward the outermost frame. Use | |
22912 | @code{gdb.frame_stop_reason_string} to convert the value returned by this | |
22913 | function to a string. | |
22914 | @end defmethod | |
22915 | ||
22916 | @defmethod Frame pc | |
22917 | Returns the frame's resume address. | |
22918 | @end defmethod | |
22919 | ||
f3e9a817 PM |
22920 | @defmethod Frame block |
22921 | Return the frame's code block. @xref{Blocks In Python}. | |
22922 | @end defmethod | |
22923 | ||
22924 | @defmethod Frame function | |
22925 | Return the symbol for the function corresponding to this frame. | |
22926 | @xref{Symbols In Python}. | |
22927 | @end defmethod | |
22928 | ||
f8f6f20b TJB |
22929 | @defmethod Frame older |
22930 | Return the frame that called this frame. | |
22931 | @end defmethod | |
22932 | ||
22933 | @defmethod Frame newer | |
22934 | Return the frame called by this frame. | |
22935 | @end defmethod | |
22936 | ||
f3e9a817 PM |
22937 | @defmethod Frame find_sal |
22938 | Return the frame's symtab and line object. | |
22939 | @xref{Symbol Tables In Python}. | |
22940 | @end defmethod | |
22941 | ||
dc00d89f PM |
22942 | @defmethod Frame read_var variable @r{[}block@r{]} |
22943 | Return the value of @var{variable} in this frame. If the optional | |
22944 | argument @var{block} is provided, search for the variable from that | |
22945 | block; otherwise start at the frame's current block (which is | |
22946 | determined by the frame's current program counter). @var{variable} | |
22947 | must be a string or a @code{gdb.Symbol} object. @var{block} must be a | |
22948 | @code{gdb.Block} object. | |
f8f6f20b | 22949 | @end defmethod |
f3e9a817 PM |
22950 | |
22951 | @defmethod Frame select | |
22952 | Set this frame to be the selected frame. @xref{Stack, ,Examining the | |
22953 | Stack}. | |
22954 | @end defmethod | |
22955 | @end table | |
22956 | ||
22957 | @node Blocks In Python | |
22958 | @subsubsection Accessing frame blocks from Python. | |
22959 | ||
22960 | @cindex blocks in python | |
22961 | @tindex gdb.Block | |
22962 | ||
22963 | Within each frame, @value{GDBN} maintains information on each block | |
22964 | stored in that frame. These blocks are organized hierarchically, and | |
22965 | are represented individually in Python as a @code{gdb.Block}. | |
22966 | Please see @ref{Frames In Python}, for a more in-depth discussion on | |
22967 | frames. Furthermore, see @ref{Stack, ,Examining the Stack}, for more | |
22968 | detailed technical information on @value{GDBN}'s book-keeping of the | |
22969 | stack. | |
22970 | ||
22971 | The following block-related functions are available in the @code{gdb} | |
22972 | module: | |
22973 | ||
22974 | @findex gdb.block_for_pc | |
22975 | @defun block_for_pc pc | |
22976 | Return the @code{gdb.Block} containing the given @var{pc} value. If the | |
22977 | block cannot be found for the @var{pc} value specified, the function | |
22978 | will return @code{None}. | |
22979 | @end defun | |
22980 | ||
29703da4 PM |
22981 | A @code{gdb.Block} object has the following methods: |
22982 | ||
22983 | @table @code | |
22984 | @defmethod Block is_valid | |
22985 | Returns @code{True} if the @code{gdb.Block} object is valid, | |
22986 | @code{False} if not. A block object can become invalid if the block it | |
22987 | refers to doesn't exist anymore in the inferior. All other | |
22988 | @code{gdb.Block} methods will throw an exception if it is invalid at | |
22989 | the time the method is called. This method is also made available to | |
22990 | the Python iterator object that @code{gdb.Block} provides in an iteration | |
22991 | context and via the Python @code{iter} built-in function. | |
22992 | @end defmethod | |
22993 | @end table | |
22994 | ||
f3e9a817 PM |
22995 | A @code{gdb.Block} object has the following attributes: |
22996 | ||
22997 | @table @code | |
22998 | @defivar Block start | |
22999 | The start address of the block. This attribute is not writable. | |
23000 | @end defivar | |
23001 | ||
23002 | @defivar Block end | |
23003 | The end address of the block. This attribute is not writable. | |
23004 | @end defivar | |
23005 | ||
23006 | @defivar Block function | |
23007 | The name of the block represented as a @code{gdb.Symbol}. If the | |
23008 | block is not named, then this attribute holds @code{None}. This | |
23009 | attribute is not writable. | |
23010 | @end defivar | |
23011 | ||
23012 | @defivar Block superblock | |
23013 | The block containing this block. If this parent block does not exist, | |
23014 | this attribute holds @code{None}. This attribute is not writable. | |
23015 | @end defivar | |
23016 | @end table | |
23017 | ||
23018 | @node Symbols In Python | |
23019 | @subsubsection Python representation of Symbols. | |
23020 | ||
23021 | @cindex symbols in python | |
23022 | @tindex gdb.Symbol | |
23023 | ||
23024 | @value{GDBN} represents every variable, function and type as an | |
23025 | entry in a symbol table. @xref{Symbols, ,Examining the Symbol Table}. | |
23026 | Similarly, Python represents these symbols in @value{GDBN} with the | |
23027 | @code{gdb.Symbol} object. | |
23028 | ||
23029 | The following symbol-related functions are available in the @code{gdb} | |
23030 | module: | |
23031 | ||
23032 | @findex gdb.lookup_symbol | |
6e6fbe60 | 23033 | @defun lookup_symbol name @r{[}block@r{]} @r{[}domain@r{]} |
f3e9a817 PM |
23034 | This function searches for a symbol by name. The search scope can be |
23035 | restricted to the parameters defined in the optional domain and block | |
23036 | arguments. | |
23037 | ||
23038 | @var{name} is the name of the symbol. It must be a string. The | |
23039 | optional @var{block} argument restricts the search to symbols visible | |
23040 | in that @var{block}. The @var{block} argument must be a | |
6e6fbe60 DE |
23041 | @code{gdb.Block} object. If omitted, the block for the current frame |
23042 | is used. The optional @var{domain} argument restricts | |
f3e9a817 PM |
23043 | the search to the domain type. The @var{domain} argument must be a |
23044 | domain constant defined in the @code{gdb} module and described later | |
23045 | in this chapter. | |
6e6fbe60 DE |
23046 | |
23047 | The result is a tuple of two elements. | |
23048 | The first element is a @code{gdb.Symbol} object or @code{None} if the symbol | |
23049 | is not found. | |
23050 | If the symbol is found, the second element is @code{True} if the symbol | |
82809774 | 23051 | is a field of a method's object (e.g., @code{this} in C@t{++}), |
6e6fbe60 DE |
23052 | otherwise it is @code{False}. |
23053 | If the symbol is not found, the second element is @code{False}. | |
23054 | @end defun | |
23055 | ||
23056 | @findex gdb.lookup_global_symbol | |
23057 | @defun lookup_global_symbol name @r{[}domain@r{]} | |
23058 | This function searches for a global symbol by name. | |
23059 | The search scope can be restricted to by the domain argument. | |
23060 | ||
23061 | @var{name} is the name of the symbol. It must be a string. | |
23062 | The optional @var{domain} argument restricts the search to the domain type. | |
23063 | The @var{domain} argument must be a domain constant defined in the @code{gdb} | |
23064 | module and described later in this chapter. | |
23065 | ||
23066 | The result is a @code{gdb.Symbol} object or @code{None} if the symbol | |
23067 | is not found. | |
f3e9a817 PM |
23068 | @end defun |
23069 | ||
23070 | A @code{gdb.Symbol} object has the following attributes: | |
23071 | ||
23072 | @table @code | |
23073 | @defivar Symbol symtab | |
23074 | The symbol table in which the symbol appears. This attribute is | |
23075 | represented as a @code{gdb.Symtab} object. @xref{Symbol Tables In | |
23076 | Python}. This attribute is not writable. | |
23077 | @end defivar | |
23078 | ||
23079 | @defivar Symbol name | |
23080 | The name of the symbol as a string. This attribute is not writable. | |
23081 | @end defivar | |
23082 | ||
23083 | @defivar Symbol linkage_name | |
23084 | The name of the symbol, as used by the linker (i.e., may be mangled). | |
23085 | This attribute is not writable. | |
23086 | @end defivar | |
23087 | ||
23088 | @defivar Symbol print_name | |
23089 | The name of the symbol in a form suitable for output. This is either | |
23090 | @code{name} or @code{linkage_name}, depending on whether the user | |
23091 | asked @value{GDBN} to display demangled or mangled names. | |
23092 | @end defivar | |
23093 | ||
23094 | @defivar Symbol addr_class | |
23095 | The address class of the symbol. This classifies how to find the value | |
23096 | of a symbol. Each address class is a constant defined in the | |
23097 | @code{gdb} module and described later in this chapter. | |
23098 | @end defivar | |
23099 | ||
23100 | @defivar Symbol is_argument | |
23101 | @code{True} if the symbol is an argument of a function. | |
23102 | @end defivar | |
23103 | ||
23104 | @defivar Symbol is_constant | |
23105 | @code{True} if the symbol is a constant. | |
23106 | @end defivar | |
23107 | ||
23108 | @defivar Symbol is_function | |
23109 | @code{True} if the symbol is a function or a method. | |
23110 | @end defivar | |
23111 | ||
23112 | @defivar Symbol is_variable | |
23113 | @code{True} if the symbol is a variable. | |
23114 | @end defivar | |
23115 | @end table | |
23116 | ||
29703da4 PM |
23117 | A @code{gdb.Symbol} object has the following methods: |
23118 | ||
23119 | @table @code | |
23120 | @defmethod Symbol is_valid | |
23121 | Returns @code{True} if the @code{gdb.Symbol} object is valid, | |
23122 | @code{False} if not. A @code{gdb.Symbol} object can become invalid if | |
23123 | the symbol it refers to does not exist in @value{GDBN} any longer. | |
23124 | All other @code{gdb.Symbol} methods will throw an exception if it is | |
23125 | invalid at the time the method is called. | |
23126 | @end defmethod | |
23127 | @end table | |
23128 | ||
f3e9a817 PM |
23129 | The available domain categories in @code{gdb.Symbol} are represented |
23130 | as constants in the @code{gdb} module: | |
23131 | ||
23132 | @table @code | |
23133 | @findex SYMBOL_UNDEF_DOMAIN | |
23134 | @findex gdb.SYMBOL_UNDEF_DOMAIN | |
23135 | @item SYMBOL_UNDEF_DOMAIN | |
23136 | This is used when a domain has not been discovered or none of the | |
23137 | following domains apply. This usually indicates an error either | |
23138 | in the symbol information or in @value{GDBN}'s handling of symbols. | |
23139 | @findex SYMBOL_VAR_DOMAIN | |
23140 | @findex gdb.SYMBOL_VAR_DOMAIN | |
23141 | @item SYMBOL_VAR_DOMAIN | |
23142 | This domain contains variables, function names, typedef names and enum | |
23143 | type values. | |
23144 | @findex SYMBOL_STRUCT_DOMAIN | |
23145 | @findex gdb.SYMBOL_STRUCT_DOMAIN | |
23146 | @item SYMBOL_STRUCT_DOMAIN | |
23147 | This domain holds struct, union and enum type names. | |
23148 | @findex SYMBOL_LABEL_DOMAIN | |
23149 | @findex gdb.SYMBOL_LABEL_DOMAIN | |
23150 | @item SYMBOL_LABEL_DOMAIN | |
23151 | This domain contains names of labels (for gotos). | |
23152 | @findex SYMBOL_VARIABLES_DOMAIN | |
23153 | @findex gdb.SYMBOL_VARIABLES_DOMAIN | |
23154 | @item SYMBOL_VARIABLES_DOMAIN | |
23155 | This domain holds a subset of the @code{SYMBOLS_VAR_DOMAIN}; it | |
23156 | contains everything minus functions and types. | |
23157 | @findex SYMBOL_FUNCTIONS_DOMAIN | |
23158 | @findex gdb.SYMBOL_FUNCTIONS_DOMAIN | |
23159 | @item SYMBOL_FUNCTION_DOMAIN | |
23160 | This domain contains all functions. | |
23161 | @findex SYMBOL_TYPES_DOMAIN | |
23162 | @findex gdb.SYMBOL_TYPES_DOMAIN | |
23163 | @item SYMBOL_TYPES_DOMAIN | |
23164 | This domain contains all types. | |
23165 | @end table | |
23166 | ||
23167 | The available address class categories in @code{gdb.Symbol} are represented | |
23168 | as constants in the @code{gdb} module: | |
23169 | ||
23170 | @table @code | |
23171 | @findex SYMBOL_LOC_UNDEF | |
23172 | @findex gdb.SYMBOL_LOC_UNDEF | |
23173 | @item SYMBOL_LOC_UNDEF | |
23174 | If this is returned by address class, it indicates an error either in | |
23175 | the symbol information or in @value{GDBN}'s handling of symbols. | |
23176 | @findex SYMBOL_LOC_CONST | |
23177 | @findex gdb.SYMBOL_LOC_CONST | |
23178 | @item SYMBOL_LOC_CONST | |
23179 | Value is constant int. | |
23180 | @findex SYMBOL_LOC_STATIC | |
23181 | @findex gdb.SYMBOL_LOC_STATIC | |
23182 | @item SYMBOL_LOC_STATIC | |
23183 | Value is at a fixed address. | |
23184 | @findex SYMBOL_LOC_REGISTER | |
23185 | @findex gdb.SYMBOL_LOC_REGISTER | |
23186 | @item SYMBOL_LOC_REGISTER | |
23187 | Value is in a register. | |
23188 | @findex SYMBOL_LOC_ARG | |
23189 | @findex gdb.SYMBOL_LOC_ARG | |
23190 | @item SYMBOL_LOC_ARG | |
23191 | Value is an argument. This value is at the offset stored within the | |
23192 | symbol inside the frame's argument list. | |
23193 | @findex SYMBOL_LOC_REF_ARG | |
23194 | @findex gdb.SYMBOL_LOC_REF_ARG | |
23195 | @item SYMBOL_LOC_REF_ARG | |
23196 | Value address is stored in the frame's argument list. Just like | |
23197 | @code{LOC_ARG} except that the value's address is stored at the | |
23198 | offset, not the value itself. | |
23199 | @findex SYMBOL_LOC_REGPARM_ADDR | |
23200 | @findex gdb.SYMBOL_LOC_REGPARM_ADDR | |
23201 | @item SYMBOL_LOC_REGPARM_ADDR | |
23202 | Value is a specified register. Just like @code{LOC_REGISTER} except | |
23203 | the register holds the address of the argument instead of the argument | |
23204 | itself. | |
23205 | @findex SYMBOL_LOC_LOCAL | |
23206 | @findex gdb.SYMBOL_LOC_LOCAL | |
23207 | @item SYMBOL_LOC_LOCAL | |
23208 | Value is a local variable. | |
23209 | @findex SYMBOL_LOC_TYPEDEF | |
23210 | @findex gdb.SYMBOL_LOC_TYPEDEF | |
23211 | @item SYMBOL_LOC_TYPEDEF | |
23212 | Value not used. Symbols in the domain @code{SYMBOL_STRUCT_DOMAIN} all | |
23213 | have this class. | |
23214 | @findex SYMBOL_LOC_BLOCK | |
23215 | @findex gdb.SYMBOL_LOC_BLOCK | |
23216 | @item SYMBOL_LOC_BLOCK | |
23217 | Value is a block. | |
23218 | @findex SYMBOL_LOC_CONST_BYTES | |
23219 | @findex gdb.SYMBOL_LOC_CONST_BYTES | |
23220 | @item SYMBOL_LOC_CONST_BYTES | |
23221 | Value is a byte-sequence. | |
23222 | @findex SYMBOL_LOC_UNRESOLVED | |
23223 | @findex gdb.SYMBOL_LOC_UNRESOLVED | |
23224 | @item SYMBOL_LOC_UNRESOLVED | |
23225 | Value is at a fixed address, but the address of the variable has to be | |
23226 | determined from the minimal symbol table whenever the variable is | |
23227 | referenced. | |
23228 | @findex SYMBOL_LOC_OPTIMIZED_OUT | |
23229 | @findex gdb.SYMBOL_LOC_OPTIMIZED_OUT | |
23230 | @item SYMBOL_LOC_OPTIMIZED_OUT | |
23231 | The value does not actually exist in the program. | |
23232 | @findex SYMBOL_LOC_COMPUTED | |
23233 | @findex gdb.SYMBOL_LOC_COMPUTED | |
23234 | @item SYMBOL_LOC_COMPUTED | |
23235 | The value's address is a computed location. | |
23236 | @end table | |
23237 | ||
23238 | @node Symbol Tables In Python | |
23239 | @subsubsection Symbol table representation in Python. | |
23240 | ||
23241 | @cindex symbol tables in python | |
23242 | @tindex gdb.Symtab | |
23243 | @tindex gdb.Symtab_and_line | |
23244 | ||
23245 | Access to symbol table data maintained by @value{GDBN} on the inferior | |
23246 | is exposed to Python via two objects: @code{gdb.Symtab_and_line} and | |
23247 | @code{gdb.Symtab}. Symbol table and line data for a frame is returned | |
23248 | from the @code{find_sal} method in @code{gdb.Frame} object. | |
23249 | @xref{Frames In Python}. | |
23250 | ||
23251 | For more information on @value{GDBN}'s symbol table management, see | |
23252 | @ref{Symbols, ,Examining the Symbol Table}, for more information. | |
23253 | ||
23254 | A @code{gdb.Symtab_and_line} object has the following attributes: | |
23255 | ||
23256 | @table @code | |
23257 | @defivar Symtab_and_line symtab | |
23258 | The symbol table object (@code{gdb.Symtab}) for this frame. | |
23259 | This attribute is not writable. | |
23260 | @end defivar | |
23261 | ||
23262 | @defivar Symtab_and_line pc | |
23263 | Indicates the current program counter address. This attribute is not | |
23264 | writable. | |
23265 | @end defivar | |
23266 | ||
23267 | @defivar Symtab_and_line line | |
23268 | Indicates the current line number for this object. This | |
23269 | attribute is not writable. | |
23270 | @end defivar | |
23271 | @end table | |
23272 | ||
29703da4 PM |
23273 | A @code{gdb.Symtab_and_line} object has the following methods: |
23274 | ||
23275 | @table @code | |
23276 | @defmethod Symtab_and_line is_valid | |
23277 | Returns @code{True} if the @code{gdb.Symtab_and_line} object is valid, | |
23278 | @code{False} if not. A @code{gdb.Symtab_and_line} object can become | |
23279 | invalid if the Symbol table and line object it refers to does not | |
23280 | exist in @value{GDBN} any longer. All other | |
23281 | @code{gdb.Symtab_and_line} methods will throw an exception if it is | |
23282 | invalid at the time the method is called. | |
23283 | @end defmethod | |
23284 | @end table | |
23285 | ||
f3e9a817 PM |
23286 | A @code{gdb.Symtab} object has the following attributes: |
23287 | ||
23288 | @table @code | |
23289 | @defivar Symtab filename | |
23290 | The symbol table's source filename. This attribute is not writable. | |
23291 | @end defivar | |
23292 | ||
23293 | @defivar Symtab objfile | |
23294 | The symbol table's backing object file. @xref{Objfiles In Python}. | |
23295 | This attribute is not writable. | |
23296 | @end defivar | |
23297 | @end table | |
23298 | ||
29703da4 | 23299 | A @code{gdb.Symtab} object has the following methods: |
f3e9a817 PM |
23300 | |
23301 | @table @code | |
29703da4 PM |
23302 | @defmethod Symtab is_valid |
23303 | Returns @code{True} if the @code{gdb.Symtab} object is valid, | |
23304 | @code{False} if not. A @code{gdb.Symtab} object can become invalid if | |
23305 | the symbol table it refers to does not exist in @value{GDBN} any | |
23306 | longer. All other @code{gdb.Symtab} methods will throw an exception | |
23307 | if it is invalid at the time the method is called. | |
23308 | @end defmethod | |
23309 | ||
f3e9a817 PM |
23310 | @defmethod Symtab fullname |
23311 | Return the symbol table's source absolute file name. | |
23312 | @end defmethod | |
f8f6f20b TJB |
23313 | @end table |
23314 | ||
adc36818 PM |
23315 | @node Breakpoints In Python |
23316 | @subsubsection Manipulating breakpoints using Python | |
23317 | ||
23318 | @cindex breakpoints in python | |
23319 | @tindex gdb.Breakpoint | |
23320 | ||
23321 | Python code can manipulate breakpoints via the @code{gdb.Breakpoint} | |
23322 | class. | |
23323 | ||
84f4c1fe | 23324 | @defmethod Breakpoint __init__ spec @r{[}type@r{]} @r{[}wp_class@r{]} @r{[}internal@r{]} |
adc36818 PM |
23325 | Create a new breakpoint. @var{spec} is a string naming the |
23326 | location of the breakpoint, or an expression that defines a | |
23327 | watchpoint. The contents can be any location recognized by the | |
23328 | @code{break} command, or in the case of a watchpoint, by the @code{watch} | |
23329 | command. The optional @var{type} denotes the breakpoint to create | |
23330 | from the types defined later in this chapter. This argument can be | |
23331 | either: @code{BP_BREAKPOINT} or @code{BP_WATCHPOINT}. @var{type} | |
84f4c1fe PM |
23332 | defaults to @code{BP_BREAKPOINT}. The optional @var{internal} argument |
23333 | allows the breakpoint to become invisible to the user. The breakpoint | |
23334 | will neither be reported when created, nor will it be listed in the | |
23335 | output from @code{info breakpoints} (but will be listed with the | |
23336 | @code{maint info breakpoints} command). The optional @var{wp_class} | |
adc36818 | 23337 | argument defines the class of watchpoint to create, if @var{type} is |
84f4c1fe PM |
23338 | @code{BP_WATCHPOINT}. If a watchpoint class is not provided, it is |
23339 | assumed to be a @var{WP_WRITE} class. | |
adc36818 PM |
23340 | @end defmethod |
23341 | ||
7371cf6d PM |
23342 | @defop Operation {gdb.Breakpoint} stop (self) |
23343 | The @code{gdb.Breakpoint} class can be sub-classed and, in | |
23344 | particular, you may choose to implement the @code{stop} method. | |
23345 | If this method is defined as a sub-class of @code{gdb.Breakpoint}, | |
23346 | it will be called when the inferior reaches any location of a | |
23347 | breakpoint which instantiates that sub-class. If the method returns | |
23348 | @code{True}, the inferior will be stopped at the location of the | |
23349 | breakpoint, otherwise the inferior will continue. | |
23350 | ||
23351 | If there are multiple breakpoints at the same location with a | |
23352 | @code{stop} method, each one will be called regardless of the | |
23353 | return status of the previous. This ensures that all @code{stop} | |
23354 | methods have a chance to execute at that location. In this scenario | |
23355 | if one of the methods returns @code{True} but the others return | |
23356 | @code{False}, the inferior will still be stopped. | |
23357 | ||
23358 | Example @code{stop} implementation: | |
23359 | ||
23360 | @smallexample | |
23361 | class MyBreakpoint (gdb.Breakpoint): | |
23362 | def stop (self): | |
23363 | inf_val = gdb.parse_and_eval("foo") | |
23364 | if inf_val == 3: | |
23365 | return True | |
23366 | return False | |
23367 | @end smallexample | |
23368 | @end defop | |
23369 | ||
adc36818 PM |
23370 | The available watchpoint types represented by constants are defined in the |
23371 | @code{gdb} module: | |
23372 | ||
23373 | @table @code | |
23374 | @findex WP_READ | |
23375 | @findex gdb.WP_READ | |
23376 | @item WP_READ | |
23377 | Read only watchpoint. | |
23378 | ||
23379 | @findex WP_WRITE | |
23380 | @findex gdb.WP_WRITE | |
23381 | @item WP_WRITE | |
23382 | Write only watchpoint. | |
23383 | ||
23384 | @findex WP_ACCESS | |
23385 | @findex gdb.WP_ACCESS | |
23386 | @item WP_ACCESS | |
23387 | Read/Write watchpoint. | |
23388 | @end table | |
23389 | ||
23390 | @defmethod Breakpoint is_valid | |
23391 | Return @code{True} if this @code{Breakpoint} object is valid, | |
23392 | @code{False} otherwise. A @code{Breakpoint} object can become invalid | |
23393 | if the user deletes the breakpoint. In this case, the object still | |
23394 | exists, but the underlying breakpoint does not. In the cases of | |
23395 | watchpoint scope, the watchpoint remains valid even if execution of the | |
23396 | inferior leaves the scope of that watchpoint. | |
23397 | @end defmethod | |
23398 | ||
94b6973e PM |
23399 | @defmethod Breakpoint delete |
23400 | Permanently deletes the @value{GDBN} breakpoint. This also | |
23401 | invalidates the Python @code{Breakpoint} object. Any further access | |
23402 | to this object's attributes or methods will raise an error. | |
23403 | @end defmethod | |
23404 | ||
adc36818 PM |
23405 | @defivar Breakpoint enabled |
23406 | This attribute is @code{True} if the breakpoint is enabled, and | |
23407 | @code{False} otherwise. This attribute is writable. | |
23408 | @end defivar | |
23409 | ||
23410 | @defivar Breakpoint silent | |
23411 | This attribute is @code{True} if the breakpoint is silent, and | |
23412 | @code{False} otherwise. This attribute is writable. | |
23413 | ||
23414 | Note that a breakpoint can also be silent if it has commands and the | |
23415 | first command is @code{silent}. This is not reported by the | |
23416 | @code{silent} attribute. | |
23417 | @end defivar | |
23418 | ||
23419 | @defivar Breakpoint thread | |
23420 | If the breakpoint is thread-specific, this attribute holds the thread | |
23421 | id. If the breakpoint is not thread-specific, this attribute is | |
23422 | @code{None}. This attribute is writable. | |
23423 | @end defivar | |
23424 | ||
23425 | @defivar Breakpoint task | |
23426 | If the breakpoint is Ada task-specific, this attribute holds the Ada task | |
23427 | id. If the breakpoint is not task-specific (or the underlying | |
23428 | language is not Ada), this attribute is @code{None}. This attribute | |
23429 | is writable. | |
23430 | @end defivar | |
23431 | ||
23432 | @defivar Breakpoint ignore_count | |
23433 | This attribute holds the ignore count for the breakpoint, an integer. | |
23434 | This attribute is writable. | |
23435 | @end defivar | |
23436 | ||
23437 | @defivar Breakpoint number | |
23438 | This attribute holds the breakpoint's number --- the identifier used by | |
23439 | the user to manipulate the breakpoint. This attribute is not writable. | |
23440 | @end defivar | |
23441 | ||
23442 | @defivar Breakpoint type | |
23443 | This attribute holds the breakpoint's type --- the identifier used to | |
23444 | determine the actual breakpoint type or use-case. This attribute is not | |
23445 | writable. | |
23446 | @end defivar | |
23447 | ||
84f4c1fe PM |
23448 | @defivar Breakpoint visible |
23449 | This attribute tells whether the breakpoint is visible to the user | |
23450 | when set, or when the @samp{info breakpoints} command is run. This | |
23451 | attribute is not writable. | |
23452 | @end defivar | |
23453 | ||
adc36818 PM |
23454 | The available types are represented by constants defined in the @code{gdb} |
23455 | module: | |
23456 | ||
23457 | @table @code | |
23458 | @findex BP_BREAKPOINT | |
23459 | @findex gdb.BP_BREAKPOINT | |
23460 | @item BP_BREAKPOINT | |
23461 | Normal code breakpoint. | |
23462 | ||
23463 | @findex BP_WATCHPOINT | |
23464 | @findex gdb.BP_WATCHPOINT | |
23465 | @item BP_WATCHPOINT | |
23466 | Watchpoint breakpoint. | |
23467 | ||
23468 | @findex BP_HARDWARE_WATCHPOINT | |
23469 | @findex gdb.BP_HARDWARE_WATCHPOINT | |
23470 | @item BP_HARDWARE_WATCHPOINT | |
23471 | Hardware assisted watchpoint. | |
23472 | ||
23473 | @findex BP_READ_WATCHPOINT | |
23474 | @findex gdb.BP_READ_WATCHPOINT | |
23475 | @item BP_READ_WATCHPOINT | |
23476 | Hardware assisted read watchpoint. | |
23477 | ||
23478 | @findex BP_ACCESS_WATCHPOINT | |
23479 | @findex gdb.BP_ACCESS_WATCHPOINT | |
23480 | @item BP_ACCESS_WATCHPOINT | |
23481 | Hardware assisted access watchpoint. | |
23482 | @end table | |
23483 | ||
23484 | @defivar Breakpoint hit_count | |
23485 | This attribute holds the hit count for the breakpoint, an integer. | |
23486 | This attribute is writable, but currently it can only be set to zero. | |
23487 | @end defivar | |
23488 | ||
23489 | @defivar Breakpoint location | |
23490 | This attribute holds the location of the breakpoint, as specified by | |
23491 | the user. It is a string. If the breakpoint does not have a location | |
23492 | (that is, it is a watchpoint) the attribute's value is @code{None}. This | |
23493 | attribute is not writable. | |
23494 | @end defivar | |
23495 | ||
23496 | @defivar Breakpoint expression | |
23497 | This attribute holds a breakpoint expression, as specified by | |
23498 | the user. It is a string. If the breakpoint does not have an | |
23499 | expression (the breakpoint is not a watchpoint) the attribute's value | |
23500 | is @code{None}. This attribute is not writable. | |
23501 | @end defivar | |
23502 | ||
23503 | @defivar Breakpoint condition | |
23504 | This attribute holds the condition of the breakpoint, as specified by | |
23505 | the user. It is a string. If there is no condition, this attribute's | |
23506 | value is @code{None}. This attribute is writable. | |
23507 | @end defivar | |
23508 | ||
23509 | @defivar Breakpoint commands | |
23510 | This attribute holds the commands attached to the breakpoint. If | |
23511 | there are commands, this attribute's value is a string holding all the | |
23512 | commands, separated by newlines. If there are no commands, this | |
23513 | attribute is @code{None}. This attribute is not writable. | |
23514 | @end defivar | |
23515 | ||
be759fcf PM |
23516 | @node Lazy Strings In Python |
23517 | @subsubsection Python representation of lazy strings. | |
23518 | ||
23519 | @cindex lazy strings in python | |
23520 | @tindex gdb.LazyString | |
23521 | ||
23522 | A @dfn{lazy string} is a string whose contents is not retrieved or | |
23523 | encoded until it is needed. | |
23524 | ||
23525 | A @code{gdb.LazyString} is represented in @value{GDBN} as an | |
23526 | @code{address} that points to a region of memory, an @code{encoding} | |
23527 | that will be used to encode that region of memory, and a @code{length} | |
23528 | to delimit the region of memory that represents the string. The | |
23529 | difference between a @code{gdb.LazyString} and a string wrapped within | |
23530 | a @code{gdb.Value} is that a @code{gdb.LazyString} will be treated | |
23531 | differently by @value{GDBN} when printing. A @code{gdb.LazyString} is | |
23532 | retrieved and encoded during printing, while a @code{gdb.Value} | |
23533 | wrapping a string is immediately retrieved and encoded on creation. | |
23534 | ||
23535 | A @code{gdb.LazyString} object has the following functions: | |
23536 | ||
23537 | @defmethod LazyString value | |
23538 | Convert the @code{gdb.LazyString} to a @code{gdb.Value}. This value | |
23539 | will point to the string in memory, but will lose all the delayed | |
23540 | retrieval, encoding and handling that @value{GDBN} applies to a | |
23541 | @code{gdb.LazyString}. | |
23542 | @end defmethod | |
23543 | ||
23544 | @defivar LazyString address | |
23545 | This attribute holds the address of the string. This attribute is not | |
23546 | writable. | |
23547 | @end defivar | |
23548 | ||
23549 | @defivar LazyString length | |
23550 | This attribute holds the length of the string in characters. If the | |
23551 | length is -1, then the string will be fetched and encoded up to the | |
23552 | first null of appropriate width. This attribute is not writable. | |
23553 | @end defivar | |
23554 | ||
23555 | @defivar LazyString encoding | |
23556 | This attribute holds the encoding that will be applied to the string | |
23557 | when the string is printed by @value{GDBN}. If the encoding is not | |
23558 | set, or contains an empty string, then @value{GDBN} will select the | |
23559 | most appropriate encoding when the string is printed. This attribute | |
23560 | is not writable. | |
23561 | @end defivar | |
23562 | ||
23563 | @defivar LazyString type | |
23564 | This attribute holds the type that is represented by the lazy string's | |
23565 | type. For a lazy string this will always be a pointer type. To | |
23566 | resolve this to the lazy string's character type, use the type's | |
23567 | @code{target} method. @xref{Types In Python}. This attribute is not | |
23568 | writable. | |
23569 | @end defivar | |
23570 | ||
8a1ea21f DE |
23571 | @node Auto-loading |
23572 | @subsection Auto-loading | |
23573 | @cindex auto-loading, Python | |
23574 | ||
23575 | When a new object file is read (for example, due to the @code{file} | |
23576 | command, or because the inferior has loaded a shared library), | |
23577 | @value{GDBN} will look for Python support scripts in several ways: | |
23578 | @file{@var{objfile}-gdb.py} and @code{.debug_gdb_scripts} section. | |
23579 | ||
23580 | @menu | |
23581 | * objfile-gdb.py file:: The @file{@var{objfile}-gdb.py} file | |
23582 | * .debug_gdb_scripts section:: The @code{.debug_gdb_scripts} section | |
23583 | * Which flavor to choose?:: | |
23584 | @end menu | |
23585 | ||
23586 | The auto-loading feature is useful for supplying application-specific | |
23587 | debugging commands and scripts. | |
23588 | ||
dbaefcf7 DE |
23589 | Auto-loading can be enabled or disabled, |
23590 | and the list of auto-loaded scripts can be printed. | |
8a1ea21f DE |
23591 | |
23592 | @table @code | |
a86caf66 DE |
23593 | @kindex set auto-load-scripts |
23594 | @item set auto-load-scripts [yes|no] | |
23595 | Enable or disable the auto-loading of Python scripts. | |
8a1ea21f | 23596 | |
a86caf66 DE |
23597 | @kindex show auto-load-scripts |
23598 | @item show auto-load-scripts | |
23599 | Show whether auto-loading of Python scripts is enabled or disabled. | |
dbaefcf7 DE |
23600 | |
23601 | @kindex info auto-load-scripts | |
23602 | @cindex print list of auto-loaded scripts | |
23603 | @item info auto-load-scripts [@var{regexp}] | |
23604 | Print the list of all scripts that gdb auto-loaded, or tried to auto-load. | |
23605 | If @var{regexp} is supplied only scripts with matching names are printed. | |
23606 | ||
23607 | @smallexample | |
23608 | (gdb) info auto-load-scripts | |
23609 | Loaded Script | |
23610 | Yes py-section-script.py | |
23611 | full name: /tmp/py-section-script.py | |
23612 | @end smallexample | |
8a1ea21f DE |
23613 | @end table |
23614 | ||
23615 | When reading an auto-loaded file, @value{GDBN} sets the | |
23616 | @dfn{current objfile}. This is available via the @code{gdb.current_objfile} | |
23617 | function (@pxref{Objfiles In Python}). This can be useful for | |
23618 | registering objfile-specific pretty-printers. | |
23619 | ||
23620 | @node objfile-gdb.py file | |
23621 | @subsubsection The @file{@var{objfile}-gdb.py} file | |
23622 | @cindex @file{@var{objfile}-gdb.py} | |
23623 | ||
23624 | When a new object file is read, @value{GDBN} looks for | |
23625 | a file named @file{@var{objfile}-gdb.py}, | |
23626 | where @var{objfile} is the object file's real name, formed by ensuring | |
23627 | that the file name is absolute, following all symlinks, and resolving | |
23628 | @code{.} and @code{..} components. If this file exists and is | |
23629 | readable, @value{GDBN} will evaluate it as a Python script. | |
23630 | ||
23631 | If this file does not exist, and if the parameter | |
23632 | @code{debug-file-directory} is set (@pxref{Separate Debug Files}), | |
23633 | then @value{GDBN} will look for @var{real-name} in all of the | |
23634 | directories mentioned in the value of @code{debug-file-directory}. | |
23635 | ||
23636 | Finally, if this file does not exist, then @value{GDBN} will look for | |
23637 | a file named @file{@var{data-directory}/python/auto-load/@var{real-name}}, where | |
23638 | @var{data-directory} is @value{GDBN}'s data directory (available via | |
23639 | @code{show data-directory}, @pxref{Data Files}), and @var{real-name} | |
23640 | is the object file's real name, as described above. | |
23641 | ||
23642 | @value{GDBN} does not track which files it has already auto-loaded this way. | |
23643 | @value{GDBN} will load the associated script every time the corresponding | |
23644 | @var{objfile} is opened. | |
23645 | So your @file{-gdb.py} file should be careful to avoid errors if it | |
23646 | is evaluated more than once. | |
23647 | ||
23648 | @node .debug_gdb_scripts section | |
23649 | @subsubsection The @code{.debug_gdb_scripts} section | |
23650 | @cindex @code{.debug_gdb_scripts} section | |
23651 | ||
23652 | For systems using file formats like ELF and COFF, | |
23653 | when @value{GDBN} loads a new object file | |
23654 | it will look for a special section named @samp{.debug_gdb_scripts}. | |
23655 | If this section exists, its contents is a list of names of scripts to load. | |
23656 | ||
23657 | @value{GDBN} will look for each specified script file first in the | |
23658 | current directory and then along the source search path | |
23659 | (@pxref{Source Path, ,Specifying Source Directories}), | |
23660 | except that @file{$cdir} is not searched, since the compilation | |
23661 | directory is not relevant to scripts. | |
23662 | ||
23663 | Entries can be placed in section @code{.debug_gdb_scripts} with, | |
23664 | for example, this GCC macro: | |
23665 | ||
23666 | @example | |
a3a7127e | 23667 | /* Note: The "MS" section flags are to remove duplicates. */ |
8a1ea21f DE |
23668 | #define DEFINE_GDB_SCRIPT(script_name) \ |
23669 | asm("\ | |
23670 | .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\ | |
23671 | .byte 1\n\ | |
23672 | .asciz \"" script_name "\"\n\ | |
23673 | .popsection \n\ | |
23674 | "); | |
23675 | @end example | |
23676 | ||
23677 | @noindent | |
23678 | Then one can reference the macro in a header or source file like this: | |
23679 | ||
23680 | @example | |
23681 | DEFINE_GDB_SCRIPT ("my-app-scripts.py") | |
23682 | @end example | |
23683 | ||
23684 | The script name may include directories if desired. | |
23685 | ||
23686 | If the macro is put in a header, any application or library | |
23687 | using this header will get a reference to the specified script. | |
23688 | ||
23689 | @node Which flavor to choose? | |
23690 | @subsubsection Which flavor to choose? | |
23691 | ||
23692 | Given the multiple ways of auto-loading Python scripts, it might not always | |
23693 | be clear which one to choose. This section provides some guidance. | |
23694 | ||
23695 | Benefits of the @file{-gdb.py} way: | |
23696 | ||
23697 | @itemize @bullet | |
23698 | @item | |
23699 | Can be used with file formats that don't support multiple sections. | |
23700 | ||
23701 | @item | |
23702 | Ease of finding scripts for public libraries. | |
23703 | ||
23704 | Scripts specified in the @code{.debug_gdb_scripts} section are searched for | |
23705 | in the source search path. | |
23706 | For publicly installed libraries, e.g., @file{libstdc++}, there typically | |
23707 | isn't a source directory in which to find the script. | |
23708 | ||
23709 | @item | |
23710 | Doesn't require source code additions. | |
23711 | @end itemize | |
23712 | ||
23713 | Benefits of the @code{.debug_gdb_scripts} way: | |
23714 | ||
23715 | @itemize @bullet | |
23716 | @item | |
23717 | Works with static linking. | |
23718 | ||
23719 | Scripts for libraries done the @file{-gdb.py} way require an objfile to | |
23720 | trigger their loading. When an application is statically linked the only | |
23721 | objfile available is the executable, and it is cumbersome to attach all the | |
23722 | scripts from all the input libraries to the executable's @file{-gdb.py} script. | |
23723 | ||
23724 | @item | |
23725 | Works with classes that are entirely inlined. | |
23726 | ||
23727 | Some classes can be entirely inlined, and thus there may not be an associated | |
23728 | shared library to attach a @file{-gdb.py} script to. | |
23729 | ||
23730 | @item | |
23731 | Scripts needn't be copied out of the source tree. | |
23732 | ||
23733 | In some circumstances, apps can be built out of large collections of internal | |
23734 | libraries, and the build infrastructure necessary to install the | |
23735 | @file{-gdb.py} scripts in a place where @value{GDBN} can find them is | |
23736 | cumbersome. It may be easier to specify the scripts in the | |
23737 | @code{.debug_gdb_scripts} section as relative paths, and add a path to the | |
23738 | top of the source tree to the source search path. | |
23739 | @end itemize | |
23740 | ||
0e3509db DE |
23741 | @node Python modules |
23742 | @subsection Python modules | |
23743 | @cindex python modules | |
23744 | ||
0e3509db DE |
23745 | @value{GDBN} comes with a module to assist writing Python code. |
23746 | ||
23747 | @menu | |
7b51bc51 | 23748 | * gdb.printing:: Building and registering pretty-printers. |
0e3509db DE |
23749 | * gdb.types:: Utilities for working with types. |
23750 | @end menu | |
23751 | ||
7b51bc51 DE |
23752 | @node gdb.printing |
23753 | @subsubsection gdb.printing | |
23754 | @cindex gdb.printing | |
23755 | ||
23756 | This module provides a collection of utilities for working with | |
23757 | pretty-printers. | |
23758 | ||
23759 | @table @code | |
23760 | @item PrettyPrinter (@var{name}, @var{subprinters}=None) | |
23761 | This class specifies the API that makes @samp{info pretty-printer}, | |
23762 | @samp{enable pretty-printer} and @samp{disable pretty-printer} work. | |
23763 | Pretty-printers should generally inherit from this class. | |
23764 | ||
23765 | @item SubPrettyPrinter (@var{name}) | |
23766 | For printers that handle multiple types, this class specifies the | |
23767 | corresponding API for the subprinters. | |
23768 | ||
23769 | @item RegexpCollectionPrettyPrinter (@var{name}) | |
23770 | Utility class for handling multiple printers, all recognized via | |
23771 | regular expressions. | |
23772 | @xref{Writing a Pretty-Printer}, for an example. | |
23773 | ||
23774 | @item register_pretty_printer (@var{obj}, @var{printer}) | |
23775 | Register @var{printer} with the pretty-printer list of @var{obj}. | |
23776 | @end table | |
23777 | ||
0e3509db DE |
23778 | @node gdb.types |
23779 | @subsubsection gdb.types | |
7b51bc51 | 23780 | @cindex gdb.types |
0e3509db DE |
23781 | |
23782 | This module provides a collection of utilities for working with | |
23783 | @code{gdb.Types} objects. | |
23784 | ||
23785 | @table @code | |
23786 | @item get_basic_type (@var{type}) | |
23787 | Return @var{type} with const and volatile qualifiers stripped, | |
23788 | and with typedefs and C@t{++} references converted to the underlying type. | |
23789 | ||
23790 | C@t{++} example: | |
23791 | ||
23792 | @smallexample | |
23793 | typedef const int const_int; | |
23794 | const_int foo (3); | |
23795 | const_int& foo_ref (foo); | |
23796 | int main () @{ return 0; @} | |
23797 | @end smallexample | |
23798 | ||
23799 | Then in gdb: | |
23800 | ||
23801 | @smallexample | |
23802 | (gdb) start | |
23803 | (gdb) python import gdb.types | |
23804 | (gdb) python foo_ref = gdb.parse_and_eval("foo_ref") | |
23805 | (gdb) python print gdb.types.get_basic_type(foo_ref.type) | |
23806 | int | |
23807 | @end smallexample | |
23808 | ||
23809 | @item has_field (@var{type}, @var{field}) | |
23810 | Return @code{True} if @var{type}, assumed to be a type with fields | |
23811 | (e.g., a structure or union), has field @var{field}. | |
23812 | ||
23813 | @item make_enum_dict (@var{enum_type}) | |
23814 | Return a Python @code{dictionary} type produced from @var{enum_type}. | |
23815 | @end table | |
23816 | ||
21c294e6 AC |
23817 | @node Interpreters |
23818 | @chapter Command Interpreters | |
23819 | @cindex command interpreters | |
23820 | ||
23821 | @value{GDBN} supports multiple command interpreters, and some command | |
23822 | infrastructure to allow users or user interface writers to switch | |
23823 | between interpreters or run commands in other interpreters. | |
23824 | ||
23825 | @value{GDBN} currently supports two command interpreters, the console | |
23826 | interpreter (sometimes called the command-line interpreter or @sc{cli}) | |
23827 | and the machine interface interpreter (or @sc{gdb/mi}). This manual | |
23828 | describes both of these interfaces in great detail. | |
23829 | ||
23830 | By default, @value{GDBN} will start with the console interpreter. | |
23831 | However, the user may choose to start @value{GDBN} with another | |
23832 | interpreter by specifying the @option{-i} or @option{--interpreter} | |
23833 | startup options. Defined interpreters include: | |
23834 | ||
23835 | @table @code | |
23836 | @item console | |
23837 | @cindex console interpreter | |
23838 | The traditional console or command-line interpreter. This is the most often | |
23839 | used interpreter with @value{GDBN}. With no interpreter specified at runtime, | |
23840 | @value{GDBN} will use this interpreter. | |
23841 | ||
23842 | @item mi | |
23843 | @cindex mi interpreter | |
23844 | The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily | |
23845 | by programs wishing to use @value{GDBN} as a backend for a debugger GUI | |
23846 | or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi} | |
23847 | Interface}. | |
23848 | ||
23849 | @item mi2 | |
23850 | @cindex mi2 interpreter | |
23851 | The current @sc{gdb/mi} interface. | |
23852 | ||
23853 | @item mi1 | |
23854 | @cindex mi1 interpreter | |
23855 | The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3. | |
23856 | ||
23857 | @end table | |
23858 | ||
23859 | @cindex invoke another interpreter | |
23860 | The interpreter being used by @value{GDBN} may not be dynamically | |
23861 | switched at runtime. Although possible, this could lead to a very | |
23862 | precarious situation. Consider an IDE using @sc{gdb/mi}. If a user | |
23863 | enters the command "interpreter-set console" in a console view, | |
23864 | @value{GDBN} would switch to using the console interpreter, rendering | |
23865 | the IDE inoperable! | |
23866 | ||
23867 | @kindex interpreter-exec | |
23868 | Although you may only choose a single interpreter at startup, you may execute | |
23869 | commands in any interpreter from the current interpreter using the appropriate | |
23870 | command. If you are running the console interpreter, simply use the | |
23871 | @code{interpreter-exec} command: | |
23872 | ||
23873 | @smallexample | |
23874 | interpreter-exec mi "-data-list-register-names" | |
23875 | @end smallexample | |
23876 | ||
23877 | @sc{gdb/mi} has a similar command, although it is only available in versions of | |
23878 | @value{GDBN} which support @sc{gdb/mi} version 2 (or greater). | |
23879 | ||
8e04817f AC |
23880 | @node TUI |
23881 | @chapter @value{GDBN} Text User Interface | |
23882 | @cindex TUI | |
d0d5df6f | 23883 | @cindex Text User Interface |
c906108c | 23884 | |
8e04817f AC |
23885 | @menu |
23886 | * TUI Overview:: TUI overview | |
23887 | * TUI Keys:: TUI key bindings | |
7cf36c78 | 23888 | * TUI Single Key Mode:: TUI single key mode |
db2e3e2e | 23889 | * TUI Commands:: TUI-specific commands |
8e04817f AC |
23890 | * TUI Configuration:: TUI configuration variables |
23891 | @end menu | |
c906108c | 23892 | |
46ba6afa | 23893 | The @value{GDBN} Text User Interface (TUI) is a terminal |
d0d5df6f AC |
23894 | interface which uses the @code{curses} library to show the source |
23895 | file, the assembly output, the program registers and @value{GDBN} | |
46ba6afa BW |
23896 | commands in separate text windows. The TUI mode is supported only |
23897 | on platforms where a suitable version of the @code{curses} library | |
23898 | is available. | |
d0d5df6f | 23899 | |
46ba6afa BW |
23900 | @pindex @value{GDBTUI} |
23901 | The TUI mode is enabled by default when you invoke @value{GDBN} as | |
23902 | either @samp{@value{GDBTUI}} or @samp{@value{GDBP} -tui}. | |
23903 | You can also switch in and out of TUI mode while @value{GDBN} runs by | |
23904 | using various TUI commands and key bindings, such as @kbd{C-x C-a}. | |
23905 | @xref{TUI Keys, ,TUI Key Bindings}. | |
c906108c | 23906 | |
8e04817f | 23907 | @node TUI Overview |
79a6e687 | 23908 | @section TUI Overview |
c906108c | 23909 | |
46ba6afa | 23910 | In TUI mode, @value{GDBN} can display several text windows: |
c906108c | 23911 | |
8e04817f AC |
23912 | @table @emph |
23913 | @item command | |
23914 | This window is the @value{GDBN} command window with the @value{GDBN} | |
46ba6afa BW |
23915 | prompt and the @value{GDBN} output. The @value{GDBN} input is still |
23916 | managed using readline. | |
c906108c | 23917 | |
8e04817f AC |
23918 | @item source |
23919 | The source window shows the source file of the program. The current | |
46ba6afa | 23920 | line and active breakpoints are displayed in this window. |
c906108c | 23921 | |
8e04817f AC |
23922 | @item assembly |
23923 | The assembly window shows the disassembly output of the program. | |
c906108c | 23924 | |
8e04817f | 23925 | @item register |
46ba6afa BW |
23926 | This window shows the processor registers. Registers are highlighted |
23927 | when their values change. | |
c906108c SS |
23928 | @end table |
23929 | ||
269c21fe | 23930 | The source and assembly windows show the current program position |
46ba6afa BW |
23931 | by highlighting the current line and marking it with a @samp{>} marker. |
23932 | Breakpoints are indicated with two markers. The first marker | |
269c21fe SC |
23933 | indicates the breakpoint type: |
23934 | ||
23935 | @table @code | |
23936 | @item B | |
23937 | Breakpoint which was hit at least once. | |
23938 | ||
23939 | @item b | |
23940 | Breakpoint which was never hit. | |
23941 | ||
23942 | @item H | |
23943 | Hardware breakpoint which was hit at least once. | |
23944 | ||
23945 | @item h | |
23946 | Hardware breakpoint which was never hit. | |
269c21fe SC |
23947 | @end table |
23948 | ||
23949 | The second marker indicates whether the breakpoint is enabled or not: | |
23950 | ||
23951 | @table @code | |
23952 | @item + | |
23953 | Breakpoint is enabled. | |
23954 | ||
23955 | @item - | |
23956 | Breakpoint is disabled. | |
269c21fe SC |
23957 | @end table |
23958 | ||
46ba6afa BW |
23959 | The source, assembly and register windows are updated when the current |
23960 | thread changes, when the frame changes, or when the program counter | |
23961 | changes. | |
23962 | ||
23963 | These windows are not all visible at the same time. The command | |
23964 | window is always visible. The others can be arranged in several | |
23965 | layouts: | |
c906108c | 23966 | |
8e04817f AC |
23967 | @itemize @bullet |
23968 | @item | |
46ba6afa | 23969 | source only, |
2df3850c | 23970 | |
8e04817f | 23971 | @item |
46ba6afa | 23972 | assembly only, |
8e04817f AC |
23973 | |
23974 | @item | |
46ba6afa | 23975 | source and assembly, |
8e04817f AC |
23976 | |
23977 | @item | |
46ba6afa | 23978 | source and registers, or |
c906108c | 23979 | |
8e04817f | 23980 | @item |
46ba6afa | 23981 | assembly and registers. |
8e04817f | 23982 | @end itemize |
c906108c | 23983 | |
46ba6afa | 23984 | A status line above the command window shows the following information: |
b7bb15bc SC |
23985 | |
23986 | @table @emph | |
23987 | @item target | |
46ba6afa | 23988 | Indicates the current @value{GDBN} target. |
b7bb15bc SC |
23989 | (@pxref{Targets, ,Specifying a Debugging Target}). |
23990 | ||
23991 | @item process | |
46ba6afa | 23992 | Gives the current process or thread number. |
b7bb15bc SC |
23993 | When no process is being debugged, this field is set to @code{No process}. |
23994 | ||
23995 | @item function | |
23996 | Gives the current function name for the selected frame. | |
23997 | The name is demangled if demangling is turned on (@pxref{Print Settings}). | |
46ba6afa | 23998 | When there is no symbol corresponding to the current program counter, |
b7bb15bc SC |
23999 | the string @code{??} is displayed. |
24000 | ||
24001 | @item line | |
24002 | Indicates the current line number for the selected frame. | |
46ba6afa | 24003 | When the current line number is not known, the string @code{??} is displayed. |
b7bb15bc SC |
24004 | |
24005 | @item pc | |
24006 | Indicates the current program counter address. | |
b7bb15bc SC |
24007 | @end table |
24008 | ||
8e04817f AC |
24009 | @node TUI Keys |
24010 | @section TUI Key Bindings | |
24011 | @cindex TUI key bindings | |
c906108c | 24012 | |
8e04817f | 24013 | The TUI installs several key bindings in the readline keymaps |
39037522 TT |
24014 | @ifset SYSTEM_READLINE |
24015 | (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}). | |
24016 | @end ifset | |
24017 | @ifclear SYSTEM_READLINE | |
24018 | (@pxref{Command Line Editing}). | |
24019 | @end ifclear | |
24020 | The following key bindings are installed for both TUI mode and the | |
24021 | @value{GDBN} standard mode. | |
c906108c | 24022 | |
8e04817f AC |
24023 | @table @kbd |
24024 | @kindex C-x C-a | |
24025 | @item C-x C-a | |
24026 | @kindex C-x a | |
24027 | @itemx C-x a | |
24028 | @kindex C-x A | |
24029 | @itemx C-x A | |
46ba6afa BW |
24030 | Enter or leave the TUI mode. When leaving the TUI mode, |
24031 | the curses window management stops and @value{GDBN} operates using | |
24032 | its standard mode, writing on the terminal directly. When reentering | |
24033 | the TUI mode, control is given back to the curses windows. | |
8e04817f | 24034 | The screen is then refreshed. |
c906108c | 24035 | |
8e04817f AC |
24036 | @kindex C-x 1 |
24037 | @item C-x 1 | |
24038 | Use a TUI layout with only one window. The layout will | |
24039 | either be @samp{source} or @samp{assembly}. When the TUI mode | |
24040 | is not active, it will switch to the TUI mode. | |
2df3850c | 24041 | |
8e04817f | 24042 | Think of this key binding as the Emacs @kbd{C-x 1} binding. |
c906108c | 24043 | |
8e04817f AC |
24044 | @kindex C-x 2 |
24045 | @item C-x 2 | |
24046 | Use a TUI layout with at least two windows. When the current | |
46ba6afa | 24047 | layout already has two windows, the next layout with two windows is used. |
8e04817f AC |
24048 | When a new layout is chosen, one window will always be common to the |
24049 | previous layout and the new one. | |
c906108c | 24050 | |
8e04817f | 24051 | Think of it as the Emacs @kbd{C-x 2} binding. |
2df3850c | 24052 | |
72ffddc9 SC |
24053 | @kindex C-x o |
24054 | @item C-x o | |
24055 | Change the active window. The TUI associates several key bindings | |
46ba6afa | 24056 | (like scrolling and arrow keys) with the active window. This command |
72ffddc9 SC |
24057 | gives the focus to the next TUI window. |
24058 | ||
24059 | Think of it as the Emacs @kbd{C-x o} binding. | |
24060 | ||
7cf36c78 SC |
24061 | @kindex C-x s |
24062 | @item C-x s | |
46ba6afa BW |
24063 | Switch in and out of the TUI SingleKey mode that binds single |
24064 | keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}). | |
c906108c SS |
24065 | @end table |
24066 | ||
46ba6afa | 24067 | The following key bindings only work in the TUI mode: |
5d161b24 | 24068 | |
46ba6afa | 24069 | @table @asis |
8e04817f | 24070 | @kindex PgUp |
46ba6afa | 24071 | @item @key{PgUp} |
8e04817f | 24072 | Scroll the active window one page up. |
c906108c | 24073 | |
8e04817f | 24074 | @kindex PgDn |
46ba6afa | 24075 | @item @key{PgDn} |
8e04817f | 24076 | Scroll the active window one page down. |
c906108c | 24077 | |
8e04817f | 24078 | @kindex Up |
46ba6afa | 24079 | @item @key{Up} |
8e04817f | 24080 | Scroll the active window one line up. |
c906108c | 24081 | |
8e04817f | 24082 | @kindex Down |
46ba6afa | 24083 | @item @key{Down} |
8e04817f | 24084 | Scroll the active window one line down. |
c906108c | 24085 | |
8e04817f | 24086 | @kindex Left |
46ba6afa | 24087 | @item @key{Left} |
8e04817f | 24088 | Scroll the active window one column left. |
c906108c | 24089 | |
8e04817f | 24090 | @kindex Right |
46ba6afa | 24091 | @item @key{Right} |
8e04817f | 24092 | Scroll the active window one column right. |
c906108c | 24093 | |
8e04817f | 24094 | @kindex C-L |
46ba6afa | 24095 | @item @kbd{C-L} |
8e04817f | 24096 | Refresh the screen. |
8e04817f | 24097 | @end table |
c906108c | 24098 | |
46ba6afa BW |
24099 | Because the arrow keys scroll the active window in the TUI mode, they |
24100 | are not available for their normal use by readline unless the command | |
24101 | window has the focus. When another window is active, you must use | |
24102 | other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b} | |
24103 | and @kbd{C-f} to control the command window. | |
8e04817f | 24104 | |
7cf36c78 SC |
24105 | @node TUI Single Key Mode |
24106 | @section TUI Single Key Mode | |
24107 | @cindex TUI single key mode | |
24108 | ||
46ba6afa BW |
24109 | The TUI also provides a @dfn{SingleKey} mode, which binds several |
24110 | frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to | |
24111 | switch into this mode, where the following key bindings are used: | |
7cf36c78 SC |
24112 | |
24113 | @table @kbd | |
24114 | @kindex c @r{(SingleKey TUI key)} | |
24115 | @item c | |
24116 | continue | |
24117 | ||
24118 | @kindex d @r{(SingleKey TUI key)} | |
24119 | @item d | |
24120 | down | |
24121 | ||
24122 | @kindex f @r{(SingleKey TUI key)} | |
24123 | @item f | |
24124 | finish | |
24125 | ||
24126 | @kindex n @r{(SingleKey TUI key)} | |
24127 | @item n | |
24128 | next | |
24129 | ||
24130 | @kindex q @r{(SingleKey TUI key)} | |
24131 | @item q | |
46ba6afa | 24132 | exit the SingleKey mode. |
7cf36c78 SC |
24133 | |
24134 | @kindex r @r{(SingleKey TUI key)} | |
24135 | @item r | |
24136 | run | |
24137 | ||
24138 | @kindex s @r{(SingleKey TUI key)} | |
24139 | @item s | |
24140 | step | |
24141 | ||
24142 | @kindex u @r{(SingleKey TUI key)} | |
24143 | @item u | |
24144 | up | |
24145 | ||
24146 | @kindex v @r{(SingleKey TUI key)} | |
24147 | @item v | |
24148 | info locals | |
24149 | ||
24150 | @kindex w @r{(SingleKey TUI key)} | |
24151 | @item w | |
24152 | where | |
7cf36c78 SC |
24153 | @end table |
24154 | ||
24155 | Other keys temporarily switch to the @value{GDBN} command prompt. | |
24156 | The key that was pressed is inserted in the editing buffer so that | |
24157 | it is possible to type most @value{GDBN} commands without interaction | |
46ba6afa BW |
24158 | with the TUI SingleKey mode. Once the command is entered the TUI |
24159 | SingleKey mode is restored. The only way to permanently leave | |
7f9087cb | 24160 | this mode is by typing @kbd{q} or @kbd{C-x s}. |
7cf36c78 SC |
24161 | |
24162 | ||
8e04817f | 24163 | @node TUI Commands |
db2e3e2e | 24164 | @section TUI-specific Commands |
8e04817f AC |
24165 | @cindex TUI commands |
24166 | ||
24167 | The TUI has specific commands to control the text windows. | |
46ba6afa BW |
24168 | These commands are always available, even when @value{GDBN} is not in |
24169 | the TUI mode. When @value{GDBN} is in the standard mode, most | |
24170 | of these commands will automatically switch to the TUI mode. | |
c906108c | 24171 | |
ff12863f PA |
24172 | Note that if @value{GDBN}'s @code{stdout} is not connected to a |
24173 | terminal, or @value{GDBN} has been started with the machine interface | |
24174 | interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of | |
24175 | these commands will fail with an error, because it would not be | |
24176 | possible or desirable to enable curses window management. | |
24177 | ||
c906108c | 24178 | @table @code |
3d757584 SC |
24179 | @item info win |
24180 | @kindex info win | |
24181 | List and give the size of all displayed windows. | |
24182 | ||
8e04817f | 24183 | @item layout next |
4644b6e3 | 24184 | @kindex layout |
8e04817f | 24185 | Display the next layout. |
2df3850c | 24186 | |
8e04817f | 24187 | @item layout prev |
8e04817f | 24188 | Display the previous layout. |
c906108c | 24189 | |
8e04817f | 24190 | @item layout src |
8e04817f | 24191 | Display the source window only. |
c906108c | 24192 | |
8e04817f | 24193 | @item layout asm |
8e04817f | 24194 | Display the assembly window only. |
c906108c | 24195 | |
8e04817f | 24196 | @item layout split |
8e04817f | 24197 | Display the source and assembly window. |
c906108c | 24198 | |
8e04817f | 24199 | @item layout regs |
8e04817f AC |
24200 | Display the register window together with the source or assembly window. |
24201 | ||
46ba6afa | 24202 | @item focus next |
8e04817f | 24203 | @kindex focus |
46ba6afa BW |
24204 | Make the next window active for scrolling. |
24205 | ||
24206 | @item focus prev | |
24207 | Make the previous window active for scrolling. | |
24208 | ||
24209 | @item focus src | |
24210 | Make the source window active for scrolling. | |
24211 | ||
24212 | @item focus asm | |
24213 | Make the assembly window active for scrolling. | |
24214 | ||
24215 | @item focus regs | |
24216 | Make the register window active for scrolling. | |
24217 | ||
24218 | @item focus cmd | |
24219 | Make the command window active for scrolling. | |
c906108c | 24220 | |
8e04817f AC |
24221 | @item refresh |
24222 | @kindex refresh | |
7f9087cb | 24223 | Refresh the screen. This is similar to typing @kbd{C-L}. |
c906108c | 24224 | |
6a1b180d SC |
24225 | @item tui reg float |
24226 | @kindex tui reg | |
24227 | Show the floating point registers in the register window. | |
24228 | ||
24229 | @item tui reg general | |
24230 | Show the general registers in the register window. | |
24231 | ||
24232 | @item tui reg next | |
24233 | Show the next register group. The list of register groups as well as | |
24234 | their order is target specific. The predefined register groups are the | |
24235 | following: @code{general}, @code{float}, @code{system}, @code{vector}, | |
24236 | @code{all}, @code{save}, @code{restore}. | |
24237 | ||
24238 | @item tui reg system | |
24239 | Show the system registers in the register window. | |
24240 | ||
8e04817f AC |
24241 | @item update |
24242 | @kindex update | |
24243 | Update the source window and the current execution point. | |
c906108c | 24244 | |
8e04817f AC |
24245 | @item winheight @var{name} +@var{count} |
24246 | @itemx winheight @var{name} -@var{count} | |
24247 | @kindex winheight | |
24248 | Change the height of the window @var{name} by @var{count} | |
24249 | lines. Positive counts increase the height, while negative counts | |
24250 | decrease it. | |
2df3850c | 24251 | |
46ba6afa BW |
24252 | @item tabset @var{nchars} |
24253 | @kindex tabset | |
c45da7e6 | 24254 | Set the width of tab stops to be @var{nchars} characters. |
c906108c SS |
24255 | @end table |
24256 | ||
8e04817f | 24257 | @node TUI Configuration |
79a6e687 | 24258 | @section TUI Configuration Variables |
8e04817f | 24259 | @cindex TUI configuration variables |
c906108c | 24260 | |
46ba6afa | 24261 | Several configuration variables control the appearance of TUI windows. |
c906108c | 24262 | |
8e04817f AC |
24263 | @table @code |
24264 | @item set tui border-kind @var{kind} | |
24265 | @kindex set tui border-kind | |
24266 | Select the border appearance for the source, assembly and register windows. | |
24267 | The possible values are the following: | |
24268 | @table @code | |
24269 | @item space | |
24270 | Use a space character to draw the border. | |
c906108c | 24271 | |
8e04817f | 24272 | @item ascii |
46ba6afa | 24273 | Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border. |
c906108c | 24274 | |
8e04817f AC |
24275 | @item acs |
24276 | Use the Alternate Character Set to draw the border. The border is | |
24277 | drawn using character line graphics if the terminal supports them. | |
8e04817f | 24278 | @end table |
c78b4128 | 24279 | |
8e04817f AC |
24280 | @item set tui border-mode @var{mode} |
24281 | @kindex set tui border-mode | |
46ba6afa BW |
24282 | @itemx set tui active-border-mode @var{mode} |
24283 | @kindex set tui active-border-mode | |
24284 | Select the display attributes for the borders of the inactive windows | |
24285 | or the active window. The @var{mode} can be one of the following: | |
8e04817f AC |
24286 | @table @code |
24287 | @item normal | |
24288 | Use normal attributes to display the border. | |
c906108c | 24289 | |
8e04817f AC |
24290 | @item standout |
24291 | Use standout mode. | |
c906108c | 24292 | |
8e04817f AC |
24293 | @item reverse |
24294 | Use reverse video mode. | |
c906108c | 24295 | |
8e04817f AC |
24296 | @item half |
24297 | Use half bright mode. | |
c906108c | 24298 | |
8e04817f AC |
24299 | @item half-standout |
24300 | Use half bright and standout mode. | |
c906108c | 24301 | |
8e04817f AC |
24302 | @item bold |
24303 | Use extra bright or bold mode. | |
c78b4128 | 24304 | |
8e04817f AC |
24305 | @item bold-standout |
24306 | Use extra bright or bold and standout mode. | |
8e04817f | 24307 | @end table |
8e04817f | 24308 | @end table |
c78b4128 | 24309 | |
8e04817f AC |
24310 | @node Emacs |
24311 | @chapter Using @value{GDBN} under @sc{gnu} Emacs | |
c78b4128 | 24312 | |
8e04817f AC |
24313 | @cindex Emacs |
24314 | @cindex @sc{gnu} Emacs | |
24315 | A special interface allows you to use @sc{gnu} Emacs to view (and | |
24316 | edit) the source files for the program you are debugging with | |
24317 | @value{GDBN}. | |
c906108c | 24318 | |
8e04817f AC |
24319 | To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the |
24320 | executable file you want to debug as an argument. This command starts | |
24321 | @value{GDBN} as a subprocess of Emacs, with input and output through a newly | |
24322 | created Emacs buffer. | |
24323 | @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.) | |
c906108c | 24324 | |
5e252a2e | 24325 | Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two |
8e04817f | 24326 | things: |
c906108c | 24327 | |
8e04817f AC |
24328 | @itemize @bullet |
24329 | @item | |
5e252a2e NR |
24330 | All ``terminal'' input and output goes through an Emacs buffer, called |
24331 | the GUD buffer. | |
c906108c | 24332 | |
8e04817f AC |
24333 | This applies both to @value{GDBN} commands and their output, and to the input |
24334 | and output done by the program you are debugging. | |
bf0184be | 24335 | |
8e04817f AC |
24336 | This is useful because it means that you can copy the text of previous |
24337 | commands and input them again; you can even use parts of the output | |
24338 | in this way. | |
bf0184be | 24339 | |
8e04817f AC |
24340 | All the facilities of Emacs' Shell mode are available for interacting |
24341 | with your program. In particular, you can send signals the usual | |
24342 | way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a | |
24343 | stop. | |
bf0184be ND |
24344 | |
24345 | @item | |
8e04817f | 24346 | @value{GDBN} displays source code through Emacs. |
bf0184be | 24347 | |
8e04817f AC |
24348 | Each time @value{GDBN} displays a stack frame, Emacs automatically finds the |
24349 | source file for that frame and puts an arrow (@samp{=>}) at the | |
24350 | left margin of the current line. Emacs uses a separate buffer for | |
24351 | source display, and splits the screen to show both your @value{GDBN} session | |
24352 | and the source. | |
bf0184be | 24353 | |
8e04817f AC |
24354 | Explicit @value{GDBN} @code{list} or search commands still produce output as |
24355 | usual, but you probably have no reason to use them from Emacs. | |
5e252a2e NR |
24356 | @end itemize |
24357 | ||
24358 | We call this @dfn{text command mode}. Emacs 22.1, and later, also uses | |
24359 | a graphical mode, enabled by default, which provides further buffers | |
24360 | that can control the execution and describe the state of your program. | |
24361 | @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}. | |
c906108c | 24362 | |
64fabec2 AC |
24363 | If you specify an absolute file name when prompted for the @kbd{M-x |
24364 | gdb} argument, then Emacs sets your current working directory to where | |
24365 | your program resides. If you only specify the file name, then Emacs | |
7a9dd1b2 | 24366 | sets your current working directory to the directory associated |
64fabec2 AC |
24367 | with the previous buffer. In this case, @value{GDBN} may find your |
24368 | program by searching your environment's @code{PATH} variable, but on | |
24369 | some operating systems it might not find the source. So, although the | |
24370 | @value{GDBN} input and output session proceeds normally, the auxiliary | |
24371 | buffer does not display the current source and line of execution. | |
24372 | ||
24373 | The initial working directory of @value{GDBN} is printed on the top | |
5e252a2e NR |
24374 | line of the GUD buffer and this serves as a default for the commands |
24375 | that specify files for @value{GDBN} to operate on. @xref{Files, | |
24376 | ,Commands to Specify Files}. | |
64fabec2 AC |
24377 | |
24378 | By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you | |
24379 | need to call @value{GDBN} by a different name (for example, if you | |
24380 | keep several configurations around, with different names) you can | |
24381 | customize the Emacs variable @code{gud-gdb-command-name} to run the | |
24382 | one you want. | |
8e04817f | 24383 | |
5e252a2e | 24384 | In the GUD buffer, you can use these special Emacs commands in |
8e04817f | 24385 | addition to the standard Shell mode commands: |
c906108c | 24386 | |
8e04817f AC |
24387 | @table @kbd |
24388 | @item C-h m | |
5e252a2e | 24389 | Describe the features of Emacs' GUD Mode. |
c906108c | 24390 | |
64fabec2 | 24391 | @item C-c C-s |
8e04817f AC |
24392 | Execute to another source line, like the @value{GDBN} @code{step} command; also |
24393 | update the display window to show the current file and location. | |
c906108c | 24394 | |
64fabec2 | 24395 | @item C-c C-n |
8e04817f AC |
24396 | Execute to next source line in this function, skipping all function |
24397 | calls, like the @value{GDBN} @code{next} command. Then update the display window | |
24398 | to show the current file and location. | |
c906108c | 24399 | |
64fabec2 | 24400 | @item C-c C-i |
8e04817f AC |
24401 | Execute one instruction, like the @value{GDBN} @code{stepi} command; update |
24402 | display window accordingly. | |
c906108c | 24403 | |
8e04817f AC |
24404 | @item C-c C-f |
24405 | Execute until exit from the selected stack frame, like the @value{GDBN} | |
24406 | @code{finish} command. | |
c906108c | 24407 | |
64fabec2 | 24408 | @item C-c C-r |
8e04817f AC |
24409 | Continue execution of your program, like the @value{GDBN} @code{continue} |
24410 | command. | |
b433d00b | 24411 | |
64fabec2 | 24412 | @item C-c < |
8e04817f AC |
24413 | Go up the number of frames indicated by the numeric argument |
24414 | (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}), | |
24415 | like the @value{GDBN} @code{up} command. | |
b433d00b | 24416 | |
64fabec2 | 24417 | @item C-c > |
8e04817f AC |
24418 | Go down the number of frames indicated by the numeric argument, like the |
24419 | @value{GDBN} @code{down} command. | |
8e04817f | 24420 | @end table |
c906108c | 24421 | |
7f9087cb | 24422 | In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break}) |
8e04817f | 24423 | tells @value{GDBN} to set a breakpoint on the source line point is on. |
c906108c | 24424 | |
5e252a2e NR |
24425 | In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a |
24426 | separate frame which shows a backtrace when the GUD buffer is current. | |
24427 | Move point to any frame in the stack and type @key{RET} to make it | |
24428 | become the current frame and display the associated source in the | |
24429 | source buffer. Alternatively, click @kbd{Mouse-2} to make the | |
24430 | selected frame become the current one. In graphical mode, the | |
24431 | speedbar displays watch expressions. | |
64fabec2 | 24432 | |
8e04817f AC |
24433 | If you accidentally delete the source-display buffer, an easy way to get |
24434 | it back is to type the command @code{f} in the @value{GDBN} buffer, to | |
24435 | request a frame display; when you run under Emacs, this recreates | |
24436 | the source buffer if necessary to show you the context of the current | |
24437 | frame. | |
c906108c | 24438 | |
8e04817f AC |
24439 | The source files displayed in Emacs are in ordinary Emacs buffers |
24440 | which are visiting the source files in the usual way. You can edit | |
24441 | the files with these buffers if you wish; but keep in mind that @value{GDBN} | |
24442 | communicates with Emacs in terms of line numbers. If you add or | |
24443 | delete lines from the text, the line numbers that @value{GDBN} knows cease | |
24444 | to correspond properly with the code. | |
b383017d | 24445 | |
5e252a2e NR |
24446 | A more detailed description of Emacs' interaction with @value{GDBN} is |
24447 | given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu} | |
24448 | Emacs Manual}). | |
c906108c | 24449 | |
8e04817f AC |
24450 | @c The following dropped because Epoch is nonstandard. Reactivate |
24451 | @c if/when v19 does something similar. ---doc@cygnus.com 19dec1990 | |
24452 | @ignore | |
24453 | @kindex Emacs Epoch environment | |
24454 | @kindex Epoch | |
24455 | @kindex inspect | |
c906108c | 24456 | |
8e04817f AC |
24457 | Version 18 of @sc{gnu} Emacs has a built-in window system |
24458 | called the @code{epoch} | |
24459 | environment. Users of this environment can use a new command, | |
24460 | @code{inspect} which performs identically to @code{print} except that | |
24461 | each value is printed in its own window. | |
24462 | @end ignore | |
c906108c | 24463 | |
922fbb7b AC |
24464 | |
24465 | @node GDB/MI | |
24466 | @chapter The @sc{gdb/mi} Interface | |
24467 | ||
24468 | @unnumberedsec Function and Purpose | |
24469 | ||
24470 | @cindex @sc{gdb/mi}, its purpose | |
6b5e8c01 NR |
24471 | @sc{gdb/mi} is a line based machine oriented text interface to |
24472 | @value{GDBN} and is activated by specifying using the | |
24473 | @option{--interpreter} command line option (@pxref{Mode Options}). It | |
24474 | is specifically intended to support the development of systems which | |
24475 | use the debugger as just one small component of a larger system. | |
922fbb7b AC |
24476 | |
24477 | This chapter is a specification of the @sc{gdb/mi} interface. It is written | |
24478 | in the form of a reference manual. | |
24479 | ||
24480 | Note that @sc{gdb/mi} is still under construction, so some of the | |
af6eff6f NR |
24481 | features described below are incomplete and subject to change |
24482 | (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}). | |
922fbb7b AC |
24483 | |
24484 | @unnumberedsec Notation and Terminology | |
24485 | ||
24486 | @cindex notational conventions, for @sc{gdb/mi} | |
24487 | This chapter uses the following notation: | |
24488 | ||
24489 | @itemize @bullet | |
24490 | @item | |
24491 | @code{|} separates two alternatives. | |
24492 | ||
24493 | @item | |
24494 | @code{[ @var{something} ]} indicates that @var{something} is optional: | |
24495 | it may or may not be given. | |
24496 | ||
24497 | @item | |
24498 | @code{( @var{group} )*} means that @var{group} inside the parentheses | |
24499 | may repeat zero or more times. | |
24500 | ||
24501 | @item | |
24502 | @code{( @var{group} )+} means that @var{group} inside the parentheses | |
24503 | may repeat one or more times. | |
24504 | ||
24505 | @item | |
24506 | @code{"@var{string}"} means a literal @var{string}. | |
24507 | @end itemize | |
24508 | ||
24509 | @ignore | |
24510 | @heading Dependencies | |
24511 | @end ignore | |
24512 | ||
922fbb7b | 24513 | @menu |
c3b108f7 | 24514 | * GDB/MI General Design:: |
922fbb7b AC |
24515 | * GDB/MI Command Syntax:: |
24516 | * GDB/MI Compatibility with CLI:: | |
af6eff6f | 24517 | * GDB/MI Development and Front Ends:: |
922fbb7b | 24518 | * GDB/MI Output Records:: |
ef21caaf | 24519 | * GDB/MI Simple Examples:: |
922fbb7b | 24520 | * GDB/MI Command Description Format:: |
ef21caaf | 24521 | * GDB/MI Breakpoint Commands:: |
a2c02241 NR |
24522 | * GDB/MI Program Context:: |
24523 | * GDB/MI Thread Commands:: | |
24524 | * GDB/MI Program Execution:: | |
24525 | * GDB/MI Stack Manipulation:: | |
24526 | * GDB/MI Variable Objects:: | |
922fbb7b | 24527 | * GDB/MI Data Manipulation:: |
a2c02241 NR |
24528 | * GDB/MI Tracepoint Commands:: |
24529 | * GDB/MI Symbol Query:: | |
351ff01a | 24530 | * GDB/MI File Commands:: |
922fbb7b AC |
24531 | @ignore |
24532 | * GDB/MI Kod Commands:: | |
24533 | * GDB/MI Memory Overlay Commands:: | |
24534 | * GDB/MI Signal Handling Commands:: | |
24535 | @end ignore | |
922fbb7b | 24536 | * GDB/MI Target Manipulation:: |
a6b151f1 | 24537 | * GDB/MI File Transfer Commands:: |
ef21caaf | 24538 | * GDB/MI Miscellaneous Commands:: |
922fbb7b AC |
24539 | @end menu |
24540 | ||
c3b108f7 VP |
24541 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
24542 | @node GDB/MI General Design | |
24543 | @section @sc{gdb/mi} General Design | |
24544 | @cindex GDB/MI General Design | |
24545 | ||
24546 | Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three | |
24547 | parts---commands sent to @value{GDBN}, responses to those commands | |
24548 | and notifications. Each command results in exactly one response, | |
24549 | indicating either successful completion of the command, or an error. | |
24550 | For the commands that do not resume the target, the response contains the | |
24551 | requested information. For the commands that resume the target, the | |
24552 | response only indicates whether the target was successfully resumed. | |
24553 | Notifications is the mechanism for reporting changes in the state of the | |
24554 | target, or in @value{GDBN} state, that cannot conveniently be associated with | |
24555 | a command and reported as part of that command response. | |
24556 | ||
24557 | The important examples of notifications are: | |
24558 | @itemize @bullet | |
24559 | ||
24560 | @item | |
24561 | Exec notifications. These are used to report changes in | |
24562 | target state---when a target is resumed, or stopped. It would not | |
24563 | be feasible to include this information in response of resuming | |
24564 | commands, because one resume commands can result in multiple events in | |
24565 | different threads. Also, quite some time may pass before any event | |
24566 | happens in the target, while a frontend needs to know whether the resuming | |
24567 | command itself was successfully executed. | |
24568 | ||
24569 | @item | |
24570 | Console output, and status notifications. Console output | |
24571 | notifications are used to report output of CLI commands, as well as | |
24572 | diagnostics for other commands. Status notifications are used to | |
24573 | report the progress of a long-running operation. Naturally, including | |
24574 | this information in command response would mean no output is produced | |
24575 | until the command is finished, which is undesirable. | |
24576 | ||
24577 | @item | |
24578 | General notifications. Commands may have various side effects on | |
24579 | the @value{GDBN} or target state beyond their official purpose. For example, | |
24580 | a command may change the selected thread. Although such changes can | |
24581 | be included in command response, using notification allows for more | |
24582 | orthogonal frontend design. | |
24583 | ||
24584 | @end itemize | |
24585 | ||
24586 | There's no guarantee that whenever an MI command reports an error, | |
24587 | @value{GDBN} or the target are in any specific state, and especially, | |
24588 | the state is not reverted to the state before the MI command was | |
24589 | processed. Therefore, whenever an MI command results in an error, | |
24590 | we recommend that the frontend refreshes all the information shown in | |
24591 | the user interface. | |
24592 | ||
508094de NR |
24593 | |
24594 | @menu | |
24595 | * Context management:: | |
24596 | * Asynchronous and non-stop modes:: | |
24597 | * Thread groups:: | |
24598 | @end menu | |
24599 | ||
24600 | @node Context management | |
c3b108f7 VP |
24601 | @subsection Context management |
24602 | ||
24603 | In most cases when @value{GDBN} accesses the target, this access is | |
24604 | done in context of a specific thread and frame (@pxref{Frames}). | |
24605 | Often, even when accessing global data, the target requires that a thread | |
24606 | be specified. The CLI interface maintains the selected thread and frame, | |
24607 | and supplies them to target on each command. This is convenient, | |
24608 | because a command line user would not want to specify that information | |
24609 | explicitly on each command, and because user interacts with | |
24610 | @value{GDBN} via a single terminal, so no confusion is possible as | |
24611 | to what thread and frame are the current ones. | |
24612 | ||
24613 | In the case of MI, the concept of selected thread and frame is less | |
24614 | useful. First, a frontend can easily remember this information | |
24615 | itself. Second, a graphical frontend can have more than one window, | |
24616 | each one used for debugging a different thread, and the frontend might | |
24617 | want to access additional threads for internal purposes. This | |
24618 | increases the risk that by relying on implicitly selected thread, the | |
24619 | frontend may be operating on a wrong one. Therefore, each MI command | |
24620 | should explicitly specify which thread and frame to operate on. To | |
24621 | make it possible, each MI command accepts the @samp{--thread} and | |
24622 | @samp{--frame} options, the value to each is @value{GDBN} identifier | |
24623 | for thread and frame to operate on. | |
24624 | ||
24625 | Usually, each top-level window in a frontend allows the user to select | |
24626 | a thread and a frame, and remembers the user selection for further | |
24627 | operations. However, in some cases @value{GDBN} may suggest that the | |
24628 | current thread be changed. For example, when stopping on a breakpoint | |
24629 | it is reasonable to switch to the thread where breakpoint is hit. For | |
24630 | another example, if the user issues the CLI @samp{thread} command via | |
24631 | the frontend, it is desirable to change the frontend's selected thread to the | |
24632 | one specified by user. @value{GDBN} communicates the suggestion to | |
24633 | change current thread using the @samp{=thread-selected} notification. | |
24634 | No such notification is available for the selected frame at the moment. | |
24635 | ||
24636 | Note that historically, MI shares the selected thread with CLI, so | |
24637 | frontends used the @code{-thread-select} to execute commands in the | |
24638 | right context. However, getting this to work right is cumbersome. The | |
24639 | simplest way is for frontend to emit @code{-thread-select} command | |
24640 | before every command. This doubles the number of commands that need | |
24641 | to be sent. The alternative approach is to suppress @code{-thread-select} | |
24642 | if the selected thread in @value{GDBN} is supposed to be identical to the | |
24643 | thread the frontend wants to operate on. However, getting this | |
24644 | optimization right can be tricky. In particular, if the frontend | |
24645 | sends several commands to @value{GDBN}, and one of the commands changes the | |
24646 | selected thread, then the behaviour of subsequent commands will | |
24647 | change. So, a frontend should either wait for response from such | |
24648 | problematic commands, or explicitly add @code{-thread-select} for | |
24649 | all subsequent commands. No frontend is known to do this exactly | |
24650 | right, so it is suggested to just always pass the @samp{--thread} and | |
24651 | @samp{--frame} options. | |
24652 | ||
508094de | 24653 | @node Asynchronous and non-stop modes |
c3b108f7 VP |
24654 | @subsection Asynchronous command execution and non-stop mode |
24655 | ||
24656 | On some targets, @value{GDBN} is capable of processing MI commands | |
24657 | even while the target is running. This is called @dfn{asynchronous | |
24658 | command execution} (@pxref{Background Execution}). The frontend may | |
24659 | specify a preferrence for asynchronous execution using the | |
24660 | @code{-gdb-set target-async 1} command, which should be emitted before | |
24661 | either running the executable or attaching to the target. After the | |
24662 | frontend has started the executable or attached to the target, it can | |
24663 | find if asynchronous execution is enabled using the | |
24664 | @code{-list-target-features} command. | |
24665 | ||
24666 | Even if @value{GDBN} can accept a command while target is running, | |
24667 | many commands that access the target do not work when the target is | |
24668 | running. Therefore, asynchronous command execution is most useful | |
24669 | when combined with non-stop mode (@pxref{Non-Stop Mode}). Then, | |
24670 | it is possible to examine the state of one thread, while other threads | |
24671 | are running. | |
24672 | ||
24673 | When a given thread is running, MI commands that try to access the | |
24674 | target in the context of that thread may not work, or may work only on | |
24675 | some targets. In particular, commands that try to operate on thread's | |
24676 | stack will not work, on any target. Commands that read memory, or | |
24677 | modify breakpoints, may work or not work, depending on the target. Note | |
24678 | that even commands that operate on global state, such as @code{print}, | |
24679 | @code{set}, and breakpoint commands, still access the target in the | |
24680 | context of a specific thread, so frontend should try to find a | |
24681 | stopped thread and perform the operation on that thread (using the | |
24682 | @samp{--thread} option). | |
24683 | ||
24684 | Which commands will work in the context of a running thread is | |
24685 | highly target dependent. However, the two commands | |
24686 | @code{-exec-interrupt}, to stop a thread, and @code{-thread-info}, | |
24687 | to find the state of a thread, will always work. | |
24688 | ||
508094de | 24689 | @node Thread groups |
c3b108f7 VP |
24690 | @subsection Thread groups |
24691 | @value{GDBN} may be used to debug several processes at the same time. | |
24692 | On some platfroms, @value{GDBN} may support debugging of several | |
24693 | hardware systems, each one having several cores with several different | |
24694 | processes running on each core. This section describes the MI | |
24695 | mechanism to support such debugging scenarios. | |
24696 | ||
24697 | The key observation is that regardless of the structure of the | |
24698 | target, MI can have a global list of threads, because most commands that | |
24699 | accept the @samp{--thread} option do not need to know what process that | |
24700 | thread belongs to. Therefore, it is not necessary to introduce | |
24701 | neither additional @samp{--process} option, nor an notion of the | |
24702 | current process in the MI interface. The only strictly new feature | |
24703 | that is required is the ability to find how the threads are grouped | |
24704 | into processes. | |
24705 | ||
24706 | To allow the user to discover such grouping, and to support arbitrary | |
24707 | hierarchy of machines/cores/processes, MI introduces the concept of a | |
24708 | @dfn{thread group}. Thread group is a collection of threads and other | |
24709 | thread groups. A thread group always has a string identifier, a type, | |
24710 | and may have additional attributes specific to the type. A new | |
24711 | command, @code{-list-thread-groups}, returns the list of top-level | |
24712 | thread groups, which correspond to processes that @value{GDBN} is | |
24713 | debugging at the moment. By passing an identifier of a thread group | |
24714 | to the @code{-list-thread-groups} command, it is possible to obtain | |
24715 | the members of specific thread group. | |
24716 | ||
24717 | To allow the user to easily discover processes, and other objects, he | |
24718 | wishes to debug, a concept of @dfn{available thread group} is | |
24719 | introduced. Available thread group is an thread group that | |
24720 | @value{GDBN} is not debugging, but that can be attached to, using the | |
24721 | @code{-target-attach} command. The list of available top-level thread | |
24722 | groups can be obtained using @samp{-list-thread-groups --available}. | |
24723 | In general, the content of a thread group may be only retrieved only | |
24724 | after attaching to that thread group. | |
24725 | ||
a79b8f6e VP |
24726 | Thread groups are related to inferiors (@pxref{Inferiors and |
24727 | Programs}). Each inferior corresponds to a thread group of a special | |
24728 | type @samp{process}, and some additional operations are permitted on | |
24729 | such thread groups. | |
24730 | ||
922fbb7b AC |
24731 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
24732 | @node GDB/MI Command Syntax | |
24733 | @section @sc{gdb/mi} Command Syntax | |
24734 | ||
24735 | @menu | |
24736 | * GDB/MI Input Syntax:: | |
24737 | * GDB/MI Output Syntax:: | |
922fbb7b AC |
24738 | @end menu |
24739 | ||
24740 | @node GDB/MI Input Syntax | |
24741 | @subsection @sc{gdb/mi} Input Syntax | |
24742 | ||
24743 | @cindex input syntax for @sc{gdb/mi} | |
24744 | @cindex @sc{gdb/mi}, input syntax | |
24745 | @table @code | |
24746 | @item @var{command} @expansion{} | |
24747 | @code{@var{cli-command} | @var{mi-command}} | |
24748 | ||
24749 | @item @var{cli-command} @expansion{} | |
24750 | @code{[ @var{token} ] @var{cli-command} @var{nl}}, where | |
24751 | @var{cli-command} is any existing @value{GDBN} CLI command. | |
24752 | ||
24753 | @item @var{mi-command} @expansion{} | |
24754 | @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )* | |
24755 | @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}} | |
24756 | ||
24757 | @item @var{token} @expansion{} | |
24758 | "any sequence of digits" | |
24759 | ||
24760 | @item @var{option} @expansion{} | |
24761 | @code{"-" @var{parameter} [ " " @var{parameter} ]} | |
24762 | ||
24763 | @item @var{parameter} @expansion{} | |
24764 | @code{@var{non-blank-sequence} | @var{c-string}} | |
24765 | ||
24766 | @item @var{operation} @expansion{} | |
24767 | @emph{any of the operations described in this chapter} | |
24768 | ||
24769 | @item @var{non-blank-sequence} @expansion{} | |
24770 | @emph{anything, provided it doesn't contain special characters such as | |
24771 | "-", @var{nl}, """ and of course " "} | |
24772 | ||
24773 | @item @var{c-string} @expansion{} | |
24774 | @code{""" @var{seven-bit-iso-c-string-content} """} | |
24775 | ||
24776 | @item @var{nl} @expansion{} | |
24777 | @code{CR | CR-LF} | |
24778 | @end table | |
24779 | ||
24780 | @noindent | |
24781 | Notes: | |
24782 | ||
24783 | @itemize @bullet | |
24784 | @item | |
24785 | The CLI commands are still handled by the @sc{mi} interpreter; their | |
24786 | output is described below. | |
24787 | ||
24788 | @item | |
24789 | The @code{@var{token}}, when present, is passed back when the command | |
24790 | finishes. | |
24791 | ||
24792 | @item | |
24793 | Some @sc{mi} commands accept optional arguments as part of the parameter | |
24794 | list. Each option is identified by a leading @samp{-} (dash) and may be | |
24795 | followed by an optional argument parameter. Options occur first in the | |
24796 | parameter list and can be delimited from normal parameters using | |
24797 | @samp{--} (this is useful when some parameters begin with a dash). | |
24798 | @end itemize | |
24799 | ||
24800 | Pragmatics: | |
24801 | ||
24802 | @itemize @bullet | |
24803 | @item | |
24804 | We want easy access to the existing CLI syntax (for debugging). | |
24805 | ||
24806 | @item | |
24807 | We want it to be easy to spot a @sc{mi} operation. | |
24808 | @end itemize | |
24809 | ||
24810 | @node GDB/MI Output Syntax | |
24811 | @subsection @sc{gdb/mi} Output Syntax | |
24812 | ||
24813 | @cindex output syntax of @sc{gdb/mi} | |
24814 | @cindex @sc{gdb/mi}, output syntax | |
24815 | The output from @sc{gdb/mi} consists of zero or more out-of-band records | |
24816 | followed, optionally, by a single result record. This result record | |
24817 | is for the most recent command. The sequence of output records is | |
594fe323 | 24818 | terminated by @samp{(gdb)}. |
922fbb7b AC |
24819 | |
24820 | If an input command was prefixed with a @code{@var{token}} then the | |
24821 | corresponding output for that command will also be prefixed by that same | |
24822 | @var{token}. | |
24823 | ||
24824 | @table @code | |
24825 | @item @var{output} @expansion{} | |
594fe323 | 24826 | @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}} |
922fbb7b AC |
24827 | |
24828 | @item @var{result-record} @expansion{} | |
24829 | @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}} | |
24830 | ||
24831 | @item @var{out-of-band-record} @expansion{} | |
24832 | @code{@var{async-record} | @var{stream-record}} | |
24833 | ||
24834 | @item @var{async-record} @expansion{} | |
24835 | @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}} | |
24836 | ||
24837 | @item @var{exec-async-output} @expansion{} | |
24838 | @code{[ @var{token} ] "*" @var{async-output}} | |
24839 | ||
24840 | @item @var{status-async-output} @expansion{} | |
24841 | @code{[ @var{token} ] "+" @var{async-output}} | |
24842 | ||
24843 | @item @var{notify-async-output} @expansion{} | |
24844 | @code{[ @var{token} ] "=" @var{async-output}} | |
24845 | ||
24846 | @item @var{async-output} @expansion{} | |
24847 | @code{@var{async-class} ( "," @var{result} )* @var{nl}} | |
24848 | ||
24849 | @item @var{result-class} @expansion{} | |
24850 | @code{"done" | "running" | "connected" | "error" | "exit"} | |
24851 | ||
24852 | @item @var{async-class} @expansion{} | |
24853 | @code{"stopped" | @var{others}} (where @var{others} will be added | |
24854 | depending on the needs---this is still in development). | |
24855 | ||
24856 | @item @var{result} @expansion{} | |
24857 | @code{ @var{variable} "=" @var{value}} | |
24858 | ||
24859 | @item @var{variable} @expansion{} | |
24860 | @code{ @var{string} } | |
24861 | ||
24862 | @item @var{value} @expansion{} | |
24863 | @code{ @var{const} | @var{tuple} | @var{list} } | |
24864 | ||
24865 | @item @var{const} @expansion{} | |
24866 | @code{@var{c-string}} | |
24867 | ||
24868 | @item @var{tuple} @expansion{} | |
24869 | @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" } | |
24870 | ||
24871 | @item @var{list} @expansion{} | |
24872 | @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "[" | |
24873 | @var{result} ( "," @var{result} )* "]" } | |
24874 | ||
24875 | @item @var{stream-record} @expansion{} | |
24876 | @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}} | |
24877 | ||
24878 | @item @var{console-stream-output} @expansion{} | |
24879 | @code{"~" @var{c-string}} | |
24880 | ||
24881 | @item @var{target-stream-output} @expansion{} | |
24882 | @code{"@@" @var{c-string}} | |
24883 | ||
24884 | @item @var{log-stream-output} @expansion{} | |
24885 | @code{"&" @var{c-string}} | |
24886 | ||
24887 | @item @var{nl} @expansion{} | |
24888 | @code{CR | CR-LF} | |
24889 | ||
24890 | @item @var{token} @expansion{} | |
24891 | @emph{any sequence of digits}. | |
24892 | @end table | |
24893 | ||
24894 | @noindent | |
24895 | Notes: | |
24896 | ||
24897 | @itemize @bullet | |
24898 | @item | |
24899 | All output sequences end in a single line containing a period. | |
24900 | ||
24901 | @item | |
721c02de VP |
24902 | The @code{@var{token}} is from the corresponding request. Note that |
24903 | for all async output, while the token is allowed by the grammar and | |
24904 | may be output by future versions of @value{GDBN} for select async | |
24905 | output messages, it is generally omitted. Frontends should treat | |
24906 | all async output as reporting general changes in the state of the | |
24907 | target and there should be no need to associate async output to any | |
24908 | prior command. | |
922fbb7b AC |
24909 | |
24910 | @item | |
24911 | @cindex status output in @sc{gdb/mi} | |
24912 | @var{status-async-output} contains on-going status information about the | |
24913 | progress of a slow operation. It can be discarded. All status output is | |
24914 | prefixed by @samp{+}. | |
24915 | ||
24916 | @item | |
24917 | @cindex async output in @sc{gdb/mi} | |
24918 | @var{exec-async-output} contains asynchronous state change on the target | |
24919 | (stopped, started, disappeared). All async output is prefixed by | |
24920 | @samp{*}. | |
24921 | ||
24922 | @item | |
24923 | @cindex notify output in @sc{gdb/mi} | |
24924 | @var{notify-async-output} contains supplementary information that the | |
24925 | client should handle (e.g., a new breakpoint information). All notify | |
24926 | output is prefixed by @samp{=}. | |
24927 | ||
24928 | @item | |
24929 | @cindex console output in @sc{gdb/mi} | |
24930 | @var{console-stream-output} is output that should be displayed as is in the | |
24931 | console. It is the textual response to a CLI command. All the console | |
24932 | output is prefixed by @samp{~}. | |
24933 | ||
24934 | @item | |
24935 | @cindex target output in @sc{gdb/mi} | |
24936 | @var{target-stream-output} is the output produced by the target program. | |
24937 | All the target output is prefixed by @samp{@@}. | |
24938 | ||
24939 | @item | |
24940 | @cindex log output in @sc{gdb/mi} | |
24941 | @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for | |
24942 | instance messages that should be displayed as part of an error log. All | |
24943 | the log output is prefixed by @samp{&}. | |
24944 | ||
24945 | @item | |
24946 | @cindex list output in @sc{gdb/mi} | |
24947 | New @sc{gdb/mi} commands should only output @var{lists} containing | |
24948 | @var{values}. | |
24949 | ||
24950 | ||
24951 | @end itemize | |
24952 | ||
24953 | @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more | |
24954 | details about the various output records. | |
24955 | ||
922fbb7b AC |
24956 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
24957 | @node GDB/MI Compatibility with CLI | |
24958 | @section @sc{gdb/mi} Compatibility with CLI | |
24959 | ||
24960 | @cindex compatibility, @sc{gdb/mi} and CLI | |
24961 | @cindex @sc{gdb/mi}, compatibility with CLI | |
922fbb7b | 24962 | |
a2c02241 NR |
24963 | For the developers convenience CLI commands can be entered directly, |
24964 | but there may be some unexpected behaviour. For example, commands | |
24965 | that query the user will behave as if the user replied yes, breakpoint | |
24966 | command lists are not executed and some CLI commands, such as | |
24967 | @code{if}, @code{when} and @code{define}, prompt for further input with | |
24968 | @samp{>}, which is not valid MI output. | |
ef21caaf NR |
24969 | |
24970 | This feature may be removed at some stage in the future and it is | |
a2c02241 NR |
24971 | recommended that front ends use the @code{-interpreter-exec} command |
24972 | (@pxref{-interpreter-exec}). | |
922fbb7b | 24973 | |
af6eff6f NR |
24974 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
24975 | @node GDB/MI Development and Front Ends | |
24976 | @section @sc{gdb/mi} Development and Front Ends | |
24977 | @cindex @sc{gdb/mi} development | |
24978 | ||
24979 | The application which takes the MI output and presents the state of the | |
24980 | program being debugged to the user is called a @dfn{front end}. | |
24981 | ||
24982 | Although @sc{gdb/mi} is still incomplete, it is currently being used | |
24983 | by a variety of front ends to @value{GDBN}. This makes it difficult | |
24984 | to introduce new functionality without breaking existing usage. This | |
24985 | section tries to minimize the problems by describing how the protocol | |
24986 | might change. | |
24987 | ||
24988 | Some changes in MI need not break a carefully designed front end, and | |
24989 | for these the MI version will remain unchanged. The following is a | |
24990 | list of changes that may occur within one level, so front ends should | |
24991 | parse MI output in a way that can handle them: | |
24992 | ||
24993 | @itemize @bullet | |
24994 | @item | |
24995 | New MI commands may be added. | |
24996 | ||
24997 | @item | |
24998 | New fields may be added to the output of any MI command. | |
24999 | ||
36ece8b3 NR |
25000 | @item |
25001 | The range of values for fields with specified values, e.g., | |
9f708cb2 | 25002 | @code{in_scope} (@pxref{-var-update}) may be extended. |
36ece8b3 | 25003 | |
af6eff6f NR |
25004 | @c The format of field's content e.g type prefix, may change so parse it |
25005 | @c at your own risk. Yes, in general? | |
25006 | ||
25007 | @c The order of fields may change? Shouldn't really matter but it might | |
25008 | @c resolve inconsistencies. | |
25009 | @end itemize | |
25010 | ||
25011 | If the changes are likely to break front ends, the MI version level | |
25012 | will be increased by one. This will allow the front end to parse the | |
25013 | output according to the MI version. Apart from mi0, new versions of | |
25014 | @value{GDBN} will not support old versions of MI and it will be the | |
25015 | responsibility of the front end to work with the new one. | |
25016 | ||
25017 | @c Starting with mi3, add a new command -mi-version that prints the MI | |
25018 | @c version? | |
25019 | ||
25020 | The best way to avoid unexpected changes in MI that might break your front | |
25021 | end is to make your project known to @value{GDBN} developers and | |
7a9a6b69 | 25022 | follow development on @email{gdb@@sourceware.org} and |
fa0f268d | 25023 | @email{gdb-patches@@sourceware.org}. |
af6eff6f NR |
25024 | @cindex mailing lists |
25025 | ||
922fbb7b AC |
25026 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25027 | @node GDB/MI Output Records | |
25028 | @section @sc{gdb/mi} Output Records | |
25029 | ||
25030 | @menu | |
25031 | * GDB/MI Result Records:: | |
25032 | * GDB/MI Stream Records:: | |
82f68b1c | 25033 | * GDB/MI Async Records:: |
c3b108f7 | 25034 | * GDB/MI Frame Information:: |
dc146f7c | 25035 | * GDB/MI Thread Information:: |
4368ebeb | 25036 | * GDB/MI Ada Exception Information:: |
922fbb7b AC |
25037 | @end menu |
25038 | ||
25039 | @node GDB/MI Result Records | |
25040 | @subsection @sc{gdb/mi} Result Records | |
25041 | ||
25042 | @cindex result records in @sc{gdb/mi} | |
25043 | @cindex @sc{gdb/mi}, result records | |
25044 | In addition to a number of out-of-band notifications, the response to a | |
25045 | @sc{gdb/mi} command includes one of the following result indications: | |
25046 | ||
25047 | @table @code | |
25048 | @findex ^done | |
25049 | @item "^done" [ "," @var{results} ] | |
25050 | The synchronous operation was successful, @code{@var{results}} are the return | |
25051 | values. | |
25052 | ||
25053 | @item "^running" | |
25054 | @findex ^running | |
8e9c5e02 VP |
25055 | This result record is equivalent to @samp{^done}. Historically, it |
25056 | was output instead of @samp{^done} if the command has resumed the | |
25057 | target. This behaviour is maintained for backward compatibility, but | |
25058 | all frontends should treat @samp{^done} and @samp{^running} | |
25059 | identically and rely on the @samp{*running} output record to determine | |
25060 | which threads are resumed. | |
922fbb7b | 25061 | |
ef21caaf NR |
25062 | @item "^connected" |
25063 | @findex ^connected | |
3f94c067 | 25064 | @value{GDBN} has connected to a remote target. |
ef21caaf | 25065 | |
922fbb7b AC |
25066 | @item "^error" "," @var{c-string} |
25067 | @findex ^error | |
25068 | The operation failed. The @code{@var{c-string}} contains the corresponding | |
25069 | error message. | |
ef21caaf NR |
25070 | |
25071 | @item "^exit" | |
25072 | @findex ^exit | |
3f94c067 | 25073 | @value{GDBN} has terminated. |
ef21caaf | 25074 | |
922fbb7b AC |
25075 | @end table |
25076 | ||
25077 | @node GDB/MI Stream Records | |
25078 | @subsection @sc{gdb/mi} Stream Records | |
25079 | ||
25080 | @cindex @sc{gdb/mi}, stream records | |
25081 | @cindex stream records in @sc{gdb/mi} | |
25082 | @value{GDBN} internally maintains a number of output streams: the console, the | |
25083 | target, and the log. The output intended for each of these streams is | |
25084 | funneled through the @sc{gdb/mi} interface using @dfn{stream records}. | |
25085 | ||
25086 | Each stream record begins with a unique @dfn{prefix character} which | |
25087 | identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output | |
25088 | Syntax}). In addition to the prefix, each stream record contains a | |
25089 | @code{@var{string-output}}. This is either raw text (with an implicit new | |
25090 | line) or a quoted C string (which does not contain an implicit newline). | |
25091 | ||
25092 | @table @code | |
25093 | @item "~" @var{string-output} | |
25094 | The console output stream contains text that should be displayed in the | |
25095 | CLI console window. It contains the textual responses to CLI commands. | |
25096 | ||
25097 | @item "@@" @var{string-output} | |
25098 | The target output stream contains any textual output from the running | |
ef21caaf NR |
25099 | target. This is only present when GDB's event loop is truly |
25100 | asynchronous, which is currently only the case for remote targets. | |
922fbb7b AC |
25101 | |
25102 | @item "&" @var{string-output} | |
25103 | The log stream contains debugging messages being produced by @value{GDBN}'s | |
25104 | internals. | |
25105 | @end table | |
25106 | ||
82f68b1c VP |
25107 | @node GDB/MI Async Records |
25108 | @subsection @sc{gdb/mi} Async Records | |
922fbb7b | 25109 | |
82f68b1c VP |
25110 | @cindex async records in @sc{gdb/mi} |
25111 | @cindex @sc{gdb/mi}, async records | |
25112 | @dfn{Async} records are used to notify the @sc{gdb/mi} client of | |
922fbb7b | 25113 | additional changes that have occurred. Those changes can either be a |
82f68b1c | 25114 | consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of |
922fbb7b AC |
25115 | target activity (e.g., target stopped). |
25116 | ||
8eb41542 | 25117 | The following is the list of possible async records: |
922fbb7b AC |
25118 | |
25119 | @table @code | |
034dad6f | 25120 | |
e1ac3328 VP |
25121 | @item *running,thread-id="@var{thread}" |
25122 | The target is now running. The @var{thread} field tells which | |
25123 | specific thread is now running, and can be @samp{all} if all threads | |
25124 | are running. The frontend should assume that no interaction with a | |
25125 | running thread is possible after this notification is produced. | |
25126 | The frontend should not assume that this notification is output | |
25127 | only once for any command. @value{GDBN} may emit this notification | |
25128 | several times, either for different threads, because it cannot resume | |
25129 | all threads together, or even for a single thread, if the thread must | |
25130 | be stepped though some code before letting it run freely. | |
25131 | ||
dc146f7c | 25132 | @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}" |
82f68b1c VP |
25133 | The target has stopped. The @var{reason} field can have one of the |
25134 | following values: | |
034dad6f BR |
25135 | |
25136 | @table @code | |
25137 | @item breakpoint-hit | |
25138 | A breakpoint was reached. | |
25139 | @item watchpoint-trigger | |
25140 | A watchpoint was triggered. | |
25141 | @item read-watchpoint-trigger | |
25142 | A read watchpoint was triggered. | |
25143 | @item access-watchpoint-trigger | |
25144 | An access watchpoint was triggered. | |
25145 | @item function-finished | |
25146 | An -exec-finish or similar CLI command was accomplished. | |
25147 | @item location-reached | |
25148 | An -exec-until or similar CLI command was accomplished. | |
25149 | @item watchpoint-scope | |
25150 | A watchpoint has gone out of scope. | |
25151 | @item end-stepping-range | |
25152 | An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or | |
25153 | similar CLI command was accomplished. | |
25154 | @item exited-signalled | |
25155 | The inferior exited because of a signal. | |
25156 | @item exited | |
25157 | The inferior exited. | |
25158 | @item exited-normally | |
25159 | The inferior exited normally. | |
25160 | @item signal-received | |
25161 | A signal was received by the inferior. | |
922fbb7b AC |
25162 | @end table |
25163 | ||
c3b108f7 VP |
25164 | The @var{id} field identifies the thread that directly caused the stop |
25165 | -- for example by hitting a breakpoint. Depending on whether all-stop | |
25166 | mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either | |
25167 | stop all threads, or only the thread that directly triggered the stop. | |
25168 | If all threads are stopped, the @var{stopped} field will have the | |
25169 | value of @code{"all"}. Otherwise, the value of the @var{stopped} | |
25170 | field will be a list of thread identifiers. Presently, this list will | |
25171 | always include a single thread, but frontend should be prepared to see | |
dc146f7c VP |
25172 | several threads in the list. The @var{core} field reports the |
25173 | processor core on which the stop event has happened. This field may be absent | |
25174 | if such information is not available. | |
c3b108f7 | 25175 | |
a79b8f6e VP |
25176 | @item =thread-group-added,id="@var{id}" |
25177 | @itemx =thread-group-removed,id="@var{id}" | |
25178 | A thread group was either added or removed. The @var{id} field | |
25179 | contains the @value{GDBN} identifier of the thread group. When a thread | |
25180 | group is added, it generally might not be associated with a running | |
25181 | process. When a thread group is removed, its id becomes invalid and | |
25182 | cannot be used in any way. | |
25183 | ||
25184 | @item =thread-group-started,id="@var{id}",pid="@var{pid}" | |
25185 | A thread group became associated with a running program, | |
25186 | either because the program was just started or the thread group | |
25187 | was attached to a program. The @var{id} field contains the | |
25188 | @value{GDBN} identifier of the thread group. The @var{pid} field | |
25189 | contains process identifier, specific to the operating system. | |
25190 | ||
c3b108f7 | 25191 | @itemx =thread-group-exited,id="@var{id}" |
a79b8f6e VP |
25192 | A thread group is no longer associated with a running program, |
25193 | either because the program has exited, or because it was detached | |
c3b108f7 VP |
25194 | from. The @var{id} field contains the @value{GDBN} identifier of the |
25195 | thread group. | |
25196 | ||
25197 | @item =thread-created,id="@var{id}",group-id="@var{gid}" | |
25198 | @itemx =thread-exited,id="@var{id}",group-id="@var{gid}" | |
82f68b1c | 25199 | A thread either was created, or has exited. The @var{id} field |
c3b108f7 VP |
25200 | contains the @value{GDBN} identifier of the thread. The @var{gid} |
25201 | field identifies the thread group this thread belongs to. | |
66bb093b VP |
25202 | |
25203 | @item =thread-selected,id="@var{id}" | |
25204 | Informs that the selected thread was changed as result of the last | |
25205 | command. This notification is not emitted as result of @code{-thread-select} | |
25206 | command but is emitted whenever an MI command that is not documented | |
25207 | to change the selected thread actually changes it. In particular, | |
25208 | invoking, directly or indirectly (via user-defined command), the CLI | |
25209 | @code{thread} command, will generate this notification. | |
25210 | ||
25211 | We suggest that in response to this notification, front ends | |
25212 | highlight the selected thread and cause subsequent commands to apply to | |
25213 | that thread. | |
25214 | ||
c86cf029 VP |
25215 | @item =library-loaded,... |
25216 | Reports that a new library file was loaded by the program. This | |
25217 | notification has 4 fields---@var{id}, @var{target-name}, | |
134eb42c | 25218 | @var{host-name}, and @var{symbols-loaded}. The @var{id} field is an |
c86cf029 VP |
25219 | opaque identifier of the library. For remote debugging case, |
25220 | @var{target-name} and @var{host-name} fields give the name of the | |
134eb42c VP |
25221 | library file on the target, and on the host respectively. For native |
25222 | debugging, both those fields have the same value. The | |
f1cbe1d3 TT |
25223 | @var{symbols-loaded} field is emitted only for backward compatibility |
25224 | and should not be relied on to convey any useful information. The | |
25225 | @var{thread-group} field, if present, specifies the id of the thread | |
25226 | group in whose context the library was loaded. If the field is | |
25227 | absent, it means the library was loaded in the context of all present | |
25228 | thread groups. | |
c86cf029 VP |
25229 | |
25230 | @item =library-unloaded,... | |
134eb42c | 25231 | Reports that a library was unloaded by the program. This notification |
c86cf029 | 25232 | has 3 fields---@var{id}, @var{target-name} and @var{host-name} with |
a79b8f6e VP |
25233 | the same meaning as for the @code{=library-loaded} notification. |
25234 | The @var{thread-group} field, if present, specifies the id of the | |
25235 | thread group in whose context the library was unloaded. If the field is | |
25236 | absent, it means the library was unloaded in the context of all present | |
25237 | thread groups. | |
c86cf029 | 25238 | |
8d3788bd VP |
25239 | @item =breakpoint-created,bkpt=@{...@} |
25240 | @itemx =breakpoint-modified,bkpt=@{...@} | |
25241 | @itemx =breakpoint-deleted,bkpt=@{...@} | |
25242 | Reports that a breakpoint was created, modified, or deleted, | |
25243 | respectively. Only user-visible breakpoints are reported to the MI | |
25244 | user. | |
25245 | ||
25246 | The @var{bkpt} argument is of the same form as returned by the various | |
25247 | breakpoint commands; @xref{GDB/MI Breakpoint Commands}. | |
25248 | ||
25249 | Note that if a breakpoint is emitted in the result record of a | |
25250 | command, then it will not also be emitted in an async record. | |
25251 | ||
82f68b1c VP |
25252 | @end table |
25253 | ||
c3b108f7 VP |
25254 | @node GDB/MI Frame Information |
25255 | @subsection @sc{gdb/mi} Frame Information | |
25256 | ||
25257 | Response from many MI commands includes an information about stack | |
25258 | frame. This information is a tuple that may have the following | |
25259 | fields: | |
25260 | ||
25261 | @table @code | |
25262 | @item level | |
25263 | The level of the stack frame. The innermost frame has the level of | |
25264 | zero. This field is always present. | |
25265 | ||
25266 | @item func | |
25267 | The name of the function corresponding to the frame. This field may | |
25268 | be absent if @value{GDBN} is unable to determine the function name. | |
25269 | ||
25270 | @item addr | |
25271 | The code address for the frame. This field is always present. | |
25272 | ||
25273 | @item file | |
25274 | The name of the source files that correspond to the frame's code | |
25275 | address. This field may be absent. | |
25276 | ||
25277 | @item line | |
25278 | The source line corresponding to the frames' code address. This field | |
25279 | may be absent. | |
25280 | ||
25281 | @item from | |
25282 | The name of the binary file (either executable or shared library) the | |
25283 | corresponds to the frame's code address. This field may be absent. | |
25284 | ||
25285 | @end table | |
82f68b1c | 25286 | |
dc146f7c VP |
25287 | @node GDB/MI Thread Information |
25288 | @subsection @sc{gdb/mi} Thread Information | |
25289 | ||
25290 | Whenever @value{GDBN} has to report an information about a thread, it | |
25291 | uses a tuple with the following fields: | |
25292 | ||
25293 | @table @code | |
25294 | @item id | |
25295 | The numeric id assigned to the thread by @value{GDBN}. This field is | |
25296 | always present. | |
25297 | ||
25298 | @item target-id | |
25299 | Target-specific string identifying the thread. This field is always present. | |
25300 | ||
25301 | @item details | |
25302 | Additional information about the thread provided by the target. | |
25303 | It is supposed to be human-readable and not interpreted by the | |
25304 | frontend. This field is optional. | |
25305 | ||
25306 | @item state | |
25307 | Either @samp{stopped} or @samp{running}, depending on whether the | |
25308 | thread is presently running. This field is always present. | |
25309 | ||
25310 | @item core | |
25311 | The value of this field is an integer number of the processor core the | |
25312 | thread was last seen on. This field is optional. | |
25313 | @end table | |
25314 | ||
956a9fb9 JB |
25315 | @node GDB/MI Ada Exception Information |
25316 | @subsection @sc{gdb/mi} Ada Exception Information | |
25317 | ||
25318 | Whenever a @code{*stopped} record is emitted because the program | |
25319 | stopped after hitting an exception catchpoint (@pxref{Set Catchpoints}), | |
25320 | @value{GDBN} provides the name of the exception that was raised via | |
25321 | the @code{exception-name} field. | |
922fbb7b | 25322 | |
ef21caaf NR |
25323 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25324 | @node GDB/MI Simple Examples | |
25325 | @section Simple Examples of @sc{gdb/mi} Interaction | |
25326 | @cindex @sc{gdb/mi}, simple examples | |
25327 | ||
25328 | This subsection presents several simple examples of interaction using | |
25329 | the @sc{gdb/mi} interface. In these examples, @samp{->} means that the | |
25330 | following line is passed to @sc{gdb/mi} as input, while @samp{<-} means | |
25331 | the output received from @sc{gdb/mi}. | |
25332 | ||
d3e8051b | 25333 | Note the line breaks shown in the examples are here only for |
ef21caaf NR |
25334 | readability, they don't appear in the real output. |
25335 | ||
79a6e687 | 25336 | @subheading Setting a Breakpoint |
ef21caaf NR |
25337 | |
25338 | Setting a breakpoint generates synchronous output which contains detailed | |
25339 | information of the breakpoint. | |
25340 | ||
25341 | @smallexample | |
25342 | -> -break-insert main | |
25343 | <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep", | |
25344 | enabled="y",addr="0x08048564",func="main",file="myprog.c", | |
25345 | fullname="/home/nickrob/myprog.c",line="68",times="0"@} | |
25346 | <- (gdb) | |
25347 | @end smallexample | |
25348 | ||
25349 | @subheading Program Execution | |
25350 | ||
25351 | Program execution generates asynchronous records and MI gives the | |
25352 | reason that execution stopped. | |
25353 | ||
25354 | @smallexample | |
25355 | -> -exec-run | |
25356 | <- ^running | |
25357 | <- (gdb) | |
a47ec5fe | 25358 | <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0", |
ef21caaf NR |
25359 | frame=@{addr="0x08048564",func="main", |
25360 | args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}], | |
25361 | file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@} | |
25362 | <- (gdb) | |
25363 | -> -exec-continue | |
25364 | <- ^running | |
25365 | <- (gdb) | |
25366 | <- *stopped,reason="exited-normally" | |
25367 | <- (gdb) | |
25368 | @end smallexample | |
25369 | ||
3f94c067 | 25370 | @subheading Quitting @value{GDBN} |
ef21caaf | 25371 | |
3f94c067 | 25372 | Quitting @value{GDBN} just prints the result class @samp{^exit}. |
ef21caaf NR |
25373 | |
25374 | @smallexample | |
25375 | -> (gdb) | |
25376 | <- -gdb-exit | |
25377 | <- ^exit | |
25378 | @end smallexample | |
25379 | ||
a6b29f87 VP |
25380 | Please note that @samp{^exit} is printed immediately, but it might |
25381 | take some time for @value{GDBN} to actually exit. During that time, @value{GDBN} | |
25382 | performs necessary cleanups, including killing programs being debugged | |
25383 | or disconnecting from debug hardware, so the frontend should wait till | |
25384 | @value{GDBN} exits and should only forcibly kill @value{GDBN} if it | |
25385 | fails to exit in reasonable time. | |
25386 | ||
a2c02241 | 25387 | @subheading A Bad Command |
ef21caaf NR |
25388 | |
25389 | Here's what happens if you pass a non-existent command: | |
25390 | ||
25391 | @smallexample | |
25392 | -> -rubbish | |
25393 | <- ^error,msg="Undefined MI command: rubbish" | |
594fe323 | 25394 | <- (gdb) |
ef21caaf NR |
25395 | @end smallexample |
25396 | ||
25397 | ||
922fbb7b AC |
25398 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25399 | @node GDB/MI Command Description Format | |
25400 | @section @sc{gdb/mi} Command Description Format | |
25401 | ||
25402 | The remaining sections describe blocks of commands. Each block of | |
25403 | commands is laid out in a fashion similar to this section. | |
25404 | ||
922fbb7b AC |
25405 | @subheading Motivation |
25406 | ||
25407 | The motivation for this collection of commands. | |
25408 | ||
25409 | @subheading Introduction | |
25410 | ||
25411 | A brief introduction to this collection of commands as a whole. | |
25412 | ||
25413 | @subheading Commands | |
25414 | ||
25415 | For each command in the block, the following is described: | |
25416 | ||
25417 | @subsubheading Synopsis | |
25418 | ||
25419 | @smallexample | |
25420 | -command @var{args}@dots{} | |
25421 | @end smallexample | |
25422 | ||
922fbb7b AC |
25423 | @subsubheading Result |
25424 | ||
265eeb58 | 25425 | @subsubheading @value{GDBN} Command |
922fbb7b | 25426 | |
265eeb58 | 25427 | The corresponding @value{GDBN} CLI command(s), if any. |
922fbb7b AC |
25428 | |
25429 | @subsubheading Example | |
25430 | ||
ef21caaf NR |
25431 | Example(s) formatted for readability. Some of the described commands have |
25432 | not been implemented yet and these are labeled N.A.@: (not available). | |
25433 | ||
25434 | ||
922fbb7b | 25435 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
ef21caaf NR |
25436 | @node GDB/MI Breakpoint Commands |
25437 | @section @sc{gdb/mi} Breakpoint Commands | |
922fbb7b AC |
25438 | |
25439 | @cindex breakpoint commands for @sc{gdb/mi} | |
25440 | @cindex @sc{gdb/mi}, breakpoint commands | |
25441 | This section documents @sc{gdb/mi} commands for manipulating | |
25442 | breakpoints. | |
25443 | ||
25444 | @subheading The @code{-break-after} Command | |
25445 | @findex -break-after | |
25446 | ||
25447 | @subsubheading Synopsis | |
25448 | ||
25449 | @smallexample | |
25450 | -break-after @var{number} @var{count} | |
25451 | @end smallexample | |
25452 | ||
25453 | The breakpoint number @var{number} is not in effect until it has been | |
25454 | hit @var{count} times. To see how this is reflected in the output of | |
25455 | the @samp{-break-list} command, see the description of the | |
25456 | @samp{-break-list} command below. | |
25457 | ||
25458 | @subsubheading @value{GDBN} Command | |
25459 | ||
25460 | The corresponding @value{GDBN} command is @samp{ignore}. | |
25461 | ||
25462 | @subsubheading Example | |
25463 | ||
25464 | @smallexample | |
594fe323 | 25465 | (gdb) |
922fbb7b | 25466 | -break-insert main |
a47ec5fe AR |
25467 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep", |
25468 | enabled="y",addr="0x000100d0",func="main",file="hello.c", | |
948d5102 | 25469 | fullname="/home/foo/hello.c",line="5",times="0"@} |
594fe323 | 25470 | (gdb) |
922fbb7b AC |
25471 | -break-after 1 3 |
25472 | ~ | |
25473 | ^done | |
594fe323 | 25474 | (gdb) |
922fbb7b AC |
25475 | -break-list |
25476 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
25477 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25478 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25479 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25480 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25481 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25482 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25483 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
25484 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
25485 | line="5",times="0",ignore="3"@}]@} | |
594fe323 | 25486 | (gdb) |
922fbb7b AC |
25487 | @end smallexample |
25488 | ||
25489 | @ignore | |
25490 | @subheading The @code{-break-catch} Command | |
25491 | @findex -break-catch | |
48cb2d85 | 25492 | @end ignore |
922fbb7b AC |
25493 | |
25494 | @subheading The @code{-break-commands} Command | |
25495 | @findex -break-commands | |
922fbb7b | 25496 | |
48cb2d85 VP |
25497 | @subsubheading Synopsis |
25498 | ||
25499 | @smallexample | |
25500 | -break-commands @var{number} [ @var{command1} ... @var{commandN} ] | |
25501 | @end smallexample | |
25502 | ||
25503 | Specifies the CLI commands that should be executed when breakpoint | |
25504 | @var{number} is hit. The parameters @var{command1} to @var{commandN} | |
25505 | are the commands. If no command is specified, any previously-set | |
25506 | commands are cleared. @xref{Break Commands}. Typical use of this | |
25507 | functionality is tracing a program, that is, printing of values of | |
25508 | some variables whenever breakpoint is hit and then continuing. | |
25509 | ||
25510 | @subsubheading @value{GDBN} Command | |
25511 | ||
25512 | The corresponding @value{GDBN} command is @samp{commands}. | |
25513 | ||
25514 | @subsubheading Example | |
25515 | ||
25516 | @smallexample | |
25517 | (gdb) | |
25518 | -break-insert main | |
25519 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep", | |
25520 | enabled="y",addr="0x000100d0",func="main",file="hello.c", | |
25521 | fullname="/home/foo/hello.c",line="5",times="0"@} | |
25522 | (gdb) | |
25523 | -break-commands 1 "print v" "continue" | |
25524 | ^done | |
25525 | (gdb) | |
25526 | @end smallexample | |
922fbb7b AC |
25527 | |
25528 | @subheading The @code{-break-condition} Command | |
25529 | @findex -break-condition | |
25530 | ||
25531 | @subsubheading Synopsis | |
25532 | ||
25533 | @smallexample | |
25534 | -break-condition @var{number} @var{expr} | |
25535 | @end smallexample | |
25536 | ||
25537 | Breakpoint @var{number} will stop the program only if the condition in | |
25538 | @var{expr} is true. The condition becomes part of the | |
25539 | @samp{-break-list} output (see the description of the @samp{-break-list} | |
25540 | command below). | |
25541 | ||
25542 | @subsubheading @value{GDBN} Command | |
25543 | ||
25544 | The corresponding @value{GDBN} command is @samp{condition}. | |
25545 | ||
25546 | @subsubheading Example | |
25547 | ||
25548 | @smallexample | |
594fe323 | 25549 | (gdb) |
922fbb7b AC |
25550 | -break-condition 1 1 |
25551 | ^done | |
594fe323 | 25552 | (gdb) |
922fbb7b AC |
25553 | -break-list |
25554 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
25555 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25556 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25557 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25558 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25559 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25560 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25561 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
25562 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
25563 | line="5",cond="1",times="0",ignore="3"@}]@} | |
594fe323 | 25564 | (gdb) |
922fbb7b AC |
25565 | @end smallexample |
25566 | ||
25567 | @subheading The @code{-break-delete} Command | |
25568 | @findex -break-delete | |
25569 | ||
25570 | @subsubheading Synopsis | |
25571 | ||
25572 | @smallexample | |
25573 | -break-delete ( @var{breakpoint} )+ | |
25574 | @end smallexample | |
25575 | ||
25576 | Delete the breakpoint(s) whose number(s) are specified in the argument | |
25577 | list. This is obviously reflected in the breakpoint list. | |
25578 | ||
79a6e687 | 25579 | @subsubheading @value{GDBN} Command |
922fbb7b AC |
25580 | |
25581 | The corresponding @value{GDBN} command is @samp{delete}. | |
25582 | ||
25583 | @subsubheading Example | |
25584 | ||
25585 | @smallexample | |
594fe323 | 25586 | (gdb) |
922fbb7b AC |
25587 | -break-delete 1 |
25588 | ^done | |
594fe323 | 25589 | (gdb) |
922fbb7b AC |
25590 | -break-list |
25591 | ^done,BreakpointTable=@{nr_rows="0",nr_cols="6", | |
25592 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25593 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25594 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25595 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25596 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25597 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25598 | body=[]@} | |
594fe323 | 25599 | (gdb) |
922fbb7b AC |
25600 | @end smallexample |
25601 | ||
25602 | @subheading The @code{-break-disable} Command | |
25603 | @findex -break-disable | |
25604 | ||
25605 | @subsubheading Synopsis | |
25606 | ||
25607 | @smallexample | |
25608 | -break-disable ( @var{breakpoint} )+ | |
25609 | @end smallexample | |
25610 | ||
25611 | Disable the named @var{breakpoint}(s). The field @samp{enabled} in the | |
25612 | break list is now set to @samp{n} for the named @var{breakpoint}(s). | |
25613 | ||
25614 | @subsubheading @value{GDBN} Command | |
25615 | ||
25616 | The corresponding @value{GDBN} command is @samp{disable}. | |
25617 | ||
25618 | @subsubheading Example | |
25619 | ||
25620 | @smallexample | |
594fe323 | 25621 | (gdb) |
922fbb7b AC |
25622 | -break-disable 2 |
25623 | ^done | |
594fe323 | 25624 | (gdb) |
922fbb7b AC |
25625 | -break-list |
25626 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
25627 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25628 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25629 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25630 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25631 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25632 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25633 | body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n", | |
948d5102 NR |
25634 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
25635 | line="5",times="0"@}]@} | |
594fe323 | 25636 | (gdb) |
922fbb7b AC |
25637 | @end smallexample |
25638 | ||
25639 | @subheading The @code{-break-enable} Command | |
25640 | @findex -break-enable | |
25641 | ||
25642 | @subsubheading Synopsis | |
25643 | ||
25644 | @smallexample | |
25645 | -break-enable ( @var{breakpoint} )+ | |
25646 | @end smallexample | |
25647 | ||
25648 | Enable (previously disabled) @var{breakpoint}(s). | |
25649 | ||
25650 | @subsubheading @value{GDBN} Command | |
25651 | ||
25652 | The corresponding @value{GDBN} command is @samp{enable}. | |
25653 | ||
25654 | @subsubheading Example | |
25655 | ||
25656 | @smallexample | |
594fe323 | 25657 | (gdb) |
922fbb7b AC |
25658 | -break-enable 2 |
25659 | ^done | |
594fe323 | 25660 | (gdb) |
922fbb7b AC |
25661 | -break-list |
25662 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
25663 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25664 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25665 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25666 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25667 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25668 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25669 | body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
25670 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
25671 | line="5",times="0"@}]@} | |
594fe323 | 25672 | (gdb) |
922fbb7b AC |
25673 | @end smallexample |
25674 | ||
25675 | @subheading The @code{-break-info} Command | |
25676 | @findex -break-info | |
25677 | ||
25678 | @subsubheading Synopsis | |
25679 | ||
25680 | @smallexample | |
25681 | -break-info @var{breakpoint} | |
25682 | @end smallexample | |
25683 | ||
25684 | @c REDUNDANT??? | |
25685 | Get information about a single breakpoint. | |
25686 | ||
79a6e687 | 25687 | @subsubheading @value{GDBN} Command |
922fbb7b AC |
25688 | |
25689 | The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}. | |
25690 | ||
25691 | @subsubheading Example | |
25692 | N.A. | |
25693 | ||
25694 | @subheading The @code{-break-insert} Command | |
25695 | @findex -break-insert | |
25696 | ||
25697 | @subsubheading Synopsis | |
25698 | ||
25699 | @smallexample | |
18148017 | 25700 | -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ] |
922fbb7b | 25701 | [ -c @var{condition} ] [ -i @var{ignore-count} ] |
afe8ab22 | 25702 | [ -p @var{thread} ] [ @var{location} ] |
922fbb7b AC |
25703 | @end smallexample |
25704 | ||
25705 | @noindent | |
afe8ab22 | 25706 | If specified, @var{location}, can be one of: |
922fbb7b AC |
25707 | |
25708 | @itemize @bullet | |
25709 | @item function | |
25710 | @c @item +offset | |
25711 | @c @item -offset | |
25712 | @c @item linenum | |
25713 | @item filename:linenum | |
25714 | @item filename:function | |
25715 | @item *address | |
25716 | @end itemize | |
25717 | ||
25718 | The possible optional parameters of this command are: | |
25719 | ||
25720 | @table @samp | |
25721 | @item -t | |
948d5102 | 25722 | Insert a temporary breakpoint. |
922fbb7b AC |
25723 | @item -h |
25724 | Insert a hardware breakpoint. | |
25725 | @item -c @var{condition} | |
25726 | Make the breakpoint conditional on @var{condition}. | |
25727 | @item -i @var{ignore-count} | |
25728 | Initialize the @var{ignore-count}. | |
afe8ab22 VP |
25729 | @item -f |
25730 | If @var{location} cannot be parsed (for example if it | |
25731 | refers to unknown files or functions), create a pending | |
25732 | breakpoint. Without this flag, @value{GDBN} will report | |
25733 | an error, and won't create a breakpoint, if @var{location} | |
25734 | cannot be parsed. | |
41447f92 VP |
25735 | @item -d |
25736 | Create a disabled breakpoint. | |
18148017 VP |
25737 | @item -a |
25738 | Create a tracepoint. @xref{Tracepoints}. When this parameter | |
25739 | is used together with @samp{-h}, a fast tracepoint is created. | |
922fbb7b AC |
25740 | @end table |
25741 | ||
25742 | @subsubheading Result | |
25743 | ||
25744 | The result is in the form: | |
25745 | ||
25746 | @smallexample | |
948d5102 NR |
25747 | ^done,bkpt=@{number="@var{number}",type="@var{type}",disp="del"|"keep", |
25748 | enabled="y"|"n",addr="@var{hex}",func="@var{funcname}",file="@var{filename}", | |
ef21caaf NR |
25749 | fullname="@var{full_filename}",line="@var{lineno}",[thread="@var{threadno},] |
25750 | times="@var{times}"@} | |
922fbb7b AC |
25751 | @end smallexample |
25752 | ||
25753 | @noindent | |
948d5102 NR |
25754 | where @var{number} is the @value{GDBN} number for this breakpoint, |
25755 | @var{funcname} is the name of the function where the breakpoint was | |
25756 | inserted, @var{filename} is the name of the source file which contains | |
25757 | this function, @var{lineno} is the source line number within that file | |
25758 | and @var{times} the number of times that the breakpoint has been hit | |
25759 | (always 0 for -break-insert but may be greater for -break-info or -break-list | |
25760 | which use the same output). | |
922fbb7b AC |
25761 | |
25762 | Note: this format is open to change. | |
25763 | @c An out-of-band breakpoint instead of part of the result? | |
25764 | ||
25765 | @subsubheading @value{GDBN} Command | |
25766 | ||
25767 | The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak}, | |
25768 | @samp{hbreak}, @samp{thbreak}, and @samp{rbreak}. | |
25769 | ||
25770 | @subsubheading Example | |
25771 | ||
25772 | @smallexample | |
594fe323 | 25773 | (gdb) |
922fbb7b | 25774 | -break-insert main |
948d5102 NR |
25775 | ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c", |
25776 | fullname="/home/foo/recursive2.c,line="4",times="0"@} | |
594fe323 | 25777 | (gdb) |
922fbb7b | 25778 | -break-insert -t foo |
948d5102 NR |
25779 | ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c", |
25780 | fullname="/home/foo/recursive2.c,line="11",times="0"@} | |
594fe323 | 25781 | (gdb) |
922fbb7b AC |
25782 | -break-list |
25783 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
25784 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25785 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25786 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25787 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25788 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25789 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25790 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
25791 | addr="0x0001072c", func="main",file="recursive2.c", |
25792 | fullname="/home/foo/recursive2.c,"line="4",times="0"@}, | |
922fbb7b | 25793 | bkpt=@{number="2",type="breakpoint",disp="del",enabled="y", |
948d5102 NR |
25794 | addr="0x00010774",func="foo",file="recursive2.c", |
25795 | fullname="/home/foo/recursive2.c",line="11",times="0"@}]@} | |
594fe323 | 25796 | (gdb) |
922fbb7b AC |
25797 | -break-insert -r foo.* |
25798 | ~int foo(int, int); | |
948d5102 NR |
25799 | ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c, |
25800 | "fullname="/home/foo/recursive2.c",line="11",times="0"@} | |
594fe323 | 25801 | (gdb) |
922fbb7b AC |
25802 | @end smallexample |
25803 | ||
25804 | @subheading The @code{-break-list} Command | |
25805 | @findex -break-list | |
25806 | ||
25807 | @subsubheading Synopsis | |
25808 | ||
25809 | @smallexample | |
25810 | -break-list | |
25811 | @end smallexample | |
25812 | ||
25813 | Displays the list of inserted breakpoints, showing the following fields: | |
25814 | ||
25815 | @table @samp | |
25816 | @item Number | |
25817 | number of the breakpoint | |
25818 | @item Type | |
25819 | type of the breakpoint: @samp{breakpoint} or @samp{watchpoint} | |
25820 | @item Disposition | |
25821 | should the breakpoint be deleted or disabled when it is hit: @samp{keep} | |
25822 | or @samp{nokeep} | |
25823 | @item Enabled | |
25824 | is the breakpoint enabled or no: @samp{y} or @samp{n} | |
25825 | @item Address | |
25826 | memory location at which the breakpoint is set | |
25827 | @item What | |
25828 | logical location of the breakpoint, expressed by function name, file | |
25829 | name, line number | |
25830 | @item Times | |
25831 | number of times the breakpoint has been hit | |
25832 | @end table | |
25833 | ||
25834 | If there are no breakpoints or watchpoints, the @code{BreakpointTable} | |
25835 | @code{body} field is an empty list. | |
25836 | ||
25837 | @subsubheading @value{GDBN} Command | |
25838 | ||
25839 | The corresponding @value{GDBN} command is @samp{info break}. | |
25840 | ||
25841 | @subsubheading Example | |
25842 | ||
25843 | @smallexample | |
594fe323 | 25844 | (gdb) |
922fbb7b AC |
25845 | -break-list |
25846 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
25847 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25848 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25849 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25850 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25851 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25852 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25853 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
25854 | addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}, | |
25855 | bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
25856 | addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c", |
25857 | line="13",times="0"@}]@} | |
594fe323 | 25858 | (gdb) |
922fbb7b AC |
25859 | @end smallexample |
25860 | ||
25861 | Here's an example of the result when there are no breakpoints: | |
25862 | ||
25863 | @smallexample | |
594fe323 | 25864 | (gdb) |
922fbb7b AC |
25865 | -break-list |
25866 | ^done,BreakpointTable=@{nr_rows="0",nr_cols="6", | |
25867 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25868 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25869 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25870 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25871 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25872 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25873 | body=[]@} | |
594fe323 | 25874 | (gdb) |
922fbb7b AC |
25875 | @end smallexample |
25876 | ||
18148017 VP |
25877 | @subheading The @code{-break-passcount} Command |
25878 | @findex -break-passcount | |
25879 | ||
25880 | @subsubheading Synopsis | |
25881 | ||
25882 | @smallexample | |
25883 | -break-passcount @var{tracepoint-number} @var{passcount} | |
25884 | @end smallexample | |
25885 | ||
25886 | Set the passcount for tracepoint @var{tracepoint-number} to | |
25887 | @var{passcount}. If the breakpoint referred to by @var{tracepoint-number} | |
25888 | is not a tracepoint, error is emitted. This corresponds to CLI | |
25889 | command @samp{passcount}. | |
25890 | ||
922fbb7b AC |
25891 | @subheading The @code{-break-watch} Command |
25892 | @findex -break-watch | |
25893 | ||
25894 | @subsubheading Synopsis | |
25895 | ||
25896 | @smallexample | |
25897 | -break-watch [ -a | -r ] | |
25898 | @end smallexample | |
25899 | ||
25900 | Create a watchpoint. With the @samp{-a} option it will create an | |
d3e8051b | 25901 | @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a |
922fbb7b | 25902 | read from or on a write to the memory location. With the @samp{-r} |
d3e8051b | 25903 | option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will |
922fbb7b AC |
25904 | trigger only when the memory location is accessed for reading. Without |
25905 | either of the options, the watchpoint created is a regular watchpoint, | |
d3e8051b | 25906 | i.e., it will trigger when the memory location is accessed for writing. |
79a6e687 | 25907 | @xref{Set Watchpoints, , Setting Watchpoints}. |
922fbb7b AC |
25908 | |
25909 | Note that @samp{-break-list} will report a single list of watchpoints and | |
25910 | breakpoints inserted. | |
25911 | ||
25912 | @subsubheading @value{GDBN} Command | |
25913 | ||
25914 | The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and | |
25915 | @samp{rwatch}. | |
25916 | ||
25917 | @subsubheading Example | |
25918 | ||
25919 | Setting a watchpoint on a variable in the @code{main} function: | |
25920 | ||
25921 | @smallexample | |
594fe323 | 25922 | (gdb) |
922fbb7b AC |
25923 | -break-watch x |
25924 | ^done,wpt=@{number="2",exp="x"@} | |
594fe323 | 25925 | (gdb) |
922fbb7b AC |
25926 | -exec-continue |
25927 | ^running | |
0869d01b NR |
25928 | (gdb) |
25929 | *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@}, | |
922fbb7b | 25930 | value=@{old="-268439212",new="55"@}, |
76ff342d | 25931 | frame=@{func="main",args=[],file="recursive2.c", |
948d5102 | 25932 | fullname="/home/foo/bar/recursive2.c",line="5"@} |
594fe323 | 25933 | (gdb) |
922fbb7b AC |
25934 | @end smallexample |
25935 | ||
25936 | Setting a watchpoint on a variable local to a function. @value{GDBN} will stop | |
25937 | the program execution twice: first for the variable changing value, then | |
25938 | for the watchpoint going out of scope. | |
25939 | ||
25940 | @smallexample | |
594fe323 | 25941 | (gdb) |
922fbb7b AC |
25942 | -break-watch C |
25943 | ^done,wpt=@{number="5",exp="C"@} | |
594fe323 | 25944 | (gdb) |
922fbb7b AC |
25945 | -exec-continue |
25946 | ^running | |
0869d01b NR |
25947 | (gdb) |
25948 | *stopped,reason="watchpoint-trigger", | |
922fbb7b AC |
25949 | wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@}, |
25950 | frame=@{func="callee4",args=[], | |
76ff342d DJ |
25951 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
25952 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@} | |
594fe323 | 25953 | (gdb) |
922fbb7b AC |
25954 | -exec-continue |
25955 | ^running | |
0869d01b NR |
25956 | (gdb) |
25957 | *stopped,reason="watchpoint-scope",wpnum="5", | |
922fbb7b AC |
25958 | frame=@{func="callee3",args=[@{name="strarg", |
25959 | value="0x11940 \"A string argument.\""@}], | |
76ff342d DJ |
25960 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
25961 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} | |
594fe323 | 25962 | (gdb) |
922fbb7b AC |
25963 | @end smallexample |
25964 | ||
25965 | Listing breakpoints and watchpoints, at different points in the program | |
25966 | execution. Note that once the watchpoint goes out of scope, it is | |
25967 | deleted. | |
25968 | ||
25969 | @smallexample | |
594fe323 | 25970 | (gdb) |
922fbb7b AC |
25971 | -break-watch C |
25972 | ^done,wpt=@{number="2",exp="C"@} | |
594fe323 | 25973 | (gdb) |
922fbb7b AC |
25974 | -break-list |
25975 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
25976 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
25977 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
25978 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
25979 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
25980 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
25981 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
25982 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
25983 | addr="0x00010734",func="callee4", | |
948d5102 NR |
25984 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
25985 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",times="1"@}, | |
922fbb7b AC |
25986 | bkpt=@{number="2",type="watchpoint",disp="keep", |
25987 | enabled="y",addr="",what="C",times="0"@}]@} | |
594fe323 | 25988 | (gdb) |
922fbb7b AC |
25989 | -exec-continue |
25990 | ^running | |
0869d01b NR |
25991 | (gdb) |
25992 | *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@}, | |
922fbb7b AC |
25993 | value=@{old="-276895068",new="3"@}, |
25994 | frame=@{func="callee4",args=[], | |
76ff342d DJ |
25995 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
25996 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@} | |
594fe323 | 25997 | (gdb) |
922fbb7b AC |
25998 | -break-list |
25999 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
26000 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26001 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26002 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26003 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26004 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26005 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26006 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
26007 | addr="0x00010734",func="callee4", | |
948d5102 NR |
26008 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26009 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"@}, | |
922fbb7b AC |
26010 | bkpt=@{number="2",type="watchpoint",disp="keep", |
26011 | enabled="y",addr="",what="C",times="-5"@}]@} | |
594fe323 | 26012 | (gdb) |
922fbb7b AC |
26013 | -exec-continue |
26014 | ^running | |
26015 | ^done,reason="watchpoint-scope",wpnum="2", | |
26016 | frame=@{func="callee3",args=[@{name="strarg", | |
26017 | value="0x11940 \"A string argument.\""@}], | |
76ff342d DJ |
26018 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26019 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} | |
594fe323 | 26020 | (gdb) |
922fbb7b AC |
26021 | -break-list |
26022 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
26023 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26024 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26025 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26026 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26027 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26028 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26029 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
26030 | addr="0x00010734",func="callee4", | |
948d5102 NR |
26031 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26032 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8", | |
26033 | times="1"@}]@} | |
594fe323 | 26034 | (gdb) |
922fbb7b AC |
26035 | @end smallexample |
26036 | ||
26037 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
a2c02241 NR |
26038 | @node GDB/MI Program Context |
26039 | @section @sc{gdb/mi} Program Context | |
922fbb7b | 26040 | |
a2c02241 NR |
26041 | @subheading The @code{-exec-arguments} Command |
26042 | @findex -exec-arguments | |
922fbb7b | 26043 | |
922fbb7b AC |
26044 | |
26045 | @subsubheading Synopsis | |
26046 | ||
26047 | @smallexample | |
a2c02241 | 26048 | -exec-arguments @var{args} |
922fbb7b AC |
26049 | @end smallexample |
26050 | ||
a2c02241 NR |
26051 | Set the inferior program arguments, to be used in the next |
26052 | @samp{-exec-run}. | |
922fbb7b | 26053 | |
a2c02241 | 26054 | @subsubheading @value{GDBN} Command |
922fbb7b | 26055 | |
a2c02241 | 26056 | The corresponding @value{GDBN} command is @samp{set args}. |
922fbb7b | 26057 | |
a2c02241 | 26058 | @subsubheading Example |
922fbb7b | 26059 | |
fbc5282e MK |
26060 | @smallexample |
26061 | (gdb) | |
26062 | -exec-arguments -v word | |
26063 | ^done | |
26064 | (gdb) | |
26065 | @end smallexample | |
922fbb7b | 26066 | |
a2c02241 | 26067 | |
9901a55b | 26068 | @ignore |
a2c02241 NR |
26069 | @subheading The @code{-exec-show-arguments} Command |
26070 | @findex -exec-show-arguments | |
26071 | ||
26072 | @subsubheading Synopsis | |
26073 | ||
26074 | @smallexample | |
26075 | -exec-show-arguments | |
26076 | @end smallexample | |
26077 | ||
26078 | Print the arguments of the program. | |
922fbb7b AC |
26079 | |
26080 | @subsubheading @value{GDBN} Command | |
26081 | ||
a2c02241 | 26082 | The corresponding @value{GDBN} command is @samp{show args}. |
922fbb7b AC |
26083 | |
26084 | @subsubheading Example | |
a2c02241 | 26085 | N.A. |
9901a55b | 26086 | @end ignore |
922fbb7b | 26087 | |
922fbb7b | 26088 | |
a2c02241 NR |
26089 | @subheading The @code{-environment-cd} Command |
26090 | @findex -environment-cd | |
922fbb7b | 26091 | |
a2c02241 | 26092 | @subsubheading Synopsis |
922fbb7b AC |
26093 | |
26094 | @smallexample | |
a2c02241 | 26095 | -environment-cd @var{pathdir} |
922fbb7b AC |
26096 | @end smallexample |
26097 | ||
a2c02241 | 26098 | Set @value{GDBN}'s working directory. |
922fbb7b | 26099 | |
a2c02241 | 26100 | @subsubheading @value{GDBN} Command |
922fbb7b | 26101 | |
a2c02241 NR |
26102 | The corresponding @value{GDBN} command is @samp{cd}. |
26103 | ||
26104 | @subsubheading Example | |
922fbb7b AC |
26105 | |
26106 | @smallexample | |
594fe323 | 26107 | (gdb) |
a2c02241 NR |
26108 | -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb |
26109 | ^done | |
594fe323 | 26110 | (gdb) |
922fbb7b AC |
26111 | @end smallexample |
26112 | ||
26113 | ||
a2c02241 NR |
26114 | @subheading The @code{-environment-directory} Command |
26115 | @findex -environment-directory | |
922fbb7b AC |
26116 | |
26117 | @subsubheading Synopsis | |
26118 | ||
26119 | @smallexample | |
a2c02241 | 26120 | -environment-directory [ -r ] [ @var{pathdir} ]+ |
922fbb7b AC |
26121 | @end smallexample |
26122 | ||
a2c02241 NR |
26123 | Add directories @var{pathdir} to beginning of search path for source files. |
26124 | If the @samp{-r} option is used, the search path is reset to the default | |
26125 | search path. If directories @var{pathdir} are supplied in addition to the | |
26126 | @samp{-r} option, the search path is first reset and then addition | |
26127 | occurs as normal. | |
26128 | Multiple directories may be specified, separated by blanks. Specifying | |
26129 | multiple directories in a single command | |
26130 | results in the directories added to the beginning of the | |
26131 | search path in the same order they were presented in the command. | |
26132 | If blanks are needed as | |
26133 | part of a directory name, double-quotes should be used around | |
26134 | the name. In the command output, the path will show up separated | |
d3e8051b | 26135 | by the system directory-separator character. The directory-separator |
a2c02241 NR |
26136 | character must not be used |
26137 | in any directory name. | |
26138 | If no directories are specified, the current search path is displayed. | |
922fbb7b AC |
26139 | |
26140 | @subsubheading @value{GDBN} Command | |
26141 | ||
a2c02241 | 26142 | The corresponding @value{GDBN} command is @samp{dir}. |
922fbb7b AC |
26143 | |
26144 | @subsubheading Example | |
26145 | ||
922fbb7b | 26146 | @smallexample |
594fe323 | 26147 | (gdb) |
a2c02241 NR |
26148 | -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb |
26149 | ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" | |
594fe323 | 26150 | (gdb) |
a2c02241 NR |
26151 | -environment-directory "" |
26152 | ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" | |
594fe323 | 26153 | (gdb) |
a2c02241 NR |
26154 | -environment-directory -r /home/jjohnstn/src/gdb /usr/src |
26155 | ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd" | |
594fe323 | 26156 | (gdb) |
a2c02241 NR |
26157 | -environment-directory -r |
26158 | ^done,source-path="$cdir:$cwd" | |
594fe323 | 26159 | (gdb) |
922fbb7b AC |
26160 | @end smallexample |
26161 | ||
26162 | ||
a2c02241 NR |
26163 | @subheading The @code{-environment-path} Command |
26164 | @findex -environment-path | |
922fbb7b AC |
26165 | |
26166 | @subsubheading Synopsis | |
26167 | ||
26168 | @smallexample | |
a2c02241 | 26169 | -environment-path [ -r ] [ @var{pathdir} ]+ |
922fbb7b AC |
26170 | @end smallexample |
26171 | ||
a2c02241 NR |
26172 | Add directories @var{pathdir} to beginning of search path for object files. |
26173 | If the @samp{-r} option is used, the search path is reset to the original | |
26174 | search path that existed at gdb start-up. If directories @var{pathdir} are | |
26175 | supplied in addition to the | |
26176 | @samp{-r} option, the search path is first reset and then addition | |
26177 | occurs as normal. | |
26178 | Multiple directories may be specified, separated by blanks. Specifying | |
26179 | multiple directories in a single command | |
26180 | results in the directories added to the beginning of the | |
26181 | search path in the same order they were presented in the command. | |
26182 | If blanks are needed as | |
26183 | part of a directory name, double-quotes should be used around | |
26184 | the name. In the command output, the path will show up separated | |
d3e8051b | 26185 | by the system directory-separator character. The directory-separator |
a2c02241 NR |
26186 | character must not be used |
26187 | in any directory name. | |
26188 | If no directories are specified, the current path is displayed. | |
26189 | ||
922fbb7b AC |
26190 | |
26191 | @subsubheading @value{GDBN} Command | |
26192 | ||
a2c02241 | 26193 | The corresponding @value{GDBN} command is @samp{path}. |
922fbb7b AC |
26194 | |
26195 | @subsubheading Example | |
26196 | ||
922fbb7b | 26197 | @smallexample |
594fe323 | 26198 | (gdb) |
a2c02241 NR |
26199 | -environment-path |
26200 | ^done,path="/usr/bin" | |
594fe323 | 26201 | (gdb) |
a2c02241 NR |
26202 | -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin |
26203 | ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin" | |
594fe323 | 26204 | (gdb) |
a2c02241 NR |
26205 | -environment-path -r /usr/local/bin |
26206 | ^done,path="/usr/local/bin:/usr/bin" | |
594fe323 | 26207 | (gdb) |
922fbb7b AC |
26208 | @end smallexample |
26209 | ||
26210 | ||
a2c02241 NR |
26211 | @subheading The @code{-environment-pwd} Command |
26212 | @findex -environment-pwd | |
922fbb7b AC |
26213 | |
26214 | @subsubheading Synopsis | |
26215 | ||
26216 | @smallexample | |
a2c02241 | 26217 | -environment-pwd |
922fbb7b AC |
26218 | @end smallexample |
26219 | ||
a2c02241 | 26220 | Show the current working directory. |
922fbb7b | 26221 | |
79a6e687 | 26222 | @subsubheading @value{GDBN} Command |
922fbb7b | 26223 | |
a2c02241 | 26224 | The corresponding @value{GDBN} command is @samp{pwd}. |
922fbb7b AC |
26225 | |
26226 | @subsubheading Example | |
26227 | ||
922fbb7b | 26228 | @smallexample |
594fe323 | 26229 | (gdb) |
a2c02241 NR |
26230 | -environment-pwd |
26231 | ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb" | |
594fe323 | 26232 | (gdb) |
922fbb7b AC |
26233 | @end smallexample |
26234 | ||
a2c02241 NR |
26235 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
26236 | @node GDB/MI Thread Commands | |
26237 | @section @sc{gdb/mi} Thread Commands | |
26238 | ||
26239 | ||
26240 | @subheading The @code{-thread-info} Command | |
26241 | @findex -thread-info | |
922fbb7b AC |
26242 | |
26243 | @subsubheading Synopsis | |
26244 | ||
26245 | @smallexample | |
8e8901c5 | 26246 | -thread-info [ @var{thread-id} ] |
922fbb7b AC |
26247 | @end smallexample |
26248 | ||
8e8901c5 VP |
26249 | Reports information about either a specific thread, if |
26250 | the @var{thread-id} parameter is present, or about all | |
26251 | threads. When printing information about all threads, | |
26252 | also reports the current thread. | |
26253 | ||
79a6e687 | 26254 | @subsubheading @value{GDBN} Command |
922fbb7b | 26255 | |
8e8901c5 VP |
26256 | The @samp{info thread} command prints the same information |
26257 | about all threads. | |
922fbb7b | 26258 | |
4694da01 | 26259 | @subsubheading Result |
922fbb7b | 26260 | |
4694da01 TT |
26261 | The result is a list of threads. The following attributes are |
26262 | defined for a given thread: | |
26263 | ||
26264 | @table @samp | |
26265 | @item current | |
26266 | This field exists only for the current thread. It has the value @samp{*}. | |
26267 | ||
26268 | @item id | |
26269 | The identifier that @value{GDBN} uses to refer to the thread. | |
26270 | ||
26271 | @item target-id | |
26272 | The identifier that the target uses to refer to the thread. | |
26273 | ||
26274 | @item details | |
26275 | Extra information about the thread, in a target-specific format. This | |
26276 | field is optional. | |
26277 | ||
26278 | @item name | |
26279 | The name of the thread. If the user specified a name using the | |
26280 | @code{thread name} command, then this name is given. Otherwise, if | |
26281 | @value{GDBN} can extract the thread name from the target, then that | |
26282 | name is given. If @value{GDBN} cannot find the thread name, then this | |
26283 | field is omitted. | |
26284 | ||
26285 | @item frame | |
26286 | The stack frame currently executing in the thread. | |
922fbb7b | 26287 | |
4694da01 TT |
26288 | @item state |
26289 | The thread's state. The @samp{state} field may have the following | |
26290 | values: | |
c3b108f7 VP |
26291 | |
26292 | @table @code | |
26293 | @item stopped | |
26294 | The thread is stopped. Frame information is available for stopped | |
26295 | threads. | |
26296 | ||
26297 | @item running | |
26298 | The thread is running. There's no frame information for running | |
26299 | threads. | |
26300 | ||
26301 | @end table | |
26302 | ||
4694da01 TT |
26303 | @item core |
26304 | If @value{GDBN} can find the CPU core on which this thread is running, | |
26305 | then this field is the core identifier. This field is optional. | |
26306 | ||
26307 | @end table | |
26308 | ||
26309 | @subsubheading Example | |
26310 | ||
26311 | @smallexample | |
26312 | -thread-info | |
26313 | ^done,threads=[ | |
26314 | @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)", | |
26315 | frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall", | |
26316 | args=[]@},state="running"@}, | |
26317 | @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)", | |
26318 | frame=@{level="0",addr="0x0804891f",func="foo", | |
26319 | args=[@{name="i",value="10"@}], | |
26320 | file="/tmp/a.c",fullname="/tmp/a.c",line="158"@}, | |
26321 | state="running"@}], | |
26322 | current-thread-id="1" | |
26323 | (gdb) | |
26324 | @end smallexample | |
26325 | ||
a2c02241 NR |
26326 | @subheading The @code{-thread-list-ids} Command |
26327 | @findex -thread-list-ids | |
922fbb7b | 26328 | |
a2c02241 | 26329 | @subsubheading Synopsis |
922fbb7b | 26330 | |
a2c02241 NR |
26331 | @smallexample |
26332 | -thread-list-ids | |
26333 | @end smallexample | |
922fbb7b | 26334 | |
a2c02241 NR |
26335 | Produces a list of the currently known @value{GDBN} thread ids. At the |
26336 | end of the list it also prints the total number of such threads. | |
922fbb7b | 26337 | |
c3b108f7 VP |
26338 | This command is retained for historical reasons, the |
26339 | @code{-thread-info} command should be used instead. | |
26340 | ||
922fbb7b AC |
26341 | @subsubheading @value{GDBN} Command |
26342 | ||
a2c02241 | 26343 | Part of @samp{info threads} supplies the same information. |
922fbb7b AC |
26344 | |
26345 | @subsubheading Example | |
26346 | ||
922fbb7b | 26347 | @smallexample |
594fe323 | 26348 | (gdb) |
a2c02241 NR |
26349 | -thread-list-ids |
26350 | ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@}, | |
592375cd | 26351 | current-thread-id="1",number-of-threads="3" |
594fe323 | 26352 | (gdb) |
922fbb7b AC |
26353 | @end smallexample |
26354 | ||
a2c02241 NR |
26355 | |
26356 | @subheading The @code{-thread-select} Command | |
26357 | @findex -thread-select | |
922fbb7b AC |
26358 | |
26359 | @subsubheading Synopsis | |
26360 | ||
26361 | @smallexample | |
a2c02241 | 26362 | -thread-select @var{threadnum} |
922fbb7b AC |
26363 | @end smallexample |
26364 | ||
a2c02241 NR |
26365 | Make @var{threadnum} the current thread. It prints the number of the new |
26366 | current thread, and the topmost frame for that thread. | |
922fbb7b | 26367 | |
c3b108f7 VP |
26368 | This command is deprecated in favor of explicitly using the |
26369 | @samp{--thread} option to each command. | |
26370 | ||
922fbb7b AC |
26371 | @subsubheading @value{GDBN} Command |
26372 | ||
a2c02241 | 26373 | The corresponding @value{GDBN} command is @samp{thread}. |
922fbb7b AC |
26374 | |
26375 | @subsubheading Example | |
922fbb7b AC |
26376 | |
26377 | @smallexample | |
594fe323 | 26378 | (gdb) |
a2c02241 NR |
26379 | -exec-next |
26380 | ^running | |
594fe323 | 26381 | (gdb) |
a2c02241 NR |
26382 | *stopped,reason="end-stepping-range",thread-id="2",line="187", |
26383 | file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c" | |
594fe323 | 26384 | (gdb) |
a2c02241 NR |
26385 | -thread-list-ids |
26386 | ^done, | |
26387 | thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@}, | |
26388 | number-of-threads="3" | |
594fe323 | 26389 | (gdb) |
a2c02241 NR |
26390 | -thread-select 3 |
26391 | ^done,new-thread-id="3", | |
26392 | frame=@{level="0",func="vprintf", | |
26393 | args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@}, | |
26394 | @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@} | |
594fe323 | 26395 | (gdb) |
922fbb7b AC |
26396 | @end smallexample |
26397 | ||
a2c02241 NR |
26398 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
26399 | @node GDB/MI Program Execution | |
26400 | @section @sc{gdb/mi} Program Execution | |
922fbb7b | 26401 | |
ef21caaf | 26402 | These are the asynchronous commands which generate the out-of-band |
3f94c067 | 26403 | record @samp{*stopped}. Currently @value{GDBN} only really executes |
ef21caaf NR |
26404 | asynchronously with remote targets and this interaction is mimicked in |
26405 | other cases. | |
922fbb7b | 26406 | |
922fbb7b AC |
26407 | @subheading The @code{-exec-continue} Command |
26408 | @findex -exec-continue | |
26409 | ||
26410 | @subsubheading Synopsis | |
26411 | ||
26412 | @smallexample | |
540aa8e7 | 26413 | -exec-continue [--reverse] [--all|--thread-group N] |
922fbb7b AC |
26414 | @end smallexample |
26415 | ||
540aa8e7 MS |
26416 | Resumes the execution of the inferior program, which will continue |
26417 | to execute until it reaches a debugger stop event. If the | |
26418 | @samp{--reverse} option is specified, execution resumes in reverse until | |
26419 | it reaches a stop event. Stop events may include | |
26420 | @itemize @bullet | |
26421 | @item | |
26422 | breakpoints or watchpoints | |
26423 | @item | |
26424 | signals or exceptions | |
26425 | @item | |
26426 | the end of the process (or its beginning under @samp{--reverse}) | |
26427 | @item | |
26428 | the end or beginning of a replay log if one is being used. | |
26429 | @end itemize | |
26430 | In all-stop mode (@pxref{All-Stop | |
26431 | Mode}), may resume only one thread, or all threads, depending on the | |
26432 | value of the @samp{scheduler-locking} variable. If @samp{--all} is | |
a79b8f6e | 26433 | specified, all threads (in all inferiors) will be resumed. The @samp{--all} option is |
540aa8e7 MS |
26434 | ignored in all-stop mode. If the @samp{--thread-group} options is |
26435 | specified, then all threads in that thread group are resumed. | |
922fbb7b AC |
26436 | |
26437 | @subsubheading @value{GDBN} Command | |
26438 | ||
26439 | The corresponding @value{GDBN} corresponding is @samp{continue}. | |
26440 | ||
26441 | @subsubheading Example | |
26442 | ||
26443 | @smallexample | |
26444 | -exec-continue | |
26445 | ^running | |
594fe323 | 26446 | (gdb) |
922fbb7b | 26447 | @@Hello world |
a47ec5fe AR |
26448 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{ |
26449 | func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c", | |
26450 | line="13"@} | |
594fe323 | 26451 | (gdb) |
922fbb7b AC |
26452 | @end smallexample |
26453 | ||
26454 | ||
26455 | @subheading The @code{-exec-finish} Command | |
26456 | @findex -exec-finish | |
26457 | ||
26458 | @subsubheading Synopsis | |
26459 | ||
26460 | @smallexample | |
540aa8e7 | 26461 | -exec-finish [--reverse] |
922fbb7b AC |
26462 | @end smallexample |
26463 | ||
ef21caaf NR |
26464 | Resumes the execution of the inferior program until the current |
26465 | function is exited. Displays the results returned by the function. | |
540aa8e7 MS |
26466 | If the @samp{--reverse} option is specified, resumes the reverse |
26467 | execution of the inferior program until the point where current | |
26468 | function was called. | |
922fbb7b AC |
26469 | |
26470 | @subsubheading @value{GDBN} Command | |
26471 | ||
26472 | The corresponding @value{GDBN} command is @samp{finish}. | |
26473 | ||
26474 | @subsubheading Example | |
26475 | ||
26476 | Function returning @code{void}. | |
26477 | ||
26478 | @smallexample | |
26479 | -exec-finish | |
26480 | ^running | |
594fe323 | 26481 | (gdb) |
922fbb7b AC |
26482 | @@hello from foo |
26483 | *stopped,reason="function-finished",frame=@{func="main",args=[], | |
948d5102 | 26484 | file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@} |
594fe323 | 26485 | (gdb) |
922fbb7b AC |
26486 | @end smallexample |
26487 | ||
26488 | Function returning other than @code{void}. The name of the internal | |
26489 | @value{GDBN} variable storing the result is printed, together with the | |
26490 | value itself. | |
26491 | ||
26492 | @smallexample | |
26493 | -exec-finish | |
26494 | ^running | |
594fe323 | 26495 | (gdb) |
922fbb7b AC |
26496 | *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo", |
26497 | args=[@{name="a",value="1"],@{name="b",value="9"@}@}, | |
948d5102 | 26498 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
922fbb7b | 26499 | gdb-result-var="$1",return-value="0" |
594fe323 | 26500 | (gdb) |
922fbb7b AC |
26501 | @end smallexample |
26502 | ||
26503 | ||
26504 | @subheading The @code{-exec-interrupt} Command | |
26505 | @findex -exec-interrupt | |
26506 | ||
26507 | @subsubheading Synopsis | |
26508 | ||
26509 | @smallexample | |
c3b108f7 | 26510 | -exec-interrupt [--all|--thread-group N] |
922fbb7b AC |
26511 | @end smallexample |
26512 | ||
ef21caaf NR |
26513 | Interrupts the background execution of the target. Note how the token |
26514 | associated with the stop message is the one for the execution command | |
26515 | that has been interrupted. The token for the interrupt itself only | |
26516 | appears in the @samp{^done} output. If the user is trying to | |
922fbb7b AC |
26517 | interrupt a non-running program, an error message will be printed. |
26518 | ||
c3b108f7 VP |
26519 | Note that when asynchronous execution is enabled, this command is |
26520 | asynchronous just like other execution commands. That is, first the | |
26521 | @samp{^done} response will be printed, and the target stop will be | |
26522 | reported after that using the @samp{*stopped} notification. | |
26523 | ||
26524 | In non-stop mode, only the context thread is interrupted by default. | |
a79b8f6e VP |
26525 | All threads (in all inferiors) will be interrupted if the |
26526 | @samp{--all} option is specified. If the @samp{--thread-group} | |
26527 | option is specified, all threads in that group will be interrupted. | |
c3b108f7 | 26528 | |
922fbb7b AC |
26529 | @subsubheading @value{GDBN} Command |
26530 | ||
26531 | The corresponding @value{GDBN} command is @samp{interrupt}. | |
26532 | ||
26533 | @subsubheading Example | |
26534 | ||
26535 | @smallexample | |
594fe323 | 26536 | (gdb) |
922fbb7b AC |
26537 | 111-exec-continue |
26538 | 111^running | |
26539 | ||
594fe323 | 26540 | (gdb) |
922fbb7b AC |
26541 | 222-exec-interrupt |
26542 | 222^done | |
594fe323 | 26543 | (gdb) |
922fbb7b | 26544 | 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt", |
76ff342d | 26545 | frame=@{addr="0x00010140",func="foo",args=[],file="try.c", |
948d5102 | 26546 | fullname="/home/foo/bar/try.c",line="13"@} |
594fe323 | 26547 | (gdb) |
922fbb7b | 26548 | |
594fe323 | 26549 | (gdb) |
922fbb7b AC |
26550 | -exec-interrupt |
26551 | ^error,msg="mi_cmd_exec_interrupt: Inferior not executing." | |
594fe323 | 26552 | (gdb) |
922fbb7b AC |
26553 | @end smallexample |
26554 | ||
83eba9b7 VP |
26555 | @subheading The @code{-exec-jump} Command |
26556 | @findex -exec-jump | |
26557 | ||
26558 | @subsubheading Synopsis | |
26559 | ||
26560 | @smallexample | |
26561 | -exec-jump @var{location} | |
26562 | @end smallexample | |
26563 | ||
26564 | Resumes execution of the inferior program at the location specified by | |
26565 | parameter. @xref{Specify Location}, for a description of the | |
26566 | different forms of @var{location}. | |
26567 | ||
26568 | @subsubheading @value{GDBN} Command | |
26569 | ||
26570 | The corresponding @value{GDBN} command is @samp{jump}. | |
26571 | ||
26572 | @subsubheading Example | |
26573 | ||
26574 | @smallexample | |
26575 | -exec-jump foo.c:10 | |
26576 | *running,thread-id="all" | |
26577 | ^running | |
26578 | @end smallexample | |
26579 | ||
922fbb7b AC |
26580 | |
26581 | @subheading The @code{-exec-next} Command | |
26582 | @findex -exec-next | |
26583 | ||
26584 | @subsubheading Synopsis | |
26585 | ||
26586 | @smallexample | |
540aa8e7 | 26587 | -exec-next [--reverse] |
922fbb7b AC |
26588 | @end smallexample |
26589 | ||
ef21caaf NR |
26590 | Resumes execution of the inferior program, stopping when the beginning |
26591 | of the next source line is reached. | |
922fbb7b | 26592 | |
540aa8e7 MS |
26593 | If the @samp{--reverse} option is specified, resumes reverse execution |
26594 | of the inferior program, stopping at the beginning of the previous | |
26595 | source line. If you issue this command on the first line of a | |
26596 | function, it will take you back to the caller of that function, to the | |
26597 | source line where the function was called. | |
26598 | ||
26599 | ||
922fbb7b AC |
26600 | @subsubheading @value{GDBN} Command |
26601 | ||
26602 | The corresponding @value{GDBN} command is @samp{next}. | |
26603 | ||
26604 | @subsubheading Example | |
26605 | ||
26606 | @smallexample | |
26607 | -exec-next | |
26608 | ^running | |
594fe323 | 26609 | (gdb) |
922fbb7b | 26610 | *stopped,reason="end-stepping-range",line="8",file="hello.c" |
594fe323 | 26611 | (gdb) |
922fbb7b AC |
26612 | @end smallexample |
26613 | ||
26614 | ||
26615 | @subheading The @code{-exec-next-instruction} Command | |
26616 | @findex -exec-next-instruction | |
26617 | ||
26618 | @subsubheading Synopsis | |
26619 | ||
26620 | @smallexample | |
540aa8e7 | 26621 | -exec-next-instruction [--reverse] |
922fbb7b AC |
26622 | @end smallexample |
26623 | ||
ef21caaf NR |
26624 | Executes one machine instruction. If the instruction is a function |
26625 | call, continues until the function returns. If the program stops at an | |
26626 | instruction in the middle of a source line, the address will be | |
26627 | printed as well. | |
922fbb7b | 26628 | |
540aa8e7 MS |
26629 | If the @samp{--reverse} option is specified, resumes reverse execution |
26630 | of the inferior program, stopping at the previous instruction. If the | |
26631 | previously executed instruction was a return from another function, | |
26632 | it will continue to execute in reverse until the call to that function | |
26633 | (from the current stack frame) is reached. | |
26634 | ||
922fbb7b AC |
26635 | @subsubheading @value{GDBN} Command |
26636 | ||
26637 | The corresponding @value{GDBN} command is @samp{nexti}. | |
26638 | ||
26639 | @subsubheading Example | |
26640 | ||
26641 | @smallexample | |
594fe323 | 26642 | (gdb) |
922fbb7b AC |
26643 | -exec-next-instruction |
26644 | ^running | |
26645 | ||
594fe323 | 26646 | (gdb) |
922fbb7b AC |
26647 | *stopped,reason="end-stepping-range", |
26648 | addr="0x000100d4",line="5",file="hello.c" | |
594fe323 | 26649 | (gdb) |
922fbb7b AC |
26650 | @end smallexample |
26651 | ||
26652 | ||
26653 | @subheading The @code{-exec-return} Command | |
26654 | @findex -exec-return | |
26655 | ||
26656 | @subsubheading Synopsis | |
26657 | ||
26658 | @smallexample | |
26659 | -exec-return | |
26660 | @end smallexample | |
26661 | ||
26662 | Makes current function return immediately. Doesn't execute the inferior. | |
26663 | Displays the new current frame. | |
26664 | ||
26665 | @subsubheading @value{GDBN} Command | |
26666 | ||
26667 | The corresponding @value{GDBN} command is @samp{return}. | |
26668 | ||
26669 | @subsubheading Example | |
26670 | ||
26671 | @smallexample | |
594fe323 | 26672 | (gdb) |
922fbb7b AC |
26673 | 200-break-insert callee4 |
26674 | 200^done,bkpt=@{number="1",addr="0x00010734", | |
26675 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@} | |
594fe323 | 26676 | (gdb) |
922fbb7b AC |
26677 | 000-exec-run |
26678 | 000^running | |
594fe323 | 26679 | (gdb) |
a47ec5fe | 26680 | 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1", |
922fbb7b | 26681 | frame=@{func="callee4",args=[], |
76ff342d DJ |
26682 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26683 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@} | |
594fe323 | 26684 | (gdb) |
922fbb7b AC |
26685 | 205-break-delete |
26686 | 205^done | |
594fe323 | 26687 | (gdb) |
922fbb7b AC |
26688 | 111-exec-return |
26689 | 111^done,frame=@{level="0",func="callee3", | |
26690 | args=[@{name="strarg", | |
26691 | value="0x11940 \"A string argument.\""@}], | |
76ff342d DJ |
26692 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26693 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} | |
594fe323 | 26694 | (gdb) |
922fbb7b AC |
26695 | @end smallexample |
26696 | ||
26697 | ||
26698 | @subheading The @code{-exec-run} Command | |
26699 | @findex -exec-run | |
26700 | ||
26701 | @subsubheading Synopsis | |
26702 | ||
26703 | @smallexample | |
a79b8f6e | 26704 | -exec-run [--all | --thread-group N] |
922fbb7b AC |
26705 | @end smallexample |
26706 | ||
ef21caaf NR |
26707 | Starts execution of the inferior from the beginning. The inferior |
26708 | executes until either a breakpoint is encountered or the program | |
26709 | exits. In the latter case the output will include an exit code, if | |
26710 | the program has exited exceptionally. | |
922fbb7b | 26711 | |
a79b8f6e VP |
26712 | When no option is specified, the current inferior is started. If the |
26713 | @samp{--thread-group} option is specified, it should refer to a thread | |
26714 | group of type @samp{process}, and that thread group will be started. | |
26715 | If the @samp{--all} option is specified, then all inferiors will be started. | |
26716 | ||
922fbb7b AC |
26717 | @subsubheading @value{GDBN} Command |
26718 | ||
26719 | The corresponding @value{GDBN} command is @samp{run}. | |
26720 | ||
ef21caaf | 26721 | @subsubheading Examples |
922fbb7b AC |
26722 | |
26723 | @smallexample | |
594fe323 | 26724 | (gdb) |
922fbb7b AC |
26725 | -break-insert main |
26726 | ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@} | |
594fe323 | 26727 | (gdb) |
922fbb7b AC |
26728 | -exec-run |
26729 | ^running | |
594fe323 | 26730 | (gdb) |
a47ec5fe | 26731 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1", |
76ff342d | 26732 | frame=@{func="main",args=[],file="recursive2.c", |
948d5102 | 26733 | fullname="/home/foo/bar/recursive2.c",line="4"@} |
594fe323 | 26734 | (gdb) |
922fbb7b AC |
26735 | @end smallexample |
26736 | ||
ef21caaf NR |
26737 | @noindent |
26738 | Program exited normally: | |
26739 | ||
26740 | @smallexample | |
594fe323 | 26741 | (gdb) |
ef21caaf NR |
26742 | -exec-run |
26743 | ^running | |
594fe323 | 26744 | (gdb) |
ef21caaf NR |
26745 | x = 55 |
26746 | *stopped,reason="exited-normally" | |
594fe323 | 26747 | (gdb) |
ef21caaf NR |
26748 | @end smallexample |
26749 | ||
26750 | @noindent | |
26751 | Program exited exceptionally: | |
26752 | ||
26753 | @smallexample | |
594fe323 | 26754 | (gdb) |
ef21caaf NR |
26755 | -exec-run |
26756 | ^running | |
594fe323 | 26757 | (gdb) |
ef21caaf NR |
26758 | x = 55 |
26759 | *stopped,reason="exited",exit-code="01" | |
594fe323 | 26760 | (gdb) |
ef21caaf NR |
26761 | @end smallexample |
26762 | ||
26763 | Another way the program can terminate is if it receives a signal such as | |
26764 | @code{SIGINT}. In this case, @sc{gdb/mi} displays this: | |
26765 | ||
26766 | @smallexample | |
594fe323 | 26767 | (gdb) |
ef21caaf NR |
26768 | *stopped,reason="exited-signalled",signal-name="SIGINT", |
26769 | signal-meaning="Interrupt" | |
26770 | @end smallexample | |
26771 | ||
922fbb7b | 26772 | |
a2c02241 NR |
26773 | @c @subheading -exec-signal |
26774 | ||
26775 | ||
26776 | @subheading The @code{-exec-step} Command | |
26777 | @findex -exec-step | |
922fbb7b AC |
26778 | |
26779 | @subsubheading Synopsis | |
26780 | ||
26781 | @smallexample | |
540aa8e7 | 26782 | -exec-step [--reverse] |
922fbb7b AC |
26783 | @end smallexample |
26784 | ||
a2c02241 NR |
26785 | Resumes execution of the inferior program, stopping when the beginning |
26786 | of the next source line is reached, if the next source line is not a | |
26787 | function call. If it is, stop at the first instruction of the called | |
540aa8e7 MS |
26788 | function. If the @samp{--reverse} option is specified, resumes reverse |
26789 | execution of the inferior program, stopping at the beginning of the | |
26790 | previously executed source line. | |
922fbb7b AC |
26791 | |
26792 | @subsubheading @value{GDBN} Command | |
26793 | ||
a2c02241 | 26794 | The corresponding @value{GDBN} command is @samp{step}. |
922fbb7b AC |
26795 | |
26796 | @subsubheading Example | |
26797 | ||
26798 | Stepping into a function: | |
26799 | ||
26800 | @smallexample | |
26801 | -exec-step | |
26802 | ^running | |
594fe323 | 26803 | (gdb) |
922fbb7b AC |
26804 | *stopped,reason="end-stepping-range", |
26805 | frame=@{func="foo",args=[@{name="a",value="10"@}, | |
76ff342d | 26806 | @{name="b",value="0"@}],file="recursive2.c", |
948d5102 | 26807 | fullname="/home/foo/bar/recursive2.c",line="11"@} |
594fe323 | 26808 | (gdb) |
922fbb7b AC |
26809 | @end smallexample |
26810 | ||
26811 | Regular stepping: | |
26812 | ||
26813 | @smallexample | |
26814 | -exec-step | |
26815 | ^running | |
594fe323 | 26816 | (gdb) |
922fbb7b | 26817 | *stopped,reason="end-stepping-range",line="14",file="recursive2.c" |
594fe323 | 26818 | (gdb) |
922fbb7b AC |
26819 | @end smallexample |
26820 | ||
26821 | ||
26822 | @subheading The @code{-exec-step-instruction} Command | |
26823 | @findex -exec-step-instruction | |
26824 | ||
26825 | @subsubheading Synopsis | |
26826 | ||
26827 | @smallexample | |
540aa8e7 | 26828 | -exec-step-instruction [--reverse] |
922fbb7b AC |
26829 | @end smallexample |
26830 | ||
540aa8e7 MS |
26831 | Resumes the inferior which executes one machine instruction. If the |
26832 | @samp{--reverse} option is specified, resumes reverse execution of the | |
26833 | inferior program, stopping at the previously executed instruction. | |
26834 | The output, once @value{GDBN} has stopped, will vary depending on | |
26835 | whether we have stopped in the middle of a source line or not. In the | |
26836 | former case, the address at which the program stopped will be printed | |
26837 | as well. | |
922fbb7b AC |
26838 | |
26839 | @subsubheading @value{GDBN} Command | |
26840 | ||
26841 | The corresponding @value{GDBN} command is @samp{stepi}. | |
26842 | ||
26843 | @subsubheading Example | |
26844 | ||
26845 | @smallexample | |
594fe323 | 26846 | (gdb) |
922fbb7b AC |
26847 | -exec-step-instruction |
26848 | ^running | |
26849 | ||
594fe323 | 26850 | (gdb) |
922fbb7b | 26851 | *stopped,reason="end-stepping-range", |
76ff342d | 26852 | frame=@{func="foo",args=[],file="try.c", |
948d5102 | 26853 | fullname="/home/foo/bar/try.c",line="10"@} |
594fe323 | 26854 | (gdb) |
922fbb7b AC |
26855 | -exec-step-instruction |
26856 | ^running | |
26857 | ||
594fe323 | 26858 | (gdb) |
922fbb7b | 26859 | *stopped,reason="end-stepping-range", |
76ff342d | 26860 | frame=@{addr="0x000100f4",func="foo",args=[],file="try.c", |
948d5102 | 26861 | fullname="/home/foo/bar/try.c",line="10"@} |
594fe323 | 26862 | (gdb) |
922fbb7b AC |
26863 | @end smallexample |
26864 | ||
26865 | ||
26866 | @subheading The @code{-exec-until} Command | |
26867 | @findex -exec-until | |
26868 | ||
26869 | @subsubheading Synopsis | |
26870 | ||
26871 | @smallexample | |
26872 | -exec-until [ @var{location} ] | |
26873 | @end smallexample | |
26874 | ||
ef21caaf NR |
26875 | Executes the inferior until the @var{location} specified in the |
26876 | argument is reached. If there is no argument, the inferior executes | |
26877 | until a source line greater than the current one is reached. The | |
26878 | reason for stopping in this case will be @samp{location-reached}. | |
922fbb7b AC |
26879 | |
26880 | @subsubheading @value{GDBN} Command | |
26881 | ||
26882 | The corresponding @value{GDBN} command is @samp{until}. | |
26883 | ||
26884 | @subsubheading Example | |
26885 | ||
26886 | @smallexample | |
594fe323 | 26887 | (gdb) |
922fbb7b AC |
26888 | -exec-until recursive2.c:6 |
26889 | ^running | |
594fe323 | 26890 | (gdb) |
922fbb7b AC |
26891 | x = 55 |
26892 | *stopped,reason="location-reached",frame=@{func="main",args=[], | |
948d5102 | 26893 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@} |
594fe323 | 26894 | (gdb) |
922fbb7b AC |
26895 | @end smallexample |
26896 | ||
26897 | @ignore | |
26898 | @subheading -file-clear | |
26899 | Is this going away???? | |
26900 | @end ignore | |
26901 | ||
351ff01a | 26902 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
a2c02241 NR |
26903 | @node GDB/MI Stack Manipulation |
26904 | @section @sc{gdb/mi} Stack Manipulation Commands | |
351ff01a | 26905 | |
922fbb7b | 26906 | |
a2c02241 NR |
26907 | @subheading The @code{-stack-info-frame} Command |
26908 | @findex -stack-info-frame | |
922fbb7b AC |
26909 | |
26910 | @subsubheading Synopsis | |
26911 | ||
26912 | @smallexample | |
a2c02241 | 26913 | -stack-info-frame |
922fbb7b AC |
26914 | @end smallexample |
26915 | ||
a2c02241 | 26916 | Get info on the selected frame. |
922fbb7b AC |
26917 | |
26918 | @subsubheading @value{GDBN} Command | |
26919 | ||
a2c02241 NR |
26920 | The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame} |
26921 | (without arguments). | |
922fbb7b AC |
26922 | |
26923 | @subsubheading Example | |
26924 | ||
26925 | @smallexample | |
594fe323 | 26926 | (gdb) |
a2c02241 NR |
26927 | -stack-info-frame |
26928 | ^done,frame=@{level="1",addr="0x0001076c",func="callee3", | |
26929 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
26930 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@} | |
594fe323 | 26931 | (gdb) |
922fbb7b AC |
26932 | @end smallexample |
26933 | ||
a2c02241 NR |
26934 | @subheading The @code{-stack-info-depth} Command |
26935 | @findex -stack-info-depth | |
922fbb7b AC |
26936 | |
26937 | @subsubheading Synopsis | |
26938 | ||
26939 | @smallexample | |
a2c02241 | 26940 | -stack-info-depth [ @var{max-depth} ] |
922fbb7b AC |
26941 | @end smallexample |
26942 | ||
a2c02241 NR |
26943 | Return the depth of the stack. If the integer argument @var{max-depth} |
26944 | is specified, do not count beyond @var{max-depth} frames. | |
922fbb7b AC |
26945 | |
26946 | @subsubheading @value{GDBN} Command | |
26947 | ||
a2c02241 | 26948 | There's no equivalent @value{GDBN} command. |
922fbb7b AC |
26949 | |
26950 | @subsubheading Example | |
26951 | ||
a2c02241 NR |
26952 | For a stack with frame levels 0 through 11: |
26953 | ||
922fbb7b | 26954 | @smallexample |
594fe323 | 26955 | (gdb) |
a2c02241 NR |
26956 | -stack-info-depth |
26957 | ^done,depth="12" | |
594fe323 | 26958 | (gdb) |
a2c02241 NR |
26959 | -stack-info-depth 4 |
26960 | ^done,depth="4" | |
594fe323 | 26961 | (gdb) |
a2c02241 NR |
26962 | -stack-info-depth 12 |
26963 | ^done,depth="12" | |
594fe323 | 26964 | (gdb) |
a2c02241 NR |
26965 | -stack-info-depth 11 |
26966 | ^done,depth="11" | |
594fe323 | 26967 | (gdb) |
a2c02241 NR |
26968 | -stack-info-depth 13 |
26969 | ^done,depth="12" | |
594fe323 | 26970 | (gdb) |
922fbb7b AC |
26971 | @end smallexample |
26972 | ||
a2c02241 NR |
26973 | @subheading The @code{-stack-list-arguments} Command |
26974 | @findex -stack-list-arguments | |
922fbb7b AC |
26975 | |
26976 | @subsubheading Synopsis | |
26977 | ||
26978 | @smallexample | |
3afae151 | 26979 | -stack-list-arguments @var{print-values} |
a2c02241 | 26980 | [ @var{low-frame} @var{high-frame} ] |
922fbb7b AC |
26981 | @end smallexample |
26982 | ||
a2c02241 NR |
26983 | Display a list of the arguments for the frames between @var{low-frame} |
26984 | and @var{high-frame} (inclusive). If @var{low-frame} and | |
2f1acb09 VP |
26985 | @var{high-frame} are not provided, list the arguments for the whole |
26986 | call stack. If the two arguments are equal, show the single frame | |
26987 | at the corresponding level. It is an error if @var{low-frame} is | |
26988 | larger than the actual number of frames. On the other hand, | |
26989 | @var{high-frame} may be larger than the actual number of frames, in | |
26990 | which case only existing frames will be returned. | |
a2c02241 | 26991 | |
3afae151 VP |
26992 | If @var{print-values} is 0 or @code{--no-values}, print only the names of |
26993 | the variables; if it is 1 or @code{--all-values}, print also their | |
26994 | values; and if it is 2 or @code{--simple-values}, print the name, | |
26995 | type and value for simple data types, and the name and type for arrays, | |
26996 | structures and unions. | |
922fbb7b | 26997 | |
b3372f91 VP |
26998 | Use of this command to obtain arguments in a single frame is |
26999 | deprecated in favor of the @samp{-stack-list-variables} command. | |
27000 | ||
922fbb7b AC |
27001 | @subsubheading @value{GDBN} Command |
27002 | ||
a2c02241 NR |
27003 | @value{GDBN} does not have an equivalent command. @code{gdbtk} has a |
27004 | @samp{gdb_get_args} command which partially overlaps with the | |
27005 | functionality of @samp{-stack-list-arguments}. | |
922fbb7b AC |
27006 | |
27007 | @subsubheading Example | |
922fbb7b | 27008 | |
a2c02241 | 27009 | @smallexample |
594fe323 | 27010 | (gdb) |
a2c02241 NR |
27011 | -stack-list-frames |
27012 | ^done, | |
27013 | stack=[ | |
27014 | frame=@{level="0",addr="0x00010734",func="callee4", | |
27015 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27016 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}, | |
27017 | frame=@{level="1",addr="0x0001076c",func="callee3", | |
27018 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27019 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}, | |
27020 | frame=@{level="2",addr="0x0001078c",func="callee2", | |
27021 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27022 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@}, | |
27023 | frame=@{level="3",addr="0x000107b4",func="callee1", | |
27024 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27025 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@}, | |
27026 | frame=@{level="4",addr="0x000107e0",func="main", | |
27027 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27028 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}] | |
594fe323 | 27029 | (gdb) |
a2c02241 NR |
27030 | -stack-list-arguments 0 |
27031 | ^done, | |
27032 | stack-args=[ | |
27033 | frame=@{level="0",args=[]@}, | |
27034 | frame=@{level="1",args=[name="strarg"]@}, | |
27035 | frame=@{level="2",args=[name="intarg",name="strarg"]@}, | |
27036 | frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@}, | |
27037 | frame=@{level="4",args=[]@}] | |
594fe323 | 27038 | (gdb) |
a2c02241 NR |
27039 | -stack-list-arguments 1 |
27040 | ^done, | |
27041 | stack-args=[ | |
27042 | frame=@{level="0",args=[]@}, | |
27043 | frame=@{level="1", | |
27044 | args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@}, | |
27045 | frame=@{level="2",args=[ | |
27046 | @{name="intarg",value="2"@}, | |
27047 | @{name="strarg",value="0x11940 \"A string argument.\""@}]@}, | |
27048 | @{frame=@{level="3",args=[ | |
27049 | @{name="intarg",value="2"@}, | |
27050 | @{name="strarg",value="0x11940 \"A string argument.\""@}, | |
27051 | @{name="fltarg",value="3.5"@}]@}, | |
27052 | frame=@{level="4",args=[]@}] | |
594fe323 | 27053 | (gdb) |
a2c02241 NR |
27054 | -stack-list-arguments 0 2 2 |
27055 | ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}] | |
594fe323 | 27056 | (gdb) |
a2c02241 NR |
27057 | -stack-list-arguments 1 2 2 |
27058 | ^done,stack-args=[frame=@{level="2", | |
27059 | args=[@{name="intarg",value="2"@}, | |
27060 | @{name="strarg",value="0x11940 \"A string argument.\""@}]@}] | |
594fe323 | 27061 | (gdb) |
a2c02241 NR |
27062 | @end smallexample |
27063 | ||
27064 | @c @subheading -stack-list-exception-handlers | |
922fbb7b | 27065 | |
a2c02241 NR |
27066 | |
27067 | @subheading The @code{-stack-list-frames} Command | |
27068 | @findex -stack-list-frames | |
1abaf70c BR |
27069 | |
27070 | @subsubheading Synopsis | |
27071 | ||
27072 | @smallexample | |
a2c02241 | 27073 | -stack-list-frames [ @var{low-frame} @var{high-frame} ] |
1abaf70c BR |
27074 | @end smallexample |
27075 | ||
a2c02241 NR |
27076 | List the frames currently on the stack. For each frame it displays the |
27077 | following info: | |
27078 | ||
27079 | @table @samp | |
27080 | @item @var{level} | |
d3e8051b | 27081 | The frame number, 0 being the topmost frame, i.e., the innermost function. |
a2c02241 NR |
27082 | @item @var{addr} |
27083 | The @code{$pc} value for that frame. | |
27084 | @item @var{func} | |
27085 | Function name. | |
27086 | @item @var{file} | |
27087 | File name of the source file where the function lives. | |
7d288aaa TT |
27088 | @item @var{fullname} |
27089 | The full file name of the source file where the function lives. | |
a2c02241 NR |
27090 | @item @var{line} |
27091 | Line number corresponding to the @code{$pc}. | |
7d288aaa TT |
27092 | @item @var{from} |
27093 | The shared library where this function is defined. This is only given | |
27094 | if the frame's function is not known. | |
a2c02241 NR |
27095 | @end table |
27096 | ||
27097 | If invoked without arguments, this command prints a backtrace for the | |
27098 | whole stack. If given two integer arguments, it shows the frames whose | |
27099 | levels are between the two arguments (inclusive). If the two arguments | |
2ab1eb7a VP |
27100 | are equal, it shows the single frame at the corresponding level. It is |
27101 | an error if @var{low-frame} is larger than the actual number of | |
a5451f4e | 27102 | frames. On the other hand, @var{high-frame} may be larger than the |
2ab1eb7a | 27103 | actual number of frames, in which case only existing frames will be returned. |
1abaf70c BR |
27104 | |
27105 | @subsubheading @value{GDBN} Command | |
27106 | ||
a2c02241 | 27107 | The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}. |
1abaf70c BR |
27108 | |
27109 | @subsubheading Example | |
27110 | ||
a2c02241 NR |
27111 | Full stack backtrace: |
27112 | ||
1abaf70c | 27113 | @smallexample |
594fe323 | 27114 | (gdb) |
a2c02241 NR |
27115 | -stack-list-frames |
27116 | ^done,stack= | |
27117 | [frame=@{level="0",addr="0x0001076c",func="foo", | |
27118 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@}, | |
27119 | frame=@{level="1",addr="0x000107a4",func="foo", | |
27120 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27121 | frame=@{level="2",addr="0x000107a4",func="foo", | |
27122 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27123 | frame=@{level="3",addr="0x000107a4",func="foo", | |
27124 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27125 | frame=@{level="4",addr="0x000107a4",func="foo", | |
27126 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27127 | frame=@{level="5",addr="0x000107a4",func="foo", | |
27128 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27129 | frame=@{level="6",addr="0x000107a4",func="foo", | |
27130 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27131 | frame=@{level="7",addr="0x000107a4",func="foo", | |
27132 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27133 | frame=@{level="8",addr="0x000107a4",func="foo", | |
27134 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27135 | frame=@{level="9",addr="0x000107a4",func="foo", | |
27136 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27137 | frame=@{level="10",addr="0x000107a4",func="foo", | |
27138 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27139 | frame=@{level="11",addr="0x00010738",func="main", | |
27140 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}] | |
594fe323 | 27141 | (gdb) |
1abaf70c BR |
27142 | @end smallexample |
27143 | ||
a2c02241 | 27144 | Show frames between @var{low_frame} and @var{high_frame}: |
1abaf70c | 27145 | |
a2c02241 | 27146 | @smallexample |
594fe323 | 27147 | (gdb) |
a2c02241 NR |
27148 | -stack-list-frames 3 5 |
27149 | ^done,stack= | |
27150 | [frame=@{level="3",addr="0x000107a4",func="foo", | |
27151 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27152 | frame=@{level="4",addr="0x000107a4",func="foo", | |
27153 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27154 | frame=@{level="5",addr="0x000107a4",func="foo", | |
27155 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}] | |
594fe323 | 27156 | (gdb) |
a2c02241 | 27157 | @end smallexample |
922fbb7b | 27158 | |
a2c02241 | 27159 | Show a single frame: |
922fbb7b AC |
27160 | |
27161 | @smallexample | |
594fe323 | 27162 | (gdb) |
a2c02241 NR |
27163 | -stack-list-frames 3 3 |
27164 | ^done,stack= | |
27165 | [frame=@{level="3",addr="0x000107a4",func="foo", | |
27166 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}] | |
594fe323 | 27167 | (gdb) |
922fbb7b AC |
27168 | @end smallexample |
27169 | ||
922fbb7b | 27170 | |
a2c02241 NR |
27171 | @subheading The @code{-stack-list-locals} Command |
27172 | @findex -stack-list-locals | |
57c22c6c | 27173 | |
a2c02241 | 27174 | @subsubheading Synopsis |
922fbb7b AC |
27175 | |
27176 | @smallexample | |
a2c02241 | 27177 | -stack-list-locals @var{print-values} |
922fbb7b AC |
27178 | @end smallexample |
27179 | ||
a2c02241 NR |
27180 | Display the local variable names for the selected frame. If |
27181 | @var{print-values} is 0 or @code{--no-values}, print only the names of | |
27182 | the variables; if it is 1 or @code{--all-values}, print also their | |
27183 | values; and if it is 2 or @code{--simple-values}, print the name, | |
3afae151 | 27184 | type and value for simple data types, and the name and type for arrays, |
a2c02241 NR |
27185 | structures and unions. In this last case, a frontend can immediately |
27186 | display the value of simple data types and create variable objects for | |
d3e8051b | 27187 | other data types when the user wishes to explore their values in |
a2c02241 | 27188 | more detail. |
922fbb7b | 27189 | |
b3372f91 VP |
27190 | This command is deprecated in favor of the |
27191 | @samp{-stack-list-variables} command. | |
27192 | ||
922fbb7b AC |
27193 | @subsubheading @value{GDBN} Command |
27194 | ||
a2c02241 | 27195 | @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}. |
922fbb7b AC |
27196 | |
27197 | @subsubheading Example | |
922fbb7b AC |
27198 | |
27199 | @smallexample | |
594fe323 | 27200 | (gdb) |
a2c02241 NR |
27201 | -stack-list-locals 0 |
27202 | ^done,locals=[name="A",name="B",name="C"] | |
594fe323 | 27203 | (gdb) |
a2c02241 NR |
27204 | -stack-list-locals --all-values |
27205 | ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@}, | |
27206 | @{name="C",value="@{1, 2, 3@}"@}] | |
27207 | -stack-list-locals --simple-values | |
27208 | ^done,locals=[@{name="A",type="int",value="1"@}, | |
27209 | @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}] | |
594fe323 | 27210 | (gdb) |
922fbb7b AC |
27211 | @end smallexample |
27212 | ||
b3372f91 VP |
27213 | @subheading The @code{-stack-list-variables} Command |
27214 | @findex -stack-list-variables | |
27215 | ||
27216 | @subsubheading Synopsis | |
27217 | ||
27218 | @smallexample | |
27219 | -stack-list-variables @var{print-values} | |
27220 | @end smallexample | |
27221 | ||
27222 | Display the names of local variables and function arguments for the selected frame. If | |
27223 | @var{print-values} is 0 or @code{--no-values}, print only the names of | |
27224 | the variables; if it is 1 or @code{--all-values}, print also their | |
27225 | values; and if it is 2 or @code{--simple-values}, print the name, | |
3afae151 | 27226 | type and value for simple data types, and the name and type for arrays, |
b3372f91 VP |
27227 | structures and unions. |
27228 | ||
27229 | @subsubheading Example | |
27230 | ||
27231 | @smallexample | |
27232 | (gdb) | |
27233 | -stack-list-variables --thread 1 --frame 0 --all-values | |
4f412fd0 | 27234 | ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}] |
b3372f91 VP |
27235 | (gdb) |
27236 | @end smallexample | |
27237 | ||
922fbb7b | 27238 | |
a2c02241 NR |
27239 | @subheading The @code{-stack-select-frame} Command |
27240 | @findex -stack-select-frame | |
922fbb7b AC |
27241 | |
27242 | @subsubheading Synopsis | |
27243 | ||
27244 | @smallexample | |
a2c02241 | 27245 | -stack-select-frame @var{framenum} |
922fbb7b AC |
27246 | @end smallexample |
27247 | ||
a2c02241 NR |
27248 | Change the selected frame. Select a different frame @var{framenum} on |
27249 | the stack. | |
922fbb7b | 27250 | |
c3b108f7 VP |
27251 | This command in deprecated in favor of passing the @samp{--frame} |
27252 | option to every command. | |
27253 | ||
922fbb7b AC |
27254 | @subsubheading @value{GDBN} Command |
27255 | ||
a2c02241 NR |
27256 | The corresponding @value{GDBN} commands are @samp{frame}, @samp{up}, |
27257 | @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}. | |
922fbb7b AC |
27258 | |
27259 | @subsubheading Example | |
27260 | ||
27261 | @smallexample | |
594fe323 | 27262 | (gdb) |
a2c02241 | 27263 | -stack-select-frame 2 |
922fbb7b | 27264 | ^done |
594fe323 | 27265 | (gdb) |
922fbb7b AC |
27266 | @end smallexample |
27267 | ||
27268 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
a2c02241 NR |
27269 | @node GDB/MI Variable Objects |
27270 | @section @sc{gdb/mi} Variable Objects | |
922fbb7b | 27271 | |
a1b5960f | 27272 | @ignore |
922fbb7b | 27273 | |
a2c02241 | 27274 | @subheading Motivation for Variable Objects in @sc{gdb/mi} |
922fbb7b | 27275 | |
a2c02241 NR |
27276 | For the implementation of a variable debugger window (locals, watched |
27277 | expressions, etc.), we are proposing the adaptation of the existing code | |
27278 | used by @code{Insight}. | |
922fbb7b | 27279 | |
a2c02241 | 27280 | The two main reasons for that are: |
922fbb7b | 27281 | |
a2c02241 NR |
27282 | @enumerate 1 |
27283 | @item | |
27284 | It has been proven in practice (it is already on its second generation). | |
922fbb7b | 27285 | |
a2c02241 NR |
27286 | @item |
27287 | It will shorten development time (needless to say how important it is | |
27288 | now). | |
27289 | @end enumerate | |
922fbb7b | 27290 | |
a2c02241 NR |
27291 | The original interface was designed to be used by Tcl code, so it was |
27292 | slightly changed so it could be used through @sc{gdb/mi}. This section | |
27293 | describes the @sc{gdb/mi} operations that will be available and gives some | |
27294 | hints about their use. | |
922fbb7b | 27295 | |
a2c02241 NR |
27296 | @emph{Note}: In addition to the set of operations described here, we |
27297 | expect the @sc{gui} implementation of a variable window to require, at | |
27298 | least, the following operations: | |
922fbb7b | 27299 | |
a2c02241 NR |
27300 | @itemize @bullet |
27301 | @item @code{-gdb-show} @code{output-radix} | |
27302 | @item @code{-stack-list-arguments} | |
27303 | @item @code{-stack-list-locals} | |
27304 | @item @code{-stack-select-frame} | |
27305 | @end itemize | |
922fbb7b | 27306 | |
a1b5960f VP |
27307 | @end ignore |
27308 | ||
c8b2f53c | 27309 | @subheading Introduction to Variable Objects |
922fbb7b | 27310 | |
a2c02241 | 27311 | @cindex variable objects in @sc{gdb/mi} |
c8b2f53c VP |
27312 | |
27313 | Variable objects are "object-oriented" MI interface for examining and | |
27314 | changing values of expressions. Unlike some other MI interfaces that | |
27315 | work with expressions, variable objects are specifically designed for | |
27316 | simple and efficient presentation in the frontend. A variable object | |
27317 | is identified by string name. When a variable object is created, the | |
27318 | frontend specifies the expression for that variable object. The | |
27319 | expression can be a simple variable, or it can be an arbitrary complex | |
27320 | expression, and can even involve CPU registers. After creating a | |
27321 | variable object, the frontend can invoke other variable object | |
27322 | operations---for example to obtain or change the value of a variable | |
27323 | object, or to change display format. | |
27324 | ||
27325 | Variable objects have hierarchical tree structure. Any variable object | |
27326 | that corresponds to a composite type, such as structure in C, has | |
27327 | a number of child variable objects, for example corresponding to each | |
27328 | element of a structure. A child variable object can itself have | |
27329 | children, recursively. Recursion ends when we reach | |
25d5ea92 VP |
27330 | leaf variable objects, which always have built-in types. Child variable |
27331 | objects are created only by explicit request, so if a frontend | |
27332 | is not interested in the children of a particular variable object, no | |
27333 | child will be created. | |
c8b2f53c VP |
27334 | |
27335 | For a leaf variable object it is possible to obtain its value as a | |
27336 | string, or set the value from a string. String value can be also | |
27337 | obtained for a non-leaf variable object, but it's generally a string | |
27338 | that only indicates the type of the object, and does not list its | |
27339 | contents. Assignment to a non-leaf variable object is not allowed. | |
27340 | ||
27341 | A frontend does not need to read the values of all variable objects each time | |
27342 | the program stops. Instead, MI provides an update command that lists all | |
27343 | variable objects whose values has changed since the last update | |
27344 | operation. This considerably reduces the amount of data that must | |
25d5ea92 VP |
27345 | be transferred to the frontend. As noted above, children variable |
27346 | objects are created on demand, and only leaf variable objects have a | |
27347 | real value. As result, gdb will read target memory only for leaf | |
27348 | variables that frontend has created. | |
27349 | ||
27350 | The automatic update is not always desirable. For example, a frontend | |
27351 | might want to keep a value of some expression for future reference, | |
27352 | and never update it. For another example, fetching memory is | |
27353 | relatively slow for embedded targets, so a frontend might want | |
27354 | to disable automatic update for the variables that are either not | |
27355 | visible on the screen, or ``closed''. This is possible using so | |
27356 | called ``frozen variable objects''. Such variable objects are never | |
27357 | implicitly updated. | |
922fbb7b | 27358 | |
c3b108f7 VP |
27359 | Variable objects can be either @dfn{fixed} or @dfn{floating}. For the |
27360 | fixed variable object, the expression is parsed when the variable | |
27361 | object is created, including associating identifiers to specific | |
27362 | variables. The meaning of expression never changes. For a floating | |
27363 | variable object the values of variables whose names appear in the | |
27364 | expressions are re-evaluated every time in the context of the current | |
27365 | frame. Consider this example: | |
27366 | ||
27367 | @smallexample | |
27368 | void do_work(...) | |
27369 | @{ | |
27370 | struct work_state state; | |
27371 | ||
27372 | if (...) | |
27373 | do_work(...); | |
27374 | @} | |
27375 | @end smallexample | |
27376 | ||
27377 | If a fixed variable object for the @code{state} variable is created in | |
7a9dd1b2 | 27378 | this function, and we enter the recursive call, the variable |
c3b108f7 VP |
27379 | object will report the value of @code{state} in the top-level |
27380 | @code{do_work} invocation. On the other hand, a floating variable | |
27381 | object will report the value of @code{state} in the current frame. | |
27382 | ||
27383 | If an expression specified when creating a fixed variable object | |
27384 | refers to a local variable, the variable object becomes bound to the | |
27385 | thread and frame in which the variable object is created. When such | |
27386 | variable object is updated, @value{GDBN} makes sure that the | |
27387 | thread/frame combination the variable object is bound to still exists, | |
27388 | and re-evaluates the variable object in context of that thread/frame. | |
27389 | ||
a2c02241 NR |
27390 | The following is the complete set of @sc{gdb/mi} operations defined to |
27391 | access this functionality: | |
922fbb7b | 27392 | |
a2c02241 NR |
27393 | @multitable @columnfractions .4 .6 |
27394 | @item @strong{Operation} | |
27395 | @tab @strong{Description} | |
922fbb7b | 27396 | |
0cc7d26f TT |
27397 | @item @code{-enable-pretty-printing} |
27398 | @tab enable Python-based pretty-printing | |
a2c02241 NR |
27399 | @item @code{-var-create} |
27400 | @tab create a variable object | |
27401 | @item @code{-var-delete} | |
22d8a470 | 27402 | @tab delete the variable object and/or its children |
a2c02241 NR |
27403 | @item @code{-var-set-format} |
27404 | @tab set the display format of this variable | |
27405 | @item @code{-var-show-format} | |
27406 | @tab show the display format of this variable | |
27407 | @item @code{-var-info-num-children} | |
27408 | @tab tells how many children this object has | |
27409 | @item @code{-var-list-children} | |
27410 | @tab return a list of the object's children | |
27411 | @item @code{-var-info-type} | |
27412 | @tab show the type of this variable object | |
27413 | @item @code{-var-info-expression} | |
02142340 VP |
27414 | @tab print parent-relative expression that this variable object represents |
27415 | @item @code{-var-info-path-expression} | |
27416 | @tab print full expression that this variable object represents | |
a2c02241 NR |
27417 | @item @code{-var-show-attributes} |
27418 | @tab is this variable editable? does it exist here? | |
27419 | @item @code{-var-evaluate-expression} | |
27420 | @tab get the value of this variable | |
27421 | @item @code{-var-assign} | |
27422 | @tab set the value of this variable | |
27423 | @item @code{-var-update} | |
27424 | @tab update the variable and its children | |
25d5ea92 VP |
27425 | @item @code{-var-set-frozen} |
27426 | @tab set frozeness attribute | |
0cc7d26f TT |
27427 | @item @code{-var-set-update-range} |
27428 | @tab set range of children to display on update | |
a2c02241 | 27429 | @end multitable |
922fbb7b | 27430 | |
a2c02241 NR |
27431 | In the next subsection we describe each operation in detail and suggest |
27432 | how it can be used. | |
922fbb7b | 27433 | |
a2c02241 | 27434 | @subheading Description And Use of Operations on Variable Objects |
922fbb7b | 27435 | |
0cc7d26f TT |
27436 | @subheading The @code{-enable-pretty-printing} Command |
27437 | @findex -enable-pretty-printing | |
27438 | ||
27439 | @smallexample | |
27440 | -enable-pretty-printing | |
27441 | @end smallexample | |
27442 | ||
27443 | @value{GDBN} allows Python-based visualizers to affect the output of the | |
27444 | MI variable object commands. However, because there was no way to | |
27445 | implement this in a fully backward-compatible way, a front end must | |
27446 | request that this functionality be enabled. | |
27447 | ||
27448 | Once enabled, this feature cannot be disabled. | |
27449 | ||
27450 | Note that if Python support has not been compiled into @value{GDBN}, | |
27451 | this command will still succeed (and do nothing). | |
27452 | ||
f43030c4 TT |
27453 | This feature is currently (as of @value{GDBN} 7.0) experimental, and |
27454 | may work differently in future versions of @value{GDBN}. | |
27455 | ||
a2c02241 NR |
27456 | @subheading The @code{-var-create} Command |
27457 | @findex -var-create | |
ef21caaf | 27458 | |
a2c02241 | 27459 | @subsubheading Synopsis |
ef21caaf | 27460 | |
a2c02241 NR |
27461 | @smallexample |
27462 | -var-create @{@var{name} | "-"@} | |
c3b108f7 | 27463 | @{@var{frame-addr} | "*" | "@@"@} @var{expression} |
a2c02241 NR |
27464 | @end smallexample |
27465 | ||
27466 | This operation creates a variable object, which allows the monitoring of | |
27467 | a variable, the result of an expression, a memory cell or a CPU | |
27468 | register. | |
ef21caaf | 27469 | |
a2c02241 NR |
27470 | The @var{name} parameter is the string by which the object can be |
27471 | referenced. It must be unique. If @samp{-} is specified, the varobj | |
27472 | system will generate a string ``varNNNNNN'' automatically. It will be | |
c3b108f7 | 27473 | unique provided that one does not specify @var{name} of that format. |
a2c02241 | 27474 | The command fails if a duplicate name is found. |
ef21caaf | 27475 | |
a2c02241 NR |
27476 | The frame under which the expression should be evaluated can be |
27477 | specified by @var{frame-addr}. A @samp{*} indicates that the current | |
c3b108f7 VP |
27478 | frame should be used. A @samp{@@} indicates that a floating variable |
27479 | object must be created. | |
922fbb7b | 27480 | |
a2c02241 NR |
27481 | @var{expression} is any expression valid on the current language set (must not |
27482 | begin with a @samp{*}), or one of the following: | |
922fbb7b | 27483 | |
a2c02241 NR |
27484 | @itemize @bullet |
27485 | @item | |
27486 | @samp{*@var{addr}}, where @var{addr} is the address of a memory cell | |
922fbb7b | 27487 | |
a2c02241 NR |
27488 | @item |
27489 | @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD) | |
922fbb7b | 27490 | |
a2c02241 NR |
27491 | @item |
27492 | @samp{$@var{regname}} --- a CPU register name | |
27493 | @end itemize | |
922fbb7b | 27494 | |
0cc7d26f TT |
27495 | @cindex dynamic varobj |
27496 | A varobj's contents may be provided by a Python-based pretty-printer. In this | |
27497 | case the varobj is known as a @dfn{dynamic varobj}. Dynamic varobjs | |
27498 | have slightly different semantics in some cases. If the | |
27499 | @code{-enable-pretty-printing} command is not sent, then @value{GDBN} | |
27500 | will never create a dynamic varobj. This ensures backward | |
27501 | compatibility for existing clients. | |
27502 | ||
a2c02241 | 27503 | @subsubheading Result |
922fbb7b | 27504 | |
0cc7d26f TT |
27505 | This operation returns attributes of the newly-created varobj. These |
27506 | are: | |
27507 | ||
27508 | @table @samp | |
27509 | @item name | |
27510 | The name of the varobj. | |
27511 | ||
27512 | @item numchild | |
27513 | The number of children of the varobj. This number is not necessarily | |
27514 | reliable for a dynamic varobj. Instead, you must examine the | |
27515 | @samp{has_more} attribute. | |
27516 | ||
27517 | @item value | |
27518 | The varobj's scalar value. For a varobj whose type is some sort of | |
27519 | aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value | |
27520 | will not be interesting. | |
27521 | ||
27522 | @item type | |
27523 | The varobj's type. This is a string representation of the type, as | |
27524 | would be printed by the @value{GDBN} CLI. | |
27525 | ||
27526 | @item thread-id | |
27527 | If a variable object is bound to a specific thread, then this is the | |
27528 | thread's identifier. | |
27529 | ||
27530 | @item has_more | |
27531 | For a dynamic varobj, this indicates whether there appear to be any | |
27532 | children available. For a non-dynamic varobj, this will be 0. | |
27533 | ||
27534 | @item dynamic | |
27535 | This attribute will be present and have the value @samp{1} if the | |
27536 | varobj is a dynamic varobj. If the varobj is not a dynamic varobj, | |
27537 | then this attribute will not be present. | |
27538 | ||
27539 | @item displayhint | |
27540 | A dynamic varobj can supply a display hint to the front end. The | |
27541 | value comes directly from the Python pretty-printer object's | |
4c374409 | 27542 | @code{display_hint} method. @xref{Pretty Printing API}. |
0cc7d26f TT |
27543 | @end table |
27544 | ||
27545 | Typical output will look like this: | |
922fbb7b AC |
27546 | |
27547 | @smallexample | |
0cc7d26f TT |
27548 | name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}", |
27549 | has_more="@var{has_more}" | |
dcaaae04 NR |
27550 | @end smallexample |
27551 | ||
a2c02241 NR |
27552 | |
27553 | @subheading The @code{-var-delete} Command | |
27554 | @findex -var-delete | |
922fbb7b AC |
27555 | |
27556 | @subsubheading Synopsis | |
27557 | ||
27558 | @smallexample | |
22d8a470 | 27559 | -var-delete [ -c ] @var{name} |
922fbb7b AC |
27560 | @end smallexample |
27561 | ||
a2c02241 | 27562 | Deletes a previously created variable object and all of its children. |
22d8a470 | 27563 | With the @samp{-c} option, just deletes the children. |
922fbb7b | 27564 | |
a2c02241 | 27565 | Returns an error if the object @var{name} is not found. |
922fbb7b | 27566 | |
922fbb7b | 27567 | |
a2c02241 NR |
27568 | @subheading The @code{-var-set-format} Command |
27569 | @findex -var-set-format | |
922fbb7b | 27570 | |
a2c02241 | 27571 | @subsubheading Synopsis |
922fbb7b AC |
27572 | |
27573 | @smallexample | |
a2c02241 | 27574 | -var-set-format @var{name} @var{format-spec} |
922fbb7b AC |
27575 | @end smallexample |
27576 | ||
a2c02241 NR |
27577 | Sets the output format for the value of the object @var{name} to be |
27578 | @var{format-spec}. | |
27579 | ||
de051565 | 27580 | @anchor{-var-set-format} |
a2c02241 NR |
27581 | The syntax for the @var{format-spec} is as follows: |
27582 | ||
27583 | @smallexample | |
27584 | @var{format-spec} @expansion{} | |
27585 | @{binary | decimal | hexadecimal | octal | natural@} | |
27586 | @end smallexample | |
27587 | ||
c8b2f53c VP |
27588 | The natural format is the default format choosen automatically |
27589 | based on the variable type (like decimal for an @code{int}, hex | |
27590 | for pointers, etc.). | |
27591 | ||
27592 | For a variable with children, the format is set only on the | |
27593 | variable itself, and the children are not affected. | |
a2c02241 NR |
27594 | |
27595 | @subheading The @code{-var-show-format} Command | |
27596 | @findex -var-show-format | |
922fbb7b AC |
27597 | |
27598 | @subsubheading Synopsis | |
27599 | ||
27600 | @smallexample | |
a2c02241 | 27601 | -var-show-format @var{name} |
922fbb7b AC |
27602 | @end smallexample |
27603 | ||
a2c02241 | 27604 | Returns the format used to display the value of the object @var{name}. |
922fbb7b | 27605 | |
a2c02241 NR |
27606 | @smallexample |
27607 | @var{format} @expansion{} | |
27608 | @var{format-spec} | |
27609 | @end smallexample | |
922fbb7b | 27610 | |
922fbb7b | 27611 | |
a2c02241 NR |
27612 | @subheading The @code{-var-info-num-children} Command |
27613 | @findex -var-info-num-children | |
27614 | ||
27615 | @subsubheading Synopsis | |
27616 | ||
27617 | @smallexample | |
27618 | -var-info-num-children @var{name} | |
27619 | @end smallexample | |
27620 | ||
27621 | Returns the number of children of a variable object @var{name}: | |
27622 | ||
27623 | @smallexample | |
27624 | numchild=@var{n} | |
27625 | @end smallexample | |
27626 | ||
0cc7d26f TT |
27627 | Note that this number is not completely reliable for a dynamic varobj. |
27628 | It will return the current number of children, but more children may | |
27629 | be available. | |
27630 | ||
a2c02241 NR |
27631 | |
27632 | @subheading The @code{-var-list-children} Command | |
27633 | @findex -var-list-children | |
27634 | ||
27635 | @subsubheading Synopsis | |
27636 | ||
27637 | @smallexample | |
0cc7d26f | 27638 | -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}] |
a2c02241 | 27639 | @end smallexample |
b569d230 | 27640 | @anchor{-var-list-children} |
a2c02241 NR |
27641 | |
27642 | Return a list of the children of the specified variable object and | |
27643 | create variable objects for them, if they do not already exist. With | |
f5011d11 | 27644 | a single argument or if @var{print-values} has a value of 0 or |
a2c02241 NR |
27645 | @code{--no-values}, print only the names of the variables; if |
27646 | @var{print-values} is 1 or @code{--all-values}, also print their | |
27647 | values; and if it is 2 or @code{--simple-values} print the name and | |
27648 | value for simple data types and just the name for arrays, structures | |
27649 | and unions. | |
922fbb7b | 27650 | |
0cc7d26f TT |
27651 | @var{from} and @var{to}, if specified, indicate the range of children |
27652 | to report. If @var{from} or @var{to} is less than zero, the range is | |
27653 | reset and all children will be reported. Otherwise, children starting | |
27654 | at @var{from} (zero-based) and up to and excluding @var{to} will be | |
27655 | reported. | |
27656 | ||
27657 | If a child range is requested, it will only affect the current call to | |
27658 | @code{-var-list-children}, but not future calls to @code{-var-update}. | |
27659 | For this, you must instead use @code{-var-set-update-range}. The | |
27660 | intent of this approach is to enable a front end to implement any | |
27661 | update approach it likes; for example, scrolling a view may cause the | |
27662 | front end to request more children with @code{-var-list-children}, and | |
27663 | then the front end could call @code{-var-set-update-range} with a | |
27664 | different range to ensure that future updates are restricted to just | |
27665 | the visible items. | |
27666 | ||
b569d230 EZ |
27667 | For each child the following results are returned: |
27668 | ||
27669 | @table @var | |
27670 | ||
27671 | @item name | |
27672 | Name of the variable object created for this child. | |
27673 | ||
27674 | @item exp | |
27675 | The expression to be shown to the user by the front end to designate this child. | |
27676 | For example this may be the name of a structure member. | |
27677 | ||
0cc7d26f TT |
27678 | For a dynamic varobj, this value cannot be used to form an |
27679 | expression. There is no way to do this at all with a dynamic varobj. | |
27680 | ||
b569d230 EZ |
27681 | For C/C@t{++} structures there are several pseudo children returned to |
27682 | designate access qualifiers. For these pseudo children @var{exp} is | |
27683 | @samp{public}, @samp{private}, or @samp{protected}. In this case the | |
27684 | type and value are not present. | |
27685 | ||
0cc7d26f TT |
27686 | A dynamic varobj will not report the access qualifying |
27687 | pseudo-children, regardless of the language. This information is not | |
27688 | available at all with a dynamic varobj. | |
27689 | ||
b569d230 | 27690 | @item numchild |
0cc7d26f TT |
27691 | Number of children this child has. For a dynamic varobj, this will be |
27692 | 0. | |
b569d230 EZ |
27693 | |
27694 | @item type | |
27695 | The type of the child. | |
27696 | ||
27697 | @item value | |
27698 | If values were requested, this is the value. | |
27699 | ||
27700 | @item thread-id | |
27701 | If this variable object is associated with a thread, this is the thread id. | |
27702 | Otherwise this result is not present. | |
27703 | ||
27704 | @item frozen | |
27705 | If the variable object is frozen, this variable will be present with a value of 1. | |
27706 | @end table | |
27707 | ||
0cc7d26f TT |
27708 | The result may have its own attributes: |
27709 | ||
27710 | @table @samp | |
27711 | @item displayhint | |
27712 | A dynamic varobj can supply a display hint to the front end. The | |
27713 | value comes directly from the Python pretty-printer object's | |
4c374409 | 27714 | @code{display_hint} method. @xref{Pretty Printing API}. |
0cc7d26f TT |
27715 | |
27716 | @item has_more | |
27717 | This is an integer attribute which is nonzero if there are children | |
27718 | remaining after the end of the selected range. | |
27719 | @end table | |
27720 | ||
922fbb7b AC |
27721 | @subsubheading Example |
27722 | ||
27723 | @smallexample | |
594fe323 | 27724 | (gdb) |
a2c02241 | 27725 | -var-list-children n |
b569d230 | 27726 | ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp}, |
a2c02241 | 27727 | numchild=@var{n},type=@var{type}@},@r{(repeats N times)}] |
594fe323 | 27728 | (gdb) |
a2c02241 | 27729 | -var-list-children --all-values n |
b569d230 | 27730 | ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp}, |
a2c02241 | 27731 | numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}] |
922fbb7b AC |
27732 | @end smallexample |
27733 | ||
922fbb7b | 27734 | |
a2c02241 NR |
27735 | @subheading The @code{-var-info-type} Command |
27736 | @findex -var-info-type | |
922fbb7b | 27737 | |
a2c02241 NR |
27738 | @subsubheading Synopsis |
27739 | ||
27740 | @smallexample | |
27741 | -var-info-type @var{name} | |
27742 | @end smallexample | |
27743 | ||
27744 | Returns the type of the specified variable @var{name}. The type is | |
27745 | returned as a string in the same format as it is output by the | |
27746 | @value{GDBN} CLI: | |
27747 | ||
27748 | @smallexample | |
27749 | type=@var{typename} | |
27750 | @end smallexample | |
27751 | ||
27752 | ||
27753 | @subheading The @code{-var-info-expression} Command | |
27754 | @findex -var-info-expression | |
922fbb7b AC |
27755 | |
27756 | @subsubheading Synopsis | |
27757 | ||
27758 | @smallexample | |
a2c02241 | 27759 | -var-info-expression @var{name} |
922fbb7b AC |
27760 | @end smallexample |
27761 | ||
02142340 VP |
27762 | Returns a string that is suitable for presenting this |
27763 | variable object in user interface. The string is generally | |
27764 | not valid expression in the current language, and cannot be evaluated. | |
27765 | ||
27766 | For example, if @code{a} is an array, and variable object | |
27767 | @code{A} was created for @code{a}, then we'll get this output: | |
922fbb7b | 27768 | |
a2c02241 | 27769 | @smallexample |
02142340 VP |
27770 | (gdb) -var-info-expression A.1 |
27771 | ^done,lang="C",exp="1" | |
a2c02241 | 27772 | @end smallexample |
922fbb7b | 27773 | |
a2c02241 | 27774 | @noindent |
02142340 VP |
27775 | Here, the values of @code{lang} can be @code{@{"C" | "C++" | "Java"@}}. |
27776 | ||
27777 | Note that the output of the @code{-var-list-children} command also | |
27778 | includes those expressions, so the @code{-var-info-expression} command | |
27779 | is of limited use. | |
27780 | ||
27781 | @subheading The @code{-var-info-path-expression} Command | |
27782 | @findex -var-info-path-expression | |
27783 | ||
27784 | @subsubheading Synopsis | |
27785 | ||
27786 | @smallexample | |
27787 | -var-info-path-expression @var{name} | |
27788 | @end smallexample | |
27789 | ||
27790 | Returns an expression that can be evaluated in the current | |
27791 | context and will yield the same value that a variable object has. | |
27792 | Compare this with the @code{-var-info-expression} command, which | |
27793 | result can be used only for UI presentation. Typical use of | |
27794 | the @code{-var-info-path-expression} command is creating a | |
27795 | watchpoint from a variable object. | |
27796 | ||
0cc7d26f TT |
27797 | This command is currently not valid for children of a dynamic varobj, |
27798 | and will give an error when invoked on one. | |
27799 | ||
02142340 VP |
27800 | For example, suppose @code{C} is a C@t{++} class, derived from class |
27801 | @code{Base}, and that the @code{Base} class has a member called | |
27802 | @code{m_size}. Assume a variable @code{c} is has the type of | |
27803 | @code{C} and a variable object @code{C} was created for variable | |
27804 | @code{c}. Then, we'll get this output: | |
27805 | @smallexample | |
27806 | (gdb) -var-info-path-expression C.Base.public.m_size | |
27807 | ^done,path_expr=((Base)c).m_size) | |
27808 | @end smallexample | |
922fbb7b | 27809 | |
a2c02241 NR |
27810 | @subheading The @code{-var-show-attributes} Command |
27811 | @findex -var-show-attributes | |
922fbb7b | 27812 | |
a2c02241 | 27813 | @subsubheading Synopsis |
922fbb7b | 27814 | |
a2c02241 NR |
27815 | @smallexample |
27816 | -var-show-attributes @var{name} | |
27817 | @end smallexample | |
922fbb7b | 27818 | |
a2c02241 | 27819 | List attributes of the specified variable object @var{name}: |
922fbb7b AC |
27820 | |
27821 | @smallexample | |
a2c02241 | 27822 | status=@var{attr} [ ( ,@var{attr} )* ] |
922fbb7b AC |
27823 | @end smallexample |
27824 | ||
a2c02241 NR |
27825 | @noindent |
27826 | where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}. | |
27827 | ||
27828 | @subheading The @code{-var-evaluate-expression} Command | |
27829 | @findex -var-evaluate-expression | |
27830 | ||
27831 | @subsubheading Synopsis | |
27832 | ||
27833 | @smallexample | |
de051565 | 27834 | -var-evaluate-expression [-f @var{format-spec}] @var{name} |
a2c02241 NR |
27835 | @end smallexample |
27836 | ||
27837 | Evaluates the expression that is represented by the specified variable | |
de051565 MK |
27838 | object and returns its value as a string. The format of the string |
27839 | can be specified with the @samp{-f} option. The possible values of | |
27840 | this option are the same as for @code{-var-set-format} | |
27841 | (@pxref{-var-set-format}). If the @samp{-f} option is not specified, | |
27842 | the current display format will be used. The current display format | |
27843 | can be changed using the @code{-var-set-format} command. | |
a2c02241 NR |
27844 | |
27845 | @smallexample | |
27846 | value=@var{value} | |
27847 | @end smallexample | |
27848 | ||
27849 | Note that one must invoke @code{-var-list-children} for a variable | |
27850 | before the value of a child variable can be evaluated. | |
27851 | ||
27852 | @subheading The @code{-var-assign} Command | |
27853 | @findex -var-assign | |
27854 | ||
27855 | @subsubheading Synopsis | |
27856 | ||
27857 | @smallexample | |
27858 | -var-assign @var{name} @var{expression} | |
27859 | @end smallexample | |
27860 | ||
27861 | Assigns the value of @var{expression} to the variable object specified | |
27862 | by @var{name}. The object must be @samp{editable}. If the variable's | |
27863 | value is altered by the assign, the variable will show up in any | |
27864 | subsequent @code{-var-update} list. | |
27865 | ||
27866 | @subsubheading Example | |
922fbb7b AC |
27867 | |
27868 | @smallexample | |
594fe323 | 27869 | (gdb) |
a2c02241 NR |
27870 | -var-assign var1 3 |
27871 | ^done,value="3" | |
594fe323 | 27872 | (gdb) |
a2c02241 NR |
27873 | -var-update * |
27874 | ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}] | |
594fe323 | 27875 | (gdb) |
922fbb7b AC |
27876 | @end smallexample |
27877 | ||
a2c02241 NR |
27878 | @subheading The @code{-var-update} Command |
27879 | @findex -var-update | |
27880 | ||
27881 | @subsubheading Synopsis | |
27882 | ||
27883 | @smallexample | |
27884 | -var-update [@var{print-values}] @{@var{name} | "*"@} | |
27885 | @end smallexample | |
27886 | ||
c8b2f53c VP |
27887 | Reevaluate the expressions corresponding to the variable object |
27888 | @var{name} and all its direct and indirect children, and return the | |
36ece8b3 NR |
27889 | list of variable objects whose values have changed; @var{name} must |
27890 | be a root variable object. Here, ``changed'' means that the result of | |
27891 | @code{-var-evaluate-expression} before and after the | |
27892 | @code{-var-update} is different. If @samp{*} is used as the variable | |
9f708cb2 VP |
27893 | object names, all existing variable objects are updated, except |
27894 | for frozen ones (@pxref{-var-set-frozen}). The option | |
36ece8b3 | 27895 | @var{print-values} determines whether both names and values, or just |
de051565 | 27896 | names are printed. The possible values of this option are the same |
36ece8b3 NR |
27897 | as for @code{-var-list-children} (@pxref{-var-list-children}). It is |
27898 | recommended to use the @samp{--all-values} option, to reduce the | |
27899 | number of MI commands needed on each program stop. | |
c8b2f53c | 27900 | |
c3b108f7 VP |
27901 | With the @samp{*} parameter, if a variable object is bound to a |
27902 | currently running thread, it will not be updated, without any | |
27903 | diagnostic. | |
a2c02241 | 27904 | |
0cc7d26f TT |
27905 | If @code{-var-set-update-range} was previously used on a varobj, then |
27906 | only the selected range of children will be reported. | |
922fbb7b | 27907 | |
0cc7d26f TT |
27908 | @code{-var-update} reports all the changed varobjs in a tuple named |
27909 | @samp{changelist}. | |
27910 | ||
27911 | Each item in the change list is itself a tuple holding: | |
27912 | ||
27913 | @table @samp | |
27914 | @item name | |
27915 | The name of the varobj. | |
27916 | ||
27917 | @item value | |
27918 | If values were requested for this update, then this field will be | |
27919 | present and will hold the value of the varobj. | |
922fbb7b | 27920 | |
0cc7d26f | 27921 | @item in_scope |
9f708cb2 | 27922 | @anchor{-var-update} |
0cc7d26f | 27923 | This field is a string which may take one of three values: |
36ece8b3 NR |
27924 | |
27925 | @table @code | |
27926 | @item "true" | |
27927 | The variable object's current value is valid. | |
27928 | ||
27929 | @item "false" | |
27930 | The variable object does not currently hold a valid value but it may | |
27931 | hold one in the future if its associated expression comes back into | |
27932 | scope. | |
27933 | ||
27934 | @item "invalid" | |
27935 | The variable object no longer holds a valid value. | |
27936 | This can occur when the executable file being debugged has changed, | |
27937 | either through recompilation or by using the @value{GDBN} @code{file} | |
27938 | command. The front end should normally choose to delete these variable | |
27939 | objects. | |
27940 | @end table | |
27941 | ||
27942 | In the future new values may be added to this list so the front should | |
27943 | be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}. | |
27944 | ||
0cc7d26f TT |
27945 | @item type_changed |
27946 | This is only present if the varobj is still valid. If the type | |
27947 | changed, then this will be the string @samp{true}; otherwise it will | |
27948 | be @samp{false}. | |
27949 | ||
27950 | @item new_type | |
27951 | If the varobj's type changed, then this field will be present and will | |
27952 | hold the new type. | |
27953 | ||
27954 | @item new_num_children | |
27955 | For a dynamic varobj, if the number of children changed, or if the | |
27956 | type changed, this will be the new number of children. | |
27957 | ||
27958 | The @samp{numchild} field in other varobj responses is generally not | |
27959 | valid for a dynamic varobj -- it will show the number of children that | |
27960 | @value{GDBN} knows about, but because dynamic varobjs lazily | |
27961 | instantiate their children, this will not reflect the number of | |
27962 | children which may be available. | |
27963 | ||
27964 | The @samp{new_num_children} attribute only reports changes to the | |
27965 | number of children known by @value{GDBN}. This is the only way to | |
27966 | detect whether an update has removed children (which necessarily can | |
27967 | only happen at the end of the update range). | |
27968 | ||
27969 | @item displayhint | |
27970 | The display hint, if any. | |
27971 | ||
27972 | @item has_more | |
27973 | This is an integer value, which will be 1 if there are more children | |
27974 | available outside the varobj's update range. | |
27975 | ||
27976 | @item dynamic | |
27977 | This attribute will be present and have the value @samp{1} if the | |
27978 | varobj is a dynamic varobj. If the varobj is not a dynamic varobj, | |
27979 | then this attribute will not be present. | |
27980 | ||
27981 | @item new_children | |
27982 | If new children were added to a dynamic varobj within the selected | |
27983 | update range (as set by @code{-var-set-update-range}), then they will | |
27984 | be listed in this attribute. | |
27985 | @end table | |
27986 | ||
27987 | @subsubheading Example | |
27988 | ||
27989 | @smallexample | |
27990 | (gdb) | |
27991 | -var-assign var1 3 | |
27992 | ^done,value="3" | |
27993 | (gdb) | |
27994 | -var-update --all-values var1 | |
27995 | ^done,changelist=[@{name="var1",value="3",in_scope="true", | |
27996 | type_changed="false"@}] | |
27997 | (gdb) | |
27998 | @end smallexample | |
27999 | ||
25d5ea92 VP |
28000 | @subheading The @code{-var-set-frozen} Command |
28001 | @findex -var-set-frozen | |
9f708cb2 | 28002 | @anchor{-var-set-frozen} |
25d5ea92 VP |
28003 | |
28004 | @subsubheading Synopsis | |
28005 | ||
28006 | @smallexample | |
9f708cb2 | 28007 | -var-set-frozen @var{name} @var{flag} |
25d5ea92 VP |
28008 | @end smallexample |
28009 | ||
9f708cb2 | 28010 | Set the frozenness flag on the variable object @var{name}. The |
25d5ea92 | 28011 | @var{flag} parameter should be either @samp{1} to make the variable |
9f708cb2 | 28012 | frozen or @samp{0} to make it unfrozen. If a variable object is |
25d5ea92 | 28013 | frozen, then neither itself, nor any of its children, are |
9f708cb2 | 28014 | implicitly updated by @code{-var-update} of |
25d5ea92 VP |
28015 | a parent variable or by @code{-var-update *}. Only |
28016 | @code{-var-update} of the variable itself will update its value and | |
28017 | values of its children. After a variable object is unfrozen, it is | |
28018 | implicitly updated by all subsequent @code{-var-update} operations. | |
28019 | Unfreezing a variable does not update it, only subsequent | |
28020 | @code{-var-update} does. | |
28021 | ||
28022 | @subsubheading Example | |
28023 | ||
28024 | @smallexample | |
28025 | (gdb) | |
28026 | -var-set-frozen V 1 | |
28027 | ^done | |
28028 | (gdb) | |
28029 | @end smallexample | |
28030 | ||
0cc7d26f TT |
28031 | @subheading The @code{-var-set-update-range} command |
28032 | @findex -var-set-update-range | |
28033 | @anchor{-var-set-update-range} | |
28034 | ||
28035 | @subsubheading Synopsis | |
28036 | ||
28037 | @smallexample | |
28038 | -var-set-update-range @var{name} @var{from} @var{to} | |
28039 | @end smallexample | |
28040 | ||
28041 | Set the range of children to be returned by future invocations of | |
28042 | @code{-var-update}. | |
28043 | ||
28044 | @var{from} and @var{to} indicate the range of children to report. If | |
28045 | @var{from} or @var{to} is less than zero, the range is reset and all | |
28046 | children will be reported. Otherwise, children starting at @var{from} | |
28047 | (zero-based) and up to and excluding @var{to} will be reported. | |
28048 | ||
28049 | @subsubheading Example | |
28050 | ||
28051 | @smallexample | |
28052 | (gdb) | |
28053 | -var-set-update-range V 1 2 | |
28054 | ^done | |
28055 | @end smallexample | |
28056 | ||
b6313243 TT |
28057 | @subheading The @code{-var-set-visualizer} command |
28058 | @findex -var-set-visualizer | |
28059 | @anchor{-var-set-visualizer} | |
28060 | ||
28061 | @subsubheading Synopsis | |
28062 | ||
28063 | @smallexample | |
28064 | -var-set-visualizer @var{name} @var{visualizer} | |
28065 | @end smallexample | |
28066 | ||
28067 | Set a visualizer for the variable object @var{name}. | |
28068 | ||
28069 | @var{visualizer} is the visualizer to use. The special value | |
28070 | @samp{None} means to disable any visualizer in use. | |
28071 | ||
28072 | If not @samp{None}, @var{visualizer} must be a Python expression. | |
28073 | This expression must evaluate to a callable object which accepts a | |
28074 | single argument. @value{GDBN} will call this object with the value of | |
28075 | the varobj @var{name} as an argument (this is done so that the same | |
28076 | Python pretty-printing code can be used for both the CLI and MI). | |
28077 | When called, this object must return an object which conforms to the | |
4c374409 | 28078 | pretty-printing interface (@pxref{Pretty Printing API}). |
b6313243 TT |
28079 | |
28080 | The pre-defined function @code{gdb.default_visualizer} may be used to | |
28081 | select a visualizer by following the built-in process | |
28082 | (@pxref{Selecting Pretty-Printers}). This is done automatically when | |
28083 | a varobj is created, and so ordinarily is not needed. | |
28084 | ||
28085 | This feature is only available if Python support is enabled. The MI | |
28086 | command @code{-list-features} (@pxref{GDB/MI Miscellaneous Commands}) | |
28087 | can be used to check this. | |
28088 | ||
28089 | @subsubheading Example | |
28090 | ||
28091 | Resetting the visualizer: | |
28092 | ||
28093 | @smallexample | |
28094 | (gdb) | |
28095 | -var-set-visualizer V None | |
28096 | ^done | |
28097 | @end smallexample | |
28098 | ||
28099 | Reselecting the default (type-based) visualizer: | |
28100 | ||
28101 | @smallexample | |
28102 | (gdb) | |
28103 | -var-set-visualizer V gdb.default_visualizer | |
28104 | ^done | |
28105 | @end smallexample | |
28106 | ||
28107 | Suppose @code{SomeClass} is a visualizer class. A lambda expression | |
28108 | can be used to instantiate this class for a varobj: | |
28109 | ||
28110 | @smallexample | |
28111 | (gdb) | |
28112 | -var-set-visualizer V "lambda val: SomeClass()" | |
28113 | ^done | |
28114 | @end smallexample | |
25d5ea92 | 28115 | |
a2c02241 NR |
28116 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
28117 | @node GDB/MI Data Manipulation | |
28118 | @section @sc{gdb/mi} Data Manipulation | |
922fbb7b | 28119 | |
a2c02241 NR |
28120 | @cindex data manipulation, in @sc{gdb/mi} |
28121 | @cindex @sc{gdb/mi}, data manipulation | |
28122 | This section describes the @sc{gdb/mi} commands that manipulate data: | |
28123 | examine memory and registers, evaluate expressions, etc. | |
28124 | ||
28125 | @c REMOVED FROM THE INTERFACE. | |
28126 | @c @subheading -data-assign | |
28127 | @c Change the value of a program variable. Plenty of side effects. | |
79a6e687 | 28128 | @c @subsubheading GDB Command |
a2c02241 NR |
28129 | @c set variable |
28130 | @c @subsubheading Example | |
28131 | @c N.A. | |
28132 | ||
28133 | @subheading The @code{-data-disassemble} Command | |
28134 | @findex -data-disassemble | |
922fbb7b AC |
28135 | |
28136 | @subsubheading Synopsis | |
28137 | ||
28138 | @smallexample | |
a2c02241 NR |
28139 | -data-disassemble |
28140 | [ -s @var{start-addr} -e @var{end-addr} ] | |
28141 | | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ] | |
28142 | -- @var{mode} | |
922fbb7b AC |
28143 | @end smallexample |
28144 | ||
a2c02241 NR |
28145 | @noindent |
28146 | Where: | |
28147 | ||
28148 | @table @samp | |
28149 | @item @var{start-addr} | |
28150 | is the beginning address (or @code{$pc}) | |
28151 | @item @var{end-addr} | |
28152 | is the end address | |
28153 | @item @var{filename} | |
28154 | is the name of the file to disassemble | |
28155 | @item @var{linenum} | |
28156 | is the line number to disassemble around | |
28157 | @item @var{lines} | |
d3e8051b | 28158 | is the number of disassembly lines to be produced. If it is -1, |
a2c02241 NR |
28159 | the whole function will be disassembled, in case no @var{end-addr} is |
28160 | specified. If @var{end-addr} is specified as a non-zero value, and | |
28161 | @var{lines} is lower than the number of disassembly lines between | |
28162 | @var{start-addr} and @var{end-addr}, only @var{lines} lines are | |
28163 | displayed; if @var{lines} is higher than the number of lines between | |
28164 | @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr} | |
28165 | are displayed. | |
28166 | @item @var{mode} | |
b716877b AB |
28167 | is either 0 (meaning only disassembly), 1 (meaning mixed source and |
28168 | disassembly), 2 (meaning disassembly with raw opcodes), or 3 (meaning | |
28169 | mixed source and disassembly with raw opcodes). | |
a2c02241 NR |
28170 | @end table |
28171 | ||
28172 | @subsubheading Result | |
28173 | ||
28174 | The output for each instruction is composed of four fields: | |
28175 | ||
28176 | @itemize @bullet | |
28177 | @item Address | |
28178 | @item Func-name | |
28179 | @item Offset | |
28180 | @item Instruction | |
28181 | @end itemize | |
28182 | ||
28183 | Note that whatever included in the instruction field, is not manipulated | |
d3e8051b | 28184 | directly by @sc{gdb/mi}, i.e., it is not possible to adjust its format. |
922fbb7b AC |
28185 | |
28186 | @subsubheading @value{GDBN} Command | |
28187 | ||
a2c02241 | 28188 | There's no direct mapping from this command to the CLI. |
922fbb7b AC |
28189 | |
28190 | @subsubheading Example | |
28191 | ||
a2c02241 NR |
28192 | Disassemble from the current value of @code{$pc} to @code{$pc + 20}: |
28193 | ||
922fbb7b | 28194 | @smallexample |
594fe323 | 28195 | (gdb) |
a2c02241 NR |
28196 | -data-disassemble -s $pc -e "$pc + 20" -- 0 |
28197 | ^done, | |
28198 | asm_insns=[ | |
28199 | @{address="0x000107c0",func-name="main",offset="4", | |
28200 | inst="mov 2, %o0"@}, | |
28201 | @{address="0x000107c4",func-name="main",offset="8", | |
28202 | inst="sethi %hi(0x11800), %o2"@}, | |
28203 | @{address="0x000107c8",func-name="main",offset="12", | |
28204 | inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@}, | |
28205 | @{address="0x000107cc",func-name="main",offset="16", | |
28206 | inst="sethi %hi(0x11800), %o2"@}, | |
28207 | @{address="0x000107d0",func-name="main",offset="20", | |
28208 | inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}] | |
594fe323 | 28209 | (gdb) |
a2c02241 NR |
28210 | @end smallexample |
28211 | ||
28212 | Disassemble the whole @code{main} function. Line 32 is part of | |
28213 | @code{main}. | |
28214 | ||
28215 | @smallexample | |
28216 | -data-disassemble -f basics.c -l 32 -- 0 | |
28217 | ^done,asm_insns=[ | |
28218 | @{address="0x000107bc",func-name="main",offset="0", | |
28219 | inst="save %sp, -112, %sp"@}, | |
28220 | @{address="0x000107c0",func-name="main",offset="4", | |
28221 | inst="mov 2, %o0"@}, | |
28222 | @{address="0x000107c4",func-name="main",offset="8", | |
28223 | inst="sethi %hi(0x11800), %o2"@}, | |
28224 | [@dots{}] | |
28225 | @{address="0x0001081c",func-name="main",offset="96",inst="ret "@}, | |
28226 | @{address="0x00010820",func-name="main",offset="100",inst="restore "@}] | |
594fe323 | 28227 | (gdb) |
922fbb7b AC |
28228 | @end smallexample |
28229 | ||
a2c02241 | 28230 | Disassemble 3 instructions from the start of @code{main}: |
922fbb7b | 28231 | |
a2c02241 | 28232 | @smallexample |
594fe323 | 28233 | (gdb) |
a2c02241 NR |
28234 | -data-disassemble -f basics.c -l 32 -n 3 -- 0 |
28235 | ^done,asm_insns=[ | |
28236 | @{address="0x000107bc",func-name="main",offset="0", | |
28237 | inst="save %sp, -112, %sp"@}, | |
28238 | @{address="0x000107c0",func-name="main",offset="4", | |
28239 | inst="mov 2, %o0"@}, | |
28240 | @{address="0x000107c4",func-name="main",offset="8", | |
28241 | inst="sethi %hi(0x11800), %o2"@}] | |
594fe323 | 28242 | (gdb) |
a2c02241 NR |
28243 | @end smallexample |
28244 | ||
28245 | Disassemble 3 instructions from the start of @code{main} in mixed mode: | |
28246 | ||
28247 | @smallexample | |
594fe323 | 28248 | (gdb) |
a2c02241 NR |
28249 | -data-disassemble -f basics.c -l 32 -n 3 -- 1 |
28250 | ^done,asm_insns=[ | |
28251 | src_and_asm_line=@{line="31", | |
28252 | file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ | |
28253 | testsuite/gdb.mi/basics.c",line_asm_insn=[ | |
28254 | @{address="0x000107bc",func-name="main",offset="0", | |
28255 | inst="save %sp, -112, %sp"@}]@}, | |
28256 | src_and_asm_line=@{line="32", | |
28257 | file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ | |
28258 | testsuite/gdb.mi/basics.c",line_asm_insn=[ | |
28259 | @{address="0x000107c0",func-name="main",offset="4", | |
28260 | inst="mov 2, %o0"@}, | |
28261 | @{address="0x000107c4",func-name="main",offset="8", | |
28262 | inst="sethi %hi(0x11800), %o2"@}]@}] | |
594fe323 | 28263 | (gdb) |
a2c02241 NR |
28264 | @end smallexample |
28265 | ||
28266 | ||
28267 | @subheading The @code{-data-evaluate-expression} Command | |
28268 | @findex -data-evaluate-expression | |
922fbb7b AC |
28269 | |
28270 | @subsubheading Synopsis | |
28271 | ||
28272 | @smallexample | |
a2c02241 | 28273 | -data-evaluate-expression @var{expr} |
922fbb7b AC |
28274 | @end smallexample |
28275 | ||
a2c02241 NR |
28276 | Evaluate @var{expr} as an expression. The expression could contain an |
28277 | inferior function call. The function call will execute synchronously. | |
28278 | If the expression contains spaces, it must be enclosed in double quotes. | |
922fbb7b AC |
28279 | |
28280 | @subsubheading @value{GDBN} Command | |
28281 | ||
a2c02241 NR |
28282 | The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and |
28283 | @samp{call}. In @code{gdbtk} only, there's a corresponding | |
28284 | @samp{gdb_eval} command. | |
922fbb7b AC |
28285 | |
28286 | @subsubheading Example | |
28287 | ||
a2c02241 NR |
28288 | In the following example, the numbers that precede the commands are the |
28289 | @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi} | |
28290 | Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its | |
28291 | output. | |
28292 | ||
922fbb7b | 28293 | @smallexample |
a2c02241 NR |
28294 | 211-data-evaluate-expression A |
28295 | 211^done,value="1" | |
594fe323 | 28296 | (gdb) |
a2c02241 NR |
28297 | 311-data-evaluate-expression &A |
28298 | 311^done,value="0xefffeb7c" | |
594fe323 | 28299 | (gdb) |
a2c02241 NR |
28300 | 411-data-evaluate-expression A+3 |
28301 | 411^done,value="4" | |
594fe323 | 28302 | (gdb) |
a2c02241 NR |
28303 | 511-data-evaluate-expression "A + 3" |
28304 | 511^done,value="4" | |
594fe323 | 28305 | (gdb) |
a2c02241 | 28306 | @end smallexample |
922fbb7b AC |
28307 | |
28308 | ||
a2c02241 NR |
28309 | @subheading The @code{-data-list-changed-registers} Command |
28310 | @findex -data-list-changed-registers | |
922fbb7b AC |
28311 | |
28312 | @subsubheading Synopsis | |
28313 | ||
28314 | @smallexample | |
a2c02241 | 28315 | -data-list-changed-registers |
922fbb7b AC |
28316 | @end smallexample |
28317 | ||
a2c02241 | 28318 | Display a list of the registers that have changed. |
922fbb7b AC |
28319 | |
28320 | @subsubheading @value{GDBN} Command | |
28321 | ||
a2c02241 NR |
28322 | @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk} |
28323 | has the corresponding command @samp{gdb_changed_register_list}. | |
922fbb7b AC |
28324 | |
28325 | @subsubheading Example | |
922fbb7b | 28326 | |
a2c02241 | 28327 | On a PPC MBX board: |
922fbb7b AC |
28328 | |
28329 | @smallexample | |
594fe323 | 28330 | (gdb) |
a2c02241 NR |
28331 | -exec-continue |
28332 | ^running | |
922fbb7b | 28333 | |
594fe323 | 28334 | (gdb) |
a47ec5fe AR |
28335 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{ |
28336 | func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c", | |
28337 | line="5"@} | |
594fe323 | 28338 | (gdb) |
a2c02241 NR |
28339 | -data-list-changed-registers |
28340 | ^done,changed-registers=["0","1","2","4","5","6","7","8","9", | |
28341 | "10","11","13","14","15","16","17","18","19","20","21","22","23", | |
28342 | "24","25","26","27","28","30","31","64","65","66","67","69"] | |
594fe323 | 28343 | (gdb) |
a2c02241 | 28344 | @end smallexample |
922fbb7b AC |
28345 | |
28346 | ||
a2c02241 NR |
28347 | @subheading The @code{-data-list-register-names} Command |
28348 | @findex -data-list-register-names | |
922fbb7b AC |
28349 | |
28350 | @subsubheading Synopsis | |
28351 | ||
28352 | @smallexample | |
a2c02241 | 28353 | -data-list-register-names [ ( @var{regno} )+ ] |
922fbb7b AC |
28354 | @end smallexample |
28355 | ||
a2c02241 NR |
28356 | Show a list of register names for the current target. If no arguments |
28357 | are given, it shows a list of the names of all the registers. If | |
28358 | integer numbers are given as arguments, it will print a list of the | |
28359 | names of the registers corresponding to the arguments. To ensure | |
28360 | consistency between a register name and its number, the output list may | |
28361 | include empty register names. | |
922fbb7b AC |
28362 | |
28363 | @subsubheading @value{GDBN} Command | |
28364 | ||
a2c02241 NR |
28365 | @value{GDBN} does not have a command which corresponds to |
28366 | @samp{-data-list-register-names}. In @code{gdbtk} there is a | |
28367 | corresponding command @samp{gdb_regnames}. | |
922fbb7b AC |
28368 | |
28369 | @subsubheading Example | |
922fbb7b | 28370 | |
a2c02241 NR |
28371 | For the PPC MBX board: |
28372 | @smallexample | |
594fe323 | 28373 | (gdb) |
a2c02241 NR |
28374 | -data-list-register-names |
28375 | ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7", | |
28376 | "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18", | |
28377 | "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29", | |
28378 | "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9", | |
28379 | "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20", | |
28380 | "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31", | |
28381 | "", "pc","ps","cr","lr","ctr","xer"] | |
594fe323 | 28382 | (gdb) |
a2c02241 NR |
28383 | -data-list-register-names 1 2 3 |
28384 | ^done,register-names=["r1","r2","r3"] | |
594fe323 | 28385 | (gdb) |
a2c02241 | 28386 | @end smallexample |
922fbb7b | 28387 | |
a2c02241 NR |
28388 | @subheading The @code{-data-list-register-values} Command |
28389 | @findex -data-list-register-values | |
922fbb7b AC |
28390 | |
28391 | @subsubheading Synopsis | |
28392 | ||
28393 | @smallexample | |
a2c02241 | 28394 | -data-list-register-values @var{fmt} [ ( @var{regno} )*] |
922fbb7b AC |
28395 | @end smallexample |
28396 | ||
a2c02241 NR |
28397 | Display the registers' contents. @var{fmt} is the format according to |
28398 | which the registers' contents are to be returned, followed by an optional | |
28399 | list of numbers specifying the registers to display. A missing list of | |
28400 | numbers indicates that the contents of all the registers must be returned. | |
28401 | ||
28402 | Allowed formats for @var{fmt} are: | |
28403 | ||
28404 | @table @code | |
28405 | @item x | |
28406 | Hexadecimal | |
28407 | @item o | |
28408 | Octal | |
28409 | @item t | |
28410 | Binary | |
28411 | @item d | |
28412 | Decimal | |
28413 | @item r | |
28414 | Raw | |
28415 | @item N | |
28416 | Natural | |
28417 | @end table | |
922fbb7b AC |
28418 | |
28419 | @subsubheading @value{GDBN} Command | |
28420 | ||
a2c02241 NR |
28421 | The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info |
28422 | all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}. | |
922fbb7b AC |
28423 | |
28424 | @subsubheading Example | |
922fbb7b | 28425 | |
a2c02241 NR |
28426 | For a PPC MBX board (note: line breaks are for readability only, they |
28427 | don't appear in the actual output): | |
28428 | ||
28429 | @smallexample | |
594fe323 | 28430 | (gdb) |
a2c02241 NR |
28431 | -data-list-register-values r 64 65 |
28432 | ^done,register-values=[@{number="64",value="0xfe00a300"@}, | |
28433 | @{number="65",value="0x00029002"@}] | |
594fe323 | 28434 | (gdb) |
a2c02241 NR |
28435 | -data-list-register-values x |
28436 | ^done,register-values=[@{number="0",value="0xfe0043c8"@}, | |
28437 | @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@}, | |
28438 | @{number="3",value="0x0"@},@{number="4",value="0xa"@}, | |
28439 | @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@}, | |
28440 | @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@}, | |
28441 | @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@}, | |
28442 | @{number="11",value="0x1"@},@{number="12",value="0x0"@}, | |
28443 | @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@}, | |
28444 | @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@}, | |
28445 | @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@}, | |
28446 | @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@}, | |
28447 | @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@}, | |
28448 | @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@}, | |
28449 | @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@}, | |
28450 | @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@}, | |
28451 | @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@}, | |
28452 | @{number="31",value="0x0"@},@{number="32",value="0x0"@}, | |
28453 | @{number="33",value="0x0"@},@{number="34",value="0x0"@}, | |
28454 | @{number="35",value="0x0"@},@{number="36",value="0x0"@}, | |
28455 | @{number="37",value="0x0"@},@{number="38",value="0x0"@}, | |
28456 | @{number="39",value="0x0"@},@{number="40",value="0x0"@}, | |
28457 | @{number="41",value="0x0"@},@{number="42",value="0x0"@}, | |
28458 | @{number="43",value="0x0"@},@{number="44",value="0x0"@}, | |
28459 | @{number="45",value="0x0"@},@{number="46",value="0x0"@}, | |
28460 | @{number="47",value="0x0"@},@{number="48",value="0x0"@}, | |
28461 | @{number="49",value="0x0"@},@{number="50",value="0x0"@}, | |
28462 | @{number="51",value="0x0"@},@{number="52",value="0x0"@}, | |
28463 | @{number="53",value="0x0"@},@{number="54",value="0x0"@}, | |
28464 | @{number="55",value="0x0"@},@{number="56",value="0x0"@}, | |
28465 | @{number="57",value="0x0"@},@{number="58",value="0x0"@}, | |
28466 | @{number="59",value="0x0"@},@{number="60",value="0x0"@}, | |
28467 | @{number="61",value="0x0"@},@{number="62",value="0x0"@}, | |
28468 | @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@}, | |
28469 | @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@}, | |
28470 | @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@}, | |
28471 | @{number="69",value="0x20002b03"@}] | |
594fe323 | 28472 | (gdb) |
a2c02241 | 28473 | @end smallexample |
922fbb7b | 28474 | |
a2c02241 NR |
28475 | |
28476 | @subheading The @code{-data-read-memory} Command | |
28477 | @findex -data-read-memory | |
922fbb7b | 28478 | |
8dedea02 VP |
28479 | This command is deprecated, use @code{-data-read-memory-bytes} instead. |
28480 | ||
922fbb7b AC |
28481 | @subsubheading Synopsis |
28482 | ||
28483 | @smallexample | |
a2c02241 NR |
28484 | -data-read-memory [ -o @var{byte-offset} ] |
28485 | @var{address} @var{word-format} @var{word-size} | |
28486 | @var{nr-rows} @var{nr-cols} [ @var{aschar} ] | |
922fbb7b AC |
28487 | @end smallexample |
28488 | ||
a2c02241 NR |
28489 | @noindent |
28490 | where: | |
922fbb7b | 28491 | |
a2c02241 NR |
28492 | @table @samp |
28493 | @item @var{address} | |
28494 | An expression specifying the address of the first memory word to be | |
28495 | read. Complex expressions containing embedded white space should be | |
28496 | quoted using the C convention. | |
922fbb7b | 28497 | |
a2c02241 NR |
28498 | @item @var{word-format} |
28499 | The format to be used to print the memory words. The notation is the | |
28500 | same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats, | |
79a6e687 | 28501 | ,Output Formats}). |
922fbb7b | 28502 | |
a2c02241 NR |
28503 | @item @var{word-size} |
28504 | The size of each memory word in bytes. | |
922fbb7b | 28505 | |
a2c02241 NR |
28506 | @item @var{nr-rows} |
28507 | The number of rows in the output table. | |
922fbb7b | 28508 | |
a2c02241 NR |
28509 | @item @var{nr-cols} |
28510 | The number of columns in the output table. | |
922fbb7b | 28511 | |
a2c02241 NR |
28512 | @item @var{aschar} |
28513 | If present, indicates that each row should include an @sc{ascii} dump. The | |
28514 | value of @var{aschar} is used as a padding character when a byte is not a | |
28515 | member of the printable @sc{ascii} character set (printable @sc{ascii} | |
28516 | characters are those whose code is between 32 and 126, inclusively). | |
922fbb7b | 28517 | |
a2c02241 NR |
28518 | @item @var{byte-offset} |
28519 | An offset to add to the @var{address} before fetching memory. | |
28520 | @end table | |
922fbb7b | 28521 | |
a2c02241 NR |
28522 | This command displays memory contents as a table of @var{nr-rows} by |
28523 | @var{nr-cols} words, each word being @var{word-size} bytes. In total, | |
28524 | @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read | |
28525 | (returned as @samp{total-bytes}). Should less than the requested number | |
28526 | of bytes be returned by the target, the missing words are identified | |
28527 | using @samp{N/A}. The number of bytes read from the target is returned | |
28528 | in @samp{nr-bytes} and the starting address used to read memory in | |
28529 | @samp{addr}. | |
28530 | ||
28531 | The address of the next/previous row or page is available in | |
28532 | @samp{next-row} and @samp{prev-row}, @samp{next-page} and | |
28533 | @samp{prev-page}. | |
922fbb7b AC |
28534 | |
28535 | @subsubheading @value{GDBN} Command | |
28536 | ||
a2c02241 NR |
28537 | The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has |
28538 | @samp{gdb_get_mem} memory read command. | |
922fbb7b AC |
28539 | |
28540 | @subsubheading Example | |
32e7087d | 28541 | |
a2c02241 NR |
28542 | Read six bytes of memory starting at @code{bytes+6} but then offset by |
28543 | @code{-6} bytes. Format as three rows of two columns. One byte per | |
28544 | word. Display each word in hex. | |
32e7087d JB |
28545 | |
28546 | @smallexample | |
594fe323 | 28547 | (gdb) |
a2c02241 NR |
28548 | 9-data-read-memory -o -6 -- bytes+6 x 1 3 2 |
28549 | 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6", | |
28550 | next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396", | |
28551 | prev-page="0x0000138a",memory=[ | |
28552 | @{addr="0x00001390",data=["0x00","0x01"]@}, | |
28553 | @{addr="0x00001392",data=["0x02","0x03"]@}, | |
28554 | @{addr="0x00001394",data=["0x04","0x05"]@}] | |
594fe323 | 28555 | (gdb) |
32e7087d JB |
28556 | @end smallexample |
28557 | ||
a2c02241 NR |
28558 | Read two bytes of memory starting at address @code{shorts + 64} and |
28559 | display as a single word formatted in decimal. | |
32e7087d | 28560 | |
32e7087d | 28561 | @smallexample |
594fe323 | 28562 | (gdb) |
a2c02241 NR |
28563 | 5-data-read-memory shorts+64 d 2 1 1 |
28564 | 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2", | |
28565 | next-row="0x00001512",prev-row="0x0000150e", | |
28566 | next-page="0x00001512",prev-page="0x0000150e",memory=[ | |
28567 | @{addr="0x00001510",data=["128"]@}] | |
594fe323 | 28568 | (gdb) |
32e7087d JB |
28569 | @end smallexample |
28570 | ||
a2c02241 NR |
28571 | Read thirty two bytes of memory starting at @code{bytes+16} and format |
28572 | as eight rows of four columns. Include a string encoding with @samp{x} | |
28573 | used as the non-printable character. | |
922fbb7b AC |
28574 | |
28575 | @smallexample | |
594fe323 | 28576 | (gdb) |
a2c02241 NR |
28577 | 4-data-read-memory bytes+16 x 1 8 4 x |
28578 | 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32", | |
28579 | next-row="0x000013c0",prev-row="0x0000139c", | |
28580 | next-page="0x000013c0",prev-page="0x00001380",memory=[ | |
28581 | @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@}, | |
28582 | @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@}, | |
28583 | @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@}, | |
28584 | @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@}, | |
28585 | @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@}, | |
28586 | @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@}, | |
28587 | @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@}, | |
28588 | @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}] | |
594fe323 | 28589 | (gdb) |
922fbb7b AC |
28590 | @end smallexample |
28591 | ||
8dedea02 VP |
28592 | @subheading The @code{-data-read-memory-bytes} Command |
28593 | @findex -data-read-memory-bytes | |
28594 | ||
28595 | @subsubheading Synopsis | |
28596 | ||
28597 | @smallexample | |
28598 | -data-read-memory-bytes [ -o @var{byte-offset} ] | |
28599 | @var{address} @var{count} | |
28600 | @end smallexample | |
28601 | ||
28602 | @noindent | |
28603 | where: | |
28604 | ||
28605 | @table @samp | |
28606 | @item @var{address} | |
28607 | An expression specifying the address of the first memory word to be | |
28608 | read. Complex expressions containing embedded white space should be | |
28609 | quoted using the C convention. | |
28610 | ||
28611 | @item @var{count} | |
28612 | The number of bytes to read. This should be an integer literal. | |
28613 | ||
28614 | @item @var{byte-offset} | |
28615 | The offsets in bytes relative to @var{address} at which to start | |
28616 | reading. This should be an integer literal. This option is provided | |
28617 | so that a frontend is not required to first evaluate address and then | |
28618 | perform address arithmetics itself. | |
28619 | ||
28620 | @end table | |
28621 | ||
28622 | This command attempts to read all accessible memory regions in the | |
28623 | specified range. First, all regions marked as unreadable in the memory | |
28624 | map (if one is defined) will be skipped. @xref{Memory Region | |
28625 | Attributes}. Second, @value{GDBN} will attempt to read the remaining | |
28626 | regions. For each one, if reading full region results in an errors, | |
28627 | @value{GDBN} will try to read a subset of the region. | |
28628 | ||
28629 | In general, every single byte in the region may be readable or not, | |
28630 | and the only way to read every readable byte is to try a read at | |
28631 | every address, which is not practical. Therefore, @value{GDBN} will | |
28632 | attempt to read all accessible bytes at either beginning or the end | |
28633 | of the region, using a binary division scheme. This heuristic works | |
28634 | well for reading accross a memory map boundary. Note that if a region | |
28635 | has a readable range that is neither at the beginning or the end, | |
28636 | @value{GDBN} will not read it. | |
28637 | ||
28638 | The result record (@pxref{GDB/MI Result Records}) that is output of | |
28639 | the command includes a field named @samp{memory} whose content is a | |
28640 | list of tuples. Each tuple represent a successfully read memory block | |
28641 | and has the following fields: | |
28642 | ||
28643 | @table @code | |
28644 | @item begin | |
28645 | The start address of the memory block, as hexadecimal literal. | |
28646 | ||
28647 | @item end | |
28648 | The end address of the memory block, as hexadecimal literal. | |
28649 | ||
28650 | @item offset | |
28651 | The offset of the memory block, as hexadecimal literal, relative to | |
28652 | the start address passed to @code{-data-read-memory-bytes}. | |
28653 | ||
28654 | @item contents | |
28655 | The contents of the memory block, in hex. | |
28656 | ||
28657 | @end table | |
28658 | ||
28659 | ||
28660 | ||
28661 | @subsubheading @value{GDBN} Command | |
28662 | ||
28663 | The corresponding @value{GDBN} command is @samp{x}. | |
28664 | ||
28665 | @subsubheading Example | |
28666 | ||
28667 | @smallexample | |
28668 | (gdb) | |
28669 | -data-read-memory-bytes &a 10 | |
28670 | ^done,memory=[@{begin="0xbffff154",offset="0x00000000", | |
28671 | end="0xbffff15e", | |
28672 | contents="01000000020000000300"@}] | |
28673 | (gdb) | |
28674 | @end smallexample | |
28675 | ||
28676 | ||
28677 | @subheading The @code{-data-write-memory-bytes} Command | |
28678 | @findex -data-write-memory-bytes | |
28679 | ||
28680 | @subsubheading Synopsis | |
28681 | ||
28682 | @smallexample | |
28683 | -data-write-memory-bytes @var{address} @var{contents} | |
28684 | @end smallexample | |
28685 | ||
28686 | @noindent | |
28687 | where: | |
28688 | ||
28689 | @table @samp | |
28690 | @item @var{address} | |
28691 | An expression specifying the address of the first memory word to be | |
28692 | read. Complex expressions containing embedded white space should be | |
28693 | quoted using the C convention. | |
28694 | ||
28695 | @item @var{contents} | |
28696 | The hex-encoded bytes to write. | |
28697 | ||
28698 | @end table | |
28699 | ||
28700 | @subsubheading @value{GDBN} Command | |
28701 | ||
28702 | There's no corresponding @value{GDBN} command. | |
28703 | ||
28704 | @subsubheading Example | |
28705 | ||
28706 | @smallexample | |
28707 | (gdb) | |
28708 | -data-write-memory-bytes &a "aabbccdd" | |
28709 | ^done | |
28710 | (gdb) | |
28711 | @end smallexample | |
28712 | ||
28713 | ||
a2c02241 NR |
28714 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
28715 | @node GDB/MI Tracepoint Commands | |
28716 | @section @sc{gdb/mi} Tracepoint Commands | |
922fbb7b | 28717 | |
18148017 VP |
28718 | The commands defined in this section implement MI support for |
28719 | tracepoints. For detailed introduction, see @ref{Tracepoints}. | |
28720 | ||
28721 | @subheading The @code{-trace-find} Command | |
28722 | @findex -trace-find | |
28723 | ||
28724 | @subsubheading Synopsis | |
28725 | ||
28726 | @smallexample | |
28727 | -trace-find @var{mode} [@var{parameters}@dots{}] | |
28728 | @end smallexample | |
28729 | ||
28730 | Find a trace frame using criteria defined by @var{mode} and | |
28731 | @var{parameters}. The following table lists permissible | |
28732 | modes and their parameters. For details of operation, see @ref{tfind}. | |
28733 | ||
28734 | @table @samp | |
28735 | ||
28736 | @item none | |
28737 | No parameters are required. Stops examining trace frames. | |
28738 | ||
28739 | @item frame-number | |
28740 | An integer is required as parameter. Selects tracepoint frame with | |
28741 | that index. | |
28742 | ||
28743 | @item tracepoint-number | |
28744 | An integer is required as parameter. Finds next | |
28745 | trace frame that corresponds to tracepoint with the specified number. | |
28746 | ||
28747 | @item pc | |
28748 | An address is required as parameter. Finds | |
28749 | next trace frame that corresponds to any tracepoint at the specified | |
28750 | address. | |
28751 | ||
28752 | @item pc-inside-range | |
28753 | Two addresses are required as parameters. Finds next trace | |
28754 | frame that corresponds to a tracepoint at an address inside the | |
28755 | specified range. Both bounds are considered to be inside the range. | |
28756 | ||
28757 | @item pc-outside-range | |
28758 | Two addresses are required as parameters. Finds | |
28759 | next trace frame that corresponds to a tracepoint at an address outside | |
28760 | the specified range. Both bounds are considered to be inside the range. | |
28761 | ||
28762 | @item line | |
28763 | Line specification is required as parameter. @xref{Specify Location}. | |
28764 | Finds next trace frame that corresponds to a tracepoint at | |
28765 | the specified location. | |
28766 | ||
28767 | @end table | |
28768 | ||
28769 | If @samp{none} was passed as @var{mode}, the response does not | |
28770 | have fields. Otherwise, the response may have the following fields: | |
28771 | ||
28772 | @table @samp | |
28773 | @item found | |
28774 | This field has either @samp{0} or @samp{1} as the value, depending | |
28775 | on whether a matching tracepoint was found. | |
28776 | ||
28777 | @item traceframe | |
28778 | The index of the found traceframe. This field is present iff | |
28779 | the @samp{found} field has value of @samp{1}. | |
28780 | ||
28781 | @item tracepoint | |
28782 | The index of the found tracepoint. This field is present iff | |
28783 | the @samp{found} field has value of @samp{1}. | |
28784 | ||
28785 | @item frame | |
28786 | The information about the frame corresponding to the found trace | |
28787 | frame. This field is present only if a trace frame was found. | |
cd64ee31 | 28788 | @xref{GDB/MI Frame Information}, for description of this field. |
18148017 VP |
28789 | |
28790 | @end table | |
28791 | ||
7d13fe92 SS |
28792 | @subsubheading @value{GDBN} Command |
28793 | ||
28794 | The corresponding @value{GDBN} command is @samp{tfind}. | |
28795 | ||
18148017 VP |
28796 | @subheading -trace-define-variable |
28797 | @findex -trace-define-variable | |
28798 | ||
28799 | @subsubheading Synopsis | |
28800 | ||
28801 | @smallexample | |
28802 | -trace-define-variable @var{name} [ @var{value} ] | |
28803 | @end smallexample | |
28804 | ||
28805 | Create trace variable @var{name} if it does not exist. If | |
28806 | @var{value} is specified, sets the initial value of the specified | |
28807 | trace variable to that value. Note that the @var{name} should start | |
28808 | with the @samp{$} character. | |
28809 | ||
7d13fe92 SS |
28810 | @subsubheading @value{GDBN} Command |
28811 | ||
28812 | The corresponding @value{GDBN} command is @samp{tvariable}. | |
28813 | ||
18148017 VP |
28814 | @subheading -trace-list-variables |
28815 | @findex -trace-list-variables | |
922fbb7b | 28816 | |
18148017 | 28817 | @subsubheading Synopsis |
922fbb7b | 28818 | |
18148017 VP |
28819 | @smallexample |
28820 | -trace-list-variables | |
28821 | @end smallexample | |
922fbb7b | 28822 | |
18148017 VP |
28823 | Return a table of all defined trace variables. Each element of the |
28824 | table has the following fields: | |
922fbb7b | 28825 | |
18148017 VP |
28826 | @table @samp |
28827 | @item name | |
28828 | The name of the trace variable. This field is always present. | |
922fbb7b | 28829 | |
18148017 VP |
28830 | @item initial |
28831 | The initial value. This is a 64-bit signed integer. This | |
28832 | field is always present. | |
922fbb7b | 28833 | |
18148017 VP |
28834 | @item current |
28835 | The value the trace variable has at the moment. This is a 64-bit | |
28836 | signed integer. This field is absent iff current value is | |
28837 | not defined, for example if the trace was never run, or is | |
28838 | presently running. | |
922fbb7b | 28839 | |
18148017 | 28840 | @end table |
922fbb7b | 28841 | |
7d13fe92 SS |
28842 | @subsubheading @value{GDBN} Command |
28843 | ||
28844 | The corresponding @value{GDBN} command is @samp{tvariables}. | |
28845 | ||
18148017 | 28846 | @subsubheading Example |
922fbb7b | 28847 | |
18148017 VP |
28848 | @smallexample |
28849 | (gdb) | |
28850 | -trace-list-variables | |
28851 | ^done,trace-variables=@{nr_rows="1",nr_cols="3", | |
28852 | hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@}, | |
28853 | @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@}, | |
28854 | @{width="11",alignment="-1",col_name="current",colhdr="Current"@}], | |
28855 | body=[variable=@{name="$trace_timestamp",initial="0"@} | |
28856 | variable=@{name="$foo",initial="10",current="15"@}]@} | |
28857 | (gdb) | |
28858 | @end smallexample | |
922fbb7b | 28859 | |
18148017 VP |
28860 | @subheading -trace-save |
28861 | @findex -trace-save | |
922fbb7b | 28862 | |
18148017 VP |
28863 | @subsubheading Synopsis |
28864 | ||
28865 | @smallexample | |
28866 | -trace-save [-r ] @var{filename} | |
28867 | @end smallexample | |
28868 | ||
28869 | Saves the collected trace data to @var{filename}. Without the | |
28870 | @samp{-r} option, the data is downloaded from the target and saved | |
28871 | in a local file. With the @samp{-r} option the target is asked | |
28872 | to perform the save. | |
28873 | ||
7d13fe92 SS |
28874 | @subsubheading @value{GDBN} Command |
28875 | ||
28876 | The corresponding @value{GDBN} command is @samp{tsave}. | |
28877 | ||
18148017 VP |
28878 | |
28879 | @subheading -trace-start | |
28880 | @findex -trace-start | |
28881 | ||
28882 | @subsubheading Synopsis | |
28883 | ||
28884 | @smallexample | |
28885 | -trace-start | |
28886 | @end smallexample | |
922fbb7b | 28887 | |
18148017 VP |
28888 | Starts a tracing experiments. The result of this command does not |
28889 | have any fields. | |
922fbb7b | 28890 | |
7d13fe92 SS |
28891 | @subsubheading @value{GDBN} Command |
28892 | ||
28893 | The corresponding @value{GDBN} command is @samp{tstart}. | |
28894 | ||
18148017 VP |
28895 | @subheading -trace-status |
28896 | @findex -trace-status | |
922fbb7b | 28897 | |
18148017 VP |
28898 | @subsubheading Synopsis |
28899 | ||
28900 | @smallexample | |
28901 | -trace-status | |
28902 | @end smallexample | |
28903 | ||
a97153c7 | 28904 | Obtains the status of a tracing experiment. The result may include |
18148017 VP |
28905 | the following fields: |
28906 | ||
28907 | @table @samp | |
28908 | ||
28909 | @item supported | |
28910 | May have a value of either @samp{0}, when no tracing operations are | |
28911 | supported, @samp{1}, when all tracing operations are supported, or | |
28912 | @samp{file} when examining trace file. In the latter case, examining | |
28913 | of trace frame is possible but new tracing experiement cannot be | |
28914 | started. This field is always present. | |
28915 | ||
28916 | @item running | |
28917 | May have a value of either @samp{0} or @samp{1} depending on whether | |
28918 | tracing experiement is in progress on target. This field is present | |
28919 | if @samp{supported} field is not @samp{0}. | |
28920 | ||
28921 | @item stop-reason | |
28922 | Report the reason why the tracing was stopped last time. This field | |
28923 | may be absent iff tracing was never stopped on target yet. The | |
28924 | value of @samp{request} means the tracing was stopped as result of | |
28925 | the @code{-trace-stop} command. The value of @samp{overflow} means | |
28926 | the tracing buffer is full. The value of @samp{disconnection} means | |
28927 | tracing was automatically stopped when @value{GDBN} has disconnected. | |
28928 | The value of @samp{passcount} means tracing was stopped when a | |
28929 | tracepoint was passed a maximal number of times for that tracepoint. | |
28930 | This field is present if @samp{supported} field is not @samp{0}. | |
28931 | ||
28932 | @item stopping-tracepoint | |
28933 | The number of tracepoint whose passcount as exceeded. This field is | |
28934 | present iff the @samp{stop-reason} field has the value of | |
28935 | @samp{passcount}. | |
28936 | ||
28937 | @item frames | |
87290684 SS |
28938 | @itemx frames-created |
28939 | The @samp{frames} field is a count of the total number of trace frames | |
28940 | in the trace buffer, while @samp{frames-created} is the total created | |
28941 | during the run, including ones that were discarded, such as when a | |
28942 | circular trace buffer filled up. Both fields are optional. | |
18148017 VP |
28943 | |
28944 | @item buffer-size | |
28945 | @itemx buffer-free | |
28946 | These fields tell the current size of the tracing buffer and the | |
87290684 | 28947 | remaining space. These fields are optional. |
18148017 | 28948 | |
a97153c7 PA |
28949 | @item circular |
28950 | The value of the circular trace buffer flag. @code{1} means that the | |
28951 | trace buffer is circular and old trace frames will be discarded if | |
28952 | necessary to make room, @code{0} means that the trace buffer is linear | |
28953 | and may fill up. | |
28954 | ||
28955 | @item disconnected | |
28956 | The value of the disconnected tracing flag. @code{1} means that | |
28957 | tracing will continue after @value{GDBN} disconnects, @code{0} means | |
28958 | that the trace run will stop. | |
28959 | ||
18148017 VP |
28960 | @end table |
28961 | ||
7d13fe92 SS |
28962 | @subsubheading @value{GDBN} Command |
28963 | ||
28964 | The corresponding @value{GDBN} command is @samp{tstatus}. | |
28965 | ||
18148017 VP |
28966 | @subheading -trace-stop |
28967 | @findex -trace-stop | |
28968 | ||
28969 | @subsubheading Synopsis | |
28970 | ||
28971 | @smallexample | |
28972 | -trace-stop | |
28973 | @end smallexample | |
922fbb7b | 28974 | |
18148017 VP |
28975 | Stops a tracing experiment. The result of this command has the same |
28976 | fields as @code{-trace-status}, except that the @samp{supported} and | |
28977 | @samp{running} fields are not output. | |
922fbb7b | 28978 | |
7d13fe92 SS |
28979 | @subsubheading @value{GDBN} Command |
28980 | ||
28981 | The corresponding @value{GDBN} command is @samp{tstop}. | |
28982 | ||
922fbb7b | 28983 | |
a2c02241 NR |
28984 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
28985 | @node GDB/MI Symbol Query | |
28986 | @section @sc{gdb/mi} Symbol Query Commands | |
922fbb7b AC |
28987 | |
28988 | ||
9901a55b | 28989 | @ignore |
a2c02241 NR |
28990 | @subheading The @code{-symbol-info-address} Command |
28991 | @findex -symbol-info-address | |
922fbb7b AC |
28992 | |
28993 | @subsubheading Synopsis | |
28994 | ||
28995 | @smallexample | |
a2c02241 | 28996 | -symbol-info-address @var{symbol} |
922fbb7b AC |
28997 | @end smallexample |
28998 | ||
a2c02241 | 28999 | Describe where @var{symbol} is stored. |
922fbb7b AC |
29000 | |
29001 | @subsubheading @value{GDBN} Command | |
29002 | ||
a2c02241 | 29003 | The corresponding @value{GDBN} command is @samp{info address}. |
922fbb7b AC |
29004 | |
29005 | @subsubheading Example | |
29006 | N.A. | |
29007 | ||
29008 | ||
a2c02241 NR |
29009 | @subheading The @code{-symbol-info-file} Command |
29010 | @findex -symbol-info-file | |
922fbb7b AC |
29011 | |
29012 | @subsubheading Synopsis | |
29013 | ||
29014 | @smallexample | |
a2c02241 | 29015 | -symbol-info-file |
922fbb7b AC |
29016 | @end smallexample |
29017 | ||
a2c02241 | 29018 | Show the file for the symbol. |
922fbb7b | 29019 | |
a2c02241 | 29020 | @subsubheading @value{GDBN} Command |
922fbb7b | 29021 | |
a2c02241 NR |
29022 | There's no equivalent @value{GDBN} command. @code{gdbtk} has |
29023 | @samp{gdb_find_file}. | |
922fbb7b AC |
29024 | |
29025 | @subsubheading Example | |
29026 | N.A. | |
29027 | ||
29028 | ||
a2c02241 NR |
29029 | @subheading The @code{-symbol-info-function} Command |
29030 | @findex -symbol-info-function | |
922fbb7b AC |
29031 | |
29032 | @subsubheading Synopsis | |
29033 | ||
29034 | @smallexample | |
a2c02241 | 29035 | -symbol-info-function |
922fbb7b AC |
29036 | @end smallexample |
29037 | ||
a2c02241 | 29038 | Show which function the symbol lives in. |
922fbb7b AC |
29039 | |
29040 | @subsubheading @value{GDBN} Command | |
29041 | ||
a2c02241 | 29042 | @samp{gdb_get_function} in @code{gdbtk}. |
922fbb7b AC |
29043 | |
29044 | @subsubheading Example | |
29045 | N.A. | |
29046 | ||
29047 | ||
a2c02241 NR |
29048 | @subheading The @code{-symbol-info-line} Command |
29049 | @findex -symbol-info-line | |
922fbb7b AC |
29050 | |
29051 | @subsubheading Synopsis | |
29052 | ||
29053 | @smallexample | |
a2c02241 | 29054 | -symbol-info-line |
922fbb7b AC |
29055 | @end smallexample |
29056 | ||
a2c02241 | 29057 | Show the core addresses of the code for a source line. |
922fbb7b | 29058 | |
a2c02241 | 29059 | @subsubheading @value{GDBN} Command |
922fbb7b | 29060 | |
a2c02241 NR |
29061 | The corresponding @value{GDBN} command is @samp{info line}. |
29062 | @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands. | |
922fbb7b AC |
29063 | |
29064 | @subsubheading Example | |
a2c02241 | 29065 | N.A. |
922fbb7b AC |
29066 | |
29067 | ||
a2c02241 NR |
29068 | @subheading The @code{-symbol-info-symbol} Command |
29069 | @findex -symbol-info-symbol | |
07f31aa6 DJ |
29070 | |
29071 | @subsubheading Synopsis | |
29072 | ||
a2c02241 NR |
29073 | @smallexample |
29074 | -symbol-info-symbol @var{addr} | |
29075 | @end smallexample | |
07f31aa6 | 29076 | |
a2c02241 | 29077 | Describe what symbol is at location @var{addr}. |
07f31aa6 | 29078 | |
a2c02241 | 29079 | @subsubheading @value{GDBN} Command |
07f31aa6 | 29080 | |
a2c02241 | 29081 | The corresponding @value{GDBN} command is @samp{info symbol}. |
07f31aa6 DJ |
29082 | |
29083 | @subsubheading Example | |
a2c02241 | 29084 | N.A. |
07f31aa6 DJ |
29085 | |
29086 | ||
a2c02241 NR |
29087 | @subheading The @code{-symbol-list-functions} Command |
29088 | @findex -symbol-list-functions | |
922fbb7b AC |
29089 | |
29090 | @subsubheading Synopsis | |
29091 | ||
29092 | @smallexample | |
a2c02241 | 29093 | -symbol-list-functions |
922fbb7b AC |
29094 | @end smallexample |
29095 | ||
a2c02241 | 29096 | List the functions in the executable. |
922fbb7b AC |
29097 | |
29098 | @subsubheading @value{GDBN} Command | |
29099 | ||
a2c02241 NR |
29100 | @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and |
29101 | @samp{gdb_search} in @code{gdbtk}. | |
922fbb7b AC |
29102 | |
29103 | @subsubheading Example | |
a2c02241 | 29104 | N.A. |
9901a55b | 29105 | @end ignore |
922fbb7b AC |
29106 | |
29107 | ||
a2c02241 NR |
29108 | @subheading The @code{-symbol-list-lines} Command |
29109 | @findex -symbol-list-lines | |
922fbb7b AC |
29110 | |
29111 | @subsubheading Synopsis | |
29112 | ||
29113 | @smallexample | |
a2c02241 | 29114 | -symbol-list-lines @var{filename} |
922fbb7b AC |
29115 | @end smallexample |
29116 | ||
a2c02241 NR |
29117 | Print the list of lines that contain code and their associated program |
29118 | addresses for the given source filename. The entries are sorted in | |
29119 | ascending PC order. | |
922fbb7b AC |
29120 | |
29121 | @subsubheading @value{GDBN} Command | |
29122 | ||
a2c02241 | 29123 | There is no corresponding @value{GDBN} command. |
922fbb7b AC |
29124 | |
29125 | @subsubheading Example | |
a2c02241 | 29126 | @smallexample |
594fe323 | 29127 | (gdb) |
a2c02241 NR |
29128 | -symbol-list-lines basics.c |
29129 | ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}] | |
594fe323 | 29130 | (gdb) |
a2c02241 | 29131 | @end smallexample |
922fbb7b AC |
29132 | |
29133 | ||
9901a55b | 29134 | @ignore |
a2c02241 NR |
29135 | @subheading The @code{-symbol-list-types} Command |
29136 | @findex -symbol-list-types | |
922fbb7b AC |
29137 | |
29138 | @subsubheading Synopsis | |
29139 | ||
29140 | @smallexample | |
a2c02241 | 29141 | -symbol-list-types |
922fbb7b AC |
29142 | @end smallexample |
29143 | ||
a2c02241 | 29144 | List all the type names. |
922fbb7b AC |
29145 | |
29146 | @subsubheading @value{GDBN} Command | |
29147 | ||
a2c02241 NR |
29148 | The corresponding commands are @samp{info types} in @value{GDBN}, |
29149 | @samp{gdb_search} in @code{gdbtk}. | |
922fbb7b AC |
29150 | |
29151 | @subsubheading Example | |
29152 | N.A. | |
29153 | ||
29154 | ||
a2c02241 NR |
29155 | @subheading The @code{-symbol-list-variables} Command |
29156 | @findex -symbol-list-variables | |
922fbb7b AC |
29157 | |
29158 | @subsubheading Synopsis | |
29159 | ||
29160 | @smallexample | |
a2c02241 | 29161 | -symbol-list-variables |
922fbb7b AC |
29162 | @end smallexample |
29163 | ||
a2c02241 | 29164 | List all the global and static variable names. |
922fbb7b AC |
29165 | |
29166 | @subsubheading @value{GDBN} Command | |
29167 | ||
a2c02241 | 29168 | @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}. |
922fbb7b AC |
29169 | |
29170 | @subsubheading Example | |
29171 | N.A. | |
29172 | ||
29173 | ||
a2c02241 NR |
29174 | @subheading The @code{-symbol-locate} Command |
29175 | @findex -symbol-locate | |
922fbb7b AC |
29176 | |
29177 | @subsubheading Synopsis | |
29178 | ||
29179 | @smallexample | |
a2c02241 | 29180 | -symbol-locate |
922fbb7b AC |
29181 | @end smallexample |
29182 | ||
922fbb7b AC |
29183 | @subsubheading @value{GDBN} Command |
29184 | ||
a2c02241 | 29185 | @samp{gdb_loc} in @code{gdbtk}. |
922fbb7b AC |
29186 | |
29187 | @subsubheading Example | |
29188 | N.A. | |
29189 | ||
29190 | ||
a2c02241 NR |
29191 | @subheading The @code{-symbol-type} Command |
29192 | @findex -symbol-type | |
922fbb7b AC |
29193 | |
29194 | @subsubheading Synopsis | |
29195 | ||
29196 | @smallexample | |
a2c02241 | 29197 | -symbol-type @var{variable} |
922fbb7b AC |
29198 | @end smallexample |
29199 | ||
a2c02241 | 29200 | Show type of @var{variable}. |
922fbb7b | 29201 | |
a2c02241 | 29202 | @subsubheading @value{GDBN} Command |
922fbb7b | 29203 | |
a2c02241 NR |
29204 | The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has |
29205 | @samp{gdb_obj_variable}. | |
29206 | ||
29207 | @subsubheading Example | |
29208 | N.A. | |
9901a55b | 29209 | @end ignore |
a2c02241 NR |
29210 | |
29211 | ||
29212 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
29213 | @node GDB/MI File Commands | |
29214 | @section @sc{gdb/mi} File Commands | |
29215 | ||
29216 | This section describes the GDB/MI commands to specify executable file names | |
29217 | and to read in and obtain symbol table information. | |
29218 | ||
29219 | @subheading The @code{-file-exec-and-symbols} Command | |
29220 | @findex -file-exec-and-symbols | |
29221 | ||
29222 | @subsubheading Synopsis | |
922fbb7b AC |
29223 | |
29224 | @smallexample | |
a2c02241 | 29225 | -file-exec-and-symbols @var{file} |
922fbb7b AC |
29226 | @end smallexample |
29227 | ||
a2c02241 NR |
29228 | Specify the executable file to be debugged. This file is the one from |
29229 | which the symbol table is also read. If no file is specified, the | |
29230 | command clears the executable and symbol information. If breakpoints | |
29231 | are set when using this command with no arguments, @value{GDBN} will produce | |
29232 | error messages. Otherwise, no output is produced, except a completion | |
29233 | notification. | |
29234 | ||
922fbb7b AC |
29235 | @subsubheading @value{GDBN} Command |
29236 | ||
a2c02241 | 29237 | The corresponding @value{GDBN} command is @samp{file}. |
922fbb7b AC |
29238 | |
29239 | @subsubheading Example | |
29240 | ||
29241 | @smallexample | |
594fe323 | 29242 | (gdb) |
a2c02241 NR |
29243 | -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
29244 | ^done | |
594fe323 | 29245 | (gdb) |
922fbb7b AC |
29246 | @end smallexample |
29247 | ||
922fbb7b | 29248 | |
a2c02241 NR |
29249 | @subheading The @code{-file-exec-file} Command |
29250 | @findex -file-exec-file | |
922fbb7b AC |
29251 | |
29252 | @subsubheading Synopsis | |
29253 | ||
29254 | @smallexample | |
a2c02241 | 29255 | -file-exec-file @var{file} |
922fbb7b AC |
29256 | @end smallexample |
29257 | ||
a2c02241 NR |
29258 | Specify the executable file to be debugged. Unlike |
29259 | @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read | |
29260 | from this file. If used without argument, @value{GDBN} clears the information | |
29261 | about the executable file. No output is produced, except a completion | |
29262 | notification. | |
922fbb7b | 29263 | |
a2c02241 NR |
29264 | @subsubheading @value{GDBN} Command |
29265 | ||
29266 | The corresponding @value{GDBN} command is @samp{exec-file}. | |
922fbb7b AC |
29267 | |
29268 | @subsubheading Example | |
a2c02241 NR |
29269 | |
29270 | @smallexample | |
594fe323 | 29271 | (gdb) |
a2c02241 NR |
29272 | -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
29273 | ^done | |
594fe323 | 29274 | (gdb) |
a2c02241 | 29275 | @end smallexample |
922fbb7b AC |
29276 | |
29277 | ||
9901a55b | 29278 | @ignore |
a2c02241 NR |
29279 | @subheading The @code{-file-list-exec-sections} Command |
29280 | @findex -file-list-exec-sections | |
922fbb7b AC |
29281 | |
29282 | @subsubheading Synopsis | |
29283 | ||
29284 | @smallexample | |
a2c02241 | 29285 | -file-list-exec-sections |
922fbb7b AC |
29286 | @end smallexample |
29287 | ||
a2c02241 NR |
29288 | List the sections of the current executable file. |
29289 | ||
922fbb7b AC |
29290 | @subsubheading @value{GDBN} Command |
29291 | ||
a2c02241 NR |
29292 | The @value{GDBN} command @samp{info file} shows, among the rest, the same |
29293 | information as this command. @code{gdbtk} has a corresponding command | |
29294 | @samp{gdb_load_info}. | |
922fbb7b AC |
29295 | |
29296 | @subsubheading Example | |
29297 | N.A. | |
9901a55b | 29298 | @end ignore |
922fbb7b AC |
29299 | |
29300 | ||
a2c02241 NR |
29301 | @subheading The @code{-file-list-exec-source-file} Command |
29302 | @findex -file-list-exec-source-file | |
922fbb7b AC |
29303 | |
29304 | @subsubheading Synopsis | |
29305 | ||
29306 | @smallexample | |
a2c02241 | 29307 | -file-list-exec-source-file |
922fbb7b AC |
29308 | @end smallexample |
29309 | ||
a2c02241 | 29310 | List the line number, the current source file, and the absolute path |
44288b44 NR |
29311 | to the current source file for the current executable. The macro |
29312 | information field has a value of @samp{1} or @samp{0} depending on | |
29313 | whether or not the file includes preprocessor macro information. | |
922fbb7b AC |
29314 | |
29315 | @subsubheading @value{GDBN} Command | |
29316 | ||
a2c02241 | 29317 | The @value{GDBN} equivalent is @samp{info source} |
922fbb7b AC |
29318 | |
29319 | @subsubheading Example | |
29320 | ||
922fbb7b | 29321 | @smallexample |
594fe323 | 29322 | (gdb) |
a2c02241 | 29323 | 123-file-list-exec-source-file |
44288b44 | 29324 | 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1" |
594fe323 | 29325 | (gdb) |
922fbb7b AC |
29326 | @end smallexample |
29327 | ||
29328 | ||
a2c02241 NR |
29329 | @subheading The @code{-file-list-exec-source-files} Command |
29330 | @findex -file-list-exec-source-files | |
922fbb7b AC |
29331 | |
29332 | @subsubheading Synopsis | |
29333 | ||
29334 | @smallexample | |
a2c02241 | 29335 | -file-list-exec-source-files |
922fbb7b AC |
29336 | @end smallexample |
29337 | ||
a2c02241 NR |
29338 | List the source files for the current executable. |
29339 | ||
3f94c067 BW |
29340 | It will always output the filename, but only when @value{GDBN} can find |
29341 | the absolute file name of a source file, will it output the fullname. | |
922fbb7b AC |
29342 | |
29343 | @subsubheading @value{GDBN} Command | |
29344 | ||
a2c02241 NR |
29345 | The @value{GDBN} equivalent is @samp{info sources}. |
29346 | @code{gdbtk} has an analogous command @samp{gdb_listfiles}. | |
922fbb7b AC |
29347 | |
29348 | @subsubheading Example | |
922fbb7b | 29349 | @smallexample |
594fe323 | 29350 | (gdb) |
a2c02241 NR |
29351 | -file-list-exec-source-files |
29352 | ^done,files=[ | |
29353 | @{file=foo.c,fullname=/home/foo.c@}, | |
29354 | @{file=/home/bar.c,fullname=/home/bar.c@}, | |
29355 | @{file=gdb_could_not_find_fullpath.c@}] | |
594fe323 | 29356 | (gdb) |
922fbb7b AC |
29357 | @end smallexample |
29358 | ||
9901a55b | 29359 | @ignore |
a2c02241 NR |
29360 | @subheading The @code{-file-list-shared-libraries} Command |
29361 | @findex -file-list-shared-libraries | |
922fbb7b | 29362 | |
a2c02241 | 29363 | @subsubheading Synopsis |
922fbb7b | 29364 | |
a2c02241 NR |
29365 | @smallexample |
29366 | -file-list-shared-libraries | |
29367 | @end smallexample | |
922fbb7b | 29368 | |
a2c02241 | 29369 | List the shared libraries in the program. |
922fbb7b | 29370 | |
a2c02241 | 29371 | @subsubheading @value{GDBN} Command |
922fbb7b | 29372 | |
a2c02241 | 29373 | The corresponding @value{GDBN} command is @samp{info shared}. |
922fbb7b | 29374 | |
a2c02241 NR |
29375 | @subsubheading Example |
29376 | N.A. | |
922fbb7b AC |
29377 | |
29378 | ||
a2c02241 NR |
29379 | @subheading The @code{-file-list-symbol-files} Command |
29380 | @findex -file-list-symbol-files | |
922fbb7b | 29381 | |
a2c02241 | 29382 | @subsubheading Synopsis |
922fbb7b | 29383 | |
a2c02241 NR |
29384 | @smallexample |
29385 | -file-list-symbol-files | |
29386 | @end smallexample | |
922fbb7b | 29387 | |
a2c02241 | 29388 | List symbol files. |
922fbb7b | 29389 | |
a2c02241 | 29390 | @subsubheading @value{GDBN} Command |
922fbb7b | 29391 | |
a2c02241 | 29392 | The corresponding @value{GDBN} command is @samp{info file} (part of it). |
922fbb7b | 29393 | |
a2c02241 NR |
29394 | @subsubheading Example |
29395 | N.A. | |
9901a55b | 29396 | @end ignore |
922fbb7b | 29397 | |
922fbb7b | 29398 | |
a2c02241 NR |
29399 | @subheading The @code{-file-symbol-file} Command |
29400 | @findex -file-symbol-file | |
922fbb7b | 29401 | |
a2c02241 | 29402 | @subsubheading Synopsis |
922fbb7b | 29403 | |
a2c02241 NR |
29404 | @smallexample |
29405 | -file-symbol-file @var{file} | |
29406 | @end smallexample | |
922fbb7b | 29407 | |
a2c02241 NR |
29408 | Read symbol table info from the specified @var{file} argument. When |
29409 | used without arguments, clears @value{GDBN}'s symbol table info. No output is | |
29410 | produced, except for a completion notification. | |
922fbb7b | 29411 | |
a2c02241 | 29412 | @subsubheading @value{GDBN} Command |
922fbb7b | 29413 | |
a2c02241 | 29414 | The corresponding @value{GDBN} command is @samp{symbol-file}. |
922fbb7b | 29415 | |
a2c02241 | 29416 | @subsubheading Example |
922fbb7b | 29417 | |
a2c02241 | 29418 | @smallexample |
594fe323 | 29419 | (gdb) |
a2c02241 NR |
29420 | -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
29421 | ^done | |
594fe323 | 29422 | (gdb) |
a2c02241 | 29423 | @end smallexample |
922fbb7b | 29424 | |
a2c02241 | 29425 | @ignore |
a2c02241 NR |
29426 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29427 | @node GDB/MI Memory Overlay Commands | |
29428 | @section @sc{gdb/mi} Memory Overlay Commands | |
922fbb7b | 29429 | |
a2c02241 | 29430 | The memory overlay commands are not implemented. |
922fbb7b | 29431 | |
a2c02241 | 29432 | @c @subheading -overlay-auto |
922fbb7b | 29433 | |
a2c02241 | 29434 | @c @subheading -overlay-list-mapping-state |
922fbb7b | 29435 | |
a2c02241 | 29436 | @c @subheading -overlay-list-overlays |
922fbb7b | 29437 | |
a2c02241 | 29438 | @c @subheading -overlay-map |
922fbb7b | 29439 | |
a2c02241 | 29440 | @c @subheading -overlay-off |
922fbb7b | 29441 | |
a2c02241 | 29442 | @c @subheading -overlay-on |
922fbb7b | 29443 | |
a2c02241 | 29444 | @c @subheading -overlay-unmap |
922fbb7b | 29445 | |
a2c02241 NR |
29446 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29447 | @node GDB/MI Signal Handling Commands | |
29448 | @section @sc{gdb/mi} Signal Handling Commands | |
922fbb7b | 29449 | |
a2c02241 | 29450 | Signal handling commands are not implemented. |
922fbb7b | 29451 | |
a2c02241 | 29452 | @c @subheading -signal-handle |
922fbb7b | 29453 | |
a2c02241 | 29454 | @c @subheading -signal-list-handle-actions |
922fbb7b | 29455 | |
a2c02241 NR |
29456 | @c @subheading -signal-list-signal-types |
29457 | @end ignore | |
922fbb7b | 29458 | |
922fbb7b | 29459 | |
a2c02241 NR |
29460 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29461 | @node GDB/MI Target Manipulation | |
29462 | @section @sc{gdb/mi} Target Manipulation Commands | |
922fbb7b AC |
29463 | |
29464 | ||
a2c02241 NR |
29465 | @subheading The @code{-target-attach} Command |
29466 | @findex -target-attach | |
922fbb7b AC |
29467 | |
29468 | @subsubheading Synopsis | |
29469 | ||
29470 | @smallexample | |
c3b108f7 | 29471 | -target-attach @var{pid} | @var{gid} | @var{file} |
922fbb7b AC |
29472 | @end smallexample |
29473 | ||
c3b108f7 VP |
29474 | Attach to a process @var{pid} or a file @var{file} outside of |
29475 | @value{GDBN}, or a thread group @var{gid}. If attaching to a thread | |
29476 | group, the id previously returned by | |
29477 | @samp{-list-thread-groups --available} must be used. | |
922fbb7b | 29478 | |
79a6e687 | 29479 | @subsubheading @value{GDBN} Command |
922fbb7b | 29480 | |
a2c02241 | 29481 | The corresponding @value{GDBN} command is @samp{attach}. |
922fbb7b | 29482 | |
a2c02241 | 29483 | @subsubheading Example |
b56e7235 VP |
29484 | @smallexample |
29485 | (gdb) | |
29486 | -target-attach 34 | |
29487 | =thread-created,id="1" | |
5ae4183a | 29488 | *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@} |
b56e7235 VP |
29489 | ^done |
29490 | (gdb) | |
29491 | @end smallexample | |
a2c02241 | 29492 | |
9901a55b | 29493 | @ignore |
a2c02241 NR |
29494 | @subheading The @code{-target-compare-sections} Command |
29495 | @findex -target-compare-sections | |
922fbb7b AC |
29496 | |
29497 | @subsubheading Synopsis | |
29498 | ||
29499 | @smallexample | |
a2c02241 | 29500 | -target-compare-sections [ @var{section} ] |
922fbb7b AC |
29501 | @end smallexample |
29502 | ||
a2c02241 NR |
29503 | Compare data of section @var{section} on target to the exec file. |
29504 | Without the argument, all sections are compared. | |
922fbb7b | 29505 | |
a2c02241 | 29506 | @subsubheading @value{GDBN} Command |
922fbb7b | 29507 | |
a2c02241 | 29508 | The @value{GDBN} equivalent is @samp{compare-sections}. |
922fbb7b | 29509 | |
a2c02241 NR |
29510 | @subsubheading Example |
29511 | N.A. | |
9901a55b | 29512 | @end ignore |
a2c02241 NR |
29513 | |
29514 | ||
29515 | @subheading The @code{-target-detach} Command | |
29516 | @findex -target-detach | |
922fbb7b AC |
29517 | |
29518 | @subsubheading Synopsis | |
29519 | ||
29520 | @smallexample | |
c3b108f7 | 29521 | -target-detach [ @var{pid} | @var{gid} ] |
922fbb7b AC |
29522 | @end smallexample |
29523 | ||
a2c02241 | 29524 | Detach from the remote target which normally resumes its execution. |
c3b108f7 VP |
29525 | If either @var{pid} or @var{gid} is specified, detaches from either |
29526 | the specified process, or specified thread group. There's no output. | |
a2c02241 | 29527 | |
79a6e687 | 29528 | @subsubheading @value{GDBN} Command |
a2c02241 NR |
29529 | |
29530 | The corresponding @value{GDBN} command is @samp{detach}. | |
29531 | ||
29532 | @subsubheading Example | |
922fbb7b AC |
29533 | |
29534 | @smallexample | |
594fe323 | 29535 | (gdb) |
a2c02241 NR |
29536 | -target-detach |
29537 | ^done | |
594fe323 | 29538 | (gdb) |
922fbb7b AC |
29539 | @end smallexample |
29540 | ||
29541 | ||
a2c02241 NR |
29542 | @subheading The @code{-target-disconnect} Command |
29543 | @findex -target-disconnect | |
922fbb7b AC |
29544 | |
29545 | @subsubheading Synopsis | |
29546 | ||
123dc839 | 29547 | @smallexample |
a2c02241 | 29548 | -target-disconnect |
123dc839 | 29549 | @end smallexample |
922fbb7b | 29550 | |
a2c02241 NR |
29551 | Disconnect from the remote target. There's no output and the target is |
29552 | generally not resumed. | |
29553 | ||
79a6e687 | 29554 | @subsubheading @value{GDBN} Command |
a2c02241 NR |
29555 | |
29556 | The corresponding @value{GDBN} command is @samp{disconnect}. | |
bc8ced35 NR |
29557 | |
29558 | @subsubheading Example | |
922fbb7b AC |
29559 | |
29560 | @smallexample | |
594fe323 | 29561 | (gdb) |
a2c02241 NR |
29562 | -target-disconnect |
29563 | ^done | |
594fe323 | 29564 | (gdb) |
922fbb7b AC |
29565 | @end smallexample |
29566 | ||
29567 | ||
a2c02241 NR |
29568 | @subheading The @code{-target-download} Command |
29569 | @findex -target-download | |
922fbb7b AC |
29570 | |
29571 | @subsubheading Synopsis | |
29572 | ||
29573 | @smallexample | |
a2c02241 | 29574 | -target-download |
922fbb7b AC |
29575 | @end smallexample |
29576 | ||
a2c02241 NR |
29577 | Loads the executable onto the remote target. |
29578 | It prints out an update message every half second, which includes the fields: | |
29579 | ||
29580 | @table @samp | |
29581 | @item section | |
29582 | The name of the section. | |
29583 | @item section-sent | |
29584 | The size of what has been sent so far for that section. | |
29585 | @item section-size | |
29586 | The size of the section. | |
29587 | @item total-sent | |
29588 | The total size of what was sent so far (the current and the previous sections). | |
29589 | @item total-size | |
29590 | The size of the overall executable to download. | |
29591 | @end table | |
29592 | ||
29593 | @noindent | |
29594 | Each message is sent as status record (@pxref{GDB/MI Output Syntax, , | |
29595 | @sc{gdb/mi} Output Syntax}). | |
29596 | ||
29597 | In addition, it prints the name and size of the sections, as they are | |
29598 | downloaded. These messages include the following fields: | |
29599 | ||
29600 | @table @samp | |
29601 | @item section | |
29602 | The name of the section. | |
29603 | @item section-size | |
29604 | The size of the section. | |
29605 | @item total-size | |
29606 | The size of the overall executable to download. | |
29607 | @end table | |
29608 | ||
29609 | @noindent | |
29610 | At the end, a summary is printed. | |
29611 | ||
29612 | @subsubheading @value{GDBN} Command | |
29613 | ||
29614 | The corresponding @value{GDBN} command is @samp{load}. | |
29615 | ||
29616 | @subsubheading Example | |
29617 | ||
29618 | Note: each status message appears on a single line. Here the messages | |
29619 | have been broken down so that they can fit onto a page. | |
922fbb7b AC |
29620 | |
29621 | @smallexample | |
594fe323 | 29622 | (gdb) |
a2c02241 NR |
29623 | -target-download |
29624 | +download,@{section=".text",section-size="6668",total-size="9880"@} | |
29625 | +download,@{section=".text",section-sent="512",section-size="6668", | |
29626 | total-sent="512",total-size="9880"@} | |
29627 | +download,@{section=".text",section-sent="1024",section-size="6668", | |
29628 | total-sent="1024",total-size="9880"@} | |
29629 | +download,@{section=".text",section-sent="1536",section-size="6668", | |
29630 | total-sent="1536",total-size="9880"@} | |
29631 | +download,@{section=".text",section-sent="2048",section-size="6668", | |
29632 | total-sent="2048",total-size="9880"@} | |
29633 | +download,@{section=".text",section-sent="2560",section-size="6668", | |
29634 | total-sent="2560",total-size="9880"@} | |
29635 | +download,@{section=".text",section-sent="3072",section-size="6668", | |
29636 | total-sent="3072",total-size="9880"@} | |
29637 | +download,@{section=".text",section-sent="3584",section-size="6668", | |
29638 | total-sent="3584",total-size="9880"@} | |
29639 | +download,@{section=".text",section-sent="4096",section-size="6668", | |
29640 | total-sent="4096",total-size="9880"@} | |
29641 | +download,@{section=".text",section-sent="4608",section-size="6668", | |
29642 | total-sent="4608",total-size="9880"@} | |
29643 | +download,@{section=".text",section-sent="5120",section-size="6668", | |
29644 | total-sent="5120",total-size="9880"@} | |
29645 | +download,@{section=".text",section-sent="5632",section-size="6668", | |
29646 | total-sent="5632",total-size="9880"@} | |
29647 | +download,@{section=".text",section-sent="6144",section-size="6668", | |
29648 | total-sent="6144",total-size="9880"@} | |
29649 | +download,@{section=".text",section-sent="6656",section-size="6668", | |
29650 | total-sent="6656",total-size="9880"@} | |
29651 | +download,@{section=".init",section-size="28",total-size="9880"@} | |
29652 | +download,@{section=".fini",section-size="28",total-size="9880"@} | |
29653 | +download,@{section=".data",section-size="3156",total-size="9880"@} | |
29654 | +download,@{section=".data",section-sent="512",section-size="3156", | |
29655 | total-sent="7236",total-size="9880"@} | |
29656 | +download,@{section=".data",section-sent="1024",section-size="3156", | |
29657 | total-sent="7748",total-size="9880"@} | |
29658 | +download,@{section=".data",section-sent="1536",section-size="3156", | |
29659 | total-sent="8260",total-size="9880"@} | |
29660 | +download,@{section=".data",section-sent="2048",section-size="3156", | |
29661 | total-sent="8772",total-size="9880"@} | |
29662 | +download,@{section=".data",section-sent="2560",section-size="3156", | |
29663 | total-sent="9284",total-size="9880"@} | |
29664 | +download,@{section=".data",section-sent="3072",section-size="3156", | |
29665 | total-sent="9796",total-size="9880"@} | |
29666 | ^done,address="0x10004",load-size="9880",transfer-rate="6586", | |
29667 | write-rate="429" | |
594fe323 | 29668 | (gdb) |
922fbb7b AC |
29669 | @end smallexample |
29670 | ||
29671 | ||
9901a55b | 29672 | @ignore |
a2c02241 NR |
29673 | @subheading The @code{-target-exec-status} Command |
29674 | @findex -target-exec-status | |
922fbb7b AC |
29675 | |
29676 | @subsubheading Synopsis | |
29677 | ||
29678 | @smallexample | |
a2c02241 | 29679 | -target-exec-status |
922fbb7b AC |
29680 | @end smallexample |
29681 | ||
a2c02241 NR |
29682 | Provide information on the state of the target (whether it is running or |
29683 | not, for instance). | |
922fbb7b | 29684 | |
a2c02241 | 29685 | @subsubheading @value{GDBN} Command |
922fbb7b | 29686 | |
a2c02241 NR |
29687 | There's no equivalent @value{GDBN} command. |
29688 | ||
29689 | @subsubheading Example | |
29690 | N.A. | |
922fbb7b | 29691 | |
a2c02241 NR |
29692 | |
29693 | @subheading The @code{-target-list-available-targets} Command | |
29694 | @findex -target-list-available-targets | |
922fbb7b AC |
29695 | |
29696 | @subsubheading Synopsis | |
29697 | ||
29698 | @smallexample | |
a2c02241 | 29699 | -target-list-available-targets |
922fbb7b AC |
29700 | @end smallexample |
29701 | ||
a2c02241 | 29702 | List the possible targets to connect to. |
922fbb7b | 29703 | |
a2c02241 | 29704 | @subsubheading @value{GDBN} Command |
922fbb7b | 29705 | |
a2c02241 | 29706 | The corresponding @value{GDBN} command is @samp{help target}. |
922fbb7b | 29707 | |
a2c02241 NR |
29708 | @subsubheading Example |
29709 | N.A. | |
29710 | ||
29711 | ||
29712 | @subheading The @code{-target-list-current-targets} Command | |
29713 | @findex -target-list-current-targets | |
922fbb7b AC |
29714 | |
29715 | @subsubheading Synopsis | |
29716 | ||
29717 | @smallexample | |
a2c02241 | 29718 | -target-list-current-targets |
922fbb7b AC |
29719 | @end smallexample |
29720 | ||
a2c02241 | 29721 | Describe the current target. |
922fbb7b | 29722 | |
a2c02241 | 29723 | @subsubheading @value{GDBN} Command |
922fbb7b | 29724 | |
a2c02241 NR |
29725 | The corresponding information is printed by @samp{info file} (among |
29726 | other things). | |
922fbb7b | 29727 | |
a2c02241 NR |
29728 | @subsubheading Example |
29729 | N.A. | |
29730 | ||
29731 | ||
29732 | @subheading The @code{-target-list-parameters} Command | |
29733 | @findex -target-list-parameters | |
922fbb7b AC |
29734 | |
29735 | @subsubheading Synopsis | |
29736 | ||
29737 | @smallexample | |
a2c02241 | 29738 | -target-list-parameters |
922fbb7b AC |
29739 | @end smallexample |
29740 | ||
a2c02241 | 29741 | @c ???? |
9901a55b | 29742 | @end ignore |
a2c02241 NR |
29743 | |
29744 | @subsubheading @value{GDBN} Command | |
29745 | ||
29746 | No equivalent. | |
922fbb7b AC |
29747 | |
29748 | @subsubheading Example | |
a2c02241 NR |
29749 | N.A. |
29750 | ||
29751 | ||
29752 | @subheading The @code{-target-select} Command | |
29753 | @findex -target-select | |
29754 | ||
29755 | @subsubheading Synopsis | |
922fbb7b AC |
29756 | |
29757 | @smallexample | |
a2c02241 | 29758 | -target-select @var{type} @var{parameters @dots{}} |
922fbb7b AC |
29759 | @end smallexample |
29760 | ||
a2c02241 | 29761 | Connect @value{GDBN} to the remote target. This command takes two args: |
922fbb7b | 29762 | |
a2c02241 NR |
29763 | @table @samp |
29764 | @item @var{type} | |
75c99385 | 29765 | The type of target, for instance @samp{remote}, etc. |
a2c02241 NR |
29766 | @item @var{parameters} |
29767 | Device names, host names and the like. @xref{Target Commands, , | |
79a6e687 | 29768 | Commands for Managing Targets}, for more details. |
a2c02241 NR |
29769 | @end table |
29770 | ||
29771 | The output is a connection notification, followed by the address at | |
29772 | which the target program is, in the following form: | |
922fbb7b AC |
29773 | |
29774 | @smallexample | |
a2c02241 NR |
29775 | ^connected,addr="@var{address}",func="@var{function name}", |
29776 | args=[@var{arg list}] | |
922fbb7b AC |
29777 | @end smallexample |
29778 | ||
a2c02241 NR |
29779 | @subsubheading @value{GDBN} Command |
29780 | ||
29781 | The corresponding @value{GDBN} command is @samp{target}. | |
265eeb58 NR |
29782 | |
29783 | @subsubheading Example | |
922fbb7b | 29784 | |
265eeb58 | 29785 | @smallexample |
594fe323 | 29786 | (gdb) |
75c99385 | 29787 | -target-select remote /dev/ttya |
a2c02241 | 29788 | ^connected,addr="0xfe00a300",func="??",args=[] |
594fe323 | 29789 | (gdb) |
265eeb58 | 29790 | @end smallexample |
ef21caaf | 29791 | |
a6b151f1 DJ |
29792 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29793 | @node GDB/MI File Transfer Commands | |
29794 | @section @sc{gdb/mi} File Transfer Commands | |
29795 | ||
29796 | ||
29797 | @subheading The @code{-target-file-put} Command | |
29798 | @findex -target-file-put | |
29799 | ||
29800 | @subsubheading Synopsis | |
29801 | ||
29802 | @smallexample | |
29803 | -target-file-put @var{hostfile} @var{targetfile} | |
29804 | @end smallexample | |
29805 | ||
29806 | Copy file @var{hostfile} from the host system (the machine running | |
29807 | @value{GDBN}) to @var{targetfile} on the target system. | |
29808 | ||
29809 | @subsubheading @value{GDBN} Command | |
29810 | ||
29811 | The corresponding @value{GDBN} command is @samp{remote put}. | |
29812 | ||
29813 | @subsubheading Example | |
29814 | ||
29815 | @smallexample | |
29816 | (gdb) | |
29817 | -target-file-put localfile remotefile | |
29818 | ^done | |
29819 | (gdb) | |
29820 | @end smallexample | |
29821 | ||
29822 | ||
1763a388 | 29823 | @subheading The @code{-target-file-get} Command |
a6b151f1 DJ |
29824 | @findex -target-file-get |
29825 | ||
29826 | @subsubheading Synopsis | |
29827 | ||
29828 | @smallexample | |
29829 | -target-file-get @var{targetfile} @var{hostfile} | |
29830 | @end smallexample | |
29831 | ||
29832 | Copy file @var{targetfile} from the target system to @var{hostfile} | |
29833 | on the host system. | |
29834 | ||
29835 | @subsubheading @value{GDBN} Command | |
29836 | ||
29837 | The corresponding @value{GDBN} command is @samp{remote get}. | |
29838 | ||
29839 | @subsubheading Example | |
29840 | ||
29841 | @smallexample | |
29842 | (gdb) | |
29843 | -target-file-get remotefile localfile | |
29844 | ^done | |
29845 | (gdb) | |
29846 | @end smallexample | |
29847 | ||
29848 | ||
29849 | @subheading The @code{-target-file-delete} Command | |
29850 | @findex -target-file-delete | |
29851 | ||
29852 | @subsubheading Synopsis | |
29853 | ||
29854 | @smallexample | |
29855 | -target-file-delete @var{targetfile} | |
29856 | @end smallexample | |
29857 | ||
29858 | Delete @var{targetfile} from the target system. | |
29859 | ||
29860 | @subsubheading @value{GDBN} Command | |
29861 | ||
29862 | The corresponding @value{GDBN} command is @samp{remote delete}. | |
29863 | ||
29864 | @subsubheading Example | |
29865 | ||
29866 | @smallexample | |
29867 | (gdb) | |
29868 | -target-file-delete remotefile | |
29869 | ^done | |
29870 | (gdb) | |
29871 | @end smallexample | |
29872 | ||
29873 | ||
ef21caaf NR |
29874 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29875 | @node GDB/MI Miscellaneous Commands | |
29876 | @section Miscellaneous @sc{gdb/mi} Commands | |
29877 | ||
29878 | @c @subheading -gdb-complete | |
29879 | ||
29880 | @subheading The @code{-gdb-exit} Command | |
29881 | @findex -gdb-exit | |
29882 | ||
29883 | @subsubheading Synopsis | |
29884 | ||
29885 | @smallexample | |
29886 | -gdb-exit | |
29887 | @end smallexample | |
29888 | ||
29889 | Exit @value{GDBN} immediately. | |
29890 | ||
29891 | @subsubheading @value{GDBN} Command | |
29892 | ||
29893 | Approximately corresponds to @samp{quit}. | |
29894 | ||
29895 | @subsubheading Example | |
29896 | ||
29897 | @smallexample | |
594fe323 | 29898 | (gdb) |
ef21caaf NR |
29899 | -gdb-exit |
29900 | ^exit | |
29901 | @end smallexample | |
29902 | ||
a2c02241 | 29903 | |
9901a55b | 29904 | @ignore |
a2c02241 NR |
29905 | @subheading The @code{-exec-abort} Command |
29906 | @findex -exec-abort | |
29907 | ||
29908 | @subsubheading Synopsis | |
29909 | ||
29910 | @smallexample | |
29911 | -exec-abort | |
29912 | @end smallexample | |
29913 | ||
29914 | Kill the inferior running program. | |
29915 | ||
29916 | @subsubheading @value{GDBN} Command | |
29917 | ||
29918 | The corresponding @value{GDBN} command is @samp{kill}. | |
29919 | ||
29920 | @subsubheading Example | |
29921 | N.A. | |
9901a55b | 29922 | @end ignore |
a2c02241 NR |
29923 | |
29924 | ||
ef21caaf NR |
29925 | @subheading The @code{-gdb-set} Command |
29926 | @findex -gdb-set | |
29927 | ||
29928 | @subsubheading Synopsis | |
29929 | ||
29930 | @smallexample | |
29931 | -gdb-set | |
29932 | @end smallexample | |
29933 | ||
29934 | Set an internal @value{GDBN} variable. | |
29935 | @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ????? | |
29936 | ||
29937 | @subsubheading @value{GDBN} Command | |
29938 | ||
29939 | The corresponding @value{GDBN} command is @samp{set}. | |
29940 | ||
29941 | @subsubheading Example | |
29942 | ||
29943 | @smallexample | |
594fe323 | 29944 | (gdb) |
ef21caaf NR |
29945 | -gdb-set $foo=3 |
29946 | ^done | |
594fe323 | 29947 | (gdb) |
ef21caaf NR |
29948 | @end smallexample |
29949 | ||
29950 | ||
29951 | @subheading The @code{-gdb-show} Command | |
29952 | @findex -gdb-show | |
29953 | ||
29954 | @subsubheading Synopsis | |
29955 | ||
29956 | @smallexample | |
29957 | -gdb-show | |
29958 | @end smallexample | |
29959 | ||
29960 | Show the current value of a @value{GDBN} variable. | |
29961 | ||
79a6e687 | 29962 | @subsubheading @value{GDBN} Command |
ef21caaf NR |
29963 | |
29964 | The corresponding @value{GDBN} command is @samp{show}. | |
29965 | ||
29966 | @subsubheading Example | |
29967 | ||
29968 | @smallexample | |
594fe323 | 29969 | (gdb) |
ef21caaf NR |
29970 | -gdb-show annotate |
29971 | ^done,value="0" | |
594fe323 | 29972 | (gdb) |
ef21caaf NR |
29973 | @end smallexample |
29974 | ||
29975 | @c @subheading -gdb-source | |
29976 | ||
29977 | ||
29978 | @subheading The @code{-gdb-version} Command | |
29979 | @findex -gdb-version | |
29980 | ||
29981 | @subsubheading Synopsis | |
29982 | ||
29983 | @smallexample | |
29984 | -gdb-version | |
29985 | @end smallexample | |
29986 | ||
29987 | Show version information for @value{GDBN}. Used mostly in testing. | |
29988 | ||
29989 | @subsubheading @value{GDBN} Command | |
29990 | ||
29991 | The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by | |
29992 | default shows this information when you start an interactive session. | |
29993 | ||
29994 | @subsubheading Example | |
29995 | ||
29996 | @c This example modifies the actual output from GDB to avoid overfull | |
29997 | @c box in TeX. | |
29998 | @smallexample | |
594fe323 | 29999 | (gdb) |
ef21caaf NR |
30000 | -gdb-version |
30001 | ~GNU gdb 5.2.1 | |
30002 | ~Copyright 2000 Free Software Foundation, Inc. | |
30003 | ~GDB is free software, covered by the GNU General Public License, and | |
30004 | ~you are welcome to change it and/or distribute copies of it under | |
30005 | ~ certain conditions. | |
30006 | ~Type "show copying" to see the conditions. | |
30007 | ~There is absolutely no warranty for GDB. Type "show warranty" for | |
30008 | ~ details. | |
30009 | ~This GDB was configured as | |
30010 | "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi". | |
30011 | ^done | |
594fe323 | 30012 | (gdb) |
ef21caaf NR |
30013 | @end smallexample |
30014 | ||
084344da VP |
30015 | @subheading The @code{-list-features} Command |
30016 | @findex -list-features | |
30017 | ||
30018 | Returns a list of particular features of the MI protocol that | |
30019 | this version of gdb implements. A feature can be a command, | |
30020 | or a new field in an output of some command, or even an | |
30021 | important bugfix. While a frontend can sometimes detect presence | |
30022 | of a feature at runtime, it is easier to perform detection at debugger | |
30023 | startup. | |
30024 | ||
30025 | The command returns a list of strings, with each string naming an | |
30026 | available feature. Each returned string is just a name, it does not | |
30027 | have any internal structure. The list of possible feature names | |
30028 | is given below. | |
30029 | ||
30030 | Example output: | |
30031 | ||
30032 | @smallexample | |
30033 | (gdb) -list-features | |
30034 | ^done,result=["feature1","feature2"] | |
30035 | @end smallexample | |
30036 | ||
30037 | The current list of features is: | |
30038 | ||
30e026bb VP |
30039 | @table @samp |
30040 | @item frozen-varobjs | |
30041 | Indicates presence of the @code{-var-set-frozen} command, as well | |
30042 | as possible presense of the @code{frozen} field in the output | |
30043 | of @code{-varobj-create}. | |
30044 | @item pending-breakpoints | |
30045 | Indicates presence of the @option{-f} option to the @code{-break-insert} command. | |
b6313243 TT |
30046 | @item python |
30047 | Indicates presence of Python scripting support, Python-based | |
30048 | pretty-printing commands, and possible presence of the | |
30049 | @samp{display_hint} field in the output of @code{-var-list-children} | |
30e026bb VP |
30050 | @item thread-info |
30051 | Indicates presence of the @code{-thread-info} command. | |
8dedea02 VP |
30052 | @item data-read-memory-bytes |
30053 | Indicates presense of the @code{-data-read-memory-bytes} and the | |
30054 | @code{-data-write-memory-bytes} commands. | |
8b4ed427 | 30055 | |
30e026bb | 30056 | @end table |
084344da | 30057 | |
c6ebd6cf VP |
30058 | @subheading The @code{-list-target-features} Command |
30059 | @findex -list-target-features | |
30060 | ||
30061 | Returns a list of particular features that are supported by the | |
30062 | target. Those features affect the permitted MI commands, but | |
30063 | unlike the features reported by the @code{-list-features} command, the | |
30064 | features depend on which target GDB is using at the moment. Whenever | |
30065 | a target can change, due to commands such as @code{-target-select}, | |
30066 | @code{-target-attach} or @code{-exec-run}, the list of target features | |
30067 | may change, and the frontend should obtain it again. | |
30068 | Example output: | |
30069 | ||
30070 | @smallexample | |
30071 | (gdb) -list-features | |
30072 | ^done,result=["async"] | |
30073 | @end smallexample | |
30074 | ||
30075 | The current list of features is: | |
30076 | ||
30077 | @table @samp | |
30078 | @item async | |
30079 | Indicates that the target is capable of asynchronous command | |
30080 | execution, which means that @value{GDBN} will accept further commands | |
30081 | while the target is running. | |
30082 | ||
f75d858b MK |
30083 | @item reverse |
30084 | Indicates that the target is capable of reverse execution. | |
30085 | @xref{Reverse Execution}, for more information. | |
30086 | ||
c6ebd6cf VP |
30087 | @end table |
30088 | ||
c3b108f7 VP |
30089 | @subheading The @code{-list-thread-groups} Command |
30090 | @findex -list-thread-groups | |
30091 | ||
30092 | @subheading Synopsis | |
30093 | ||
30094 | @smallexample | |
dc146f7c | 30095 | -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ] |
c3b108f7 VP |
30096 | @end smallexample |
30097 | ||
dc146f7c VP |
30098 | Lists thread groups (@pxref{Thread groups}). When a single thread |
30099 | group is passed as the argument, lists the children of that group. | |
30100 | When several thread group are passed, lists information about those | |
30101 | thread groups. Without any parameters, lists information about all | |
30102 | top-level thread groups. | |
30103 | ||
30104 | Normally, thread groups that are being debugged are reported. | |
30105 | With the @samp{--available} option, @value{GDBN} reports thread groups | |
30106 | available on the target. | |
30107 | ||
30108 | The output of this command may have either a @samp{threads} result or | |
30109 | a @samp{groups} result. The @samp{thread} result has a list of tuples | |
30110 | as value, with each tuple describing a thread (@pxref{GDB/MI Thread | |
30111 | Information}). The @samp{groups} result has a list of tuples as value, | |
30112 | each tuple describing a thread group. If top-level groups are | |
30113 | requested (that is, no parameter is passed), or when several groups | |
30114 | are passed, the output always has a @samp{groups} result. The format | |
30115 | of the @samp{group} result is described below. | |
30116 | ||
30117 | To reduce the number of roundtrips it's possible to list thread groups | |
30118 | together with their children, by passing the @samp{--recurse} option | |
30119 | and the recursion depth. Presently, only recursion depth of 1 is | |
30120 | permitted. If this option is present, then every reported thread group | |
30121 | will also include its children, either as @samp{group} or | |
30122 | @samp{threads} field. | |
30123 | ||
30124 | In general, any combination of option and parameters is permitted, with | |
30125 | the following caveats: | |
30126 | ||
30127 | @itemize @bullet | |
30128 | @item | |
30129 | When a single thread group is passed, the output will typically | |
30130 | be the @samp{threads} result. Because threads may not contain | |
30131 | anything, the @samp{recurse} option will be ignored. | |
30132 | ||
30133 | @item | |
30134 | When the @samp{--available} option is passed, limited information may | |
30135 | be available. In particular, the list of threads of a process might | |
30136 | be inaccessible. Further, specifying specific thread groups might | |
30137 | not give any performance advantage over listing all thread groups. | |
30138 | The frontend should assume that @samp{-list-thread-groups --available} | |
30139 | is always an expensive operation and cache the results. | |
30140 | ||
30141 | @end itemize | |
30142 | ||
30143 | The @samp{groups} result is a list of tuples, where each tuple may | |
30144 | have the following fields: | |
30145 | ||
30146 | @table @code | |
30147 | @item id | |
30148 | Identifier of the thread group. This field is always present. | |
a79b8f6e VP |
30149 | The identifier is an opaque string; frontends should not try to |
30150 | convert it to an integer, even though it might look like one. | |
dc146f7c VP |
30151 | |
30152 | @item type | |
30153 | The type of the thread group. At present, only @samp{process} is a | |
30154 | valid type. | |
30155 | ||
30156 | @item pid | |
30157 | The target-specific process identifier. This field is only present | |
a79b8f6e | 30158 | for thread groups of type @samp{process} and only if the process exists. |
c3b108f7 | 30159 | |
dc146f7c VP |
30160 | @item num_children |
30161 | The number of children this thread group has. This field may be | |
30162 | absent for an available thread group. | |
30163 | ||
30164 | @item threads | |
30165 | This field has a list of tuples as value, each tuple describing a | |
30166 | thread. It may be present if the @samp{--recurse} option is | |
30167 | specified, and it's actually possible to obtain the threads. | |
30168 | ||
30169 | @item cores | |
30170 | This field is a list of integers, each identifying a core that one | |
30171 | thread of the group is running on. This field may be absent if | |
30172 | such information is not available. | |
30173 | ||
a79b8f6e VP |
30174 | @item executable |
30175 | The name of the executable file that corresponds to this thread group. | |
30176 | The field is only present for thread groups of type @samp{process}, | |
30177 | and only if there is a corresponding executable file. | |
30178 | ||
dc146f7c | 30179 | @end table |
c3b108f7 VP |
30180 | |
30181 | @subheading Example | |
30182 | ||
30183 | @smallexample | |
30184 | @value{GDBP} | |
30185 | -list-thread-groups | |
30186 | ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}] | |
30187 | -list-thread-groups 17 | |
30188 | ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)", | |
30189 | frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@}, | |
30190 | @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)", | |
30191 | frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}], | |
30192 | file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},state="running"@}]] | |
dc146f7c VP |
30193 | -list-thread-groups --available |
30194 | ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}] | |
30195 | -list-thread-groups --available --recurse 1 | |
30196 | ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2], | |
30197 | threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@}, | |
30198 | @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..] | |
30199 | -list-thread-groups --available --recurse 1 17 18 | |
30200 | ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2], | |
30201 | threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@}, | |
30202 | @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...] | |
c3b108f7 | 30203 | @end smallexample |
c6ebd6cf | 30204 | |
a79b8f6e VP |
30205 | |
30206 | @subheading The @code{-add-inferior} Command | |
30207 | @findex -add-inferior | |
30208 | ||
30209 | @subheading Synopsis | |
30210 | ||
30211 | @smallexample | |
30212 | -add-inferior | |
30213 | @end smallexample | |
30214 | ||
30215 | Creates a new inferior (@pxref{Inferiors and Programs}). The created | |
30216 | inferior is not associated with any executable. Such association may | |
30217 | be established with the @samp{-file-exec-and-symbols} command | |
30218 | (@pxref{GDB/MI File Commands}). The command response has a single | |
30219 | field, @samp{thread-group}, whose value is the identifier of the | |
30220 | thread group corresponding to the new inferior. | |
30221 | ||
30222 | @subheading Example | |
30223 | ||
30224 | @smallexample | |
30225 | @value{GDBP} | |
30226 | -add-inferior | |
30227 | ^done,thread-group="i3" | |
30228 | @end smallexample | |
30229 | ||
ef21caaf NR |
30230 | @subheading The @code{-interpreter-exec} Command |
30231 | @findex -interpreter-exec | |
30232 | ||
30233 | @subheading Synopsis | |
30234 | ||
30235 | @smallexample | |
30236 | -interpreter-exec @var{interpreter} @var{command} | |
30237 | @end smallexample | |
a2c02241 | 30238 | @anchor{-interpreter-exec} |
ef21caaf NR |
30239 | |
30240 | Execute the specified @var{command} in the given @var{interpreter}. | |
30241 | ||
30242 | @subheading @value{GDBN} Command | |
30243 | ||
30244 | The corresponding @value{GDBN} command is @samp{interpreter-exec}. | |
30245 | ||
30246 | @subheading Example | |
30247 | ||
30248 | @smallexample | |
594fe323 | 30249 | (gdb) |
ef21caaf NR |
30250 | -interpreter-exec console "break main" |
30251 | &"During symbol reading, couldn't parse type; debugger out of date?.\n" | |
30252 | &"During symbol reading, bad structure-type format.\n" | |
30253 | ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n" | |
30254 | ^done | |
594fe323 | 30255 | (gdb) |
ef21caaf NR |
30256 | @end smallexample |
30257 | ||
30258 | @subheading The @code{-inferior-tty-set} Command | |
30259 | @findex -inferior-tty-set | |
30260 | ||
30261 | @subheading Synopsis | |
30262 | ||
30263 | @smallexample | |
30264 | -inferior-tty-set /dev/pts/1 | |
30265 | @end smallexample | |
30266 | ||
30267 | Set terminal for future runs of the program being debugged. | |
30268 | ||
30269 | @subheading @value{GDBN} Command | |
30270 | ||
30271 | The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1. | |
30272 | ||
30273 | @subheading Example | |
30274 | ||
30275 | @smallexample | |
594fe323 | 30276 | (gdb) |
ef21caaf NR |
30277 | -inferior-tty-set /dev/pts/1 |
30278 | ^done | |
594fe323 | 30279 | (gdb) |
ef21caaf NR |
30280 | @end smallexample |
30281 | ||
30282 | @subheading The @code{-inferior-tty-show} Command | |
30283 | @findex -inferior-tty-show | |
30284 | ||
30285 | @subheading Synopsis | |
30286 | ||
30287 | @smallexample | |
30288 | -inferior-tty-show | |
30289 | @end smallexample | |
30290 | ||
30291 | Show terminal for future runs of program being debugged. | |
30292 | ||
30293 | @subheading @value{GDBN} Command | |
30294 | ||
30295 | The corresponding @value{GDBN} command is @samp{show inferior-tty}. | |
30296 | ||
30297 | @subheading Example | |
30298 | ||
30299 | @smallexample | |
594fe323 | 30300 | (gdb) |
ef21caaf NR |
30301 | -inferior-tty-set /dev/pts/1 |
30302 | ^done | |
594fe323 | 30303 | (gdb) |
ef21caaf NR |
30304 | -inferior-tty-show |
30305 | ^done,inferior_tty_terminal="/dev/pts/1" | |
594fe323 | 30306 | (gdb) |
ef21caaf | 30307 | @end smallexample |
922fbb7b | 30308 | |
a4eefcd8 NR |
30309 | @subheading The @code{-enable-timings} Command |
30310 | @findex -enable-timings | |
30311 | ||
30312 | @subheading Synopsis | |
30313 | ||
30314 | @smallexample | |
30315 | -enable-timings [yes | no] | |
30316 | @end smallexample | |
30317 | ||
30318 | Toggle the printing of the wallclock, user and system times for an MI | |
30319 | command as a field in its output. This command is to help frontend | |
30320 | developers optimize the performance of their code. No argument is | |
30321 | equivalent to @samp{yes}. | |
30322 | ||
30323 | @subheading @value{GDBN} Command | |
30324 | ||
30325 | No equivalent. | |
30326 | ||
30327 | @subheading Example | |
30328 | ||
30329 | @smallexample | |
30330 | (gdb) | |
30331 | -enable-timings | |
30332 | ^done | |
30333 | (gdb) | |
30334 | -break-insert main | |
30335 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
30336 | addr="0x080484ed",func="main",file="myprog.c", | |
30337 | fullname="/home/nickrob/myprog.c",line="73",times="0"@}, | |
30338 | time=@{wallclock="0.05185",user="0.00800",system="0.00000"@} | |
30339 | (gdb) | |
30340 | -enable-timings no | |
30341 | ^done | |
30342 | (gdb) | |
30343 | -exec-run | |
30344 | ^running | |
30345 | (gdb) | |
a47ec5fe | 30346 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0", |
a4eefcd8 NR |
30347 | frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@}, |
30348 | @{name="argv",value="0xbfb60364"@}],file="myprog.c", | |
30349 | fullname="/home/nickrob/myprog.c",line="73"@} | |
30350 | (gdb) | |
30351 | @end smallexample | |
30352 | ||
922fbb7b AC |
30353 | @node Annotations |
30354 | @chapter @value{GDBN} Annotations | |
30355 | ||
086432e2 AC |
30356 | This chapter describes annotations in @value{GDBN}. Annotations were |
30357 | designed to interface @value{GDBN} to graphical user interfaces or other | |
30358 | similar programs which want to interact with @value{GDBN} at a | |
922fbb7b AC |
30359 | relatively high level. |
30360 | ||
d3e8051b | 30361 | The annotation mechanism has largely been superseded by @sc{gdb/mi} |
086432e2 AC |
30362 | (@pxref{GDB/MI}). |
30363 | ||
922fbb7b AC |
30364 | @ignore |
30365 | This is Edition @value{EDITION}, @value{DATE}. | |
30366 | @end ignore | |
30367 | ||
30368 | @menu | |
30369 | * Annotations Overview:: What annotations are; the general syntax. | |
9e6c4bd5 | 30370 | * Server Prefix:: Issuing a command without affecting user state. |
922fbb7b AC |
30371 | * Prompting:: Annotations marking @value{GDBN}'s need for input. |
30372 | * Errors:: Annotations for error messages. | |
922fbb7b AC |
30373 | * Invalidation:: Some annotations describe things now invalid. |
30374 | * Annotations for Running:: | |
30375 | Whether the program is running, how it stopped, etc. | |
30376 | * Source Annotations:: Annotations describing source code. | |
922fbb7b AC |
30377 | @end menu |
30378 | ||
30379 | @node Annotations Overview | |
30380 | @section What is an Annotation? | |
30381 | @cindex annotations | |
30382 | ||
922fbb7b AC |
30383 | Annotations start with a newline character, two @samp{control-z} |
30384 | characters, and the name of the annotation. If there is no additional | |
30385 | information associated with this annotation, the name of the annotation | |
30386 | is followed immediately by a newline. If there is additional | |
30387 | information, the name of the annotation is followed by a space, the | |
30388 | additional information, and a newline. The additional information | |
30389 | cannot contain newline characters. | |
30390 | ||
30391 | Any output not beginning with a newline and two @samp{control-z} | |
30392 | characters denotes literal output from @value{GDBN}. Currently there is | |
30393 | no need for @value{GDBN} to output a newline followed by two | |
30394 | @samp{control-z} characters, but if there was such a need, the | |
30395 | annotations could be extended with an @samp{escape} annotation which | |
30396 | means those three characters as output. | |
30397 | ||
086432e2 AC |
30398 | The annotation @var{level}, which is specified using the |
30399 | @option{--annotate} command line option (@pxref{Mode Options}), controls | |
30400 | how much information @value{GDBN} prints together with its prompt, | |
30401 | values of expressions, source lines, and other types of output. Level 0 | |
d3e8051b | 30402 | is for no annotations, level 1 is for use when @value{GDBN} is run as a |
086432e2 AC |
30403 | subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable |
30404 | for programs that control @value{GDBN}, and level 2 annotations have | |
30405 | been made obsolete (@pxref{Limitations, , Limitations of the Annotation | |
09d4efe1 EZ |
30406 | Interface, annotate, GDB's Obsolete Annotations}). |
30407 | ||
30408 | @table @code | |
30409 | @kindex set annotate | |
30410 | @item set annotate @var{level} | |
e09f16f9 | 30411 | The @value{GDBN} command @code{set annotate} sets the level of |
09d4efe1 | 30412 | annotations to the specified @var{level}. |
9c16f35a EZ |
30413 | |
30414 | @item show annotate | |
30415 | @kindex show annotate | |
30416 | Show the current annotation level. | |
09d4efe1 EZ |
30417 | @end table |
30418 | ||
30419 | This chapter describes level 3 annotations. | |
086432e2 | 30420 | |
922fbb7b AC |
30421 | A simple example of starting up @value{GDBN} with annotations is: |
30422 | ||
30423 | @smallexample | |
086432e2 AC |
30424 | $ @kbd{gdb --annotate=3} |
30425 | GNU gdb 6.0 | |
30426 | Copyright 2003 Free Software Foundation, Inc. | |
922fbb7b AC |
30427 | GDB is free software, covered by the GNU General Public License, |
30428 | and you are welcome to change it and/or distribute copies of it | |
30429 | under certain conditions. | |
30430 | Type "show copying" to see the conditions. | |
30431 | There is absolutely no warranty for GDB. Type "show warranty" | |
30432 | for details. | |
086432e2 | 30433 | This GDB was configured as "i386-pc-linux-gnu" |
922fbb7b AC |
30434 | |
30435 | ^Z^Zpre-prompt | |
f7dc1244 | 30436 | (@value{GDBP}) |
922fbb7b | 30437 | ^Z^Zprompt |
086432e2 | 30438 | @kbd{quit} |
922fbb7b AC |
30439 | |
30440 | ^Z^Zpost-prompt | |
b383017d | 30441 | $ |
922fbb7b AC |
30442 | @end smallexample |
30443 | ||
30444 | Here @samp{quit} is input to @value{GDBN}; the rest is output from | |
30445 | @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z} | |
30446 | denotes a @samp{control-z} character) are annotations; the rest is | |
30447 | output from @value{GDBN}. | |
30448 | ||
9e6c4bd5 NR |
30449 | @node Server Prefix |
30450 | @section The Server Prefix | |
30451 | @cindex server prefix | |
30452 | ||
30453 | If you prefix a command with @samp{server } then it will not affect | |
30454 | the command history, nor will it affect @value{GDBN}'s notion of which | |
30455 | command to repeat if @key{RET} is pressed on a line by itself. This | |
30456 | means that commands can be run behind a user's back by a front-end in | |
30457 | a transparent manner. | |
30458 | ||
d837706a NR |
30459 | The @code{server } prefix does not affect the recording of values into |
30460 | the value history; to print a value without recording it into the | |
30461 | value history, use the @code{output} command instead of the | |
30462 | @code{print} command. | |
30463 | ||
30464 | Using this prefix also disables confirmation requests | |
30465 | (@pxref{confirmation requests}). | |
9e6c4bd5 | 30466 | |
922fbb7b AC |
30467 | @node Prompting |
30468 | @section Annotation for @value{GDBN} Input | |
30469 | ||
30470 | @cindex annotations for prompts | |
30471 | When @value{GDBN} prompts for input, it annotates this fact so it is possible | |
30472 | to know when to send output, when the output from a given command is | |
30473 | over, etc. | |
30474 | ||
30475 | Different kinds of input each have a different @dfn{input type}. Each | |
30476 | input type has three annotations: a @code{pre-} annotation, which | |
30477 | denotes the beginning of any prompt which is being output, a plain | |
30478 | annotation, which denotes the end of the prompt, and then a @code{post-} | |
30479 | annotation which denotes the end of any echo which may (or may not) be | |
30480 | associated with the input. For example, the @code{prompt} input type | |
30481 | features the following annotations: | |
30482 | ||
30483 | @smallexample | |
30484 | ^Z^Zpre-prompt | |
30485 | ^Z^Zprompt | |
30486 | ^Z^Zpost-prompt | |
30487 | @end smallexample | |
30488 | ||
30489 | The input types are | |
30490 | ||
30491 | @table @code | |
e5ac9b53 EZ |
30492 | @findex pre-prompt annotation |
30493 | @findex prompt annotation | |
30494 | @findex post-prompt annotation | |
922fbb7b AC |
30495 | @item prompt |
30496 | When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt). | |
30497 | ||
e5ac9b53 EZ |
30498 | @findex pre-commands annotation |
30499 | @findex commands annotation | |
30500 | @findex post-commands annotation | |
922fbb7b AC |
30501 | @item commands |
30502 | When @value{GDBN} prompts for a set of commands, like in the @code{commands} | |
30503 | command. The annotations are repeated for each command which is input. | |
30504 | ||
e5ac9b53 EZ |
30505 | @findex pre-overload-choice annotation |
30506 | @findex overload-choice annotation | |
30507 | @findex post-overload-choice annotation | |
922fbb7b AC |
30508 | @item overload-choice |
30509 | When @value{GDBN} wants the user to select between various overloaded functions. | |
30510 | ||
e5ac9b53 EZ |
30511 | @findex pre-query annotation |
30512 | @findex query annotation | |
30513 | @findex post-query annotation | |
922fbb7b AC |
30514 | @item query |
30515 | When @value{GDBN} wants the user to confirm a potentially dangerous operation. | |
30516 | ||
e5ac9b53 EZ |
30517 | @findex pre-prompt-for-continue annotation |
30518 | @findex prompt-for-continue annotation | |
30519 | @findex post-prompt-for-continue annotation | |
922fbb7b AC |
30520 | @item prompt-for-continue |
30521 | When @value{GDBN} is asking the user to press return to continue. Note: Don't | |
30522 | expect this to work well; instead use @code{set height 0} to disable | |
30523 | prompting. This is because the counting of lines is buggy in the | |
30524 | presence of annotations. | |
30525 | @end table | |
30526 | ||
30527 | @node Errors | |
30528 | @section Errors | |
30529 | @cindex annotations for errors, warnings and interrupts | |
30530 | ||
e5ac9b53 | 30531 | @findex quit annotation |
922fbb7b AC |
30532 | @smallexample |
30533 | ^Z^Zquit | |
30534 | @end smallexample | |
30535 | ||
30536 | This annotation occurs right before @value{GDBN} responds to an interrupt. | |
30537 | ||
e5ac9b53 | 30538 | @findex error annotation |
922fbb7b AC |
30539 | @smallexample |
30540 | ^Z^Zerror | |
30541 | @end smallexample | |
30542 | ||
30543 | This annotation occurs right before @value{GDBN} responds to an error. | |
30544 | ||
30545 | Quit and error annotations indicate that any annotations which @value{GDBN} was | |
30546 | in the middle of may end abruptly. For example, if a | |
30547 | @code{value-history-begin} annotation is followed by a @code{error}, one | |
30548 | cannot expect to receive the matching @code{value-history-end}. One | |
30549 | cannot expect not to receive it either, however; an error annotation | |
30550 | does not necessarily mean that @value{GDBN} is immediately returning all the way | |
30551 | to the top level. | |
30552 | ||
e5ac9b53 | 30553 | @findex error-begin annotation |
922fbb7b AC |
30554 | A quit or error annotation may be preceded by |
30555 | ||
30556 | @smallexample | |
30557 | ^Z^Zerror-begin | |
30558 | @end smallexample | |
30559 | ||
30560 | Any output between that and the quit or error annotation is the error | |
30561 | message. | |
30562 | ||
30563 | Warning messages are not yet annotated. | |
30564 | @c If we want to change that, need to fix warning(), type_error(), | |
30565 | @c range_error(), and possibly other places. | |
30566 | ||
922fbb7b AC |
30567 | @node Invalidation |
30568 | @section Invalidation Notices | |
30569 | ||
30570 | @cindex annotations for invalidation messages | |
30571 | The following annotations say that certain pieces of state may have | |
30572 | changed. | |
30573 | ||
30574 | @table @code | |
e5ac9b53 | 30575 | @findex frames-invalid annotation |
922fbb7b AC |
30576 | @item ^Z^Zframes-invalid |
30577 | ||
30578 | The frames (for example, output from the @code{backtrace} command) may | |
30579 | have changed. | |
30580 | ||
e5ac9b53 | 30581 | @findex breakpoints-invalid annotation |
922fbb7b AC |
30582 | @item ^Z^Zbreakpoints-invalid |
30583 | ||
30584 | The breakpoints may have changed. For example, the user just added or | |
30585 | deleted a breakpoint. | |
30586 | @end table | |
30587 | ||
30588 | @node Annotations for Running | |
30589 | @section Running the Program | |
30590 | @cindex annotations for running programs | |
30591 | ||
e5ac9b53 EZ |
30592 | @findex starting annotation |
30593 | @findex stopping annotation | |
922fbb7b | 30594 | When the program starts executing due to a @value{GDBN} command such as |
b383017d | 30595 | @code{step} or @code{continue}, |
922fbb7b AC |
30596 | |
30597 | @smallexample | |
30598 | ^Z^Zstarting | |
30599 | @end smallexample | |
30600 | ||
b383017d | 30601 | is output. When the program stops, |
922fbb7b AC |
30602 | |
30603 | @smallexample | |
30604 | ^Z^Zstopped | |
30605 | @end smallexample | |
30606 | ||
30607 | is output. Before the @code{stopped} annotation, a variety of | |
30608 | annotations describe how the program stopped. | |
30609 | ||
30610 | @table @code | |
e5ac9b53 | 30611 | @findex exited annotation |
922fbb7b AC |
30612 | @item ^Z^Zexited @var{exit-status} |
30613 | The program exited, and @var{exit-status} is the exit status (zero for | |
30614 | successful exit, otherwise nonzero). | |
30615 | ||
e5ac9b53 EZ |
30616 | @findex signalled annotation |
30617 | @findex signal-name annotation | |
30618 | @findex signal-name-end annotation | |
30619 | @findex signal-string annotation | |
30620 | @findex signal-string-end annotation | |
922fbb7b AC |
30621 | @item ^Z^Zsignalled |
30622 | The program exited with a signal. After the @code{^Z^Zsignalled}, the | |
30623 | annotation continues: | |
30624 | ||
30625 | @smallexample | |
30626 | @var{intro-text} | |
30627 | ^Z^Zsignal-name | |
30628 | @var{name} | |
30629 | ^Z^Zsignal-name-end | |
30630 | @var{middle-text} | |
30631 | ^Z^Zsignal-string | |
30632 | @var{string} | |
30633 | ^Z^Zsignal-string-end | |
30634 | @var{end-text} | |
30635 | @end smallexample | |
30636 | ||
30637 | @noindent | |
30638 | where @var{name} is the name of the signal, such as @code{SIGILL} or | |
30639 | @code{SIGSEGV}, and @var{string} is the explanation of the signal, such | |
30640 | as @code{Illegal Instruction} or @code{Segmentation fault}. | |
30641 | @var{intro-text}, @var{middle-text}, and @var{end-text} are for the | |
30642 | user's benefit and have no particular format. | |
30643 | ||
e5ac9b53 | 30644 | @findex signal annotation |
922fbb7b AC |
30645 | @item ^Z^Zsignal |
30646 | The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is | |
30647 | just saying that the program received the signal, not that it was | |
30648 | terminated with it. | |
30649 | ||
e5ac9b53 | 30650 | @findex breakpoint annotation |
922fbb7b AC |
30651 | @item ^Z^Zbreakpoint @var{number} |
30652 | The program hit breakpoint number @var{number}. | |
30653 | ||
e5ac9b53 | 30654 | @findex watchpoint annotation |
922fbb7b AC |
30655 | @item ^Z^Zwatchpoint @var{number} |
30656 | The program hit watchpoint number @var{number}. | |
30657 | @end table | |
30658 | ||
30659 | @node Source Annotations | |
30660 | @section Displaying Source | |
30661 | @cindex annotations for source display | |
30662 | ||
e5ac9b53 | 30663 | @findex source annotation |
922fbb7b AC |
30664 | The following annotation is used instead of displaying source code: |
30665 | ||
30666 | @smallexample | |
30667 | ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr} | |
30668 | @end smallexample | |
30669 | ||
30670 | where @var{filename} is an absolute file name indicating which source | |
30671 | file, @var{line} is the line number within that file (where 1 is the | |
30672 | first line in the file), @var{character} is the character position | |
30673 | within the file (where 0 is the first character in the file) (for most | |
30674 | debug formats this will necessarily point to the beginning of a line), | |
30675 | @var{middle} is @samp{middle} if @var{addr} is in the middle of the | |
30676 | line, or @samp{beg} if @var{addr} is at the beginning of the line, and | |
30677 | @var{addr} is the address in the target program associated with the | |
30678 | source which is being displayed. @var{addr} is in the form @samp{0x} | |
30679 | followed by one or more lowercase hex digits (note that this does not | |
30680 | depend on the language). | |
30681 | ||
4efc6507 DE |
30682 | @node JIT Interface |
30683 | @chapter JIT Compilation Interface | |
30684 | @cindex just-in-time compilation | |
30685 | @cindex JIT compilation interface | |
30686 | ||
30687 | This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation | |
30688 | interface. A JIT compiler is a program or library that generates native | |
30689 | executable code at runtime and executes it, usually in order to achieve good | |
30690 | performance while maintaining platform independence. | |
30691 | ||
30692 | Programs that use JIT compilation are normally difficult to debug because | |
30693 | portions of their code are generated at runtime, instead of being loaded from | |
30694 | object files, which is where @value{GDBN} normally finds the program's symbols | |
30695 | and debug information. In order to debug programs that use JIT compilation, | |
30696 | @value{GDBN} has an interface that allows the program to register in-memory | |
30697 | symbol files with @value{GDBN} at runtime. | |
30698 | ||
30699 | If you are using @value{GDBN} to debug a program that uses this interface, then | |
30700 | it should work transparently so long as you have not stripped the binary. If | |
30701 | you are developing a JIT compiler, then the interface is documented in the rest | |
30702 | of this chapter. At this time, the only known client of this interface is the | |
30703 | LLVM JIT. | |
30704 | ||
30705 | Broadly speaking, the JIT interface mirrors the dynamic loader interface. The | |
30706 | JIT compiler communicates with @value{GDBN} by writing data into a global | |
30707 | variable and calling a fuction at a well-known symbol. When @value{GDBN} | |
30708 | attaches, it reads a linked list of symbol files from the global variable to | |
30709 | find existing code, and puts a breakpoint in the function so that it can find | |
30710 | out about additional code. | |
30711 | ||
30712 | @menu | |
30713 | * Declarations:: Relevant C struct declarations | |
30714 | * Registering Code:: Steps to register code | |
30715 | * Unregistering Code:: Steps to unregister code | |
30716 | @end menu | |
30717 | ||
30718 | @node Declarations | |
30719 | @section JIT Declarations | |
30720 | ||
30721 | These are the relevant struct declarations that a C program should include to | |
30722 | implement the interface: | |
30723 | ||
30724 | @smallexample | |
30725 | typedef enum | |
30726 | @{ | |
30727 | JIT_NOACTION = 0, | |
30728 | JIT_REGISTER_FN, | |
30729 | JIT_UNREGISTER_FN | |
30730 | @} jit_actions_t; | |
30731 | ||
30732 | struct jit_code_entry | |
30733 | @{ | |
30734 | struct jit_code_entry *next_entry; | |
30735 | struct jit_code_entry *prev_entry; | |
30736 | const char *symfile_addr; | |
30737 | uint64_t symfile_size; | |
30738 | @}; | |
30739 | ||
30740 | struct jit_descriptor | |
30741 | @{ | |
30742 | uint32_t version; | |
30743 | /* This type should be jit_actions_t, but we use uint32_t | |
30744 | to be explicit about the bitwidth. */ | |
30745 | uint32_t action_flag; | |
30746 | struct jit_code_entry *relevant_entry; | |
30747 | struct jit_code_entry *first_entry; | |
30748 | @}; | |
30749 | ||
30750 | /* GDB puts a breakpoint in this function. */ | |
30751 | void __attribute__((noinline)) __jit_debug_register_code() @{ @}; | |
30752 | ||
30753 | /* Make sure to specify the version statically, because the | |
30754 | debugger may check the version before we can set it. */ | |
30755 | struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @}; | |
30756 | @end smallexample | |
30757 | ||
30758 | If the JIT is multi-threaded, then it is important that the JIT synchronize any | |
30759 | modifications to this global data properly, which can easily be done by putting | |
30760 | a global mutex around modifications to these structures. | |
30761 | ||
30762 | @node Registering Code | |
30763 | @section Registering Code | |
30764 | ||
30765 | To register code with @value{GDBN}, the JIT should follow this protocol: | |
30766 | ||
30767 | @itemize @bullet | |
30768 | @item | |
30769 | Generate an object file in memory with symbols and other desired debug | |
30770 | information. The file must include the virtual addresses of the sections. | |
30771 | ||
30772 | @item | |
30773 | Create a code entry for the file, which gives the start and size of the symbol | |
30774 | file. | |
30775 | ||
30776 | @item | |
30777 | Add it to the linked list in the JIT descriptor. | |
30778 | ||
30779 | @item | |
30780 | Point the relevant_entry field of the descriptor at the entry. | |
30781 | ||
30782 | @item | |
30783 | Set @code{action_flag} to @code{JIT_REGISTER} and call | |
30784 | @code{__jit_debug_register_code}. | |
30785 | @end itemize | |
30786 | ||
30787 | When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the | |
30788 | @code{relevant_entry} pointer so it doesn't have to walk the list looking for | |
30789 | new code. However, the linked list must still be maintained in order to allow | |
30790 | @value{GDBN} to attach to a running process and still find the symbol files. | |
30791 | ||
30792 | @node Unregistering Code | |
30793 | @section Unregistering Code | |
30794 | ||
30795 | If code is freed, then the JIT should use the following protocol: | |
30796 | ||
30797 | @itemize @bullet | |
30798 | @item | |
30799 | Remove the code entry corresponding to the code from the linked list. | |
30800 | ||
30801 | @item | |
30802 | Point the @code{relevant_entry} field of the descriptor at the code entry. | |
30803 | ||
30804 | @item | |
30805 | Set @code{action_flag} to @code{JIT_UNREGISTER} and call | |
30806 | @code{__jit_debug_register_code}. | |
30807 | @end itemize | |
30808 | ||
30809 | If the JIT frees or recompiles code without unregistering it, then @value{GDBN} | |
30810 | and the JIT will leak the memory used for the associated symbol files. | |
30811 | ||
8e04817f AC |
30812 | @node GDB Bugs |
30813 | @chapter Reporting Bugs in @value{GDBN} | |
30814 | @cindex bugs in @value{GDBN} | |
30815 | @cindex reporting bugs in @value{GDBN} | |
c906108c | 30816 | |
8e04817f | 30817 | Your bug reports play an essential role in making @value{GDBN} reliable. |
c906108c | 30818 | |
8e04817f AC |
30819 | Reporting a bug may help you by bringing a solution to your problem, or it |
30820 | may not. But in any case the principal function of a bug report is to help | |
30821 | the entire community by making the next version of @value{GDBN} work better. Bug | |
30822 | reports are your contribution to the maintenance of @value{GDBN}. | |
c906108c | 30823 | |
8e04817f AC |
30824 | In order for a bug report to serve its purpose, you must include the |
30825 | information that enables us to fix the bug. | |
c4555f82 SC |
30826 | |
30827 | @menu | |
8e04817f AC |
30828 | * Bug Criteria:: Have you found a bug? |
30829 | * Bug Reporting:: How to report bugs | |
c4555f82 SC |
30830 | @end menu |
30831 | ||
8e04817f | 30832 | @node Bug Criteria |
79a6e687 | 30833 | @section Have You Found a Bug? |
8e04817f | 30834 | @cindex bug criteria |
c4555f82 | 30835 | |
8e04817f | 30836 | If you are not sure whether you have found a bug, here are some guidelines: |
c4555f82 SC |
30837 | |
30838 | @itemize @bullet | |
8e04817f AC |
30839 | @cindex fatal signal |
30840 | @cindex debugger crash | |
30841 | @cindex crash of debugger | |
c4555f82 | 30842 | @item |
8e04817f AC |
30843 | If the debugger gets a fatal signal, for any input whatever, that is a |
30844 | @value{GDBN} bug. Reliable debuggers never crash. | |
30845 | ||
30846 | @cindex error on valid input | |
30847 | @item | |
30848 | If @value{GDBN} produces an error message for valid input, that is a | |
30849 | bug. (Note that if you're cross debugging, the problem may also be | |
30850 | somewhere in the connection to the target.) | |
c4555f82 | 30851 | |
8e04817f | 30852 | @cindex invalid input |
c4555f82 | 30853 | @item |
8e04817f AC |
30854 | If @value{GDBN} does not produce an error message for invalid input, |
30855 | that is a bug. However, you should note that your idea of | |
30856 | ``invalid input'' might be our idea of ``an extension'' or ``support | |
30857 | for traditional practice''. | |
30858 | ||
30859 | @item | |
30860 | If you are an experienced user of debugging tools, your suggestions | |
30861 | for improvement of @value{GDBN} are welcome in any case. | |
c4555f82 SC |
30862 | @end itemize |
30863 | ||
8e04817f | 30864 | @node Bug Reporting |
79a6e687 | 30865 | @section How to Report Bugs |
8e04817f AC |
30866 | @cindex bug reports |
30867 | @cindex @value{GDBN} bugs, reporting | |
30868 | ||
30869 | A number of companies and individuals offer support for @sc{gnu} products. | |
30870 | If you obtained @value{GDBN} from a support organization, we recommend you | |
30871 | contact that organization first. | |
30872 | ||
30873 | You can find contact information for many support companies and | |
30874 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
30875 | distribution. | |
30876 | @c should add a web page ref... | |
30877 | ||
c16158bc JM |
30878 | @ifset BUGURL |
30879 | @ifset BUGURL_DEFAULT | |
129188f6 | 30880 | In any event, we also recommend that you submit bug reports for |
d3e8051b | 30881 | @value{GDBN}. The preferred method is to submit them directly using |
129188f6 AC |
30882 | @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web |
30883 | page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can | |
30884 | be used. | |
8e04817f AC |
30885 | |
30886 | @strong{Do not send bug reports to @samp{info-gdb}, or to | |
30887 | @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do | |
30888 | not want to receive bug reports. Those that do have arranged to receive | |
30889 | @samp{bug-gdb}. | |
30890 | ||
30891 | The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which | |
30892 | serves as a repeater. The mailing list and the newsgroup carry exactly | |
30893 | the same messages. Often people think of posting bug reports to the | |
30894 | newsgroup instead of mailing them. This appears to work, but it has one | |
30895 | problem which can be crucial: a newsgroup posting often lacks a mail | |
30896 | path back to the sender. Thus, if we need to ask for more information, | |
30897 | we may be unable to reach you. For this reason, it is better to send | |
30898 | bug reports to the mailing list. | |
c16158bc JM |
30899 | @end ifset |
30900 | @ifclear BUGURL_DEFAULT | |
30901 | In any event, we also recommend that you submit bug reports for | |
30902 | @value{GDBN} to @value{BUGURL}. | |
30903 | @end ifclear | |
30904 | @end ifset | |
c4555f82 | 30905 | |
8e04817f AC |
30906 | The fundamental principle of reporting bugs usefully is this: |
30907 | @strong{report all the facts}. If you are not sure whether to state a | |
30908 | fact or leave it out, state it! | |
c4555f82 | 30909 | |
8e04817f AC |
30910 | Often people omit facts because they think they know what causes the |
30911 | problem and assume that some details do not matter. Thus, you might | |
30912 | assume that the name of the variable you use in an example does not matter. | |
30913 | Well, probably it does not, but one cannot be sure. Perhaps the bug is a | |
30914 | stray memory reference which happens to fetch from the location where that | |
30915 | name is stored in memory; perhaps, if the name were different, the contents | |
30916 | of that location would fool the debugger into doing the right thing despite | |
30917 | the bug. Play it safe and give a specific, complete example. That is the | |
30918 | easiest thing for you to do, and the most helpful. | |
c4555f82 | 30919 | |
8e04817f AC |
30920 | Keep in mind that the purpose of a bug report is to enable us to fix the |
30921 | bug. It may be that the bug has been reported previously, but neither | |
30922 | you nor we can know that unless your bug report is complete and | |
30923 | self-contained. | |
c4555f82 | 30924 | |
8e04817f AC |
30925 | Sometimes people give a few sketchy facts and ask, ``Does this ring a |
30926 | bell?'' Those bug reports are useless, and we urge everyone to | |
30927 | @emph{refuse to respond to them} except to chide the sender to report | |
30928 | bugs properly. | |
30929 | ||
30930 | To enable us to fix the bug, you should include all these things: | |
c4555f82 SC |
30931 | |
30932 | @itemize @bullet | |
30933 | @item | |
8e04817f AC |
30934 | The version of @value{GDBN}. @value{GDBN} announces it if you start |
30935 | with no arguments; you can also print it at any time using @code{show | |
30936 | version}. | |
c4555f82 | 30937 | |
8e04817f AC |
30938 | Without this, we will not know whether there is any point in looking for |
30939 | the bug in the current version of @value{GDBN}. | |
c4555f82 SC |
30940 | |
30941 | @item | |
8e04817f AC |
30942 | The type of machine you are using, and the operating system name and |
30943 | version number. | |
c4555f82 SC |
30944 | |
30945 | @item | |
c1468174 | 30946 | What compiler (and its version) was used to compile @value{GDBN}---e.g.@: |
8e04817f | 30947 | ``@value{GCC}--2.8.1''. |
c4555f82 SC |
30948 | |
30949 | @item | |
8e04817f | 30950 | What compiler (and its version) was used to compile the program you are |
c1468174 | 30951 | debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP |
3f94c067 BW |
30952 | C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version} |
30953 | to get this information; for other compilers, see the documentation for | |
30954 | those compilers. | |
c4555f82 | 30955 | |
8e04817f AC |
30956 | @item |
30957 | The command arguments you gave the compiler to compile your example and | |
30958 | observe the bug. For example, did you use @samp{-O}? To guarantee | |
30959 | you will not omit something important, list them all. A copy of the | |
30960 | Makefile (or the output from make) is sufficient. | |
c4555f82 | 30961 | |
8e04817f AC |
30962 | If we were to try to guess the arguments, we would probably guess wrong |
30963 | and then we might not encounter the bug. | |
c4555f82 | 30964 | |
8e04817f AC |
30965 | @item |
30966 | A complete input script, and all necessary source files, that will | |
30967 | reproduce the bug. | |
c4555f82 | 30968 | |
8e04817f AC |
30969 | @item |
30970 | A description of what behavior you observe that you believe is | |
30971 | incorrect. For example, ``It gets a fatal signal.'' | |
c4555f82 | 30972 | |
8e04817f AC |
30973 | Of course, if the bug is that @value{GDBN} gets a fatal signal, then we |
30974 | will certainly notice it. But if the bug is incorrect output, we might | |
30975 | not notice unless it is glaringly wrong. You might as well not give us | |
30976 | a chance to make a mistake. | |
c4555f82 | 30977 | |
8e04817f AC |
30978 | Even if the problem you experience is a fatal signal, you should still |
30979 | say so explicitly. Suppose something strange is going on, such as, your | |
30980 | copy of @value{GDBN} is out of synch, or you have encountered a bug in | |
30981 | the C library on your system. (This has happened!) Your copy might | |
30982 | crash and ours would not. If you told us to expect a crash, then when | |
30983 | ours fails to crash, we would know that the bug was not happening for | |
30984 | us. If you had not told us to expect a crash, then we would not be able | |
30985 | to draw any conclusion from our observations. | |
c4555f82 | 30986 | |
e0c07bf0 MC |
30987 | @pindex script |
30988 | @cindex recording a session script | |
30989 | To collect all this information, you can use a session recording program | |
30990 | such as @command{script}, which is available on many Unix systems. | |
30991 | Just run your @value{GDBN} session inside @command{script} and then | |
30992 | include the @file{typescript} file with your bug report. | |
30993 | ||
30994 | Another way to record a @value{GDBN} session is to run @value{GDBN} | |
30995 | inside Emacs and then save the entire buffer to a file. | |
30996 | ||
8e04817f AC |
30997 | @item |
30998 | If you wish to suggest changes to the @value{GDBN} source, send us context | |
30999 | diffs. If you even discuss something in the @value{GDBN} source, refer to | |
31000 | it by context, not by line number. | |
c4555f82 | 31001 | |
8e04817f AC |
31002 | The line numbers in our development sources will not match those in your |
31003 | sources. Your line numbers would convey no useful information to us. | |
c4555f82 | 31004 | |
8e04817f | 31005 | @end itemize |
c4555f82 | 31006 | |
8e04817f | 31007 | Here are some things that are not necessary: |
c4555f82 | 31008 | |
8e04817f AC |
31009 | @itemize @bullet |
31010 | @item | |
31011 | A description of the envelope of the bug. | |
c4555f82 | 31012 | |
8e04817f AC |
31013 | Often people who encounter a bug spend a lot of time investigating |
31014 | which changes to the input file will make the bug go away and which | |
31015 | changes will not affect it. | |
c4555f82 | 31016 | |
8e04817f AC |
31017 | This is often time consuming and not very useful, because the way we |
31018 | will find the bug is by running a single example under the debugger | |
31019 | with breakpoints, not by pure deduction from a series of examples. | |
31020 | We recommend that you save your time for something else. | |
c4555f82 | 31021 | |
8e04817f AC |
31022 | Of course, if you can find a simpler example to report @emph{instead} |
31023 | of the original one, that is a convenience for us. Errors in the | |
31024 | output will be easier to spot, running under the debugger will take | |
31025 | less time, and so on. | |
c4555f82 | 31026 | |
8e04817f AC |
31027 | However, simplification is not vital; if you do not want to do this, |
31028 | report the bug anyway and send us the entire test case you used. | |
c4555f82 | 31029 | |
8e04817f AC |
31030 | @item |
31031 | A patch for the bug. | |
c4555f82 | 31032 | |
8e04817f AC |
31033 | A patch for the bug does help us if it is a good one. But do not omit |
31034 | the necessary information, such as the test case, on the assumption that | |
31035 | a patch is all we need. We might see problems with your patch and decide | |
31036 | to fix the problem another way, or we might not understand it at all. | |
c4555f82 | 31037 | |
8e04817f AC |
31038 | Sometimes with a program as complicated as @value{GDBN} it is very hard to |
31039 | construct an example that will make the program follow a certain path | |
31040 | through the code. If you do not send us the example, we will not be able | |
31041 | to construct one, so we will not be able to verify that the bug is fixed. | |
c4555f82 | 31042 | |
8e04817f AC |
31043 | And if we cannot understand what bug you are trying to fix, or why your |
31044 | patch should be an improvement, we will not install it. A test case will | |
31045 | help us to understand. | |
c4555f82 | 31046 | |
8e04817f AC |
31047 | @item |
31048 | A guess about what the bug is or what it depends on. | |
c4555f82 | 31049 | |
8e04817f AC |
31050 | Such guesses are usually wrong. Even we cannot guess right about such |
31051 | things without first using the debugger to find the facts. | |
31052 | @end itemize | |
c4555f82 | 31053 | |
8e04817f AC |
31054 | @c The readline documentation is distributed with the readline code |
31055 | @c and consists of the two following files: | |
cc88a640 JK |
31056 | @c rluser.texi |
31057 | @c hsuser.texi | |
8e04817f AC |
31058 | @c Use -I with makeinfo to point to the appropriate directory, |
31059 | @c environment var TEXINPUTS with TeX. | |
39037522 | 31060 | @ifclear SYSTEM_READLINE |
5bdf8622 | 31061 | @include rluser.texi |
cc88a640 | 31062 | @include hsuser.texi |
39037522 | 31063 | @end ifclear |
c4555f82 | 31064 | |
4ceed123 JB |
31065 | @node In Memoriam |
31066 | @appendix In Memoriam | |
31067 | ||
9ed350ad JB |
31068 | The @value{GDBN} project mourns the loss of the following long-time |
31069 | contributors: | |
4ceed123 JB |
31070 | |
31071 | @table @code | |
31072 | @item Fred Fish | |
9ed350ad JB |
31073 | Fred was a long-standing contributor to @value{GDBN} (1991-2006), and |
31074 | to Free Software in general. Outside of @value{GDBN}, he was known in | |
31075 | the Amiga world for his series of Fish Disks, and the GeekGadget project. | |
4ceed123 JB |
31076 | |
31077 | @item Michael Snyder | |
9ed350ad JB |
31078 | Michael was one of the Global Maintainers of the @value{GDBN} project, |
31079 | with contributions recorded as early as 1996, until 2011. In addition | |
31080 | to his day to day participation, he was a large driving force behind | |
31081 | adding Reverse Debugging to @value{GDBN}. | |
4ceed123 JB |
31082 | @end table |
31083 | ||
31084 | Beyond their technical contributions to the project, they were also | |
31085 | enjoyable members of the Free Software Community. We will miss them. | |
c4555f82 | 31086 | |
8e04817f AC |
31087 | @node Formatting Documentation |
31088 | @appendix Formatting Documentation | |
c4555f82 | 31089 | |
8e04817f AC |
31090 | @cindex @value{GDBN} reference card |
31091 | @cindex reference card | |
31092 | The @value{GDBN} 4 release includes an already-formatted reference card, ready | |
31093 | for printing with PostScript or Ghostscript, in the @file{gdb} | |
31094 | subdirectory of the main source directory@footnote{In | |
31095 | @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN} | |
31096 | release.}. If you can use PostScript or Ghostscript with your printer, | |
31097 | you can print the reference card immediately with @file{refcard.ps}. | |
c4555f82 | 31098 | |
8e04817f AC |
31099 | The release also includes the source for the reference card. You |
31100 | can format it, using @TeX{}, by typing: | |
c4555f82 | 31101 | |
474c8240 | 31102 | @smallexample |
8e04817f | 31103 | make refcard.dvi |
474c8240 | 31104 | @end smallexample |
c4555f82 | 31105 | |
8e04817f AC |
31106 | The @value{GDBN} reference card is designed to print in @dfn{landscape} |
31107 | mode on US ``letter'' size paper; | |
31108 | that is, on a sheet 11 inches wide by 8.5 inches | |
31109 | high. You will need to specify this form of printing as an option to | |
31110 | your @sc{dvi} output program. | |
c4555f82 | 31111 | |
8e04817f | 31112 | @cindex documentation |
c4555f82 | 31113 | |
8e04817f AC |
31114 | All the documentation for @value{GDBN} comes as part of the machine-readable |
31115 | distribution. The documentation is written in Texinfo format, which is | |
31116 | a documentation system that uses a single source file to produce both | |
31117 | on-line information and a printed manual. You can use one of the Info | |
31118 | formatting commands to create the on-line version of the documentation | |
31119 | and @TeX{} (or @code{texi2roff}) to typeset the printed version. | |
c4555f82 | 31120 | |
8e04817f AC |
31121 | @value{GDBN} includes an already formatted copy of the on-line Info |
31122 | version of this manual in the @file{gdb} subdirectory. The main Info | |
31123 | file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to | |
31124 | subordinate files matching @samp{gdb.info*} in the same directory. If | |
31125 | necessary, you can print out these files, or read them with any editor; | |
31126 | but they are easier to read using the @code{info} subsystem in @sc{gnu} | |
31127 | Emacs or the standalone @code{info} program, available as part of the | |
31128 | @sc{gnu} Texinfo distribution. | |
c4555f82 | 31129 | |
8e04817f AC |
31130 | If you want to format these Info files yourself, you need one of the |
31131 | Info formatting programs, such as @code{texinfo-format-buffer} or | |
31132 | @code{makeinfo}. | |
c4555f82 | 31133 | |
8e04817f AC |
31134 | If you have @code{makeinfo} installed, and are in the top level |
31135 | @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of | |
31136 | version @value{GDBVN}), you can make the Info file by typing: | |
c4555f82 | 31137 | |
474c8240 | 31138 | @smallexample |
8e04817f AC |
31139 | cd gdb |
31140 | make gdb.info | |
474c8240 | 31141 | @end smallexample |
c4555f82 | 31142 | |
8e04817f AC |
31143 | If you want to typeset and print copies of this manual, you need @TeX{}, |
31144 | a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the | |
31145 | Texinfo definitions file. | |
c4555f82 | 31146 | |
8e04817f AC |
31147 | @TeX{} is a typesetting program; it does not print files directly, but |
31148 | produces output files called @sc{dvi} files. To print a typeset | |
31149 | document, you need a program to print @sc{dvi} files. If your system | |
31150 | has @TeX{} installed, chances are it has such a program. The precise | |
31151 | command to use depends on your system; @kbd{lpr -d} is common; another | |
31152 | (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may | |
31153 | require a file name without any extension or a @samp{.dvi} extension. | |
c4555f82 | 31154 | |
8e04817f AC |
31155 | @TeX{} also requires a macro definitions file called |
31156 | @file{texinfo.tex}. This file tells @TeX{} how to typeset a document | |
31157 | written in Texinfo format. On its own, @TeX{} cannot either read or | |
31158 | typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB | |
31159 | and is located in the @file{gdb-@var{version-number}/texinfo} | |
31160 | directory. | |
c4555f82 | 31161 | |
8e04817f | 31162 | If you have @TeX{} and a @sc{dvi} printer program installed, you can |
d3e8051b | 31163 | typeset and print this manual. First switch to the @file{gdb} |
8e04817f AC |
31164 | subdirectory of the main source directory (for example, to |
31165 | @file{gdb-@value{GDBVN}/gdb}) and type: | |
c4555f82 | 31166 | |
474c8240 | 31167 | @smallexample |
8e04817f | 31168 | make gdb.dvi |
474c8240 | 31169 | @end smallexample |
c4555f82 | 31170 | |
8e04817f | 31171 | Then give @file{gdb.dvi} to your @sc{dvi} printing program. |
c4555f82 | 31172 | |
8e04817f AC |
31173 | @node Installing GDB |
31174 | @appendix Installing @value{GDBN} | |
8e04817f | 31175 | @cindex installation |
c4555f82 | 31176 | |
7fa2210b DJ |
31177 | @menu |
31178 | * Requirements:: Requirements for building @value{GDBN} | |
db2e3e2e | 31179 | * Running Configure:: Invoking the @value{GDBN} @file{configure} script |
7fa2210b DJ |
31180 | * Separate Objdir:: Compiling @value{GDBN} in another directory |
31181 | * Config Names:: Specifying names for hosts and targets | |
31182 | * Configure Options:: Summary of options for configure | |
098b41a6 | 31183 | * System-wide configuration:: Having a system-wide init file |
7fa2210b DJ |
31184 | @end menu |
31185 | ||
31186 | @node Requirements | |
79a6e687 | 31187 | @section Requirements for Building @value{GDBN} |
7fa2210b DJ |
31188 | @cindex building @value{GDBN}, requirements for |
31189 | ||
31190 | Building @value{GDBN} requires various tools and packages to be available. | |
31191 | Other packages will be used only if they are found. | |
31192 | ||
79a6e687 | 31193 | @heading Tools/Packages Necessary for Building @value{GDBN} |
7fa2210b DJ |
31194 | @table @asis |
31195 | @item ISO C90 compiler | |
31196 | @value{GDBN} is written in ISO C90. It should be buildable with any | |
31197 | working C90 compiler, e.g.@: GCC. | |
31198 | ||
31199 | @end table | |
31200 | ||
79a6e687 | 31201 | @heading Tools/Packages Optional for Building @value{GDBN} |
7fa2210b DJ |
31202 | @table @asis |
31203 | @item Expat | |
123dc839 | 31204 | @anchor{Expat} |
7fa2210b DJ |
31205 | @value{GDBN} can use the Expat XML parsing library. This library may be |
31206 | included with your operating system distribution; if it is not, you | |
31207 | can get the latest version from @url{http://expat.sourceforge.net}. | |
db2e3e2e | 31208 | The @file{configure} script will search for this library in several |
7fa2210b DJ |
31209 | standard locations; if it is installed in an unusual path, you can |
31210 | use the @option{--with-libexpat-prefix} option to specify its location. | |
31211 | ||
9cceb671 DJ |
31212 | Expat is used for: |
31213 | ||
31214 | @itemize @bullet | |
31215 | @item | |
31216 | Remote protocol memory maps (@pxref{Memory Map Format}) | |
31217 | @item | |
31218 | Target descriptions (@pxref{Target Descriptions}) | |
31219 | @item | |
31220 | Remote shared library lists (@pxref{Library List Format}) | |
31221 | @item | |
31222 | MS-Windows shared libraries (@pxref{Shared Libraries}) | |
b3b9301e PA |
31223 | @item |
31224 | Traceframe info (@pxref{Traceframe Info Format}) | |
9cceb671 | 31225 | @end itemize |
7fa2210b | 31226 | |
31fffb02 CS |
31227 | @item zlib |
31228 | @cindex compressed debug sections | |
31229 | @value{GDBN} will use the @samp{zlib} library, if available, to read | |
31230 | compressed debug sections. Some linkers, such as GNU gold, are capable | |
31231 | of producing binaries with compressed debug sections. If @value{GDBN} | |
31232 | is compiled with @samp{zlib}, it will be able to read the debug | |
31233 | information in such binaries. | |
31234 | ||
31235 | The @samp{zlib} library is likely included with your operating system | |
31236 | distribution; if it is not, you can get the latest version from | |
31237 | @url{http://zlib.net}. | |
31238 | ||
6c7a06a3 TT |
31239 | @item iconv |
31240 | @value{GDBN}'s features related to character sets (@pxref{Character | |
31241 | Sets}) require a functioning @code{iconv} implementation. If you are | |
31242 | on a GNU system, then this is provided by the GNU C Library. Some | |
31243 | other systems also provide a working @code{iconv}. | |
31244 | ||
478aac75 DE |
31245 | If @value{GDBN} is using the @code{iconv} program which is installed |
31246 | in a non-standard place, you will need to tell @value{GDBN} where to find it. | |
31247 | This is done with @option{--with-iconv-bin} which specifies the | |
31248 | directory that contains the @code{iconv} program. | |
31249 | ||
31250 | On systems without @code{iconv}, you can install GNU Libiconv. If you | |
6c7a06a3 TT |
31251 | have previously installed Libiconv, you can use the |
31252 | @option{--with-libiconv-prefix} option to configure. | |
31253 | ||
31254 | @value{GDBN}'s top-level @file{configure} and @file{Makefile} will | |
31255 | arrange to build Libiconv if a directory named @file{libiconv} appears | |
31256 | in the top-most source directory. If Libiconv is built this way, and | |
31257 | if the operating system does not provide a suitable @code{iconv} | |
31258 | implementation, then the just-built library will automatically be used | |
31259 | by @value{GDBN}. One easy way to set this up is to download GNU | |
31260 | Libiconv, unpack it, and then rename the directory holding the | |
31261 | Libiconv source code to @samp{libiconv}. | |
7fa2210b DJ |
31262 | @end table |
31263 | ||
31264 | @node Running Configure | |
db2e3e2e | 31265 | @section Invoking the @value{GDBN} @file{configure} Script |
7fa2210b | 31266 | @cindex configuring @value{GDBN} |
db2e3e2e | 31267 | @value{GDBN} comes with a @file{configure} script that automates the process |
8e04817f AC |
31268 | of preparing @value{GDBN} for installation; you can then use @code{make} to |
31269 | build the @code{gdb} program. | |
31270 | @iftex | |
31271 | @c irrelevant in info file; it's as current as the code it lives with. | |
31272 | @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN}, | |
31273 | look at the @file{README} file in the sources; we may have improved the | |
31274 | installation procedures since publishing this manual.} | |
31275 | @end iftex | |
c4555f82 | 31276 | |
8e04817f AC |
31277 | The @value{GDBN} distribution includes all the source code you need for |
31278 | @value{GDBN} in a single directory, whose name is usually composed by | |
31279 | appending the version number to @samp{gdb}. | |
c4555f82 | 31280 | |
8e04817f AC |
31281 | For example, the @value{GDBN} version @value{GDBVN} distribution is in the |
31282 | @file{gdb-@value{GDBVN}} directory. That directory contains: | |
c4555f82 | 31283 | |
8e04817f AC |
31284 | @table @code |
31285 | @item gdb-@value{GDBVN}/configure @r{(and supporting files)} | |
31286 | script for configuring @value{GDBN} and all its supporting libraries | |
c4555f82 | 31287 | |
8e04817f AC |
31288 | @item gdb-@value{GDBVN}/gdb |
31289 | the source specific to @value{GDBN} itself | |
c4555f82 | 31290 | |
8e04817f AC |
31291 | @item gdb-@value{GDBVN}/bfd |
31292 | source for the Binary File Descriptor library | |
c906108c | 31293 | |
8e04817f AC |
31294 | @item gdb-@value{GDBVN}/include |
31295 | @sc{gnu} include files | |
c906108c | 31296 | |
8e04817f AC |
31297 | @item gdb-@value{GDBVN}/libiberty |
31298 | source for the @samp{-liberty} free software library | |
c906108c | 31299 | |
8e04817f AC |
31300 | @item gdb-@value{GDBVN}/opcodes |
31301 | source for the library of opcode tables and disassemblers | |
c906108c | 31302 | |
8e04817f AC |
31303 | @item gdb-@value{GDBVN}/readline |
31304 | source for the @sc{gnu} command-line interface | |
c906108c | 31305 | |
8e04817f AC |
31306 | @item gdb-@value{GDBVN}/glob |
31307 | source for the @sc{gnu} filename pattern-matching subroutine | |
c906108c | 31308 | |
8e04817f AC |
31309 | @item gdb-@value{GDBVN}/mmalloc |
31310 | source for the @sc{gnu} memory-mapped malloc package | |
31311 | @end table | |
c906108c | 31312 | |
db2e3e2e | 31313 | The simplest way to configure and build @value{GDBN} is to run @file{configure} |
8e04817f AC |
31314 | from the @file{gdb-@var{version-number}} source directory, which in |
31315 | this example is the @file{gdb-@value{GDBVN}} directory. | |
c906108c | 31316 | |
8e04817f | 31317 | First switch to the @file{gdb-@var{version-number}} source directory |
db2e3e2e | 31318 | if you are not already in it; then run @file{configure}. Pass the |
8e04817f AC |
31319 | identifier for the platform on which @value{GDBN} will run as an |
31320 | argument. | |
c906108c | 31321 | |
8e04817f | 31322 | For example: |
c906108c | 31323 | |
474c8240 | 31324 | @smallexample |
8e04817f AC |
31325 | cd gdb-@value{GDBVN} |
31326 | ./configure @var{host} | |
31327 | make | |
474c8240 | 31328 | @end smallexample |
c906108c | 31329 | |
8e04817f AC |
31330 | @noindent |
31331 | where @var{host} is an identifier such as @samp{sun4} or | |
31332 | @samp{decstation}, that identifies the platform where @value{GDBN} will run. | |
db2e3e2e | 31333 | (You can often leave off @var{host}; @file{configure} tries to guess the |
8e04817f | 31334 | correct value by examining your system.) |
c906108c | 31335 | |
8e04817f AC |
31336 | Running @samp{configure @var{host}} and then running @code{make} builds the |
31337 | @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty} | |
31338 | libraries, then @code{gdb} itself. The configured source files, and the | |
31339 | binaries, are left in the corresponding source directories. | |
c906108c | 31340 | |
8e04817f | 31341 | @need 750 |
db2e3e2e | 31342 | @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your |
8e04817f AC |
31343 | system does not recognize this automatically when you run a different |
31344 | shell, you may need to run @code{sh} on it explicitly: | |
c906108c | 31345 | |
474c8240 | 31346 | @smallexample |
8e04817f | 31347 | sh configure @var{host} |
474c8240 | 31348 | @end smallexample |
c906108c | 31349 | |
db2e3e2e | 31350 | If you run @file{configure} from a directory that contains source |
8e04817f | 31351 | directories for multiple libraries or programs, such as the |
db2e3e2e BW |
31352 | @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN}, |
31353 | @file{configure} | |
8e04817f AC |
31354 | creates configuration files for every directory level underneath (unless |
31355 | you tell it not to, with the @samp{--norecursion} option). | |
31356 | ||
db2e3e2e | 31357 | You should run the @file{configure} script from the top directory in the |
94e91d6d | 31358 | source tree, the @file{gdb-@var{version-number}} directory. If you run |
db2e3e2e | 31359 | @file{configure} from one of the subdirectories, you will configure only |
94e91d6d | 31360 | that subdirectory. That is usually not what you want. In particular, |
db2e3e2e | 31361 | if you run the first @file{configure} from the @file{gdb} subdirectory |
94e91d6d MC |
31362 | of the @file{gdb-@var{version-number}} directory, you will omit the |
31363 | configuration of @file{bfd}, @file{readline}, and other sibling | |
31364 | directories of the @file{gdb} subdirectory. This leads to build errors | |
31365 | about missing include files such as @file{bfd/bfd.h}. | |
c906108c | 31366 | |
8e04817f AC |
31367 | You can install @code{@value{GDBP}} anywhere; it has no hardwired paths. |
31368 | However, you should make sure that the shell on your path (named by | |
31369 | the @samp{SHELL} environment variable) is publicly readable. Remember | |
31370 | that @value{GDBN} uses the shell to start your program---some systems refuse to | |
31371 | let @value{GDBN} debug child processes whose programs are not readable. | |
c906108c | 31372 | |
8e04817f | 31373 | @node Separate Objdir |
79a6e687 | 31374 | @section Compiling @value{GDBN} in Another Directory |
c906108c | 31375 | |
8e04817f AC |
31376 | If you want to run @value{GDBN} versions for several host or target machines, |
31377 | you need a different @code{gdb} compiled for each combination of | |
db2e3e2e | 31378 | host and target. @file{configure} is designed to make this easy by |
8e04817f AC |
31379 | allowing you to generate each configuration in a separate subdirectory, |
31380 | rather than in the source directory. If your @code{make} program | |
31381 | handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running | |
31382 | @code{make} in each of these directories builds the @code{gdb} | |
31383 | program specified there. | |
c906108c | 31384 | |
db2e3e2e | 31385 | To build @code{gdb} in a separate directory, run @file{configure} |
8e04817f | 31386 | with the @samp{--srcdir} option to specify where to find the source. |
db2e3e2e BW |
31387 | (You also need to specify a path to find @file{configure} |
31388 | itself from your working directory. If the path to @file{configure} | |
8e04817f AC |
31389 | would be the same as the argument to @samp{--srcdir}, you can leave out |
31390 | the @samp{--srcdir} option; it is assumed.) | |
c906108c | 31391 | |
8e04817f AC |
31392 | For example, with version @value{GDBVN}, you can build @value{GDBN} in a |
31393 | separate directory for a Sun 4 like this: | |
c906108c | 31394 | |
474c8240 | 31395 | @smallexample |
8e04817f AC |
31396 | @group |
31397 | cd gdb-@value{GDBVN} | |
31398 | mkdir ../gdb-sun4 | |
31399 | cd ../gdb-sun4 | |
31400 | ../gdb-@value{GDBVN}/configure sun4 | |
31401 | make | |
31402 | @end group | |
474c8240 | 31403 | @end smallexample |
c906108c | 31404 | |
db2e3e2e | 31405 | When @file{configure} builds a configuration using a remote source |
8e04817f AC |
31406 | directory, it creates a tree for the binaries with the same structure |
31407 | (and using the same names) as the tree under the source directory. In | |
31408 | the example, you'd find the Sun 4 library @file{libiberty.a} in the | |
31409 | directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in | |
31410 | @file{gdb-sun4/gdb}. | |
c906108c | 31411 | |
94e91d6d MC |
31412 | Make sure that your path to the @file{configure} script has just one |
31413 | instance of @file{gdb} in it. If your path to @file{configure} looks | |
31414 | like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only | |
31415 | one subdirectory of @value{GDBN}, not the whole package. This leads to | |
31416 | build errors about missing include files such as @file{bfd/bfd.h}. | |
31417 | ||
8e04817f AC |
31418 | One popular reason to build several @value{GDBN} configurations in separate |
31419 | directories is to configure @value{GDBN} for cross-compiling (where | |
31420 | @value{GDBN} runs on one machine---the @dfn{host}---while debugging | |
31421 | programs that run on another machine---the @dfn{target}). | |
31422 | You specify a cross-debugging target by | |
db2e3e2e | 31423 | giving the @samp{--target=@var{target}} option to @file{configure}. |
c906108c | 31424 | |
8e04817f AC |
31425 | When you run @code{make} to build a program or library, you must run |
31426 | it in a configured directory---whatever directory you were in when you | |
db2e3e2e | 31427 | called @file{configure} (or one of its subdirectories). |
c906108c | 31428 | |
db2e3e2e | 31429 | The @code{Makefile} that @file{configure} generates in each source |
8e04817f AC |
31430 | directory also runs recursively. If you type @code{make} in a source |
31431 | directory such as @file{gdb-@value{GDBVN}} (or in a separate configured | |
31432 | directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you | |
31433 | will build all the required libraries, and then build GDB. | |
c906108c | 31434 | |
8e04817f AC |
31435 | When you have multiple hosts or targets configured in separate |
31436 | directories, you can run @code{make} on them in parallel (for example, | |
31437 | if they are NFS-mounted on each of the hosts); they will not interfere | |
31438 | with each other. | |
c906108c | 31439 | |
8e04817f | 31440 | @node Config Names |
79a6e687 | 31441 | @section Specifying Names for Hosts and Targets |
c906108c | 31442 | |
db2e3e2e | 31443 | The specifications used for hosts and targets in the @file{configure} |
8e04817f AC |
31444 | script are based on a three-part naming scheme, but some short predefined |
31445 | aliases are also supported. The full naming scheme encodes three pieces | |
31446 | of information in the following pattern: | |
c906108c | 31447 | |
474c8240 | 31448 | @smallexample |
8e04817f | 31449 | @var{architecture}-@var{vendor}-@var{os} |
474c8240 | 31450 | @end smallexample |
c906108c | 31451 | |
8e04817f AC |
31452 | For example, you can use the alias @code{sun4} as a @var{host} argument, |
31453 | or as the value for @var{target} in a @code{--target=@var{target}} | |
31454 | option. The equivalent full name is @samp{sparc-sun-sunos4}. | |
c906108c | 31455 | |
db2e3e2e | 31456 | The @file{configure} script accompanying @value{GDBN} does not provide |
8e04817f | 31457 | any query facility to list all supported host and target names or |
db2e3e2e | 31458 | aliases. @file{configure} calls the Bourne shell script |
8e04817f AC |
31459 | @code{config.sub} to map abbreviations to full names; you can read the |
31460 | script, if you wish, or you can use it to test your guesses on | |
31461 | abbreviations---for example: | |
c906108c | 31462 | |
8e04817f AC |
31463 | @smallexample |
31464 | % sh config.sub i386-linux | |
31465 | i386-pc-linux-gnu | |
31466 | % sh config.sub alpha-linux | |
31467 | alpha-unknown-linux-gnu | |
31468 | % sh config.sub hp9k700 | |
31469 | hppa1.1-hp-hpux | |
31470 | % sh config.sub sun4 | |
31471 | sparc-sun-sunos4.1.1 | |
31472 | % sh config.sub sun3 | |
31473 | m68k-sun-sunos4.1.1 | |
31474 | % sh config.sub i986v | |
31475 | Invalid configuration `i986v': machine `i986v' not recognized | |
31476 | @end smallexample | |
c906108c | 31477 | |
8e04817f AC |
31478 | @noindent |
31479 | @code{config.sub} is also distributed in the @value{GDBN} source | |
31480 | directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}). | |
d700128c | 31481 | |
8e04817f | 31482 | @node Configure Options |
db2e3e2e | 31483 | @section @file{configure} Options |
c906108c | 31484 | |
db2e3e2e BW |
31485 | Here is a summary of the @file{configure} options and arguments that |
31486 | are most often useful for building @value{GDBN}. @file{configure} also has | |
8e04817f | 31487 | several other options not listed here. @inforef{What Configure |
db2e3e2e | 31488 | Does,,configure.info}, for a full explanation of @file{configure}. |
c906108c | 31489 | |
474c8240 | 31490 | @smallexample |
8e04817f AC |
31491 | configure @r{[}--help@r{]} |
31492 | @r{[}--prefix=@var{dir}@r{]} | |
31493 | @r{[}--exec-prefix=@var{dir}@r{]} | |
31494 | @r{[}--srcdir=@var{dirname}@r{]} | |
31495 | @r{[}--norecursion@r{]} @r{[}--rm@r{]} | |
31496 | @r{[}--target=@var{target}@r{]} | |
31497 | @var{host} | |
474c8240 | 31498 | @end smallexample |
c906108c | 31499 | |
8e04817f AC |
31500 | @noindent |
31501 | You may introduce options with a single @samp{-} rather than | |
31502 | @samp{--} if you prefer; but you may abbreviate option names if you use | |
31503 | @samp{--}. | |
c906108c | 31504 | |
8e04817f AC |
31505 | @table @code |
31506 | @item --help | |
db2e3e2e | 31507 | Display a quick summary of how to invoke @file{configure}. |
c906108c | 31508 | |
8e04817f AC |
31509 | @item --prefix=@var{dir} |
31510 | Configure the source to install programs and files under directory | |
31511 | @file{@var{dir}}. | |
c906108c | 31512 | |
8e04817f AC |
31513 | @item --exec-prefix=@var{dir} |
31514 | Configure the source to install programs under directory | |
31515 | @file{@var{dir}}. | |
c906108c | 31516 | |
8e04817f AC |
31517 | @c avoid splitting the warning from the explanation: |
31518 | @need 2000 | |
31519 | @item --srcdir=@var{dirname} | |
31520 | @strong{Warning: using this option requires @sc{gnu} @code{make}, or another | |
31521 | @code{make} that implements the @code{VPATH} feature.}@* | |
31522 | Use this option to make configurations in directories separate from the | |
31523 | @value{GDBN} source directories. Among other things, you can use this to | |
31524 | build (or maintain) several configurations simultaneously, in separate | |
db2e3e2e | 31525 | directories. @file{configure} writes configuration-specific files in |
8e04817f | 31526 | the current directory, but arranges for them to use the source in the |
db2e3e2e | 31527 | directory @var{dirname}. @file{configure} creates directories under |
8e04817f AC |
31528 | the working directory in parallel to the source directories below |
31529 | @var{dirname}. | |
c906108c | 31530 | |
8e04817f | 31531 | @item --norecursion |
db2e3e2e | 31532 | Configure only the directory level where @file{configure} is executed; do not |
8e04817f | 31533 | propagate configuration to subdirectories. |
c906108c | 31534 | |
8e04817f AC |
31535 | @item --target=@var{target} |
31536 | Configure @value{GDBN} for cross-debugging programs running on the specified | |
31537 | @var{target}. Without this option, @value{GDBN} is configured to debug | |
31538 | programs that run on the same machine (@var{host}) as @value{GDBN} itself. | |
c906108c | 31539 | |
8e04817f | 31540 | There is no convenient way to generate a list of all available targets. |
c906108c | 31541 | |
8e04817f AC |
31542 | @item @var{host} @dots{} |
31543 | Configure @value{GDBN} to run on the specified @var{host}. | |
c906108c | 31544 | |
8e04817f AC |
31545 | There is no convenient way to generate a list of all available hosts. |
31546 | @end table | |
c906108c | 31547 | |
8e04817f AC |
31548 | There are many other options available as well, but they are generally |
31549 | needed for special purposes only. | |
c906108c | 31550 | |
098b41a6 JG |
31551 | @node System-wide configuration |
31552 | @section System-wide configuration and settings | |
31553 | @cindex system-wide init file | |
31554 | ||
31555 | @value{GDBN} can be configured to have a system-wide init file; | |
31556 | this file will be read and executed at startup (@pxref{Startup, , What | |
31557 | @value{GDBN} does during startup}). | |
31558 | ||
31559 | Here is the corresponding configure option: | |
31560 | ||
31561 | @table @code | |
31562 | @item --with-system-gdbinit=@var{file} | |
31563 | Specify that the default location of the system-wide init file is | |
31564 | @var{file}. | |
31565 | @end table | |
31566 | ||
31567 | If @value{GDBN} has been configured with the option @option{--prefix=$prefix}, | |
31568 | it may be subject to relocation. Two possible cases: | |
31569 | ||
31570 | @itemize @bullet | |
31571 | @item | |
31572 | If the default location of this init file contains @file{$prefix}, | |
31573 | it will be subject to relocation. Suppose that the configure options | |
31574 | are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit}; | |
31575 | if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system | |
31576 | init file is looked for as @file{$install/etc/gdbinit} instead of | |
31577 | @file{$prefix/etc/gdbinit}. | |
31578 | ||
31579 | @item | |
31580 | By contrast, if the default location does not contain the prefix, | |
31581 | it will not be relocated. E.g.@: if @value{GDBN} has been configured with | |
31582 | @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit}, | |
31583 | then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit}, | |
31584 | wherever @value{GDBN} is installed. | |
31585 | @end itemize | |
31586 | ||
8e04817f AC |
31587 | @node Maintenance Commands |
31588 | @appendix Maintenance Commands | |
31589 | @cindex maintenance commands | |
31590 | @cindex internal commands | |
c906108c | 31591 | |
8e04817f | 31592 | In addition to commands intended for @value{GDBN} users, @value{GDBN} |
09d4efe1 EZ |
31593 | includes a number of commands intended for @value{GDBN} developers, |
31594 | that are not documented elsewhere in this manual. These commands are | |
da316a69 EZ |
31595 | provided here for reference. (For commands that turn on debugging |
31596 | messages, see @ref{Debugging Output}.) | |
c906108c | 31597 | |
8e04817f | 31598 | @table @code |
09d4efe1 | 31599 | @kindex maint agent |
782b2b07 | 31600 | @kindex maint agent-eval |
09d4efe1 | 31601 | @item maint agent @var{expression} |
782b2b07 | 31602 | @itemx maint agent-eval @var{expression} |
09d4efe1 EZ |
31603 | Translate the given @var{expression} into remote agent bytecodes. |
31604 | This command is useful for debugging the Agent Expression mechanism | |
782b2b07 SS |
31605 | (@pxref{Agent Expressions}). The @samp{agent} version produces an |
31606 | expression useful for data collection, such as by tracepoints, while | |
31607 | @samp{maint agent-eval} produces an expression that evaluates directly | |
31608 | to a result. For instance, a collection expression for @code{globa + | |
31609 | globb} will include bytecodes to record four bytes of memory at each | |
31610 | of the addresses of @code{globa} and @code{globb}, while discarding | |
31611 | the result of the addition, while an evaluation expression will do the | |
31612 | addition and return the sum. | |
09d4efe1 | 31613 | |
8e04817f AC |
31614 | @kindex maint info breakpoints |
31615 | @item @anchor{maint info breakpoints}maint info breakpoints | |
31616 | Using the same format as @samp{info breakpoints}, display both the | |
31617 | breakpoints you've set explicitly, and those @value{GDBN} is using for | |
31618 | internal purposes. Internal breakpoints are shown with negative | |
31619 | breakpoint numbers. The type column identifies what kind of breakpoint | |
31620 | is shown: | |
c906108c | 31621 | |
8e04817f AC |
31622 | @table @code |
31623 | @item breakpoint | |
31624 | Normal, explicitly set breakpoint. | |
c906108c | 31625 | |
8e04817f AC |
31626 | @item watchpoint |
31627 | Normal, explicitly set watchpoint. | |
c906108c | 31628 | |
8e04817f AC |
31629 | @item longjmp |
31630 | Internal breakpoint, used to handle correctly stepping through | |
31631 | @code{longjmp} calls. | |
c906108c | 31632 | |
8e04817f AC |
31633 | @item longjmp resume |
31634 | Internal breakpoint at the target of a @code{longjmp}. | |
c906108c | 31635 | |
8e04817f AC |
31636 | @item until |
31637 | Temporary internal breakpoint used by the @value{GDBN} @code{until} command. | |
c906108c | 31638 | |
8e04817f AC |
31639 | @item finish |
31640 | Temporary internal breakpoint used by the @value{GDBN} @code{finish} command. | |
c906108c | 31641 | |
8e04817f AC |
31642 | @item shlib events |
31643 | Shared library events. | |
c906108c | 31644 | |
8e04817f | 31645 | @end table |
c906108c | 31646 | |
fff08868 HZ |
31647 | @kindex set displaced-stepping |
31648 | @kindex show displaced-stepping | |
237fc4c9 PA |
31649 | @cindex displaced stepping support |
31650 | @cindex out-of-line single-stepping | |
fff08868 HZ |
31651 | @item set displaced-stepping |
31652 | @itemx show displaced-stepping | |
237fc4c9 | 31653 | Control whether or not @value{GDBN} will do @dfn{displaced stepping} |
fff08868 HZ |
31654 | if the target supports it. Displaced stepping is a way to single-step |
31655 | over breakpoints without removing them from the inferior, by executing | |
31656 | an out-of-line copy of the instruction that was originally at the | |
31657 | breakpoint location. It is also known as out-of-line single-stepping. | |
31658 | ||
31659 | @table @code | |
31660 | @item set displaced-stepping on | |
31661 | If the target architecture supports it, @value{GDBN} will use | |
31662 | displaced stepping to step over breakpoints. | |
31663 | ||
31664 | @item set displaced-stepping off | |
31665 | @value{GDBN} will not use displaced stepping to step over breakpoints, | |
31666 | even if such is supported by the target architecture. | |
31667 | ||
31668 | @cindex non-stop mode, and @samp{set displaced-stepping} | |
31669 | @item set displaced-stepping auto | |
31670 | This is the default mode. @value{GDBN} will use displaced stepping | |
31671 | only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target | |
31672 | architecture supports displaced stepping. | |
31673 | @end table | |
237fc4c9 | 31674 | |
09d4efe1 EZ |
31675 | @kindex maint check-symtabs |
31676 | @item maint check-symtabs | |
31677 | Check the consistency of psymtabs and symtabs. | |
31678 | ||
31679 | @kindex maint cplus first_component | |
31680 | @item maint cplus first_component @var{name} | |
31681 | Print the first C@t{++} class/namespace component of @var{name}. | |
31682 | ||
31683 | @kindex maint cplus namespace | |
31684 | @item maint cplus namespace | |
31685 | Print the list of possible C@t{++} namespaces. | |
31686 | ||
31687 | @kindex maint demangle | |
31688 | @item maint demangle @var{name} | |
d3e8051b | 31689 | Demangle a C@t{++} or Objective-C mangled @var{name}. |
09d4efe1 EZ |
31690 | |
31691 | @kindex maint deprecate | |
31692 | @kindex maint undeprecate | |
31693 | @cindex deprecated commands | |
31694 | @item maint deprecate @var{command} @r{[}@var{replacement}@r{]} | |
31695 | @itemx maint undeprecate @var{command} | |
31696 | Deprecate or undeprecate the named @var{command}. Deprecated commands | |
31697 | cause @value{GDBN} to issue a warning when you use them. The optional | |
31698 | argument @var{replacement} says which newer command should be used in | |
31699 | favor of the deprecated one; if it is given, @value{GDBN} will mention | |
31700 | the replacement as part of the warning. | |
31701 | ||
31702 | @kindex maint dump-me | |
31703 | @item maint dump-me | |
721c2651 | 31704 | @cindex @code{SIGQUIT} signal, dump core of @value{GDBN} |
09d4efe1 | 31705 | Cause a fatal signal in the debugger and force it to dump its core. |
721c2651 EZ |
31706 | This is supported only on systems which support aborting a program |
31707 | with the @code{SIGQUIT} signal. | |
09d4efe1 | 31708 | |
8d30a00d AC |
31709 | @kindex maint internal-error |
31710 | @kindex maint internal-warning | |
09d4efe1 EZ |
31711 | @item maint internal-error @r{[}@var{message-text}@r{]} |
31712 | @itemx maint internal-warning @r{[}@var{message-text}@r{]} | |
8d30a00d AC |
31713 | Cause @value{GDBN} to call the internal function @code{internal_error} |
31714 | or @code{internal_warning} and hence behave as though an internal error | |
31715 | or internal warning has been detected. In addition to reporting the | |
31716 | internal problem, these functions give the user the opportunity to | |
31717 | either quit @value{GDBN} or create a core file of the current | |
31718 | @value{GDBN} session. | |
31719 | ||
09d4efe1 EZ |
31720 | These commands take an optional parameter @var{message-text} that is |
31721 | used as the text of the error or warning message. | |
31722 | ||
d3e8051b | 31723 | Here's an example of using @code{internal-error}: |
09d4efe1 | 31724 | |
8d30a00d | 31725 | @smallexample |
f7dc1244 | 31726 | (@value{GDBP}) @kbd{maint internal-error testing, 1, 2} |
8d30a00d AC |
31727 | @dots{}/maint.c:121: internal-error: testing, 1, 2 |
31728 | A problem internal to GDB has been detected. Further | |
31729 | debugging may prove unreliable. | |
31730 | Quit this debugging session? (y or n) @kbd{n} | |
31731 | Create a core file? (y or n) @kbd{n} | |
f7dc1244 | 31732 | (@value{GDBP}) |
8d30a00d AC |
31733 | @end smallexample |
31734 | ||
3c16cced PA |
31735 | @cindex @value{GDBN} internal error |
31736 | @cindex internal errors, control of @value{GDBN} behavior | |
31737 | ||
31738 | @kindex maint set internal-error | |
31739 | @kindex maint show internal-error | |
31740 | @kindex maint set internal-warning | |
31741 | @kindex maint show internal-warning | |
31742 | @item maint set internal-error @var{action} [ask|yes|no] | |
31743 | @itemx maint show internal-error @var{action} | |
31744 | @itemx maint set internal-warning @var{action} [ask|yes|no] | |
31745 | @itemx maint show internal-warning @var{action} | |
31746 | When @value{GDBN} reports an internal problem (error or warning) it | |
31747 | gives the user the opportunity to both quit @value{GDBN} and create a | |
31748 | core file of the current @value{GDBN} session. These commands let you | |
31749 | override the default behaviour for each particular @var{action}, | |
31750 | described in the table below. | |
31751 | ||
31752 | @table @samp | |
31753 | @item quit | |
31754 | You can specify that @value{GDBN} should always (yes) or never (no) | |
31755 | quit. The default is to ask the user what to do. | |
31756 | ||
31757 | @item corefile | |
31758 | You can specify that @value{GDBN} should always (yes) or never (no) | |
31759 | create a core file. The default is to ask the user what to do. | |
31760 | @end table | |
31761 | ||
09d4efe1 EZ |
31762 | @kindex maint packet |
31763 | @item maint packet @var{text} | |
31764 | If @value{GDBN} is talking to an inferior via the serial protocol, | |
31765 | then this command sends the string @var{text} to the inferior, and | |
31766 | displays the response packet. @value{GDBN} supplies the initial | |
31767 | @samp{$} character, the terminating @samp{#} character, and the | |
31768 | checksum. | |
31769 | ||
31770 | @kindex maint print architecture | |
31771 | @item maint print architecture @r{[}@var{file}@r{]} | |
31772 | Print the entire architecture configuration. The optional argument | |
31773 | @var{file} names the file where the output goes. | |
8d30a00d | 31774 | |
81adfced DJ |
31775 | @kindex maint print c-tdesc |
31776 | @item maint print c-tdesc | |
31777 | Print the current target description (@pxref{Target Descriptions}) as | |
31778 | a C source file. The created source file can be used in @value{GDBN} | |
31779 | when an XML parser is not available to parse the description. | |
31780 | ||
00905d52 AC |
31781 | @kindex maint print dummy-frames |
31782 | @item maint print dummy-frames | |
00905d52 AC |
31783 | Prints the contents of @value{GDBN}'s internal dummy-frame stack. |
31784 | ||
31785 | @smallexample | |
f7dc1244 | 31786 | (@value{GDBP}) @kbd{b add} |
00905d52 | 31787 | @dots{} |
f7dc1244 | 31788 | (@value{GDBP}) @kbd{print add(2,3)} |
00905d52 AC |
31789 | Breakpoint 2, add (a=2, b=3) at @dots{} |
31790 | 58 return (a + b); | |
31791 | The program being debugged stopped while in a function called from GDB. | |
31792 | @dots{} | |
f7dc1244 | 31793 | (@value{GDBP}) @kbd{maint print dummy-frames} |
00905d52 AC |
31794 | 0x1a57c80: pc=0x01014068 fp=0x0200bddc sp=0x0200bdd6 |
31795 | top=0x0200bdd4 id=@{stack=0x200bddc,code=0x101405c@} | |
31796 | call_lo=0x01014000 call_hi=0x01014001 | |
f7dc1244 | 31797 | (@value{GDBP}) |
00905d52 AC |
31798 | @end smallexample |
31799 | ||
31800 | Takes an optional file parameter. | |
31801 | ||
0680b120 AC |
31802 | @kindex maint print registers |
31803 | @kindex maint print raw-registers | |
31804 | @kindex maint print cooked-registers | |
617073a9 | 31805 | @kindex maint print register-groups |
c21236dc | 31806 | @kindex maint print remote-registers |
09d4efe1 EZ |
31807 | @item maint print registers @r{[}@var{file}@r{]} |
31808 | @itemx maint print raw-registers @r{[}@var{file}@r{]} | |
31809 | @itemx maint print cooked-registers @r{[}@var{file}@r{]} | |
31810 | @itemx maint print register-groups @r{[}@var{file}@r{]} | |
c21236dc | 31811 | @itemx maint print remote-registers @r{[}@var{file}@r{]} |
0680b120 AC |
31812 | Print @value{GDBN}'s internal register data structures. |
31813 | ||
617073a9 | 31814 | The command @code{maint print raw-registers} includes the contents of |
c21236dc PA |
31815 | the raw register cache; the command @code{maint print |
31816 | cooked-registers} includes the (cooked) value of all registers, | |
31817 | including registers which aren't available on the target nor visible | |
31818 | to user; the command @code{maint print register-groups} includes the | |
31819 | groups that each register is a member of; and the command @code{maint | |
31820 | print remote-registers} includes the remote target's register numbers | |
31821 | and offsets in the `G' packets. @xref{Registers,, Registers, gdbint, | |
617073a9 | 31822 | @value{GDBN} Internals}. |
0680b120 | 31823 | |
09d4efe1 EZ |
31824 | These commands take an optional parameter, a file name to which to |
31825 | write the information. | |
0680b120 | 31826 | |
617073a9 | 31827 | @kindex maint print reggroups |
09d4efe1 EZ |
31828 | @item maint print reggroups @r{[}@var{file}@r{]} |
31829 | Print @value{GDBN}'s internal register group data structures. The | |
31830 | optional argument @var{file} tells to what file to write the | |
31831 | information. | |
617073a9 | 31832 | |
09d4efe1 | 31833 | The register groups info looks like this: |
617073a9 AC |
31834 | |
31835 | @smallexample | |
f7dc1244 | 31836 | (@value{GDBP}) @kbd{maint print reggroups} |
b383017d RM |
31837 | Group Type |
31838 | general user | |
31839 | float user | |
31840 | all user | |
31841 | vector user | |
31842 | system user | |
31843 | save internal | |
31844 | restore internal | |
617073a9 AC |
31845 | @end smallexample |
31846 | ||
09d4efe1 EZ |
31847 | @kindex flushregs |
31848 | @item flushregs | |
31849 | This command forces @value{GDBN} to flush its internal register cache. | |
31850 | ||
31851 | @kindex maint print objfiles | |
31852 | @cindex info for known object files | |
31853 | @item maint print objfiles | |
31854 | Print a dump of all known object files. For each object file, this | |
31855 | command prints its name, address in memory, and all of its psymtabs | |
31856 | and symtabs. | |
31857 | ||
8a1ea21f DE |
31858 | @kindex maint print section-scripts |
31859 | @cindex info for known .debug_gdb_scripts-loaded scripts | |
31860 | @item maint print section-scripts [@var{regexp}] | |
31861 | Print a dump of scripts specified in the @code{.debug_gdb_section} section. | |
31862 | If @var{regexp} is specified, only print scripts loaded by object files | |
31863 | matching @var{regexp}. | |
31864 | For each script, this command prints its name as specified in the objfile, | |
31865 | and the full path if known. | |
31866 | @xref{.debug_gdb_scripts section}. | |
31867 | ||
09d4efe1 EZ |
31868 | @kindex maint print statistics |
31869 | @cindex bcache statistics | |
31870 | @item maint print statistics | |
31871 | This command prints, for each object file in the program, various data | |
31872 | about that object file followed by the byte cache (@dfn{bcache}) | |
31873 | statistics for the object file. The objfile data includes the number | |
d3e8051b | 31874 | of minimal, partial, full, and stabs symbols, the number of types |
09d4efe1 EZ |
31875 | defined by the objfile, the number of as yet unexpanded psym tables, |
31876 | the number of line tables and string tables, and the amount of memory | |
31877 | used by the various tables. The bcache statistics include the counts, | |
31878 | sizes, and counts of duplicates of all and unique objects, max, | |
31879 | average, and median entry size, total memory used and its overhead and | |
31880 | savings, and various measures of the hash table size and chain | |
31881 | lengths. | |
31882 | ||
c7ba131e JB |
31883 | @kindex maint print target-stack |
31884 | @cindex target stack description | |
31885 | @item maint print target-stack | |
31886 | A @dfn{target} is an interface between the debugger and a particular | |
31887 | kind of file or process. Targets can be stacked in @dfn{strata}, | |
31888 | so that more than one target can potentially respond to a request. | |
31889 | In particular, memory accesses will walk down the stack of targets | |
31890 | until they find a target that is interested in handling that particular | |
31891 | address. | |
31892 | ||
31893 | This command prints a short description of each layer that was pushed on | |
31894 | the @dfn{target stack}, starting from the top layer down to the bottom one. | |
31895 | ||
09d4efe1 EZ |
31896 | @kindex maint print type |
31897 | @cindex type chain of a data type | |
31898 | @item maint print type @var{expr} | |
31899 | Print the type chain for a type specified by @var{expr}. The argument | |
31900 | can be either a type name or a symbol. If it is a symbol, the type of | |
31901 | that symbol is described. The type chain produced by this command is | |
31902 | a recursive definition of the data type as stored in @value{GDBN}'s | |
31903 | data structures, including its flags and contained types. | |
31904 | ||
9eae7c52 TT |
31905 | @kindex maint set dwarf2 always-disassemble |
31906 | @kindex maint show dwarf2 always-disassemble | |
31907 | @item maint set dwarf2 always-disassemble | |
31908 | @item maint show dwarf2 always-disassemble | |
31909 | Control the behavior of @code{info address} when using DWARF debugging | |
31910 | information. | |
31911 | ||
31912 | The default is @code{off}, which means that @value{GDBN} should try to | |
31913 | describe a variable's location in an easily readable format. When | |
31914 | @code{on}, @value{GDBN} will instead display the DWARF location | |
31915 | expression in an assembly-like format. Note that some locations are | |
31916 | too complex for @value{GDBN} to describe simply; in this case you will | |
31917 | always see the disassembly form. | |
31918 | ||
31919 | Here is an example of the resulting disassembly: | |
31920 | ||
31921 | @smallexample | |
31922 | (gdb) info addr argc | |
31923 | Symbol "argc" is a complex DWARF expression: | |
31924 | 1: DW_OP_fbreg 0 | |
31925 | @end smallexample | |
31926 | ||
31927 | For more information on these expressions, see | |
31928 | @uref{http://www.dwarfstd.org/, the DWARF standard}. | |
31929 | ||
09d4efe1 EZ |
31930 | @kindex maint set dwarf2 max-cache-age |
31931 | @kindex maint show dwarf2 max-cache-age | |
31932 | @item maint set dwarf2 max-cache-age | |
31933 | @itemx maint show dwarf2 max-cache-age | |
31934 | Control the DWARF 2 compilation unit cache. | |
31935 | ||
31936 | @cindex DWARF 2 compilation units cache | |
31937 | In object files with inter-compilation-unit references, such as those | |
31938 | produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF 2 | |
31939 | reader needs to frequently refer to previously read compilation units. | |
31940 | This setting controls how long a compilation unit will remain in the | |
31941 | cache if it is not referenced. A higher limit means that cached | |
31942 | compilation units will be stored in memory longer, and more total | |
31943 | memory will be used. Setting it to zero disables caching, which will | |
31944 | slow down @value{GDBN} startup, but reduce memory consumption. | |
31945 | ||
e7ba9c65 DJ |
31946 | @kindex maint set profile |
31947 | @kindex maint show profile | |
31948 | @cindex profiling GDB | |
31949 | @item maint set profile | |
31950 | @itemx maint show profile | |
31951 | Control profiling of @value{GDBN}. | |
31952 | ||
31953 | Profiling will be disabled until you use the @samp{maint set profile} | |
31954 | command to enable it. When you enable profiling, the system will begin | |
31955 | collecting timing and execution count data; when you disable profiling or | |
31956 | exit @value{GDBN}, the results will be written to a log file. Remember that | |
31957 | if you use profiling, @value{GDBN} will overwrite the profiling log file | |
31958 | (often called @file{gmon.out}). If you have a record of important profiling | |
31959 | data in a @file{gmon.out} file, be sure to move it to a safe location. | |
31960 | ||
31961 | Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be | |
b383017d | 31962 | compiled with the @samp{-pg} compiler option. |
e7ba9c65 | 31963 | |
cbe54154 PA |
31964 | @kindex maint set show-debug-regs |
31965 | @kindex maint show show-debug-regs | |
eac35c4e | 31966 | @cindex hardware debug registers |
cbe54154 PA |
31967 | @item maint set show-debug-regs |
31968 | @itemx maint show show-debug-regs | |
eac35c4e | 31969 | Control whether to show variables that mirror the hardware debug |
09d4efe1 | 31970 | registers. Use @code{ON} to enable, @code{OFF} to disable. If |
3f94c067 | 31971 | enabled, the debug registers values are shown when @value{GDBN} inserts or |
09d4efe1 EZ |
31972 | removes a hardware breakpoint or watchpoint, and when the inferior |
31973 | triggers a hardware-assisted breakpoint or watchpoint. | |
31974 | ||
711e434b PM |
31975 | @kindex maint set show-all-tib |
31976 | @kindex maint show show-all-tib | |
31977 | @item maint set show-all-tib | |
31978 | @itemx maint show show-all-tib | |
31979 | Control whether to show all non zero areas within a 1k block starting | |
31980 | at thread local base, when using the @samp{info w32 thread-information-block} | |
31981 | command. | |
31982 | ||
09d4efe1 EZ |
31983 | @kindex maint space |
31984 | @cindex memory used by commands | |
31985 | @item maint space | |
31986 | Control whether to display memory usage for each command. If set to a | |
31987 | nonzero value, @value{GDBN} will display how much memory each command | |
31988 | took, following the command's own output. This can also be requested | |
31989 | by invoking @value{GDBN} with the @option{--statistics} command-line | |
31990 | switch (@pxref{Mode Options}). | |
31991 | ||
31992 | @kindex maint time | |
31993 | @cindex time of command execution | |
31994 | @item maint time | |
31995 | Control whether to display the execution time for each command. If | |
31996 | set to a nonzero value, @value{GDBN} will display how much time it | |
31997 | took to execute each command, following the command's own output. | |
e2b7ddea VP |
31998 | The time is not printed for the commands that run the target, since |
31999 | there's no mechanism currently to compute how much time was spend | |
32000 | by @value{GDBN} and how much time was spend by the program been debugged. | |
32001 | it's not possibly currently | |
09d4efe1 EZ |
32002 | This can also be requested by invoking @value{GDBN} with the |
32003 | @option{--statistics} command-line switch (@pxref{Mode Options}). | |
32004 | ||
32005 | @kindex maint translate-address | |
32006 | @item maint translate-address @r{[}@var{section}@r{]} @var{addr} | |
32007 | Find the symbol stored at the location specified by the address | |
32008 | @var{addr} and an optional section name @var{section}. If found, | |
32009 | @value{GDBN} prints the name of the closest symbol and an offset from | |
32010 | the symbol's location to the specified address. This is similar to | |
32011 | the @code{info address} command (@pxref{Symbols}), except that this | |
32012 | command also allows to find symbols in other sections. | |
ae038cb0 | 32013 | |
c14c28ba PP |
32014 | If section was not specified, the section in which the symbol was found |
32015 | is also printed. For dynamically linked executables, the name of | |
32016 | executable or shared library containing the symbol is printed as well. | |
32017 | ||
8e04817f | 32018 | @end table |
c906108c | 32019 | |
9c16f35a EZ |
32020 | The following command is useful for non-interactive invocations of |
32021 | @value{GDBN}, such as in the test suite. | |
32022 | ||
32023 | @table @code | |
32024 | @item set watchdog @var{nsec} | |
32025 | @kindex set watchdog | |
32026 | @cindex watchdog timer | |
32027 | @cindex timeout for commands | |
32028 | Set the maximum number of seconds @value{GDBN} will wait for the | |
32029 | target operation to finish. If this time expires, @value{GDBN} | |
32030 | reports and error and the command is aborted. | |
32031 | ||
32032 | @item show watchdog | |
32033 | Show the current setting of the target wait timeout. | |
32034 | @end table | |
c906108c | 32035 | |
e0ce93ac | 32036 | @node Remote Protocol |
8e04817f | 32037 | @appendix @value{GDBN} Remote Serial Protocol |
c906108c | 32038 | |
ee2d5c50 AC |
32039 | @menu |
32040 | * Overview:: | |
32041 | * Packets:: | |
32042 | * Stop Reply Packets:: | |
32043 | * General Query Packets:: | |
a1dcb23a | 32044 | * Architecture-Specific Protocol Details:: |
9d29849a | 32045 | * Tracepoint Packets:: |
a6b151f1 | 32046 | * Host I/O Packets:: |
9a6253be | 32047 | * Interrupts:: |
8b23ecc4 SL |
32048 | * Notification Packets:: |
32049 | * Remote Non-Stop:: | |
a6f3e723 | 32050 | * Packet Acknowledgment:: |
ee2d5c50 | 32051 | * Examples:: |
79a6e687 | 32052 | * File-I/O Remote Protocol Extension:: |
cfa9d6d9 | 32053 | * Library List Format:: |
79a6e687 | 32054 | * Memory Map Format:: |
dc146f7c | 32055 | * Thread List Format:: |
b3b9301e | 32056 | * Traceframe Info Format:: |
ee2d5c50 AC |
32057 | @end menu |
32058 | ||
32059 | @node Overview | |
32060 | @section Overview | |
32061 | ||
8e04817f AC |
32062 | There may be occasions when you need to know something about the |
32063 | protocol---for example, if there is only one serial port to your target | |
32064 | machine, you might want your program to do something special if it | |
32065 | recognizes a packet meant for @value{GDBN}. | |
c906108c | 32066 | |
d2c6833e | 32067 | In the examples below, @samp{->} and @samp{<-} are used to indicate |
bf06d120 | 32068 | transmitted and received data, respectively. |
c906108c | 32069 | |
8e04817f AC |
32070 | @cindex protocol, @value{GDBN} remote serial |
32071 | @cindex serial protocol, @value{GDBN} remote | |
32072 | @cindex remote serial protocol | |
8b23ecc4 SL |
32073 | All @value{GDBN} commands and responses (other than acknowledgments |
32074 | and notifications, see @ref{Notification Packets}) are sent as a | |
32075 | @var{packet}. A @var{packet} is introduced with the character | |
8e04817f AC |
32076 | @samp{$}, the actual @var{packet-data}, and the terminating character |
32077 | @samp{#} followed by a two-digit @var{checksum}: | |
c906108c | 32078 | |
474c8240 | 32079 | @smallexample |
8e04817f | 32080 | @code{$}@var{packet-data}@code{#}@var{checksum} |
474c8240 | 32081 | @end smallexample |
8e04817f | 32082 | @noindent |
c906108c | 32083 | |
8e04817f AC |
32084 | @cindex checksum, for @value{GDBN} remote |
32085 | @noindent | |
32086 | The two-digit @var{checksum} is computed as the modulo 256 sum of all | |
32087 | characters between the leading @samp{$} and the trailing @samp{#} (an | |
32088 | eight bit unsigned checksum). | |
c906108c | 32089 | |
8e04817f AC |
32090 | Implementors should note that prior to @value{GDBN} 5.0 the protocol |
32091 | specification also included an optional two-digit @var{sequence-id}: | |
c906108c | 32092 | |
474c8240 | 32093 | @smallexample |
8e04817f | 32094 | @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum} |
474c8240 | 32095 | @end smallexample |
c906108c | 32096 | |
8e04817f AC |
32097 | @cindex sequence-id, for @value{GDBN} remote |
32098 | @noindent | |
32099 | That @var{sequence-id} was appended to the acknowledgment. @value{GDBN} | |
32100 | has never output @var{sequence-id}s. Stubs that handle packets added | |
32101 | since @value{GDBN} 5.0 must not accept @var{sequence-id}. | |
c906108c | 32102 | |
8e04817f AC |
32103 | When either the host or the target machine receives a packet, the first |
32104 | response expected is an acknowledgment: either @samp{+} (to indicate | |
32105 | the package was received correctly) or @samp{-} (to request | |
32106 | retransmission): | |
c906108c | 32107 | |
474c8240 | 32108 | @smallexample |
d2c6833e AC |
32109 | -> @code{$}@var{packet-data}@code{#}@var{checksum} |
32110 | <- @code{+} | |
474c8240 | 32111 | @end smallexample |
8e04817f | 32112 | @noindent |
53a5351d | 32113 | |
a6f3e723 SL |
32114 | The @samp{+}/@samp{-} acknowledgments can be disabled |
32115 | once a connection is established. | |
32116 | @xref{Packet Acknowledgment}, for details. | |
32117 | ||
8e04817f AC |
32118 | The host (@value{GDBN}) sends @var{command}s, and the target (the |
32119 | debugging stub incorporated in your program) sends a @var{response}. In | |
32120 | the case of step and continue @var{command}s, the response is only sent | |
8b23ecc4 SL |
32121 | when the operation has completed, and the target has again stopped all |
32122 | threads in all attached processes. This is the default all-stop mode | |
32123 | behavior, but the remote protocol also supports @value{GDBN}'s non-stop | |
32124 | execution mode; see @ref{Remote Non-Stop}, for details. | |
c906108c | 32125 | |
8e04817f AC |
32126 | @var{packet-data} consists of a sequence of characters with the |
32127 | exception of @samp{#} and @samp{$} (see @samp{X} packet for additional | |
32128 | exceptions). | |
c906108c | 32129 | |
ee2d5c50 | 32130 | @cindex remote protocol, field separator |
0876f84a | 32131 | Fields within the packet should be separated using @samp{,} @samp{;} or |
8e04817f | 32132 | @samp{:}. Except where otherwise noted all numbers are represented in |
ee2d5c50 | 32133 | @sc{hex} with leading zeros suppressed. |
c906108c | 32134 | |
8e04817f AC |
32135 | Implementors should note that prior to @value{GDBN} 5.0, the character |
32136 | @samp{:} could not appear as the third character in a packet (as it | |
32137 | would potentially conflict with the @var{sequence-id}). | |
c906108c | 32138 | |
0876f84a DJ |
32139 | @cindex remote protocol, binary data |
32140 | @anchor{Binary Data} | |
32141 | Binary data in most packets is encoded either as two hexadecimal | |
32142 | digits per byte of binary data. This allowed the traditional remote | |
32143 | protocol to work over connections which were only seven-bit clean. | |
32144 | Some packets designed more recently assume an eight-bit clean | |
32145 | connection, and use a more efficient encoding to send and receive | |
32146 | binary data. | |
32147 | ||
32148 | The binary data representation uses @code{7d} (@sc{ascii} @samp{@}}) | |
32149 | as an escape character. Any escaped byte is transmitted as the escape | |
32150 | character followed by the original character XORed with @code{0x20}. | |
32151 | For example, the byte @code{0x7d} would be transmitted as the two | |
32152 | bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}), | |
32153 | @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii} | |
32154 | @samp{@}}) must always be escaped. Responses sent by the stub | |
32155 | must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it | |
32156 | is not interpreted as the start of a run-length encoded sequence | |
32157 | (described next). | |
32158 | ||
1d3811f6 DJ |
32159 | Response @var{data} can be run-length encoded to save space. |
32160 | Run-length encoding replaces runs of identical characters with one | |
32161 | instance of the repeated character, followed by a @samp{*} and a | |
32162 | repeat count. The repeat count is itself sent encoded, to avoid | |
32163 | binary characters in @var{data}: a value of @var{n} is sent as | |
32164 | @code{@var{n}+29}. For a repeat count greater or equal to 3, this | |
32165 | produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii} | |
32166 | code 32) for a repeat count of 3. (This is because run-length | |
32167 | encoding starts to win for counts 3 or more.) Thus, for example, | |
32168 | @samp{0* } is a run-length encoding of ``0000'': the space character | |
32169 | after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 = | |
32170 | 3}} more times. | |
32171 | ||
32172 | The printable characters @samp{#} and @samp{$} or with a numeric value | |
32173 | greater than 126 must not be used. Runs of six repeats (@samp{#}) or | |
32174 | seven repeats (@samp{$}) can be expanded using a repeat count of only | |
32175 | five (@samp{"}). For example, @samp{00000000} can be encoded as | |
32176 | @samp{0*"00}. | |
c906108c | 32177 | |
8e04817f AC |
32178 | The error response returned for some packets includes a two character |
32179 | error number. That number is not well defined. | |
c906108c | 32180 | |
f8da2bff | 32181 | @cindex empty response, for unsupported packets |
8e04817f AC |
32182 | For any @var{command} not supported by the stub, an empty response |
32183 | (@samp{$#00}) should be returned. That way it is possible to extend the | |
32184 | protocol. A newer @value{GDBN} can tell if a packet is supported based | |
32185 | on that response. | |
c906108c | 32186 | |
b383017d RM |
32187 | A stub is required to support the @samp{g}, @samp{G}, @samp{m}, @samp{M}, |
32188 | @samp{c}, and @samp{s} @var{command}s. All other @var{command}s are | |
8e04817f | 32189 | optional. |
c906108c | 32190 | |
ee2d5c50 AC |
32191 | @node Packets |
32192 | @section Packets | |
32193 | ||
32194 | The following table provides a complete list of all currently defined | |
32195 | @var{command}s and their corresponding response @var{data}. | |
79a6e687 | 32196 | @xref{File-I/O Remote Protocol Extension}, for details about the File |
9c16f35a | 32197 | I/O extension of the remote protocol. |
ee2d5c50 | 32198 | |
b8ff78ce JB |
32199 | Each packet's description has a template showing the packet's overall |
32200 | syntax, followed by an explanation of the packet's meaning. We | |
32201 | include spaces in some of the templates for clarity; these are not | |
32202 | part of the packet's syntax. No @value{GDBN} packet uses spaces to | |
32203 | separate its components. For example, a template like @samp{foo | |
32204 | @var{bar} @var{baz}} describes a packet beginning with the three ASCII | |
32205 | bytes @samp{foo}, followed by a @var{bar}, followed directly by a | |
3f94c067 | 32206 | @var{baz}. @value{GDBN} does not transmit a space character between the |
b8ff78ce JB |
32207 | @samp{foo} and the @var{bar}, or between the @var{bar} and the |
32208 | @var{baz}. | |
32209 | ||
b90a069a SL |
32210 | @cindex @var{thread-id}, in remote protocol |
32211 | @anchor{thread-id syntax} | |
32212 | Several packets and replies include a @var{thread-id} field to identify | |
32213 | a thread. Normally these are positive numbers with a target-specific | |
32214 | interpretation, formatted as big-endian hex strings. A @var{thread-id} | |
32215 | can also be a literal @samp{-1} to indicate all threads, or @samp{0} to | |
32216 | pick any thread. | |
32217 | ||
32218 | In addition, the remote protocol supports a multiprocess feature in | |
32219 | which the @var{thread-id} syntax is extended to optionally include both | |
32220 | process and thread ID fields, as @samp{p@var{pid}.@var{tid}}. | |
32221 | The @var{pid} (process) and @var{tid} (thread) components each have the | |
32222 | format described above: a positive number with target-specific | |
32223 | interpretation formatted as a big-endian hex string, literal @samp{-1} | |
32224 | to indicate all processes or threads (respectively), or @samp{0} to | |
32225 | indicate an arbitrary process or thread. Specifying just a process, as | |
32226 | @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}. It is an | |
32227 | error to specify all processes but a specific thread, such as | |
32228 | @samp{p-1.@var{tid}}. Note that the @samp{p} prefix is @emph{not} used | |
32229 | for those packets and replies explicitly documented to include a process | |
32230 | ID, rather than a @var{thread-id}. | |
32231 | ||
32232 | The multiprocess @var{thread-id} syntax extensions are only used if both | |
32233 | @value{GDBN} and the stub report support for the @samp{multiprocess} | |
32234 | feature using @samp{qSupported}. @xref{multiprocess extensions}, for | |
32235 | more information. | |
32236 | ||
8ffe2530 JB |
32237 | Note that all packet forms beginning with an upper- or lower-case |
32238 | letter, other than those described here, are reserved for future use. | |
32239 | ||
b8ff78ce | 32240 | Here are the packet descriptions. |
ee2d5c50 | 32241 | |
b8ff78ce | 32242 | @table @samp |
ee2d5c50 | 32243 | |
b8ff78ce JB |
32244 | @item ! |
32245 | @cindex @samp{!} packet | |
2d717e4f | 32246 | @anchor{extended mode} |
8e04817f AC |
32247 | Enable extended mode. In extended mode, the remote server is made |
32248 | persistent. The @samp{R} packet is used to restart the program being | |
32249 | debugged. | |
ee2d5c50 AC |
32250 | |
32251 | Reply: | |
32252 | @table @samp | |
32253 | @item OK | |
8e04817f | 32254 | The remote target both supports and has enabled extended mode. |
ee2d5c50 | 32255 | @end table |
c906108c | 32256 | |
b8ff78ce JB |
32257 | @item ? |
32258 | @cindex @samp{?} packet | |
ee2d5c50 | 32259 | Indicate the reason the target halted. The reply is the same as for |
8b23ecc4 SL |
32260 | step and continue. This packet has a special interpretation when the |
32261 | target is in non-stop mode; see @ref{Remote Non-Stop}. | |
c906108c | 32262 | |
ee2d5c50 AC |
32263 | Reply: |
32264 | @xref{Stop Reply Packets}, for the reply specifications. | |
32265 | ||
b8ff78ce JB |
32266 | @item A @var{arglen},@var{argnum},@var{arg},@dots{} |
32267 | @cindex @samp{A} packet | |
32268 | Initialized @code{argv[]} array passed into program. @var{arglen} | |
32269 | specifies the number of bytes in the hex encoded byte stream | |
32270 | @var{arg}. See @code{gdbserver} for more details. | |
ee2d5c50 AC |
32271 | |
32272 | Reply: | |
32273 | @table @samp | |
32274 | @item OK | |
b8ff78ce JB |
32275 | The arguments were set. |
32276 | @item E @var{NN} | |
32277 | An error occurred. | |
ee2d5c50 AC |
32278 | @end table |
32279 | ||
b8ff78ce JB |
32280 | @item b @var{baud} |
32281 | @cindex @samp{b} packet | |
32282 | (Don't use this packet; its behavior is not well-defined.) | |
ee2d5c50 AC |
32283 | Change the serial line speed to @var{baud}. |
32284 | ||
32285 | JTC: @emph{When does the transport layer state change? When it's | |
32286 | received, or after the ACK is transmitted. In either case, there are | |
32287 | problems if the command or the acknowledgment packet is dropped.} | |
32288 | ||
32289 | Stan: @emph{If people really wanted to add something like this, and get | |
32290 | it working for the first time, they ought to modify ser-unix.c to send | |
32291 | some kind of out-of-band message to a specially-setup stub and have the | |
32292 | switch happen "in between" packets, so that from remote protocol's point | |
32293 | of view, nothing actually happened.} | |
32294 | ||
b8ff78ce JB |
32295 | @item B @var{addr},@var{mode} |
32296 | @cindex @samp{B} packet | |
8e04817f | 32297 | Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a |
2f870471 AC |
32298 | breakpoint at @var{addr}. |
32299 | ||
b8ff78ce | 32300 | Don't use this packet. Use the @samp{Z} and @samp{z} packets instead |
2f870471 | 32301 | (@pxref{insert breakpoint or watchpoint packet}). |
c906108c | 32302 | |
bacec72f | 32303 | @cindex @samp{bc} packet |
0d772ac9 MS |
32304 | @anchor{bc} |
32305 | @item bc | |
bacec72f MS |
32306 | Backward continue. Execute the target system in reverse. No parameter. |
32307 | @xref{Reverse Execution}, for more information. | |
32308 | ||
32309 | Reply: | |
32310 | @xref{Stop Reply Packets}, for the reply specifications. | |
32311 | ||
bacec72f | 32312 | @cindex @samp{bs} packet |
0d772ac9 MS |
32313 | @anchor{bs} |
32314 | @item bs | |
bacec72f MS |
32315 | Backward single step. Execute one instruction in reverse. No parameter. |
32316 | @xref{Reverse Execution}, for more information. | |
32317 | ||
32318 | Reply: | |
32319 | @xref{Stop Reply Packets}, for the reply specifications. | |
32320 | ||
4f553f88 | 32321 | @item c @r{[}@var{addr}@r{]} |
b8ff78ce JB |
32322 | @cindex @samp{c} packet |
32323 | Continue. @var{addr} is address to resume. If @var{addr} is omitted, | |
32324 | resume at current address. | |
c906108c | 32325 | |
ee2d5c50 AC |
32326 | Reply: |
32327 | @xref{Stop Reply Packets}, for the reply specifications. | |
32328 | ||
4f553f88 | 32329 | @item C @var{sig}@r{[};@var{addr}@r{]} |
b8ff78ce | 32330 | @cindex @samp{C} packet |
8e04817f | 32331 | Continue with signal @var{sig} (hex signal number). If |
b8ff78ce | 32332 | @samp{;@var{addr}} is omitted, resume at same address. |
c906108c | 32333 | |
ee2d5c50 AC |
32334 | Reply: |
32335 | @xref{Stop Reply Packets}, for the reply specifications. | |
c906108c | 32336 | |
b8ff78ce JB |
32337 | @item d |
32338 | @cindex @samp{d} packet | |
ee2d5c50 AC |
32339 | Toggle debug flag. |
32340 | ||
b8ff78ce JB |
32341 | Don't use this packet; instead, define a general set packet |
32342 | (@pxref{General Query Packets}). | |
ee2d5c50 | 32343 | |
b8ff78ce | 32344 | @item D |
b90a069a | 32345 | @itemx D;@var{pid} |
b8ff78ce | 32346 | @cindex @samp{D} packet |
b90a069a SL |
32347 | The first form of the packet is used to detach @value{GDBN} from the |
32348 | remote system. It is sent to the remote target | |
07f31aa6 | 32349 | before @value{GDBN} disconnects via the @code{detach} command. |
ee2d5c50 | 32350 | |
b90a069a SL |
32351 | The second form, including a process ID, is used when multiprocess |
32352 | protocol extensions are enabled (@pxref{multiprocess extensions}), to | |
32353 | detach only a specific process. The @var{pid} is specified as a | |
32354 | big-endian hex string. | |
32355 | ||
ee2d5c50 AC |
32356 | Reply: |
32357 | @table @samp | |
10fac096 NW |
32358 | @item OK |
32359 | for success | |
b8ff78ce | 32360 | @item E @var{NN} |
10fac096 | 32361 | for an error |
ee2d5c50 | 32362 | @end table |
c906108c | 32363 | |
b8ff78ce JB |
32364 | @item F @var{RC},@var{EE},@var{CF};@var{XX} |
32365 | @cindex @samp{F} packet | |
32366 | A reply from @value{GDBN} to an @samp{F} packet sent by the target. | |
32367 | This is part of the File-I/O protocol extension. @xref{File-I/O | |
79a6e687 | 32368 | Remote Protocol Extension}, for the specification. |
ee2d5c50 | 32369 | |
b8ff78ce | 32370 | @item g |
ee2d5c50 | 32371 | @anchor{read registers packet} |
b8ff78ce | 32372 | @cindex @samp{g} packet |
ee2d5c50 AC |
32373 | Read general registers. |
32374 | ||
32375 | Reply: | |
32376 | @table @samp | |
32377 | @item @var{XX@dots{}} | |
8e04817f AC |
32378 | Each byte of register data is described by two hex digits. The bytes |
32379 | with the register are transmitted in target byte order. The size of | |
b8ff78ce | 32380 | each register and their position within the @samp{g} packet are |
4a9bb1df UW |
32381 | determined by the @value{GDBN} internal gdbarch functions |
32382 | @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}. The | |
b8ff78ce | 32383 | specification of several standard @samp{g} packets is specified below. |
ad196637 PA |
32384 | |
32385 | When reading registers from a trace frame (@pxref{Analyze Collected | |
32386 | Data,,Using the Collected Data}), the stub may also return a string of | |
32387 | literal @samp{x}'s in place of the register data digits, to indicate | |
32388 | that the corresponding register has not been collected, thus its value | |
32389 | is unavailable. For example, for an architecture with 4 registers of | |
32390 | 4 bytes each, the following reply indicates to @value{GDBN} that | |
32391 | registers 0 and 2 have not been collected, while registers 1 and 3 | |
32392 | have been collected, and both have zero value: | |
32393 | ||
32394 | @smallexample | |
32395 | -> @code{g} | |
32396 | <- @code{xxxxxxxx00000000xxxxxxxx00000000} | |
32397 | @end smallexample | |
32398 | ||
b8ff78ce | 32399 | @item E @var{NN} |
ee2d5c50 AC |
32400 | for an error. |
32401 | @end table | |
c906108c | 32402 | |
b8ff78ce JB |
32403 | @item G @var{XX@dots{}} |
32404 | @cindex @samp{G} packet | |
32405 | Write general registers. @xref{read registers packet}, for a | |
32406 | description of the @var{XX@dots{}} data. | |
ee2d5c50 AC |
32407 | |
32408 | Reply: | |
32409 | @table @samp | |
32410 | @item OK | |
32411 | for success | |
b8ff78ce | 32412 | @item E @var{NN} |
ee2d5c50 AC |
32413 | for an error |
32414 | @end table | |
32415 | ||
b90a069a | 32416 | @item H @var{c} @var{thread-id} |
b8ff78ce | 32417 | @cindex @samp{H} packet |
8e04817f | 32418 | Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g}, |
ee2d5c50 AC |
32419 | @samp{G}, et.al.). @var{c} depends on the operation to be performed: it |
32420 | should be @samp{c} for step and continue operations, @samp{g} for other | |
b90a069a SL |
32421 | operations. The thread designator @var{thread-id} has the format and |
32422 | interpretation described in @ref{thread-id syntax}. | |
ee2d5c50 AC |
32423 | |
32424 | Reply: | |
32425 | @table @samp | |
32426 | @item OK | |
32427 | for success | |
b8ff78ce | 32428 | @item E @var{NN} |
ee2d5c50 AC |
32429 | for an error |
32430 | @end table | |
c906108c | 32431 | |
8e04817f AC |
32432 | @c FIXME: JTC: |
32433 | @c 'H': How restrictive (or permissive) is the thread model. If a | |
32434 | @c thread is selected and stopped, are other threads allowed | |
32435 | @c to continue to execute? As I mentioned above, I think the | |
32436 | @c semantics of each command when a thread is selected must be | |
32437 | @c described. For example: | |
32438 | @c | |
32439 | @c 'g': If the stub supports threads and a specific thread is | |
32440 | @c selected, returns the register block from that thread; | |
32441 | @c otherwise returns current registers. | |
32442 | @c | |
32443 | @c 'G' If the stub supports threads and a specific thread is | |
32444 | @c selected, sets the registers of the register block of | |
32445 | @c that thread; otherwise sets current registers. | |
c906108c | 32446 | |
b8ff78ce | 32447 | @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]} |
ee2d5c50 | 32448 | @anchor{cycle step packet} |
b8ff78ce JB |
32449 | @cindex @samp{i} packet |
32450 | Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is | |
8e04817f AC |
32451 | present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle |
32452 | step starting at that address. | |
c906108c | 32453 | |
b8ff78ce JB |
32454 | @item I |
32455 | @cindex @samp{I} packet | |
32456 | Signal, then cycle step. @xref{step with signal packet}. @xref{cycle | |
32457 | step packet}. | |
ee2d5c50 | 32458 | |
b8ff78ce JB |
32459 | @item k |
32460 | @cindex @samp{k} packet | |
32461 | Kill request. | |
c906108c | 32462 | |
ac282366 | 32463 | FIXME: @emph{There is no description of how to operate when a specific |
ee2d5c50 AC |
32464 | thread context has been selected (i.e.@: does 'k' kill only that |
32465 | thread?)}. | |
c906108c | 32466 | |
b8ff78ce JB |
32467 | @item m @var{addr},@var{length} |
32468 | @cindex @samp{m} packet | |
8e04817f | 32469 | Read @var{length} bytes of memory starting at address @var{addr}. |
fb031cdf JB |
32470 | Note that @var{addr} may not be aligned to any particular boundary. |
32471 | ||
32472 | The stub need not use any particular size or alignment when gathering | |
32473 | data from memory for the response; even if @var{addr} is word-aligned | |
32474 | and @var{length} is a multiple of the word size, the stub is free to | |
32475 | use byte accesses, or not. For this reason, this packet may not be | |
32476 | suitable for accessing memory-mapped I/O devices. | |
c43c5473 JB |
32477 | @cindex alignment of remote memory accesses |
32478 | @cindex size of remote memory accesses | |
32479 | @cindex memory, alignment and size of remote accesses | |
c906108c | 32480 | |
ee2d5c50 AC |
32481 | Reply: |
32482 | @table @samp | |
32483 | @item @var{XX@dots{}} | |
599b237a | 32484 | Memory contents; each byte is transmitted as a two-digit hexadecimal |
b8ff78ce JB |
32485 | number. The reply may contain fewer bytes than requested if the |
32486 | server was able to read only part of the region of memory. | |
32487 | @item E @var{NN} | |
ee2d5c50 AC |
32488 | @var{NN} is errno |
32489 | @end table | |
32490 | ||
b8ff78ce JB |
32491 | @item M @var{addr},@var{length}:@var{XX@dots{}} |
32492 | @cindex @samp{M} packet | |
8e04817f | 32493 | Write @var{length} bytes of memory starting at address @var{addr}. |
b8ff78ce | 32494 | @var{XX@dots{}} is the data; each byte is transmitted as a two-digit |
599b237a | 32495 | hexadecimal number. |
ee2d5c50 AC |
32496 | |
32497 | Reply: | |
32498 | @table @samp | |
32499 | @item OK | |
32500 | for success | |
b8ff78ce | 32501 | @item E @var{NN} |
8e04817f AC |
32502 | for an error (this includes the case where only part of the data was |
32503 | written). | |
ee2d5c50 | 32504 | @end table |
c906108c | 32505 | |
b8ff78ce JB |
32506 | @item p @var{n} |
32507 | @cindex @samp{p} packet | |
32508 | Read the value of register @var{n}; @var{n} is in hex. | |
2e868123 AC |
32509 | @xref{read registers packet}, for a description of how the returned |
32510 | register value is encoded. | |
ee2d5c50 AC |
32511 | |
32512 | Reply: | |
32513 | @table @samp | |
2e868123 AC |
32514 | @item @var{XX@dots{}} |
32515 | the register's value | |
b8ff78ce | 32516 | @item E @var{NN} |
2e868123 AC |
32517 | for an error |
32518 | @item | |
32519 | Indicating an unrecognized @var{query}. | |
ee2d5c50 AC |
32520 | @end table |
32521 | ||
b8ff78ce | 32522 | @item P @var{n@dots{}}=@var{r@dots{}} |
ee2d5c50 | 32523 | @anchor{write register packet} |
b8ff78ce JB |
32524 | @cindex @samp{P} packet |
32525 | Write register @var{n@dots{}} with value @var{r@dots{}}. The register | |
599b237a | 32526 | number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex |
8e04817f | 32527 | digits for each byte in the register (target byte order). |
c906108c | 32528 | |
ee2d5c50 AC |
32529 | Reply: |
32530 | @table @samp | |
32531 | @item OK | |
32532 | for success | |
b8ff78ce | 32533 | @item E @var{NN} |
ee2d5c50 AC |
32534 | for an error |
32535 | @end table | |
32536 | ||
5f3bebba JB |
32537 | @item q @var{name} @var{params}@dots{} |
32538 | @itemx Q @var{name} @var{params}@dots{} | |
b8ff78ce | 32539 | @cindex @samp{q} packet |
b8ff78ce | 32540 | @cindex @samp{Q} packet |
5f3bebba JB |
32541 | General query (@samp{q}) and set (@samp{Q}). These packets are |
32542 | described fully in @ref{General Query Packets}. | |
c906108c | 32543 | |
b8ff78ce JB |
32544 | @item r |
32545 | @cindex @samp{r} packet | |
8e04817f | 32546 | Reset the entire system. |
c906108c | 32547 | |
b8ff78ce | 32548 | Don't use this packet; use the @samp{R} packet instead. |
ee2d5c50 | 32549 | |
b8ff78ce JB |
32550 | @item R @var{XX} |
32551 | @cindex @samp{R} packet | |
8e04817f | 32552 | Restart the program being debugged. @var{XX}, while needed, is ignored. |
2d717e4f | 32553 | This packet is only available in extended mode (@pxref{extended mode}). |
ee2d5c50 | 32554 | |
8e04817f | 32555 | The @samp{R} packet has no reply. |
ee2d5c50 | 32556 | |
4f553f88 | 32557 | @item s @r{[}@var{addr}@r{]} |
b8ff78ce JB |
32558 | @cindex @samp{s} packet |
32559 | Single step. @var{addr} is the address at which to resume. If | |
32560 | @var{addr} is omitted, resume at same address. | |
c906108c | 32561 | |
ee2d5c50 AC |
32562 | Reply: |
32563 | @xref{Stop Reply Packets}, for the reply specifications. | |
32564 | ||
4f553f88 | 32565 | @item S @var{sig}@r{[};@var{addr}@r{]} |
ee2d5c50 | 32566 | @anchor{step with signal packet} |
b8ff78ce JB |
32567 | @cindex @samp{S} packet |
32568 | Step with signal. This is analogous to the @samp{C} packet, but | |
32569 | requests a single-step, rather than a normal resumption of execution. | |
c906108c | 32570 | |
ee2d5c50 AC |
32571 | Reply: |
32572 | @xref{Stop Reply Packets}, for the reply specifications. | |
32573 | ||
b8ff78ce JB |
32574 | @item t @var{addr}:@var{PP},@var{MM} |
32575 | @cindex @samp{t} packet | |
8e04817f | 32576 | Search backwards starting at address @var{addr} for a match with pattern |
ee2d5c50 AC |
32577 | @var{PP} and mask @var{MM}. @var{PP} and @var{MM} are 4 bytes. |
32578 | @var{addr} must be at least 3 digits. | |
c906108c | 32579 | |
b90a069a | 32580 | @item T @var{thread-id} |
b8ff78ce | 32581 | @cindex @samp{T} packet |
b90a069a | 32582 | Find out if the thread @var{thread-id} is alive. @xref{thread-id syntax}. |
c906108c | 32583 | |
ee2d5c50 AC |
32584 | Reply: |
32585 | @table @samp | |
32586 | @item OK | |
32587 | thread is still alive | |
b8ff78ce | 32588 | @item E @var{NN} |
ee2d5c50 AC |
32589 | thread is dead |
32590 | @end table | |
32591 | ||
b8ff78ce JB |
32592 | @item v |
32593 | Packets starting with @samp{v} are identified by a multi-letter name, | |
32594 | up to the first @samp{;} or @samp{?} (or the end of the packet). | |
86d30acc | 32595 | |
2d717e4f DJ |
32596 | @item vAttach;@var{pid} |
32597 | @cindex @samp{vAttach} packet | |
8b23ecc4 SL |
32598 | Attach to a new process with the specified process ID @var{pid}. |
32599 | The process ID is a | |
32600 | hexadecimal integer identifying the process. In all-stop mode, all | |
32601 | threads in the attached process are stopped; in non-stop mode, it may be | |
32602 | attached without being stopped if that is supported by the target. | |
32603 | ||
32604 | @c In non-stop mode, on a successful vAttach, the stub should set the | |
32605 | @c current thread to a thread of the newly-attached process. After | |
32606 | @c attaching, GDB queries for the attached process's thread ID with qC. | |
32607 | @c Also note that, from a user perspective, whether or not the | |
32608 | @c target is stopped on attach in non-stop mode depends on whether you | |
32609 | @c use the foreground or background version of the attach command, not | |
32610 | @c on what vAttach does; GDB does the right thing with respect to either | |
32611 | @c stopping or restarting threads. | |
2d717e4f DJ |
32612 | |
32613 | This packet is only available in extended mode (@pxref{extended mode}). | |
32614 | ||
32615 | Reply: | |
32616 | @table @samp | |
32617 | @item E @var{nn} | |
32618 | for an error | |
32619 | @item @r{Any stop packet} | |
8b23ecc4 SL |
32620 | for success in all-stop mode (@pxref{Stop Reply Packets}) |
32621 | @item OK | |
32622 | for success in non-stop mode (@pxref{Remote Non-Stop}) | |
2d717e4f DJ |
32623 | @end table |
32624 | ||
b90a069a | 32625 | @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{} |
b8ff78ce JB |
32626 | @cindex @samp{vCont} packet |
32627 | Resume the inferior, specifying different actions for each thread. | |
b90a069a | 32628 | If an action is specified with no @var{thread-id}, then it is applied to any |
86d30acc | 32629 | threads that don't have a specific action specified; if no default action is |
8b23ecc4 SL |
32630 | specified then other threads should remain stopped in all-stop mode and |
32631 | in their current state in non-stop mode. | |
32632 | Specifying multiple | |
86d30acc | 32633 | default actions is an error; specifying no actions is also an error. |
b90a069a SL |
32634 | Thread IDs are specified using the syntax described in @ref{thread-id syntax}. |
32635 | ||
32636 | Currently supported actions are: | |
86d30acc | 32637 | |
b8ff78ce | 32638 | @table @samp |
86d30acc DJ |
32639 | @item c |
32640 | Continue. | |
b8ff78ce | 32641 | @item C @var{sig} |
8b23ecc4 | 32642 | Continue with signal @var{sig}. The signal @var{sig} should be two hex digits. |
86d30acc DJ |
32643 | @item s |
32644 | Step. | |
b8ff78ce | 32645 | @item S @var{sig} |
8b23ecc4 SL |
32646 | Step with signal @var{sig}. The signal @var{sig} should be two hex digits. |
32647 | @item t | |
32648 | Stop. | |
86d30acc DJ |
32649 | @end table |
32650 | ||
8b23ecc4 SL |
32651 | The optional argument @var{addr} normally associated with the |
32652 | @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is | |
b8ff78ce | 32653 | not supported in @samp{vCont}. |
86d30acc | 32654 | |
08a0efd0 PA |
32655 | The @samp{t} action is only relevant in non-stop mode |
32656 | (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise. | |
8b23ecc4 SL |
32657 | A stop reply should be generated for any affected thread not already stopped. |
32658 | When a thread is stopped by means of a @samp{t} action, | |
32659 | the corresponding stop reply should indicate that the thread has stopped with | |
32660 | signal @samp{0}, regardless of whether the target uses some other signal | |
32661 | as an implementation detail. | |
32662 | ||
86d30acc DJ |
32663 | Reply: |
32664 | @xref{Stop Reply Packets}, for the reply specifications. | |
32665 | ||
b8ff78ce JB |
32666 | @item vCont? |
32667 | @cindex @samp{vCont?} packet | |
d3e8051b | 32668 | Request a list of actions supported by the @samp{vCont} packet. |
86d30acc DJ |
32669 | |
32670 | Reply: | |
32671 | @table @samp | |
b8ff78ce JB |
32672 | @item vCont@r{[};@var{action}@dots{}@r{]} |
32673 | The @samp{vCont} packet is supported. Each @var{action} is a supported | |
32674 | command in the @samp{vCont} packet. | |
86d30acc | 32675 | @item |
b8ff78ce | 32676 | The @samp{vCont} packet is not supported. |
86d30acc | 32677 | @end table |
ee2d5c50 | 32678 | |
a6b151f1 DJ |
32679 | @item vFile:@var{operation}:@var{parameter}@dots{} |
32680 | @cindex @samp{vFile} packet | |
32681 | Perform a file operation on the target system. For details, | |
32682 | see @ref{Host I/O Packets}. | |
32683 | ||
68437a39 DJ |
32684 | @item vFlashErase:@var{addr},@var{length} |
32685 | @cindex @samp{vFlashErase} packet | |
32686 | Direct the stub to erase @var{length} bytes of flash starting at | |
32687 | @var{addr}. The region may enclose any number of flash blocks, but | |
32688 | its start and end must fall on block boundaries, as indicated by the | |
79a6e687 BW |
32689 | flash block size appearing in the memory map (@pxref{Memory Map |
32690 | Format}). @value{GDBN} groups flash memory programming operations | |
68437a39 DJ |
32691 | together, and sends a @samp{vFlashDone} request after each group; the |
32692 | stub is allowed to delay erase operation until the @samp{vFlashDone} | |
32693 | packet is received. | |
32694 | ||
b90a069a SL |
32695 | The stub must support @samp{vCont} if it reports support for |
32696 | multiprocess extensions (@pxref{multiprocess extensions}). Note that in | |
32697 | this case @samp{vCont} actions can be specified to apply to all threads | |
32698 | in a process by using the @samp{p@var{pid}.-1} form of the | |
32699 | @var{thread-id}. | |
32700 | ||
68437a39 DJ |
32701 | Reply: |
32702 | @table @samp | |
32703 | @item OK | |
32704 | for success | |
32705 | @item E @var{NN} | |
32706 | for an error | |
32707 | @end table | |
32708 | ||
32709 | @item vFlashWrite:@var{addr}:@var{XX@dots{}} | |
32710 | @cindex @samp{vFlashWrite} packet | |
32711 | Direct the stub to write data to flash address @var{addr}. The data | |
32712 | is passed in binary form using the same encoding as for the @samp{X} | |
32713 | packet (@pxref{Binary Data}). The memory ranges specified by | |
32714 | @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must | |
32715 | not overlap, and must appear in order of increasing addresses | |
32716 | (although @samp{vFlashErase} packets for higher addresses may already | |
32717 | have been received; the ordering is guaranteed only between | |
32718 | @samp{vFlashWrite} packets). If a packet writes to an address that was | |
32719 | neither erased by a preceding @samp{vFlashErase} packet nor by some other | |
32720 | target-specific method, the results are unpredictable. | |
32721 | ||
32722 | ||
32723 | Reply: | |
32724 | @table @samp | |
32725 | @item OK | |
32726 | for success | |
32727 | @item E.memtype | |
32728 | for vFlashWrite addressing non-flash memory | |
32729 | @item E @var{NN} | |
32730 | for an error | |
32731 | @end table | |
32732 | ||
32733 | @item vFlashDone | |
32734 | @cindex @samp{vFlashDone} packet | |
32735 | Indicate to the stub that flash programming operation is finished. | |
32736 | The stub is permitted to delay or batch the effects of a group of | |
32737 | @samp{vFlashErase} and @samp{vFlashWrite} packets until a | |
32738 | @samp{vFlashDone} packet is received. The contents of the affected | |
32739 | regions of flash memory are unpredictable until the @samp{vFlashDone} | |
32740 | request is completed. | |
32741 | ||
b90a069a SL |
32742 | @item vKill;@var{pid} |
32743 | @cindex @samp{vKill} packet | |
32744 | Kill the process with the specified process ID. @var{pid} is a | |
32745 | hexadecimal integer identifying the process. This packet is used in | |
32746 | preference to @samp{k} when multiprocess protocol extensions are | |
32747 | supported; see @ref{multiprocess extensions}. | |
32748 | ||
32749 | Reply: | |
32750 | @table @samp | |
32751 | @item E @var{nn} | |
32752 | for an error | |
32753 | @item OK | |
32754 | for success | |
32755 | @end table | |
32756 | ||
2d717e4f DJ |
32757 | @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{} |
32758 | @cindex @samp{vRun} packet | |
32759 | Run the program @var{filename}, passing it each @var{argument} on its | |
32760 | command line. The file and arguments are hex-encoded strings. If | |
32761 | @var{filename} is an empty string, the stub may use a default program | |
32762 | (e.g.@: the last program run). The program is created in the stopped | |
9b562ab8 | 32763 | state. |
2d717e4f | 32764 | |
8b23ecc4 SL |
32765 | @c FIXME: What about non-stop mode? |
32766 | ||
2d717e4f DJ |
32767 | This packet is only available in extended mode (@pxref{extended mode}). |
32768 | ||
32769 | Reply: | |
32770 | @table @samp | |
32771 | @item E @var{nn} | |
32772 | for an error | |
32773 | @item @r{Any stop packet} | |
32774 | for success (@pxref{Stop Reply Packets}) | |
32775 | @end table | |
32776 | ||
8b23ecc4 SL |
32777 | @item vStopped |
32778 | @anchor{vStopped packet} | |
32779 | @cindex @samp{vStopped} packet | |
32780 | ||
32781 | In non-stop mode (@pxref{Remote Non-Stop}), acknowledge a previous stop | |
32782 | reply and prompt for the stub to report another one. | |
32783 | ||
32784 | Reply: | |
32785 | @table @samp | |
32786 | @item @r{Any stop packet} | |
32787 | if there is another unreported stop event (@pxref{Stop Reply Packets}) | |
32788 | @item OK | |
32789 | if there are no unreported stop events | |
32790 | @end table | |
32791 | ||
b8ff78ce | 32792 | @item X @var{addr},@var{length}:@var{XX@dots{}} |
9a6253be | 32793 | @anchor{X packet} |
b8ff78ce JB |
32794 | @cindex @samp{X} packet |
32795 | Write data to memory, where the data is transmitted in binary. | |
32796 | @var{addr} is address, @var{length} is number of bytes, | |
0876f84a | 32797 | @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}). |
c906108c | 32798 | |
ee2d5c50 AC |
32799 | Reply: |
32800 | @table @samp | |
32801 | @item OK | |
32802 | for success | |
b8ff78ce | 32803 | @item E @var{NN} |
ee2d5c50 AC |
32804 | for an error |
32805 | @end table | |
32806 | ||
a1dcb23a DJ |
32807 | @item z @var{type},@var{addr},@var{kind} |
32808 | @itemx Z @var{type},@var{addr},@var{kind} | |
2f870471 | 32809 | @anchor{insert breakpoint or watchpoint packet} |
b8ff78ce JB |
32810 | @cindex @samp{z} packet |
32811 | @cindex @samp{Z} packets | |
32812 | Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or | |
a1dcb23a | 32813 | watchpoint starting at address @var{address} of kind @var{kind}. |
ee2d5c50 | 32814 | |
2f870471 AC |
32815 | Each breakpoint and watchpoint packet @var{type} is documented |
32816 | separately. | |
32817 | ||
512217c7 AC |
32818 | @emph{Implementation notes: A remote target shall return an empty string |
32819 | for an unrecognized breakpoint or watchpoint packet @var{type}. A | |
32820 | remote target shall support either both or neither of a given | |
b8ff78ce | 32821 | @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To |
2f870471 AC |
32822 | avoid potential problems with duplicate packets, the operations should |
32823 | be implemented in an idempotent way.} | |
32824 | ||
a1dcb23a DJ |
32825 | @item z0,@var{addr},@var{kind} |
32826 | @itemx Z0,@var{addr},@var{kind} | |
b8ff78ce JB |
32827 | @cindex @samp{z0} packet |
32828 | @cindex @samp{Z0} packet | |
32829 | Insert (@samp{Z0}) or remove (@samp{z0}) a memory breakpoint at address | |
a1dcb23a | 32830 | @var{addr} of type @var{kind}. |
2f870471 AC |
32831 | |
32832 | A memory breakpoint is implemented by replacing the instruction at | |
32833 | @var{addr} with a software breakpoint or trap instruction. The | |
a1dcb23a DJ |
32834 | @var{kind} is target-specific and typically indicates the size of |
32835 | the breakpoint in bytes that should be inserted. E.g., the @sc{arm} | |
32836 | and @sc{mips} can insert either a 2 or 4 byte breakpoint. Some | |
32837 | architectures have additional meanings for @var{kind}; | |
32838 | see @ref{Architecture-Specific Protocol Details}. | |
c906108c | 32839 | |
2f870471 AC |
32840 | @emph{Implementation note: It is possible for a target to copy or move |
32841 | code that contains memory breakpoints (e.g., when implementing | |
32842 | overlays). The behavior of this packet, in the presence of such a | |
32843 | target, is not defined.} | |
c906108c | 32844 | |
ee2d5c50 AC |
32845 | Reply: |
32846 | @table @samp | |
2f870471 AC |
32847 | @item OK |
32848 | success | |
32849 | @item | |
32850 | not supported | |
b8ff78ce | 32851 | @item E @var{NN} |
ee2d5c50 | 32852 | for an error |
2f870471 AC |
32853 | @end table |
32854 | ||
a1dcb23a DJ |
32855 | @item z1,@var{addr},@var{kind} |
32856 | @itemx Z1,@var{addr},@var{kind} | |
b8ff78ce JB |
32857 | @cindex @samp{z1} packet |
32858 | @cindex @samp{Z1} packet | |
32859 | Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at | |
a1dcb23a | 32860 | address @var{addr}. |
2f870471 AC |
32861 | |
32862 | A hardware breakpoint is implemented using a mechanism that is not | |
a1dcb23a DJ |
32863 | dependant on being able to modify the target's memory. @var{kind} |
32864 | has the same meaning as in @samp{Z0} packets. | |
2f870471 AC |
32865 | |
32866 | @emph{Implementation note: A hardware breakpoint is not affected by code | |
32867 | movement.} | |
32868 | ||
32869 | Reply: | |
32870 | @table @samp | |
ee2d5c50 | 32871 | @item OK |
2f870471 AC |
32872 | success |
32873 | @item | |
32874 | not supported | |
b8ff78ce | 32875 | @item E @var{NN} |
2f870471 AC |
32876 | for an error |
32877 | @end table | |
32878 | ||
a1dcb23a DJ |
32879 | @item z2,@var{addr},@var{kind} |
32880 | @itemx Z2,@var{addr},@var{kind} | |
b8ff78ce JB |
32881 | @cindex @samp{z2} packet |
32882 | @cindex @samp{Z2} packet | |
a1dcb23a DJ |
32883 | Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}. |
32884 | @var{kind} is interpreted as the number of bytes to watch. | |
2f870471 AC |
32885 | |
32886 | Reply: | |
32887 | @table @samp | |
32888 | @item OK | |
32889 | success | |
32890 | @item | |
32891 | not supported | |
b8ff78ce | 32892 | @item E @var{NN} |
2f870471 AC |
32893 | for an error |
32894 | @end table | |
32895 | ||
a1dcb23a DJ |
32896 | @item z3,@var{addr},@var{kind} |
32897 | @itemx Z3,@var{addr},@var{kind} | |
b8ff78ce JB |
32898 | @cindex @samp{z3} packet |
32899 | @cindex @samp{Z3} packet | |
a1dcb23a DJ |
32900 | Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}. |
32901 | @var{kind} is interpreted as the number of bytes to watch. | |
2f870471 AC |
32902 | |
32903 | Reply: | |
32904 | @table @samp | |
32905 | @item OK | |
32906 | success | |
32907 | @item | |
32908 | not supported | |
b8ff78ce | 32909 | @item E @var{NN} |
2f870471 AC |
32910 | for an error |
32911 | @end table | |
32912 | ||
a1dcb23a DJ |
32913 | @item z4,@var{addr},@var{kind} |
32914 | @itemx Z4,@var{addr},@var{kind} | |
b8ff78ce JB |
32915 | @cindex @samp{z4} packet |
32916 | @cindex @samp{Z4} packet | |
a1dcb23a DJ |
32917 | Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}. |
32918 | @var{kind} is interpreted as the number of bytes to watch. | |
2f870471 AC |
32919 | |
32920 | Reply: | |
32921 | @table @samp | |
32922 | @item OK | |
32923 | success | |
32924 | @item | |
32925 | not supported | |
b8ff78ce | 32926 | @item E @var{NN} |
2f870471 | 32927 | for an error |
ee2d5c50 AC |
32928 | @end table |
32929 | ||
32930 | @end table | |
c906108c | 32931 | |
ee2d5c50 AC |
32932 | @node Stop Reply Packets |
32933 | @section Stop Reply Packets | |
32934 | @cindex stop reply packets | |
c906108c | 32935 | |
8b23ecc4 SL |
32936 | The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont}, |
32937 | @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can | |
32938 | receive any of the below as a reply. Except for @samp{?} | |
32939 | and @samp{vStopped}, that reply is only returned | |
b8ff78ce | 32940 | when the target halts. In the below the exact meaning of @dfn{signal |
89be2091 DJ |
32941 | number} is defined by the header @file{include/gdb/signals.h} in the |
32942 | @value{GDBN} source code. | |
c906108c | 32943 | |
b8ff78ce JB |
32944 | As in the description of request packets, we include spaces in the |
32945 | reply templates for clarity; these are not part of the reply packet's | |
32946 | syntax. No @value{GDBN} stop reply packet uses spaces to separate its | |
32947 | components. | |
c906108c | 32948 | |
b8ff78ce | 32949 | @table @samp |
ee2d5c50 | 32950 | |
b8ff78ce | 32951 | @item S @var{AA} |
599b237a | 32952 | The program received signal number @var{AA} (a two-digit hexadecimal |
940178d3 JB |
32953 | number). This is equivalent to a @samp{T} response with no |
32954 | @var{n}:@var{r} pairs. | |
c906108c | 32955 | |
b8ff78ce JB |
32956 | @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{} |
32957 | @cindex @samp{T} packet reply | |
599b237a | 32958 | The program received signal number @var{AA} (a two-digit hexadecimal |
940178d3 JB |
32959 | number). This is equivalent to an @samp{S} response, except that the |
32960 | @samp{@var{n}:@var{r}} pairs can carry values of important registers | |
32961 | and other information directly in the stop reply packet, reducing | |
32962 | round-trip latency. Single-step and breakpoint traps are reported | |
32963 | this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows: | |
cfa9d6d9 DJ |
32964 | |
32965 | @itemize @bullet | |
b8ff78ce | 32966 | @item |
599b237a | 32967 | If @var{n} is a hexadecimal number, it is a register number, and the |
b8ff78ce JB |
32968 | corresponding @var{r} gives that register's value. @var{r} is a |
32969 | series of bytes in target byte order, with each byte given by a | |
32970 | two-digit hex number. | |
cfa9d6d9 | 32971 | |
b8ff78ce | 32972 | @item |
b90a069a SL |
32973 | If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of |
32974 | the stopped thread, as specified in @ref{thread-id syntax}. | |
cfa9d6d9 | 32975 | |
dc146f7c VP |
32976 | @item |
32977 | If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of | |
32978 | the core on which the stop event was detected. | |
32979 | ||
b8ff78ce | 32980 | @item |
cfa9d6d9 DJ |
32981 | If @var{n} is a recognized @dfn{stop reason}, it describes a more |
32982 | specific event that stopped the target. The currently defined stop | |
32983 | reasons are listed below. @var{aa} should be @samp{05}, the trap | |
32984 | signal. At most one stop reason should be present. | |
32985 | ||
b8ff78ce JB |
32986 | @item |
32987 | Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair | |
32988 | and go on to the next; this allows us to extend the protocol in the | |
32989 | future. | |
cfa9d6d9 DJ |
32990 | @end itemize |
32991 | ||
32992 | The currently defined stop reasons are: | |
32993 | ||
32994 | @table @samp | |
32995 | @item watch | |
32996 | @itemx rwatch | |
32997 | @itemx awatch | |
32998 | The packet indicates a watchpoint hit, and @var{r} is the data address, in | |
32999 | hex. | |
33000 | ||
33001 | @cindex shared library events, remote reply | |
33002 | @item library | |
33003 | The packet indicates that the loaded libraries have changed. | |
33004 | @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new | |
33005 | list of loaded libraries. @var{r} is ignored. | |
bacec72f MS |
33006 | |
33007 | @cindex replay log events, remote reply | |
33008 | @item replaylog | |
33009 | The packet indicates that the target cannot continue replaying | |
33010 | logged execution events, because it has reached the end (or the | |
33011 | beginning when executing backward) of the log. The value of @var{r} | |
33012 | will be either @samp{begin} or @samp{end}. @xref{Reverse Execution}, | |
33013 | for more information. | |
cfa9d6d9 | 33014 | @end table |
ee2d5c50 | 33015 | |
b8ff78ce | 33016 | @item W @var{AA} |
b90a069a | 33017 | @itemx W @var{AA} ; process:@var{pid} |
8e04817f | 33018 | The process exited, and @var{AA} is the exit status. This is only |
ee2d5c50 AC |
33019 | applicable to certain targets. |
33020 | ||
b90a069a SL |
33021 | The second form of the response, including the process ID of the exited |
33022 | process, can be used only when @value{GDBN} has reported support for | |
33023 | multiprocess protocol extensions; see @ref{multiprocess extensions}. | |
33024 | The @var{pid} is formatted as a big-endian hex string. | |
33025 | ||
b8ff78ce | 33026 | @item X @var{AA} |
b90a069a | 33027 | @itemx X @var{AA} ; process:@var{pid} |
8e04817f | 33028 | The process terminated with signal @var{AA}. |
c906108c | 33029 | |
b90a069a SL |
33030 | The second form of the response, including the process ID of the |
33031 | terminated process, can be used only when @value{GDBN} has reported | |
33032 | support for multiprocess protocol extensions; see @ref{multiprocess | |
33033 | extensions}. The @var{pid} is formatted as a big-endian hex string. | |
33034 | ||
b8ff78ce JB |
33035 | @item O @var{XX}@dots{} |
33036 | @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be | |
33037 | written as the program's console output. This can happen at any time | |
33038 | while the program is running and the debugger should continue to wait | |
8b23ecc4 | 33039 | for @samp{W}, @samp{T}, etc. This reply is not permitted in non-stop mode. |
0ce1b118 | 33040 | |
b8ff78ce | 33041 | @item F @var{call-id},@var{parameter}@dots{} |
0ce1b118 CV |
33042 | @var{call-id} is the identifier which says which host system call should |
33043 | be called. This is just the name of the function. Translation into the | |
33044 | correct system call is only applicable as it's defined in @value{GDBN}. | |
79a6e687 | 33045 | @xref{File-I/O Remote Protocol Extension}, for a list of implemented |
0ce1b118 CV |
33046 | system calls. |
33047 | ||
b8ff78ce JB |
33048 | @samp{@var{parameter}@dots{}} is a list of parameters as defined for |
33049 | this very system call. | |
0ce1b118 | 33050 | |
b8ff78ce JB |
33051 | The target replies with this packet when it expects @value{GDBN} to |
33052 | call a host system call on behalf of the target. @value{GDBN} replies | |
33053 | with an appropriate @samp{F} packet and keeps up waiting for the next | |
33054 | reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S} | |
79a6e687 BW |
33055 | or @samp{s} action is expected to be continued. @xref{File-I/O Remote |
33056 | Protocol Extension}, for more details. | |
0ce1b118 | 33057 | |
ee2d5c50 AC |
33058 | @end table |
33059 | ||
33060 | @node General Query Packets | |
33061 | @section General Query Packets | |
9c16f35a | 33062 | @cindex remote query requests |
c906108c | 33063 | |
5f3bebba JB |
33064 | Packets starting with @samp{q} are @dfn{general query packets}; |
33065 | packets starting with @samp{Q} are @dfn{general set packets}. General | |
33066 | query and set packets are a semi-unified form for retrieving and | |
33067 | sending information to and from the stub. | |
33068 | ||
33069 | The initial letter of a query or set packet is followed by a name | |
33070 | indicating what sort of thing the packet applies to. For example, | |
33071 | @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol | |
33072 | definitions with the stub. These packet names follow some | |
33073 | conventions: | |
33074 | ||
33075 | @itemize @bullet | |
33076 | @item | |
33077 | The name must not contain commas, colons or semicolons. | |
33078 | @item | |
33079 | Most @value{GDBN} query and set packets have a leading upper case | |
33080 | letter. | |
33081 | @item | |
33082 | The names of custom vendor packets should use a company prefix, in | |
33083 | lower case, followed by a period. For example, packets designed at | |
33084 | the Acme Corporation might begin with @samp{qacme.foo} (for querying | |
33085 | foos) or @samp{Qacme.bar} (for setting bars). | |
33086 | @end itemize | |
33087 | ||
aa56d27a JB |
33088 | The name of a query or set packet should be separated from any |
33089 | parameters by a @samp{:}; the parameters themselves should be | |
33090 | separated by @samp{,} or @samp{;}. Stubs must be careful to match the | |
369af7bd DJ |
33091 | full packet name, and check for a separator or the end of the packet, |
33092 | in case two packet names share a common prefix. New packets should not begin | |
33093 | with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL} | |
33094 | packets predate these conventions, and have arguments without any terminator | |
33095 | for the packet name; we suspect they are in widespread use in places that | |
33096 | are difficult to upgrade. The @samp{qC} packet has no arguments, but some | |
33097 | existing stubs (e.g.@: RedBoot) are known to not check for the end of the | |
33098 | packet.}. | |
c906108c | 33099 | |
b8ff78ce JB |
33100 | Like the descriptions of the other packets, each description here |
33101 | has a template showing the packet's overall syntax, followed by an | |
33102 | explanation of the packet's meaning. We include spaces in some of the | |
33103 | templates for clarity; these are not part of the packet's syntax. No | |
33104 | @value{GDBN} packet uses spaces to separate its components. | |
33105 | ||
5f3bebba JB |
33106 | Here are the currently defined query and set packets: |
33107 | ||
b8ff78ce | 33108 | @table @samp |
c906108c | 33109 | |
d914c394 SS |
33110 | @item QAllow:@var{op}:@var{val}@dots{} |
33111 | @cindex @samp{QAllow} packet | |
33112 | Specify which operations @value{GDBN} expects to request of the | |
33113 | target, as a semicolon-separated list of operation name and value | |
33114 | pairs. Possible values for @var{op} include @samp{WriteReg}, | |
33115 | @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace}, | |
33116 | @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0, | |
33117 | indicating that @value{GDBN} will not request the operation, or 1, | |
33118 | indicating that it may. (The target can then use this to set up its | |
33119 | own internals optimally, for instance if the debugger never expects to | |
33120 | insert breakpoints, it may not need to install its own trap handler.) | |
33121 | ||
b8ff78ce | 33122 | @item qC |
9c16f35a | 33123 | @cindex current thread, remote request |
b8ff78ce | 33124 | @cindex @samp{qC} packet |
b90a069a | 33125 | Return the current thread ID. |
ee2d5c50 AC |
33126 | |
33127 | Reply: | |
33128 | @table @samp | |
b90a069a SL |
33129 | @item QC @var{thread-id} |
33130 | Where @var{thread-id} is a thread ID as documented in | |
33131 | @ref{thread-id syntax}. | |
b8ff78ce | 33132 | @item @r{(anything else)} |
b90a069a | 33133 | Any other reply implies the old thread ID. |
ee2d5c50 AC |
33134 | @end table |
33135 | ||
b8ff78ce | 33136 | @item qCRC:@var{addr},@var{length} |
ff2587ec | 33137 | @cindex CRC of memory block, remote request |
b8ff78ce | 33138 | @cindex @samp{qCRC} packet |
99e008fe EZ |
33139 | Compute the CRC checksum of a block of memory using CRC-32 defined in |
33140 | IEEE 802.3. The CRC is computed byte at a time, taking the most | |
33141 | significant bit of each byte first. The initial pattern code | |
33142 | @code{0xffffffff} is used to ensure leading zeros affect the CRC. | |
33143 | ||
33144 | @emph{Note:} This is the same CRC used in validating separate debug | |
33145 | files (@pxref{Separate Debug Files, , Debugging Information in Separate | |
33146 | Files}). However the algorithm is slightly different. When validating | |
33147 | separate debug files, the CRC is computed taking the @emph{least} | |
33148 | significant bit of each byte first, and the final result is inverted to | |
33149 | detect trailing zeros. | |
33150 | ||
ff2587ec WZ |
33151 | Reply: |
33152 | @table @samp | |
b8ff78ce | 33153 | @item E @var{NN} |
ff2587ec | 33154 | An error (such as memory fault) |
b8ff78ce JB |
33155 | @item C @var{crc32} |
33156 | The specified memory region's checksum is @var{crc32}. | |
ff2587ec WZ |
33157 | @end table |
33158 | ||
b8ff78ce JB |
33159 | @item qfThreadInfo |
33160 | @itemx qsThreadInfo | |
9c16f35a | 33161 | @cindex list active threads, remote request |
b8ff78ce JB |
33162 | @cindex @samp{qfThreadInfo} packet |
33163 | @cindex @samp{qsThreadInfo} packet | |
b90a069a | 33164 | Obtain a list of all active thread IDs from the target (OS). Since there |
8e04817f AC |
33165 | may be too many active threads to fit into one reply packet, this query |
33166 | works iteratively: it may require more than one query/reply sequence to | |
33167 | obtain the entire list of threads. The first query of the sequence will | |
b8ff78ce JB |
33168 | be the @samp{qfThreadInfo} query; subsequent queries in the |
33169 | sequence will be the @samp{qsThreadInfo} query. | |
ee2d5c50 | 33170 | |
b8ff78ce | 33171 | NOTE: This packet replaces the @samp{qL} query (see below). |
ee2d5c50 AC |
33172 | |
33173 | Reply: | |
33174 | @table @samp | |
b90a069a SL |
33175 | @item m @var{thread-id} |
33176 | A single thread ID | |
33177 | @item m @var{thread-id},@var{thread-id}@dots{} | |
33178 | a comma-separated list of thread IDs | |
b8ff78ce JB |
33179 | @item l |
33180 | (lower case letter @samp{L}) denotes end of list. | |
ee2d5c50 AC |
33181 | @end table |
33182 | ||
33183 | In response to each query, the target will reply with a list of one or | |
b90a069a | 33184 | more thread IDs, separated by commas. |
e1aac25b | 33185 | @value{GDBN} will respond to each reply with a request for more thread |
b8ff78ce | 33186 | ids (using the @samp{qs} form of the query), until the target responds |
501994c0 | 33187 | with @samp{l} (lower-case ell, for @dfn{last}). |
b90a069a SL |
33188 | Refer to @ref{thread-id syntax}, for the format of the @var{thread-id} |
33189 | fields. | |
c906108c | 33190 | |
b8ff78ce | 33191 | @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm} |
ff2587ec | 33192 | @cindex get thread-local storage address, remote request |
b8ff78ce | 33193 | @cindex @samp{qGetTLSAddr} packet |
ff2587ec WZ |
33194 | Fetch the address associated with thread local storage specified |
33195 | by @var{thread-id}, @var{offset}, and @var{lm}. | |
33196 | ||
b90a069a SL |
33197 | @var{thread-id} is the thread ID associated with the |
33198 | thread for which to fetch the TLS address. @xref{thread-id syntax}. | |
ff2587ec WZ |
33199 | |
33200 | @var{offset} is the (big endian, hex encoded) offset associated with the | |
33201 | thread local variable. (This offset is obtained from the debug | |
33202 | information associated with the variable.) | |
33203 | ||
db2e3e2e | 33204 | @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the |
7a9dd1b2 | 33205 | load module associated with the thread local storage. For example, |
ff2587ec WZ |
33206 | a @sc{gnu}/Linux system will pass the link map address of the shared |
33207 | object associated with the thread local storage under consideration. | |
33208 | Other operating environments may choose to represent the load module | |
33209 | differently, so the precise meaning of this parameter will vary. | |
ee2d5c50 AC |
33210 | |
33211 | Reply: | |
b8ff78ce JB |
33212 | @table @samp |
33213 | @item @var{XX}@dots{} | |
ff2587ec WZ |
33214 | Hex encoded (big endian) bytes representing the address of the thread |
33215 | local storage requested. | |
33216 | ||
b8ff78ce JB |
33217 | @item E @var{nn} |
33218 | An error occurred. @var{nn} are hex digits. | |
ff2587ec | 33219 | |
b8ff78ce JB |
33220 | @item |
33221 | An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub. | |
ee2d5c50 AC |
33222 | @end table |
33223 | ||
711e434b PM |
33224 | @item qGetTIBAddr:@var{thread-id} |
33225 | @cindex get thread information block address | |
33226 | @cindex @samp{qGetTIBAddr} packet | |
33227 | Fetch address of the Windows OS specific Thread Information Block. | |
33228 | ||
33229 | @var{thread-id} is the thread ID associated with the thread. | |
33230 | ||
33231 | Reply: | |
33232 | @table @samp | |
33233 | @item @var{XX}@dots{} | |
33234 | Hex encoded (big endian) bytes representing the linear address of the | |
33235 | thread information block. | |
33236 | ||
33237 | @item E @var{nn} | |
33238 | An error occured. This means that either the thread was not found, or the | |
33239 | address could not be retrieved. | |
33240 | ||
33241 | @item | |
33242 | An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub. | |
33243 | @end table | |
33244 | ||
b8ff78ce | 33245 | @item qL @var{startflag} @var{threadcount} @var{nextthread} |
8e04817f AC |
33246 | Obtain thread information from RTOS. Where: @var{startflag} (one hex |
33247 | digit) is one to indicate the first query and zero to indicate a | |
33248 | subsequent query; @var{threadcount} (two hex digits) is the maximum | |
33249 | number of threads the response packet can contain; and @var{nextthread} | |
33250 | (eight hex digits), for subsequent queries (@var{startflag} is zero), is | |
33251 | returned in the response as @var{argthread}. | |
ee2d5c50 | 33252 | |
b8ff78ce | 33253 | Don't use this packet; use the @samp{qfThreadInfo} query instead (see above). |
ee2d5c50 AC |
33254 | |
33255 | Reply: | |
33256 | @table @samp | |
b8ff78ce | 33257 | @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{} |
8e04817f AC |
33258 | Where: @var{count} (two hex digits) is the number of threads being |
33259 | returned; @var{done} (one hex digit) is zero to indicate more threads | |
33260 | and one indicates no further threads; @var{argthreadid} (eight hex | |
b8ff78ce | 33261 | digits) is @var{nextthread} from the request packet; @var{thread}@dots{} |
ee2d5c50 | 33262 | is a sequence of thread IDs from the target. @var{threadid} (eight hex |
8e04817f | 33263 | digits). See @code{remote.c:parse_threadlist_response()}. |
ee2d5c50 | 33264 | @end table |
c906108c | 33265 | |
b8ff78ce | 33266 | @item qOffsets |
9c16f35a | 33267 | @cindex section offsets, remote request |
b8ff78ce | 33268 | @cindex @samp{qOffsets} packet |
31d99776 DJ |
33269 | Get section offsets that the target used when relocating the downloaded |
33270 | image. | |
c906108c | 33271 | |
ee2d5c50 AC |
33272 | Reply: |
33273 | @table @samp | |
31d99776 DJ |
33274 | @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]} |
33275 | Relocate the @code{Text} section by @var{xxx} from its original address. | |
33276 | Relocate the @code{Data} section by @var{yyy} from its original address. | |
33277 | If the object file format provides segment information (e.g.@: @sc{elf} | |
33278 | @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire | |
33279 | segments by the supplied offsets. | |
33280 | ||
33281 | @emph{Note: while a @code{Bss} offset may be included in the response, | |
33282 | @value{GDBN} ignores this and instead applies the @code{Data} offset | |
33283 | to the @code{Bss} section.} | |
33284 | ||
33285 | @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]} | |
33286 | Relocate the first segment of the object file, which conventionally | |
33287 | contains program code, to a starting address of @var{xxx}. If | |
33288 | @samp{DataSeg} is specified, relocate the second segment, which | |
33289 | conventionally contains modifiable data, to a starting address of | |
33290 | @var{yyy}. @value{GDBN} will report an error if the object file | |
33291 | does not contain segment information, or does not contain at least | |
33292 | as many segments as mentioned in the reply. Extra segments are | |
33293 | kept at fixed offsets relative to the last relocated segment. | |
ee2d5c50 AC |
33294 | @end table |
33295 | ||
b90a069a | 33296 | @item qP @var{mode} @var{thread-id} |
9c16f35a | 33297 | @cindex thread information, remote request |
b8ff78ce | 33298 | @cindex @samp{qP} packet |
b90a069a SL |
33299 | Returns information on @var{thread-id}. Where: @var{mode} is a hex |
33300 | encoded 32 bit mode; @var{thread-id} is a thread ID | |
33301 | (@pxref{thread-id syntax}). | |
ee2d5c50 | 33302 | |
aa56d27a JB |
33303 | Don't use this packet; use the @samp{qThreadExtraInfo} query instead |
33304 | (see below). | |
33305 | ||
b8ff78ce | 33306 | Reply: see @code{remote.c:remote_unpack_thread_info_response()}. |
c906108c | 33307 | |
8b23ecc4 SL |
33308 | @item QNonStop:1 |
33309 | @item QNonStop:0 | |
33310 | @cindex non-stop mode, remote request | |
33311 | @cindex @samp{QNonStop} packet | |
33312 | @anchor{QNonStop} | |
33313 | Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode. | |
33314 | @xref{Remote Non-Stop}, for more information. | |
33315 | ||
33316 | Reply: | |
33317 | @table @samp | |
33318 | @item OK | |
33319 | The request succeeded. | |
33320 | ||
33321 | @item E @var{nn} | |
33322 | An error occurred. @var{nn} are hex digits. | |
33323 | ||
33324 | @item | |
33325 | An empty reply indicates that @samp{QNonStop} is not supported by | |
33326 | the stub. | |
33327 | @end table | |
33328 | ||
33329 | This packet is not probed by default; the remote stub must request it, | |
33330 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33331 | Use of this packet is controlled by the @code{set non-stop} command; | |
33332 | @pxref{Non-Stop Mode}. | |
33333 | ||
89be2091 DJ |
33334 | @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{} |
33335 | @cindex pass signals to inferior, remote request | |
33336 | @cindex @samp{QPassSignals} packet | |
23181151 | 33337 | @anchor{QPassSignals} |
89be2091 DJ |
33338 | Each listed @var{signal} should be passed directly to the inferior process. |
33339 | Signals are numbered identically to continue packets and stop replies | |
33340 | (@pxref{Stop Reply Packets}). Each @var{signal} list item should be | |
33341 | strictly greater than the previous item. These signals do not need to stop | |
33342 | the inferior, or be reported to @value{GDBN}. All other signals should be | |
33343 | reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not | |
33344 | combine; any earlier @samp{QPassSignals} list is completely replaced by the | |
33345 | new list. This packet improves performance when using @samp{handle | |
33346 | @var{signal} nostop noprint pass}. | |
33347 | ||
33348 | Reply: | |
33349 | @table @samp | |
33350 | @item OK | |
33351 | The request succeeded. | |
33352 | ||
33353 | @item E @var{nn} | |
33354 | An error occurred. @var{nn} are hex digits. | |
33355 | ||
33356 | @item | |
33357 | An empty reply indicates that @samp{QPassSignals} is not supported by | |
33358 | the stub. | |
33359 | @end table | |
33360 | ||
33361 | Use of this packet is controlled by the @code{set remote pass-signals} | |
79a6e687 | 33362 | command (@pxref{Remote Configuration, set remote pass-signals}). |
89be2091 DJ |
33363 | This packet is not probed by default; the remote stub must request it, |
33364 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33365 | ||
b8ff78ce | 33366 | @item qRcmd,@var{command} |
ff2587ec | 33367 | @cindex execute remote command, remote request |
b8ff78ce | 33368 | @cindex @samp{qRcmd} packet |
ff2587ec | 33369 | @var{command} (hex encoded) is passed to the local interpreter for |
b8ff78ce JB |
33370 | execution. Invalid commands should be reported using the output |
33371 | string. Before the final result packet, the target may also respond | |
33372 | with a number of intermediate @samp{O@var{output}} console output | |
33373 | packets. @emph{Implementors should note that providing access to a | |
33374 | stubs's interpreter may have security implications}. | |
fa93a9d8 | 33375 | |
ff2587ec WZ |
33376 | Reply: |
33377 | @table @samp | |
33378 | @item OK | |
33379 | A command response with no output. | |
33380 | @item @var{OUTPUT} | |
33381 | A command response with the hex encoded output string @var{OUTPUT}. | |
b8ff78ce | 33382 | @item E @var{NN} |
ff2587ec | 33383 | Indicate a badly formed request. |
b8ff78ce JB |
33384 | @item |
33385 | An empty reply indicates that @samp{qRcmd} is not recognized. | |
ff2587ec | 33386 | @end table |
fa93a9d8 | 33387 | |
aa56d27a JB |
33388 | (Note that the @code{qRcmd} packet's name is separated from the |
33389 | command by a @samp{,}, not a @samp{:}, contrary to the naming | |
33390 | conventions above. Please don't use this packet as a model for new | |
33391 | packets.) | |
33392 | ||
08388c79 DE |
33393 | @item qSearch:memory:@var{address};@var{length};@var{search-pattern} |
33394 | @cindex searching memory, in remote debugging | |
33395 | @cindex @samp{qSearch:memory} packet | |
33396 | @anchor{qSearch memory} | |
33397 | Search @var{length} bytes at @var{address} for @var{search-pattern}. | |
33398 | @var{address} and @var{length} are encoded in hex. | |
33399 | @var{search-pattern} is a sequence of bytes, hex encoded. | |
33400 | ||
33401 | Reply: | |
33402 | @table @samp | |
33403 | @item 0 | |
33404 | The pattern was not found. | |
33405 | @item 1,address | |
33406 | The pattern was found at @var{address}. | |
33407 | @item E @var{NN} | |
33408 | A badly formed request or an error was encountered while searching memory. | |
33409 | @item | |
33410 | An empty reply indicates that @samp{qSearch:memory} is not recognized. | |
33411 | @end table | |
33412 | ||
a6f3e723 SL |
33413 | @item QStartNoAckMode |
33414 | @cindex @samp{QStartNoAckMode} packet | |
33415 | @anchor{QStartNoAckMode} | |
33416 | Request that the remote stub disable the normal @samp{+}/@samp{-} | |
33417 | protocol acknowledgments (@pxref{Packet Acknowledgment}). | |
33418 | ||
33419 | Reply: | |
33420 | @table @samp | |
33421 | @item OK | |
33422 | The stub has switched to no-acknowledgment mode. | |
33423 | @value{GDBN} acknowledges this reponse, | |
33424 | but neither the stub nor @value{GDBN} shall send or expect further | |
33425 | @samp{+}/@samp{-} acknowledgments in the current connection. | |
33426 | @item | |
33427 | An empty reply indicates that the stub does not support no-acknowledgment mode. | |
33428 | @end table | |
33429 | ||
be2a5f71 DJ |
33430 | @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]} |
33431 | @cindex supported packets, remote query | |
33432 | @cindex features of the remote protocol | |
33433 | @cindex @samp{qSupported} packet | |
0876f84a | 33434 | @anchor{qSupported} |
be2a5f71 DJ |
33435 | Tell the remote stub about features supported by @value{GDBN}, and |
33436 | query the stub for features it supports. This packet allows | |
33437 | @value{GDBN} and the remote stub to take advantage of each others' | |
33438 | features. @samp{qSupported} also consolidates multiple feature probes | |
33439 | at startup, to improve @value{GDBN} performance---a single larger | |
33440 | packet performs better than multiple smaller probe packets on | |
33441 | high-latency links. Some features may enable behavior which must not | |
33442 | be on by default, e.g.@: because it would confuse older clients or | |
33443 | stubs. Other features may describe packets which could be | |
33444 | automatically probed for, but are not. These features must be | |
33445 | reported before @value{GDBN} will use them. This ``default | |
33446 | unsupported'' behavior is not appropriate for all packets, but it | |
33447 | helps to keep the initial connection time under control with new | |
33448 | versions of @value{GDBN} which support increasing numbers of packets. | |
33449 | ||
33450 | Reply: | |
33451 | @table @samp | |
33452 | @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{} | |
33453 | The stub supports or does not support each returned @var{stubfeature}, | |
33454 | depending on the form of each @var{stubfeature} (see below for the | |
33455 | possible forms). | |
33456 | @item | |
33457 | An empty reply indicates that @samp{qSupported} is not recognized, | |
33458 | or that no features needed to be reported to @value{GDBN}. | |
33459 | @end table | |
33460 | ||
33461 | The allowed forms for each feature (either a @var{gdbfeature} in the | |
33462 | @samp{qSupported} packet, or a @var{stubfeature} in the response) | |
33463 | are: | |
33464 | ||
33465 | @table @samp | |
33466 | @item @var{name}=@var{value} | |
33467 | The remote protocol feature @var{name} is supported, and associated | |
33468 | with the specified @var{value}. The format of @var{value} depends | |
33469 | on the feature, but it must not include a semicolon. | |
33470 | @item @var{name}+ | |
33471 | The remote protocol feature @var{name} is supported, and does not | |
33472 | need an associated value. | |
33473 | @item @var{name}- | |
33474 | The remote protocol feature @var{name} is not supported. | |
33475 | @item @var{name}? | |
33476 | The remote protocol feature @var{name} may be supported, and | |
33477 | @value{GDBN} should auto-detect support in some other way when it is | |
33478 | needed. This form will not be used for @var{gdbfeature} notifications, | |
33479 | but may be used for @var{stubfeature} responses. | |
33480 | @end table | |
33481 | ||
33482 | Whenever the stub receives a @samp{qSupported} request, the | |
33483 | supplied set of @value{GDBN} features should override any previous | |
33484 | request. This allows @value{GDBN} to put the stub in a known | |
33485 | state, even if the stub had previously been communicating with | |
33486 | a different version of @value{GDBN}. | |
33487 | ||
b90a069a SL |
33488 | The following values of @var{gdbfeature} (for the packet sent by @value{GDBN}) |
33489 | are defined: | |
33490 | ||
33491 | @table @samp | |
33492 | @item multiprocess | |
33493 | This feature indicates whether @value{GDBN} supports multiprocess | |
33494 | extensions to the remote protocol. @value{GDBN} does not use such | |
33495 | extensions unless the stub also reports that it supports them by | |
33496 | including @samp{multiprocess+} in its @samp{qSupported} reply. | |
33497 | @xref{multiprocess extensions}, for details. | |
c8d5aac9 L |
33498 | |
33499 | @item xmlRegisters | |
33500 | This feature indicates that @value{GDBN} supports the XML target | |
33501 | description. If the stub sees @samp{xmlRegisters=} with target | |
33502 | specific strings separated by a comma, it will report register | |
33503 | description. | |
dde08ee1 PA |
33504 | |
33505 | @item qRelocInsn | |
33506 | This feature indicates whether @value{GDBN} supports the | |
33507 | @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate | |
33508 | instruction reply packet}). | |
b90a069a SL |
33509 | @end table |
33510 | ||
33511 | Stubs should ignore any unknown values for | |
be2a5f71 DJ |
33512 | @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported} |
33513 | packet supports receiving packets of unlimited length (earlier | |
b90a069a | 33514 | versions of @value{GDBN} may reject overly long responses). Additional values |
be2a5f71 DJ |
33515 | for @var{gdbfeature} may be defined in the future to let the stub take |
33516 | advantage of new features in @value{GDBN}, e.g.@: incompatible | |
b90a069a SL |
33517 | improvements in the remote protocol---the @samp{multiprocess} feature is |
33518 | an example of such a feature. The stub's reply should be independent | |
be2a5f71 DJ |
33519 | of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN} |
33520 | describes all the features it supports, and then the stub replies with | |
33521 | all the features it supports. | |
33522 | ||
33523 | Similarly, @value{GDBN} will silently ignore unrecognized stub feature | |
33524 | responses, as long as each response uses one of the standard forms. | |
33525 | ||
33526 | Some features are flags. A stub which supports a flag feature | |
33527 | should respond with a @samp{+} form response. Other features | |
33528 | require values, and the stub should respond with an @samp{=} | |
33529 | form response. | |
33530 | ||
33531 | Each feature has a default value, which @value{GDBN} will use if | |
33532 | @samp{qSupported} is not available or if the feature is not mentioned | |
33533 | in the @samp{qSupported} response. The default values are fixed; a | |
33534 | stub is free to omit any feature responses that match the defaults. | |
33535 | ||
33536 | Not all features can be probed, but for those which can, the probing | |
33537 | mechanism is useful: in some cases, a stub's internal | |
33538 | architecture may not allow the protocol layer to know some information | |
33539 | about the underlying target in advance. This is especially common in | |
33540 | stubs which may be configured for multiple targets. | |
33541 | ||
33542 | These are the currently defined stub features and their properties: | |
33543 | ||
cfa9d6d9 | 33544 | @multitable @columnfractions 0.35 0.2 0.12 0.2 |
be2a5f71 DJ |
33545 | @c NOTE: The first row should be @headitem, but we do not yet require |
33546 | @c a new enough version of Texinfo (4.7) to use @headitem. | |
0876f84a | 33547 | @item Feature Name |
be2a5f71 DJ |
33548 | @tab Value Required |
33549 | @tab Default | |
33550 | @tab Probe Allowed | |
33551 | ||
33552 | @item @samp{PacketSize} | |
33553 | @tab Yes | |
33554 | @tab @samp{-} | |
33555 | @tab No | |
33556 | ||
0876f84a DJ |
33557 | @item @samp{qXfer:auxv:read} |
33558 | @tab No | |
33559 | @tab @samp{-} | |
33560 | @tab Yes | |
33561 | ||
23181151 DJ |
33562 | @item @samp{qXfer:features:read} |
33563 | @tab No | |
33564 | @tab @samp{-} | |
33565 | @tab Yes | |
33566 | ||
cfa9d6d9 DJ |
33567 | @item @samp{qXfer:libraries:read} |
33568 | @tab No | |
33569 | @tab @samp{-} | |
33570 | @tab Yes | |
33571 | ||
68437a39 DJ |
33572 | @item @samp{qXfer:memory-map:read} |
33573 | @tab No | |
33574 | @tab @samp{-} | |
33575 | @tab Yes | |
33576 | ||
0fb4aa4b PA |
33577 | @item @samp{qXfer:sdata:read} |
33578 | @tab No | |
33579 | @tab @samp{-} | |
33580 | @tab Yes | |
33581 | ||
0e7f50da UW |
33582 | @item @samp{qXfer:spu:read} |
33583 | @tab No | |
33584 | @tab @samp{-} | |
33585 | @tab Yes | |
33586 | ||
33587 | @item @samp{qXfer:spu:write} | |
33588 | @tab No | |
33589 | @tab @samp{-} | |
33590 | @tab Yes | |
33591 | ||
4aa995e1 PA |
33592 | @item @samp{qXfer:siginfo:read} |
33593 | @tab No | |
33594 | @tab @samp{-} | |
33595 | @tab Yes | |
33596 | ||
33597 | @item @samp{qXfer:siginfo:write} | |
33598 | @tab No | |
33599 | @tab @samp{-} | |
33600 | @tab Yes | |
33601 | ||
dc146f7c VP |
33602 | @item @samp{qXfer:threads:read} |
33603 | @tab No | |
33604 | @tab @samp{-} | |
33605 | @tab Yes | |
33606 | ||
b3b9301e PA |
33607 | @item @samp{qXfer:traceframe-info:read} |
33608 | @tab No | |
33609 | @tab @samp{-} | |
33610 | @tab Yes | |
33611 | ||
dc146f7c | 33612 | |
8b23ecc4 SL |
33613 | @item @samp{QNonStop} |
33614 | @tab No | |
33615 | @tab @samp{-} | |
33616 | @tab Yes | |
33617 | ||
89be2091 DJ |
33618 | @item @samp{QPassSignals} |
33619 | @tab No | |
33620 | @tab @samp{-} | |
33621 | @tab Yes | |
33622 | ||
a6f3e723 SL |
33623 | @item @samp{QStartNoAckMode} |
33624 | @tab No | |
33625 | @tab @samp{-} | |
33626 | @tab Yes | |
33627 | ||
b90a069a SL |
33628 | @item @samp{multiprocess} |
33629 | @tab No | |
33630 | @tab @samp{-} | |
33631 | @tab No | |
33632 | ||
782b2b07 SS |
33633 | @item @samp{ConditionalTracepoints} |
33634 | @tab No | |
33635 | @tab @samp{-} | |
33636 | @tab No | |
33637 | ||
0d772ac9 MS |
33638 | @item @samp{ReverseContinue} |
33639 | @tab No | |
2f8132f3 | 33640 | @tab @samp{-} |
0d772ac9 MS |
33641 | @tab No |
33642 | ||
33643 | @item @samp{ReverseStep} | |
33644 | @tab No | |
2f8132f3 | 33645 | @tab @samp{-} |
0d772ac9 MS |
33646 | @tab No |
33647 | ||
409873ef SS |
33648 | @item @samp{TracepointSource} |
33649 | @tab No | |
33650 | @tab @samp{-} | |
33651 | @tab No | |
33652 | ||
d914c394 SS |
33653 | @item @samp{QAllow} |
33654 | @tab No | |
33655 | @tab @samp{-} | |
33656 | @tab No | |
33657 | ||
d248b706 KY |
33658 | @item @samp{EnableDisableTracepoints} |
33659 | @tab No | |
33660 | @tab @samp{-} | |
33661 | @tab No | |
33662 | ||
be2a5f71 DJ |
33663 | @end multitable |
33664 | ||
33665 | These are the currently defined stub features, in more detail: | |
33666 | ||
33667 | @table @samp | |
33668 | @cindex packet size, remote protocol | |
33669 | @item PacketSize=@var{bytes} | |
33670 | The remote stub can accept packets up to at least @var{bytes} in | |
33671 | length. @value{GDBN} will send packets up to this size for bulk | |
33672 | transfers, and will never send larger packets. This is a limit on the | |
33673 | data characters in the packet, including the frame and checksum. | |
33674 | There is no trailing NUL byte in a remote protocol packet; if the stub | |
33675 | stores packets in a NUL-terminated format, it should allow an extra | |
33676 | byte in its buffer for the NUL. If this stub feature is not supported, | |
33677 | @value{GDBN} guesses based on the size of the @samp{g} packet response. | |
33678 | ||
0876f84a DJ |
33679 | @item qXfer:auxv:read |
33680 | The remote stub understands the @samp{qXfer:auxv:read} packet | |
33681 | (@pxref{qXfer auxiliary vector read}). | |
33682 | ||
23181151 DJ |
33683 | @item qXfer:features:read |
33684 | The remote stub understands the @samp{qXfer:features:read} packet | |
33685 | (@pxref{qXfer target description read}). | |
33686 | ||
cfa9d6d9 DJ |
33687 | @item qXfer:libraries:read |
33688 | The remote stub understands the @samp{qXfer:libraries:read} packet | |
33689 | (@pxref{qXfer library list read}). | |
33690 | ||
23181151 DJ |
33691 | @item qXfer:memory-map:read |
33692 | The remote stub understands the @samp{qXfer:memory-map:read} packet | |
33693 | (@pxref{qXfer memory map read}). | |
33694 | ||
0fb4aa4b PA |
33695 | @item qXfer:sdata:read |
33696 | The remote stub understands the @samp{qXfer:sdata:read} packet | |
33697 | (@pxref{qXfer sdata read}). | |
33698 | ||
0e7f50da UW |
33699 | @item qXfer:spu:read |
33700 | The remote stub understands the @samp{qXfer:spu:read} packet | |
33701 | (@pxref{qXfer spu read}). | |
33702 | ||
33703 | @item qXfer:spu:write | |
33704 | The remote stub understands the @samp{qXfer:spu:write} packet | |
33705 | (@pxref{qXfer spu write}). | |
33706 | ||
4aa995e1 PA |
33707 | @item qXfer:siginfo:read |
33708 | The remote stub understands the @samp{qXfer:siginfo:read} packet | |
33709 | (@pxref{qXfer siginfo read}). | |
33710 | ||
33711 | @item qXfer:siginfo:write | |
33712 | The remote stub understands the @samp{qXfer:siginfo:write} packet | |
33713 | (@pxref{qXfer siginfo write}). | |
33714 | ||
dc146f7c VP |
33715 | @item qXfer:threads:read |
33716 | The remote stub understands the @samp{qXfer:threads:read} packet | |
33717 | (@pxref{qXfer threads read}). | |
33718 | ||
b3b9301e PA |
33719 | @item qXfer:traceframe-info:read |
33720 | The remote stub understands the @samp{qXfer:traceframe-info:read} | |
33721 | packet (@pxref{qXfer traceframe info read}). | |
33722 | ||
8b23ecc4 SL |
33723 | @item QNonStop |
33724 | The remote stub understands the @samp{QNonStop} packet | |
33725 | (@pxref{QNonStop}). | |
33726 | ||
23181151 DJ |
33727 | @item QPassSignals |
33728 | The remote stub understands the @samp{QPassSignals} packet | |
33729 | (@pxref{QPassSignals}). | |
33730 | ||
a6f3e723 SL |
33731 | @item QStartNoAckMode |
33732 | The remote stub understands the @samp{QStartNoAckMode} packet and | |
33733 | prefers to operate in no-acknowledgment mode. @xref{Packet Acknowledgment}. | |
33734 | ||
b90a069a SL |
33735 | @item multiprocess |
33736 | @anchor{multiprocess extensions} | |
33737 | @cindex multiprocess extensions, in remote protocol | |
33738 | The remote stub understands the multiprocess extensions to the remote | |
33739 | protocol syntax. The multiprocess extensions affect the syntax of | |
33740 | thread IDs in both packets and replies (@pxref{thread-id syntax}), and | |
33741 | add process IDs to the @samp{D} packet and @samp{W} and @samp{X} | |
33742 | replies. Note that reporting this feature indicates support for the | |
33743 | syntactic extensions only, not that the stub necessarily supports | |
33744 | debugging of more than one process at a time. The stub must not use | |
33745 | multiprocess extensions in packet replies unless @value{GDBN} has also | |
33746 | indicated it supports them in its @samp{qSupported} request. | |
33747 | ||
07e059b5 VP |
33748 | @item qXfer:osdata:read |
33749 | The remote stub understands the @samp{qXfer:osdata:read} packet | |
33750 | ((@pxref{qXfer osdata read}). | |
33751 | ||
782b2b07 SS |
33752 | @item ConditionalTracepoints |
33753 | The remote stub accepts and implements conditional expressions defined | |
33754 | for tracepoints (@pxref{Tracepoint Conditions}). | |
33755 | ||
0d772ac9 MS |
33756 | @item ReverseContinue |
33757 | The remote stub accepts and implements the reverse continue packet | |
33758 | (@pxref{bc}). | |
33759 | ||
33760 | @item ReverseStep | |
33761 | The remote stub accepts and implements the reverse step packet | |
33762 | (@pxref{bs}). | |
33763 | ||
409873ef SS |
33764 | @item TracepointSource |
33765 | The remote stub understands the @samp{QTDPsrc} packet that supplies | |
33766 | the source form of tracepoint definitions. | |
33767 | ||
d914c394 SS |
33768 | @item QAllow |
33769 | The remote stub understands the @samp{QAllow} packet. | |
33770 | ||
0fb4aa4b PA |
33771 | @item StaticTracepoint |
33772 | @cindex static tracepoints, in remote protocol | |
33773 | The remote stub supports static tracepoints. | |
33774 | ||
d248b706 KY |
33775 | @item EnableDisableTracepoints |
33776 | The remote stub supports the @samp{QTEnable} (@pxref{QTEnable}) and | |
33777 | @samp{QTDisable} (@pxref{QTDisable}) packets that allow tracepoints | |
33778 | to be enabled and disabled while a trace experiment is running. | |
33779 | ||
be2a5f71 DJ |
33780 | @end table |
33781 | ||
b8ff78ce | 33782 | @item qSymbol:: |
ff2587ec | 33783 | @cindex symbol lookup, remote request |
b8ff78ce | 33784 | @cindex @samp{qSymbol} packet |
ff2587ec WZ |
33785 | Notify the target that @value{GDBN} is prepared to serve symbol lookup |
33786 | requests. Accept requests from the target for the values of symbols. | |
fa93a9d8 JB |
33787 | |
33788 | Reply: | |
ff2587ec | 33789 | @table @samp |
b8ff78ce | 33790 | @item OK |
ff2587ec | 33791 | The target does not need to look up any (more) symbols. |
b8ff78ce | 33792 | @item qSymbol:@var{sym_name} |
ff2587ec WZ |
33793 | The target requests the value of symbol @var{sym_name} (hex encoded). |
33794 | @value{GDBN} may provide the value by using the | |
b8ff78ce JB |
33795 | @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described |
33796 | below. | |
ff2587ec | 33797 | @end table |
83761cbd | 33798 | |
b8ff78ce | 33799 | @item qSymbol:@var{sym_value}:@var{sym_name} |
ff2587ec WZ |
33800 | Set the value of @var{sym_name} to @var{sym_value}. |
33801 | ||
33802 | @var{sym_name} (hex encoded) is the name of a symbol whose value the | |
33803 | target has previously requested. | |
33804 | ||
33805 | @var{sym_value} (hex) is the value for symbol @var{sym_name}. If | |
33806 | @value{GDBN} cannot supply a value for @var{sym_name}, then this field | |
33807 | will be empty. | |
33808 | ||
33809 | Reply: | |
33810 | @table @samp | |
b8ff78ce | 33811 | @item OK |
ff2587ec | 33812 | The target does not need to look up any (more) symbols. |
b8ff78ce | 33813 | @item qSymbol:@var{sym_name} |
ff2587ec WZ |
33814 | The target requests the value of a new symbol @var{sym_name} (hex |
33815 | encoded). @value{GDBN} will continue to supply the values of symbols | |
33816 | (if available), until the target ceases to request them. | |
fa93a9d8 | 33817 | @end table |
0abb7bc7 | 33818 | |
00bf0b85 | 33819 | @item qTBuffer |
4daf5ac0 | 33820 | @item QTBuffer |
d5551862 SS |
33821 | @item QTDisconnected |
33822 | @itemx QTDP | |
409873ef | 33823 | @itemx QTDPsrc |
d5551862 | 33824 | @itemx QTDV |
00bf0b85 SS |
33825 | @itemx qTfP |
33826 | @itemx qTfV | |
9d29849a JB |
33827 | @itemx QTFrame |
33828 | @xref{Tracepoint Packets}. | |
33829 | ||
b90a069a | 33830 | @item qThreadExtraInfo,@var{thread-id} |
ff2587ec | 33831 | @cindex thread attributes info, remote request |
b8ff78ce JB |
33832 | @cindex @samp{qThreadExtraInfo} packet |
33833 | Obtain a printable string description of a thread's attributes from | |
b90a069a SL |
33834 | the target OS. @var{thread-id} is a thread ID; |
33835 | see @ref{thread-id syntax}. This | |
b8ff78ce JB |
33836 | string may contain anything that the target OS thinks is interesting |
33837 | for @value{GDBN} to tell the user about the thread. The string is | |
33838 | displayed in @value{GDBN}'s @code{info threads} display. Some | |
33839 | examples of possible thread extra info strings are @samp{Runnable}, or | |
33840 | @samp{Blocked on Mutex}. | |
ff2587ec WZ |
33841 | |
33842 | Reply: | |
33843 | @table @samp | |
b8ff78ce JB |
33844 | @item @var{XX}@dots{} |
33845 | Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data, | |
33846 | comprising the printable string containing the extra information about | |
33847 | the thread's attributes. | |
ff2587ec | 33848 | @end table |
814e32d7 | 33849 | |
aa56d27a JB |
33850 | (Note that the @code{qThreadExtraInfo} packet's name is separated from |
33851 | the command by a @samp{,}, not a @samp{:}, contrary to the naming | |
33852 | conventions above. Please don't use this packet as a model for new | |
33853 | packets.) | |
33854 | ||
00bf0b85 SS |
33855 | @item QTSave |
33856 | @item qTsP | |
33857 | @item qTsV | |
d5551862 | 33858 | @itemx QTStart |
9d29849a | 33859 | @itemx QTStop |
d248b706 KY |
33860 | @itemx QTEnable |
33861 | @itemx QTDisable | |
9d29849a JB |
33862 | @itemx QTinit |
33863 | @itemx QTro | |
33864 | @itemx qTStatus | |
d5551862 | 33865 | @itemx qTV |
0fb4aa4b PA |
33866 | @itemx qTfSTM |
33867 | @itemx qTsSTM | |
33868 | @itemx qTSTMat | |
9d29849a JB |
33869 | @xref{Tracepoint Packets}. |
33870 | ||
0876f84a DJ |
33871 | @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length} |
33872 | @cindex read special object, remote request | |
33873 | @cindex @samp{qXfer} packet | |
68437a39 | 33874 | @anchor{qXfer read} |
0876f84a DJ |
33875 | Read uninterpreted bytes from the target's special data area |
33876 | identified by the keyword @var{object}. Request @var{length} bytes | |
33877 | starting at @var{offset} bytes into the data. The content and | |
0e7f50da | 33878 | encoding of @var{annex} is specific to @var{object}; it can supply |
0876f84a DJ |
33879 | additional details about what data to access. |
33880 | ||
33881 | Here are the specific requests of this form defined so far. All | |
33882 | @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply | |
33883 | formats, listed below. | |
33884 | ||
33885 | @table @samp | |
33886 | @item qXfer:auxv:read::@var{offset},@var{length} | |
33887 | @anchor{qXfer auxiliary vector read} | |
33888 | Access the target's @dfn{auxiliary vector}. @xref{OS Information, | |
427c3a89 | 33889 | auxiliary vector}. Note @var{annex} must be empty. |
0876f84a DJ |
33890 | |
33891 | This packet is not probed by default; the remote stub must request it, | |
89be2091 | 33892 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
0876f84a | 33893 | |
23181151 DJ |
33894 | @item qXfer:features:read:@var{annex}:@var{offset},@var{length} |
33895 | @anchor{qXfer target description read} | |
33896 | Access the @dfn{target description}. @xref{Target Descriptions}. The | |
33897 | annex specifies which XML document to access. The main description is | |
33898 | always loaded from the @samp{target.xml} annex. | |
33899 | ||
33900 | This packet is not probed by default; the remote stub must request it, | |
33901 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33902 | ||
cfa9d6d9 DJ |
33903 | @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length} |
33904 | @anchor{qXfer library list read} | |
33905 | Access the target's list of loaded libraries. @xref{Library List Format}. | |
33906 | The annex part of the generic @samp{qXfer} packet must be empty | |
33907 | (@pxref{qXfer read}). | |
33908 | ||
33909 | Targets which maintain a list of libraries in the program's memory do | |
33910 | not need to implement this packet; it is designed for platforms where | |
33911 | the operating system manages the list of loaded libraries. | |
33912 | ||
33913 | This packet is not probed by default; the remote stub must request it, | |
33914 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33915 | ||
68437a39 DJ |
33916 | @item qXfer:memory-map:read::@var{offset},@var{length} |
33917 | @anchor{qXfer memory map read} | |
79a6e687 | 33918 | Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The |
68437a39 DJ |
33919 | annex part of the generic @samp{qXfer} packet must be empty |
33920 | (@pxref{qXfer read}). | |
33921 | ||
0e7f50da UW |
33922 | This packet is not probed by default; the remote stub must request it, |
33923 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33924 | ||
0fb4aa4b PA |
33925 | @item qXfer:sdata:read::@var{offset},@var{length} |
33926 | @anchor{qXfer sdata read} | |
33927 | ||
33928 | Read contents of the extra collected static tracepoint marker | |
33929 | information. The annex part of the generic @samp{qXfer} packet must | |
33930 | be empty (@pxref{qXfer read}). @xref{Tracepoint Actions,,Tracepoint | |
33931 | Action Lists}. | |
33932 | ||
33933 | This packet is not probed by default; the remote stub must request it, | |
33934 | by supplying an appropriate @samp{qSupported} response | |
33935 | (@pxref{qSupported}). | |
33936 | ||
4aa995e1 PA |
33937 | @item qXfer:siginfo:read::@var{offset},@var{length} |
33938 | @anchor{qXfer siginfo read} | |
33939 | Read contents of the extra signal information on the target | |
33940 | system. The annex part of the generic @samp{qXfer} packet must be | |
33941 | empty (@pxref{qXfer read}). | |
33942 | ||
33943 | This packet is not probed by default; the remote stub must request it, | |
33944 | by supplying an appropriate @samp{qSupported} response | |
33945 | (@pxref{qSupported}). | |
33946 | ||
0e7f50da UW |
33947 | @item qXfer:spu:read:@var{annex}:@var{offset},@var{length} |
33948 | @anchor{qXfer spu read} | |
33949 | Read contents of an @code{spufs} file on the target system. The | |
33950 | annex specifies which file to read; it must be of the form | |
33951 | @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID | |
33952 | in the target process, and @var{name} identifes the @code{spufs} file | |
33953 | in that context to be accessed. | |
33954 | ||
68437a39 | 33955 | This packet is not probed by default; the remote stub must request it, |
07e059b5 VP |
33956 | by supplying an appropriate @samp{qSupported} response |
33957 | (@pxref{qSupported}). | |
33958 | ||
dc146f7c VP |
33959 | @item qXfer:threads:read::@var{offset},@var{length} |
33960 | @anchor{qXfer threads read} | |
33961 | Access the list of threads on target. @xref{Thread List Format}. The | |
33962 | annex part of the generic @samp{qXfer} packet must be empty | |
33963 | (@pxref{qXfer read}). | |
33964 | ||
33965 | This packet is not probed by default; the remote stub must request it, | |
33966 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33967 | ||
b3b9301e PA |
33968 | @item qXfer:traceframe-info:read::@var{offset},@var{length} |
33969 | @anchor{qXfer traceframe info read} | |
33970 | ||
33971 | Return a description of the current traceframe's contents. | |
33972 | @xref{Traceframe Info Format}. The annex part of the generic | |
33973 | @samp{qXfer} packet must be empty (@pxref{qXfer read}). | |
33974 | ||
33975 | This packet is not probed by default; the remote stub must request it, | |
33976 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
33977 | ||
07e059b5 VP |
33978 | @item qXfer:osdata:read::@var{offset},@var{length} |
33979 | @anchor{qXfer osdata read} | |
33980 | Access the target's @dfn{operating system information}. | |
33981 | @xref{Operating System Information}. | |
33982 | ||
68437a39 DJ |
33983 | @end table |
33984 | ||
0876f84a DJ |
33985 | Reply: |
33986 | @table @samp | |
33987 | @item m @var{data} | |
33988 | Data @var{data} (@pxref{Binary Data}) has been read from the | |
33989 | target. There may be more data at a higher address (although | |
33990 | it is permitted to return @samp{m} even for the last valid | |
33991 | block of data, as long as at least one byte of data was read). | |
33992 | @var{data} may have fewer bytes than the @var{length} in the | |
33993 | request. | |
33994 | ||
33995 | @item l @var{data} | |
33996 | Data @var{data} (@pxref{Binary Data}) has been read from the target. | |
33997 | There is no more data to be read. @var{data} may have fewer bytes | |
33998 | than the @var{length} in the request. | |
33999 | ||
34000 | @item l | |
34001 | The @var{offset} in the request is at the end of the data. | |
34002 | There is no more data to be read. | |
34003 | ||
34004 | @item E00 | |
34005 | The request was malformed, or @var{annex} was invalid. | |
34006 | ||
34007 | @item E @var{nn} | |
34008 | The offset was invalid, or there was an error encountered reading the data. | |
34009 | @var{nn} is a hex-encoded @code{errno} value. | |
34010 | ||
34011 | @item | |
34012 | An empty reply indicates the @var{object} string was not recognized by | |
34013 | the stub, or that the object does not support reading. | |
34014 | @end table | |
34015 | ||
34016 | @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{} | |
34017 | @cindex write data into object, remote request | |
4aa995e1 | 34018 | @anchor{qXfer write} |
0876f84a DJ |
34019 | Write uninterpreted bytes into the target's special data area |
34020 | identified by the keyword @var{object}, starting at @var{offset} bytes | |
0e7f50da | 34021 | into the data. @var{data}@dots{} is the binary-encoded data |
0876f84a | 34022 | (@pxref{Binary Data}) to be written. The content and encoding of @var{annex} |
0e7f50da | 34023 | is specific to @var{object}; it can supply additional details about what data |
0876f84a DJ |
34024 | to access. |
34025 | ||
0e7f50da UW |
34026 | Here are the specific requests of this form defined so far. All |
34027 | @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply | |
34028 | formats, listed below. | |
34029 | ||
34030 | @table @samp | |
4aa995e1 PA |
34031 | @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{} |
34032 | @anchor{qXfer siginfo write} | |
34033 | Write @var{data} to the extra signal information on the target system. | |
34034 | The annex part of the generic @samp{qXfer} packet must be | |
34035 | empty (@pxref{qXfer write}). | |
34036 | ||
34037 | This packet is not probed by default; the remote stub must request it, | |
34038 | by supplying an appropriate @samp{qSupported} response | |
34039 | (@pxref{qSupported}). | |
34040 | ||
84fcdf95 | 34041 | @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{} |
0e7f50da UW |
34042 | @anchor{qXfer spu write} |
34043 | Write @var{data} to an @code{spufs} file on the target system. The | |
34044 | annex specifies which file to write; it must be of the form | |
34045 | @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID | |
34046 | in the target process, and @var{name} identifes the @code{spufs} file | |
34047 | in that context to be accessed. | |
34048 | ||
34049 | This packet is not probed by default; the remote stub must request it, | |
34050 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34051 | @end table | |
0876f84a DJ |
34052 | |
34053 | Reply: | |
34054 | @table @samp | |
34055 | @item @var{nn} | |
34056 | @var{nn} (hex encoded) is the number of bytes written. | |
34057 | This may be fewer bytes than supplied in the request. | |
34058 | ||
34059 | @item E00 | |
34060 | The request was malformed, or @var{annex} was invalid. | |
34061 | ||
34062 | @item E @var{nn} | |
34063 | The offset was invalid, or there was an error encountered writing the data. | |
34064 | @var{nn} is a hex-encoded @code{errno} value. | |
34065 | ||
34066 | @item | |
34067 | An empty reply indicates the @var{object} string was not | |
34068 | recognized by the stub, or that the object does not support writing. | |
34069 | @end table | |
34070 | ||
34071 | @item qXfer:@var{object}:@var{operation}:@dots{} | |
34072 | Requests of this form may be added in the future. When a stub does | |
34073 | not recognize the @var{object} keyword, or its support for | |
34074 | @var{object} does not recognize the @var{operation} keyword, the stub | |
34075 | must respond with an empty packet. | |
34076 | ||
0b16c5cf PA |
34077 | @item qAttached:@var{pid} |
34078 | @cindex query attached, remote request | |
34079 | @cindex @samp{qAttached} packet | |
34080 | Return an indication of whether the remote server attached to an | |
34081 | existing process or created a new process. When the multiprocess | |
34082 | protocol extensions are supported (@pxref{multiprocess extensions}), | |
34083 | @var{pid} is an integer in hexadecimal format identifying the target | |
34084 | process. Otherwise, @value{GDBN} will omit the @var{pid} field and | |
34085 | the query packet will be simplified as @samp{qAttached}. | |
34086 | ||
34087 | This query is used, for example, to know whether the remote process | |
34088 | should be detached or killed when a @value{GDBN} session is ended with | |
34089 | the @code{quit} command. | |
34090 | ||
34091 | Reply: | |
34092 | @table @samp | |
34093 | @item 1 | |
34094 | The remote server attached to an existing process. | |
34095 | @item 0 | |
34096 | The remote server created a new process. | |
34097 | @item E @var{NN} | |
34098 | A badly formed request or an error was encountered. | |
34099 | @end table | |
34100 | ||
ee2d5c50 AC |
34101 | @end table |
34102 | ||
a1dcb23a DJ |
34103 | @node Architecture-Specific Protocol Details |
34104 | @section Architecture-Specific Protocol Details | |
34105 | ||
34106 | This section describes how the remote protocol is applied to specific | |
34107 | target architectures. Also see @ref{Standard Target Features}, for | |
34108 | details of XML target descriptions for each architecture. | |
34109 | ||
34110 | @subsection ARM | |
34111 | ||
34112 | @subsubsection Breakpoint Kinds | |
34113 | ||
34114 | These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets. | |
34115 | ||
34116 | @table @r | |
34117 | ||
34118 | @item 2 | |
34119 | 16-bit Thumb mode breakpoint. | |
34120 | ||
34121 | @item 3 | |
34122 | 32-bit Thumb mode (Thumb-2) breakpoint. | |
34123 | ||
34124 | @item 4 | |
34125 | 32-bit ARM mode breakpoint. | |
34126 | ||
34127 | @end table | |
34128 | ||
34129 | @subsection MIPS | |
34130 | ||
34131 | @subsubsection Register Packet Format | |
eb12ee30 | 34132 | |
b8ff78ce | 34133 | The following @code{g}/@code{G} packets have previously been defined. |
ee2d5c50 AC |
34134 | In the below, some thirty-two bit registers are transferred as |
34135 | sixty-four bits. Those registers should be zero/sign extended (which?) | |
599b237a BW |
34136 | to fill the space allocated. Register bytes are transferred in target |
34137 | byte order. The two nibbles within a register byte are transferred | |
ee2d5c50 | 34138 | most-significant - least-significant. |
eb12ee30 | 34139 | |
ee2d5c50 | 34140 | @table @r |
eb12ee30 | 34141 | |
8e04817f | 34142 | @item MIPS32 |
ee2d5c50 | 34143 | |
599b237a | 34144 | All registers are transferred as thirty-two bit quantities in the order: |
8e04817f AC |
34145 | 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point |
34146 | registers; fsr; fir; fp. | |
eb12ee30 | 34147 | |
8e04817f | 34148 | @item MIPS64 |
ee2d5c50 | 34149 | |
599b237a | 34150 | All registers are transferred as sixty-four bit quantities (including |
8e04817f AC |
34151 | thirty-two bit registers such as @code{sr}). The ordering is the same |
34152 | as @code{MIPS32}. | |
eb12ee30 | 34153 | |
ee2d5c50 AC |
34154 | @end table |
34155 | ||
9d29849a JB |
34156 | @node Tracepoint Packets |
34157 | @section Tracepoint Packets | |
34158 | @cindex tracepoint packets | |
34159 | @cindex packets, tracepoint | |
34160 | ||
34161 | Here we describe the packets @value{GDBN} uses to implement | |
34162 | tracepoints (@pxref{Tracepoints}). | |
34163 | ||
34164 | @table @samp | |
34165 | ||
7a697b8d | 34166 | @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]} |
9d29849a JB |
34167 | Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena} |
34168 | is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then | |
34169 | the tracepoint is disabled. @var{step} is the tracepoint's step | |
7a697b8d SS |
34170 | count, and @var{pass} is its pass count. If an @samp{F} is present, |
34171 | then the tracepoint is to be a fast tracepoint, and the @var{flen} is | |
34172 | the number of bytes that the target should copy elsewhere to make room | |
34173 | for the tracepoint. If an @samp{X} is present, it introduces a | |
34174 | tracepoint condition, which consists of a hexadecimal length, followed | |
34175 | by a comma and hex-encoded bytes, in a manner similar to action | |
34176 | encodings as described below. If the trailing @samp{-} is present, | |
34177 | further @samp{QTDP} packets will follow to specify this tracepoint's | |
34178 | actions. | |
9d29849a JB |
34179 | |
34180 | Replies: | |
34181 | @table @samp | |
34182 | @item OK | |
34183 | The packet was understood and carried out. | |
dde08ee1 PA |
34184 | @item qRelocInsn |
34185 | @xref{Tracepoint Packets,,Relocate instruction reply packet}. | |
9d29849a JB |
34186 | @item |
34187 | The packet was not recognized. | |
34188 | @end table | |
34189 | ||
34190 | @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]} | |
34191 | Define actions to be taken when a tracepoint is hit. @var{n} and | |
34192 | @var{addr} must be the same as in the initial @samp{QTDP} packet for | |
34193 | this tracepoint. This packet may only be sent immediately after | |
34194 | another @samp{QTDP} packet that ended with a @samp{-}. If the | |
34195 | trailing @samp{-} is present, further @samp{QTDP} packets will follow, | |
34196 | specifying more actions for this tracepoint. | |
34197 | ||
34198 | In the series of action packets for a given tracepoint, at most one | |
34199 | can have an @samp{S} before its first @var{action}. If such a packet | |
34200 | is sent, it and the following packets define ``while-stepping'' | |
34201 | actions. Any prior packets define ordinary actions --- that is, those | |
34202 | taken when the tracepoint is first hit. If no action packet has an | |
34203 | @samp{S}, then all the packets in the series specify ordinary | |
34204 | tracepoint actions. | |
34205 | ||
34206 | The @samp{@var{action}@dots{}} portion of the packet is a series of | |
34207 | actions, concatenated without separators. Each action has one of the | |
34208 | following forms: | |
34209 | ||
34210 | @table @samp | |
34211 | ||
34212 | @item R @var{mask} | |
34213 | Collect the registers whose bits are set in @var{mask}. @var{mask} is | |
599b237a | 34214 | a hexadecimal number whose @var{i}'th bit is set if register number |
9d29849a JB |
34215 | @var{i} should be collected. (The least significant bit is numbered |
34216 | zero.) Note that @var{mask} may be any number of digits long; it may | |
34217 | not fit in a 32-bit word. | |
34218 | ||
34219 | @item M @var{basereg},@var{offset},@var{len} | |
34220 | Collect @var{len} bytes of memory starting at the address in register | |
34221 | number @var{basereg}, plus @var{offset}. If @var{basereg} is | |
34222 | @samp{-1}, then the range has a fixed address: @var{offset} is the | |
34223 | address of the lowest byte to collect. The @var{basereg}, | |
599b237a | 34224 | @var{offset}, and @var{len} parameters are all unsigned hexadecimal |
9d29849a JB |
34225 | values (the @samp{-1} value for @var{basereg} is a special case). |
34226 | ||
34227 | @item X @var{len},@var{expr} | |
34228 | Evaluate @var{expr}, whose length is @var{len}, and collect memory as | |
34229 | it directs. @var{expr} is an agent expression, as described in | |
34230 | @ref{Agent Expressions}. Each byte of the expression is encoded as a | |
34231 | two-digit hex number in the packet; @var{len} is the number of bytes | |
34232 | in the expression (and thus one-half the number of hex digits in the | |
34233 | packet). | |
34234 | ||
34235 | @end table | |
34236 | ||
34237 | Any number of actions may be packed together in a single @samp{QTDP} | |
34238 | packet, as long as the packet does not exceed the maximum packet | |
c1947b85 JB |
34239 | length (400 bytes, for many stubs). There may be only one @samp{R} |
34240 | action per tracepoint, and it must precede any @samp{M} or @samp{X} | |
34241 | actions. Any registers referred to by @samp{M} and @samp{X} actions | |
34242 | must be collected by a preceding @samp{R} action. (The | |
34243 | ``while-stepping'' actions are treated as if they were attached to a | |
34244 | separate tracepoint, as far as these restrictions are concerned.) | |
9d29849a JB |
34245 | |
34246 | Replies: | |
34247 | @table @samp | |
34248 | @item OK | |
34249 | The packet was understood and carried out. | |
dde08ee1 PA |
34250 | @item qRelocInsn |
34251 | @xref{Tracepoint Packets,,Relocate instruction reply packet}. | |
9d29849a JB |
34252 | @item |
34253 | The packet was not recognized. | |
34254 | @end table | |
34255 | ||
409873ef SS |
34256 | @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes} |
34257 | @cindex @samp{QTDPsrc} packet | |
34258 | Specify a source string of tracepoint @var{n} at address @var{addr}. | |
34259 | This is useful to get accurate reproduction of the tracepoints | |
34260 | originally downloaded at the beginning of the trace run. @var{type} | |
34261 | is the name of the tracepoint part, such as @samp{cond} for the | |
34262 | tracepoint's conditional expression (see below for a list of types), while | |
34263 | @var{bytes} is the string, encoded in hexadecimal. | |
34264 | ||
34265 | @var{start} is the offset of the @var{bytes} within the overall source | |
34266 | string, while @var{slen} is the total length of the source string. | |
34267 | This is intended for handling source strings that are longer than will | |
34268 | fit in a single packet. | |
34269 | @c Add detailed example when this info is moved into a dedicated | |
34270 | @c tracepoint descriptions section. | |
34271 | ||
34272 | The available string types are @samp{at} for the location, | |
34273 | @samp{cond} for the conditional, and @samp{cmd} for an action command. | |
34274 | @value{GDBN} sends a separate packet for each command in the action | |
34275 | list, in the same order in which the commands are stored in the list. | |
34276 | ||
34277 | The target does not need to do anything with source strings except | |
34278 | report them back as part of the replies to the @samp{qTfP}/@samp{qTsP} | |
34279 | query packets. | |
34280 | ||
34281 | Although this packet is optional, and @value{GDBN} will only send it | |
34282 | if the target replies with @samp{TracepointSource} @xref{General | |
34283 | Query Packets}, it makes both disconnected tracing and trace files | |
34284 | much easier to use. Otherwise the user must be careful that the | |
34285 | tracepoints in effect while looking at trace frames are identical to | |
34286 | the ones in effect during the trace run; even a small discrepancy | |
34287 | could cause @samp{tdump} not to work, or a particular trace frame not | |
34288 | be found. | |
34289 | ||
f61e138d SS |
34290 | @item QTDV:@var{n}:@var{value} |
34291 | @cindex define trace state variable, remote request | |
34292 | @cindex @samp{QTDV} packet | |
34293 | Create a new trace state variable, number @var{n}, with an initial | |
34294 | value of @var{value}, which is a 64-bit signed integer. Both @var{n} | |
34295 | and @var{value} are encoded as hexadecimal values. @value{GDBN} has | |
34296 | the option of not using this packet for initial values of zero; the | |
34297 | target should simply create the trace state variables as they are | |
34298 | mentioned in expressions. | |
34299 | ||
9d29849a JB |
34300 | @item QTFrame:@var{n} |
34301 | Select the @var{n}'th tracepoint frame from the buffer, and use the | |
34302 | register and memory contents recorded there to answer subsequent | |
34303 | request packets from @value{GDBN}. | |
34304 | ||
34305 | A successful reply from the stub indicates that the stub has found the | |
34306 | requested frame. The response is a series of parts, concatenated | |
34307 | without separators, describing the frame we selected. Each part has | |
34308 | one of the following forms: | |
34309 | ||
34310 | @table @samp | |
34311 | @item F @var{f} | |
34312 | The selected frame is number @var{n} in the trace frame buffer; | |
599b237a | 34313 | @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there |
9d29849a JB |
34314 | was no frame matching the criteria in the request packet. |
34315 | ||
34316 | @item T @var{t} | |
34317 | The selected trace frame records a hit of tracepoint number @var{t}; | |
599b237a | 34318 | @var{t} is a hexadecimal number. |
9d29849a JB |
34319 | |
34320 | @end table | |
34321 | ||
34322 | @item QTFrame:pc:@var{addr} | |
34323 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the | |
34324 | currently selected frame whose PC is @var{addr}; | |
599b237a | 34325 | @var{addr} is a hexadecimal number. |
9d29849a JB |
34326 | |
34327 | @item QTFrame:tdp:@var{t} | |
34328 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the | |
34329 | currently selected frame that is a hit of tracepoint @var{t}; @var{t} | |
599b237a | 34330 | is a hexadecimal number. |
9d29849a JB |
34331 | |
34332 | @item QTFrame:range:@var{start}:@var{end} | |
34333 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the | |
34334 | currently selected frame whose PC is between @var{start} (inclusive) | |
081dfbf7 | 34335 | and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal |
9d29849a JB |
34336 | numbers. |
34337 | ||
34338 | @item QTFrame:outside:@var{start}:@var{end} | |
34339 | Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first | |
081dfbf7 | 34340 | frame @emph{outside} the given range of addresses (exclusive). |
9d29849a JB |
34341 | |
34342 | @item QTStart | |
dde08ee1 PA |
34343 | Begin the tracepoint experiment. Begin collecting data from |
34344 | tracepoint hits in the trace frame buffer. This packet supports the | |
34345 | @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate | |
34346 | instruction reply packet}). | |
9d29849a JB |
34347 | |
34348 | @item QTStop | |
34349 | End the tracepoint experiment. Stop collecting trace frames. | |
34350 | ||
d248b706 KY |
34351 | @item QTEnable:@var{n}:@var{addr} |
34352 | @anchor{QTEnable} | |
34353 | Enable tracepoint @var{n} at address @var{addr} in a started tracepoint | |
34354 | experiment. If the tracepoint was previously disabled, then collection | |
34355 | of data from it will resume. | |
34356 | ||
34357 | @item QTDisable:@var{n}:@var{addr} | |
34358 | @anchor{QTDisable} | |
34359 | Disable tracepoint @var{n} at address @var{addr} in a started tracepoint | |
34360 | experiment. No more data will be collected from the tracepoint unless | |
34361 | @samp{QTEnable:@var{n}:@var{addr}} is subsequently issued. | |
34362 | ||
9d29849a JB |
34363 | @item QTinit |
34364 | Clear the table of tracepoints, and empty the trace frame buffer. | |
34365 | ||
34366 | @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{} | |
34367 | Establish the given ranges of memory as ``transparent''. The stub | |
34368 | will answer requests for these ranges from memory's current contents, | |
34369 | if they were not collected as part of the tracepoint hit. | |
34370 | ||
34371 | @value{GDBN} uses this to mark read-only regions of memory, like those | |
34372 | containing program code. Since these areas never change, they should | |
34373 | still have the same contents they did when the tracepoint was hit, so | |
34374 | there's no reason for the stub to refuse to provide their contents. | |
34375 | ||
d5551862 SS |
34376 | @item QTDisconnected:@var{value} |
34377 | Set the choice to what to do with the tracing run when @value{GDBN} | |
34378 | disconnects from the target. A @var{value} of 1 directs the target to | |
34379 | continue the tracing run, while 0 tells the target to stop tracing if | |
34380 | @value{GDBN} is no longer in the picture. | |
34381 | ||
9d29849a JB |
34382 | @item qTStatus |
34383 | Ask the stub if there is a trace experiment running right now. | |
34384 | ||
4daf5ac0 SS |
34385 | The reply has the form: |
34386 | ||
34387 | @table @samp | |
34388 | ||
34389 | @item T@var{running}@r{[};@var{field}@r{]}@dots{} | |
34390 | @var{running} is a single digit @code{1} if the trace is presently | |
34391 | running, or @code{0} if not. It is followed by semicolon-separated | |
34392 | optional fields that an agent may use to report additional status. | |
34393 | ||
34394 | @end table | |
34395 | ||
34396 | If the trace is not running, the agent may report any of several | |
34397 | explanations as one of the optional fields: | |
34398 | ||
34399 | @table @samp | |
34400 | ||
34401 | @item tnotrun:0 | |
34402 | No trace has been run yet. | |
34403 | ||
34404 | @item tstop:0 | |
34405 | The trace was stopped by a user-originated stop command. | |
34406 | ||
34407 | @item tfull:0 | |
34408 | The trace stopped because the trace buffer filled up. | |
34409 | ||
34410 | @item tdisconnected:0 | |
34411 | The trace stopped because @value{GDBN} disconnected from the target. | |
34412 | ||
34413 | @item tpasscount:@var{tpnum} | |
34414 | The trace stopped because tracepoint @var{tpnum} exceeded its pass count. | |
34415 | ||
6c28cbf2 SS |
34416 | @item terror:@var{text}:@var{tpnum} |
34417 | The trace stopped because tracepoint @var{tpnum} had an error. The | |
34418 | string @var{text} is available to describe the nature of the error | |
34419 | (for instance, a divide by zero in the condition expression). | |
99b5e152 | 34420 | @var{text} is hex encoded. |
6c28cbf2 | 34421 | |
4daf5ac0 SS |
34422 | @item tunknown:0 |
34423 | The trace stopped for some other reason. | |
34424 | ||
34425 | @end table | |
34426 | ||
33da3f1c SS |
34427 | Additional optional fields supply statistical and other information. |
34428 | Although not required, they are extremely useful for users monitoring | |
34429 | the progress of a trace run. If a trace has stopped, and these | |
34430 | numbers are reported, they must reflect the state of the just-stopped | |
34431 | trace. | |
4daf5ac0 | 34432 | |
9d29849a | 34433 | @table @samp |
4daf5ac0 SS |
34434 | |
34435 | @item tframes:@var{n} | |
34436 | The number of trace frames in the buffer. | |
34437 | ||
34438 | @item tcreated:@var{n} | |
34439 | The total number of trace frames created during the run. This may | |
34440 | be larger than the trace frame count, if the buffer is circular. | |
34441 | ||
34442 | @item tsize:@var{n} | |
34443 | The total size of the trace buffer, in bytes. | |
34444 | ||
34445 | @item tfree:@var{n} | |
34446 | The number of bytes still unused in the buffer. | |
34447 | ||
33da3f1c SS |
34448 | @item circular:@var{n} |
34449 | The value of the circular trace buffer flag. @code{1} means that the | |
34450 | trace buffer is circular and old trace frames will be discarded if | |
34451 | necessary to make room, @code{0} means that the trace buffer is linear | |
34452 | and may fill up. | |
34453 | ||
34454 | @item disconn:@var{n} | |
34455 | The value of the disconnected tracing flag. @code{1} means that | |
34456 | tracing will continue after @value{GDBN} disconnects, @code{0} means | |
34457 | that the trace run will stop. | |
34458 | ||
9d29849a JB |
34459 | @end table |
34460 | ||
f61e138d SS |
34461 | @item qTV:@var{var} |
34462 | @cindex trace state variable value, remote request | |
34463 | @cindex @samp{qTV} packet | |
34464 | Ask the stub for the value of the trace state variable number @var{var}. | |
34465 | ||
34466 | Replies: | |
34467 | @table @samp | |
34468 | @item V@var{value} | |
34469 | The value of the variable is @var{value}. This will be the current | |
34470 | value of the variable if the user is examining a running target, or a | |
34471 | saved value if the variable was collected in the trace frame that the | |
34472 | user is looking at. Note that multiple requests may result in | |
34473 | different reply values, such as when requesting values while the | |
34474 | program is running. | |
34475 | ||
34476 | @item U | |
34477 | The value of the variable is unknown. This would occur, for example, | |
34478 | if the user is examining a trace frame in which the requested variable | |
34479 | was not collected. | |
9d29849a JB |
34480 | @end table |
34481 | ||
d5551862 SS |
34482 | @item qTfP |
34483 | @itemx qTsP | |
34484 | These packets request data about tracepoints that are being used by | |
34485 | the target. @value{GDBN} sends @code{qTfP} to get the first piece | |
34486 | of data, and multiple @code{qTsP} to get additional pieces. Replies | |
34487 | to these packets generally take the form of the @code{QTDP} packets | |
34488 | that define tracepoints. (FIXME add detailed syntax) | |
34489 | ||
00bf0b85 SS |
34490 | @item qTfV |
34491 | @itemx qTsV | |
34492 | These packets request data about trace state variables that are on the | |
34493 | target. @value{GDBN} sends @code{qTfV} to get the first vari of data, | |
34494 | and multiple @code{qTsV} to get additional variables. Replies to | |
34495 | these packets follow the syntax of the @code{QTDV} packets that define | |
34496 | trace state variables. | |
34497 | ||
0fb4aa4b PA |
34498 | @item qTfSTM |
34499 | @itemx qTsSTM | |
34500 | These packets request data about static tracepoint markers that exist | |
34501 | in the target program. @value{GDBN} sends @code{qTfSTM} to get the | |
34502 | first piece of data, and multiple @code{qTsSTM} to get additional | |
34503 | pieces. Replies to these packets take the following form: | |
34504 | ||
34505 | Reply: | |
34506 | @table @samp | |
34507 | @item m @var{address}:@var{id}:@var{extra} | |
34508 | A single marker | |
34509 | @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{} | |
34510 | a comma-separated list of markers | |
34511 | @item l | |
34512 | (lower case letter @samp{L}) denotes end of list. | |
34513 | @item E @var{nn} | |
34514 | An error occurred. @var{nn} are hex digits. | |
34515 | @item | |
34516 | An empty reply indicates that the request is not supported by the | |
34517 | stub. | |
34518 | @end table | |
34519 | ||
34520 | @var{address} is encoded in hex. | |
34521 | @var{id} and @var{extra} are strings encoded in hex. | |
34522 | ||
34523 | In response to each query, the target will reply with a list of one or | |
34524 | more markers, separated by commas. @value{GDBN} will respond to each | |
34525 | reply with a request for more markers (using the @samp{qs} form of the | |
34526 | query), until the target responds with @samp{l} (lower-case ell, for | |
34527 | @dfn{last}). | |
34528 | ||
34529 | @item qTSTMat:@var{address} | |
34530 | This packets requests data about static tracepoint markers in the | |
34531 | target program at @var{address}. Replies to this packet follow the | |
34532 | syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static | |
34533 | tracepoint markers. | |
34534 | ||
00bf0b85 SS |
34535 | @item QTSave:@var{filename} |
34536 | This packet directs the target to save trace data to the file name | |
34537 | @var{filename} in the target's filesystem. @var{filename} is encoded | |
34538 | as a hex string; the interpretation of the file name (relative vs | |
34539 | absolute, wild cards, etc) is up to the target. | |
34540 | ||
34541 | @item qTBuffer:@var{offset},@var{len} | |
34542 | Return up to @var{len} bytes of the current contents of trace buffer, | |
34543 | starting at @var{offset}. The trace buffer is treated as if it were | |
34544 | a contiguous collection of traceframes, as per the trace file format. | |
34545 | The reply consists as many hex-encoded bytes as the target can deliver | |
34546 | in a packet; it is not an error to return fewer than were asked for. | |
34547 | A reply consisting of just @code{l} indicates that no bytes are | |
34548 | available. | |
34549 | ||
4daf5ac0 SS |
34550 | @item QTBuffer:circular:@var{value} |
34551 | This packet directs the target to use a circular trace buffer if | |
34552 | @var{value} is 1, or a linear buffer if the value is 0. | |
34553 | ||
f61e138d | 34554 | @end table |
9d29849a | 34555 | |
dde08ee1 PA |
34556 | @subsection Relocate instruction reply packet |
34557 | When installing fast tracepoints in memory, the target may need to | |
34558 | relocate the instruction currently at the tracepoint address to a | |
34559 | different address in memory. For most instructions, a simple copy is | |
34560 | enough, but, for example, call instructions that implicitly push the | |
34561 | return address on the stack, and relative branches or other | |
34562 | PC-relative instructions require offset adjustment, so that the effect | |
34563 | of executing the instruction at a different address is the same as if | |
34564 | it had executed in the original location. | |
34565 | ||
34566 | In response to several of the tracepoint packets, the target may also | |
34567 | respond with a number of intermediate @samp{qRelocInsn} request | |
34568 | packets before the final result packet, to have @value{GDBN} handle | |
34569 | this relocation operation. If a packet supports this mechanism, its | |
34570 | documentation will explicitly say so. See for example the above | |
34571 | descriptions for the @samp{QTStart} and @samp{QTDP} packets. The | |
34572 | format of the request is: | |
34573 | ||
34574 | @table @samp | |
34575 | @item qRelocInsn:@var{from};@var{to} | |
34576 | ||
34577 | This requests @value{GDBN} to copy instruction at address @var{from} | |
34578 | to address @var{to}, possibly adjusted so that executing the | |
34579 | instruction at @var{to} has the same effect as executing it at | |
34580 | @var{from}. @value{GDBN} writes the adjusted instruction to target | |
34581 | memory starting at @var{to}. | |
34582 | @end table | |
34583 | ||
34584 | Replies: | |
34585 | @table @samp | |
34586 | @item qRelocInsn:@var{adjusted_size} | |
34587 | Informs the stub the relocation is complete. @var{adjusted_size} is | |
34588 | the length in bytes of resulting relocated instruction sequence. | |
34589 | @item E @var{NN} | |
34590 | A badly formed request was detected, or an error was encountered while | |
34591 | relocating the instruction. | |
34592 | @end table | |
34593 | ||
a6b151f1 DJ |
34594 | @node Host I/O Packets |
34595 | @section Host I/O Packets | |
34596 | @cindex Host I/O, remote protocol | |
34597 | @cindex file transfer, remote protocol | |
34598 | ||
34599 | The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O | |
34600 | operations on the far side of a remote link. For example, Host I/O is | |
34601 | used to upload and download files to a remote target with its own | |
34602 | filesystem. Host I/O uses the same constant values and data structure | |
34603 | layout as the target-initiated File-I/O protocol. However, the | |
34604 | Host I/O packets are structured differently. The target-initiated | |
34605 | protocol relies on target memory to store parameters and buffers. | |
34606 | Host I/O requests are initiated by @value{GDBN}, and the | |
34607 | target's memory is not involved. @xref{File-I/O Remote Protocol | |
34608 | Extension}, for more details on the target-initiated protocol. | |
34609 | ||
34610 | The Host I/O request packets all encode a single operation along with | |
34611 | its arguments. They have this format: | |
34612 | ||
34613 | @table @samp | |
34614 | ||
34615 | @item vFile:@var{operation}: @var{parameter}@dots{} | |
34616 | @var{operation} is the name of the particular request; the target | |
34617 | should compare the entire packet name up to the second colon when checking | |
34618 | for a supported operation. The format of @var{parameter} depends on | |
34619 | the operation. Numbers are always passed in hexadecimal. Negative | |
34620 | numbers have an explicit minus sign (i.e.@: two's complement is not | |
34621 | used). Strings (e.g.@: filenames) are encoded as a series of | |
34622 | hexadecimal bytes. The last argument to a system call may be a | |
34623 | buffer of escaped binary data (@pxref{Binary Data}). | |
34624 | ||
34625 | @end table | |
34626 | ||
34627 | The valid responses to Host I/O packets are: | |
34628 | ||
34629 | @table @samp | |
34630 | ||
34631 | @item F @var{result} [, @var{errno}] [; @var{attachment}] | |
34632 | @var{result} is the integer value returned by this operation, usually | |
34633 | non-negative for success and -1 for errors. If an error has occured, | |
34634 | @var{errno} will be included in the result. @var{errno} will have a | |
34635 | value defined by the File-I/O protocol (@pxref{Errno Values}). For | |
34636 | operations which return data, @var{attachment} supplies the data as a | |
34637 | binary buffer. Binary buffers in response packets are escaped in the | |
34638 | normal way (@pxref{Binary Data}). See the individual packet | |
34639 | documentation for the interpretation of @var{result} and | |
34640 | @var{attachment}. | |
34641 | ||
34642 | @item | |
34643 | An empty response indicates that this operation is not recognized. | |
34644 | ||
34645 | @end table | |
34646 | ||
34647 | These are the supported Host I/O operations: | |
34648 | ||
34649 | @table @samp | |
34650 | @item vFile:open: @var{pathname}, @var{flags}, @var{mode} | |
34651 | Open a file at @var{pathname} and return a file descriptor for it, or | |
34652 | return -1 if an error occurs. @var{pathname} is a string, | |
34653 | @var{flags} is an integer indicating a mask of open flags | |
34654 | (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask | |
34655 | of mode bits to use if the file is created (@pxref{mode_t Values}). | |
c1c25a1a | 34656 | @xref{open}, for details of the open flags and mode values. |
a6b151f1 DJ |
34657 | |
34658 | @item vFile:close: @var{fd} | |
34659 | Close the open file corresponding to @var{fd} and return 0, or | |
34660 | -1 if an error occurs. | |
34661 | ||
34662 | @item vFile:pread: @var{fd}, @var{count}, @var{offset} | |
34663 | Read data from the open file corresponding to @var{fd}. Up to | |
34664 | @var{count} bytes will be read from the file, starting at @var{offset} | |
34665 | relative to the start of the file. The target may read fewer bytes; | |
34666 | common reasons include packet size limits and an end-of-file | |
34667 | condition. The number of bytes read is returned. Zero should only be | |
34668 | returned for a successful read at the end of the file, or if | |
34669 | @var{count} was zero. | |
34670 | ||
34671 | The data read should be returned as a binary attachment on success. | |
34672 | If zero bytes were read, the response should include an empty binary | |
34673 | attachment (i.e.@: a trailing semicolon). The return value is the | |
34674 | number of target bytes read; the binary attachment may be longer if | |
34675 | some characters were escaped. | |
34676 | ||
34677 | @item vFile:pwrite: @var{fd}, @var{offset}, @var{data} | |
34678 | Write @var{data} (a binary buffer) to the open file corresponding | |
34679 | to @var{fd}. Start the write at @var{offset} from the start of the | |
34680 | file. Unlike many @code{write} system calls, there is no | |
34681 | separate @var{count} argument; the length of @var{data} in the | |
34682 | packet is used. @samp{vFile:write} returns the number of bytes written, | |
34683 | which may be shorter than the length of @var{data}, or -1 if an | |
34684 | error occurred. | |
34685 | ||
34686 | @item vFile:unlink: @var{pathname} | |
34687 | Delete the file at @var{pathname} on the target. Return 0, | |
34688 | or -1 if an error occurs. @var{pathname} is a string. | |
34689 | ||
34690 | @end table | |
34691 | ||
9a6253be KB |
34692 | @node Interrupts |
34693 | @section Interrupts | |
34694 | @cindex interrupts (remote protocol) | |
34695 | ||
34696 | When a program on the remote target is running, @value{GDBN} may | |
9a7071a8 JB |
34697 | attempt to interrupt it by sending a @samp{Ctrl-C}, @code{BREAK} or |
34698 | a @code{BREAK} followed by @code{g}, | |
34699 | control of which is specified via @value{GDBN}'s @samp{interrupt-sequence}. | |
9a6253be KB |
34700 | |
34701 | The precise meaning of @code{BREAK} is defined by the transport | |
8775bb90 MS |
34702 | mechanism and may, in fact, be undefined. @value{GDBN} does not |
34703 | currently define a @code{BREAK} mechanism for any of the network | |
34704 | interfaces except for TCP, in which case @value{GDBN} sends the | |
34705 | @code{telnet} BREAK sequence. | |
9a6253be KB |
34706 | |
34707 | @samp{Ctrl-C}, on the other hand, is defined and implemented for all | |
34708 | transport mechanisms. It is represented by sending the single byte | |
34709 | @code{0x03} without any of the usual packet overhead described in | |
34710 | the Overview section (@pxref{Overview}). When a @code{0x03} byte is | |
34711 | transmitted as part of a packet, it is considered to be packet data | |
34712 | and does @emph{not} represent an interrupt. E.g., an @samp{X} packet | |
0876f84a | 34713 | (@pxref{X packet}), used for binary downloads, may include an unescaped |
9a6253be KB |
34714 | @code{0x03} as part of its packet. |
34715 | ||
9a7071a8 JB |
34716 | @code{BREAK} followed by @code{g} is also known as Magic SysRq g. |
34717 | When Linux kernel receives this sequence from serial port, | |
34718 | it stops execution and connects to gdb. | |
34719 | ||
9a6253be KB |
34720 | Stubs are not required to recognize these interrupt mechanisms and the |
34721 | precise meaning associated with receipt of the interrupt is | |
8b23ecc4 SL |
34722 | implementation defined. If the target supports debugging of multiple |
34723 | threads and/or processes, it should attempt to interrupt all | |
34724 | currently-executing threads and processes. | |
34725 | If the stub is successful at interrupting the | |
34726 | running program, it should send one of the stop | |
34727 | reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result | |
34728 | of successfully stopping the program in all-stop mode, and a stop reply | |
34729 | for each stopped thread in non-stop mode. | |
34730 | Interrupts received while the | |
34731 | program is stopped are discarded. | |
34732 | ||
34733 | @node Notification Packets | |
34734 | @section Notification Packets | |
34735 | @cindex notification packets | |
34736 | @cindex packets, notification | |
34737 | ||
34738 | The @value{GDBN} remote serial protocol includes @dfn{notifications}, | |
34739 | packets that require no acknowledgment. Both the GDB and the stub | |
34740 | may send notifications (although the only notifications defined at | |
34741 | present are sent by the stub). Notifications carry information | |
34742 | without incurring the round-trip latency of an acknowledgment, and so | |
34743 | are useful for low-impact communications where occasional packet loss | |
34744 | is not a problem. | |
34745 | ||
34746 | A notification packet has the form @samp{% @var{data} # | |
34747 | @var{checksum}}, where @var{data} is the content of the notification, | |
34748 | and @var{checksum} is a checksum of @var{data}, computed and formatted | |
34749 | as for ordinary @value{GDBN} packets. A notification's @var{data} | |
34750 | never contains @samp{$}, @samp{%} or @samp{#} characters. Upon | |
34751 | receiving a notification, the recipient sends no @samp{+} or @samp{-} | |
34752 | to acknowledge the notification's receipt or to report its corruption. | |
34753 | ||
34754 | Every notification's @var{data} begins with a name, which contains no | |
34755 | colon characters, followed by a colon character. | |
34756 | ||
34757 | Recipients should silently ignore corrupted notifications and | |
34758 | notifications they do not understand. Recipients should restart | |
34759 | timeout periods on receipt of a well-formed notification, whether or | |
34760 | not they understand it. | |
34761 | ||
34762 | Senders should only send the notifications described here when this | |
34763 | protocol description specifies that they are permitted. In the | |
34764 | future, we may extend the protocol to permit existing notifications in | |
34765 | new contexts; this rule helps older senders avoid confusing newer | |
34766 | recipients. | |
34767 | ||
34768 | (Older versions of @value{GDBN} ignore bytes received until they see | |
34769 | the @samp{$} byte that begins an ordinary packet, so new stubs may | |
34770 | transmit notifications without fear of confusing older clients. There | |
34771 | are no notifications defined for @value{GDBN} to send at the moment, but we | |
34772 | assume that most older stubs would ignore them, as well.) | |
34773 | ||
34774 | The following notification packets from the stub to @value{GDBN} are | |
34775 | defined: | |
34776 | ||
34777 | @table @samp | |
34778 | @item Stop: @var{reply} | |
34779 | Report an asynchronous stop event in non-stop mode. | |
34780 | The @var{reply} has the form of a stop reply, as | |
34781 | described in @ref{Stop Reply Packets}. Refer to @ref{Remote Non-Stop}, | |
34782 | for information on how these notifications are acknowledged by | |
34783 | @value{GDBN}. | |
34784 | @end table | |
34785 | ||
34786 | @node Remote Non-Stop | |
34787 | @section Remote Protocol Support for Non-Stop Mode | |
34788 | ||
34789 | @value{GDBN}'s remote protocol supports non-stop debugging of | |
34790 | multi-threaded programs, as described in @ref{Non-Stop Mode}. If the stub | |
34791 | supports non-stop mode, it should report that to @value{GDBN} by including | |
34792 | @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}). | |
34793 | ||
34794 | @value{GDBN} typically sends a @samp{QNonStop} packet only when | |
34795 | establishing a new connection with the stub. Entering non-stop mode | |
34796 | does not alter the state of any currently-running threads, but targets | |
34797 | must stop all threads in any already-attached processes when entering | |
34798 | all-stop mode. @value{GDBN} uses the @samp{?} packet as necessary to | |
34799 | probe the target state after a mode change. | |
34800 | ||
34801 | In non-stop mode, when an attached process encounters an event that | |
34802 | would otherwise be reported with a stop reply, it uses the | |
34803 | asynchronous notification mechanism (@pxref{Notification Packets}) to | |
34804 | inform @value{GDBN}. In contrast to all-stop mode, where all threads | |
34805 | in all processes are stopped when a stop reply is sent, in non-stop | |
34806 | mode only the thread reporting the stop event is stopped. That is, | |
34807 | when reporting a @samp{S} or @samp{T} response to indicate completion | |
34808 | of a step operation, hitting a breakpoint, or a fault, only the | |
34809 | affected thread is stopped; any other still-running threads continue | |
34810 | to run. When reporting a @samp{W} or @samp{X} response, all running | |
34811 | threads belonging to other attached processes continue to run. | |
34812 | ||
34813 | Only one stop reply notification at a time may be pending; if | |
34814 | additional stop events occur before @value{GDBN} has acknowledged the | |
34815 | previous notification, they must be queued by the stub for later | |
34816 | synchronous transmission in response to @samp{vStopped} packets from | |
34817 | @value{GDBN}. Because the notification mechanism is unreliable, | |
34818 | the stub is permitted to resend a stop reply notification | |
34819 | if it believes @value{GDBN} may not have received it. @value{GDBN} | |
34820 | ignores additional stop reply notifications received before it has | |
34821 | finished processing a previous notification and the stub has completed | |
34822 | sending any queued stop events. | |
34823 | ||
34824 | Otherwise, @value{GDBN} must be prepared to receive a stop reply | |
34825 | notification at any time. Specifically, they may appear when | |
34826 | @value{GDBN} is not otherwise reading input from the stub, or when | |
34827 | @value{GDBN} is expecting to read a normal synchronous response or a | |
34828 | @samp{+}/@samp{-} acknowledgment to a packet it has sent. | |
34829 | Notification packets are distinct from any other communication from | |
34830 | the stub so there is no ambiguity. | |
34831 | ||
34832 | After receiving a stop reply notification, @value{GDBN} shall | |
34833 | acknowledge it by sending a @samp{vStopped} packet (@pxref{vStopped packet}) | |
34834 | as a regular, synchronous request to the stub. Such acknowledgment | |
34835 | is not required to happen immediately, as @value{GDBN} is permitted to | |
34836 | send other, unrelated packets to the stub first, which the stub should | |
34837 | process normally. | |
34838 | ||
34839 | Upon receiving a @samp{vStopped} packet, if the stub has other queued | |
34840 | stop events to report to @value{GDBN}, it shall respond by sending a | |
34841 | normal stop reply response. @value{GDBN} shall then send another | |
34842 | @samp{vStopped} packet to solicit further responses; again, it is | |
34843 | permitted to send other, unrelated packets as well which the stub | |
34844 | should process normally. | |
34845 | ||
34846 | If the stub receives a @samp{vStopped} packet and there are no | |
34847 | additional stop events to report, the stub shall return an @samp{OK} | |
34848 | response. At this point, if further stop events occur, the stub shall | |
34849 | send a new stop reply notification, @value{GDBN} shall accept the | |
34850 | notification, and the process shall be repeated. | |
34851 | ||
34852 | In non-stop mode, the target shall respond to the @samp{?} packet as | |
34853 | follows. First, any incomplete stop reply notification/@samp{vStopped} | |
34854 | sequence in progress is abandoned. The target must begin a new | |
34855 | sequence reporting stop events for all stopped threads, whether or not | |
34856 | it has previously reported those events to @value{GDBN}. The first | |
34857 | stop reply is sent as a synchronous reply to the @samp{?} packet, and | |
34858 | subsequent stop replies are sent as responses to @samp{vStopped} packets | |
34859 | using the mechanism described above. The target must not send | |
34860 | asynchronous stop reply notifications until the sequence is complete. | |
34861 | If all threads are running when the target receives the @samp{?} packet, | |
34862 | or if the target is not attached to any process, it shall respond | |
34863 | @samp{OK}. | |
9a6253be | 34864 | |
a6f3e723 SL |
34865 | @node Packet Acknowledgment |
34866 | @section Packet Acknowledgment | |
34867 | ||
34868 | @cindex acknowledgment, for @value{GDBN} remote | |
34869 | @cindex packet acknowledgment, for @value{GDBN} remote | |
34870 | By default, when either the host or the target machine receives a packet, | |
34871 | the first response expected is an acknowledgment: either @samp{+} (to indicate | |
34872 | the package was received correctly) or @samp{-} (to request retransmission). | |
34873 | This mechanism allows the @value{GDBN} remote protocol to operate over | |
34874 | unreliable transport mechanisms, such as a serial line. | |
34875 | ||
34876 | In cases where the transport mechanism is itself reliable (such as a pipe or | |
34877 | TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant. | |
34878 | It may be desirable to disable them in that case to reduce communication | |
34879 | overhead, or for other reasons. This can be accomplished by means of the | |
34880 | @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}. | |
34881 | ||
34882 | When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or | |
34883 | expect @samp{+}/@samp{-} protocol acknowledgments. The packet | |
34884 | and response format still includes the normal checksum, as described in | |
34885 | @ref{Overview}, but the checksum may be ignored by the receiver. | |
34886 | ||
34887 | If the stub supports @samp{QStartNoAckMode} and prefers to operate in | |
34888 | no-acknowledgment mode, it should report that to @value{GDBN} | |
34889 | by including @samp{QStartNoAckMode+} in its response to @samp{qSupported}; | |
34890 | @pxref{qSupported}. | |
34891 | If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been | |
34892 | disabled via the @code{set remote noack-packet off} command | |
34893 | (@pxref{Remote Configuration}), | |
34894 | @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub. | |
34895 | Only then may the stub actually turn off packet acknowledgments. | |
34896 | @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK} | |
34897 | response, which can be safely ignored by the stub. | |
34898 | ||
34899 | Note that @code{set remote noack-packet} command only affects negotiation | |
34900 | between @value{GDBN} and the stub when subsequent connections are made; | |
34901 | it does not affect the protocol acknowledgment state for any current | |
34902 | connection. | |
34903 | Since @samp{+}/@samp{-} acknowledgments are enabled by default when a | |
34904 | new connection is established, | |
34905 | there is also no protocol request to re-enable the acknowledgments | |
34906 | for the current connection, once disabled. | |
34907 | ||
ee2d5c50 AC |
34908 | @node Examples |
34909 | @section Examples | |
eb12ee30 | 34910 | |
8e04817f AC |
34911 | Example sequence of a target being re-started. Notice how the restart |
34912 | does not get any direct output: | |
eb12ee30 | 34913 | |
474c8240 | 34914 | @smallexample |
d2c6833e AC |
34915 | -> @code{R00} |
34916 | <- @code{+} | |
8e04817f | 34917 | @emph{target restarts} |
d2c6833e | 34918 | -> @code{?} |
8e04817f | 34919 | <- @code{+} |
d2c6833e AC |
34920 | <- @code{T001:1234123412341234} |
34921 | -> @code{+} | |
474c8240 | 34922 | @end smallexample |
eb12ee30 | 34923 | |
8e04817f | 34924 | Example sequence of a target being stepped by a single instruction: |
eb12ee30 | 34925 | |
474c8240 | 34926 | @smallexample |
d2c6833e | 34927 | -> @code{G1445@dots{}} |
8e04817f | 34928 | <- @code{+} |
d2c6833e AC |
34929 | -> @code{s} |
34930 | <- @code{+} | |
34931 | @emph{time passes} | |
34932 | <- @code{T001:1234123412341234} | |
8e04817f | 34933 | -> @code{+} |
d2c6833e | 34934 | -> @code{g} |
8e04817f | 34935 | <- @code{+} |
d2c6833e AC |
34936 | <- @code{1455@dots{}} |
34937 | -> @code{+} | |
474c8240 | 34938 | @end smallexample |
eb12ee30 | 34939 | |
79a6e687 BW |
34940 | @node File-I/O Remote Protocol Extension |
34941 | @section File-I/O Remote Protocol Extension | |
0ce1b118 CV |
34942 | @cindex File-I/O remote protocol extension |
34943 | ||
34944 | @menu | |
34945 | * File-I/O Overview:: | |
79a6e687 BW |
34946 | * Protocol Basics:: |
34947 | * The F Request Packet:: | |
34948 | * The F Reply Packet:: | |
34949 | * The Ctrl-C Message:: | |
0ce1b118 | 34950 | * Console I/O:: |
79a6e687 | 34951 | * List of Supported Calls:: |
db2e3e2e | 34952 | * Protocol-specific Representation of Datatypes:: |
0ce1b118 CV |
34953 | * Constants:: |
34954 | * File-I/O Examples:: | |
34955 | @end menu | |
34956 | ||
34957 | @node File-I/O Overview | |
34958 | @subsection File-I/O Overview | |
34959 | @cindex file-i/o overview | |
34960 | ||
9c16f35a | 34961 | The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the |
fc320d37 | 34962 | target to use the host's file system and console I/O to perform various |
0ce1b118 | 34963 | system calls. System calls on the target system are translated into a |
fc320d37 SL |
34964 | remote protocol packet to the host system, which then performs the needed |
34965 | actions and returns a response packet to the target system. | |
0ce1b118 CV |
34966 | This simulates file system operations even on targets that lack file systems. |
34967 | ||
fc320d37 SL |
34968 | The protocol is defined to be independent of both the host and target systems. |
34969 | It uses its own internal representation of datatypes and values. Both | |
0ce1b118 | 34970 | @value{GDBN} and the target's @value{GDBN} stub are responsible for |
fc320d37 SL |
34971 | translating the system-dependent value representations into the internal |
34972 | protocol representations when data is transmitted. | |
0ce1b118 | 34973 | |
fc320d37 SL |
34974 | The communication is synchronous. A system call is possible only when |
34975 | @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S} | |
34976 | or @samp{s} packets. While @value{GDBN} handles the request for a system call, | |
0ce1b118 | 34977 | the target is stopped to allow deterministic access to the target's |
fc320d37 SL |
34978 | memory. Therefore File-I/O is not interruptible by target signals. On |
34979 | the other hand, it is possible to interrupt File-I/O by a user interrupt | |
c8aa23ab | 34980 | (@samp{Ctrl-C}) within @value{GDBN}. |
0ce1b118 CV |
34981 | |
34982 | The target's request to perform a host system call does not finish | |
34983 | the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means, | |
34984 | after finishing the system call, the target returns to continuing the | |
34985 | previous activity (continue, step). No additional continue or step | |
34986 | request from @value{GDBN} is required. | |
34987 | ||
34988 | @smallexample | |
f7dc1244 | 34989 | (@value{GDBP}) continue |
0ce1b118 CV |
34990 | <- target requests 'system call X' |
34991 | target is stopped, @value{GDBN} executes system call | |
3f94c067 BW |
34992 | -> @value{GDBN} returns result |
34993 | ... target continues, @value{GDBN} returns to wait for the target | |
0ce1b118 CV |
34994 | <- target hits breakpoint and sends a Txx packet |
34995 | @end smallexample | |
34996 | ||
fc320d37 SL |
34997 | The protocol only supports I/O on the console and to regular files on |
34998 | the host file system. Character or block special devices, pipes, | |
34999 | named pipes, sockets or any other communication method on the host | |
0ce1b118 CV |
35000 | system are not supported by this protocol. |
35001 | ||
8b23ecc4 SL |
35002 | File I/O is not supported in non-stop mode. |
35003 | ||
79a6e687 BW |
35004 | @node Protocol Basics |
35005 | @subsection Protocol Basics | |
0ce1b118 CV |
35006 | @cindex protocol basics, file-i/o |
35007 | ||
fc320d37 SL |
35008 | The File-I/O protocol uses the @code{F} packet as the request as well |
35009 | as reply packet. Since a File-I/O system call can only occur when | |
35010 | @value{GDBN} is waiting for a response from the continuing or stepping target, | |
35011 | the File-I/O request is a reply that @value{GDBN} has to expect as a result | |
35012 | of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet. | |
0ce1b118 CV |
35013 | This @code{F} packet contains all information needed to allow @value{GDBN} |
35014 | to call the appropriate host system call: | |
35015 | ||
35016 | @itemize @bullet | |
b383017d | 35017 | @item |
0ce1b118 CV |
35018 | A unique identifier for the requested system call. |
35019 | ||
35020 | @item | |
35021 | All parameters to the system call. Pointers are given as addresses | |
35022 | in the target memory address space. Pointers to strings are given as | |
b383017d | 35023 | pointer/length pair. Numerical values are given as they are. |
db2e3e2e | 35024 | Numerical control flags are given in a protocol-specific representation. |
0ce1b118 CV |
35025 | |
35026 | @end itemize | |
35027 | ||
fc320d37 | 35028 | At this point, @value{GDBN} has to perform the following actions. |
0ce1b118 CV |
35029 | |
35030 | @itemize @bullet | |
b383017d | 35031 | @item |
fc320d37 SL |
35032 | If the parameters include pointer values to data needed as input to a |
35033 | system call, @value{GDBN} requests this data from the target with a | |
0ce1b118 CV |
35034 | standard @code{m} packet request. This additional communication has to be |
35035 | expected by the target implementation and is handled as any other @code{m} | |
35036 | packet. | |
35037 | ||
35038 | @item | |
35039 | @value{GDBN} translates all value from protocol representation to host | |
35040 | representation as needed. Datatypes are coerced into the host types. | |
35041 | ||
35042 | @item | |
fc320d37 | 35043 | @value{GDBN} calls the system call. |
0ce1b118 CV |
35044 | |
35045 | @item | |
35046 | It then coerces datatypes back to protocol representation. | |
35047 | ||
35048 | @item | |
fc320d37 SL |
35049 | If the system call is expected to return data in buffer space specified |
35050 | by pointer parameters to the call, the data is transmitted to the | |
0ce1b118 CV |
35051 | target using a @code{M} or @code{X} packet. This packet has to be expected |
35052 | by the target implementation and is handled as any other @code{M} or @code{X} | |
35053 | packet. | |
35054 | ||
35055 | @end itemize | |
35056 | ||
35057 | Eventually @value{GDBN} replies with another @code{F} packet which contains all | |
35058 | necessary information for the target to continue. This at least contains | |
35059 | ||
35060 | @itemize @bullet | |
35061 | @item | |
35062 | Return value. | |
35063 | ||
35064 | @item | |
35065 | @code{errno}, if has been changed by the system call. | |
35066 | ||
35067 | @item | |
35068 | ``Ctrl-C'' flag. | |
35069 | ||
35070 | @end itemize | |
35071 | ||
35072 | After having done the needed type and value coercion, the target continues | |
35073 | the latest continue or step action. | |
35074 | ||
79a6e687 BW |
35075 | @node The F Request Packet |
35076 | @subsection The @code{F} Request Packet | |
0ce1b118 CV |
35077 | @cindex file-i/o request packet |
35078 | @cindex @code{F} request packet | |
35079 | ||
35080 | The @code{F} request packet has the following format: | |
35081 | ||
35082 | @table @samp | |
fc320d37 | 35083 | @item F@var{call-id},@var{parameter@dots{}} |
0ce1b118 CV |
35084 | |
35085 | @var{call-id} is the identifier to indicate the host system call to be called. | |
35086 | This is just the name of the function. | |
35087 | ||
fc320d37 SL |
35088 | @var{parameter@dots{}} are the parameters to the system call. |
35089 | Parameters are hexadecimal integer values, either the actual values in case | |
35090 | of scalar datatypes, pointers to target buffer space in case of compound | |
35091 | datatypes and unspecified memory areas, or pointer/length pairs in case | |
35092 | of string parameters. These are appended to the @var{call-id} as a | |
35093 | comma-delimited list. All values are transmitted in ASCII | |
35094 | string representation, pointer/length pairs separated by a slash. | |
0ce1b118 | 35095 | |
b383017d | 35096 | @end table |
0ce1b118 | 35097 | |
fc320d37 | 35098 | |
0ce1b118 | 35099 | |
79a6e687 BW |
35100 | @node The F Reply Packet |
35101 | @subsection The @code{F} Reply Packet | |
0ce1b118 CV |
35102 | @cindex file-i/o reply packet |
35103 | @cindex @code{F} reply packet | |
35104 | ||
35105 | The @code{F} reply packet has the following format: | |
35106 | ||
35107 | @table @samp | |
35108 | ||
d3bdde98 | 35109 | @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment} |
0ce1b118 CV |
35110 | |
35111 | @var{retcode} is the return code of the system call as hexadecimal value. | |
35112 | ||
db2e3e2e BW |
35113 | @var{errno} is the @code{errno} set by the call, in protocol-specific |
35114 | representation. | |
0ce1b118 CV |
35115 | This parameter can be omitted if the call was successful. |
35116 | ||
fc320d37 SL |
35117 | @var{Ctrl-C flag} is only sent if the user requested a break. In this |
35118 | case, @var{errno} must be sent as well, even if the call was successful. | |
35119 | The @var{Ctrl-C flag} itself consists of the character @samp{C}: | |
0ce1b118 CV |
35120 | |
35121 | @smallexample | |
35122 | F0,0,C | |
35123 | @end smallexample | |
35124 | ||
35125 | @noindent | |
fc320d37 | 35126 | or, if the call was interrupted before the host call has been performed: |
0ce1b118 CV |
35127 | |
35128 | @smallexample | |
35129 | F-1,4,C | |
35130 | @end smallexample | |
35131 | ||
35132 | @noindent | |
db2e3e2e | 35133 | assuming 4 is the protocol-specific representation of @code{EINTR}. |
0ce1b118 CV |
35134 | |
35135 | @end table | |
35136 | ||
0ce1b118 | 35137 | |
79a6e687 BW |
35138 | @node The Ctrl-C Message |
35139 | @subsection The @samp{Ctrl-C} Message | |
0ce1b118 CV |
35140 | @cindex ctrl-c message, in file-i/o protocol |
35141 | ||
c8aa23ab | 35142 | If the @samp{Ctrl-C} flag is set in the @value{GDBN} |
79a6e687 | 35143 | reply packet (@pxref{The F Reply Packet}), |
fc320d37 | 35144 | the target should behave as if it had |
0ce1b118 | 35145 | gotten a break message. The meaning for the target is ``system call |
fc320d37 | 35146 | interrupted by @code{SIGINT}''. Consequentially, the target should actually stop |
0ce1b118 | 35147 | (as with a break message) and return to @value{GDBN} with a @code{T02} |
c8aa23ab | 35148 | packet. |
fc320d37 SL |
35149 | |
35150 | It's important for the target to know in which | |
35151 | state the system call was interrupted. There are two possible cases: | |
0ce1b118 CV |
35152 | |
35153 | @itemize @bullet | |
35154 | @item | |
35155 | The system call hasn't been performed on the host yet. | |
35156 | ||
35157 | @item | |
35158 | The system call on the host has been finished. | |
35159 | ||
35160 | @end itemize | |
35161 | ||
35162 | These two states can be distinguished by the target by the value of the | |
35163 | returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system | |
35164 | call hasn't been performed. This is equivalent to the @code{EINTR} handling | |
35165 | on POSIX systems. In any other case, the target may presume that the | |
fc320d37 | 35166 | system call has been finished --- successfully or not --- and should behave |
0ce1b118 CV |
35167 | as if the break message arrived right after the system call. |
35168 | ||
fc320d37 | 35169 | @value{GDBN} must behave reliably. If the system call has not been called |
0ce1b118 CV |
35170 | yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as |
35171 | @code{errno} in the packet. If the system call on the host has been finished | |
fc320d37 SL |
35172 | before the user requests a break, the full action must be finished by |
35173 | @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary. | |
35174 | The @code{F} packet may only be sent when either nothing has happened | |
0ce1b118 CV |
35175 | or the full action has been completed. |
35176 | ||
35177 | @node Console I/O | |
35178 | @subsection Console I/O | |
35179 | @cindex console i/o as part of file-i/o | |
35180 | ||
d3e8051b | 35181 | By default and if not explicitly closed by the target system, the file |
0ce1b118 CV |
35182 | descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output |
35183 | on the @value{GDBN} console is handled as any other file output operation | |
35184 | (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled | |
35185 | by @value{GDBN} so that after the target read request from file descriptor | |
35186 | 0 all following typing is buffered until either one of the following | |
35187 | conditions is met: | |
35188 | ||
35189 | @itemize @bullet | |
35190 | @item | |
c8aa23ab | 35191 | The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the |
0ce1b118 CV |
35192 | @code{read} |
35193 | system call is treated as finished. | |
35194 | ||
35195 | @item | |
7f9087cb | 35196 | The user presses @key{RET}. This is treated as end of input with a trailing |
fc320d37 | 35197 | newline. |
0ce1b118 CV |
35198 | |
35199 | @item | |
c8aa23ab EZ |
35200 | The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing |
35201 | character (neither newline nor @samp{Ctrl-D}) is appended to the input. | |
0ce1b118 CV |
35202 | |
35203 | @end itemize | |
35204 | ||
fc320d37 SL |
35205 | If the user has typed more characters than fit in the buffer given to |
35206 | the @code{read} call, the trailing characters are buffered in @value{GDBN} until | |
35207 | either another @code{read(0, @dots{})} is requested by the target, or debugging | |
35208 | is stopped at the user's request. | |
0ce1b118 | 35209 | |
0ce1b118 | 35210 | |
79a6e687 BW |
35211 | @node List of Supported Calls |
35212 | @subsection List of Supported Calls | |
0ce1b118 CV |
35213 | @cindex list of supported file-i/o calls |
35214 | ||
35215 | @menu | |
35216 | * open:: | |
35217 | * close:: | |
35218 | * read:: | |
35219 | * write:: | |
35220 | * lseek:: | |
35221 | * rename:: | |
35222 | * unlink:: | |
35223 | * stat/fstat:: | |
35224 | * gettimeofday:: | |
35225 | * isatty:: | |
35226 | * system:: | |
35227 | @end menu | |
35228 | ||
35229 | @node open | |
35230 | @unnumberedsubsubsec open | |
35231 | @cindex open, file-i/o system call | |
35232 | ||
fc320d37 SL |
35233 | @table @asis |
35234 | @item Synopsis: | |
0ce1b118 | 35235 | @smallexample |
0ce1b118 CV |
35236 | int open(const char *pathname, int flags); |
35237 | int open(const char *pathname, int flags, mode_t mode); | |
0ce1b118 CV |
35238 | @end smallexample |
35239 | ||
fc320d37 SL |
35240 | @item Request: |
35241 | @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}} | |
35242 | ||
0ce1b118 | 35243 | @noindent |
fc320d37 | 35244 | @var{flags} is the bitwise @code{OR} of the following values: |
0ce1b118 CV |
35245 | |
35246 | @table @code | |
b383017d | 35247 | @item O_CREAT |
0ce1b118 CV |
35248 | If the file does not exist it will be created. The host |
35249 | rules apply as far as file ownership and time stamps | |
35250 | are concerned. | |
35251 | ||
b383017d | 35252 | @item O_EXCL |
fc320d37 | 35253 | When used with @code{O_CREAT}, if the file already exists it is |
0ce1b118 CV |
35254 | an error and open() fails. |
35255 | ||
b383017d | 35256 | @item O_TRUNC |
0ce1b118 | 35257 | If the file already exists and the open mode allows |
fc320d37 SL |
35258 | writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be |
35259 | truncated to zero length. | |
0ce1b118 | 35260 | |
b383017d | 35261 | @item O_APPEND |
0ce1b118 CV |
35262 | The file is opened in append mode. |
35263 | ||
b383017d | 35264 | @item O_RDONLY |
0ce1b118 CV |
35265 | The file is opened for reading only. |
35266 | ||
b383017d | 35267 | @item O_WRONLY |
0ce1b118 CV |
35268 | The file is opened for writing only. |
35269 | ||
b383017d | 35270 | @item O_RDWR |
0ce1b118 | 35271 | The file is opened for reading and writing. |
fc320d37 | 35272 | @end table |
0ce1b118 CV |
35273 | |
35274 | @noindent | |
fc320d37 | 35275 | Other bits are silently ignored. |
0ce1b118 | 35276 | |
0ce1b118 CV |
35277 | |
35278 | @noindent | |
fc320d37 | 35279 | @var{mode} is the bitwise @code{OR} of the following values: |
0ce1b118 CV |
35280 | |
35281 | @table @code | |
b383017d | 35282 | @item S_IRUSR |
0ce1b118 CV |
35283 | User has read permission. |
35284 | ||
b383017d | 35285 | @item S_IWUSR |
0ce1b118 CV |
35286 | User has write permission. |
35287 | ||
b383017d | 35288 | @item S_IRGRP |
0ce1b118 CV |
35289 | Group has read permission. |
35290 | ||
b383017d | 35291 | @item S_IWGRP |
0ce1b118 CV |
35292 | Group has write permission. |
35293 | ||
b383017d | 35294 | @item S_IROTH |
0ce1b118 CV |
35295 | Others have read permission. |
35296 | ||
b383017d | 35297 | @item S_IWOTH |
0ce1b118 | 35298 | Others have write permission. |
fc320d37 | 35299 | @end table |
0ce1b118 CV |
35300 | |
35301 | @noindent | |
fc320d37 | 35302 | Other bits are silently ignored. |
0ce1b118 | 35303 | |
0ce1b118 | 35304 | |
fc320d37 SL |
35305 | @item Return value: |
35306 | @code{open} returns the new file descriptor or -1 if an error | |
35307 | occurred. | |
0ce1b118 | 35308 | |
fc320d37 | 35309 | @item Errors: |
0ce1b118 CV |
35310 | |
35311 | @table @code | |
b383017d | 35312 | @item EEXIST |
fc320d37 | 35313 | @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used. |
0ce1b118 | 35314 | |
b383017d | 35315 | @item EISDIR |
fc320d37 | 35316 | @var{pathname} refers to a directory. |
0ce1b118 | 35317 | |
b383017d | 35318 | @item EACCES |
0ce1b118 CV |
35319 | The requested access is not allowed. |
35320 | ||
35321 | @item ENAMETOOLONG | |
fc320d37 | 35322 | @var{pathname} was too long. |
0ce1b118 | 35323 | |
b383017d | 35324 | @item ENOENT |
fc320d37 | 35325 | A directory component in @var{pathname} does not exist. |
0ce1b118 | 35326 | |
b383017d | 35327 | @item ENODEV |
fc320d37 | 35328 | @var{pathname} refers to a device, pipe, named pipe or socket. |
0ce1b118 | 35329 | |
b383017d | 35330 | @item EROFS |
fc320d37 | 35331 | @var{pathname} refers to a file on a read-only filesystem and |
0ce1b118 CV |
35332 | write access was requested. |
35333 | ||
b383017d | 35334 | @item EFAULT |
fc320d37 | 35335 | @var{pathname} is an invalid pointer value. |
0ce1b118 | 35336 | |
b383017d | 35337 | @item ENOSPC |
0ce1b118 CV |
35338 | No space on device to create the file. |
35339 | ||
b383017d | 35340 | @item EMFILE |
0ce1b118 CV |
35341 | The process already has the maximum number of files open. |
35342 | ||
b383017d | 35343 | @item ENFILE |
0ce1b118 CV |
35344 | The limit on the total number of files open on the system |
35345 | has been reached. | |
35346 | ||
b383017d | 35347 | @item EINTR |
0ce1b118 CV |
35348 | The call was interrupted by the user. |
35349 | @end table | |
35350 | ||
fc320d37 SL |
35351 | @end table |
35352 | ||
0ce1b118 CV |
35353 | @node close |
35354 | @unnumberedsubsubsec close | |
35355 | @cindex close, file-i/o system call | |
35356 | ||
fc320d37 SL |
35357 | @table @asis |
35358 | @item Synopsis: | |
0ce1b118 | 35359 | @smallexample |
0ce1b118 | 35360 | int close(int fd); |
fc320d37 | 35361 | @end smallexample |
0ce1b118 | 35362 | |
fc320d37 SL |
35363 | @item Request: |
35364 | @samp{Fclose,@var{fd}} | |
0ce1b118 | 35365 | |
fc320d37 SL |
35366 | @item Return value: |
35367 | @code{close} returns zero on success, or -1 if an error occurred. | |
0ce1b118 | 35368 | |
fc320d37 | 35369 | @item Errors: |
0ce1b118 CV |
35370 | |
35371 | @table @code | |
b383017d | 35372 | @item EBADF |
fc320d37 | 35373 | @var{fd} isn't a valid open file descriptor. |
0ce1b118 | 35374 | |
b383017d | 35375 | @item EINTR |
0ce1b118 CV |
35376 | The call was interrupted by the user. |
35377 | @end table | |
35378 | ||
fc320d37 SL |
35379 | @end table |
35380 | ||
0ce1b118 CV |
35381 | @node read |
35382 | @unnumberedsubsubsec read | |
35383 | @cindex read, file-i/o system call | |
35384 | ||
fc320d37 SL |
35385 | @table @asis |
35386 | @item Synopsis: | |
0ce1b118 | 35387 | @smallexample |
0ce1b118 | 35388 | int read(int fd, void *buf, unsigned int count); |
fc320d37 | 35389 | @end smallexample |
0ce1b118 | 35390 | |
fc320d37 SL |
35391 | @item Request: |
35392 | @samp{Fread,@var{fd},@var{bufptr},@var{count}} | |
0ce1b118 | 35393 | |
fc320d37 | 35394 | @item Return value: |
0ce1b118 CV |
35395 | On success, the number of bytes read is returned. |
35396 | Zero indicates end of file. If count is zero, read | |
b383017d | 35397 | returns zero as well. On error, -1 is returned. |
0ce1b118 | 35398 | |
fc320d37 | 35399 | @item Errors: |
0ce1b118 CV |
35400 | |
35401 | @table @code | |
b383017d | 35402 | @item EBADF |
fc320d37 | 35403 | @var{fd} is not a valid file descriptor or is not open for |
0ce1b118 CV |
35404 | reading. |
35405 | ||
b383017d | 35406 | @item EFAULT |
fc320d37 | 35407 | @var{bufptr} is an invalid pointer value. |
0ce1b118 | 35408 | |
b383017d | 35409 | @item EINTR |
0ce1b118 CV |
35410 | The call was interrupted by the user. |
35411 | @end table | |
35412 | ||
fc320d37 SL |
35413 | @end table |
35414 | ||
0ce1b118 CV |
35415 | @node write |
35416 | @unnumberedsubsubsec write | |
35417 | @cindex write, file-i/o system call | |
35418 | ||
fc320d37 SL |
35419 | @table @asis |
35420 | @item Synopsis: | |
0ce1b118 | 35421 | @smallexample |
0ce1b118 | 35422 | int write(int fd, const void *buf, unsigned int count); |
fc320d37 | 35423 | @end smallexample |
0ce1b118 | 35424 | |
fc320d37 SL |
35425 | @item Request: |
35426 | @samp{Fwrite,@var{fd},@var{bufptr},@var{count}} | |
0ce1b118 | 35427 | |
fc320d37 | 35428 | @item Return value: |
0ce1b118 CV |
35429 | On success, the number of bytes written are returned. |
35430 | Zero indicates nothing was written. On error, -1 | |
35431 | is returned. | |
35432 | ||
fc320d37 | 35433 | @item Errors: |
0ce1b118 CV |
35434 | |
35435 | @table @code | |
b383017d | 35436 | @item EBADF |
fc320d37 | 35437 | @var{fd} is not a valid file descriptor or is not open for |
0ce1b118 CV |
35438 | writing. |
35439 | ||
b383017d | 35440 | @item EFAULT |
fc320d37 | 35441 | @var{bufptr} is an invalid pointer value. |
0ce1b118 | 35442 | |
b383017d | 35443 | @item EFBIG |
0ce1b118 | 35444 | An attempt was made to write a file that exceeds the |
db2e3e2e | 35445 | host-specific maximum file size allowed. |
0ce1b118 | 35446 | |
b383017d | 35447 | @item ENOSPC |
0ce1b118 CV |
35448 | No space on device to write the data. |
35449 | ||
b383017d | 35450 | @item EINTR |
0ce1b118 CV |
35451 | The call was interrupted by the user. |
35452 | @end table | |
35453 | ||
fc320d37 SL |
35454 | @end table |
35455 | ||
0ce1b118 CV |
35456 | @node lseek |
35457 | @unnumberedsubsubsec lseek | |
35458 | @cindex lseek, file-i/o system call | |
35459 | ||
fc320d37 SL |
35460 | @table @asis |
35461 | @item Synopsis: | |
0ce1b118 | 35462 | @smallexample |
0ce1b118 | 35463 | long lseek (int fd, long offset, int flag); |
0ce1b118 CV |
35464 | @end smallexample |
35465 | ||
fc320d37 SL |
35466 | @item Request: |
35467 | @samp{Flseek,@var{fd},@var{offset},@var{flag}} | |
35468 | ||
35469 | @var{flag} is one of: | |
0ce1b118 CV |
35470 | |
35471 | @table @code | |
b383017d | 35472 | @item SEEK_SET |
fc320d37 | 35473 | The offset is set to @var{offset} bytes. |
0ce1b118 | 35474 | |
b383017d | 35475 | @item SEEK_CUR |
fc320d37 | 35476 | The offset is set to its current location plus @var{offset} |
0ce1b118 CV |
35477 | bytes. |
35478 | ||
b383017d | 35479 | @item SEEK_END |
fc320d37 | 35480 | The offset is set to the size of the file plus @var{offset} |
0ce1b118 CV |
35481 | bytes. |
35482 | @end table | |
35483 | ||
fc320d37 | 35484 | @item Return value: |
0ce1b118 CV |
35485 | On success, the resulting unsigned offset in bytes from |
35486 | the beginning of the file is returned. Otherwise, a | |
35487 | value of -1 is returned. | |
35488 | ||
fc320d37 | 35489 | @item Errors: |
0ce1b118 CV |
35490 | |
35491 | @table @code | |
b383017d | 35492 | @item EBADF |
fc320d37 | 35493 | @var{fd} is not a valid open file descriptor. |
0ce1b118 | 35494 | |
b383017d | 35495 | @item ESPIPE |
fc320d37 | 35496 | @var{fd} is associated with the @value{GDBN} console. |
0ce1b118 | 35497 | |
b383017d | 35498 | @item EINVAL |
fc320d37 | 35499 | @var{flag} is not a proper value. |
0ce1b118 | 35500 | |
b383017d | 35501 | @item EINTR |
0ce1b118 CV |
35502 | The call was interrupted by the user. |
35503 | @end table | |
35504 | ||
fc320d37 SL |
35505 | @end table |
35506 | ||
0ce1b118 CV |
35507 | @node rename |
35508 | @unnumberedsubsubsec rename | |
35509 | @cindex rename, file-i/o system call | |
35510 | ||
fc320d37 SL |
35511 | @table @asis |
35512 | @item Synopsis: | |
0ce1b118 | 35513 | @smallexample |
0ce1b118 | 35514 | int rename(const char *oldpath, const char *newpath); |
fc320d37 | 35515 | @end smallexample |
0ce1b118 | 35516 | |
fc320d37 SL |
35517 | @item Request: |
35518 | @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}} | |
0ce1b118 | 35519 | |
fc320d37 | 35520 | @item Return value: |
0ce1b118 CV |
35521 | On success, zero is returned. On error, -1 is returned. |
35522 | ||
fc320d37 | 35523 | @item Errors: |
0ce1b118 CV |
35524 | |
35525 | @table @code | |
b383017d | 35526 | @item EISDIR |
fc320d37 | 35527 | @var{newpath} is an existing directory, but @var{oldpath} is not a |
0ce1b118 CV |
35528 | directory. |
35529 | ||
b383017d | 35530 | @item EEXIST |
fc320d37 | 35531 | @var{newpath} is a non-empty directory. |
0ce1b118 | 35532 | |
b383017d | 35533 | @item EBUSY |
fc320d37 | 35534 | @var{oldpath} or @var{newpath} is a directory that is in use by some |
0ce1b118 CV |
35535 | process. |
35536 | ||
b383017d | 35537 | @item EINVAL |
0ce1b118 CV |
35538 | An attempt was made to make a directory a subdirectory |
35539 | of itself. | |
35540 | ||
b383017d | 35541 | @item ENOTDIR |
fc320d37 SL |
35542 | A component used as a directory in @var{oldpath} or new |
35543 | path is not a directory. Or @var{oldpath} is a directory | |
35544 | and @var{newpath} exists but is not a directory. | |
0ce1b118 | 35545 | |
b383017d | 35546 | @item EFAULT |
fc320d37 | 35547 | @var{oldpathptr} or @var{newpathptr} are invalid pointer values. |
0ce1b118 | 35548 | |
b383017d | 35549 | @item EACCES |
0ce1b118 CV |
35550 | No access to the file or the path of the file. |
35551 | ||
35552 | @item ENAMETOOLONG | |
b383017d | 35553 | |
fc320d37 | 35554 | @var{oldpath} or @var{newpath} was too long. |
0ce1b118 | 35555 | |
b383017d | 35556 | @item ENOENT |
fc320d37 | 35557 | A directory component in @var{oldpath} or @var{newpath} does not exist. |
0ce1b118 | 35558 | |
b383017d | 35559 | @item EROFS |
0ce1b118 CV |
35560 | The file is on a read-only filesystem. |
35561 | ||
b383017d | 35562 | @item ENOSPC |
0ce1b118 CV |
35563 | The device containing the file has no room for the new |
35564 | directory entry. | |
35565 | ||
b383017d | 35566 | @item EINTR |
0ce1b118 CV |
35567 | The call was interrupted by the user. |
35568 | @end table | |
35569 | ||
fc320d37 SL |
35570 | @end table |
35571 | ||
0ce1b118 CV |
35572 | @node unlink |
35573 | @unnumberedsubsubsec unlink | |
35574 | @cindex unlink, file-i/o system call | |
35575 | ||
fc320d37 SL |
35576 | @table @asis |
35577 | @item Synopsis: | |
0ce1b118 | 35578 | @smallexample |
0ce1b118 | 35579 | int unlink(const char *pathname); |
fc320d37 | 35580 | @end smallexample |
0ce1b118 | 35581 | |
fc320d37 SL |
35582 | @item Request: |
35583 | @samp{Funlink,@var{pathnameptr}/@var{len}} | |
0ce1b118 | 35584 | |
fc320d37 | 35585 | @item Return value: |
0ce1b118 CV |
35586 | On success, zero is returned. On error, -1 is returned. |
35587 | ||
fc320d37 | 35588 | @item Errors: |
0ce1b118 CV |
35589 | |
35590 | @table @code | |
b383017d | 35591 | @item EACCES |
0ce1b118 CV |
35592 | No access to the file or the path of the file. |
35593 | ||
b383017d | 35594 | @item EPERM |
0ce1b118 CV |
35595 | The system does not allow unlinking of directories. |
35596 | ||
b383017d | 35597 | @item EBUSY |
fc320d37 | 35598 | The file @var{pathname} cannot be unlinked because it's |
0ce1b118 CV |
35599 | being used by another process. |
35600 | ||
b383017d | 35601 | @item EFAULT |
fc320d37 | 35602 | @var{pathnameptr} is an invalid pointer value. |
0ce1b118 CV |
35603 | |
35604 | @item ENAMETOOLONG | |
fc320d37 | 35605 | @var{pathname} was too long. |
0ce1b118 | 35606 | |
b383017d | 35607 | @item ENOENT |
fc320d37 | 35608 | A directory component in @var{pathname} does not exist. |
0ce1b118 | 35609 | |
b383017d | 35610 | @item ENOTDIR |
0ce1b118 CV |
35611 | A component of the path is not a directory. |
35612 | ||
b383017d | 35613 | @item EROFS |
0ce1b118 CV |
35614 | The file is on a read-only filesystem. |
35615 | ||
b383017d | 35616 | @item EINTR |
0ce1b118 CV |
35617 | The call was interrupted by the user. |
35618 | @end table | |
35619 | ||
fc320d37 SL |
35620 | @end table |
35621 | ||
0ce1b118 CV |
35622 | @node stat/fstat |
35623 | @unnumberedsubsubsec stat/fstat | |
35624 | @cindex fstat, file-i/o system call | |
35625 | @cindex stat, file-i/o system call | |
35626 | ||
fc320d37 SL |
35627 | @table @asis |
35628 | @item Synopsis: | |
0ce1b118 | 35629 | @smallexample |
0ce1b118 CV |
35630 | int stat(const char *pathname, struct stat *buf); |
35631 | int fstat(int fd, struct stat *buf); | |
fc320d37 | 35632 | @end smallexample |
0ce1b118 | 35633 | |
fc320d37 SL |
35634 | @item Request: |
35635 | @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@* | |
35636 | @samp{Ffstat,@var{fd},@var{bufptr}} | |
0ce1b118 | 35637 | |
fc320d37 | 35638 | @item Return value: |
0ce1b118 CV |
35639 | On success, zero is returned. On error, -1 is returned. |
35640 | ||
fc320d37 | 35641 | @item Errors: |
0ce1b118 CV |
35642 | |
35643 | @table @code | |
b383017d | 35644 | @item EBADF |
fc320d37 | 35645 | @var{fd} is not a valid open file. |
0ce1b118 | 35646 | |
b383017d | 35647 | @item ENOENT |
fc320d37 | 35648 | A directory component in @var{pathname} does not exist or the |
0ce1b118 CV |
35649 | path is an empty string. |
35650 | ||
b383017d | 35651 | @item ENOTDIR |
0ce1b118 CV |
35652 | A component of the path is not a directory. |
35653 | ||
b383017d | 35654 | @item EFAULT |
fc320d37 | 35655 | @var{pathnameptr} is an invalid pointer value. |
0ce1b118 | 35656 | |
b383017d | 35657 | @item EACCES |
0ce1b118 CV |
35658 | No access to the file or the path of the file. |
35659 | ||
35660 | @item ENAMETOOLONG | |
fc320d37 | 35661 | @var{pathname} was too long. |
0ce1b118 | 35662 | |
b383017d | 35663 | @item EINTR |
0ce1b118 CV |
35664 | The call was interrupted by the user. |
35665 | @end table | |
35666 | ||
fc320d37 SL |
35667 | @end table |
35668 | ||
0ce1b118 CV |
35669 | @node gettimeofday |
35670 | @unnumberedsubsubsec gettimeofday | |
35671 | @cindex gettimeofday, file-i/o system call | |
35672 | ||
fc320d37 SL |
35673 | @table @asis |
35674 | @item Synopsis: | |
0ce1b118 | 35675 | @smallexample |
0ce1b118 | 35676 | int gettimeofday(struct timeval *tv, void *tz); |
fc320d37 | 35677 | @end smallexample |
0ce1b118 | 35678 | |
fc320d37 SL |
35679 | @item Request: |
35680 | @samp{Fgettimeofday,@var{tvptr},@var{tzptr}} | |
0ce1b118 | 35681 | |
fc320d37 | 35682 | @item Return value: |
0ce1b118 CV |
35683 | On success, 0 is returned, -1 otherwise. |
35684 | ||
fc320d37 | 35685 | @item Errors: |
0ce1b118 CV |
35686 | |
35687 | @table @code | |
b383017d | 35688 | @item EINVAL |
fc320d37 | 35689 | @var{tz} is a non-NULL pointer. |
0ce1b118 | 35690 | |
b383017d | 35691 | @item EFAULT |
fc320d37 SL |
35692 | @var{tvptr} and/or @var{tzptr} is an invalid pointer value. |
35693 | @end table | |
35694 | ||
0ce1b118 CV |
35695 | @end table |
35696 | ||
35697 | @node isatty | |
35698 | @unnumberedsubsubsec isatty | |
35699 | @cindex isatty, file-i/o system call | |
35700 | ||
fc320d37 SL |
35701 | @table @asis |
35702 | @item Synopsis: | |
0ce1b118 | 35703 | @smallexample |
0ce1b118 | 35704 | int isatty(int fd); |
fc320d37 | 35705 | @end smallexample |
0ce1b118 | 35706 | |
fc320d37 SL |
35707 | @item Request: |
35708 | @samp{Fisatty,@var{fd}} | |
0ce1b118 | 35709 | |
fc320d37 SL |
35710 | @item Return value: |
35711 | Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise. | |
0ce1b118 | 35712 | |
fc320d37 | 35713 | @item Errors: |
0ce1b118 CV |
35714 | |
35715 | @table @code | |
b383017d | 35716 | @item EINTR |
0ce1b118 CV |
35717 | The call was interrupted by the user. |
35718 | @end table | |
35719 | ||
fc320d37 SL |
35720 | @end table |
35721 | ||
35722 | Note that the @code{isatty} call is treated as a special case: it returns | |
35723 | 1 to the target if the file descriptor is attached | |
35724 | to the @value{GDBN} console, 0 otherwise. Implementing through system calls | |
35725 | would require implementing @code{ioctl} and would be more complex than | |
35726 | needed. | |
35727 | ||
35728 | ||
0ce1b118 CV |
35729 | @node system |
35730 | @unnumberedsubsubsec system | |
35731 | @cindex system, file-i/o system call | |
35732 | ||
fc320d37 SL |
35733 | @table @asis |
35734 | @item Synopsis: | |
0ce1b118 | 35735 | @smallexample |
0ce1b118 | 35736 | int system(const char *command); |
fc320d37 | 35737 | @end smallexample |
0ce1b118 | 35738 | |
fc320d37 SL |
35739 | @item Request: |
35740 | @samp{Fsystem,@var{commandptr}/@var{len}} | |
0ce1b118 | 35741 | |
fc320d37 | 35742 | @item Return value: |
5600ea19 NS |
35743 | If @var{len} is zero, the return value indicates whether a shell is |
35744 | available. A zero return value indicates a shell is not available. | |
35745 | For non-zero @var{len}, the value returned is -1 on error and the | |
35746 | return status of the command otherwise. Only the exit status of the | |
35747 | command is returned, which is extracted from the host's @code{system} | |
35748 | return value by calling @code{WEXITSTATUS(retval)}. In case | |
35749 | @file{/bin/sh} could not be executed, 127 is returned. | |
0ce1b118 | 35750 | |
fc320d37 | 35751 | @item Errors: |
0ce1b118 CV |
35752 | |
35753 | @table @code | |
b383017d | 35754 | @item EINTR |
0ce1b118 CV |
35755 | The call was interrupted by the user. |
35756 | @end table | |
35757 | ||
fc320d37 SL |
35758 | @end table |
35759 | ||
35760 | @value{GDBN} takes over the full task of calling the necessary host calls | |
35761 | to perform the @code{system} call. The return value of @code{system} on | |
35762 | the host is simplified before it's returned | |
35763 | to the target. Any termination signal information from the child process | |
35764 | is discarded, and the return value consists | |
35765 | entirely of the exit status of the called command. | |
35766 | ||
35767 | Due to security concerns, the @code{system} call is by default refused | |
35768 | by @value{GDBN}. The user has to allow this call explicitly with the | |
35769 | @code{set remote system-call-allowed 1} command. | |
35770 | ||
35771 | @table @code | |
35772 | @item set remote system-call-allowed | |
35773 | @kindex set remote system-call-allowed | |
35774 | Control whether to allow the @code{system} calls in the File I/O | |
35775 | protocol for the remote target. The default is zero (disabled). | |
35776 | ||
35777 | @item show remote system-call-allowed | |
35778 | @kindex show remote system-call-allowed | |
35779 | Show whether the @code{system} calls are allowed in the File I/O | |
35780 | protocol. | |
35781 | @end table | |
35782 | ||
db2e3e2e BW |
35783 | @node Protocol-specific Representation of Datatypes |
35784 | @subsection Protocol-specific Representation of Datatypes | |
35785 | @cindex protocol-specific representation of datatypes, in file-i/o protocol | |
0ce1b118 CV |
35786 | |
35787 | @menu | |
79a6e687 BW |
35788 | * Integral Datatypes:: |
35789 | * Pointer Values:: | |
35790 | * Memory Transfer:: | |
0ce1b118 CV |
35791 | * struct stat:: |
35792 | * struct timeval:: | |
35793 | @end menu | |
35794 | ||
79a6e687 BW |
35795 | @node Integral Datatypes |
35796 | @unnumberedsubsubsec Integral Datatypes | |
0ce1b118 CV |
35797 | @cindex integral datatypes, in file-i/o protocol |
35798 | ||
fc320d37 SL |
35799 | The integral datatypes used in the system calls are @code{int}, |
35800 | @code{unsigned int}, @code{long}, @code{unsigned long}, | |
35801 | @code{mode_t}, and @code{time_t}. | |
0ce1b118 | 35802 | |
fc320d37 | 35803 | @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are |
0ce1b118 CV |
35804 | implemented as 32 bit values in this protocol. |
35805 | ||
fc320d37 | 35806 | @code{long} and @code{unsigned long} are implemented as 64 bit types. |
b383017d | 35807 | |
0ce1b118 CV |
35808 | @xref{Limits}, for corresponding MIN and MAX values (similar to those |
35809 | in @file{limits.h}) to allow range checking on host and target. | |
35810 | ||
35811 | @code{time_t} datatypes are defined as seconds since the Epoch. | |
35812 | ||
35813 | All integral datatypes transferred as part of a memory read or write of a | |
35814 | structured datatype e.g.@: a @code{struct stat} have to be given in big endian | |
35815 | byte order. | |
35816 | ||
79a6e687 BW |
35817 | @node Pointer Values |
35818 | @unnumberedsubsubsec Pointer Values | |
0ce1b118 CV |
35819 | @cindex pointer values, in file-i/o protocol |
35820 | ||
35821 | Pointers to target data are transmitted as they are. An exception | |
35822 | is made for pointers to buffers for which the length isn't | |
35823 | transmitted as part of the function call, namely strings. Strings | |
35824 | are transmitted as a pointer/length pair, both as hex values, e.g.@: | |
35825 | ||
35826 | @smallexample | |
35827 | @code{1aaf/12} | |
35828 | @end smallexample | |
35829 | ||
35830 | @noindent | |
35831 | which is a pointer to data of length 18 bytes at position 0x1aaf. | |
35832 | The length is defined as the full string length in bytes, including | |
fc320d37 SL |
35833 | the trailing null byte. For example, the string @code{"hello world"} |
35834 | at address 0x123456 is transmitted as | |
0ce1b118 CV |
35835 | |
35836 | @smallexample | |
fc320d37 | 35837 | @code{123456/d} |
0ce1b118 CV |
35838 | @end smallexample |
35839 | ||
79a6e687 BW |
35840 | @node Memory Transfer |
35841 | @unnumberedsubsubsec Memory Transfer | |
fc320d37 SL |
35842 | @cindex memory transfer, in file-i/o protocol |
35843 | ||
35844 | Structured data which is transferred using a memory read or write (for | |
db2e3e2e | 35845 | example, a @code{struct stat}) is expected to be in a protocol-specific format |
fc320d37 SL |
35846 | with all scalar multibyte datatypes being big endian. Translation to |
35847 | this representation needs to be done both by the target before the @code{F} | |
35848 | packet is sent, and by @value{GDBN} before | |
35849 | it transfers memory to the target. Transferred pointers to structured | |
35850 | data should point to the already-coerced data at any time. | |
0ce1b118 | 35851 | |
0ce1b118 CV |
35852 | |
35853 | @node struct stat | |
35854 | @unnumberedsubsubsec struct stat | |
35855 | @cindex struct stat, in file-i/o protocol | |
35856 | ||
fc320d37 SL |
35857 | The buffer of type @code{struct stat} used by the target and @value{GDBN} |
35858 | is defined as follows: | |
0ce1b118 CV |
35859 | |
35860 | @smallexample | |
35861 | struct stat @{ | |
35862 | unsigned int st_dev; /* device */ | |
35863 | unsigned int st_ino; /* inode */ | |
35864 | mode_t st_mode; /* protection */ | |
35865 | unsigned int st_nlink; /* number of hard links */ | |
35866 | unsigned int st_uid; /* user ID of owner */ | |
35867 | unsigned int st_gid; /* group ID of owner */ | |
35868 | unsigned int st_rdev; /* device type (if inode device) */ | |
35869 | unsigned long st_size; /* total size, in bytes */ | |
35870 | unsigned long st_blksize; /* blocksize for filesystem I/O */ | |
35871 | unsigned long st_blocks; /* number of blocks allocated */ | |
35872 | time_t st_atime; /* time of last access */ | |
35873 | time_t st_mtime; /* time of last modification */ | |
35874 | time_t st_ctime; /* time of last change */ | |
35875 | @}; | |
35876 | @end smallexample | |
35877 | ||
fc320d37 | 35878 | The integral datatypes conform to the definitions given in the |
79a6e687 | 35879 | appropriate section (see @ref{Integral Datatypes}, for details) so this |
0ce1b118 CV |
35880 | structure is of size 64 bytes. |
35881 | ||
35882 | The values of several fields have a restricted meaning and/or | |
35883 | range of values. | |
35884 | ||
fc320d37 | 35885 | @table @code |
0ce1b118 | 35886 | |
fc320d37 SL |
35887 | @item st_dev |
35888 | A value of 0 represents a file, 1 the console. | |
0ce1b118 | 35889 | |
fc320d37 SL |
35890 | @item st_ino |
35891 | No valid meaning for the target. Transmitted unchanged. | |
0ce1b118 | 35892 | |
fc320d37 SL |
35893 | @item st_mode |
35894 | Valid mode bits are described in @ref{Constants}. Any other | |
35895 | bits have currently no meaning for the target. | |
0ce1b118 | 35896 | |
fc320d37 SL |
35897 | @item st_uid |
35898 | @itemx st_gid | |
35899 | @itemx st_rdev | |
35900 | No valid meaning for the target. Transmitted unchanged. | |
0ce1b118 | 35901 | |
fc320d37 SL |
35902 | @item st_atime |
35903 | @itemx st_mtime | |
35904 | @itemx st_ctime | |
35905 | These values have a host and file system dependent | |
35906 | accuracy. Especially on Windows hosts, the file system may not | |
35907 | support exact timing values. | |
35908 | @end table | |
0ce1b118 | 35909 | |
fc320d37 SL |
35910 | The target gets a @code{struct stat} of the above representation and is |
35911 | responsible for coercing it to the target representation before | |
0ce1b118 CV |
35912 | continuing. |
35913 | ||
fc320d37 SL |
35914 | Note that due to size differences between the host, target, and protocol |
35915 | representations of @code{struct stat} members, these members could eventually | |
0ce1b118 CV |
35916 | get truncated on the target. |
35917 | ||
35918 | @node struct timeval | |
35919 | @unnumberedsubsubsec struct timeval | |
35920 | @cindex struct timeval, in file-i/o protocol | |
35921 | ||
fc320d37 | 35922 | The buffer of type @code{struct timeval} used by the File-I/O protocol |
0ce1b118 CV |
35923 | is defined as follows: |
35924 | ||
35925 | @smallexample | |
b383017d | 35926 | struct timeval @{ |
0ce1b118 CV |
35927 | time_t tv_sec; /* second */ |
35928 | long tv_usec; /* microsecond */ | |
35929 | @}; | |
35930 | @end smallexample | |
35931 | ||
fc320d37 | 35932 | The integral datatypes conform to the definitions given in the |
79a6e687 | 35933 | appropriate section (see @ref{Integral Datatypes}, for details) so this |
0ce1b118 CV |
35934 | structure is of size 8 bytes. |
35935 | ||
35936 | @node Constants | |
35937 | @subsection Constants | |
35938 | @cindex constants, in file-i/o protocol | |
35939 | ||
35940 | The following values are used for the constants inside of the | |
fc320d37 | 35941 | protocol. @value{GDBN} and target are responsible for translating these |
0ce1b118 CV |
35942 | values before and after the call as needed. |
35943 | ||
35944 | @menu | |
79a6e687 BW |
35945 | * Open Flags:: |
35946 | * mode_t Values:: | |
35947 | * Errno Values:: | |
35948 | * Lseek Flags:: | |
0ce1b118 CV |
35949 | * Limits:: |
35950 | @end menu | |
35951 | ||
79a6e687 BW |
35952 | @node Open Flags |
35953 | @unnumberedsubsubsec Open Flags | |
0ce1b118 CV |
35954 | @cindex open flags, in file-i/o protocol |
35955 | ||
35956 | All values are given in hexadecimal representation. | |
35957 | ||
35958 | @smallexample | |
35959 | O_RDONLY 0x0 | |
35960 | O_WRONLY 0x1 | |
35961 | O_RDWR 0x2 | |
35962 | O_APPEND 0x8 | |
35963 | O_CREAT 0x200 | |
35964 | O_TRUNC 0x400 | |
35965 | O_EXCL 0x800 | |
35966 | @end smallexample | |
35967 | ||
79a6e687 BW |
35968 | @node mode_t Values |
35969 | @unnumberedsubsubsec mode_t Values | |
0ce1b118 CV |
35970 | @cindex mode_t values, in file-i/o protocol |
35971 | ||
35972 | All values are given in octal representation. | |
35973 | ||
35974 | @smallexample | |
35975 | S_IFREG 0100000 | |
35976 | S_IFDIR 040000 | |
35977 | S_IRUSR 0400 | |
35978 | S_IWUSR 0200 | |
35979 | S_IXUSR 0100 | |
35980 | S_IRGRP 040 | |
35981 | S_IWGRP 020 | |
35982 | S_IXGRP 010 | |
35983 | S_IROTH 04 | |
35984 | S_IWOTH 02 | |
35985 | S_IXOTH 01 | |
35986 | @end smallexample | |
35987 | ||
79a6e687 BW |
35988 | @node Errno Values |
35989 | @unnumberedsubsubsec Errno Values | |
0ce1b118 CV |
35990 | @cindex errno values, in file-i/o protocol |
35991 | ||
35992 | All values are given in decimal representation. | |
35993 | ||
35994 | @smallexample | |
35995 | EPERM 1 | |
35996 | ENOENT 2 | |
35997 | EINTR 4 | |
35998 | EBADF 9 | |
35999 | EACCES 13 | |
36000 | EFAULT 14 | |
36001 | EBUSY 16 | |
36002 | EEXIST 17 | |
36003 | ENODEV 19 | |
36004 | ENOTDIR 20 | |
36005 | EISDIR 21 | |
36006 | EINVAL 22 | |
36007 | ENFILE 23 | |
36008 | EMFILE 24 | |
36009 | EFBIG 27 | |
36010 | ENOSPC 28 | |
36011 | ESPIPE 29 | |
36012 | EROFS 30 | |
36013 | ENAMETOOLONG 91 | |
36014 | EUNKNOWN 9999 | |
36015 | @end smallexample | |
36016 | ||
fc320d37 | 36017 | @code{EUNKNOWN} is used as a fallback error value if a host system returns |
0ce1b118 CV |
36018 | any error value not in the list of supported error numbers. |
36019 | ||
79a6e687 BW |
36020 | @node Lseek Flags |
36021 | @unnumberedsubsubsec Lseek Flags | |
0ce1b118 CV |
36022 | @cindex lseek flags, in file-i/o protocol |
36023 | ||
36024 | @smallexample | |
36025 | SEEK_SET 0 | |
36026 | SEEK_CUR 1 | |
36027 | SEEK_END 2 | |
36028 | @end smallexample | |
36029 | ||
36030 | @node Limits | |
36031 | @unnumberedsubsubsec Limits | |
36032 | @cindex limits, in file-i/o protocol | |
36033 | ||
36034 | All values are given in decimal representation. | |
36035 | ||
36036 | @smallexample | |
36037 | INT_MIN -2147483648 | |
36038 | INT_MAX 2147483647 | |
36039 | UINT_MAX 4294967295 | |
36040 | LONG_MIN -9223372036854775808 | |
36041 | LONG_MAX 9223372036854775807 | |
36042 | ULONG_MAX 18446744073709551615 | |
36043 | @end smallexample | |
36044 | ||
36045 | @node File-I/O Examples | |
36046 | @subsection File-I/O Examples | |
36047 | @cindex file-i/o examples | |
36048 | ||
36049 | Example sequence of a write call, file descriptor 3, buffer is at target | |
36050 | address 0x1234, 6 bytes should be written: | |
36051 | ||
36052 | @smallexample | |
36053 | <- @code{Fwrite,3,1234,6} | |
36054 | @emph{request memory read from target} | |
36055 | -> @code{m1234,6} | |
36056 | <- XXXXXX | |
36057 | @emph{return "6 bytes written"} | |
36058 | -> @code{F6} | |
36059 | @end smallexample | |
36060 | ||
36061 | Example sequence of a read call, file descriptor 3, buffer is at target | |
36062 | address 0x1234, 6 bytes should be read: | |
36063 | ||
36064 | @smallexample | |
36065 | <- @code{Fread,3,1234,6} | |
36066 | @emph{request memory write to target} | |
36067 | -> @code{X1234,6:XXXXXX} | |
36068 | @emph{return "6 bytes read"} | |
36069 | -> @code{F6} | |
36070 | @end smallexample | |
36071 | ||
36072 | Example sequence of a read call, call fails on the host due to invalid | |
fc320d37 | 36073 | file descriptor (@code{EBADF}): |
0ce1b118 CV |
36074 | |
36075 | @smallexample | |
36076 | <- @code{Fread,3,1234,6} | |
36077 | -> @code{F-1,9} | |
36078 | @end smallexample | |
36079 | ||
c8aa23ab | 36080 | Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on |
0ce1b118 CV |
36081 | host is called: |
36082 | ||
36083 | @smallexample | |
36084 | <- @code{Fread,3,1234,6} | |
36085 | -> @code{F-1,4,C} | |
36086 | <- @code{T02} | |
36087 | @end smallexample | |
36088 | ||
c8aa23ab | 36089 | Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on |
0ce1b118 CV |
36090 | host is called: |
36091 | ||
36092 | @smallexample | |
36093 | <- @code{Fread,3,1234,6} | |
36094 | -> @code{X1234,6:XXXXXX} | |
36095 | <- @code{T02} | |
36096 | @end smallexample | |
36097 | ||
cfa9d6d9 DJ |
36098 | @node Library List Format |
36099 | @section Library List Format | |
36100 | @cindex library list format, remote protocol | |
36101 | ||
36102 | On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the | |
36103 | same process as your application to manage libraries. In this case, | |
36104 | @value{GDBN} can use the loader's symbol table and normal memory | |
36105 | operations to maintain a list of shared libraries. On other | |
36106 | platforms, the operating system manages loaded libraries. | |
36107 | @value{GDBN} can not retrieve the list of currently loaded libraries | |
36108 | through memory operations, so it uses the @samp{qXfer:libraries:read} | |
36109 | packet (@pxref{qXfer library list read}) instead. The remote stub | |
36110 | queries the target's operating system and reports which libraries | |
36111 | are loaded. | |
36112 | ||
36113 | The @samp{qXfer:libraries:read} packet returns an XML document which | |
36114 | lists loaded libraries and their offsets. Each library has an | |
1fddbabb PA |
36115 | associated name and one or more segment or section base addresses, |
36116 | which report where the library was loaded in memory. | |
36117 | ||
36118 | For the common case of libraries that are fully linked binaries, the | |
36119 | library should have a list of segments. If the target supports | |
36120 | dynamic linking of a relocatable object file, its library XML element | |
36121 | should instead include a list of allocated sections. The segment or | |
36122 | section bases are start addresses, not relocation offsets; they do not | |
36123 | depend on the library's link-time base addresses. | |
cfa9d6d9 | 36124 | |
9cceb671 DJ |
36125 | @value{GDBN} must be linked with the Expat library to support XML |
36126 | library lists. @xref{Expat}. | |
36127 | ||
cfa9d6d9 DJ |
36128 | A simple memory map, with one loaded library relocated by a single |
36129 | offset, looks like this: | |
36130 | ||
36131 | @smallexample | |
36132 | <library-list> | |
36133 | <library name="/lib/libc.so.6"> | |
36134 | <segment address="0x10000000"/> | |
36135 | </library> | |
36136 | </library-list> | |
36137 | @end smallexample | |
36138 | ||
1fddbabb PA |
36139 | Another simple memory map, with one loaded library with three |
36140 | allocated sections (.text, .data, .bss), looks like this: | |
36141 | ||
36142 | @smallexample | |
36143 | <library-list> | |
36144 | <library name="sharedlib.o"> | |
36145 | <section address="0x10000000"/> | |
36146 | <section address="0x20000000"/> | |
36147 | <section address="0x30000000"/> | |
36148 | </library> | |
36149 | </library-list> | |
36150 | @end smallexample | |
36151 | ||
cfa9d6d9 DJ |
36152 | The format of a library list is described by this DTD: |
36153 | ||
36154 | @smallexample | |
36155 | <!-- library-list: Root element with versioning --> | |
36156 | <!ELEMENT library-list (library)*> | |
36157 | <!ATTLIST library-list version CDATA #FIXED "1.0"> | |
1fddbabb | 36158 | <!ELEMENT library (segment*, section*)> |
cfa9d6d9 DJ |
36159 | <!ATTLIST library name CDATA #REQUIRED> |
36160 | <!ELEMENT segment EMPTY> | |
36161 | <!ATTLIST segment address CDATA #REQUIRED> | |
1fddbabb PA |
36162 | <!ELEMENT section EMPTY> |
36163 | <!ATTLIST section address CDATA #REQUIRED> | |
cfa9d6d9 DJ |
36164 | @end smallexample |
36165 | ||
1fddbabb PA |
36166 | In addition, segments and section descriptors cannot be mixed within a |
36167 | single library element, and you must supply at least one segment or | |
36168 | section for each library. | |
36169 | ||
79a6e687 BW |
36170 | @node Memory Map Format |
36171 | @section Memory Map Format | |
68437a39 DJ |
36172 | @cindex memory map format |
36173 | ||
36174 | To be able to write into flash memory, @value{GDBN} needs to obtain a | |
36175 | memory map from the target. This section describes the format of the | |
36176 | memory map. | |
36177 | ||
36178 | The memory map is obtained using the @samp{qXfer:memory-map:read} | |
36179 | (@pxref{qXfer memory map read}) packet and is an XML document that | |
9cceb671 DJ |
36180 | lists memory regions. |
36181 | ||
36182 | @value{GDBN} must be linked with the Expat library to support XML | |
36183 | memory maps. @xref{Expat}. | |
36184 | ||
36185 | The top-level structure of the document is shown below: | |
68437a39 DJ |
36186 | |
36187 | @smallexample | |
36188 | <?xml version="1.0"?> | |
36189 | <!DOCTYPE memory-map | |
36190 | PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN" | |
36191 | "http://sourceware.org/gdb/gdb-memory-map.dtd"> | |
36192 | <memory-map> | |
36193 | region... | |
36194 | </memory-map> | |
36195 | @end smallexample | |
36196 | ||
36197 | Each region can be either: | |
36198 | ||
36199 | @itemize | |
36200 | ||
36201 | @item | |
36202 | A region of RAM starting at @var{addr} and extending for @var{length} | |
36203 | bytes from there: | |
36204 | ||
36205 | @smallexample | |
36206 | <memory type="ram" start="@var{addr}" length="@var{length}"/> | |
36207 | @end smallexample | |
36208 | ||
36209 | ||
36210 | @item | |
36211 | A region of read-only memory: | |
36212 | ||
36213 | @smallexample | |
36214 | <memory type="rom" start="@var{addr}" length="@var{length}"/> | |
36215 | @end smallexample | |
36216 | ||
36217 | ||
36218 | @item | |
36219 | A region of flash memory, with erasure blocks @var{blocksize} | |
36220 | bytes in length: | |
36221 | ||
36222 | @smallexample | |
36223 | <memory type="flash" start="@var{addr}" length="@var{length}"> | |
36224 | <property name="blocksize">@var{blocksize}</property> | |
36225 | </memory> | |
36226 | @end smallexample | |
36227 | ||
36228 | @end itemize | |
36229 | ||
36230 | Regions must not overlap. @value{GDBN} assumes that areas of memory not covered | |
36231 | by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X} | |
36232 | packets to write to addresses in such ranges. | |
36233 | ||
36234 | The formal DTD for memory map format is given below: | |
36235 | ||
36236 | @smallexample | |
36237 | <!-- ................................................... --> | |
36238 | <!-- Memory Map XML DTD ................................ --> | |
36239 | <!-- File: memory-map.dtd .............................. --> | |
36240 | <!-- .................................... .............. --> | |
36241 | <!-- memory-map.dtd --> | |
36242 | <!-- memory-map: Root element with versioning --> | |
36243 | <!ELEMENT memory-map (memory | property)> | |
36244 | <!ATTLIST memory-map version CDATA #FIXED "1.0.0"> | |
36245 | <!ELEMENT memory (property)> | |
36246 | <!-- memory: Specifies a memory region, | |
36247 | and its type, or device. --> | |
36248 | <!ATTLIST memory type CDATA #REQUIRED | |
36249 | start CDATA #REQUIRED | |
36250 | length CDATA #REQUIRED | |
36251 | device CDATA #IMPLIED> | |
36252 | <!-- property: Generic attribute tag --> | |
36253 | <!ELEMENT property (#PCDATA | property)*> | |
36254 | <!ATTLIST property name CDATA #REQUIRED> | |
36255 | @end smallexample | |
36256 | ||
dc146f7c VP |
36257 | @node Thread List Format |
36258 | @section Thread List Format | |
36259 | @cindex thread list format | |
36260 | ||
36261 | To efficiently update the list of threads and their attributes, | |
36262 | @value{GDBN} issues the @samp{qXfer:threads:read} packet | |
36263 | (@pxref{qXfer threads read}) and obtains the XML document with | |
36264 | the following structure: | |
36265 | ||
36266 | @smallexample | |
36267 | <?xml version="1.0"?> | |
36268 | <threads> | |
36269 | <thread id="id" core="0"> | |
36270 | ... description ... | |
36271 | </thread> | |
36272 | </threads> | |
36273 | @end smallexample | |
36274 | ||
36275 | Each @samp{thread} element must have the @samp{id} attribute that | |
36276 | identifies the thread (@pxref{thread-id syntax}). The | |
36277 | @samp{core} attribute, if present, specifies which processor core | |
36278 | the thread was last executing on. The content of the of @samp{thread} | |
36279 | element is interpreted as human-readable auxilliary information. | |
36280 | ||
b3b9301e PA |
36281 | @node Traceframe Info Format |
36282 | @section Traceframe Info Format | |
36283 | @cindex traceframe info format | |
36284 | ||
36285 | To be able to know which objects in the inferior can be examined when | |
36286 | inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of | |
36287 | memory ranges, registers and trace state variables that have been | |
36288 | collected in a traceframe. | |
36289 | ||
36290 | This list is obtained using the @samp{qXfer:traceframe-info:read} | |
36291 | (@pxref{qXfer traceframe info read}) packet and is an XML document. | |
36292 | ||
36293 | @value{GDBN} must be linked with the Expat library to support XML | |
36294 | traceframe info discovery. @xref{Expat}. | |
36295 | ||
36296 | The top-level structure of the document is shown below: | |
36297 | ||
36298 | @smallexample | |
36299 | <?xml version="1.0"?> | |
36300 | <!DOCTYPE traceframe-info | |
36301 | PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN" | |
36302 | "http://sourceware.org/gdb/gdb-traceframe-info.dtd"> | |
36303 | <traceframe-info> | |
36304 | block... | |
36305 | </traceframe-info> | |
36306 | @end smallexample | |
36307 | ||
36308 | Each traceframe block can be either: | |
36309 | ||
36310 | @itemize | |
36311 | ||
36312 | @item | |
36313 | A region of collected memory starting at @var{addr} and extending for | |
36314 | @var{length} bytes from there: | |
36315 | ||
36316 | @smallexample | |
36317 | <memory start="@var{addr}" length="@var{length}"/> | |
36318 | @end smallexample | |
36319 | ||
36320 | @end itemize | |
36321 | ||
36322 | The formal DTD for the traceframe info format is given below: | |
36323 | ||
36324 | @smallexample | |
36325 | <!ELEMENT traceframe-info (memory)* > | |
36326 | <!ATTLIST traceframe-info version CDATA #FIXED "1.0"> | |
36327 | ||
36328 | <!ELEMENT memory EMPTY> | |
36329 | <!ATTLIST memory start CDATA #REQUIRED | |
36330 | length CDATA #REQUIRED> | |
36331 | @end smallexample | |
36332 | ||
f418dd93 DJ |
36333 | @include agentexpr.texi |
36334 | ||
23181151 DJ |
36335 | @node Target Descriptions |
36336 | @appendix Target Descriptions | |
36337 | @cindex target descriptions | |
36338 | ||
36339 | @strong{Warning:} target descriptions are still under active development, | |
36340 | and the contents and format may change between @value{GDBN} releases. | |
36341 | The format is expected to stabilize in the future. | |
36342 | ||
36343 | One of the challenges of using @value{GDBN} to debug embedded systems | |
36344 | is that there are so many minor variants of each processor | |
36345 | architecture in use. It is common practice for vendors to start with | |
36346 | a standard processor core --- ARM, PowerPC, or MIPS, for example --- | |
36347 | and then make changes to adapt it to a particular market niche. Some | |
36348 | architectures have hundreds of variants, available from dozens of | |
36349 | vendors. This leads to a number of problems: | |
36350 | ||
36351 | @itemize @bullet | |
36352 | @item | |
36353 | With so many different customized processors, it is difficult for | |
36354 | the @value{GDBN} maintainers to keep up with the changes. | |
36355 | @item | |
36356 | Since individual variants may have short lifetimes or limited | |
36357 | audiences, it may not be worthwhile to carry information about every | |
36358 | variant in the @value{GDBN} source tree. | |
36359 | @item | |
36360 | When @value{GDBN} does support the architecture of the embedded system | |
36361 | at hand, the task of finding the correct architecture name to give the | |
36362 | @command{set architecture} command can be error-prone. | |
36363 | @end itemize | |
36364 | ||
36365 | To address these problems, the @value{GDBN} remote protocol allows a | |
36366 | target system to not only identify itself to @value{GDBN}, but to | |
36367 | actually describe its own features. This lets @value{GDBN} support | |
36368 | processor variants it has never seen before --- to the extent that the | |
36369 | descriptions are accurate, and that @value{GDBN} understands them. | |
36370 | ||
9cceb671 DJ |
36371 | @value{GDBN} must be linked with the Expat library to support XML |
36372 | target descriptions. @xref{Expat}. | |
123dc839 | 36373 | |
23181151 DJ |
36374 | @menu |
36375 | * Retrieving Descriptions:: How descriptions are fetched from a target. | |
36376 | * Target Description Format:: The contents of a target description. | |
123dc839 DJ |
36377 | * Predefined Target Types:: Standard types available for target |
36378 | descriptions. | |
36379 | * Standard Target Features:: Features @value{GDBN} knows about. | |
23181151 DJ |
36380 | @end menu |
36381 | ||
36382 | @node Retrieving Descriptions | |
36383 | @section Retrieving Descriptions | |
36384 | ||
36385 | Target descriptions can be read from the target automatically, or | |
36386 | specified by the user manually. The default behavior is to read the | |
36387 | description from the target. @value{GDBN} retrieves it via the remote | |
36388 | protocol using @samp{qXfer} requests (@pxref{General Query Packets, | |
36389 | qXfer}). The @var{annex} in the @samp{qXfer} packet will be | |
36390 | @samp{target.xml}. The contents of the @samp{target.xml} annex are an | |
36391 | XML document, of the form described in @ref{Target Description | |
36392 | Format}. | |
36393 | ||
36394 | Alternatively, you can specify a file to read for the target description. | |
36395 | If a file is set, the target will not be queried. The commands to | |
36396 | specify a file are: | |
36397 | ||
36398 | @table @code | |
36399 | @cindex set tdesc filename | |
36400 | @item set tdesc filename @var{path} | |
36401 | Read the target description from @var{path}. | |
36402 | ||
36403 | @cindex unset tdesc filename | |
36404 | @item unset tdesc filename | |
36405 | Do not read the XML target description from a file. @value{GDBN} | |
36406 | will use the description supplied by the current target. | |
36407 | ||
36408 | @cindex show tdesc filename | |
36409 | @item show tdesc filename | |
36410 | Show the filename to read for a target description, if any. | |
36411 | @end table | |
36412 | ||
36413 | ||
36414 | @node Target Description Format | |
36415 | @section Target Description Format | |
36416 | @cindex target descriptions, XML format | |
36417 | ||
36418 | A target description annex is an @uref{http://www.w3.org/XML/, XML} | |
36419 | document which complies with the Document Type Definition provided in | |
36420 | the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This | |
36421 | means you can use generally available tools like @command{xmllint} to | |
36422 | check that your feature descriptions are well-formed and valid. | |
36423 | However, to help people unfamiliar with XML write descriptions for | |
36424 | their targets, we also describe the grammar here. | |
36425 | ||
123dc839 DJ |
36426 | Target descriptions can identify the architecture of the remote target |
36427 | and (for some architectures) provide information about custom register | |
08d16641 PA |
36428 | sets. They can also identify the OS ABI of the remote target. |
36429 | @value{GDBN} can use this information to autoconfigure for your | |
123dc839 | 36430 | target, or to warn you if you connect to an unsupported target. |
23181151 DJ |
36431 | |
36432 | Here is a simple target description: | |
36433 | ||
123dc839 | 36434 | @smallexample |
1780a0ed | 36435 | <target version="1.0"> |
23181151 DJ |
36436 | <architecture>i386:x86-64</architecture> |
36437 | </target> | |
123dc839 | 36438 | @end smallexample |
23181151 DJ |
36439 | |
36440 | @noindent | |
36441 | This minimal description only says that the target uses | |
36442 | the x86-64 architecture. | |
36443 | ||
123dc839 DJ |
36444 | A target description has the following overall form, with [ ] marking |
36445 | optional elements and @dots{} marking repeatable elements. The elements | |
36446 | are explained further below. | |
23181151 | 36447 | |
123dc839 | 36448 | @smallexample |
23181151 DJ |
36449 | <?xml version="1.0"?> |
36450 | <!DOCTYPE target SYSTEM "gdb-target.dtd"> | |
1780a0ed | 36451 | <target version="1.0"> |
123dc839 | 36452 | @r{[}@var{architecture}@r{]} |
08d16641 | 36453 | @r{[}@var{osabi}@r{]} |
e35359c5 | 36454 | @r{[}@var{compatible}@r{]} |
123dc839 | 36455 | @r{[}@var{feature}@dots{}@r{]} |
23181151 | 36456 | </target> |
123dc839 | 36457 | @end smallexample |
23181151 DJ |
36458 | |
36459 | @noindent | |
36460 | The description is generally insensitive to whitespace and line | |
36461 | breaks, under the usual common-sense rules. The XML version | |
36462 | declaration and document type declaration can generally be omitted | |
36463 | (@value{GDBN} does not require them), but specifying them may be | |
1780a0ed DJ |
36464 | useful for XML validation tools. The @samp{version} attribute for |
36465 | @samp{<target>} may also be omitted, but we recommend | |
36466 | including it; if future versions of @value{GDBN} use an incompatible | |
36467 | revision of @file{gdb-target.dtd}, they will detect and report | |
36468 | the version mismatch. | |
23181151 | 36469 | |
108546a0 DJ |
36470 | @subsection Inclusion |
36471 | @cindex target descriptions, inclusion | |
36472 | @cindex XInclude | |
36473 | @ifnotinfo | |
36474 | @cindex <xi:include> | |
36475 | @end ifnotinfo | |
36476 | ||
36477 | It can sometimes be valuable to split a target description up into | |
36478 | several different annexes, either for organizational purposes, or to | |
36479 | share files between different possible target descriptions. You can | |
36480 | divide a description into multiple files by replacing any element of | |
36481 | the target description with an inclusion directive of the form: | |
36482 | ||
123dc839 | 36483 | @smallexample |
108546a0 | 36484 | <xi:include href="@var{document}"/> |
123dc839 | 36485 | @end smallexample |
108546a0 DJ |
36486 | |
36487 | @noindent | |
36488 | When @value{GDBN} encounters an element of this form, it will retrieve | |
36489 | the named XML @var{document}, and replace the inclusion directive with | |
36490 | the contents of that document. If the current description was read | |
36491 | using @samp{qXfer}, then so will be the included document; | |
36492 | @var{document} will be interpreted as the name of an annex. If the | |
36493 | current description was read from a file, @value{GDBN} will look for | |
36494 | @var{document} as a file in the same directory where it found the | |
36495 | original description. | |
36496 | ||
123dc839 DJ |
36497 | @subsection Architecture |
36498 | @cindex <architecture> | |
36499 | ||
36500 | An @samp{<architecture>} element has this form: | |
36501 | ||
36502 | @smallexample | |
36503 | <architecture>@var{arch}</architecture> | |
36504 | @end smallexample | |
36505 | ||
e35359c5 UW |
36506 | @var{arch} is one of the architectures from the set accepted by |
36507 | @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}). | |
123dc839 | 36508 | |
08d16641 PA |
36509 | @subsection OS ABI |
36510 | @cindex @code{<osabi>} | |
36511 | ||
36512 | This optional field was introduced in @value{GDBN} version 7.0. | |
36513 | Previous versions of @value{GDBN} ignore it. | |
36514 | ||
36515 | An @samp{<osabi>} element has this form: | |
36516 | ||
36517 | @smallexample | |
36518 | <osabi>@var{abi-name}</osabi> | |
36519 | @end smallexample | |
36520 | ||
36521 | @var{abi-name} is an OS ABI name from the same selection accepted by | |
36522 | @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}). | |
36523 | ||
e35359c5 UW |
36524 | @subsection Compatible Architecture |
36525 | @cindex @code{<compatible>} | |
36526 | ||
36527 | This optional field was introduced in @value{GDBN} version 7.0. | |
36528 | Previous versions of @value{GDBN} ignore it. | |
36529 | ||
36530 | A @samp{<compatible>} element has this form: | |
36531 | ||
36532 | @smallexample | |
36533 | <compatible>@var{arch}</compatible> | |
36534 | @end smallexample | |
36535 | ||
36536 | @var{arch} is one of the architectures from the set accepted by | |
36537 | @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}). | |
36538 | ||
36539 | A @samp{<compatible>} element is used to specify that the target | |
36540 | is able to run binaries in some other than the main target architecture | |
36541 | given by the @samp{<architecture>} element. For example, on the | |
36542 | Cell Broadband Engine, the main architecture is @code{powerpc:common} | |
36543 | or @code{powerpc:common64}, but the system is able to run binaries | |
36544 | in the @code{spu} architecture as well. The way to describe this | |
36545 | capability with @samp{<compatible>} is as follows: | |
36546 | ||
36547 | @smallexample | |
36548 | <architecture>powerpc:common</architecture> | |
36549 | <compatible>spu</compatible> | |
36550 | @end smallexample | |
36551 | ||
123dc839 DJ |
36552 | @subsection Features |
36553 | @cindex <feature> | |
36554 | ||
36555 | Each @samp{<feature>} describes some logical portion of the target | |
36556 | system. Features are currently used to describe available CPU | |
36557 | registers and the types of their contents. A @samp{<feature>} element | |
36558 | has this form: | |
36559 | ||
36560 | @smallexample | |
36561 | <feature name="@var{name}"> | |
36562 | @r{[}@var{type}@dots{}@r{]} | |
36563 | @var{reg}@dots{} | |
36564 | </feature> | |
36565 | @end smallexample | |
36566 | ||
36567 | @noindent | |
36568 | Each feature's name should be unique within the description. The name | |
36569 | of a feature does not matter unless @value{GDBN} has some special | |
36570 | knowledge of the contents of that feature; if it does, the feature | |
36571 | should have its standard name. @xref{Standard Target Features}. | |
36572 | ||
36573 | @subsection Types | |
36574 | ||
36575 | Any register's value is a collection of bits which @value{GDBN} must | |
36576 | interpret. The default interpretation is a two's complement integer, | |
36577 | but other types can be requested by name in the register description. | |
36578 | Some predefined types are provided by @value{GDBN} (@pxref{Predefined | |
36579 | Target Types}), and the description can define additional composite types. | |
36580 | ||
36581 | Each type element must have an @samp{id} attribute, which gives | |
36582 | a unique (within the containing @samp{<feature>}) name to the type. | |
36583 | Types must be defined before they are used. | |
36584 | ||
36585 | @cindex <vector> | |
36586 | Some targets offer vector registers, which can be treated as arrays | |
36587 | of scalar elements. These types are written as @samp{<vector>} elements, | |
36588 | specifying the array element type, @var{type}, and the number of elements, | |
36589 | @var{count}: | |
36590 | ||
36591 | @smallexample | |
36592 | <vector id="@var{id}" type="@var{type}" count="@var{count}"/> | |
36593 | @end smallexample | |
36594 | ||
36595 | @cindex <union> | |
36596 | If a register's value is usefully viewed in multiple ways, define it | |
36597 | with a union type containing the useful representations. The | |
36598 | @samp{<union>} element contains one or more @samp{<field>} elements, | |
36599 | each of which has a @var{name} and a @var{type}: | |
36600 | ||
36601 | @smallexample | |
36602 | <union id="@var{id}"> | |
36603 | <field name="@var{name}" type="@var{type}"/> | |
36604 | @dots{} | |
36605 | </union> | |
36606 | @end smallexample | |
36607 | ||
f5dff777 DJ |
36608 | @cindex <struct> |
36609 | If a register's value is composed from several separate values, define | |
36610 | it with a structure type. There are two forms of the @samp{<struct>} | |
36611 | element; a @samp{<struct>} element must either contain only bitfields | |
36612 | or contain no bitfields. If the structure contains only bitfields, | |
36613 | its total size in bytes must be specified, each bitfield must have an | |
36614 | explicit start and end, and bitfields are automatically assigned an | |
36615 | integer type. The field's @var{start} should be less than or | |
36616 | equal to its @var{end}, and zero represents the least significant bit. | |
36617 | ||
36618 | @smallexample | |
36619 | <struct id="@var{id}" size="@var{size}"> | |
36620 | <field name="@var{name}" start="@var{start}" end="@var{end}"/> | |
36621 | @dots{} | |
36622 | </struct> | |
36623 | @end smallexample | |
36624 | ||
36625 | If the structure contains no bitfields, then each field has an | |
36626 | explicit type, and no implicit padding is added. | |
36627 | ||
36628 | @smallexample | |
36629 | <struct id="@var{id}"> | |
36630 | <field name="@var{name}" type="@var{type}"/> | |
36631 | @dots{} | |
36632 | </struct> | |
36633 | @end smallexample | |
36634 | ||
36635 | @cindex <flags> | |
36636 | If a register's value is a series of single-bit flags, define it with | |
36637 | a flags type. The @samp{<flags>} element has an explicit @var{size} | |
36638 | and contains one or more @samp{<field>} elements. Each field has a | |
36639 | @var{name}, a @var{start}, and an @var{end}. Only single-bit flags | |
36640 | are supported. | |
36641 | ||
36642 | @smallexample | |
36643 | <flags id="@var{id}" size="@var{size}"> | |
36644 | <field name="@var{name}" start="@var{start}" end="@var{end}"/> | |
36645 | @dots{} | |
36646 | </flags> | |
36647 | @end smallexample | |
36648 | ||
123dc839 DJ |
36649 | @subsection Registers |
36650 | @cindex <reg> | |
36651 | ||
36652 | Each register is represented as an element with this form: | |
36653 | ||
36654 | @smallexample | |
36655 | <reg name="@var{name}" | |
36656 | bitsize="@var{size}" | |
36657 | @r{[}regnum="@var{num}"@r{]} | |
36658 | @r{[}save-restore="@var{save-restore}"@r{]} | |
36659 | @r{[}type="@var{type}"@r{]} | |
36660 | @r{[}group="@var{group}"@r{]}/> | |
36661 | @end smallexample | |
36662 | ||
36663 | @noindent | |
36664 | The components are as follows: | |
36665 | ||
36666 | @table @var | |
36667 | ||
36668 | @item name | |
36669 | The register's name; it must be unique within the target description. | |
36670 | ||
36671 | @item bitsize | |
36672 | The register's size, in bits. | |
36673 | ||
36674 | @item regnum | |
36675 | The register's number. If omitted, a register's number is one greater | |
36676 | than that of the previous register (either in the current feature or in | |
36677 | a preceeding feature); the first register in the target description | |
36678 | defaults to zero. This register number is used to read or write | |
36679 | the register; e.g.@: it is used in the remote @code{p} and @code{P} | |
36680 | packets, and registers appear in the @code{g} and @code{G} packets | |
36681 | in order of increasing register number. | |
36682 | ||
36683 | @item save-restore | |
36684 | Whether the register should be preserved across inferior function | |
36685 | calls; this must be either @code{yes} or @code{no}. The default is | |
36686 | @code{yes}, which is appropriate for most registers except for | |
36687 | some system control registers; this is not related to the target's | |
36688 | ABI. | |
36689 | ||
36690 | @item type | |
36691 | The type of the register. @var{type} may be a predefined type, a type | |
36692 | defined in the current feature, or one of the special types @code{int} | |
36693 | and @code{float}. @code{int} is an integer type of the correct size | |
36694 | for @var{bitsize}, and @code{float} is a floating point type (in the | |
36695 | architecture's normal floating point format) of the correct size for | |
36696 | @var{bitsize}. The default is @code{int}. | |
36697 | ||
36698 | @item group | |
36699 | The register group to which this register belongs. @var{group} must | |
36700 | be either @code{general}, @code{float}, or @code{vector}. If no | |
36701 | @var{group} is specified, @value{GDBN} will not display the register | |
36702 | in @code{info registers}. | |
36703 | ||
36704 | @end table | |
36705 | ||
36706 | @node Predefined Target Types | |
36707 | @section Predefined Target Types | |
36708 | @cindex target descriptions, predefined types | |
36709 | ||
36710 | Type definitions in the self-description can build up composite types | |
36711 | from basic building blocks, but can not define fundamental types. Instead, | |
36712 | standard identifiers are provided by @value{GDBN} for the fundamental | |
36713 | types. The currently supported types are: | |
36714 | ||
36715 | @table @code | |
36716 | ||
36717 | @item int8 | |
36718 | @itemx int16 | |
36719 | @itemx int32 | |
36720 | @itemx int64 | |
7cc46491 | 36721 | @itemx int128 |
123dc839 DJ |
36722 | Signed integer types holding the specified number of bits. |
36723 | ||
36724 | @item uint8 | |
36725 | @itemx uint16 | |
36726 | @itemx uint32 | |
36727 | @itemx uint64 | |
7cc46491 | 36728 | @itemx uint128 |
123dc839 DJ |
36729 | Unsigned integer types holding the specified number of bits. |
36730 | ||
36731 | @item code_ptr | |
36732 | @itemx data_ptr | |
36733 | Pointers to unspecified code and data. The program counter and | |
36734 | any dedicated return address register may be marked as code | |
36735 | pointers; printing a code pointer converts it into a symbolic | |
36736 | address. The stack pointer and any dedicated address registers | |
36737 | may be marked as data pointers. | |
36738 | ||
6e3bbd1a PB |
36739 | @item ieee_single |
36740 | Single precision IEEE floating point. | |
36741 | ||
36742 | @item ieee_double | |
36743 | Double precision IEEE floating point. | |
36744 | ||
123dc839 DJ |
36745 | @item arm_fpa_ext |
36746 | The 12-byte extended precision format used by ARM FPA registers. | |
36747 | ||
075b51b7 L |
36748 | @item i387_ext |
36749 | The 10-byte extended precision format used by x87 registers. | |
36750 | ||
36751 | @item i386_eflags | |
36752 | 32bit @sc{eflags} register used by x86. | |
36753 | ||
36754 | @item i386_mxcsr | |
36755 | 32bit @sc{mxcsr} register used by x86. | |
36756 | ||
123dc839 DJ |
36757 | @end table |
36758 | ||
36759 | @node Standard Target Features | |
36760 | @section Standard Target Features | |
36761 | @cindex target descriptions, standard features | |
36762 | ||
36763 | A target description must contain either no registers or all the | |
36764 | target's registers. If the description contains no registers, then | |
36765 | @value{GDBN} will assume a default register layout, selected based on | |
36766 | the architecture. If the description contains any registers, the | |
36767 | default layout will not be used; the standard registers must be | |
36768 | described in the target description, in such a way that @value{GDBN} | |
36769 | can recognize them. | |
36770 | ||
36771 | This is accomplished by giving specific names to feature elements | |
36772 | which contain standard registers. @value{GDBN} will look for features | |
36773 | with those names and verify that they contain the expected registers; | |
36774 | if any known feature is missing required registers, or if any required | |
36775 | feature is missing, @value{GDBN} will reject the target | |
36776 | description. You can add additional registers to any of the | |
36777 | standard features --- @value{GDBN} will display them just as if | |
36778 | they were added to an unrecognized feature. | |
36779 | ||
36780 | This section lists the known features and their expected contents. | |
36781 | Sample XML documents for these features are included in the | |
36782 | @value{GDBN} source tree, in the directory @file{gdb/features}. | |
36783 | ||
36784 | Names recognized by @value{GDBN} should include the name of the | |
36785 | company or organization which selected the name, and the overall | |
36786 | architecture to which the feature applies; so e.g.@: the feature | |
36787 | containing ARM core registers is named @samp{org.gnu.gdb.arm.core}. | |
36788 | ||
ff6f572f DJ |
36789 | The names of registers are not case sensitive for the purpose |
36790 | of recognizing standard features, but @value{GDBN} will only display | |
36791 | registers using the capitalization used in the description. | |
36792 | ||
e9c17194 VP |
36793 | @menu |
36794 | * ARM Features:: | |
3bb8d5c3 | 36795 | * i386 Features:: |
1e26b4f8 | 36796 | * MIPS Features:: |
e9c17194 | 36797 | * M68K Features:: |
1e26b4f8 | 36798 | * PowerPC Features:: |
e9c17194 VP |
36799 | @end menu |
36800 | ||
36801 | ||
36802 | @node ARM Features | |
123dc839 DJ |
36803 | @subsection ARM Features |
36804 | @cindex target descriptions, ARM features | |
36805 | ||
9779414d DJ |
36806 | The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile |
36807 | ARM targets. | |
123dc839 DJ |
36808 | It should contain registers @samp{r0} through @samp{r13}, @samp{sp}, |
36809 | @samp{lr}, @samp{pc}, and @samp{cpsr}. | |
36810 | ||
9779414d DJ |
36811 | For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core} |
36812 | feature is replaced by @samp{org.gnu.gdb.arm.m-profile}. It should contain | |
36813 | registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc}, | |
36814 | and @samp{xpsr}. | |
36815 | ||
123dc839 DJ |
36816 | The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it |
36817 | should contain registers @samp{f0} through @samp{f7} and @samp{fps}. | |
36818 | ||
ff6f572f DJ |
36819 | The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present, |
36820 | it should contain at least registers @samp{wR0} through @samp{wR15} and | |
36821 | @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon}, | |
36822 | @samp{wCSSF}, and @samp{wCASF} registers are optional. | |
23181151 | 36823 | |
58d6951d DJ |
36824 | The @samp{org.gnu.gdb.arm.vfp} feature is optional. If present, it |
36825 | should contain at least registers @samp{d0} through @samp{d15}. If | |
36826 | they are present, @samp{d16} through @samp{d31} should also be included. | |
36827 | @value{GDBN} will synthesize the single-precision registers from | |
36828 | halves of the double-precision registers. | |
36829 | ||
36830 | The @samp{org.gnu.gdb.arm.neon} feature is optional. It does not | |
36831 | need to contain registers; it instructs @value{GDBN} to display the | |
36832 | VFP double-precision registers as vectors and to synthesize the | |
36833 | quad-precision registers from pairs of double-precision registers. | |
36834 | If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also | |
36835 | be present and include 32 double-precision registers. | |
36836 | ||
3bb8d5c3 L |
36837 | @node i386 Features |
36838 | @subsection i386 Features | |
36839 | @cindex target descriptions, i386 features | |
36840 | ||
36841 | The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64 | |
36842 | targets. It should describe the following registers: | |
36843 | ||
36844 | @itemize @minus | |
36845 | @item | |
36846 | @samp{eax} through @samp{edi} plus @samp{eip} for i386 | |
36847 | @item | |
36848 | @samp{rax} through @samp{r15} plus @samp{rip} for amd64 | |
36849 | @item | |
36850 | @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es}, | |
36851 | @samp{fs}, @samp{gs} | |
36852 | @item | |
36853 | @samp{st0} through @samp{st7} | |
36854 | @item | |
36855 | @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff}, | |
36856 | @samp{foseg}, @samp{fooff} and @samp{fop} | |
36857 | @end itemize | |
36858 | ||
36859 | The register sets may be different, depending on the target. | |
36860 | ||
3a13a53b | 36861 | The @samp{org.gnu.gdb.i386.sse} feature is optional. It should |
3bb8d5c3 L |
36862 | describe registers: |
36863 | ||
36864 | @itemize @minus | |
36865 | @item | |
36866 | @samp{xmm0} through @samp{xmm7} for i386 | |
36867 | @item | |
36868 | @samp{xmm0} through @samp{xmm15} for amd64 | |
36869 | @item | |
36870 | @samp{mxcsr} | |
36871 | @end itemize | |
36872 | ||
3a13a53b L |
36873 | The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the |
36874 | @samp{org.gnu.gdb.i386.sse} feature. It should | |
f68eb612 L |
36875 | describe the upper 128 bits of @sc{ymm} registers: |
36876 | ||
36877 | @itemize @minus | |
36878 | @item | |
36879 | @samp{ymm0h} through @samp{ymm7h} for i386 | |
36880 | @item | |
36881 | @samp{ymm0h} through @samp{ymm15h} for amd64 | |
f68eb612 L |
36882 | @end itemize |
36883 | ||
3bb8d5c3 L |
36884 | The @samp{org.gnu.gdb.i386.linux} feature is optional. It should |
36885 | describe a single register, @samp{orig_eax}. | |
36886 | ||
1e26b4f8 | 36887 | @node MIPS Features |
f8b73d13 DJ |
36888 | @subsection MIPS Features |
36889 | @cindex target descriptions, MIPS features | |
36890 | ||
36891 | The @samp{org.gnu.gdb.mips.cpu} feature is required for MIPS targets. | |
36892 | It should contain registers @samp{r0} through @samp{r31}, @samp{lo}, | |
36893 | @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending | |
36894 | on the target. | |
36895 | ||
36896 | The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should | |
36897 | contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause} | |
36898 | registers. They may be 32-bit or 64-bit depending on the target. | |
36899 | ||
36900 | The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though | |
36901 | it may be optional in a future version of @value{GDBN}. It should | |
36902 | contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and | |
36903 | @samp{fir}. They may be 32-bit or 64-bit depending on the target. | |
36904 | ||
822b6570 DJ |
36905 | The @samp{org.gnu.gdb.mips.linux} feature is optional. It should |
36906 | contain a single register, @samp{restart}, which is used by the | |
36907 | Linux kernel to control restartable syscalls. | |
36908 | ||
e9c17194 VP |
36909 | @node M68K Features |
36910 | @subsection M68K Features | |
36911 | @cindex target descriptions, M68K features | |
36912 | ||
36913 | @table @code | |
36914 | @item @samp{org.gnu.gdb.m68k.core} | |
36915 | @itemx @samp{org.gnu.gdb.coldfire.core} | |
36916 | @itemx @samp{org.gnu.gdb.fido.core} | |
36917 | One of those features must be always present. | |
249e1128 | 36918 | The feature that is present determines which flavor of m68k is |
e9c17194 VP |
36919 | used. The feature that is present should contain registers |
36920 | @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp}, | |
36921 | @samp{sp}, @samp{ps} and @samp{pc}. | |
36922 | ||
36923 | @item @samp{org.gnu.gdb.coldfire.fp} | |
36924 | This feature is optional. If present, it should contain registers | |
36925 | @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and | |
36926 | @samp{fpiaddr}. | |
36927 | @end table | |
36928 | ||
1e26b4f8 | 36929 | @node PowerPC Features |
7cc46491 DJ |
36930 | @subsection PowerPC Features |
36931 | @cindex target descriptions, PowerPC features | |
36932 | ||
36933 | The @samp{org.gnu.gdb.power.core} feature is required for PowerPC | |
36934 | targets. It should contain registers @samp{r0} through @samp{r31}, | |
36935 | @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and | |
36936 | @samp{xer}. They may be 32-bit or 64-bit depending on the target. | |
36937 | ||
36938 | The @samp{org.gnu.gdb.power.fpu} feature is optional. It should | |
36939 | contain registers @samp{f0} through @samp{f31} and @samp{fpscr}. | |
36940 | ||
36941 | The @samp{org.gnu.gdb.power.altivec} feature is optional. It should | |
36942 | contain registers @samp{vr0} through @samp{vr31}, @samp{vscr}, | |
36943 | and @samp{vrsave}. | |
36944 | ||
677c5bb1 LM |
36945 | The @samp{org.gnu.gdb.power.vsx} feature is optional. It should |
36946 | contain registers @samp{vs0h} through @samp{vs31h}. @value{GDBN} | |
36947 | will combine these registers with the floating point registers | |
36948 | (@samp{f0} through @samp{f31}) and the altivec registers (@samp{vr0} | |
aeac0ff9 | 36949 | through @samp{vr31}) to present the 128-bit wide registers @samp{vs0} |
677c5bb1 LM |
36950 | through @samp{vs63}, the set of vector registers for POWER7. |
36951 | ||
7cc46491 DJ |
36952 | The @samp{org.gnu.gdb.power.spe} feature is optional. It should |
36953 | contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and | |
36954 | @samp{spefscr}. SPE targets should provide 32-bit registers in | |
36955 | @samp{org.gnu.gdb.power.core} and provide the upper halves in | |
36956 | @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine | |
36957 | these to present registers @samp{ev0} through @samp{ev31} to the | |
36958 | user. | |
36959 | ||
07e059b5 VP |
36960 | @node Operating System Information |
36961 | @appendix Operating System Information | |
36962 | @cindex operating system information | |
36963 | ||
36964 | @menu | |
36965 | * Process list:: | |
36966 | @end menu | |
36967 | ||
36968 | Users of @value{GDBN} often wish to obtain information about the state of | |
36969 | the operating system running on the target---for example the list of | |
36970 | processes, or the list of open files. This section describes the | |
36971 | mechanism that makes it possible. This mechanism is similar to the | |
36972 | target features mechanism (@pxref{Target Descriptions}), but focuses | |
36973 | on a different aspect of target. | |
36974 | ||
36975 | Operating system information is retrived from the target via the | |
36976 | remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata | |
36977 | read}). The object name in the request should be @samp{osdata}, and | |
36978 | the @var{annex} identifies the data to be fetched. | |
36979 | ||
36980 | @node Process list | |
36981 | @appendixsection Process list | |
36982 | @cindex operating system information, process list | |
36983 | ||
36984 | When requesting the process list, the @var{annex} field in the | |
36985 | @samp{qXfer} request should be @samp{processes}. The returned data is | |
36986 | an XML document. The formal syntax of this document is defined in | |
36987 | @file{gdb/features/osdata.dtd}. | |
36988 | ||
36989 | An example document is: | |
36990 | ||
36991 | @smallexample | |
36992 | <?xml version="1.0"?> | |
36993 | <!DOCTYPE target SYSTEM "osdata.dtd"> | |
36994 | <osdata type="processes"> | |
36995 | <item> | |
36996 | <column name="pid">1</column> | |
36997 | <column name="user">root</column> | |
36998 | <column name="command">/sbin/init</column> | |
dc146f7c | 36999 | <column name="cores">1,2,3</column> |
07e059b5 VP |
37000 | </item> |
37001 | </osdata> | |
37002 | @end smallexample | |
37003 | ||
37004 | Each item should include a column whose name is @samp{pid}. The value | |
37005 | of that column should identify the process on the target. The | |
37006 | @samp{user} and @samp{command} columns are optional, and will be | |
dc146f7c VP |
37007 | displayed by @value{GDBN}. The @samp{cores} column, if present, |
37008 | should contain a comma-separated list of cores that this process | |
37009 | is running on. Target may provide additional columns, | |
07e059b5 VP |
37010 | which @value{GDBN} currently ignores. |
37011 | ||
05c8c3f5 TT |
37012 | @node Trace File Format |
37013 | @appendix Trace File Format | |
37014 | @cindex trace file format | |
37015 | ||
37016 | The trace file comes in three parts: a header, a textual description | |
37017 | section, and a trace frame section with binary data. | |
37018 | ||
37019 | The header has the form @code{\x7fTRACE0\n}. The first byte is | |
37020 | @code{0x7f} so as to indicate that the file contains binary data, | |
37021 | while the @code{0} is a version number that may have different values | |
37022 | in the future. | |
37023 | ||
37024 | The description section consists of multiple lines of @sc{ascii} text | |
37025 | separated by newline characters (@code{0xa}). The lines may include a | |
37026 | variety of optional descriptive or context-setting information, such | |
37027 | as tracepoint definitions or register set size. @value{GDBN} will | |
37028 | ignore any line that it does not recognize. An empty line marks the end | |
37029 | of this section. | |
37030 | ||
37031 | @c FIXME add some specific types of data | |
37032 | ||
37033 | The trace frame section consists of a number of consecutive frames. | |
37034 | Each frame begins with a two-byte tracepoint number, followed by a | |
37035 | four-byte size giving the amount of data in the frame. The data in | |
37036 | the frame consists of a number of blocks, each introduced by a | |
37037 | character indicating its type (at least register, memory, and trace | |
37038 | state variable). The data in this section is raw binary, not a | |
37039 | hexadecimal or other encoding; its endianness matches the target's | |
37040 | endianness. | |
37041 | ||
37042 | @c FIXME bi-arch may require endianness/arch info in description section | |
37043 | ||
37044 | @table @code | |
37045 | @item R @var{bytes} | |
37046 | Register block. The number and ordering of bytes matches that of a | |
37047 | @code{g} packet in the remote protocol. Note that these are the | |
37048 | actual bytes, in target order and @value{GDBN} register order, not a | |
37049 | hexadecimal encoding. | |
37050 | ||
37051 | @item M @var{address} @var{length} @var{bytes}... | |
37052 | Memory block. This is a contiguous block of memory, at the 8-byte | |
37053 | address @var{address}, with a 2-byte length @var{length}, followed by | |
37054 | @var{length} bytes. | |
37055 | ||
37056 | @item V @var{number} @var{value} | |
37057 | Trace state variable block. This records the 8-byte signed value | |
37058 | @var{value} of trace state variable numbered @var{number}. | |
37059 | ||
37060 | @end table | |
37061 | ||
37062 | Future enhancements of the trace file format may include additional types | |
37063 | of blocks. | |
37064 | ||
90476074 TT |
37065 | @node Index Section Format |
37066 | @appendix @code{.gdb_index} section format | |
37067 | @cindex .gdb_index section format | |
37068 | @cindex index section format | |
37069 | ||
37070 | This section documents the index section that is created by @code{save | |
37071 | gdb-index} (@pxref{Index Files}). The index section is | |
37072 | DWARF-specific; some knowledge of DWARF is assumed in this | |
37073 | description. | |
37074 | ||
37075 | The mapped index file format is designed to be directly | |
37076 | @code{mmap}able on any architecture. In most cases, a datum is | |
37077 | represented using a little-endian 32-bit integer value, called an | |
37078 | @code{offset_type}. Big endian machines must byte-swap the values | |
37079 | before using them. Exceptions to this rule are noted. The data is | |
37080 | laid out such that alignment is always respected. | |
37081 | ||
37082 | A mapped index consists of several areas, laid out in order. | |
37083 | ||
37084 | @enumerate | |
37085 | @item | |
37086 | The file header. This is a sequence of values, of @code{offset_type} | |
37087 | unless otherwise noted: | |
37088 | ||
37089 | @enumerate | |
37090 | @item | |
559a7a62 JK |
37091 | The version number, currently 5. Versions 1, 2 and 3 are obsolete. |
37092 | Version 4 differs by its hashing function. | |
90476074 TT |
37093 | |
37094 | @item | |
37095 | The offset, from the start of the file, of the CU list. | |
37096 | ||
37097 | @item | |
37098 | The offset, from the start of the file, of the types CU list. Note | |
37099 | that this area can be empty, in which case this offset will be equal | |
37100 | to the next offset. | |
37101 | ||
37102 | @item | |
37103 | The offset, from the start of the file, of the address area. | |
37104 | ||
37105 | @item | |
37106 | The offset, from the start of the file, of the symbol table. | |
37107 | ||
37108 | @item | |
37109 | The offset, from the start of the file, of the constant pool. | |
37110 | @end enumerate | |
37111 | ||
37112 | @item | |
37113 | The CU list. This is a sequence of pairs of 64-bit little-endian | |
37114 | values, sorted by the CU offset. The first element in each pair is | |
37115 | the offset of a CU in the @code{.debug_info} section. The second | |
37116 | element in each pair is the length of that CU. References to a CU | |
37117 | elsewhere in the map are done using a CU index, which is just the | |
37118 | 0-based index into this table. Note that if there are type CUs, then | |
37119 | conceptually CUs and type CUs form a single list for the purposes of | |
37120 | CU indices. | |
37121 | ||
37122 | @item | |
37123 | The types CU list. This is a sequence of triplets of 64-bit | |
37124 | little-endian values. In a triplet, the first value is the CU offset, | |
37125 | the second value is the type offset in the CU, and the third value is | |
37126 | the type signature. The types CU list is not sorted. | |
37127 | ||
37128 | @item | |
37129 | The address area. The address area consists of a sequence of address | |
37130 | entries. Each address entry has three elements: | |
37131 | ||
37132 | @enumerate | |
37133 | @item | |
37134 | The low address. This is a 64-bit little-endian value. | |
37135 | ||
37136 | @item | |
37137 | The high address. This is a 64-bit little-endian value. Like | |
37138 | @code{DW_AT_high_pc}, the value is one byte beyond the end. | |
37139 | ||
37140 | @item | |
37141 | The CU index. This is an @code{offset_type} value. | |
37142 | @end enumerate | |
37143 | ||
37144 | @item | |
37145 | The symbol table. This is an open-addressed hash table. The size of | |
37146 | the hash table is always a power of 2. | |
37147 | ||
37148 | Each slot in the hash table consists of a pair of @code{offset_type} | |
37149 | values. The first value is the offset of the symbol's name in the | |
37150 | constant pool. The second value is the offset of the CU vector in the | |
37151 | constant pool. | |
37152 | ||
37153 | If both values are 0, then this slot in the hash table is empty. This | |
37154 | is ok because while 0 is a valid constant pool index, it cannot be a | |
37155 | valid index for both a string and a CU vector. | |
37156 | ||
37157 | The hash value for a table entry is computed by applying an | |
37158 | iterative hash function to the symbol's name. Starting with an | |
37159 | initial value of @code{r = 0}, each (unsigned) character @samp{c} in | |
559a7a62 JK |
37160 | the string is incorporated into the hash using the formula depending on the |
37161 | index version: | |
37162 | ||
37163 | @table @asis | |
37164 | @item Version 4 | |
37165 | The formula is @code{r = r * 67 + c - 113}. | |
37166 | ||
37167 | @item Version 5 | |
37168 | The formula is @code{r = r * 67 + tolower (c) - 113}. | |
37169 | @end table | |
37170 | ||
37171 | The terminating @samp{\0} is not incorporated into the hash. | |
90476074 TT |
37172 | |
37173 | The step size used in the hash table is computed via | |
37174 | @code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash | |
37175 | value, and @samp{size} is the size of the hash table. The step size | |
37176 | is used to find the next candidate slot when handling a hash | |
37177 | collision. | |
37178 | ||
37179 | The names of C@t{++} symbols in the hash table are canonicalized. We | |
37180 | don't currently have a simple description of the canonicalization | |
37181 | algorithm; if you intend to create new index sections, you must read | |
37182 | the code. | |
37183 | ||
37184 | @item | |
37185 | The constant pool. This is simply a bunch of bytes. It is organized | |
37186 | so that alignment is correct: CU vectors are stored first, followed by | |
37187 | strings. | |
37188 | ||
37189 | A CU vector in the constant pool is a sequence of @code{offset_type} | |
37190 | values. The first value is the number of CU indices in the vector. | |
37191 | Each subsequent value is the index of a CU in the CU list. This | |
37192 | element in the hash table is used to indicate which CUs define the | |
37193 | symbol. | |
37194 | ||
37195 | A string in the constant pool is zero-terminated. | |
37196 | @end enumerate | |
37197 | ||
aab4e0ec | 37198 | @include gpl.texi |
eb12ee30 | 37199 | |
e4c0cfae SS |
37200 | @node GNU Free Documentation License |
37201 | @appendix GNU Free Documentation License | |
6826cf00 EZ |
37202 | @include fdl.texi |
37203 | ||
6d2ebf8b | 37204 | @node Index |
c906108c SS |
37205 | @unnumbered Index |
37206 | ||
37207 | @printindex cp | |
37208 | ||
37209 | @tex | |
37210 | % I think something like @colophon should be in texinfo. In the | |
37211 | % meantime: | |
37212 | \long\def\colophon{\hbox to0pt{}\vfill | |
37213 | \centerline{The body of this manual is set in} | |
37214 | \centerline{\fontname\tenrm,} | |
37215 | \centerline{with headings in {\bf\fontname\tenbf}} | |
37216 | \centerline{and examples in {\tt\fontname\tentt}.} | |
37217 | \centerline{{\it\fontname\tenit\/},} | |
37218 | \centerline{{\bf\fontname\tenbf}, and} | |
37219 | \centerline{{\sl\fontname\tensl\/}} | |
37220 | \centerline{are used for emphasis.}\vfill} | |
37221 | \page\colophon | |
37222 | % Blame: doc@cygnus.com, 1991. | |
37223 | @end tex | |
37224 | ||
c906108c | 37225 | @bye |