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. |
26829f2b | 33 | @set EDITION Tenth |
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@* | |
26829f2b | 100 | ISBN 978-0-9831592-3-0 @* |
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 | ||
03583c20 UW |
2047 | This feature is implemented only on certain targets, including @sc{gnu}/Linux. |
2048 | On @sc{gnu}/Linux you can get the same behavior using | |
10568435 JK |
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 | ||
03583c20 UW |
2062 | On targets where it is available, virtual address space randomization |
2063 | protects the programs against certain kinds of security attacks. In these | |
10568435 JK |
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 | ||
36b11add JK |
7280 | If you append @kbd{@@entry} string to a function parameter name you get its |
7281 | value at the time the function got called. If the value is not available an | |
7282 | error message is printed. Entry values are available only with some compilers. | |
7283 | Entry values are normally also printed at the function parameter list according | |
7284 | to @ref{set print entry-values}. | |
7285 | ||
7286 | @smallexample | |
7287 | Breakpoint 1, d (i=30) at gdb.base/entry-value.c:29 | |
7288 | 29 i++; | |
7289 | (gdb) next | |
7290 | 30 e (i); | |
7291 | (gdb) print i | |
7292 | $1 = 31 | |
7293 | (gdb) print i@@entry | |
7294 | $2 = 30 | |
7295 | @end smallexample | |
7296 | ||
3a60f64e JK |
7297 | Strings are identified as arrays of @code{char} values without specified |
7298 | signedness. Arrays of either @code{signed char} or @code{unsigned char} get | |
7299 | printed as arrays of 1 byte sized integers. @code{-fsigned-char} or | |
7300 | @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN} | |
7301 | defines literal string type @code{"char"} as @code{char} without a sign. | |
7302 | For program code | |
7303 | ||
7304 | @smallexample | |
7305 | char var0[] = "A"; | |
7306 | signed char var1[] = "A"; | |
7307 | @end smallexample | |
7308 | ||
7309 | You get during debugging | |
7310 | @smallexample | |
7311 | (gdb) print var0 | |
7312 | $1 = "A" | |
7313 | (gdb) print var1 | |
7314 | $2 = @{65 'A', 0 '\0'@} | |
7315 | @end smallexample | |
7316 | ||
6d2ebf8b | 7317 | @node Arrays |
79a6e687 | 7318 | @section Artificial Arrays |
c906108c SS |
7319 | |
7320 | @cindex artificial array | |
15387254 | 7321 | @cindex arrays |
41afff9a | 7322 | @kindex @@@r{, referencing memory as an array} |
c906108c SS |
7323 | It is often useful to print out several successive objects of the |
7324 | same type in memory; a section of an array, or an array of | |
7325 | dynamically determined size for which only a pointer exists in the | |
7326 | program. | |
7327 | ||
7328 | You can do this by referring to a contiguous span of memory as an | |
7329 | @dfn{artificial array}, using the binary operator @samp{@@}. The left | |
7330 | operand of @samp{@@} should be the first element of the desired array | |
7331 | and be an individual object. The right operand should be the desired length | |
7332 | of the array. The result is an array value whose elements are all of | |
7333 | the type of the left argument. The first element is actually the left | |
7334 | argument; the second element comes from bytes of memory immediately | |
7335 | following those that hold the first element, and so on. Here is an | |
7336 | example. If a program says | |
7337 | ||
474c8240 | 7338 | @smallexample |
c906108c | 7339 | int *array = (int *) malloc (len * sizeof (int)); |
474c8240 | 7340 | @end smallexample |
c906108c SS |
7341 | |
7342 | @noindent | |
7343 | you can print the contents of @code{array} with | |
7344 | ||
474c8240 | 7345 | @smallexample |
c906108c | 7346 | p *array@@len |
474c8240 | 7347 | @end smallexample |
c906108c SS |
7348 | |
7349 | The left operand of @samp{@@} must reside in memory. Array values made | |
7350 | with @samp{@@} in this way behave just like other arrays in terms of | |
7351 | subscripting, and are coerced to pointers when used in expressions. | |
7352 | Artificial arrays most often appear in expressions via the value history | |
79a6e687 | 7353 | (@pxref{Value History, ,Value History}), after printing one out. |
c906108c SS |
7354 | |
7355 | Another way to create an artificial array is to use a cast. | |
7356 | This re-interprets a value as if it were an array. | |
7357 | The value need not be in memory: | |
474c8240 | 7358 | @smallexample |
c906108c SS |
7359 | (@value{GDBP}) p/x (short[2])0x12345678 |
7360 | $1 = @{0x1234, 0x5678@} | |
474c8240 | 7361 | @end smallexample |
c906108c SS |
7362 | |
7363 | As a convenience, if you leave the array length out (as in | |
c3f6f71d | 7364 | @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill |
c906108c | 7365 | the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}: |
474c8240 | 7366 | @smallexample |
c906108c SS |
7367 | (@value{GDBP}) p/x (short[])0x12345678 |
7368 | $2 = @{0x1234, 0x5678@} | |
474c8240 | 7369 | @end smallexample |
c906108c SS |
7370 | |
7371 | Sometimes the artificial array mechanism is not quite enough; in | |
7372 | moderately complex data structures, the elements of interest may not | |
7373 | actually be adjacent---for example, if you are interested in the values | |
7374 | of pointers in an array. One useful work-around in this situation is | |
7375 | to use a convenience variable (@pxref{Convenience Vars, ,Convenience | |
79a6e687 | 7376 | Variables}) as a counter in an expression that prints the first |
c906108c SS |
7377 | interesting value, and then repeat that expression via @key{RET}. For |
7378 | instance, suppose you have an array @code{dtab} of pointers to | |
7379 | structures, and you are interested in the values of a field @code{fv} | |
7380 | in each structure. Here is an example of what you might type: | |
7381 | ||
474c8240 | 7382 | @smallexample |
c906108c SS |
7383 | set $i = 0 |
7384 | p dtab[$i++]->fv | |
7385 | @key{RET} | |
7386 | @key{RET} | |
7387 | @dots{} | |
474c8240 | 7388 | @end smallexample |
c906108c | 7389 | |
6d2ebf8b | 7390 | @node Output Formats |
79a6e687 | 7391 | @section Output Formats |
c906108c SS |
7392 | |
7393 | @cindex formatted output | |
7394 | @cindex output formats | |
7395 | By default, @value{GDBN} prints a value according to its data type. Sometimes | |
7396 | this is not what you want. For example, you might want to print a number | |
7397 | in hex, or a pointer in decimal. Or you might want to view data in memory | |
7398 | at a certain address as a character string or as an instruction. To do | |
7399 | these things, specify an @dfn{output format} when you print a value. | |
7400 | ||
7401 | The simplest use of output formats is to say how to print a value | |
7402 | already computed. This is done by starting the arguments of the | |
7403 | @code{print} command with a slash and a format letter. The format | |
7404 | letters supported are: | |
7405 | ||
7406 | @table @code | |
7407 | @item x | |
7408 | Regard the bits of the value as an integer, and print the integer in | |
7409 | hexadecimal. | |
7410 | ||
7411 | @item d | |
7412 | Print as integer in signed decimal. | |
7413 | ||
7414 | @item u | |
7415 | Print as integer in unsigned decimal. | |
7416 | ||
7417 | @item o | |
7418 | Print as integer in octal. | |
7419 | ||
7420 | @item t | |
7421 | Print as integer in binary. The letter @samp{t} stands for ``two''. | |
7422 | @footnote{@samp{b} cannot be used because these format letters are also | |
7423 | used with the @code{x} command, where @samp{b} stands for ``byte''; | |
79a6e687 | 7424 | see @ref{Memory,,Examining Memory}.} |
c906108c SS |
7425 | |
7426 | @item a | |
7427 | @cindex unknown address, locating | |
3d67e040 | 7428 | @cindex locate address |
c906108c SS |
7429 | Print as an address, both absolute in hexadecimal and as an offset from |
7430 | the nearest preceding symbol. You can use this format used to discover | |
7431 | where (in what function) an unknown address is located: | |
7432 | ||
474c8240 | 7433 | @smallexample |
c906108c SS |
7434 | (@value{GDBP}) p/a 0x54320 |
7435 | $3 = 0x54320 <_initialize_vx+396> | |
474c8240 | 7436 | @end smallexample |
c906108c | 7437 | |
3d67e040 EZ |
7438 | @noindent |
7439 | The command @code{info symbol 0x54320} yields similar results. | |
7440 | @xref{Symbols, info symbol}. | |
7441 | ||
c906108c | 7442 | @item c |
51274035 EZ |
7443 | Regard as an integer and print it as a character constant. This |
7444 | prints both the numerical value and its character representation. The | |
7445 | character representation is replaced with the octal escape @samp{\nnn} | |
7446 | for characters outside the 7-bit @sc{ascii} range. | |
c906108c | 7447 | |
ea37ba09 DJ |
7448 | Without this format, @value{GDBN} displays @code{char}, |
7449 | @w{@code{unsigned char}}, and @w{@code{signed char}} data as character | |
7450 | constants. Single-byte members of vectors are displayed as integer | |
7451 | data. | |
7452 | ||
c906108c SS |
7453 | @item f |
7454 | Regard the bits of the value as a floating point number and print | |
7455 | using typical floating point syntax. | |
ea37ba09 DJ |
7456 | |
7457 | @item s | |
7458 | @cindex printing strings | |
7459 | @cindex printing byte arrays | |
7460 | Regard as a string, if possible. With this format, pointers to single-byte | |
7461 | data are displayed as null-terminated strings and arrays of single-byte data | |
7462 | are displayed as fixed-length strings. Other values are displayed in their | |
7463 | natural types. | |
7464 | ||
7465 | Without this format, @value{GDBN} displays pointers to and arrays of | |
7466 | @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as | |
7467 | strings. Single-byte members of a vector are displayed as an integer | |
7468 | array. | |
a6bac58e TT |
7469 | |
7470 | @item r | |
7471 | @cindex raw printing | |
7472 | Print using the @samp{raw} formatting. By default, @value{GDBN} will | |
78e2826b TT |
7473 | use a Python-based pretty-printer, if one is available (@pxref{Pretty |
7474 | Printing}). This typically results in a higher-level display of the | |
7475 | value's contents. The @samp{r} format bypasses any Python | |
7476 | pretty-printer which might exist. | |
c906108c SS |
7477 | @end table |
7478 | ||
7479 | For example, to print the program counter in hex (@pxref{Registers}), type | |
7480 | ||
474c8240 | 7481 | @smallexample |
c906108c | 7482 | p/x $pc |
474c8240 | 7483 | @end smallexample |
c906108c SS |
7484 | |
7485 | @noindent | |
7486 | Note that no space is required before the slash; this is because command | |
7487 | names in @value{GDBN} cannot contain a slash. | |
7488 | ||
7489 | To reprint the last value in the value history with a different format, | |
7490 | you can use the @code{print} command with just a format and no | |
7491 | expression. For example, @samp{p/x} reprints the last value in hex. | |
7492 | ||
6d2ebf8b | 7493 | @node Memory |
79a6e687 | 7494 | @section Examining Memory |
c906108c SS |
7495 | |
7496 | You can use the command @code{x} (for ``examine'') to examine memory in | |
7497 | any of several formats, independently of your program's data types. | |
7498 | ||
7499 | @cindex examining memory | |
7500 | @table @code | |
41afff9a | 7501 | @kindex x @r{(examine memory)} |
c906108c SS |
7502 | @item x/@var{nfu} @var{addr} |
7503 | @itemx x @var{addr} | |
7504 | @itemx x | |
7505 | Use the @code{x} command to examine memory. | |
7506 | @end table | |
7507 | ||
7508 | @var{n}, @var{f}, and @var{u} are all optional parameters that specify how | |
7509 | much memory to display and how to format it; @var{addr} is an | |
7510 | expression giving the address where you want to start displaying memory. | |
7511 | If you use defaults for @var{nfu}, you need not type the slash @samp{/}. | |
7512 | Several commands set convenient defaults for @var{addr}. | |
7513 | ||
7514 | @table @r | |
7515 | @item @var{n}, the repeat count | |
7516 | The repeat count is a decimal integer; the default is 1. It specifies | |
7517 | how much memory (counting by units @var{u}) to display. | |
7518 | @c This really is **decimal**; unaffected by 'set radix' as of GDB | |
7519 | @c 4.1.2. | |
7520 | ||
7521 | @item @var{f}, the display format | |
51274035 EZ |
7522 | The display format is one of the formats used by @code{print} |
7523 | (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c}, | |
ea37ba09 DJ |
7524 | @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions). |
7525 | The default is @samp{x} (hexadecimal) initially. The default changes | |
7526 | each time you use either @code{x} or @code{print}. | |
c906108c SS |
7527 | |
7528 | @item @var{u}, the unit size | |
7529 | The unit size is any of | |
7530 | ||
7531 | @table @code | |
7532 | @item b | |
7533 | Bytes. | |
7534 | @item h | |
7535 | Halfwords (two bytes). | |
7536 | @item w | |
7537 | Words (four bytes). This is the initial default. | |
7538 | @item g | |
7539 | Giant words (eight bytes). | |
7540 | @end table | |
7541 | ||
7542 | Each time you specify a unit size with @code{x}, that size becomes the | |
9a22f0d0 PM |
7543 | default unit the next time you use @code{x}. For the @samp{i} format, |
7544 | the unit size is ignored and is normally not written. For the @samp{s} format, | |
7545 | the unit size defaults to @samp{b}, unless it is explicitly given. | |
7546 | Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display | |
7547 | 32-bit strings. The next use of @kbd{x /s} will again display 8-bit strings. | |
7548 | Note that the results depend on the programming language of the | |
7549 | current compilation unit. If the language is C, the @samp{s} | |
7550 | modifier will use the UTF-16 encoding while @samp{w} will use | |
7551 | UTF-32. The encoding is set by the programming language and cannot | |
7552 | be altered. | |
c906108c SS |
7553 | |
7554 | @item @var{addr}, starting display address | |
7555 | @var{addr} is the address where you want @value{GDBN} to begin displaying | |
7556 | memory. The expression need not have a pointer value (though it may); | |
7557 | it is always interpreted as an integer address of a byte of memory. | |
7558 | @xref{Expressions, ,Expressions}, for more information on expressions. The default for | |
7559 | @var{addr} is usually just after the last address examined---but several | |
7560 | other commands also set the default address: @code{info breakpoints} (to | |
7561 | the address of the last breakpoint listed), @code{info line} (to the | |
7562 | starting address of a line), and @code{print} (if you use it to display | |
7563 | a value from memory). | |
7564 | @end table | |
7565 | ||
7566 | For example, @samp{x/3uh 0x54320} is a request to display three halfwords | |
7567 | (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}), | |
7568 | starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four | |
7569 | words (@samp{w}) of memory above the stack pointer (here, @samp{$sp}; | |
d4f3574e | 7570 | @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}). |
c906108c SS |
7571 | |
7572 | Since the letters indicating unit sizes are all distinct from the | |
7573 | letters specifying output formats, you do not have to remember whether | |
7574 | unit size or format comes first; either order works. The output | |
7575 | specifications @samp{4xw} and @samp{4wx} mean exactly the same thing. | |
7576 | (However, the count @var{n} must come first; @samp{wx4} does not work.) | |
7577 | ||
7578 | Even though the unit size @var{u} is ignored for the formats @samp{s} | |
7579 | and @samp{i}, you might still want to use a count @var{n}; for example, | |
7580 | @samp{3i} specifies that you want to see three machine instructions, | |
a4642986 MR |
7581 | including any operands. For convenience, especially when used with |
7582 | the @code{display} command, the @samp{i} format also prints branch delay | |
7583 | slot instructions, if any, beyond the count specified, which immediately | |
7584 | follow the last instruction that is within the count. The command | |
7585 | @code{disassemble} gives an alternative way of inspecting machine | |
7586 | instructions; see @ref{Machine Code,,Source and Machine Code}. | |
c906108c SS |
7587 | |
7588 | All the defaults for the arguments to @code{x} are designed to make it | |
7589 | easy to continue scanning memory with minimal specifications each time | |
7590 | you use @code{x}. For example, after you have inspected three machine | |
7591 | instructions with @samp{x/3i @var{addr}}, you can inspect the next seven | |
7592 | with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command, | |
7593 | the repeat count @var{n} is used again; the other arguments default as | |
7594 | for successive uses of @code{x}. | |
7595 | ||
2b28d209 PP |
7596 | When examining machine instructions, the instruction at current program |
7597 | counter is shown with a @code{=>} marker. For example: | |
7598 | ||
7599 | @smallexample | |
7600 | (@value{GDBP}) x/5i $pc-6 | |
7601 | 0x804837f <main+11>: mov %esp,%ebp | |
7602 | 0x8048381 <main+13>: push %ecx | |
7603 | 0x8048382 <main+14>: sub $0x4,%esp | |
7604 | => 0x8048385 <main+17>: movl $0x8048460,(%esp) | |
7605 | 0x804838c <main+24>: call 0x80482d4 <puts@@plt> | |
7606 | @end smallexample | |
7607 | ||
c906108c SS |
7608 | @cindex @code{$_}, @code{$__}, and value history |
7609 | The addresses and contents printed by the @code{x} command are not saved | |
7610 | in the value history because there is often too much of them and they | |
7611 | would get in the way. Instead, @value{GDBN} makes these values available for | |
7612 | subsequent use in expressions as values of the convenience variables | |
7613 | @code{$_} and @code{$__}. After an @code{x} command, the last address | |
7614 | examined is available for use in expressions in the convenience variable | |
7615 | @code{$_}. The contents of that address, as examined, are available in | |
7616 | the convenience variable @code{$__}. | |
7617 | ||
7618 | If the @code{x} command has a repeat count, the address and contents saved | |
7619 | are from the last memory unit printed; this is not the same as the last | |
7620 | address printed if several units were printed on the last line of output. | |
7621 | ||
09d4efe1 EZ |
7622 | @cindex remote memory comparison |
7623 | @cindex verify remote memory image | |
7624 | When you are debugging a program running on a remote target machine | |
ea35711c | 7625 | (@pxref{Remote Debugging}), you may wish to verify the program's image in the |
09d4efe1 EZ |
7626 | remote machine's memory against the executable file you downloaded to |
7627 | the target. The @code{compare-sections} command is provided for such | |
7628 | situations. | |
7629 | ||
7630 | @table @code | |
7631 | @kindex compare-sections | |
7632 | @item compare-sections @r{[}@var{section-name}@r{]} | |
7633 | Compare the data of a loadable section @var{section-name} in the | |
7634 | executable file of the program being debugged with the same section in | |
7635 | the remote machine's memory, and report any mismatches. With no | |
7636 | arguments, compares all loadable sections. This command's | |
7637 | availability depends on the target's support for the @code{"qCRC"} | |
7638 | remote request. | |
7639 | @end table | |
7640 | ||
6d2ebf8b | 7641 | @node Auto Display |
79a6e687 | 7642 | @section Automatic Display |
c906108c SS |
7643 | @cindex automatic display |
7644 | @cindex display of expressions | |
7645 | ||
7646 | If you find that you want to print the value of an expression frequently | |
7647 | (to see how it changes), you might want to add it to the @dfn{automatic | |
7648 | display list} so that @value{GDBN} prints its value each time your program stops. | |
7649 | Each expression added to the list is given a number to identify it; | |
7650 | to remove an expression from the list, you specify that number. | |
7651 | The automatic display looks like this: | |
7652 | ||
474c8240 | 7653 | @smallexample |
c906108c SS |
7654 | 2: foo = 38 |
7655 | 3: bar[5] = (struct hack *) 0x3804 | |
474c8240 | 7656 | @end smallexample |
c906108c SS |
7657 | |
7658 | @noindent | |
7659 | This display shows item numbers, expressions and their current values. As with | |
7660 | displays you request manually using @code{x} or @code{print}, you can | |
7661 | specify the output format you prefer; in fact, @code{display} decides | |
ea37ba09 DJ |
7662 | whether to use @code{print} or @code{x} depending your format |
7663 | specification---it uses @code{x} if you specify either the @samp{i} | |
7664 | or @samp{s} format, or a unit size; otherwise it uses @code{print}. | |
c906108c SS |
7665 | |
7666 | @table @code | |
7667 | @kindex display | |
d4f3574e SS |
7668 | @item display @var{expr} |
7669 | Add the expression @var{expr} to the list of expressions to display | |
c906108c SS |
7670 | each time your program stops. @xref{Expressions, ,Expressions}. |
7671 | ||
7672 | @code{display} does not repeat if you press @key{RET} again after using it. | |
7673 | ||
d4f3574e | 7674 | @item display/@var{fmt} @var{expr} |
c906108c | 7675 | For @var{fmt} specifying only a display format and not a size or |
d4f3574e | 7676 | count, add the expression @var{expr} to the auto-display list but |
c906108c | 7677 | arrange to display it each time in the specified format @var{fmt}. |
79a6e687 | 7678 | @xref{Output Formats,,Output Formats}. |
c906108c SS |
7679 | |
7680 | @item display/@var{fmt} @var{addr} | |
7681 | For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a | |
7682 | number of units, add the expression @var{addr} as a memory address to | |
7683 | be examined each time your program stops. Examining means in effect | |
79a6e687 | 7684 | doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}. |
c906108c SS |
7685 | @end table |
7686 | ||
7687 | For example, @samp{display/i $pc} can be helpful, to see the machine | |
7688 | instruction about to be executed each time execution stops (@samp{$pc} | |
d4f3574e | 7689 | is a common name for the program counter; @pxref{Registers, ,Registers}). |
c906108c SS |
7690 | |
7691 | @table @code | |
7692 | @kindex delete display | |
7693 | @kindex undisplay | |
7694 | @item undisplay @var{dnums}@dots{} | |
7695 | @itemx delete display @var{dnums}@dots{} | |
c9174737 PA |
7696 | Remove items from the list of expressions to display. Specify the |
7697 | numbers of the displays that you want affected with the command | |
7698 | argument @var{dnums}. It can be a single display number, one of the | |
7699 | numbers shown in the first field of the @samp{info display} display; | |
7700 | or it could be a range of display numbers, as in @code{2-4}. | |
c906108c SS |
7701 | |
7702 | @code{undisplay} does not repeat if you press @key{RET} after using it. | |
7703 | (Otherwise you would just get the error @samp{No display number @dots{}}.) | |
7704 | ||
7705 | @kindex disable display | |
7706 | @item disable display @var{dnums}@dots{} | |
7707 | Disable the display of item numbers @var{dnums}. A disabled display | |
7708 | item is not printed automatically, but is not forgotten. It may be | |
c9174737 PA |
7709 | enabled again later. Specify the numbers of the displays that you |
7710 | want affected with the command argument @var{dnums}. It can be a | |
7711 | single display number, one of the numbers shown in the first field of | |
7712 | the @samp{info display} display; or it could be a range of display | |
7713 | numbers, as in @code{2-4}. | |
c906108c SS |
7714 | |
7715 | @kindex enable display | |
7716 | @item enable display @var{dnums}@dots{} | |
7717 | Enable display of item numbers @var{dnums}. It becomes effective once | |
7718 | again in auto display of its expression, until you specify otherwise. | |
c9174737 PA |
7719 | Specify the numbers of the displays that you want affected with the |
7720 | command argument @var{dnums}. It can be a single display number, one | |
7721 | of the numbers shown in the first field of the @samp{info display} | |
7722 | display; or it could be a range of display numbers, as in @code{2-4}. | |
c906108c SS |
7723 | |
7724 | @item display | |
7725 | Display the current values of the expressions on the list, just as is | |
7726 | done when your program stops. | |
7727 | ||
7728 | @kindex info display | |
7729 | @item info display | |
7730 | Print the list of expressions previously set up to display | |
7731 | automatically, each one with its item number, but without showing the | |
7732 | values. This includes disabled expressions, which are marked as such. | |
7733 | It also includes expressions which would not be displayed right now | |
7734 | because they refer to automatic variables not currently available. | |
7735 | @end table | |
7736 | ||
15387254 | 7737 | @cindex display disabled out of scope |
c906108c SS |
7738 | If a display expression refers to local variables, then it does not make |
7739 | sense outside the lexical context for which it was set up. Such an | |
7740 | expression is disabled when execution enters a context where one of its | |
7741 | variables is not defined. For example, if you give the command | |
7742 | @code{display last_char} while inside a function with an argument | |
7743 | @code{last_char}, @value{GDBN} displays this argument while your program | |
7744 | continues to stop inside that function. When it stops elsewhere---where | |
7745 | there is no variable @code{last_char}---the display is disabled | |
7746 | automatically. The next time your program stops where @code{last_char} | |
7747 | is meaningful, you can enable the display expression once again. | |
7748 | ||
6d2ebf8b | 7749 | @node Print Settings |
79a6e687 | 7750 | @section Print Settings |
c906108c SS |
7751 | |
7752 | @cindex format options | |
7753 | @cindex print settings | |
7754 | @value{GDBN} provides the following ways to control how arrays, structures, | |
7755 | and symbols are printed. | |
7756 | ||
7757 | @noindent | |
7758 | These settings are useful for debugging programs in any language: | |
7759 | ||
7760 | @table @code | |
4644b6e3 | 7761 | @kindex set print |
c906108c SS |
7762 | @item set print address |
7763 | @itemx set print address on | |
4644b6e3 | 7764 | @cindex print/don't print memory addresses |
c906108c SS |
7765 | @value{GDBN} prints memory addresses showing the location of stack |
7766 | traces, structure values, pointer values, breakpoints, and so forth, | |
7767 | even when it also displays the contents of those addresses. The default | |
7768 | is @code{on}. For example, this is what a stack frame display looks like with | |
7769 | @code{set print address on}: | |
7770 | ||
7771 | @smallexample | |
7772 | @group | |
7773 | (@value{GDBP}) f | |
7774 | #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>") | |
7775 | at input.c:530 | |
7776 | 530 if (lquote != def_lquote) | |
7777 | @end group | |
7778 | @end smallexample | |
7779 | ||
7780 | @item set print address off | |
7781 | Do not print addresses when displaying their contents. For example, | |
7782 | this is the same stack frame displayed with @code{set print address off}: | |
7783 | ||
7784 | @smallexample | |
7785 | @group | |
7786 | (@value{GDBP}) set print addr off | |
7787 | (@value{GDBP}) f | |
7788 | #0 set_quotes (lq="<<", rq=">>") at input.c:530 | |
7789 | 530 if (lquote != def_lquote) | |
7790 | @end group | |
7791 | @end smallexample | |
7792 | ||
7793 | You can use @samp{set print address off} to eliminate all machine | |
7794 | dependent displays from the @value{GDBN} interface. For example, with | |
7795 | @code{print address off}, you should get the same text for backtraces on | |
7796 | all machines---whether or not they involve pointer arguments. | |
7797 | ||
4644b6e3 | 7798 | @kindex show print |
c906108c SS |
7799 | @item show print address |
7800 | Show whether or not addresses are to be printed. | |
7801 | @end table | |
7802 | ||
7803 | When @value{GDBN} prints a symbolic address, it normally prints the | |
7804 | closest earlier symbol plus an offset. If that symbol does not uniquely | |
7805 | identify the address (for example, it is a name whose scope is a single | |
7806 | source file), you may need to clarify. One way to do this is with | |
7807 | @code{info line}, for example @samp{info line *0x4537}. Alternately, | |
7808 | you can set @value{GDBN} to print the source file and line number when | |
7809 | it prints a symbolic address: | |
7810 | ||
7811 | @table @code | |
c906108c | 7812 | @item set print symbol-filename on |
9c16f35a EZ |
7813 | @cindex source file and line of a symbol |
7814 | @cindex symbol, source file and line | |
c906108c SS |
7815 | Tell @value{GDBN} to print the source file name and line number of a |
7816 | symbol in the symbolic form of an address. | |
7817 | ||
7818 | @item set print symbol-filename off | |
7819 | Do not print source file name and line number of a symbol. This is the | |
7820 | default. | |
7821 | ||
c906108c SS |
7822 | @item show print symbol-filename |
7823 | Show whether or not @value{GDBN} will print the source file name and | |
7824 | line number of a symbol in the symbolic form of an address. | |
7825 | @end table | |
7826 | ||
7827 | Another situation where it is helpful to show symbol filenames and line | |
7828 | numbers is when disassembling code; @value{GDBN} shows you the line | |
7829 | number and source file that corresponds to each instruction. | |
7830 | ||
7831 | Also, you may wish to see the symbolic form only if the address being | |
7832 | printed is reasonably close to the closest earlier symbol: | |
7833 | ||
7834 | @table @code | |
c906108c | 7835 | @item set print max-symbolic-offset @var{max-offset} |
4644b6e3 | 7836 | @cindex maximum value for offset of closest symbol |
c906108c SS |
7837 | Tell @value{GDBN} to only display the symbolic form of an address if the |
7838 | offset between the closest earlier symbol and the address is less than | |
5d161b24 | 7839 | @var{max-offset}. The default is 0, which tells @value{GDBN} |
c906108c SS |
7840 | to always print the symbolic form of an address if any symbol precedes it. |
7841 | ||
c906108c SS |
7842 | @item show print max-symbolic-offset |
7843 | Ask how large the maximum offset is that @value{GDBN} prints in a | |
7844 | symbolic address. | |
7845 | @end table | |
7846 | ||
7847 | @cindex wild pointer, interpreting | |
7848 | @cindex pointer, finding referent | |
7849 | If you have a pointer and you are not sure where it points, try | |
7850 | @samp{set print symbol-filename on}. Then you can determine the name | |
7851 | and source file location of the variable where it points, using | |
7852 | @samp{p/a @var{pointer}}. This interprets the address in symbolic form. | |
7853 | For example, here @value{GDBN} shows that a variable @code{ptt} points | |
7854 | at another variable @code{t}, defined in @file{hi2.c}: | |
7855 | ||
474c8240 | 7856 | @smallexample |
c906108c SS |
7857 | (@value{GDBP}) set print symbol-filename on |
7858 | (@value{GDBP}) p/a ptt | |
7859 | $4 = 0xe008 <t in hi2.c> | |
474c8240 | 7860 | @end smallexample |
c906108c SS |
7861 | |
7862 | @quotation | |
7863 | @emph{Warning:} For pointers that point to a local variable, @samp{p/a} | |
7864 | does not show the symbol name and filename of the referent, even with | |
7865 | the appropriate @code{set print} options turned on. | |
7866 | @end quotation | |
7867 | ||
7868 | Other settings control how different kinds of objects are printed: | |
7869 | ||
7870 | @table @code | |
c906108c SS |
7871 | @item set print array |
7872 | @itemx set print array on | |
4644b6e3 | 7873 | @cindex pretty print arrays |
c906108c SS |
7874 | Pretty print arrays. This format is more convenient to read, |
7875 | but uses more space. The default is off. | |
7876 | ||
7877 | @item set print array off | |
7878 | Return to compressed format for arrays. | |
7879 | ||
c906108c SS |
7880 | @item show print array |
7881 | Show whether compressed or pretty format is selected for displaying | |
7882 | arrays. | |
7883 | ||
3c9c013a JB |
7884 | @cindex print array indexes |
7885 | @item set print array-indexes | |
7886 | @itemx set print array-indexes on | |
7887 | Print the index of each element when displaying arrays. May be more | |
7888 | convenient to locate a given element in the array or quickly find the | |
7889 | index of a given element in that printed array. The default is off. | |
7890 | ||
7891 | @item set print array-indexes off | |
7892 | Stop printing element indexes when displaying arrays. | |
7893 | ||
7894 | @item show print array-indexes | |
7895 | Show whether the index of each element is printed when displaying | |
7896 | arrays. | |
7897 | ||
c906108c | 7898 | @item set print elements @var{number-of-elements} |
4644b6e3 | 7899 | @cindex number of array elements to print |
9c16f35a | 7900 | @cindex limit on number of printed array elements |
c906108c SS |
7901 | Set a limit on how many elements of an array @value{GDBN} will print. |
7902 | If @value{GDBN} is printing a large array, it stops printing after it has | |
7903 | printed the number of elements set by the @code{set print elements} command. | |
7904 | This limit also applies to the display of strings. | |
d4f3574e | 7905 | When @value{GDBN} starts, this limit is set to 200. |
c906108c SS |
7906 | Setting @var{number-of-elements} to zero means that the printing is unlimited. |
7907 | ||
c906108c SS |
7908 | @item show print elements |
7909 | Display the number of elements of a large array that @value{GDBN} will print. | |
7910 | If the number is 0, then the printing is unlimited. | |
7911 | ||
b4740add | 7912 | @item set print frame-arguments @var{value} |
a0381d3a | 7913 | @kindex set print frame-arguments |
b4740add JB |
7914 | @cindex printing frame argument values |
7915 | @cindex print all frame argument values | |
7916 | @cindex print frame argument values for scalars only | |
7917 | @cindex do not print frame argument values | |
7918 | This command allows to control how the values of arguments are printed | |
7919 | when the debugger prints a frame (@pxref{Frames}). The possible | |
7920 | values are: | |
7921 | ||
7922 | @table @code | |
7923 | @item all | |
4f5376b2 | 7924 | The values of all arguments are printed. |
b4740add JB |
7925 | |
7926 | @item scalars | |
7927 | Print the value of an argument only if it is a scalar. The value of more | |
7928 | complex arguments such as arrays, structures, unions, etc, is replaced | |
4f5376b2 JB |
7929 | by @code{@dots{}}. This is the default. Here is an example where |
7930 | only scalar arguments are shown: | |
b4740add JB |
7931 | |
7932 | @smallexample | |
7933 | #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green) | |
7934 | at frame-args.c:23 | |
7935 | @end smallexample | |
7936 | ||
7937 | @item none | |
7938 | None of the argument values are printed. Instead, the value of each argument | |
7939 | is replaced by @code{@dots{}}. In this case, the example above now becomes: | |
7940 | ||
7941 | @smallexample | |
7942 | #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{}) | |
7943 | at frame-args.c:23 | |
7944 | @end smallexample | |
7945 | @end table | |
7946 | ||
4f5376b2 JB |
7947 | By default, only scalar arguments are printed. This command can be used |
7948 | to configure the debugger to print the value of all arguments, regardless | |
7949 | of their type. However, it is often advantageous to not print the value | |
7950 | of more complex parameters. For instance, it reduces the amount of | |
7951 | information printed in each frame, making the backtrace more readable. | |
7952 | Also, it improves performance when displaying Ada frames, because | |
7953 | the computation of large arguments can sometimes be CPU-intensive, | |
7954 | especially in large applications. Setting @code{print frame-arguments} | |
7955 | to @code{scalars} (the default) or @code{none} avoids this computation, | |
7956 | thus speeding up the display of each Ada frame. | |
b4740add JB |
7957 | |
7958 | @item show print frame-arguments | |
7959 | Show how the value of arguments should be displayed when printing a frame. | |
7960 | ||
36b11add | 7961 | @anchor{set print entry-values} |
e18b2753 JK |
7962 | @item set print entry-values @var{value} |
7963 | @kindex set print entry-values | |
7964 | Set printing of frame argument values at function entry. In some cases | |
7965 | @value{GDBN} can determine the value of function argument which was passed by | |
7966 | the function caller, even if the value was modified inside the called function | |
7967 | and therefore is different. With optimized code, the current value could be | |
7968 | unavailable, but the entry value may still be known. | |
7969 | ||
7970 | The default value is @code{default} (see below for its description). Older | |
7971 | @value{GDBN} behaved as with the setting @code{no}. Compilers not supporting | |
7972 | this feature will behave in the @code{default} setting the same way as with the | |
7973 | @code{no} setting. | |
7974 | ||
7975 | This functionality is currently supported only by DWARF 2 debugging format and | |
7976 | the compiler has to produce @samp{DW_TAG_GNU_call_site} tags. With | |
7977 | @value{NGCC}, you need to specify @option{-O -g} during compilation, to get | |
7978 | this information. | |
7979 | ||
7980 | The @var{value} parameter can be one of the following: | |
7981 | ||
7982 | @table @code | |
7983 | @item no | |
7984 | Print only actual parameter values, never print values from function entry | |
7985 | point. | |
7986 | @smallexample | |
7987 | #0 equal (val=5) | |
7988 | #0 different (val=6) | |
7989 | #0 lost (val=<optimized out>) | |
7990 | #0 born (val=10) | |
7991 | #0 invalid (val=<optimized out>) | |
7992 | @end smallexample | |
7993 | ||
7994 | @item only | |
7995 | Print only parameter values from function entry point. The actual parameter | |
7996 | values are never printed. | |
7997 | @smallexample | |
7998 | #0 equal (val@@entry=5) | |
7999 | #0 different (val@@entry=5) | |
8000 | #0 lost (val@@entry=5) | |
8001 | #0 born (val@@entry=<optimized out>) | |
8002 | #0 invalid (val@@entry=<optimized out>) | |
8003 | @end smallexample | |
8004 | ||
8005 | @item preferred | |
8006 | Print only parameter values from function entry point. If value from function | |
8007 | entry point is not known while the actual value is known, print the actual | |
8008 | value for such parameter. | |
8009 | @smallexample | |
8010 | #0 equal (val@@entry=5) | |
8011 | #0 different (val@@entry=5) | |
8012 | #0 lost (val@@entry=5) | |
8013 | #0 born (val=10) | |
8014 | #0 invalid (val@@entry=<optimized out>) | |
8015 | @end smallexample | |
8016 | ||
8017 | @item if-needed | |
8018 | Print actual parameter values. If actual parameter value is not known while | |
8019 | value from function entry point is known, print the entry point value for such | |
8020 | parameter. | |
8021 | @smallexample | |
8022 | #0 equal (val=5) | |
8023 | #0 different (val=6) | |
8024 | #0 lost (val@@entry=5) | |
8025 | #0 born (val=10) | |
8026 | #0 invalid (val=<optimized out>) | |
8027 | @end smallexample | |
8028 | ||
8029 | @item both | |
8030 | Always print both the actual parameter value and its value from function entry | |
8031 | point, even if values of one or both are not available due to compiler | |
8032 | optimizations. | |
8033 | @smallexample | |
8034 | #0 equal (val=5, val@@entry=5) | |
8035 | #0 different (val=6, val@@entry=5) | |
8036 | #0 lost (val=<optimized out>, val@@entry=5) | |
8037 | #0 born (val=10, val@@entry=<optimized out>) | |
8038 | #0 invalid (val=<optimized out>, val@@entry=<optimized out>) | |
8039 | @end smallexample | |
8040 | ||
8041 | @item compact | |
8042 | Print the actual parameter value if it is known and also its value from | |
8043 | function entry point if it is known. If neither is known, print for the actual | |
8044 | value @code{<optimized out>}. If not in MI mode (@pxref{GDB/MI}) and if both | |
8045 | values are known and identical, print the shortened | |
8046 | @code{param=param@@entry=VALUE} notation. | |
8047 | @smallexample | |
8048 | #0 equal (val=val@@entry=5) | |
8049 | #0 different (val=6, val@@entry=5) | |
8050 | #0 lost (val@@entry=5) | |
8051 | #0 born (val=10) | |
8052 | #0 invalid (val=<optimized out>) | |
8053 | @end smallexample | |
8054 | ||
8055 | @item default | |
8056 | Always print the actual parameter value. Print also its value from function | |
8057 | entry point, but only if it is known. If not in MI mode (@pxref{GDB/MI}) and | |
8058 | if both values are known and identical, print the shortened | |
8059 | @code{param=param@@entry=VALUE} notation. | |
8060 | @smallexample | |
8061 | #0 equal (val=val@@entry=5) | |
8062 | #0 different (val=6, val@@entry=5) | |
8063 | #0 lost (val=<optimized out>, val@@entry=5) | |
8064 | #0 born (val=10) | |
8065 | #0 invalid (val=<optimized out>) | |
8066 | @end smallexample | |
8067 | @end table | |
8068 | ||
8069 | For analysis messages on possible failures of frame argument values at function | |
8070 | entry resolution see @ref{set debug entry-values}. | |
8071 | ||
8072 | @item show print entry-values | |
8073 | Show the method being used for printing of frame argument values at function | |
8074 | entry. | |
8075 | ||
9c16f35a EZ |
8076 | @item set print repeats |
8077 | @cindex repeated array elements | |
8078 | Set the threshold for suppressing display of repeated array | |
d3e8051b | 8079 | elements. When the number of consecutive identical elements of an |
9c16f35a EZ |
8080 | array exceeds the threshold, @value{GDBN} prints the string |
8081 | @code{"<repeats @var{n} times>"}, where @var{n} is the number of | |
8082 | identical repetitions, instead of displaying the identical elements | |
8083 | themselves. Setting the threshold to zero will cause all elements to | |
8084 | be individually printed. The default threshold is 10. | |
8085 | ||
8086 | @item show print repeats | |
8087 | Display the current threshold for printing repeated identical | |
8088 | elements. | |
8089 | ||
c906108c | 8090 | @item set print null-stop |
4644b6e3 | 8091 | @cindex @sc{null} elements in arrays |
c906108c | 8092 | Cause @value{GDBN} to stop printing the characters of an array when the first |
d4f3574e | 8093 | @sc{null} is encountered. This is useful when large arrays actually |
c906108c | 8094 | contain only short strings. |
d4f3574e | 8095 | The default is off. |
c906108c | 8096 | |
9c16f35a EZ |
8097 | @item show print null-stop |
8098 | Show whether @value{GDBN} stops printing an array on the first | |
8099 | @sc{null} character. | |
8100 | ||
c906108c | 8101 | @item set print pretty on |
9c16f35a EZ |
8102 | @cindex print structures in indented form |
8103 | @cindex indentation in structure display | |
5d161b24 | 8104 | Cause @value{GDBN} to print structures in an indented format with one member |
c906108c SS |
8105 | per line, like this: |
8106 | ||
8107 | @smallexample | |
8108 | @group | |
8109 | $1 = @{ | |
8110 | next = 0x0, | |
8111 | flags = @{ | |
8112 | sweet = 1, | |
8113 | sour = 1 | |
8114 | @}, | |
8115 | meat = 0x54 "Pork" | |
8116 | @} | |
8117 | @end group | |
8118 | @end smallexample | |
8119 | ||
8120 | @item set print pretty off | |
8121 | Cause @value{GDBN} to print structures in a compact format, like this: | |
8122 | ||
8123 | @smallexample | |
8124 | @group | |
8125 | $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \ | |
8126 | meat = 0x54 "Pork"@} | |
8127 | @end group | |
8128 | @end smallexample | |
8129 | ||
8130 | @noindent | |
8131 | This is the default format. | |
8132 | ||
c906108c SS |
8133 | @item show print pretty |
8134 | Show which format @value{GDBN} is using to print structures. | |
8135 | ||
c906108c | 8136 | @item set print sevenbit-strings on |
4644b6e3 EZ |
8137 | @cindex eight-bit characters in strings |
8138 | @cindex octal escapes in strings | |
c906108c SS |
8139 | Print using only seven-bit characters; if this option is set, |
8140 | @value{GDBN} displays any eight-bit characters (in strings or | |
8141 | character values) using the notation @code{\}@var{nnn}. This setting is | |
8142 | best if you are working in English (@sc{ascii}) and you use the | |
8143 | high-order bit of characters as a marker or ``meta'' bit. | |
8144 | ||
8145 | @item set print sevenbit-strings off | |
8146 | Print full eight-bit characters. This allows the use of more | |
8147 | international character sets, and is the default. | |
8148 | ||
c906108c SS |
8149 | @item show print sevenbit-strings |
8150 | Show whether or not @value{GDBN} is printing only seven-bit characters. | |
8151 | ||
c906108c | 8152 | @item set print union on |
4644b6e3 | 8153 | @cindex unions in structures, printing |
9c16f35a EZ |
8154 | Tell @value{GDBN} to print unions which are contained in structures |
8155 | and other unions. This is the default setting. | |
c906108c SS |
8156 | |
8157 | @item set print union off | |
9c16f35a EZ |
8158 | Tell @value{GDBN} not to print unions which are contained in |
8159 | structures and other unions. @value{GDBN} will print @code{"@{...@}"} | |
8160 | instead. | |
c906108c | 8161 | |
c906108c SS |
8162 | @item show print union |
8163 | Ask @value{GDBN} whether or not it will print unions which are contained in | |
9c16f35a | 8164 | structures and other unions. |
c906108c SS |
8165 | |
8166 | For example, given the declarations | |
8167 | ||
8168 | @smallexample | |
8169 | typedef enum @{Tree, Bug@} Species; | |
8170 | typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms; | |
5d161b24 | 8171 | typedef enum @{Caterpillar, Cocoon, Butterfly@} |
c906108c SS |
8172 | Bug_forms; |
8173 | ||
8174 | struct thing @{ | |
8175 | Species it; | |
8176 | union @{ | |
8177 | Tree_forms tree; | |
8178 | Bug_forms bug; | |
8179 | @} form; | |
8180 | @}; | |
8181 | ||
8182 | struct thing foo = @{Tree, @{Acorn@}@}; | |
8183 | @end smallexample | |
8184 | ||
8185 | @noindent | |
8186 | with @code{set print union on} in effect @samp{p foo} would print | |
8187 | ||
8188 | @smallexample | |
8189 | $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@} | |
8190 | @end smallexample | |
8191 | ||
8192 | @noindent | |
8193 | and with @code{set print union off} in effect it would print | |
8194 | ||
8195 | @smallexample | |
8196 | $1 = @{it = Tree, form = @{...@}@} | |
8197 | @end smallexample | |
9c16f35a EZ |
8198 | |
8199 | @noindent | |
8200 | @code{set print union} affects programs written in C-like languages | |
8201 | and in Pascal. | |
c906108c SS |
8202 | @end table |
8203 | ||
c906108c SS |
8204 | @need 1000 |
8205 | @noindent | |
b37052ae | 8206 | These settings are of interest when debugging C@t{++} programs: |
c906108c SS |
8207 | |
8208 | @table @code | |
4644b6e3 | 8209 | @cindex demangling C@t{++} names |
c906108c SS |
8210 | @item set print demangle |
8211 | @itemx set print demangle on | |
b37052ae | 8212 | Print C@t{++} names in their source form rather than in the encoded |
c906108c | 8213 | (``mangled'') form passed to the assembler and linker for type-safe |
d4f3574e | 8214 | linkage. The default is on. |
c906108c | 8215 | |
c906108c | 8216 | @item show print demangle |
b37052ae | 8217 | Show whether C@t{++} names are printed in mangled or demangled form. |
c906108c | 8218 | |
c906108c SS |
8219 | @item set print asm-demangle |
8220 | @itemx set print asm-demangle on | |
b37052ae | 8221 | Print C@t{++} names in their source form rather than their mangled form, even |
c906108c SS |
8222 | in assembler code printouts such as instruction disassemblies. |
8223 | The default is off. | |
8224 | ||
c906108c | 8225 | @item show print asm-demangle |
b37052ae | 8226 | Show whether C@t{++} names in assembly listings are printed in mangled |
c906108c SS |
8227 | or demangled form. |
8228 | ||
b37052ae EZ |
8229 | @cindex C@t{++} symbol decoding style |
8230 | @cindex symbol decoding style, C@t{++} | |
a8f24a35 | 8231 | @kindex set demangle-style |
c906108c SS |
8232 | @item set demangle-style @var{style} |
8233 | Choose among several encoding schemes used by different compilers to | |
b37052ae | 8234 | represent C@t{++} names. The choices for @var{style} are currently: |
c906108c SS |
8235 | |
8236 | @table @code | |
8237 | @item auto | |
8238 | Allow @value{GDBN} to choose a decoding style by inspecting your program. | |
8239 | ||
8240 | @item gnu | |
b37052ae | 8241 | Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm. |
c906108c | 8242 | This is the default. |
c906108c SS |
8243 | |
8244 | @item hp | |
b37052ae | 8245 | Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm. |
c906108c SS |
8246 | |
8247 | @item lucid | |
b37052ae | 8248 | Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm. |
c906108c SS |
8249 | |
8250 | @item arm | |
b37052ae | 8251 | Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}. |
c906108c SS |
8252 | @strong{Warning:} this setting alone is not sufficient to allow |
8253 | debugging @code{cfront}-generated executables. @value{GDBN} would | |
8254 | require further enhancement to permit that. | |
8255 | ||
8256 | @end table | |
8257 | If you omit @var{style}, you will see a list of possible formats. | |
8258 | ||
c906108c | 8259 | @item show demangle-style |
b37052ae | 8260 | Display the encoding style currently in use for decoding C@t{++} symbols. |
c906108c | 8261 | |
c906108c SS |
8262 | @item set print object |
8263 | @itemx set print object on | |
4644b6e3 | 8264 | @cindex derived type of an object, printing |
9c16f35a | 8265 | @cindex display derived types |
c906108c SS |
8266 | When displaying a pointer to an object, identify the @emph{actual} |
8267 | (derived) type of the object rather than the @emph{declared} type, using | |
8268 | the virtual function table. | |
8269 | ||
8270 | @item set print object off | |
8271 | Display only the declared type of objects, without reference to the | |
8272 | virtual function table. This is the default setting. | |
8273 | ||
c906108c SS |
8274 | @item show print object |
8275 | Show whether actual, or declared, object types are displayed. | |
8276 | ||
c906108c SS |
8277 | @item set print static-members |
8278 | @itemx set print static-members on | |
4644b6e3 | 8279 | @cindex static members of C@t{++} objects |
b37052ae | 8280 | Print static members when displaying a C@t{++} object. The default is on. |
c906108c SS |
8281 | |
8282 | @item set print static-members off | |
b37052ae | 8283 | Do not print static members when displaying a C@t{++} object. |
c906108c | 8284 | |
c906108c | 8285 | @item show print static-members |
9c16f35a EZ |
8286 | Show whether C@t{++} static members are printed or not. |
8287 | ||
8288 | @item set print pascal_static-members | |
8289 | @itemx set print pascal_static-members on | |
d3e8051b EZ |
8290 | @cindex static members of Pascal objects |
8291 | @cindex Pascal objects, static members display | |
9c16f35a EZ |
8292 | Print static members when displaying a Pascal object. The default is on. |
8293 | ||
8294 | @item set print pascal_static-members off | |
8295 | Do not print static members when displaying a Pascal object. | |
8296 | ||
8297 | @item show print pascal_static-members | |
8298 | Show whether Pascal static members are printed or not. | |
c906108c SS |
8299 | |
8300 | @c These don't work with HP ANSI C++ yet. | |
c906108c SS |
8301 | @item set print vtbl |
8302 | @itemx set print vtbl on | |
4644b6e3 | 8303 | @cindex pretty print C@t{++} virtual function tables |
9c16f35a EZ |
8304 | @cindex virtual functions (C@t{++}) display |
8305 | @cindex VTBL display | |
b37052ae | 8306 | Pretty print C@t{++} virtual function tables. The default is off. |
c906108c | 8307 | (The @code{vtbl} commands do not work on programs compiled with the HP |
b37052ae | 8308 | ANSI C@t{++} compiler (@code{aCC}).) |
c906108c SS |
8309 | |
8310 | @item set print vtbl off | |
b37052ae | 8311 | Do not pretty print C@t{++} virtual function tables. |
c906108c | 8312 | |
c906108c | 8313 | @item show print vtbl |
b37052ae | 8314 | Show whether C@t{++} virtual function tables are pretty printed, or not. |
c906108c | 8315 | @end table |
c906108c | 8316 | |
4c374409 JK |
8317 | @node Pretty Printing |
8318 | @section Pretty Printing | |
8319 | ||
8320 | @value{GDBN} provides a mechanism to allow pretty-printing of values using | |
8321 | Python code. It greatly simplifies the display of complex objects. This | |
8322 | mechanism works for both MI and the CLI. | |
8323 | ||
7b51bc51 DE |
8324 | @menu |
8325 | * Pretty-Printer Introduction:: Introduction to pretty-printers | |
8326 | * Pretty-Printer Example:: An example pretty-printer | |
8327 | * Pretty-Printer Commands:: Pretty-printer commands | |
8328 | @end menu | |
8329 | ||
8330 | @node Pretty-Printer Introduction | |
8331 | @subsection Pretty-Printer Introduction | |
8332 | ||
8333 | When @value{GDBN} prints a value, it first sees if there is a pretty-printer | |
8334 | registered for the value. If there is then @value{GDBN} invokes the | |
8335 | pretty-printer to print the value. Otherwise the value is printed normally. | |
8336 | ||
8337 | Pretty-printers are normally named. This makes them easy to manage. | |
8338 | The @samp{info pretty-printer} command will list all the installed | |
8339 | pretty-printers with their names. | |
8340 | If a pretty-printer can handle multiple data types, then its | |
8341 | @dfn{subprinters} are the printers for the individual data types. | |
8342 | Each such subprinter has its own name. | |
4e04c971 | 8343 | The format of the name is @var{printer-name};@var{subprinter-name}. |
7b51bc51 DE |
8344 | |
8345 | Pretty-printers are installed by @dfn{registering} them with @value{GDBN}. | |
8346 | Typically they are automatically loaded and registered when the corresponding | |
8347 | debug information is loaded, thus making them available without having to | |
8348 | do anything special. | |
8349 | ||
8350 | There are three places where a pretty-printer can be registered. | |
8351 | ||
8352 | @itemize @bullet | |
8353 | @item | |
8354 | Pretty-printers registered globally are available when debugging | |
8355 | all inferiors. | |
8356 | ||
8357 | @item | |
8358 | Pretty-printers registered with a program space are available only | |
8359 | when debugging that program. | |
8360 | @xref{Progspaces In Python}, for more details on program spaces in Python. | |
8361 | ||
8362 | @item | |
8363 | Pretty-printers registered with an objfile are loaded and unloaded | |
8364 | with the corresponding objfile (e.g., shared library). | |
8365 | @xref{Objfiles In Python}, for more details on objfiles in Python. | |
8366 | @end itemize | |
8367 | ||
8368 | @xref{Selecting Pretty-Printers}, for further information on how | |
8369 | pretty-printers are selected, | |
8370 | ||
8371 | @xref{Writing a Pretty-Printer}, for implementing pretty printers | |
8372 | for new types. | |
8373 | ||
8374 | @node Pretty-Printer Example | |
8375 | @subsection Pretty-Printer Example | |
8376 | ||
8377 | Here is how a C@t{++} @code{std::string} looks without a pretty-printer: | |
4c374409 JK |
8378 | |
8379 | @smallexample | |
8380 | (@value{GDBP}) print s | |
8381 | $1 = @{ | |
8382 | static npos = 4294967295, | |
8383 | _M_dataplus = @{ | |
8384 | <std::allocator<char>> = @{ | |
8385 | <__gnu_cxx::new_allocator<char>> = @{ | |
8386 | <No data fields>@}, <No data fields> | |
8387 | @}, | |
8388 | members of std::basic_string<char, std::char_traits<char>, | |
8389 | std::allocator<char> >::_Alloc_hider: | |
8390 | _M_p = 0x804a014 "abcd" | |
8391 | @} | |
8392 | @} | |
8393 | @end smallexample | |
8394 | ||
8395 | With a pretty-printer for @code{std::string} only the contents are printed: | |
8396 | ||
8397 | @smallexample | |
8398 | (@value{GDBP}) print s | |
8399 | $2 = "abcd" | |
8400 | @end smallexample | |
8401 | ||
7b51bc51 DE |
8402 | @node Pretty-Printer Commands |
8403 | @subsection Pretty-Printer Commands | |
8404 | @cindex pretty-printer commands | |
8405 | ||
8406 | @table @code | |
8407 | @kindex info pretty-printer | |
8408 | @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]] | |
8409 | Print the list of installed pretty-printers. | |
8410 | This includes disabled pretty-printers, which are marked as such. | |
8411 | ||
8412 | @var{object-regexp} is a regular expression matching the objects | |
8413 | whose pretty-printers to list. | |
8414 | Objects can be @code{global}, the program space's file | |
8415 | (@pxref{Progspaces In Python}), | |
8416 | and the object files within that program space (@pxref{Objfiles In Python}). | |
8417 | @xref{Selecting Pretty-Printers}, for details on how @value{GDBN} | |
8418 | looks up a printer from these three objects. | |
8419 | ||
8420 | @var{name-regexp} is a regular expression matching the name of the printers | |
8421 | to list. | |
8422 | ||
8423 | @kindex disable pretty-printer | |
8424 | @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]] | |
8425 | Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}. | |
8426 | A disabled pretty-printer is not forgotten, it may be enabled again later. | |
8427 | ||
8428 | @kindex enable pretty-printer | |
8429 | @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]] | |
8430 | Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}. | |
8431 | @end table | |
8432 | ||
8433 | Example: | |
8434 | ||
8435 | Suppose we have three pretty-printers installed: one from library1.so | |
8436 | named @code{foo} that prints objects of type @code{foo}, and | |
8437 | another from library2.so named @code{bar} that prints two types of objects, | |
8438 | @code{bar1} and @code{bar2}. | |
8439 | ||
8440 | @smallexample | |
8441 | (gdb) info pretty-printer | |
8442 | library1.so: | |
8443 | foo | |
8444 | library2.so: | |
8445 | bar | |
8446 | bar1 | |
8447 | bar2 | |
8448 | (gdb) info pretty-printer library2 | |
8449 | library2.so: | |
8450 | bar | |
8451 | bar1 | |
8452 | bar2 | |
8453 | (gdb) disable pretty-printer library1 | |
8454 | 1 printer disabled | |
8455 | 2 of 3 printers enabled | |
8456 | (gdb) info pretty-printer | |
8457 | library1.so: | |
8458 | foo [disabled] | |
8459 | library2.so: | |
8460 | bar | |
8461 | bar1 | |
8462 | bar2 | |
8463 | (gdb) disable pretty-printer library2 bar:bar1 | |
8464 | 1 printer disabled | |
8465 | 1 of 3 printers enabled | |
8466 | (gdb) info pretty-printer library2 | |
8467 | library1.so: | |
8468 | foo [disabled] | |
8469 | library2.so: | |
8470 | bar | |
8471 | bar1 [disabled] | |
8472 | bar2 | |
8473 | (gdb) disable pretty-printer library2 bar | |
8474 | 1 printer disabled | |
8475 | 0 of 3 printers enabled | |
8476 | (gdb) info pretty-printer library2 | |
8477 | library1.so: | |
8478 | foo [disabled] | |
8479 | library2.so: | |
8480 | bar [disabled] | |
8481 | bar1 [disabled] | |
8482 | bar2 | |
8483 | @end smallexample | |
8484 | ||
8485 | Note that for @code{bar} the entire printer can be disabled, | |
8486 | as can each individual subprinter. | |
4c374409 | 8487 | |
6d2ebf8b | 8488 | @node Value History |
79a6e687 | 8489 | @section Value History |
c906108c SS |
8490 | |
8491 | @cindex value history | |
9c16f35a | 8492 | @cindex history of values printed by @value{GDBN} |
5d161b24 DB |
8493 | Values printed by the @code{print} command are saved in the @value{GDBN} |
8494 | @dfn{value history}. This allows you to refer to them in other expressions. | |
8495 | Values are kept until the symbol table is re-read or discarded | |
8496 | (for example with the @code{file} or @code{symbol-file} commands). | |
8497 | When the symbol table changes, the value history is discarded, | |
8498 | since the values may contain pointers back to the types defined in the | |
c906108c SS |
8499 | symbol table. |
8500 | ||
8501 | @cindex @code{$} | |
8502 | @cindex @code{$$} | |
8503 | @cindex history number | |
8504 | The values printed are given @dfn{history numbers} by which you can | |
8505 | refer to them. These are successive integers starting with one. | |
8506 | @code{print} shows you the history number assigned to a value by | |
8507 | printing @samp{$@var{num} = } before the value; here @var{num} is the | |
8508 | history number. | |
8509 | ||
8510 | To refer to any previous value, use @samp{$} followed by the value's | |
8511 | history number. The way @code{print} labels its output is designed to | |
8512 | remind you of this. Just @code{$} refers to the most recent value in | |
8513 | the history, and @code{$$} refers to the value before that. | |
8514 | @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2} | |
8515 | is the value just prior to @code{$$}, @code{$$1} is equivalent to | |
8516 | @code{$$}, and @code{$$0} is equivalent to @code{$}. | |
8517 | ||
8518 | For example, suppose you have just printed a pointer to a structure and | |
8519 | want to see the contents of the structure. It suffices to type | |
8520 | ||
474c8240 | 8521 | @smallexample |
c906108c | 8522 | p *$ |
474c8240 | 8523 | @end smallexample |
c906108c SS |
8524 | |
8525 | If you have a chain of structures where the component @code{next} points | |
8526 | to the next one, you can print the contents of the next one with this: | |
8527 | ||
474c8240 | 8528 | @smallexample |
c906108c | 8529 | p *$.next |
474c8240 | 8530 | @end smallexample |
c906108c SS |
8531 | |
8532 | @noindent | |
8533 | You can print successive links in the chain by repeating this | |
8534 | command---which you can do by just typing @key{RET}. | |
8535 | ||
8536 | Note that the history records values, not expressions. If the value of | |
8537 | @code{x} is 4 and you type these commands: | |
8538 | ||
474c8240 | 8539 | @smallexample |
c906108c SS |
8540 | print x |
8541 | set x=5 | |
474c8240 | 8542 | @end smallexample |
c906108c SS |
8543 | |
8544 | @noindent | |
8545 | then the value recorded in the value history by the @code{print} command | |
8546 | remains 4 even though the value of @code{x} has changed. | |
8547 | ||
8548 | @table @code | |
8549 | @kindex show values | |
8550 | @item show values | |
8551 | Print the last ten values in the value history, with their item numbers. | |
8552 | This is like @samp{p@ $$9} repeated ten times, except that @code{show | |
8553 | values} does not change the history. | |
8554 | ||
8555 | @item show values @var{n} | |
8556 | Print ten history values centered on history item number @var{n}. | |
8557 | ||
8558 | @item show values + | |
8559 | Print ten history values just after the values last printed. If no more | |
8560 | values are available, @code{show values +} produces no display. | |
8561 | @end table | |
8562 | ||
8563 | Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the | |
8564 | same effect as @samp{show values +}. | |
8565 | ||
6d2ebf8b | 8566 | @node Convenience Vars |
79a6e687 | 8567 | @section Convenience Variables |
c906108c SS |
8568 | |
8569 | @cindex convenience variables | |
9c16f35a | 8570 | @cindex user-defined variables |
c906108c SS |
8571 | @value{GDBN} provides @dfn{convenience variables} that you can use within |
8572 | @value{GDBN} to hold on to a value and refer to it later. These variables | |
8573 | exist entirely within @value{GDBN}; they are not part of your program, and | |
8574 | setting a convenience variable has no direct effect on further execution | |
8575 | of your program. That is why you can use them freely. | |
8576 | ||
8577 | Convenience variables are prefixed with @samp{$}. Any name preceded by | |
8578 | @samp{$} can be used for a convenience variable, unless it is one of | |
d4f3574e | 8579 | the predefined machine-specific register names (@pxref{Registers, ,Registers}). |
c906108c | 8580 | (Value history references, in contrast, are @emph{numbers} preceded |
79a6e687 | 8581 | by @samp{$}. @xref{Value History, ,Value History}.) |
c906108c SS |
8582 | |
8583 | You can save a value in a convenience variable with an assignment | |
8584 | expression, just as you would set a variable in your program. | |
8585 | For example: | |
8586 | ||
474c8240 | 8587 | @smallexample |
c906108c | 8588 | set $foo = *object_ptr |
474c8240 | 8589 | @end smallexample |
c906108c SS |
8590 | |
8591 | @noindent | |
8592 | would save in @code{$foo} the value contained in the object pointed to by | |
8593 | @code{object_ptr}. | |
8594 | ||
8595 | Using a convenience variable for the first time creates it, but its | |
8596 | value is @code{void} until you assign a new value. You can alter the | |
8597 | value with another assignment at any time. | |
8598 | ||
8599 | Convenience variables have no fixed types. You can assign a convenience | |
8600 | variable any type of value, including structures and arrays, even if | |
8601 | that variable already has a value of a different type. The convenience | |
8602 | variable, when used as an expression, has the type of its current value. | |
8603 | ||
8604 | @table @code | |
8605 | @kindex show convenience | |
9c16f35a | 8606 | @cindex show all user variables |
c906108c SS |
8607 | @item show convenience |
8608 | Print a list of convenience variables used so far, and their values. | |
d4f3574e | 8609 | Abbreviated @code{show conv}. |
53e5f3cf AS |
8610 | |
8611 | @kindex init-if-undefined | |
8612 | @cindex convenience variables, initializing | |
8613 | @item init-if-undefined $@var{variable} = @var{expression} | |
8614 | Set a convenience variable if it has not already been set. This is useful | |
8615 | for user-defined commands that keep some state. It is similar, in concept, | |
8616 | to using local static variables with initializers in C (except that | |
8617 | convenience variables are global). It can also be used to allow users to | |
8618 | override default values used in a command script. | |
8619 | ||
8620 | If the variable is already defined then the expression is not evaluated so | |
8621 | any side-effects do not occur. | |
c906108c SS |
8622 | @end table |
8623 | ||
8624 | One of the ways to use a convenience variable is as a counter to be | |
8625 | incremented or a pointer to be advanced. For example, to print | |
8626 | a field from successive elements of an array of structures: | |
8627 | ||
474c8240 | 8628 | @smallexample |
c906108c SS |
8629 | set $i = 0 |
8630 | print bar[$i++]->contents | |
474c8240 | 8631 | @end smallexample |
c906108c | 8632 | |
d4f3574e SS |
8633 | @noindent |
8634 | Repeat that command by typing @key{RET}. | |
c906108c SS |
8635 | |
8636 | Some convenience variables are created automatically by @value{GDBN} and given | |
8637 | values likely to be useful. | |
8638 | ||
8639 | @table @code | |
41afff9a | 8640 | @vindex $_@r{, convenience variable} |
c906108c SS |
8641 | @item $_ |
8642 | The variable @code{$_} is automatically set by the @code{x} command to | |
79a6e687 | 8643 | the last address examined (@pxref{Memory, ,Examining Memory}). Other |
c906108c SS |
8644 | commands which provide a default address for @code{x} to examine also |
8645 | set @code{$_} to that address; these commands include @code{info line} | |
8646 | and @code{info breakpoint}. The type of @code{$_} is @code{void *} | |
8647 | except when set by the @code{x} command, in which case it is a pointer | |
8648 | to the type of @code{$__}. | |
8649 | ||
41afff9a | 8650 | @vindex $__@r{, convenience variable} |
c906108c SS |
8651 | @item $__ |
8652 | The variable @code{$__} is automatically set by the @code{x} command | |
8653 | to the value found in the last address examined. Its type is chosen | |
8654 | to match the format in which the data was printed. | |
8655 | ||
8656 | @item $_exitcode | |
41afff9a | 8657 | @vindex $_exitcode@r{, convenience variable} |
c906108c SS |
8658 | The variable @code{$_exitcode} is automatically set to the exit code when |
8659 | the program being debugged terminates. | |
4aa995e1 | 8660 | |
0fb4aa4b PA |
8661 | @item $_sdata |
8662 | @vindex $_sdata@r{, inspect, convenience variable} | |
8663 | The variable @code{$_sdata} contains extra collected static tracepoint | |
8664 | data. @xref{Tracepoint Actions,,Tracepoint Action Lists}. Note that | |
8665 | @code{$_sdata} could be empty, if not inspecting a trace buffer, or | |
8666 | if extra static tracepoint data has not been collected. | |
8667 | ||
4aa995e1 PA |
8668 | @item $_siginfo |
8669 | @vindex $_siginfo@r{, convenience variable} | |
ec7e75e7 PP |
8670 | The variable @code{$_siginfo} contains extra signal information |
8671 | (@pxref{extra signal information}). Note that @code{$_siginfo} | |
8672 | could be empty, if the application has not yet received any signals. | |
8673 | For example, it will be empty before you execute the @code{run} command. | |
711e434b PM |
8674 | |
8675 | @item $_tlb | |
8676 | @vindex $_tlb@r{, convenience variable} | |
8677 | The variable @code{$_tlb} is automatically set when debugging | |
8678 | applications running on MS-Windows in native mode or connected to | |
8679 | gdbserver that supports the @code{qGetTIBAddr} request. | |
8680 | @xref{General Query Packets}. | |
8681 | This variable contains the address of the thread information block. | |
8682 | ||
c906108c SS |
8683 | @end table |
8684 | ||
53a5351d JM |
8685 | On HP-UX systems, if you refer to a function or variable name that |
8686 | begins with a dollar sign, @value{GDBN} searches for a user or system | |
8687 | name first, before it searches for a convenience variable. | |
c906108c | 8688 | |
bc3b79fd TJB |
8689 | @cindex convenience functions |
8690 | @value{GDBN} also supplies some @dfn{convenience functions}. These | |
8691 | have a syntax similar to convenience variables. A convenience | |
8692 | function can be used in an expression just like an ordinary function; | |
8693 | however, a convenience function is implemented internally to | |
8694 | @value{GDBN}. | |
8695 | ||
8696 | @table @code | |
8697 | @item help function | |
8698 | @kindex help function | |
8699 | @cindex show all convenience functions | |
8700 | Print a list of all convenience functions. | |
8701 | @end table | |
8702 | ||
6d2ebf8b | 8703 | @node Registers |
c906108c SS |
8704 | @section Registers |
8705 | ||
8706 | @cindex registers | |
8707 | You can refer to machine register contents, in expressions, as variables | |
8708 | with names starting with @samp{$}. The names of registers are different | |
8709 | for each machine; use @code{info registers} to see the names used on | |
8710 | your machine. | |
8711 | ||
8712 | @table @code | |
8713 | @kindex info registers | |
8714 | @item info registers | |
8715 | Print the names and values of all registers except floating-point | |
c85508ee | 8716 | and vector registers (in the selected stack frame). |
c906108c SS |
8717 | |
8718 | @kindex info all-registers | |
8719 | @cindex floating point registers | |
8720 | @item info all-registers | |
8721 | Print the names and values of all registers, including floating-point | |
c85508ee | 8722 | and vector registers (in the selected stack frame). |
c906108c SS |
8723 | |
8724 | @item info registers @var{regname} @dots{} | |
8725 | Print the @dfn{relativized} value of each specified register @var{regname}. | |
5d161b24 DB |
8726 | As discussed in detail below, register values are normally relative to |
8727 | the selected stack frame. @var{regname} may be any register name valid on | |
c906108c SS |
8728 | the machine you are using, with or without the initial @samp{$}. |
8729 | @end table | |
8730 | ||
e09f16f9 EZ |
8731 | @cindex stack pointer register |
8732 | @cindex program counter register | |
8733 | @cindex process status register | |
8734 | @cindex frame pointer register | |
8735 | @cindex standard registers | |
c906108c SS |
8736 | @value{GDBN} has four ``standard'' register names that are available (in |
8737 | expressions) on most machines---whenever they do not conflict with an | |
8738 | architecture's canonical mnemonics for registers. The register names | |
8739 | @code{$pc} and @code{$sp} are used for the program counter register and | |
8740 | the stack pointer. @code{$fp} is used for a register that contains a | |
8741 | pointer to the current stack frame, and @code{$ps} is used for a | |
8742 | register that contains the processor status. For example, | |
8743 | you could print the program counter in hex with | |
8744 | ||
474c8240 | 8745 | @smallexample |
c906108c | 8746 | p/x $pc |
474c8240 | 8747 | @end smallexample |
c906108c SS |
8748 | |
8749 | @noindent | |
8750 | or print the instruction to be executed next with | |
8751 | ||
474c8240 | 8752 | @smallexample |
c906108c | 8753 | x/i $pc |
474c8240 | 8754 | @end smallexample |
c906108c SS |
8755 | |
8756 | @noindent | |
8757 | or add four to the stack pointer@footnote{This is a way of removing | |
8758 | one word from the stack, on machines where stacks grow downward in | |
8759 | memory (most machines, nowadays). This assumes that the innermost | |
8760 | stack frame is selected; setting @code{$sp} is not allowed when other | |
8761 | stack frames are selected. To pop entire frames off the stack, | |
8762 | regardless of machine architecture, use @code{return}; | |
79a6e687 | 8763 | see @ref{Returning, ,Returning from a Function}.} with |
c906108c | 8764 | |
474c8240 | 8765 | @smallexample |
c906108c | 8766 | set $sp += 4 |
474c8240 | 8767 | @end smallexample |
c906108c SS |
8768 | |
8769 | Whenever possible, these four standard register names are available on | |
8770 | your machine even though the machine has different canonical mnemonics, | |
8771 | so long as there is no conflict. The @code{info registers} command | |
8772 | shows the canonical names. For example, on the SPARC, @code{info | |
8773 | registers} displays the processor status register as @code{$psr} but you | |
d4f3574e SS |
8774 | can also refer to it as @code{$ps}; and on x86-based machines @code{$ps} |
8775 | is an alias for the @sc{eflags} register. | |
c906108c SS |
8776 | |
8777 | @value{GDBN} always considers the contents of an ordinary register as an | |
8778 | integer when the register is examined in this way. Some machines have | |
8779 | special registers which can hold nothing but floating point; these | |
8780 | registers are considered to have floating point values. There is no way | |
8781 | to refer to the contents of an ordinary register as floating point value | |
8782 | (although you can @emph{print} it as a floating point value with | |
8783 | @samp{print/f $@var{regname}}). | |
8784 | ||
8785 | Some registers have distinct ``raw'' and ``virtual'' data formats. This | |
8786 | means that the data format in which the register contents are saved by | |
8787 | the operating system is not the same one that your program normally | |
8788 | sees. For example, the registers of the 68881 floating point | |
8789 | coprocessor are always saved in ``extended'' (raw) format, but all C | |
8790 | programs expect to work with ``double'' (virtual) format. In such | |
5d161b24 | 8791 | cases, @value{GDBN} normally works with the virtual format only (the format |
c906108c SS |
8792 | that makes sense for your program), but the @code{info registers} command |
8793 | prints the data in both formats. | |
8794 | ||
36b80e65 EZ |
8795 | @cindex SSE registers (x86) |
8796 | @cindex MMX registers (x86) | |
8797 | Some machines have special registers whose contents can be interpreted | |
8798 | in several different ways. For example, modern x86-based machines | |
8799 | have SSE and MMX registers that can hold several values packed | |
8800 | together in several different formats. @value{GDBN} refers to such | |
8801 | registers in @code{struct} notation: | |
8802 | ||
8803 | @smallexample | |
8804 | (@value{GDBP}) print $xmm1 | |
8805 | $1 = @{ | |
8806 | v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@}, | |
8807 | v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@}, | |
8808 | v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000", | |
8809 | v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@}, | |
8810 | v4_int32 = @{0, 20657912, 11, 13@}, | |
8811 | v2_int64 = @{88725056443645952, 55834574859@}, | |
8812 | uint128 = 0x0000000d0000000b013b36f800000000 | |
8813 | @} | |
8814 | @end smallexample | |
8815 | ||
8816 | @noindent | |
8817 | To set values of such registers, you need to tell @value{GDBN} which | |
8818 | view of the register you wish to change, as if you were assigning | |
8819 | value to a @code{struct} member: | |
8820 | ||
8821 | @smallexample | |
8822 | (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF | |
8823 | @end smallexample | |
8824 | ||
c906108c | 8825 | Normally, register values are relative to the selected stack frame |
79a6e687 | 8826 | (@pxref{Selection, ,Selecting a Frame}). This means that you get the |
c906108c SS |
8827 | value that the register would contain if all stack frames farther in |
8828 | were exited and their saved registers restored. In order to see the | |
8829 | true contents of hardware registers, you must select the innermost | |
8830 | frame (with @samp{frame 0}). | |
8831 | ||
8832 | However, @value{GDBN} must deduce where registers are saved, from the machine | |
8833 | code generated by your compiler. If some registers are not saved, or if | |
8834 | @value{GDBN} is unable to locate the saved registers, the selected stack | |
8835 | frame makes no difference. | |
8836 | ||
6d2ebf8b | 8837 | @node Floating Point Hardware |
79a6e687 | 8838 | @section Floating Point Hardware |
c906108c SS |
8839 | @cindex floating point |
8840 | ||
8841 | Depending on the configuration, @value{GDBN} may be able to give | |
8842 | you more information about the status of the floating point hardware. | |
8843 | ||
8844 | @table @code | |
8845 | @kindex info float | |
8846 | @item info float | |
8847 | Display hardware-dependent information about the floating | |
8848 | point unit. The exact contents and layout vary depending on the | |
8849 | floating point chip. Currently, @samp{info float} is supported on | |
8850 | the ARM and x86 machines. | |
8851 | @end table | |
c906108c | 8852 | |
e76f1f2e AC |
8853 | @node Vector Unit |
8854 | @section Vector Unit | |
8855 | @cindex vector unit | |
8856 | ||
8857 | Depending on the configuration, @value{GDBN} may be able to give you | |
8858 | more information about the status of the vector unit. | |
8859 | ||
8860 | @table @code | |
8861 | @kindex info vector | |
8862 | @item info vector | |
8863 | Display information about the vector unit. The exact contents and | |
8864 | layout vary depending on the hardware. | |
8865 | @end table | |
8866 | ||
721c2651 | 8867 | @node OS Information |
79a6e687 | 8868 | @section Operating System Auxiliary Information |
721c2651 EZ |
8869 | @cindex OS information |
8870 | ||
8871 | @value{GDBN} provides interfaces to useful OS facilities that can help | |
8872 | you debug your program. | |
8873 | ||
8874 | @cindex @code{ptrace} system call | |
8875 | @cindex @code{struct user} contents | |
8876 | When @value{GDBN} runs on a @dfn{Posix system} (such as GNU or Unix | |
8877 | machines), it interfaces with the inferior via the @code{ptrace} | |
8878 | system call. The operating system creates a special sata structure, | |
8879 | called @code{struct user}, for this interface. You can use the | |
8880 | command @code{info udot} to display the contents of this data | |
8881 | structure. | |
8882 | ||
8883 | @table @code | |
8884 | @item info udot | |
8885 | @kindex info udot | |
8886 | Display the contents of the @code{struct user} maintained by the OS | |
8887 | kernel for the program being debugged. @value{GDBN} displays the | |
8888 | contents of @code{struct user} as a list of hex numbers, similar to | |
8889 | the @code{examine} command. | |
8890 | @end table | |
8891 | ||
b383017d RM |
8892 | @cindex auxiliary vector |
8893 | @cindex vector, auxiliary | |
b383017d RM |
8894 | Some operating systems supply an @dfn{auxiliary vector} to programs at |
8895 | startup. This is akin to the arguments and environment that you | |
8896 | specify for a program, but contains a system-dependent variety of | |
8897 | binary values that tell system libraries important details about the | |
8898 | hardware, operating system, and process. Each value's purpose is | |
8899 | identified by an integer tag; the meanings are well-known but system-specific. | |
8900 | Depending on the configuration and operating system facilities, | |
9c16f35a EZ |
8901 | @value{GDBN} may be able to show you this information. For remote |
8902 | targets, this functionality may further depend on the remote stub's | |
427c3a89 DJ |
8903 | support of the @samp{qXfer:auxv:read} packet, see |
8904 | @ref{qXfer auxiliary vector read}. | |
b383017d RM |
8905 | |
8906 | @table @code | |
8907 | @kindex info auxv | |
8908 | @item info auxv | |
8909 | Display the auxiliary vector of the inferior, which can be either a | |
e4937fc1 | 8910 | live process or a core dump file. @value{GDBN} prints each tag value |
b383017d RM |
8911 | numerically, and also shows names and text descriptions for recognized |
8912 | tags. Some values in the vector are numbers, some bit masks, and some | |
e4937fc1 | 8913 | pointers to strings or other data. @value{GDBN} displays each value in the |
b383017d RM |
8914 | most appropriate form for a recognized tag, and in hexadecimal for |
8915 | an unrecognized tag. | |
8916 | @end table | |
8917 | ||
07e059b5 VP |
8918 | On some targets, @value{GDBN} can access operating-system-specific information |
8919 | and display it to user, without interpretation. For remote targets, | |
8920 | this functionality depends on the remote stub's support of the | |
8921 | @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}. | |
8922 | ||
8923 | @table @code | |
a61408f8 SS |
8924 | @kindex info os |
8925 | @item info os | |
8926 | List the types of OS information available for the target. If the | |
8927 | target does not return a list of possible types, this command will | |
8928 | report an error. | |
8929 | ||
07e059b5 VP |
8930 | @kindex info os processes |
8931 | @item info os processes | |
8932 | Display the list of processes on the target. For each process, | |
8933 | @value{GDBN} prints the process identifier, the name of the user, and | |
8934 | the command corresponding to the process. | |
8935 | @end table | |
721c2651 | 8936 | |
29e57380 | 8937 | @node Memory Region Attributes |
79a6e687 | 8938 | @section Memory Region Attributes |
29e57380 C |
8939 | @cindex memory region attributes |
8940 | ||
b383017d | 8941 | @dfn{Memory region attributes} allow you to describe special handling |
fd79ecee DJ |
8942 | required by regions of your target's memory. @value{GDBN} uses |
8943 | attributes to determine whether to allow certain types of memory | |
8944 | accesses; whether to use specific width accesses; and whether to cache | |
8945 | target memory. By default the description of memory regions is | |
8946 | fetched from the target (if the current target supports this), but the | |
8947 | user can override the fetched regions. | |
29e57380 C |
8948 | |
8949 | Defined memory regions can be individually enabled and disabled. When a | |
8950 | memory region is disabled, @value{GDBN} uses the default attributes when | |
8951 | accessing memory in that region. Similarly, if no memory regions have | |
8952 | been defined, @value{GDBN} uses the default attributes when accessing | |
8953 | all memory. | |
8954 | ||
b383017d | 8955 | When a memory region is defined, it is given a number to identify it; |
29e57380 C |
8956 | to enable, disable, or remove a memory region, you specify that number. |
8957 | ||
8958 | @table @code | |
8959 | @kindex mem | |
bfac230e | 8960 | @item mem @var{lower} @var{upper} @var{attributes}@dots{} |
09d4efe1 EZ |
8961 | Define a memory region bounded by @var{lower} and @var{upper} with |
8962 | attributes @var{attributes}@dots{}, and add it to the list of regions | |
8963 | monitored by @value{GDBN}. Note that @var{upper} == 0 is a special | |
d3e8051b | 8964 | case: it is treated as the target's maximum memory address. |
bfac230e | 8965 | (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.) |
29e57380 | 8966 | |
fd79ecee DJ |
8967 | @item mem auto |
8968 | Discard any user changes to the memory regions and use target-supplied | |
8969 | regions, if available, or no regions if the target does not support. | |
8970 | ||
29e57380 C |
8971 | @kindex delete mem |
8972 | @item delete mem @var{nums}@dots{} | |
09d4efe1 EZ |
8973 | Remove memory regions @var{nums}@dots{} from the list of regions |
8974 | monitored by @value{GDBN}. | |
29e57380 C |
8975 | |
8976 | @kindex disable mem | |
8977 | @item disable mem @var{nums}@dots{} | |
09d4efe1 | 8978 | Disable monitoring of memory regions @var{nums}@dots{}. |
b383017d | 8979 | A disabled memory region is not forgotten. |
29e57380 C |
8980 | It may be enabled again later. |
8981 | ||
8982 | @kindex enable mem | |
8983 | @item enable mem @var{nums}@dots{} | |
09d4efe1 | 8984 | Enable monitoring of memory regions @var{nums}@dots{}. |
29e57380 C |
8985 | |
8986 | @kindex info mem | |
8987 | @item info mem | |
8988 | Print a table of all defined memory regions, with the following columns | |
09d4efe1 | 8989 | for each region: |
29e57380 C |
8990 | |
8991 | @table @emph | |
8992 | @item Memory Region Number | |
8993 | @item Enabled or Disabled. | |
b383017d | 8994 | Enabled memory regions are marked with @samp{y}. |
29e57380 C |
8995 | Disabled memory regions are marked with @samp{n}. |
8996 | ||
8997 | @item Lo Address | |
8998 | The address defining the inclusive lower bound of the memory region. | |
8999 | ||
9000 | @item Hi Address | |
9001 | The address defining the exclusive upper bound of the memory region. | |
9002 | ||
9003 | @item Attributes | |
9004 | The list of attributes set for this memory region. | |
9005 | @end table | |
9006 | @end table | |
9007 | ||
9008 | ||
9009 | @subsection Attributes | |
9010 | ||
b383017d | 9011 | @subsubsection Memory Access Mode |
29e57380 C |
9012 | The access mode attributes set whether @value{GDBN} may make read or |
9013 | write accesses to a memory region. | |
9014 | ||
9015 | While these attributes prevent @value{GDBN} from performing invalid | |
9016 | memory accesses, they do nothing to prevent the target system, I/O DMA, | |
359df76b | 9017 | etc.@: from accessing memory. |
29e57380 C |
9018 | |
9019 | @table @code | |
9020 | @item ro | |
9021 | Memory is read only. | |
9022 | @item wo | |
9023 | Memory is write only. | |
9024 | @item rw | |
6ca652b0 | 9025 | Memory is read/write. This is the default. |
29e57380 C |
9026 | @end table |
9027 | ||
9028 | @subsubsection Memory Access Size | |
d3e8051b | 9029 | The access size attribute tells @value{GDBN} to use specific sized |
29e57380 C |
9030 | accesses in the memory region. Often memory mapped device registers |
9031 | require specific sized accesses. If no access size attribute is | |
9032 | specified, @value{GDBN} may use accesses of any size. | |
9033 | ||
9034 | @table @code | |
9035 | @item 8 | |
9036 | Use 8 bit memory accesses. | |
9037 | @item 16 | |
9038 | Use 16 bit memory accesses. | |
9039 | @item 32 | |
9040 | Use 32 bit memory accesses. | |
9041 | @item 64 | |
9042 | Use 64 bit memory accesses. | |
9043 | @end table | |
9044 | ||
9045 | @c @subsubsection Hardware/Software Breakpoints | |
9046 | @c The hardware/software breakpoint attributes set whether @value{GDBN} | |
9047 | @c will use hardware or software breakpoints for the internal breakpoints | |
9048 | @c used by the step, next, finish, until, etc. commands. | |
9049 | @c | |
9050 | @c @table @code | |
9051 | @c @item hwbreak | |
b383017d | 9052 | @c Always use hardware breakpoints |
29e57380 C |
9053 | @c @item swbreak (default) |
9054 | @c @end table | |
9055 | ||
9056 | @subsubsection Data Cache | |
9057 | The data cache attributes set whether @value{GDBN} will cache target | |
9058 | memory. While this generally improves performance by reducing debug | |
9059 | protocol overhead, it can lead to incorrect results because @value{GDBN} | |
9060 | does not know about volatile variables or memory mapped device | |
9061 | registers. | |
9062 | ||
9063 | @table @code | |
9064 | @item cache | |
b383017d | 9065 | Enable @value{GDBN} to cache target memory. |
6ca652b0 EZ |
9066 | @item nocache |
9067 | Disable @value{GDBN} from caching target memory. This is the default. | |
29e57380 C |
9068 | @end table |
9069 | ||
4b5752d0 VP |
9070 | @subsection Memory Access Checking |
9071 | @value{GDBN} can be instructed to refuse accesses to memory that is | |
9072 | not explicitly described. This can be useful if accessing such | |
9073 | regions has undesired effects for a specific target, or to provide | |
9074 | better error checking. The following commands control this behaviour. | |
9075 | ||
9076 | @table @code | |
9077 | @kindex set mem inaccessible-by-default | |
9078 | @item set mem inaccessible-by-default [on|off] | |
9079 | If @code{on} is specified, make @value{GDBN} treat memory not | |
9080 | explicitly described by the memory ranges as non-existent and refuse accesses | |
9081 | to such memory. The checks are only performed if there's at least one | |
9082 | memory range defined. If @code{off} is specified, make @value{GDBN} | |
9083 | treat the memory not explicitly described by the memory ranges as RAM. | |
56cf5405 | 9084 | The default value is @code{on}. |
4b5752d0 VP |
9085 | @kindex show mem inaccessible-by-default |
9086 | @item show mem inaccessible-by-default | |
9087 | Show the current handling of accesses to unknown memory. | |
9088 | @end table | |
9089 | ||
9090 | ||
29e57380 | 9091 | @c @subsubsection Memory Write Verification |
b383017d | 9092 | @c The memory write verification attributes set whether @value{GDBN} |
29e57380 C |
9093 | @c will re-reads data after each write to verify the write was successful. |
9094 | @c | |
9095 | @c @table @code | |
9096 | @c @item verify | |
9097 | @c @item noverify (default) | |
9098 | @c @end table | |
9099 | ||
16d9dec6 | 9100 | @node Dump/Restore Files |
79a6e687 | 9101 | @section Copy Between Memory and a File |
16d9dec6 MS |
9102 | @cindex dump/restore files |
9103 | @cindex append data to a file | |
9104 | @cindex dump data to a file | |
9105 | @cindex restore data from a file | |
16d9dec6 | 9106 | |
df5215a6 JB |
9107 | You can use the commands @code{dump}, @code{append}, and |
9108 | @code{restore} to copy data between target memory and a file. The | |
9109 | @code{dump} and @code{append} commands write data to a file, and the | |
9110 | @code{restore} command reads data from a file back into the inferior's | |
9111 | memory. Files may be in binary, Motorola S-record, Intel hex, or | |
9112 | Tektronix Hex format; however, @value{GDBN} can only append to binary | |
9113 | files. | |
9114 | ||
9115 | @table @code | |
9116 | ||
9117 | @kindex dump | |
9118 | @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr} | |
9119 | @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr} | |
9120 | Dump the contents of memory from @var{start_addr} to @var{end_addr}, | |
9121 | or the value of @var{expr}, to @var{filename} in the given format. | |
16d9dec6 | 9122 | |
df5215a6 | 9123 | The @var{format} parameter may be any one of: |
16d9dec6 | 9124 | @table @code |
df5215a6 JB |
9125 | @item binary |
9126 | Raw binary form. | |
9127 | @item ihex | |
9128 | Intel hex format. | |
9129 | @item srec | |
9130 | Motorola S-record format. | |
9131 | @item tekhex | |
9132 | Tektronix Hex format. | |
9133 | @end table | |
9134 | ||
9135 | @value{GDBN} uses the same definitions of these formats as the | |
9136 | @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If | |
9137 | @var{format} is omitted, @value{GDBN} dumps the data in raw binary | |
9138 | form. | |
9139 | ||
9140 | @kindex append | |
9141 | @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr} | |
9142 | @itemx append @r{[}binary@r{]} value @var{filename} @var{expr} | |
9143 | Append the contents of memory from @var{start_addr} to @var{end_addr}, | |
09d4efe1 | 9144 | or the value of @var{expr}, to the file @var{filename}, in raw binary form. |
df5215a6 JB |
9145 | (@value{GDBN} can only append data to files in raw binary form.) |
9146 | ||
9147 | @kindex restore | |
9148 | @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end} | |
9149 | Restore the contents of file @var{filename} into memory. The | |
9150 | @code{restore} command can automatically recognize any known @sc{bfd} | |
9151 | file format, except for raw binary. To restore a raw binary file you | |
9152 | must specify the optional keyword @code{binary} after the filename. | |
16d9dec6 | 9153 | |
b383017d | 9154 | If @var{bias} is non-zero, its value will be added to the addresses |
16d9dec6 MS |
9155 | contained in the file. Binary files always start at address zero, so |
9156 | they will be restored at address @var{bias}. Other bfd files have | |
9157 | a built-in location; they will be restored at offset @var{bias} | |
9158 | from that location. | |
9159 | ||
9160 | If @var{start} and/or @var{end} are non-zero, then only data between | |
9161 | file offset @var{start} and file offset @var{end} will be restored. | |
b383017d | 9162 | These offsets are relative to the addresses in the file, before |
16d9dec6 MS |
9163 | the @var{bias} argument is applied. |
9164 | ||
9165 | @end table | |
9166 | ||
384ee23f EZ |
9167 | @node Core File Generation |
9168 | @section How to Produce a Core File from Your Program | |
9169 | @cindex dump core from inferior | |
9170 | ||
9171 | A @dfn{core file} or @dfn{core dump} is a file that records the memory | |
9172 | image of a running process and its process status (register values | |
9173 | etc.). Its primary use is post-mortem debugging of a program that | |
9174 | crashed while it ran outside a debugger. A program that crashes | |
9175 | automatically produces a core file, unless this feature is disabled by | |
9176 | the user. @xref{Files}, for information on invoking @value{GDBN} in | |
9177 | the post-mortem debugging mode. | |
9178 | ||
9179 | Occasionally, you may wish to produce a core file of the program you | |
9180 | are debugging in order to preserve a snapshot of its state. | |
9181 | @value{GDBN} has a special command for that. | |
9182 | ||
9183 | @table @code | |
9184 | @kindex gcore | |
9185 | @kindex generate-core-file | |
9186 | @item generate-core-file [@var{file}] | |
9187 | @itemx gcore [@var{file}] | |
9188 | Produce a core dump of the inferior process. The optional argument | |
9189 | @var{file} specifies the file name where to put the core dump. If not | |
9190 | specified, the file name defaults to @file{core.@var{pid}}, where | |
9191 | @var{pid} is the inferior process ID. | |
9192 | ||
9193 | Note that this command is implemented only for some systems (as of | |
9194 | this writing, @sc{gnu}/Linux, FreeBSD, Solaris, Unixware, and S390). | |
9195 | @end table | |
9196 | ||
a0eb71c5 KB |
9197 | @node Character Sets |
9198 | @section Character Sets | |
9199 | @cindex character sets | |
9200 | @cindex charset | |
9201 | @cindex translating between character sets | |
9202 | @cindex host character set | |
9203 | @cindex target character set | |
9204 | ||
9205 | If the program you are debugging uses a different character set to | |
9206 | represent characters and strings than the one @value{GDBN} uses itself, | |
9207 | @value{GDBN} can automatically translate between the character sets for | |
9208 | you. The character set @value{GDBN} uses we call the @dfn{host | |
9209 | character set}; the one the inferior program uses we call the | |
9210 | @dfn{target character set}. | |
9211 | ||
9212 | For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which | |
9213 | uses the ISO Latin 1 character set, but you are using @value{GDBN}'s | |
ea35711c | 9214 | remote protocol (@pxref{Remote Debugging}) to debug a program |
a0eb71c5 KB |
9215 | running on an IBM mainframe, which uses the @sc{ebcdic} character set, |
9216 | then the host character set is Latin-1, and the target character set is | |
9217 | @sc{ebcdic}. If you give @value{GDBN} the command @code{set | |
e33d66ec | 9218 | target-charset EBCDIC-US}, then @value{GDBN} translates between |
a0eb71c5 KB |
9219 | @sc{ebcdic} and Latin 1 as you print character or string values, or use |
9220 | character and string literals in expressions. | |
9221 | ||
9222 | @value{GDBN} has no way to automatically recognize which character set | |
9223 | the inferior program uses; you must tell it, using the @code{set | |
9224 | target-charset} command, described below. | |
9225 | ||
9226 | Here are the commands for controlling @value{GDBN}'s character set | |
9227 | support: | |
9228 | ||
9229 | @table @code | |
9230 | @item set target-charset @var{charset} | |
9231 | @kindex set target-charset | |
10af6951 EZ |
9232 | Set the current target character set to @var{charset}. To display the |
9233 | list of supported target character sets, type | |
9234 | @kbd{@w{set target-charset @key{TAB}@key{TAB}}}. | |
a0eb71c5 | 9235 | |
a0eb71c5 KB |
9236 | @item set host-charset @var{charset} |
9237 | @kindex set host-charset | |
9238 | Set the current host character set to @var{charset}. | |
9239 | ||
9240 | By default, @value{GDBN} uses a host character set appropriate to the | |
9241 | system it is running on; you can override that default using the | |
732f6a93 TT |
9242 | @code{set host-charset} command. On some systems, @value{GDBN} cannot |
9243 | automatically determine the appropriate host character set. In this | |
9244 | case, @value{GDBN} uses @samp{UTF-8}. | |
a0eb71c5 KB |
9245 | |
9246 | @value{GDBN} can only use certain character sets as its host character | |
c1b6b909 | 9247 | set. If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}}, |
10af6951 | 9248 | @value{GDBN} will list the host character sets it supports. |
a0eb71c5 KB |
9249 | |
9250 | @item set charset @var{charset} | |
9251 | @kindex set charset | |
e33d66ec | 9252 | Set the current host and target character sets to @var{charset}. As |
10af6951 EZ |
9253 | above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}}, |
9254 | @value{GDBN} will list the names of the character sets that can be used | |
e33d66ec EZ |
9255 | for both host and target. |
9256 | ||
a0eb71c5 | 9257 | @item show charset |
a0eb71c5 | 9258 | @kindex show charset |
10af6951 | 9259 | Show the names of the current host and target character sets. |
e33d66ec | 9260 | |
10af6951 | 9261 | @item show host-charset |
a0eb71c5 | 9262 | @kindex show host-charset |
10af6951 | 9263 | Show the name of the current host character set. |
e33d66ec | 9264 | |
10af6951 | 9265 | @item show target-charset |
a0eb71c5 | 9266 | @kindex show target-charset |
10af6951 | 9267 | Show the name of the current target character set. |
a0eb71c5 | 9268 | |
10af6951 EZ |
9269 | @item set target-wide-charset @var{charset} |
9270 | @kindex set target-wide-charset | |
9271 | Set the current target's wide character set to @var{charset}. This is | |
9272 | the character set used by the target's @code{wchar_t} type. To | |
9273 | display the list of supported wide character sets, type | |
9274 | @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}. | |
9275 | ||
9276 | @item show target-wide-charset | |
9277 | @kindex show target-wide-charset | |
9278 | Show the name of the current target's wide character set. | |
a0eb71c5 KB |
9279 | @end table |
9280 | ||
a0eb71c5 KB |
9281 | Here is an example of @value{GDBN}'s character set support in action. |
9282 | Assume that the following source code has been placed in the file | |
9283 | @file{charset-test.c}: | |
9284 | ||
9285 | @smallexample | |
9286 | #include <stdio.h> | |
9287 | ||
9288 | char ascii_hello[] | |
9289 | = @{72, 101, 108, 108, 111, 44, 32, 119, | |
9290 | 111, 114, 108, 100, 33, 10, 0@}; | |
9291 | char ibm1047_hello[] | |
9292 | = @{200, 133, 147, 147, 150, 107, 64, 166, | |
9293 | 150, 153, 147, 132, 90, 37, 0@}; | |
9294 | ||
9295 | main () | |
9296 | @{ | |
9297 | printf ("Hello, world!\n"); | |
9298 | @} | |
10998722 | 9299 | @end smallexample |
a0eb71c5 KB |
9300 | |
9301 | In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays | |
9302 | containing the string @samp{Hello, world!} followed by a newline, | |
9303 | encoded in the @sc{ascii} and @sc{ibm1047} character sets. | |
9304 | ||
9305 | We compile the program, and invoke the debugger on it: | |
9306 | ||
9307 | @smallexample | |
9308 | $ gcc -g charset-test.c -o charset-test | |
9309 | $ gdb -nw charset-test | |
9310 | GNU gdb 2001-12-19-cvs | |
9311 | Copyright 2001 Free Software Foundation, Inc. | |
9312 | @dots{} | |
f7dc1244 | 9313 | (@value{GDBP}) |
10998722 | 9314 | @end smallexample |
a0eb71c5 KB |
9315 | |
9316 | We can use the @code{show charset} command to see what character sets | |
9317 | @value{GDBN} is currently using to interpret and display characters and | |
9318 | strings: | |
9319 | ||
9320 | @smallexample | |
f7dc1244 | 9321 | (@value{GDBP}) show charset |
e33d66ec | 9322 | The current host and target character set is `ISO-8859-1'. |
f7dc1244 | 9323 | (@value{GDBP}) |
10998722 | 9324 | @end smallexample |
a0eb71c5 KB |
9325 | |
9326 | For the sake of printing this manual, let's use @sc{ascii} as our | |
9327 | initial character set: | |
9328 | @smallexample | |
f7dc1244 EZ |
9329 | (@value{GDBP}) set charset ASCII |
9330 | (@value{GDBP}) show charset | |
e33d66ec | 9331 | The current host and target character set is `ASCII'. |
f7dc1244 | 9332 | (@value{GDBP}) |
10998722 | 9333 | @end smallexample |
a0eb71c5 KB |
9334 | |
9335 | Let's assume that @sc{ascii} is indeed the correct character set for our | |
9336 | host system --- in other words, let's assume that if @value{GDBN} prints | |
9337 | characters using the @sc{ascii} character set, our terminal will display | |
9338 | them properly. Since our current target character set is also | |
9339 | @sc{ascii}, the contents of @code{ascii_hello} print legibly: | |
9340 | ||
9341 | @smallexample | |
f7dc1244 | 9342 | (@value{GDBP}) print ascii_hello |
a0eb71c5 | 9343 | $1 = 0x401698 "Hello, world!\n" |
f7dc1244 | 9344 | (@value{GDBP}) print ascii_hello[0] |
a0eb71c5 | 9345 | $2 = 72 'H' |
f7dc1244 | 9346 | (@value{GDBP}) |
10998722 | 9347 | @end smallexample |
a0eb71c5 KB |
9348 | |
9349 | @value{GDBN} uses the target character set for character and string | |
9350 | literals you use in expressions: | |
9351 | ||
9352 | @smallexample | |
f7dc1244 | 9353 | (@value{GDBP}) print '+' |
a0eb71c5 | 9354 | $3 = 43 '+' |
f7dc1244 | 9355 | (@value{GDBP}) |
10998722 | 9356 | @end smallexample |
a0eb71c5 KB |
9357 | |
9358 | The @sc{ascii} character set uses the number 43 to encode the @samp{+} | |
9359 | character. | |
9360 | ||
9361 | @value{GDBN} relies on the user to tell it which character set the | |
9362 | target program uses. If we print @code{ibm1047_hello} while our target | |
9363 | character set is still @sc{ascii}, we get jibberish: | |
9364 | ||
9365 | @smallexample | |
f7dc1244 | 9366 | (@value{GDBP}) print ibm1047_hello |
a0eb71c5 | 9367 | $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%" |
f7dc1244 | 9368 | (@value{GDBP}) print ibm1047_hello[0] |
a0eb71c5 | 9369 | $5 = 200 '\310' |
f7dc1244 | 9370 | (@value{GDBP}) |
10998722 | 9371 | @end smallexample |
a0eb71c5 | 9372 | |
e33d66ec | 9373 | If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB}, |
a0eb71c5 KB |
9374 | @value{GDBN} tells us the character sets it supports: |
9375 | ||
9376 | @smallexample | |
f7dc1244 | 9377 | (@value{GDBP}) set target-charset |
b383017d | 9378 | ASCII EBCDIC-US IBM1047 ISO-8859-1 |
f7dc1244 | 9379 | (@value{GDBP}) set target-charset |
10998722 | 9380 | @end smallexample |
a0eb71c5 KB |
9381 | |
9382 | We can select @sc{ibm1047} as our target character set, and examine the | |
9383 | program's strings again. Now the @sc{ascii} string is wrong, but | |
9384 | @value{GDBN} translates the contents of @code{ibm1047_hello} from the | |
9385 | target character set, @sc{ibm1047}, to the host character set, | |
9386 | @sc{ascii}, and they display correctly: | |
9387 | ||
9388 | @smallexample | |
f7dc1244 EZ |
9389 | (@value{GDBP}) set target-charset IBM1047 |
9390 | (@value{GDBP}) show charset | |
e33d66ec EZ |
9391 | The current host character set is `ASCII'. |
9392 | The current target character set is `IBM1047'. | |
f7dc1244 | 9393 | (@value{GDBP}) print ascii_hello |
a0eb71c5 | 9394 | $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012" |
f7dc1244 | 9395 | (@value{GDBP}) print ascii_hello[0] |
a0eb71c5 | 9396 | $7 = 72 '\110' |
f7dc1244 | 9397 | (@value{GDBP}) print ibm1047_hello |
a0eb71c5 | 9398 | $8 = 0x4016a8 "Hello, world!\n" |
f7dc1244 | 9399 | (@value{GDBP}) print ibm1047_hello[0] |
a0eb71c5 | 9400 | $9 = 200 'H' |
f7dc1244 | 9401 | (@value{GDBP}) |
10998722 | 9402 | @end smallexample |
a0eb71c5 KB |
9403 | |
9404 | As above, @value{GDBN} uses the target character set for character and | |
9405 | string literals you use in expressions: | |
9406 | ||
9407 | @smallexample | |
f7dc1244 | 9408 | (@value{GDBP}) print '+' |
a0eb71c5 | 9409 | $10 = 78 '+' |
f7dc1244 | 9410 | (@value{GDBP}) |
10998722 | 9411 | @end smallexample |
a0eb71c5 | 9412 | |
e33d66ec | 9413 | The @sc{ibm1047} character set uses the number 78 to encode the @samp{+} |
a0eb71c5 KB |
9414 | character. |
9415 | ||
09d4efe1 EZ |
9416 | @node Caching Remote Data |
9417 | @section Caching Data of Remote Targets | |
9418 | @cindex caching data of remote targets | |
9419 | ||
4e5d721f | 9420 | @value{GDBN} caches data exchanged between the debugger and a |
ea35711c | 9421 | remote target (@pxref{Remote Debugging}). Such caching generally improves |
09d4efe1 | 9422 | performance, because it reduces the overhead of the remote protocol by |
4e5d721f DE |
9423 | bundling memory reads and writes into large chunks. Unfortunately, simply |
9424 | caching everything would lead to incorrect results, since @value{GDBN} | |
9425 | does not necessarily know anything about volatile values, memory-mapped I/O | |
29b090c0 DE |
9426 | addresses, etc. Furthermore, in non-stop mode (@pxref{Non-Stop Mode}) |
9427 | memory can be changed @emph{while} a gdb command is executing. | |
9428 | Therefore, by default, @value{GDBN} only caches data | |
9429 | known to be on the stack@footnote{In non-stop mode, it is moderately | |
9430 | rare for a running thread to modify the stack of a stopped thread | |
9431 | in a way that would interfere with a backtrace, and caching of | |
9432 | stack reads provides a significant speed up of remote backtraces.}. | |
9433 | Other regions of memory can be explicitly marked as | |
4e5d721f | 9434 | cacheable; see @pxref{Memory Region Attributes}. |
09d4efe1 EZ |
9435 | |
9436 | @table @code | |
9437 | @kindex set remotecache | |
9438 | @item set remotecache on | |
9439 | @itemx set remotecache off | |
4e5d721f DE |
9440 | This option no longer does anything; it exists for compatibility |
9441 | with old scripts. | |
09d4efe1 EZ |
9442 | |
9443 | @kindex show remotecache | |
9444 | @item show remotecache | |
4e5d721f DE |
9445 | Show the current state of the obsolete remotecache flag. |
9446 | ||
9447 | @kindex set stack-cache | |
9448 | @item set stack-cache on | |
9449 | @itemx set stack-cache off | |
9450 | Enable or disable caching of stack accesses. When @code{ON}, use | |
9451 | caching. By default, this option is @code{ON}. | |
9452 | ||
9453 | @kindex show stack-cache | |
9454 | @item show stack-cache | |
9455 | Show the current state of data caching for memory accesses. | |
09d4efe1 EZ |
9456 | |
9457 | @kindex info dcache | |
4e5d721f | 9458 | @item info dcache @r{[}line@r{]} |
09d4efe1 | 9459 | Print the information about the data cache performance. The |
4e5d721f DE |
9460 | information displayed includes the dcache width and depth, and for |
9461 | each cache line, its number, address, and how many times it was | |
9462 | referenced. This command is useful for debugging the data cache | |
9463 | operation. | |
9464 | ||
9465 | If a line number is specified, the contents of that line will be | |
9466 | printed in hex. | |
1a532630 PP |
9467 | |
9468 | @item set dcache size @var{size} | |
9469 | @cindex dcache size | |
9470 | @kindex set dcache size | |
9471 | Set maximum number of entries in dcache (dcache depth above). | |
9472 | ||
9473 | @item set dcache line-size @var{line-size} | |
9474 | @cindex dcache line-size | |
9475 | @kindex set dcache line-size | |
9476 | Set number of bytes each dcache entry caches (dcache width above). | |
9477 | Must be a power of 2. | |
9478 | ||
9479 | @item show dcache size | |
9480 | @kindex show dcache size | |
9481 | Show maximum number of dcache entries. See also @ref{Caching Remote Data, info dcache}. | |
9482 | ||
9483 | @item show dcache line-size | |
9484 | @kindex show dcache line-size | |
9485 | Show default size of dcache lines. See also @ref{Caching Remote Data, info dcache}. | |
9486 | ||
09d4efe1 EZ |
9487 | @end table |
9488 | ||
08388c79 DE |
9489 | @node Searching Memory |
9490 | @section Search Memory | |
9491 | @cindex searching memory | |
9492 | ||
9493 | Memory can be searched for a particular sequence of bytes with the | |
9494 | @code{find} command. | |
9495 | ||
9496 | @table @code | |
9497 | @kindex find | |
9498 | @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]} | |
9499 | @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]} | |
9500 | Search memory for the sequence of bytes specified by @var{val1}, @var{val2}, | |
9501 | etc. The search begins at address @var{start_addr} and continues for either | |
9502 | @var{len} bytes or through to @var{end_addr} inclusive. | |
9503 | @end table | |
9504 | ||
9505 | @var{s} and @var{n} are optional parameters. | |
9506 | They may be specified in either order, apart or together. | |
9507 | ||
9508 | @table @r | |
9509 | @item @var{s}, search query size | |
9510 | The size of each search query value. | |
9511 | ||
9512 | @table @code | |
9513 | @item b | |
9514 | bytes | |
9515 | @item h | |
9516 | halfwords (two bytes) | |
9517 | @item w | |
9518 | words (four bytes) | |
9519 | @item g | |
9520 | giant words (eight bytes) | |
9521 | @end table | |
9522 | ||
9523 | All values are interpreted in the current language. | |
9524 | This means, for example, that if the current source language is C/C@t{++} | |
9525 | then searching for the string ``hello'' includes the trailing '\0'. | |
9526 | ||
9527 | If the value size is not specified, it is taken from the | |
9528 | value's type in the current language. | |
9529 | This is useful when one wants to specify the search | |
9530 | pattern as a mixture of types. | |
9531 | Note that this means, for example, that in the case of C-like languages | |
9532 | a search for an untyped 0x42 will search for @samp{(int) 0x42} | |
9533 | which is typically four bytes. | |
9534 | ||
9535 | @item @var{n}, maximum number of finds | |
9536 | The maximum number of matches to print. The default is to print all finds. | |
9537 | @end table | |
9538 | ||
9539 | You can use strings as search values. Quote them with double-quotes | |
9540 | (@code{"}). | |
9541 | The string value is copied into the search pattern byte by byte, | |
9542 | regardless of the endianness of the target and the size specification. | |
9543 | ||
9544 | The address of each match found is printed as well as a count of the | |
9545 | number of matches found. | |
9546 | ||
9547 | The address of the last value found is stored in convenience variable | |
9548 | @samp{$_}. | |
9549 | A count of the number of matches is stored in @samp{$numfound}. | |
9550 | ||
9551 | For example, if stopped at the @code{printf} in this function: | |
9552 | ||
9553 | @smallexample | |
9554 | void | |
9555 | hello () | |
9556 | @{ | |
9557 | static char hello[] = "hello-hello"; | |
9558 | static struct @{ char c; short s; int i; @} | |
9559 | __attribute__ ((packed)) mixed | |
9560 | = @{ 'c', 0x1234, 0x87654321 @}; | |
9561 | printf ("%s\n", hello); | |
9562 | @} | |
9563 | @end smallexample | |
9564 | ||
9565 | @noindent | |
9566 | you get during debugging: | |
9567 | ||
9568 | @smallexample | |
9569 | (gdb) find &hello[0], +sizeof(hello), "hello" | |
9570 | 0x804956d <hello.1620+6> | |
9571 | 1 pattern found | |
9572 | (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o' | |
9573 | 0x8049567 <hello.1620> | |
9574 | 0x804956d <hello.1620+6> | |
9575 | 2 patterns found | |
9576 | (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l' | |
9577 | 0x8049567 <hello.1620> | |
9578 | 1 pattern found | |
9579 | (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321 | |
9580 | 0x8049560 <mixed.1625> | |
9581 | 1 pattern found | |
9582 | (gdb) print $numfound | |
9583 | $1 = 1 | |
9584 | (gdb) print $_ | |
9585 | $2 = (void *) 0x8049560 | |
9586 | @end smallexample | |
a0eb71c5 | 9587 | |
edb3359d DJ |
9588 | @node Optimized Code |
9589 | @chapter Debugging Optimized Code | |
9590 | @cindex optimized code, debugging | |
9591 | @cindex debugging optimized code | |
9592 | ||
9593 | Almost all compilers support optimization. With optimization | |
9594 | disabled, the compiler generates assembly code that corresponds | |
9595 | directly to your source code, in a simplistic way. As the compiler | |
9596 | applies more powerful optimizations, the generated assembly code | |
9597 | diverges from your original source code. With help from debugging | |
9598 | information generated by the compiler, @value{GDBN} can map from | |
9599 | the running program back to constructs from your original source. | |
9600 | ||
9601 | @value{GDBN} is more accurate with optimization disabled. If you | |
9602 | can recompile without optimization, it is easier to follow the | |
9603 | progress of your program during debugging. But, there are many cases | |
9604 | where you may need to debug an optimized version. | |
9605 | ||
9606 | When you debug a program compiled with @samp{-g -O}, remember that the | |
9607 | optimizer has rearranged your code; the debugger shows you what is | |
9608 | really there. Do not be too surprised when the execution path does not | |
9609 | exactly match your source file! An extreme example: if you define a | |
9610 | variable, but never use it, @value{GDBN} never sees that | |
9611 | variable---because the compiler optimizes it out of existence. | |
9612 | ||
9613 | Some things do not work as well with @samp{-g -O} as with just | |
9614 | @samp{-g}, particularly on machines with instruction scheduling. If in | |
9615 | doubt, recompile with @samp{-g} alone, and if this fixes the problem, | |
9616 | please report it to us as a bug (including a test case!). | |
9617 | @xref{Variables}, for more information about debugging optimized code. | |
9618 | ||
9619 | @menu | |
9620 | * Inline Functions:: How @value{GDBN} presents inlining | |
111c6489 | 9621 | * Tail Call Frames:: @value{GDBN} analysis of jumps to functions |
edb3359d DJ |
9622 | @end menu |
9623 | ||
9624 | @node Inline Functions | |
9625 | @section Inline Functions | |
9626 | @cindex inline functions, debugging | |
9627 | ||
9628 | @dfn{Inlining} is an optimization that inserts a copy of the function | |
9629 | body directly at each call site, instead of jumping to a shared | |
9630 | routine. @value{GDBN} displays inlined functions just like | |
9631 | non-inlined functions. They appear in backtraces. You can view their | |
9632 | arguments and local variables, step into them with @code{step}, skip | |
9633 | them with @code{next}, and escape from them with @code{finish}. | |
9634 | You can check whether a function was inlined by using the | |
9635 | @code{info frame} command. | |
9636 | ||
9637 | For @value{GDBN} to support inlined functions, the compiler must | |
9638 | record information about inlining in the debug information --- | |
9639 | @value{NGCC} using the @sc{dwarf 2} format does this, and several | |
9640 | other compilers do also. @value{GDBN} only supports inlined functions | |
9641 | when using @sc{dwarf 2}. Versions of @value{NGCC} before 4.1 | |
9642 | do not emit two required attributes (@samp{DW_AT_call_file} and | |
9643 | @samp{DW_AT_call_line}); @value{GDBN} does not display inlined | |
9644 | function calls with earlier versions of @value{NGCC}. It instead | |
9645 | displays the arguments and local variables of inlined functions as | |
9646 | local variables in the caller. | |
9647 | ||
9648 | The body of an inlined function is directly included at its call site; | |
9649 | unlike a non-inlined function, there are no instructions devoted to | |
9650 | the call. @value{GDBN} still pretends that the call site and the | |
9651 | start of the inlined function are different instructions. Stepping to | |
9652 | the call site shows the call site, and then stepping again shows | |
9653 | the first line of the inlined function, even though no additional | |
9654 | instructions are executed. | |
9655 | ||
9656 | This makes source-level debugging much clearer; you can see both the | |
9657 | context of the call and then the effect of the call. Only stepping by | |
9658 | a single instruction using @code{stepi} or @code{nexti} does not do | |
9659 | this; single instruction steps always show the inlined body. | |
9660 | ||
9661 | There are some ways that @value{GDBN} does not pretend that inlined | |
9662 | function calls are the same as normal calls: | |
9663 | ||
9664 | @itemize @bullet | |
9665 | @item | |
9666 | You cannot set breakpoints on inlined functions. @value{GDBN} | |
9667 | either reports that there is no symbol with that name, or else sets the | |
9668 | breakpoint only on non-inlined copies of the function. This limitation | |
9669 | will be removed in a future version of @value{GDBN}; until then, | |
9670 | set a breakpoint by line number on the first line of the inlined | |
9671 | function instead. | |
9672 | ||
9673 | @item | |
9674 | Setting breakpoints at the call site of an inlined function may not | |
9675 | work, because the call site does not contain any code. @value{GDBN} | |
9676 | may incorrectly move the breakpoint to the next line of the enclosing | |
9677 | function, after the call. This limitation will be removed in a future | |
9678 | version of @value{GDBN}; until then, set a breakpoint on an earlier line | |
9679 | or inside the inlined function instead. | |
9680 | ||
9681 | @item | |
9682 | @value{GDBN} cannot locate the return value of inlined calls after | |
9683 | using the @code{finish} command. This is a limitation of compiler-generated | |
9684 | debugging information; after @code{finish}, you can step to the next line | |
9685 | and print a variable where your program stored the return value. | |
9686 | ||
9687 | @end itemize | |
9688 | ||
111c6489 JK |
9689 | @node Tail Call Frames |
9690 | @section Tail Call Frames | |
9691 | @cindex tail call frames, debugging | |
9692 | ||
9693 | Function @code{B} can call function @code{C} in its very last statement. In | |
9694 | unoptimized compilation the call of @code{C} is immediately followed by return | |
9695 | instruction at the end of @code{B} code. Optimizing compiler may replace the | |
9696 | call and return in function @code{B} into one jump to function @code{C} | |
9697 | instead. Such use of a jump instruction is called @dfn{tail call}. | |
9698 | ||
9699 | During execution of function @code{C}, there will be no indication in the | |
9700 | function call stack frames that it was tail-called from @code{B}. If function | |
9701 | @code{A} regularly calls function @code{B} which tail-calls function @code{C}, | |
9702 | then @value{GDBN} will see @code{A} as the caller of @code{C}. However, in | |
9703 | some cases @value{GDBN} can determine that @code{C} was tail-called from | |
9704 | @code{B}, and it will then create fictitious call frame for that, with the | |
9705 | return address set up as if @code{B} called @code{C} normally. | |
9706 | ||
9707 | This functionality is currently supported only by DWARF 2 debugging format and | |
9708 | the compiler has to produce @samp{DW_TAG_GNU_call_site} tags. With | |
9709 | @value{NGCC}, you need to specify @option{-O -g} during compilation, to get | |
9710 | this information. | |
9711 | ||
9712 | @kbd{info frame} command (@pxref{Frame Info}) will indicate the tail call frame | |
9713 | kind by text @code{tail call frame} such as in this sample @value{GDBN} output: | |
9714 | ||
9715 | @smallexample | |
9716 | (gdb) x/i $pc - 2 | |
9717 | 0x40066b <b(int, double)+11>: jmp 0x400640 <c(int, double)> | |
9718 | (gdb) info frame | |
9719 | Stack level 1, frame at 0x7fffffffda30: | |
9720 | rip = 0x40066d in b (amd64-entry-value.cc:59); saved rip 0x4004c5 | |
9721 | tail call frame, caller of frame at 0x7fffffffda30 | |
9722 | source language c++. | |
9723 | Arglist at unknown address. | |
9724 | Locals at unknown address, Previous frame's sp is 0x7fffffffda30 | |
9725 | @end smallexample | |
9726 | ||
9727 | The detection of all the possible code path executions can find them ambiguous. | |
9728 | There is no execution history stored (possible @ref{Reverse Execution} is never | |
9729 | used for this purpose) and the last known caller could have reached the known | |
9730 | callee by multiple different jump sequences. In such case @value{GDBN} still | |
9731 | tries to show at least all the unambiguous top tail callers and all the | |
9732 | unambiguous bottom tail calees, if any. | |
9733 | ||
9734 | @table @code | |
e18b2753 | 9735 | @anchor{set debug entry-values} |
111c6489 JK |
9736 | @item set debug entry-values |
9737 | @kindex set debug entry-values | |
9738 | When set to on, enables printing of analysis messages for both frame argument | |
9739 | values at function entry and tail calls. It will show all the possible valid | |
9740 | tail calls code paths it has considered. It will also print the intersection | |
9741 | of them with the final unambiguous (possibly partial or even empty) code path | |
9742 | result. | |
9743 | ||
9744 | @item show debug entry-values | |
9745 | @kindex show debug entry-values | |
9746 | Show the current state of analysis messages printing for both frame argument | |
9747 | values at function entry and tail calls. | |
9748 | @end table | |
9749 | ||
9750 | The analysis messages for tail calls can for example show why the virtual tail | |
9751 | call frame for function @code{c} has not been recognized (due to the indirect | |
9752 | reference by variable @code{x}): | |
9753 | ||
9754 | @smallexample | |
9755 | static void __attribute__((noinline, noclone)) c (void); | |
9756 | void (*x) (void) = c; | |
9757 | static void __attribute__((noinline, noclone)) a (void) @{ x++; @} | |
9758 | static void __attribute__((noinline, noclone)) c (void) @{ a (); @} | |
9759 | int main (void) @{ x (); return 0; @} | |
9760 | ||
9761 | Breakpoint 1, DW_OP_GNU_entry_value resolving cannot find | |
9762 | DW_TAG_GNU_call_site 0x40039a in main | |
9763 | a () at t.c:3 | |
9764 | 3 static void __attribute__((noinline, noclone)) a (void) @{ x++; @} | |
9765 | (gdb) bt | |
9766 | #0 a () at t.c:3 | |
9767 | #1 0x000000000040039a in main () at t.c:5 | |
9768 | @end smallexample | |
9769 | ||
9770 | Another possibility is an ambiguous virtual tail call frames resolution: | |
9771 | ||
9772 | @smallexample | |
9773 | int i; | |
9774 | static void __attribute__((noinline, noclone)) f (void) @{ i++; @} | |
9775 | static void __attribute__((noinline, noclone)) e (void) @{ f (); @} | |
9776 | static void __attribute__((noinline, noclone)) d (void) @{ f (); @} | |
9777 | static void __attribute__((noinline, noclone)) c (void) @{ d (); @} | |
9778 | static void __attribute__((noinline, noclone)) b (void) | |
9779 | @{ if (i) c (); else e (); @} | |
9780 | static void __attribute__((noinline, noclone)) a (void) @{ b (); @} | |
9781 | int main (void) @{ a (); return 0; @} | |
9782 | ||
9783 | tailcall: initial: 0x4004d2(a) 0x4004ce(b) 0x4004b2(c) 0x4004a2(d) | |
9784 | tailcall: compare: 0x4004d2(a) 0x4004cc(b) 0x400492(e) | |
9785 | tailcall: reduced: 0x4004d2(a) | | |
9786 | (gdb) bt | |
9787 | #0 f () at t.c:2 | |
9788 | #1 0x00000000004004d2 in a () at t.c:8 | |
9789 | #2 0x0000000000400395 in main () at t.c:9 | |
9790 | @end smallexample | |
9791 | ||
5048e516 JK |
9792 | @set CALLSEQ1A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}c@value{ARROW}d@value{ARROW}f} |
9793 | @set CALLSEQ2A @code{main@value{ARROW}a@value{ARROW}b@value{ARROW}e@value{ARROW}f} | |
9794 | ||
9795 | @c Convert CALLSEQ#A to CALLSEQ#B depending on HAVE_MAKEINFO_CLICK. | |
9796 | @ifset HAVE_MAKEINFO_CLICK | |
9797 | @set ARROW @click{} | |
9798 | @set CALLSEQ1B @clicksequence{@value{CALLSEQ1A}} | |
9799 | @set CALLSEQ2B @clicksequence{@value{CALLSEQ2A}} | |
9800 | @end ifset | |
9801 | @ifclear HAVE_MAKEINFO_CLICK | |
9802 | @set ARROW -> | |
9803 | @set CALLSEQ1B @value{CALLSEQ1A} | |
9804 | @set CALLSEQ2B @value{CALLSEQ2A} | |
9805 | @end ifclear | |
9806 | ||
9807 | Frames #0 and #2 are real, #1 is a virtual tail call frame. | |
9808 | The code can have possible execution paths @value{CALLSEQ1B} or | |
9809 | @value{CALLSEQ2B}, @value{GDBN} cannot find which one from the inferior state. | |
111c6489 JK |
9810 | |
9811 | @code{initial:} state shows some random possible calling sequence @value{GDBN} | |
9812 | has found. It then finds another possible calling sequcen - that one is | |
9813 | prefixed by @code{compare:}. The non-ambiguous intersection of these two is | |
9814 | printed as the @code{reduced:} calling sequence. That one could have many | |
9815 | futher @code{compare:} and @code{reduced:} statements as long as there remain | |
9816 | any non-ambiguous sequence entries. | |
9817 | ||
9818 | For the frame of function @code{b} in both cases there are different possible | |
9819 | @code{$pc} values (@code{0x4004cc} or @code{0x4004ce}), therefore this frame is | |
9820 | also ambigous. The only non-ambiguous frame is the one for function @code{a}, | |
9821 | therefore this one is displayed to the user while the ambiguous frames are | |
9822 | omitted. | |
edb3359d | 9823 | |
e18b2753 JK |
9824 | There can be also reasons why printing of frame argument values at function |
9825 | entry may fail: | |
9826 | ||
9827 | @smallexample | |
9828 | int v; | |
9829 | static void __attribute__((noinline, noclone)) c (int i) @{ v++; @} | |
9830 | static void __attribute__((noinline, noclone)) a (int i); | |
9831 | static void __attribute__((noinline, noclone)) b (int i) @{ a (i); @} | |
9832 | static void __attribute__((noinline, noclone)) a (int i) | |
9833 | @{ if (i) b (i - 1); else c (0); @} | |
9834 | int main (void) @{ a (5); return 0; @} | |
9835 | ||
9836 | (gdb) bt | |
9837 | #0 c (i=i@@entry=0) at t.c:2 | |
9838 | #1 0x0000000000400428 in a (DW_OP_GNU_entry_value resolving has found | |
9839 | function "a" at 0x400420 can call itself via tail calls | |
9840 | i=<optimized out>) at t.c:6 | |
9841 | #2 0x000000000040036e in main () at t.c:7 | |
9842 | @end smallexample | |
9843 | ||
9844 | @value{GDBN} cannot find out from the inferior state if and how many times did | |
9845 | function @code{a} call itself (via function @code{b}) as these calls would be | |
9846 | tail calls. Such tail calls would modify thue @code{i} variable, therefore | |
9847 | @value{GDBN} cannot be sure the value it knows would be right - @value{GDBN} | |
9848 | prints @code{<optimized out>} instead. | |
9849 | ||
e2e0bcd1 JB |
9850 | @node Macros |
9851 | @chapter C Preprocessor Macros | |
9852 | ||
49efadf5 | 9853 | Some languages, such as C and C@t{++}, provide a way to define and invoke |
e2e0bcd1 JB |
9854 | ``preprocessor macros'' which expand into strings of tokens. |
9855 | @value{GDBN} can evaluate expressions containing macro invocations, show | |
9856 | the result of macro expansion, and show a macro's definition, including | |
9857 | where it was defined. | |
9858 | ||
9859 | You may need to compile your program specially to provide @value{GDBN} | |
9860 | with information about preprocessor macros. Most compilers do not | |
9861 | include macros in their debugging information, even when you compile | |
9862 | with the @option{-g} flag. @xref{Compilation}. | |
9863 | ||
9864 | A program may define a macro at one point, remove that definition later, | |
9865 | and then provide a different definition after that. Thus, at different | |
9866 | points in the program, a macro may have different definitions, or have | |
9867 | no definition at all. If there is a current stack frame, @value{GDBN} | |
9868 | uses the macros in scope at that frame's source code line. Otherwise, | |
9869 | @value{GDBN} uses the macros in scope at the current listing location; | |
9870 | see @ref{List}. | |
9871 | ||
e2e0bcd1 JB |
9872 | Whenever @value{GDBN} evaluates an expression, it always expands any |
9873 | macro invocations present in the expression. @value{GDBN} also provides | |
9874 | the following commands for working with macros explicitly. | |
9875 | ||
9876 | @table @code | |
9877 | ||
9878 | @kindex macro expand | |
9879 | @cindex macro expansion, showing the results of preprocessor | |
9880 | @cindex preprocessor macro expansion, showing the results of | |
9881 | @cindex expanding preprocessor macros | |
9882 | @item macro expand @var{expression} | |
9883 | @itemx macro exp @var{expression} | |
9884 | Show the results of expanding all preprocessor macro invocations in | |
9885 | @var{expression}. Since @value{GDBN} simply expands macros, but does | |
9886 | not parse the result, @var{expression} need not be a valid expression; | |
9887 | it can be any string of tokens. | |
9888 | ||
09d4efe1 | 9889 | @kindex macro exp1 |
e2e0bcd1 JB |
9890 | @item macro expand-once @var{expression} |
9891 | @itemx macro exp1 @var{expression} | |
4644b6e3 | 9892 | @cindex expand macro once |
e2e0bcd1 JB |
9893 | @i{(This command is not yet implemented.)} Show the results of |
9894 | expanding those preprocessor macro invocations that appear explicitly in | |
9895 | @var{expression}. Macro invocations appearing in that expansion are | |
9896 | left unchanged. This command allows you to see the effect of a | |
9897 | particular macro more clearly, without being confused by further | |
9898 | expansions. Since @value{GDBN} simply expands macros, but does not | |
9899 | parse the result, @var{expression} need not be a valid expression; it | |
9900 | can be any string of tokens. | |
9901 | ||
475b0867 | 9902 | @kindex info macro |
e2e0bcd1 | 9903 | @cindex macro definition, showing |
9b158ba0 | 9904 | @cindex definition of a macro, showing |
9905 | @cindex macros, from debug info | |
475b0867 | 9906 | @item info macro @var{macro} |
9b158ba0 | 9907 | Show the current definition of the named @var{macro}, and describe the |
484086b7 | 9908 | source location or compiler command-line where that definition was established. |
e2e0bcd1 | 9909 | |
9b158ba0 | 9910 | @kindex info macros |
9911 | @item info macros @var{linespec} | |
9912 | Show all macro definitions that are in effect at the location specified | |
9913 | by @var{linespec}, and describe the source location or compiler | |
9914 | command-line where those definitions were established. | |
9915 | ||
9916 | @kindex info definitions | |
9917 | @item info definitions @var{macro} | |
9918 | Show all definitions of the named @var{macro} that are defined in the current | |
9919 | compilation unit, and describe the source location or compiler command-line | |
9920 | where those definitions were established. | |
9921 | ||
e2e0bcd1 JB |
9922 | @kindex macro define |
9923 | @cindex user-defined macros | |
9924 | @cindex defining macros interactively | |
9925 | @cindex macros, user-defined | |
9926 | @item macro define @var{macro} @var{replacement-list} | |
9927 | @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list} | |
d7d9f01e TT |
9928 | Introduce a definition for a preprocessor macro named @var{macro}, |
9929 | invocations of which are replaced by the tokens given in | |
9930 | @var{replacement-list}. The first form of this command defines an | |
9931 | ``object-like'' macro, which takes no arguments; the second form | |
9932 | defines a ``function-like'' macro, which takes the arguments given in | |
9933 | @var{arglist}. | |
9934 | ||
9935 | A definition introduced by this command is in scope in every | |
9936 | expression evaluated in @value{GDBN}, until it is removed with the | |
9937 | @code{macro undef} command, described below. The definition overrides | |
9938 | all definitions for @var{macro} present in the program being debugged, | |
9939 | as well as any previous user-supplied definition. | |
e2e0bcd1 JB |
9940 | |
9941 | @kindex macro undef | |
9942 | @item macro undef @var{macro} | |
d7d9f01e TT |
9943 | Remove any user-supplied definition for the macro named @var{macro}. |
9944 | This command only affects definitions provided with the @code{macro | |
9945 | define} command, described above; it cannot remove definitions present | |
9946 | in the program being debugged. | |
e2e0bcd1 | 9947 | |
09d4efe1 EZ |
9948 | @kindex macro list |
9949 | @item macro list | |
d7d9f01e | 9950 | List all the macros defined using the @code{macro define} command. |
e2e0bcd1 JB |
9951 | @end table |
9952 | ||
9953 | @cindex macros, example of debugging with | |
9954 | Here is a transcript showing the above commands in action. First, we | |
9955 | show our source files: | |
9956 | ||
9957 | @smallexample | |
9958 | $ cat sample.c | |
9959 | #include <stdio.h> | |
9960 | #include "sample.h" | |
9961 | ||
9962 | #define M 42 | |
9963 | #define ADD(x) (M + x) | |
9964 | ||
9965 | main () | |
9966 | @{ | |
9967 | #define N 28 | |
9968 | printf ("Hello, world!\n"); | |
9969 | #undef N | |
9970 | printf ("We're so creative.\n"); | |
9971 | #define N 1729 | |
9972 | printf ("Goodbye, world!\n"); | |
9973 | @} | |
9974 | $ cat sample.h | |
9975 | #define Q < | |
9976 | $ | |
9977 | @end smallexample | |
9978 | ||
9979 | Now, we compile the program using the @sc{gnu} C compiler, @value{NGCC}. | |
9980 | We pass the @option{-gdwarf-2} and @option{-g3} flags to ensure the | |
9981 | compiler includes information about preprocessor macros in the debugging | |
9982 | information. | |
9983 | ||
9984 | @smallexample | |
9985 | $ gcc -gdwarf-2 -g3 sample.c -o sample | |
9986 | $ | |
9987 | @end smallexample | |
9988 | ||
9989 | Now, we start @value{GDBN} on our sample program: | |
9990 | ||
9991 | @smallexample | |
9992 | $ gdb -nw sample | |
9993 | GNU gdb 2002-05-06-cvs | |
9994 | Copyright 2002 Free Software Foundation, Inc. | |
9995 | GDB is free software, @dots{} | |
f7dc1244 | 9996 | (@value{GDBP}) |
e2e0bcd1 JB |
9997 | @end smallexample |
9998 | ||
9999 | We can expand macros and examine their definitions, even when the | |
10000 | program is not running. @value{GDBN} uses the current listing position | |
10001 | to decide which macro definitions are in scope: | |
10002 | ||
10003 | @smallexample | |
f7dc1244 | 10004 | (@value{GDBP}) list main |
e2e0bcd1 JB |
10005 | 3 |
10006 | 4 #define M 42 | |
10007 | 5 #define ADD(x) (M + x) | |
10008 | 6 | |
10009 | 7 main () | |
10010 | 8 @{ | |
10011 | 9 #define N 28 | |
10012 | 10 printf ("Hello, world!\n"); | |
10013 | 11 #undef N | |
10014 | 12 printf ("We're so creative.\n"); | |
f7dc1244 | 10015 | (@value{GDBP}) info macro ADD |
e2e0bcd1 JB |
10016 | Defined at /home/jimb/gdb/macros/play/sample.c:5 |
10017 | #define ADD(x) (M + x) | |
f7dc1244 | 10018 | (@value{GDBP}) info macro Q |
e2e0bcd1 JB |
10019 | Defined at /home/jimb/gdb/macros/play/sample.h:1 |
10020 | included at /home/jimb/gdb/macros/play/sample.c:2 | |
10021 | #define Q < | |
f7dc1244 | 10022 | (@value{GDBP}) macro expand ADD(1) |
e2e0bcd1 | 10023 | expands to: (42 + 1) |
f7dc1244 | 10024 | (@value{GDBP}) macro expand-once ADD(1) |
e2e0bcd1 | 10025 | expands to: once (M + 1) |
f7dc1244 | 10026 | (@value{GDBP}) |
e2e0bcd1 JB |
10027 | @end smallexample |
10028 | ||
d7d9f01e | 10029 | In the example above, note that @code{macro expand-once} expands only |
e2e0bcd1 JB |
10030 | the macro invocation explicit in the original text --- the invocation of |
10031 | @code{ADD} --- but does not expand the invocation of the macro @code{M}, | |
10032 | which was introduced by @code{ADD}. | |
10033 | ||
3f94c067 BW |
10034 | Once the program is running, @value{GDBN} uses the macro definitions in |
10035 | force at the source line of the current stack frame: | |
e2e0bcd1 JB |
10036 | |
10037 | @smallexample | |
f7dc1244 | 10038 | (@value{GDBP}) break main |
e2e0bcd1 | 10039 | Breakpoint 1 at 0x8048370: file sample.c, line 10. |
f7dc1244 | 10040 | (@value{GDBP}) run |
b383017d | 10041 | Starting program: /home/jimb/gdb/macros/play/sample |
e2e0bcd1 JB |
10042 | |
10043 | Breakpoint 1, main () at sample.c:10 | |
10044 | 10 printf ("Hello, world!\n"); | |
f7dc1244 | 10045 | (@value{GDBP}) |
e2e0bcd1 JB |
10046 | @end smallexample |
10047 | ||
10048 | At line 10, the definition of the macro @code{N} at line 9 is in force: | |
10049 | ||
10050 | @smallexample | |
f7dc1244 | 10051 | (@value{GDBP}) info macro N |
e2e0bcd1 JB |
10052 | Defined at /home/jimb/gdb/macros/play/sample.c:9 |
10053 | #define N 28 | |
f7dc1244 | 10054 | (@value{GDBP}) macro expand N Q M |
e2e0bcd1 | 10055 | expands to: 28 < 42 |
f7dc1244 | 10056 | (@value{GDBP}) print N Q M |
e2e0bcd1 | 10057 | $1 = 1 |
f7dc1244 | 10058 | (@value{GDBP}) |
e2e0bcd1 JB |
10059 | @end smallexample |
10060 | ||
10061 | As we step over directives that remove @code{N}'s definition, and then | |
10062 | give it a new definition, @value{GDBN} finds the definition (or lack | |
10063 | thereof) in force at each point: | |
10064 | ||
10065 | @smallexample | |
f7dc1244 | 10066 | (@value{GDBP}) next |
e2e0bcd1 JB |
10067 | Hello, world! |
10068 | 12 printf ("We're so creative.\n"); | |
f7dc1244 | 10069 | (@value{GDBP}) info macro N |
e2e0bcd1 JB |
10070 | The symbol `N' has no definition as a C/C++ preprocessor macro |
10071 | at /home/jimb/gdb/macros/play/sample.c:12 | |
f7dc1244 | 10072 | (@value{GDBP}) next |
e2e0bcd1 JB |
10073 | We're so creative. |
10074 | 14 printf ("Goodbye, world!\n"); | |
f7dc1244 | 10075 | (@value{GDBP}) info macro N |
e2e0bcd1 JB |
10076 | Defined at /home/jimb/gdb/macros/play/sample.c:13 |
10077 | #define N 1729 | |
f7dc1244 | 10078 | (@value{GDBP}) macro expand N Q M |
e2e0bcd1 | 10079 | expands to: 1729 < 42 |
f7dc1244 | 10080 | (@value{GDBP}) print N Q M |
e2e0bcd1 | 10081 | $2 = 0 |
f7dc1244 | 10082 | (@value{GDBP}) |
e2e0bcd1 JB |
10083 | @end smallexample |
10084 | ||
484086b7 JK |
10085 | In addition to source files, macros can be defined on the compilation command |
10086 | line using the @option{-D@var{name}=@var{value}} syntax. For macros defined in | |
10087 | such a way, @value{GDBN} displays the location of their definition as line zero | |
10088 | of the source file submitted to the compiler. | |
10089 | ||
10090 | @smallexample | |
10091 | (@value{GDBP}) info macro __STDC__ | |
10092 | Defined at /home/jimb/gdb/macros/play/sample.c:0 | |
10093 | -D__STDC__=1 | |
10094 | (@value{GDBP}) | |
10095 | @end smallexample | |
10096 | ||
e2e0bcd1 | 10097 | |
b37052ae EZ |
10098 | @node Tracepoints |
10099 | @chapter Tracepoints | |
10100 | @c This chapter is based on the documentation written by Michael | |
10101 | @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni. | |
10102 | ||
10103 | @cindex tracepoints | |
10104 | In some applications, it is not feasible for the debugger to interrupt | |
10105 | the program's execution long enough for the developer to learn | |
10106 | anything helpful about its behavior. If the program's correctness | |
10107 | depends on its real-time behavior, delays introduced by a debugger | |
10108 | might cause the program to change its behavior drastically, or perhaps | |
10109 | fail, even when the code itself is correct. It is useful to be able | |
10110 | to observe the program's behavior without interrupting it. | |
10111 | ||
10112 | Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can | |
10113 | specify locations in the program, called @dfn{tracepoints}, and | |
10114 | arbitrary expressions to evaluate when those tracepoints are reached. | |
10115 | Later, using the @code{tfind} command, you can examine the values | |
10116 | those expressions had when the program hit the tracepoints. The | |
10117 | expressions may also denote objects in memory---structures or arrays, | |
10118 | for example---whose values @value{GDBN} should record; while visiting | |
10119 | a particular tracepoint, you may inspect those objects as if they were | |
10120 | in memory at that moment. However, because @value{GDBN} records these | |
10121 | values without interacting with you, it can do so quickly and | |
10122 | unobtrusively, hopefully not disturbing the program's behavior. | |
10123 | ||
10124 | The tracepoint facility is currently available only for remote | |
9d29849a JB |
10125 | targets. @xref{Targets}. In addition, your remote target must know |
10126 | how to collect trace data. This functionality is implemented in the | |
10127 | remote stub; however, none of the stubs distributed with @value{GDBN} | |
10128 | support tracepoints as of this writing. The format of the remote | |
10129 | packets used to implement tracepoints are described in @ref{Tracepoint | |
10130 | Packets}. | |
b37052ae | 10131 | |
00bf0b85 SS |
10132 | It is also possible to get trace data from a file, in a manner reminiscent |
10133 | of corefiles; you specify the filename, and use @code{tfind} to search | |
10134 | through the file. @xref{Trace Files}, for more details. | |
10135 | ||
b37052ae EZ |
10136 | This chapter describes the tracepoint commands and features. |
10137 | ||
10138 | @menu | |
b383017d RM |
10139 | * Set Tracepoints:: |
10140 | * Analyze Collected Data:: | |
10141 | * Tracepoint Variables:: | |
00bf0b85 | 10142 | * Trace Files:: |
b37052ae EZ |
10143 | @end menu |
10144 | ||
10145 | @node Set Tracepoints | |
10146 | @section Commands to Set Tracepoints | |
10147 | ||
10148 | Before running such a @dfn{trace experiment}, an arbitrary number of | |
1042e4c0 SS |
10149 | tracepoints can be set. A tracepoint is actually a special type of |
10150 | breakpoint (@pxref{Set Breaks}), so you can manipulate it using | |
10151 | standard breakpoint commands. For instance, as with breakpoints, | |
10152 | tracepoint numbers are successive integers starting from one, and many | |
10153 | of the commands associated with tracepoints take the tracepoint number | |
10154 | as their argument, to identify which tracepoint to work on. | |
b37052ae EZ |
10155 | |
10156 | For each tracepoint, you can specify, in advance, some arbitrary set | |
10157 | of data that you want the target to collect in the trace buffer when | |
10158 | it hits that tracepoint. The collected data can include registers, | |
10159 | local variables, or global data. Later, you can use @value{GDBN} | |
10160 | commands to examine the values these data had at the time the | |
10161 | tracepoint was hit. | |
10162 | ||
7d13fe92 SS |
10163 | Tracepoints do not support every breakpoint feature. Ignore counts on |
10164 | tracepoints have no effect, and tracepoints cannot run @value{GDBN} | |
10165 | commands when they are hit. Tracepoints may not be thread-specific | |
10166 | either. | |
1042e4c0 | 10167 | |
7a697b8d SS |
10168 | @cindex fast tracepoints |
10169 | Some targets may support @dfn{fast tracepoints}, which are inserted in | |
10170 | a different way (such as with a jump instead of a trap), that is | |
10171 | faster but possibly restricted in where they may be installed. | |
10172 | ||
0fb4aa4b PA |
10173 | @cindex static tracepoints |
10174 | @cindex markers, static tracepoints | |
10175 | @cindex probing markers, static tracepoints | |
10176 | Regular and fast tracepoints are dynamic tracing facilities, meaning | |
10177 | that they can be used to insert tracepoints at (almost) any location | |
10178 | in the target. Some targets may also support controlling @dfn{static | |
10179 | tracepoints} from @value{GDBN}. With static tracing, a set of | |
10180 | instrumentation points, also known as @dfn{markers}, are embedded in | |
10181 | the target program, and can be activated or deactivated by name or | |
10182 | address. These are usually placed at locations which facilitate | |
10183 | investigating what the target is actually doing. @value{GDBN}'s | |
10184 | support for static tracing includes being able to list instrumentation | |
10185 | points, and attach them with @value{GDBN} defined high level | |
10186 | tracepoints that expose the whole range of convenience of | |
8786b2bd | 10187 | @value{GDBN}'s tracepoints support. Namely, support for collecting |
0fb4aa4b PA |
10188 | registers values and values of global or local (to the instrumentation |
10189 | point) variables; tracepoint conditions and trace state variables. | |
10190 | The act of installing a @value{GDBN} static tracepoint on an | |
10191 | instrumentation point, or marker, is referred to as @dfn{probing} a | |
10192 | static tracepoint marker. | |
10193 | ||
fa593d66 PA |
10194 | @code{gdbserver} supports tracepoints on some target systems. |
10195 | @xref{Server,,Tracepoints support in @code{gdbserver}}. | |
10196 | ||
b37052ae EZ |
10197 | This section describes commands to set tracepoints and associated |
10198 | conditions and actions. | |
10199 | ||
10200 | @menu | |
b383017d RM |
10201 | * Create and Delete Tracepoints:: |
10202 | * Enable and Disable Tracepoints:: | |
10203 | * Tracepoint Passcounts:: | |
782b2b07 | 10204 | * Tracepoint Conditions:: |
f61e138d | 10205 | * Trace State Variables:: |
b383017d RM |
10206 | * Tracepoint Actions:: |
10207 | * Listing Tracepoints:: | |
0fb4aa4b | 10208 | * Listing Static Tracepoint Markers:: |
79a6e687 | 10209 | * Starting and Stopping Trace Experiments:: |
c9429232 | 10210 | * Tracepoint Restrictions:: |
b37052ae EZ |
10211 | @end menu |
10212 | ||
10213 | @node Create and Delete Tracepoints | |
10214 | @subsection Create and Delete Tracepoints | |
10215 | ||
10216 | @table @code | |
10217 | @cindex set tracepoint | |
10218 | @kindex trace | |
1042e4c0 | 10219 | @item trace @var{location} |
b37052ae | 10220 | The @code{trace} command is very similar to the @code{break} command. |
1042e4c0 SS |
10221 | Its argument @var{location} can be a source line, a function name, or |
10222 | an address in the target program. @xref{Specify Location}. The | |
10223 | @code{trace} command defines a tracepoint, which is a point in the | |
10224 | target program where the debugger will briefly stop, collect some | |
10225 | data, and then allow the program to continue. Setting a tracepoint or | |
10226 | changing its actions doesn't take effect until the next @code{tstart} | |
10227 | command, and once a trace experiment is running, further changes will | |
10228 | not have any effect until the next trace experiment starts. | |
b37052ae EZ |
10229 | |
10230 | Here are some examples of using the @code{trace} command: | |
10231 | ||
10232 | @smallexample | |
10233 | (@value{GDBP}) @b{trace foo.c:121} // a source file and line number | |
10234 | ||
10235 | (@value{GDBP}) @b{trace +2} // 2 lines forward | |
10236 | ||
10237 | (@value{GDBP}) @b{trace my_function} // first source line of function | |
10238 | ||
10239 | (@value{GDBP}) @b{trace *my_function} // EXACT start address of function | |
10240 | ||
10241 | (@value{GDBP}) @b{trace *0x2117c4} // an address | |
10242 | @end smallexample | |
10243 | ||
10244 | @noindent | |
10245 | You can abbreviate @code{trace} as @code{tr}. | |
10246 | ||
782b2b07 SS |
10247 | @item trace @var{location} if @var{cond} |
10248 | Set a tracepoint with condition @var{cond}; evaluate the expression | |
10249 | @var{cond} each time the tracepoint is reached, and collect data only | |
10250 | if the value is nonzero---that is, if @var{cond} evaluates as true. | |
10251 | @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more | |
10252 | information on tracepoint conditions. | |
10253 | ||
7a697b8d SS |
10254 | @item ftrace @var{location} [ if @var{cond} ] |
10255 | @cindex set fast tracepoint | |
74c761c1 | 10256 | @cindex fast tracepoints, setting |
7a697b8d SS |
10257 | @kindex ftrace |
10258 | The @code{ftrace} command sets a fast tracepoint. For targets that | |
10259 | support them, fast tracepoints will use a more efficient but possibly | |
10260 | less general technique to trigger data collection, such as a jump | |
10261 | instruction instead of a trap, or some sort of hardware support. It | |
10262 | may not be possible to create a fast tracepoint at the desired | |
10263 | location, in which case the command will exit with an explanatory | |
10264 | message. | |
10265 | ||
10266 | @value{GDBN} handles arguments to @code{ftrace} exactly as for | |
10267 | @code{trace}. | |
10268 | ||
0fb4aa4b | 10269 | @item strace @var{location} [ if @var{cond} ] |
74c761c1 PA |
10270 | @cindex set static tracepoint |
10271 | @cindex static tracepoints, setting | |
10272 | @cindex probe static tracepoint marker | |
0fb4aa4b PA |
10273 | @kindex strace |
10274 | The @code{strace} command sets a static tracepoint. For targets that | |
10275 | support it, setting a static tracepoint probes a static | |
10276 | instrumentation point, or marker, found at @var{location}. It may not | |
10277 | be possible to set a static tracepoint at the desired location, in | |
10278 | which case the command will exit with an explanatory message. | |
10279 | ||
10280 | @value{GDBN} handles arguments to @code{strace} exactly as for | |
10281 | @code{trace}, with the addition that the user can also specify | |
10282 | @code{-m @var{marker}} as @var{location}. This probes the marker | |
10283 | identified by the @var{marker} string identifier. This identifier | |
10284 | depends on the static tracepoint backend library your program is | |
10285 | using. You can find all the marker identifiers in the @samp{ID} field | |
10286 | of the @code{info static-tracepoint-markers} command output. | |
10287 | @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint | |
10288 | Markers}. For example, in the following small program using the UST | |
10289 | tracing engine: | |
10290 | ||
10291 | @smallexample | |
10292 | main () | |
10293 | @{ | |
10294 | trace_mark(ust, bar33, "str %s", "FOOBAZ"); | |
10295 | @} | |
10296 | @end smallexample | |
10297 | ||
10298 | @noindent | |
10299 | the marker id is composed of joining the first two arguments to the | |
10300 | @code{trace_mark} call with a slash, which translates to: | |
10301 | ||
10302 | @smallexample | |
10303 | (@value{GDBP}) info static-tracepoint-markers | |
10304 | Cnt Enb ID Address What | |
10305 | 1 n ust/bar33 0x0000000000400ddc in main at stexample.c:22 | |
10306 | Data: "str %s" | |
10307 | [etc...] | |
10308 | @end smallexample | |
10309 | ||
10310 | @noindent | |
10311 | so you may probe the marker above with: | |
10312 | ||
10313 | @smallexample | |
10314 | (@value{GDBP}) strace -m ust/bar33 | |
10315 | @end smallexample | |
10316 | ||
10317 | Static tracepoints accept an extra collect action --- @code{collect | |
10318 | $_sdata}. This collects arbitrary user data passed in the probe point | |
10319 | call to the tracing library. In the UST example above, you'll see | |
10320 | that the third argument to @code{trace_mark} is a printf-like format | |
10321 | string. The user data is then the result of running that formating | |
10322 | string against the following arguments. Note that @code{info | |
10323 | static-tracepoint-markers} command output lists that format string in | |
10324 | the @samp{Data:} field. | |
10325 | ||
10326 | You can inspect this data when analyzing the trace buffer, by printing | |
10327 | the $_sdata variable like any other variable available to | |
10328 | @value{GDBN}. @xref{Tracepoint Actions,,Tracepoint Action Lists}. | |
10329 | ||
b37052ae EZ |
10330 | @vindex $tpnum |
10331 | @cindex last tracepoint number | |
10332 | @cindex recent tracepoint number | |
10333 | @cindex tracepoint number | |
10334 | The convenience variable @code{$tpnum} records the tracepoint number | |
10335 | of the most recently set tracepoint. | |
10336 | ||
10337 | @kindex delete tracepoint | |
10338 | @cindex tracepoint deletion | |
10339 | @item delete tracepoint @r{[}@var{num}@r{]} | |
10340 | Permanently delete one or more tracepoints. With no argument, the | |
1042e4c0 SS |
10341 | default is to delete all tracepoints. Note that the regular |
10342 | @code{delete} command can remove tracepoints also. | |
b37052ae EZ |
10343 | |
10344 | Examples: | |
10345 | ||
10346 | @smallexample | |
10347 | (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints | |
10348 | ||
10349 | (@value{GDBP}) @b{delete trace} // remove all tracepoints | |
10350 | @end smallexample | |
10351 | ||
10352 | @noindent | |
10353 | You can abbreviate this command as @code{del tr}. | |
10354 | @end table | |
10355 | ||
10356 | @node Enable and Disable Tracepoints | |
10357 | @subsection Enable and Disable Tracepoints | |
10358 | ||
1042e4c0 SS |
10359 | These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}. |
10360 | ||
b37052ae EZ |
10361 | @table @code |
10362 | @kindex disable tracepoint | |
10363 | @item disable tracepoint @r{[}@var{num}@r{]} | |
10364 | Disable tracepoint @var{num}, or all tracepoints if no argument | |
10365 | @var{num} is given. A disabled tracepoint will have no effect during | |
d248b706 | 10366 | a trace experiment, but it is not forgotten. You can re-enable |
b37052ae | 10367 | a disabled tracepoint using the @code{enable tracepoint} command. |
d248b706 KY |
10368 | If the command is issued during a trace experiment and the debug target |
10369 | has support for disabling tracepoints during a trace experiment, then the | |
10370 | change will be effective immediately. Otherwise, it will be applied to the | |
10371 | next trace experiment. | |
b37052ae EZ |
10372 | |
10373 | @kindex enable tracepoint | |
10374 | @item enable tracepoint @r{[}@var{num}@r{]} | |
d248b706 KY |
10375 | Enable tracepoint @var{num}, or all tracepoints. If this command is |
10376 | issued during a trace experiment and the debug target supports enabling | |
10377 | tracepoints during a trace experiment, then the enabled tracepoints will | |
10378 | become effective immediately. Otherwise, they will become effective the | |
10379 | next time a trace experiment is run. | |
b37052ae EZ |
10380 | @end table |
10381 | ||
10382 | @node Tracepoint Passcounts | |
10383 | @subsection Tracepoint Passcounts | |
10384 | ||
10385 | @table @code | |
10386 | @kindex passcount | |
10387 | @cindex tracepoint pass count | |
10388 | @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]} | |
10389 | Set the @dfn{passcount} of a tracepoint. The passcount is a way to | |
10390 | automatically stop a trace experiment. If a tracepoint's passcount is | |
10391 | @var{n}, then the trace experiment will be automatically stopped on | |
10392 | the @var{n}'th time that tracepoint is hit. If the tracepoint number | |
10393 | @var{num} is not specified, the @code{passcount} command sets the | |
10394 | passcount of the most recently defined tracepoint. If no passcount is | |
10395 | given, the trace experiment will run until stopped explicitly by the | |
10396 | user. | |
10397 | ||
10398 | Examples: | |
10399 | ||
10400 | @smallexample | |
b383017d | 10401 | (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of |
6826cf00 | 10402 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2} |
b37052ae EZ |
10403 | |
10404 | (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the | |
6826cf00 | 10405 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.} |
b37052ae EZ |
10406 | (@value{GDBP}) @b{trace foo} |
10407 | (@value{GDBP}) @b{pass 3} | |
10408 | (@value{GDBP}) @b{trace bar} | |
10409 | (@value{GDBP}) @b{pass 2} | |
10410 | (@value{GDBP}) @b{trace baz} | |
10411 | (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been | |
6826cf00 EZ |
10412 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has} |
10413 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times} | |
10414 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.} | |
b37052ae EZ |
10415 | @end smallexample |
10416 | @end table | |
10417 | ||
782b2b07 SS |
10418 | @node Tracepoint Conditions |
10419 | @subsection Tracepoint Conditions | |
10420 | @cindex conditional tracepoints | |
10421 | @cindex tracepoint conditions | |
10422 | ||
10423 | The simplest sort of tracepoint collects data every time your program | |
10424 | reaches a specified place. You can also specify a @dfn{condition} for | |
10425 | a tracepoint. A condition is just a Boolean expression in your | |
10426 | programming language (@pxref{Expressions, ,Expressions}). A | |
10427 | tracepoint with a condition evaluates the expression each time your | |
10428 | program reaches it, and data collection happens only if the condition | |
10429 | is true. | |
10430 | ||
10431 | Tracepoint conditions can be specified when a tracepoint is set, by | |
10432 | using @samp{if} in the arguments to the @code{trace} command. | |
10433 | @xref{Create and Delete Tracepoints, ,Setting Tracepoints}. They can | |
10434 | also be set or changed at any time with the @code{condition} command, | |
10435 | just as with breakpoints. | |
10436 | ||
10437 | Unlike breakpoint conditions, @value{GDBN} does not actually evaluate | |
10438 | the conditional expression itself. Instead, @value{GDBN} encodes the | |
6dcd5565 | 10439 | expression into an agent expression (@pxref{Agent Expressions}) |
782b2b07 SS |
10440 | suitable for execution on the target, independently of @value{GDBN}. |
10441 | Global variables become raw memory locations, locals become stack | |
10442 | accesses, and so forth. | |
10443 | ||
10444 | For instance, suppose you have a function that is usually called | |
10445 | frequently, but should not be called after an error has occurred. You | |
10446 | could use the following tracepoint command to collect data about calls | |
10447 | of that function that happen while the error code is propagating | |
10448 | through the program; an unconditional tracepoint could end up | |
10449 | collecting thousands of useless trace frames that you would have to | |
10450 | search through. | |
10451 | ||
10452 | @smallexample | |
10453 | (@value{GDBP}) @kbd{trace normal_operation if errcode > 0} | |
10454 | @end smallexample | |
10455 | ||
f61e138d SS |
10456 | @node Trace State Variables |
10457 | @subsection Trace State Variables | |
10458 | @cindex trace state variables | |
10459 | ||
10460 | A @dfn{trace state variable} is a special type of variable that is | |
10461 | created and managed by target-side code. The syntax is the same as | |
10462 | that for GDB's convenience variables (a string prefixed with ``$''), | |
10463 | but they are stored on the target. They must be created explicitly, | |
10464 | using a @code{tvariable} command. They are always 64-bit signed | |
10465 | integers. | |
10466 | ||
10467 | Trace state variables are remembered by @value{GDBN}, and downloaded | |
10468 | to the target along with tracepoint information when the trace | |
10469 | experiment starts. There are no intrinsic limits on the number of | |
10470 | trace state variables, beyond memory limitations of the target. | |
10471 | ||
10472 | @cindex convenience variables, and trace state variables | |
10473 | Although trace state variables are managed by the target, you can use | |
10474 | them in print commands and expressions as if they were convenience | |
10475 | variables; @value{GDBN} will get the current value from the target | |
10476 | while the trace experiment is running. Trace state variables share | |
10477 | the same namespace as other ``$'' variables, which means that you | |
10478 | cannot have trace state variables with names like @code{$23} or | |
10479 | @code{$pc}, nor can you have a trace state variable and a convenience | |
10480 | variable with the same name. | |
10481 | ||
10482 | @table @code | |
10483 | ||
10484 | @item tvariable $@var{name} [ = @var{expression} ] | |
10485 | @kindex tvariable | |
10486 | The @code{tvariable} command creates a new trace state variable named | |
10487 | @code{$@var{name}}, and optionally gives it an initial value of | |
10488 | @var{expression}. @var{expression} is evaluated when this command is | |
10489 | entered; the result will be converted to an integer if possible, | |
10490 | otherwise @value{GDBN} will report an error. A subsequent | |
10491 | @code{tvariable} command specifying the same name does not create a | |
10492 | variable, but instead assigns the supplied initial value to the | |
10493 | existing variable of that name, overwriting any previous initial | |
10494 | value. The default initial value is 0. | |
10495 | ||
10496 | @item info tvariables | |
10497 | @kindex info tvariables | |
10498 | List all the trace state variables along with their initial values. | |
10499 | Their current values may also be displayed, if the trace experiment is | |
10500 | currently running. | |
10501 | ||
10502 | @item delete tvariable @r{[} $@var{name} @dots{} @r{]} | |
10503 | @kindex delete tvariable | |
10504 | Delete the given trace state variables, or all of them if no arguments | |
10505 | are specified. | |
10506 | ||
10507 | @end table | |
10508 | ||
b37052ae EZ |
10509 | @node Tracepoint Actions |
10510 | @subsection Tracepoint Action Lists | |
10511 | ||
10512 | @table @code | |
10513 | @kindex actions | |
10514 | @cindex tracepoint actions | |
10515 | @item actions @r{[}@var{num}@r{]} | |
10516 | This command will prompt for a list of actions to be taken when the | |
10517 | tracepoint is hit. If the tracepoint number @var{num} is not | |
10518 | specified, this command sets the actions for the one that was most | |
10519 | recently defined (so that you can define a tracepoint and then say | |
10520 | @code{actions} without bothering about its number). You specify the | |
10521 | actions themselves on the following lines, one action at a time, and | |
10522 | terminate the actions list with a line containing just @code{end}. So | |
7d13fe92 | 10523 | far, the only defined actions are @code{collect}, @code{teval}, and |
b37052ae EZ |
10524 | @code{while-stepping}. |
10525 | ||
5a9351ae SS |
10526 | @code{actions} is actually equivalent to @code{commands} (@pxref{Break |
10527 | Commands, ,Breakpoint Command Lists}), except that only the defined | |
10528 | actions are allowed; any other @value{GDBN} command is rejected. | |
10529 | ||
b37052ae EZ |
10530 | @cindex remove actions from a tracepoint |
10531 | To remove all actions from a tracepoint, type @samp{actions @var{num}} | |
10532 | and follow it immediately with @samp{end}. | |
10533 | ||
10534 | @smallexample | |
10535 | (@value{GDBP}) @b{collect @var{data}} // collect some data | |
10536 | ||
6826cf00 | 10537 | (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data |
b37052ae | 10538 | |
6826cf00 | 10539 | (@value{GDBP}) @b{end} // signals the end of actions. |
b37052ae EZ |
10540 | @end smallexample |
10541 | ||
10542 | In the following example, the action list begins with @code{collect} | |
10543 | commands indicating the things to be collected when the tracepoint is | |
10544 | hit. Then, in order to single-step and collect additional data | |
10545 | following the tracepoint, a @code{while-stepping} command is used, | |
7d13fe92 SS |
10546 | followed by the list of things to be collected after each step in a |
10547 | sequence of single steps. The @code{while-stepping} command is | |
10548 | terminated by its own separate @code{end} command. Lastly, the action | |
10549 | list is terminated by an @code{end} command. | |
b37052ae EZ |
10550 | |
10551 | @smallexample | |
10552 | (@value{GDBP}) @b{trace foo} | |
10553 | (@value{GDBP}) @b{actions} | |
10554 | Enter actions for tracepoint 1, one per line: | |
10555 | > collect bar,baz | |
10556 | > collect $regs | |
10557 | > while-stepping 12 | |
5a9351ae | 10558 | > collect $pc, arr[i] |
b37052ae EZ |
10559 | > end |
10560 | end | |
10561 | @end smallexample | |
10562 | ||
10563 | @kindex collect @r{(tracepoints)} | |
10564 | @item collect @var{expr1}, @var{expr2}, @dots{} | |
10565 | Collect values of the given expressions when the tracepoint is hit. | |
10566 | This command accepts a comma-separated list of any valid expressions. | |
10567 | In addition to global, static, or local variables, the following | |
10568 | special arguments are supported: | |
10569 | ||
10570 | @table @code | |
10571 | @item $regs | |
0fb4aa4b | 10572 | Collect all registers. |
b37052ae EZ |
10573 | |
10574 | @item $args | |
0fb4aa4b | 10575 | Collect all function arguments. |
b37052ae EZ |
10576 | |
10577 | @item $locals | |
0fb4aa4b PA |
10578 | Collect all local variables. |
10579 | ||
6710bf39 SS |
10580 | @item $_ret |
10581 | Collect the return address. This is helpful if you want to see more | |
10582 | of a backtrace. | |
10583 | ||
0fb4aa4b PA |
10584 | @item $_sdata |
10585 | @vindex $_sdata@r{, collect} | |
10586 | Collect static tracepoint marker specific data. Only available for | |
10587 | static tracepoints. @xref{Tracepoint Actions,,Tracepoint Action | |
10588 | Lists}. On the UST static tracepoints library backend, an | |
10589 | instrumentation point resembles a @code{printf} function call. The | |
10590 | tracing library is able to collect user specified data formatted to a | |
10591 | character string using the format provided by the programmer that | |
10592 | instrumented the program. Other backends have similar mechanisms. | |
10593 | Here's an example of a UST marker call: | |
10594 | ||
10595 | @smallexample | |
10596 | const char master_name[] = "$your_name"; | |
10597 | trace_mark(channel1, marker1, "hello %s", master_name) | |
10598 | @end smallexample | |
10599 | ||
10600 | In this case, collecting @code{$_sdata} collects the string | |
10601 | @samp{hello $yourname}. When analyzing the trace buffer, you can | |
10602 | inspect @samp{$_sdata} like any other variable available to | |
10603 | @value{GDBN}. | |
b37052ae EZ |
10604 | @end table |
10605 | ||
10606 | You can give several consecutive @code{collect} commands, each one | |
10607 | with a single argument, or one @code{collect} command with several | |
5a9351ae | 10608 | arguments separated by commas; the effect is the same. |
b37052ae | 10609 | |
f5c37c66 EZ |
10610 | The command @code{info scope} (@pxref{Symbols, info scope}) is |
10611 | particularly useful for figuring out what data to collect. | |
10612 | ||
6da95a67 SS |
10613 | @kindex teval @r{(tracepoints)} |
10614 | @item teval @var{expr1}, @var{expr2}, @dots{} | |
10615 | Evaluate the given expressions when the tracepoint is hit. This | |
10616 | command accepts a comma-separated list of expressions. The results | |
10617 | are discarded, so this is mainly useful for assigning values to trace | |
10618 | state variables (@pxref{Trace State Variables}) without adding those | |
10619 | values to the trace buffer, as would be the case if the @code{collect} | |
10620 | action were used. | |
10621 | ||
b37052ae EZ |
10622 | @kindex while-stepping @r{(tracepoints)} |
10623 | @item while-stepping @var{n} | |
c9429232 | 10624 | Perform @var{n} single-step instruction traces after the tracepoint, |
7d13fe92 | 10625 | collecting new data after each step. The @code{while-stepping} |
c9429232 SS |
10626 | command is followed by the list of what to collect while stepping |
10627 | (followed by its own @code{end} command): | |
b37052ae EZ |
10628 | |
10629 | @smallexample | |
10630 | > while-stepping 12 | |
10631 | > collect $regs, myglobal | |
10632 | > end | |
10633 | > | |
10634 | @end smallexample | |
10635 | ||
10636 | @noindent | |
7d13fe92 SS |
10637 | Note that @code{$pc} is not automatically collected by |
10638 | @code{while-stepping}; you need to explicitly collect that register if | |
10639 | you need it. You may abbreviate @code{while-stepping} as @code{ws} or | |
b37052ae | 10640 | @code{stepping}. |
236f1d4d SS |
10641 | |
10642 | @item set default-collect @var{expr1}, @var{expr2}, @dots{} | |
10643 | @kindex set default-collect | |
10644 | @cindex default collection action | |
10645 | This variable is a list of expressions to collect at each tracepoint | |
10646 | hit. It is effectively an additional @code{collect} action prepended | |
10647 | to every tracepoint action list. The expressions are parsed | |
10648 | individually for each tracepoint, so for instance a variable named | |
10649 | @code{xyz} may be interpreted as a global for one tracepoint, and a | |
10650 | local for another, as appropriate to the tracepoint's location. | |
10651 | ||
10652 | @item show default-collect | |
10653 | @kindex show default-collect | |
10654 | Show the list of expressions that are collected by default at each | |
10655 | tracepoint hit. | |
10656 | ||
b37052ae EZ |
10657 | @end table |
10658 | ||
10659 | @node Listing Tracepoints | |
10660 | @subsection Listing Tracepoints | |
10661 | ||
10662 | @table @code | |
e5a67952 MS |
10663 | @kindex info tracepoints @r{[}@var{n}@dots{}@r{]} |
10664 | @kindex info tp @r{[}@var{n}@dots{}@r{]} | |
b37052ae | 10665 | @cindex information about tracepoints |
e5a67952 | 10666 | @item info tracepoints @r{[}@var{num}@dots{}@r{]} |
1042e4c0 SS |
10667 | Display information about the tracepoint @var{num}. If you don't |
10668 | specify a tracepoint number, displays information about all the | |
10669 | tracepoints defined so far. The format is similar to that used for | |
10670 | @code{info breakpoints}; in fact, @code{info tracepoints} is the same | |
10671 | command, simply restricting itself to tracepoints. | |
10672 | ||
10673 | A tracepoint's listing may include additional information specific to | |
10674 | tracing: | |
b37052ae EZ |
10675 | |
10676 | @itemize @bullet | |
10677 | @item | |
b37052ae | 10678 | its passcount as given by the @code{passcount @var{n}} command |
b37052ae EZ |
10679 | @end itemize |
10680 | ||
10681 | @smallexample | |
10682 | (@value{GDBP}) @b{info trace} | |
1042e4c0 SS |
10683 | Num Type Disp Enb Address What |
10684 | 1 tracepoint keep y 0x0804ab57 in foo() at main.cxx:7 | |
5a9351ae SS |
10685 | while-stepping 20 |
10686 | collect globfoo, $regs | |
10687 | end | |
10688 | collect globfoo2 | |
10689 | end | |
1042e4c0 | 10690 | pass count 1200 |
b37052ae EZ |
10691 | (@value{GDBP}) |
10692 | @end smallexample | |
10693 | ||
10694 | @noindent | |
10695 | This command can be abbreviated @code{info tp}. | |
10696 | @end table | |
10697 | ||
0fb4aa4b PA |
10698 | @node Listing Static Tracepoint Markers |
10699 | @subsection Listing Static Tracepoint Markers | |
10700 | ||
10701 | @table @code | |
10702 | @kindex info static-tracepoint-markers | |
10703 | @cindex information about static tracepoint markers | |
10704 | @item info static-tracepoint-markers | |
10705 | Display information about all static tracepoint markers defined in the | |
10706 | program. | |
10707 | ||
10708 | For each marker, the following columns are printed: | |
10709 | ||
10710 | @table @emph | |
10711 | @item Count | |
10712 | An incrementing counter, output to help readability. This is not a | |
10713 | stable identifier. | |
10714 | @item ID | |
10715 | The marker ID, as reported by the target. | |
10716 | @item Enabled or Disabled | |
10717 | Probed markers are tagged with @samp{y}. @samp{n} identifies marks | |
10718 | that are not enabled. | |
10719 | @item Address | |
10720 | Where the marker is in your program, as a memory address. | |
10721 | @item What | |
10722 | Where the marker is in the source for your program, as a file and line | |
10723 | number. If the debug information included in the program does not | |
10724 | allow @value{GDBN} to locate the source of the marker, this column | |
10725 | will be left blank. | |
10726 | @end table | |
10727 | ||
10728 | @noindent | |
10729 | In addition, the following information may be printed for each marker: | |
10730 | ||
10731 | @table @emph | |
10732 | @item Data | |
10733 | User data passed to the tracing library by the marker call. In the | |
10734 | UST backend, this is the format string passed as argument to the | |
10735 | marker call. | |
10736 | @item Static tracepoints probing the marker | |
10737 | The list of static tracepoints attached to the marker. | |
10738 | @end table | |
10739 | ||
10740 | @smallexample | |
10741 | (@value{GDBP}) info static-tracepoint-markers | |
10742 | Cnt ID Enb Address What | |
10743 | 1 ust/bar2 y 0x0000000000400e1a in main at stexample.c:25 | |
10744 | Data: number1 %d number2 %d | |
10745 | Probed by static tracepoints: #2 | |
10746 | 2 ust/bar33 n 0x0000000000400c87 in main at stexample.c:24 | |
10747 | Data: str %s | |
10748 | (@value{GDBP}) | |
10749 | @end smallexample | |
10750 | @end table | |
10751 | ||
79a6e687 BW |
10752 | @node Starting and Stopping Trace Experiments |
10753 | @subsection Starting and Stopping Trace Experiments | |
b37052ae EZ |
10754 | |
10755 | @table @code | |
10756 | @kindex tstart | |
10757 | @cindex start a new trace experiment | |
10758 | @cindex collected data discarded | |
10759 | @item tstart | |
10760 | This command takes no arguments. It starts the trace experiment, and | |
10761 | begins collecting data. This has the side effect of discarding all | |
10762 | the data collected in the trace buffer during the previous trace | |
10763 | experiment. | |
10764 | ||
10765 | @kindex tstop | |
10766 | @cindex stop a running trace experiment | |
10767 | @item tstop | |
10768 | This command takes no arguments. It ends the trace experiment, and | |
10769 | stops collecting data. | |
10770 | ||
68c71a2e | 10771 | @strong{Note}: a trace experiment and data collection may stop |
b37052ae EZ |
10772 | automatically if any tracepoint's passcount is reached |
10773 | (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full. | |
10774 | ||
10775 | @kindex tstatus | |
10776 | @cindex status of trace data collection | |
10777 | @cindex trace experiment, status of | |
10778 | @item tstatus | |
10779 | This command displays the status of the current trace data | |
10780 | collection. | |
10781 | @end table | |
10782 | ||
10783 | Here is an example of the commands we described so far: | |
10784 | ||
10785 | @smallexample | |
10786 | (@value{GDBP}) @b{trace gdb_c_test} | |
10787 | (@value{GDBP}) @b{actions} | |
10788 | Enter actions for tracepoint #1, one per line. | |
10789 | > collect $regs,$locals,$args | |
10790 | > while-stepping 11 | |
10791 | > collect $regs | |
10792 | > end | |
10793 | > end | |
10794 | (@value{GDBP}) @b{tstart} | |
10795 | [time passes @dots{}] | |
10796 | (@value{GDBP}) @b{tstop} | |
10797 | @end smallexample | |
10798 | ||
03f2bd59 | 10799 | @anchor{disconnected tracing} |
d5551862 SS |
10800 | @cindex disconnected tracing |
10801 | You can choose to continue running the trace experiment even if | |
10802 | @value{GDBN} disconnects from the target, voluntarily or | |
10803 | involuntarily. For commands such as @code{detach}, the debugger will | |
10804 | ask what you want to do with the trace. But for unexpected | |
10805 | terminations (@value{GDBN} crash, network outage), it would be | |
10806 | unfortunate to lose hard-won trace data, so the variable | |
10807 | @code{disconnected-tracing} lets you decide whether the trace should | |
10808 | continue running without @value{GDBN}. | |
10809 | ||
10810 | @table @code | |
10811 | @item set disconnected-tracing on | |
10812 | @itemx set disconnected-tracing off | |
10813 | @kindex set disconnected-tracing | |
10814 | Choose whether a tracing run should continue to run if @value{GDBN} | |
10815 | has disconnected from the target. Note that @code{detach} or | |
10816 | @code{quit} will ask you directly what to do about a running trace no | |
10817 | matter what this variable's setting, so the variable is mainly useful | |
10818 | for handling unexpected situations, such as loss of the network. | |
10819 | ||
10820 | @item show disconnected-tracing | |
10821 | @kindex show disconnected-tracing | |
10822 | Show the current choice for disconnected tracing. | |
10823 | ||
10824 | @end table | |
10825 | ||
10826 | When you reconnect to the target, the trace experiment may or may not | |
10827 | still be running; it might have filled the trace buffer in the | |
10828 | meantime, or stopped for one of the other reasons. If it is running, | |
10829 | it will continue after reconnection. | |
10830 | ||
10831 | Upon reconnection, the target will upload information about the | |
10832 | tracepoints in effect. @value{GDBN} will then compare that | |
10833 | information to the set of tracepoints currently defined, and attempt | |
10834 | to match them up, allowing for the possibility that the numbers may | |
10835 | have changed due to creation and deletion in the meantime. If one of | |
10836 | the target's tracepoints does not match any in @value{GDBN}, the | |
10837 | debugger will create a new tracepoint, so that you have a number with | |
10838 | which to specify that tracepoint. This matching-up process is | |
10839 | necessarily heuristic, and it may result in useless tracepoints being | |
10840 | created; you may simply delete them if they are of no use. | |
b37052ae | 10841 | |
4daf5ac0 SS |
10842 | @cindex circular trace buffer |
10843 | If your target agent supports a @dfn{circular trace buffer}, then you | |
10844 | can run a trace experiment indefinitely without filling the trace | |
10845 | buffer; when space runs out, the agent deletes already-collected trace | |
10846 | frames, oldest first, until there is enough room to continue | |
10847 | collecting. This is especially useful if your tracepoints are being | |
10848 | hit too often, and your trace gets terminated prematurely because the | |
10849 | buffer is full. To ask for a circular trace buffer, simply set | |
81896e36 | 10850 | @samp{circular-trace-buffer} to on. You can set this at any time, |
4daf5ac0 SS |
10851 | including during tracing; if the agent can do it, it will change |
10852 | buffer handling on the fly, otherwise it will not take effect until | |
10853 | the next run. | |
10854 | ||
10855 | @table @code | |
10856 | @item set circular-trace-buffer on | |
10857 | @itemx set circular-trace-buffer off | |
10858 | @kindex set circular-trace-buffer | |
10859 | Choose whether a tracing run should use a linear or circular buffer | |
10860 | for trace data. A linear buffer will not lose any trace data, but may | |
10861 | fill up prematurely, while a circular buffer will discard old trace | |
10862 | data, but it will have always room for the latest tracepoint hits. | |
10863 | ||
10864 | @item show circular-trace-buffer | |
10865 | @kindex show circular-trace-buffer | |
10866 | Show the current choice for the trace buffer. Note that this may not | |
10867 | match the agent's current buffer handling, nor is it guaranteed to | |
10868 | match the setting that might have been in effect during a past run, | |
10869 | for instance if you are looking at frames from a trace file. | |
10870 | ||
10871 | @end table | |
10872 | ||
c9429232 SS |
10873 | @node Tracepoint Restrictions |
10874 | @subsection Tracepoint Restrictions | |
10875 | ||
10876 | @cindex tracepoint restrictions | |
10877 | There are a number of restrictions on the use of tracepoints. As | |
10878 | described above, tracepoint data gathering occurs on the target | |
10879 | without interaction from @value{GDBN}. Thus the full capabilities of | |
10880 | the debugger are not available during data gathering, and then at data | |
10881 | examination time, you will be limited by only having what was | |
10882 | collected. The following items describe some common problems, but it | |
10883 | is not exhaustive, and you may run into additional difficulties not | |
10884 | mentioned here. | |
10885 | ||
10886 | @itemize @bullet | |
10887 | ||
10888 | @item | |
10889 | Tracepoint expressions are intended to gather objects (lvalues). Thus | |
10890 | the full flexibility of GDB's expression evaluator is not available. | |
10891 | You cannot call functions, cast objects to aggregate types, access | |
10892 | convenience variables or modify values (except by assignment to trace | |
10893 | state variables). Some language features may implicitly call | |
10894 | functions (for instance Objective-C fields with accessors), and therefore | |
10895 | cannot be collected either. | |
10896 | ||
10897 | @item | |
10898 | Collection of local variables, either individually or in bulk with | |
10899 | @code{$locals} or @code{$args}, during @code{while-stepping} may | |
10900 | behave erratically. The stepping action may enter a new scope (for | |
10901 | instance by stepping into a function), or the location of the variable | |
10902 | may change (for instance it is loaded into a register). The | |
10903 | tracepoint data recorded uses the location information for the | |
10904 | variables that is correct for the tracepoint location. When the | |
10905 | tracepoint is created, it is not possible, in general, to determine | |
10906 | where the steps of a @code{while-stepping} sequence will advance the | |
10907 | program---particularly if a conditional branch is stepped. | |
10908 | ||
10909 | @item | |
10910 | Collection of an incompletely-initialized or partially-destroyed object | |
10911 | may result in something that @value{GDBN} cannot display, or displays | |
10912 | in a misleading way. | |
10913 | ||
10914 | @item | |
10915 | When @value{GDBN} displays a pointer to character it automatically | |
10916 | dereferences the pointer to also display characters of the string | |
10917 | being pointed to. However, collecting the pointer during tracing does | |
10918 | not automatically collect the string. You need to explicitly | |
10919 | dereference the pointer and provide size information if you want to | |
10920 | collect not only the pointer, but the memory pointed to. For example, | |
10921 | @code{*ptr@@50} can be used to collect the 50 element array pointed to | |
10922 | by @code{ptr}. | |
10923 | ||
10924 | @item | |
10925 | It is not possible to collect a complete stack backtrace at a | |
10926 | tracepoint. Instead, you may collect the registers and a few hundred | |
d99f7e48 | 10927 | bytes from the stack pointer with something like @code{*(unsigned char *)$esp@@300} |
c9429232 SS |
10928 | (adjust to use the name of the actual stack pointer register on your |
10929 | target architecture, and the amount of stack you wish to capture). | |
10930 | Then the @code{backtrace} command will show a partial backtrace when | |
10931 | using a trace frame. The number of stack frames that can be examined | |
10932 | depends on the sizes of the frames in the collected stack. Note that | |
10933 | if you ask for a block so large that it goes past the bottom of the | |
10934 | stack, the target agent may report an error trying to read from an | |
10935 | invalid address. | |
10936 | ||
af54718e SS |
10937 | @item |
10938 | If you do not collect registers at a tracepoint, @value{GDBN} can | |
10939 | infer that the value of @code{$pc} must be the same as the address of | |
10940 | the tracepoint and use that when you are looking at a trace frame | |
10941 | for that tracepoint. However, this cannot work if the tracepoint has | |
10942 | multiple locations (for instance if it was set in a function that was | |
10943 | inlined), or if it has a @code{while-stepping} loop. In those cases | |
10944 | @value{GDBN} will warn you that it can't infer @code{$pc}, and default | |
10945 | it to zero. | |
10946 | ||
c9429232 SS |
10947 | @end itemize |
10948 | ||
b37052ae | 10949 | @node Analyze Collected Data |
79a6e687 | 10950 | @section Using the Collected Data |
b37052ae EZ |
10951 | |
10952 | After the tracepoint experiment ends, you use @value{GDBN} commands | |
10953 | for examining the trace data. The basic idea is that each tracepoint | |
10954 | collects a trace @dfn{snapshot} every time it is hit and another | |
10955 | snapshot every time it single-steps. All these snapshots are | |
10956 | consecutively numbered from zero and go into a buffer, and you can | |
10957 | examine them later. The way you examine them is to @dfn{focus} on a | |
10958 | specific trace snapshot. When the remote stub is focused on a trace | |
10959 | snapshot, it will respond to all @value{GDBN} requests for memory and | |
10960 | registers by reading from the buffer which belongs to that snapshot, | |
10961 | rather than from @emph{real} memory or registers of the program being | |
10962 | debugged. This means that @strong{all} @value{GDBN} commands | |
10963 | (@code{print}, @code{info registers}, @code{backtrace}, etc.) will | |
10964 | behave as if we were currently debugging the program state as it was | |
10965 | when the tracepoint occurred. Any requests for data that are not in | |
10966 | the buffer will fail. | |
10967 | ||
10968 | @menu | |
10969 | * tfind:: How to select a trace snapshot | |
10970 | * tdump:: How to display all data for a snapshot | |
6149aea9 | 10971 | * save tracepoints:: How to save tracepoints for a future run |
b37052ae EZ |
10972 | @end menu |
10973 | ||
10974 | @node tfind | |
10975 | @subsection @code{tfind @var{n}} | |
10976 | ||
10977 | @kindex tfind | |
10978 | @cindex select trace snapshot | |
10979 | @cindex find trace snapshot | |
10980 | The basic command for selecting a trace snapshot from the buffer is | |
10981 | @code{tfind @var{n}}, which finds trace snapshot number @var{n}, | |
10982 | counting from zero. If no argument @var{n} is given, the next | |
10983 | snapshot is selected. | |
10984 | ||
10985 | Here are the various forms of using the @code{tfind} command. | |
10986 | ||
10987 | @table @code | |
10988 | @item tfind start | |
10989 | Find the first snapshot in the buffer. This is a synonym for | |
10990 | @code{tfind 0} (since 0 is the number of the first snapshot). | |
10991 | ||
10992 | @item tfind none | |
10993 | Stop debugging trace snapshots, resume @emph{live} debugging. | |
10994 | ||
10995 | @item tfind end | |
10996 | Same as @samp{tfind none}. | |
10997 | ||
10998 | @item tfind | |
10999 | No argument means find the next trace snapshot. | |
11000 | ||
11001 | @item tfind - | |
11002 | Find the previous trace snapshot before the current one. This permits | |
11003 | retracing earlier steps. | |
11004 | ||
11005 | @item tfind tracepoint @var{num} | |
11006 | Find the next snapshot associated with tracepoint @var{num}. Search | |
11007 | proceeds forward from the last examined trace snapshot. If no | |
11008 | argument @var{num} is given, it means find the next snapshot collected | |
11009 | for the same tracepoint as the current snapshot. | |
11010 | ||
11011 | @item tfind pc @var{addr} | |
11012 | Find the next snapshot associated with the value @var{addr} of the | |
11013 | program counter. Search proceeds forward from the last examined trace | |
11014 | snapshot. If no argument @var{addr} is given, it means find the next | |
11015 | snapshot with the same value of PC as the current snapshot. | |
11016 | ||
11017 | @item tfind outside @var{addr1}, @var{addr2} | |
11018 | Find the next snapshot whose PC is outside the given range of | |
081dfbf7 | 11019 | addresses (exclusive). |
b37052ae EZ |
11020 | |
11021 | @item tfind range @var{addr1}, @var{addr2} | |
11022 | Find the next snapshot whose PC is between @var{addr1} and | |
081dfbf7 | 11023 | @var{addr2} (inclusive). |
b37052ae EZ |
11024 | |
11025 | @item tfind line @r{[}@var{file}:@r{]}@var{n} | |
11026 | Find the next snapshot associated with the source line @var{n}. If | |
11027 | the optional argument @var{file} is given, refer to line @var{n} in | |
11028 | that source file. Search proceeds forward from the last examined | |
11029 | trace snapshot. If no argument @var{n} is given, it means find the | |
11030 | next line other than the one currently being examined; thus saying | |
11031 | @code{tfind line} repeatedly can appear to have the same effect as | |
11032 | stepping from line to line in a @emph{live} debugging session. | |
11033 | @end table | |
11034 | ||
11035 | The default arguments for the @code{tfind} commands are specifically | |
11036 | designed to make it easy to scan through the trace buffer. For | |
11037 | instance, @code{tfind} with no argument selects the next trace | |
11038 | snapshot, and @code{tfind -} with no argument selects the previous | |
11039 | trace snapshot. So, by giving one @code{tfind} command, and then | |
11040 | simply hitting @key{RET} repeatedly you can examine all the trace | |
11041 | snapshots in order. Or, by saying @code{tfind -} and then hitting | |
11042 | @key{RET} repeatedly you can examine the snapshots in reverse order. | |
11043 | The @code{tfind line} command with no argument selects the snapshot | |
11044 | for the next source line executed. The @code{tfind pc} command with | |
11045 | no argument selects the next snapshot with the same program counter | |
11046 | (PC) as the current frame. The @code{tfind tracepoint} command with | |
11047 | no argument selects the next trace snapshot collected by the same | |
11048 | tracepoint as the current one. | |
11049 | ||
11050 | In addition to letting you scan through the trace buffer manually, | |
11051 | these commands make it easy to construct @value{GDBN} scripts that | |
11052 | scan through the trace buffer and print out whatever collected data | |
11053 | you are interested in. Thus, if we want to examine the PC, FP, and SP | |
11054 | registers from each trace frame in the buffer, we can say this: | |
11055 | ||
11056 | @smallexample | |
11057 | (@value{GDBP}) @b{tfind start} | |
11058 | (@value{GDBP}) @b{while ($trace_frame != -1)} | |
11059 | > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \ | |
11060 | $trace_frame, $pc, $sp, $fp | |
11061 | > tfind | |
11062 | > end | |
11063 | ||
11064 | Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44 | |
11065 | Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44 | |
11066 | Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44 | |
11067 | Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44 | |
11068 | Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44 | |
11069 | Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44 | |
11070 | Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44 | |
11071 | Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44 | |
11072 | Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44 | |
11073 | Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44 | |
11074 | Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14 | |
11075 | @end smallexample | |
11076 | ||
11077 | Or, if we want to examine the variable @code{X} at each source line in | |
11078 | the buffer: | |
11079 | ||
11080 | @smallexample | |
11081 | (@value{GDBP}) @b{tfind start} | |
11082 | (@value{GDBP}) @b{while ($trace_frame != -1)} | |
11083 | > printf "Frame %d, X == %d\n", $trace_frame, X | |
11084 | > tfind line | |
11085 | > end | |
11086 | ||
11087 | Frame 0, X = 1 | |
11088 | Frame 7, X = 2 | |
11089 | Frame 13, X = 255 | |
11090 | @end smallexample | |
11091 | ||
11092 | @node tdump | |
11093 | @subsection @code{tdump} | |
11094 | @kindex tdump | |
11095 | @cindex dump all data collected at tracepoint | |
11096 | @cindex tracepoint data, display | |
11097 | ||
11098 | This command takes no arguments. It prints all the data collected at | |
11099 | the current trace snapshot. | |
11100 | ||
11101 | @smallexample | |
11102 | (@value{GDBP}) @b{trace 444} | |
11103 | (@value{GDBP}) @b{actions} | |
11104 | Enter actions for tracepoint #2, one per line: | |
11105 | > collect $regs, $locals, $args, gdb_long_test | |
11106 | > end | |
11107 | ||
11108 | (@value{GDBP}) @b{tstart} | |
11109 | ||
11110 | (@value{GDBP}) @b{tfind line 444} | |
11111 | #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66) | |
11112 | at gdb_test.c:444 | |
11113 | 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", ) | |
11114 | ||
11115 | (@value{GDBP}) @b{tdump} | |
11116 | Data collected at tracepoint 2, trace frame 1: | |
11117 | d0 0xc4aa0085 -995491707 | |
11118 | d1 0x18 24 | |
11119 | d2 0x80 128 | |
11120 | d3 0x33 51 | |
11121 | d4 0x71aea3d 119204413 | |
11122 | d5 0x22 34 | |
11123 | d6 0xe0 224 | |
11124 | d7 0x380035 3670069 | |
11125 | a0 0x19e24a 1696330 | |
11126 | a1 0x3000668 50333288 | |
11127 | a2 0x100 256 | |
11128 | a3 0x322000 3284992 | |
11129 | a4 0x3000698 50333336 | |
11130 | a5 0x1ad3cc 1758156 | |
11131 | fp 0x30bf3c 0x30bf3c | |
11132 | sp 0x30bf34 0x30bf34 | |
11133 | ps 0x0 0 | |
11134 | pc 0x20b2c8 0x20b2c8 | |
11135 | fpcontrol 0x0 0 | |
11136 | fpstatus 0x0 0 | |
11137 | fpiaddr 0x0 0 | |
11138 | p = 0x20e5b4 "gdb-test" | |
11139 | p1 = (void *) 0x11 | |
11140 | p2 = (void *) 0x22 | |
11141 | p3 = (void *) 0x33 | |
11142 | p4 = (void *) 0x44 | |
11143 | p5 = (void *) 0x55 | |
11144 | p6 = (void *) 0x66 | |
11145 | gdb_long_test = 17 '\021' | |
11146 | ||
11147 | (@value{GDBP}) | |
11148 | @end smallexample | |
11149 | ||
af54718e SS |
11150 | @code{tdump} works by scanning the tracepoint's current collection |
11151 | actions and printing the value of each expression listed. So | |
11152 | @code{tdump} can fail, if after a run, you change the tracepoint's | |
11153 | actions to mention variables that were not collected during the run. | |
11154 | ||
11155 | Also, for tracepoints with @code{while-stepping} loops, @code{tdump} | |
11156 | uses the collected value of @code{$pc} to distinguish between trace | |
11157 | frames that were collected at the tracepoint hit, and frames that were | |
11158 | collected while stepping. This allows it to correctly choose whether | |
11159 | to display the basic list of collections, or the collections from the | |
11160 | body of the while-stepping loop. However, if @code{$pc} was not collected, | |
11161 | then @code{tdump} will always attempt to dump using the basic collection | |
11162 | list, and may fail if a while-stepping frame does not include all the | |
11163 | same data that is collected at the tracepoint hit. | |
11164 | @c This is getting pretty arcane, example would be good. | |
11165 | ||
6149aea9 PA |
11166 | @node save tracepoints |
11167 | @subsection @code{save tracepoints @var{filename}} | |
11168 | @kindex save tracepoints | |
b37052ae EZ |
11169 | @kindex save-tracepoints |
11170 | @cindex save tracepoints for future sessions | |
11171 | ||
11172 | This command saves all current tracepoint definitions together with | |
11173 | their actions and passcounts, into a file @file{@var{filename}} | |
11174 | suitable for use in a later debugging session. To read the saved | |
11175 | tracepoint definitions, use the @code{source} command (@pxref{Command | |
6149aea9 PA |
11176 | Files}). The @w{@code{save-tracepoints}} command is a deprecated |
11177 | alias for @w{@code{save tracepoints}} | |
b37052ae EZ |
11178 | |
11179 | @node Tracepoint Variables | |
11180 | @section Convenience Variables for Tracepoints | |
11181 | @cindex tracepoint variables | |
11182 | @cindex convenience variables for tracepoints | |
11183 | ||
11184 | @table @code | |
11185 | @vindex $trace_frame | |
11186 | @item (int) $trace_frame | |
11187 | The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no | |
11188 | snapshot is selected. | |
11189 | ||
11190 | @vindex $tracepoint | |
11191 | @item (int) $tracepoint | |
11192 | The tracepoint for the current trace snapshot. | |
11193 | ||
11194 | @vindex $trace_line | |
11195 | @item (int) $trace_line | |
11196 | The line number for the current trace snapshot. | |
11197 | ||
11198 | @vindex $trace_file | |
11199 | @item (char []) $trace_file | |
11200 | The source file for the current trace snapshot. | |
11201 | ||
11202 | @vindex $trace_func | |
11203 | @item (char []) $trace_func | |
11204 | The name of the function containing @code{$tracepoint}. | |
11205 | @end table | |
11206 | ||
11207 | Note: @code{$trace_file} is not suitable for use in @code{printf}, | |
11208 | use @code{output} instead. | |
11209 | ||
11210 | Here's a simple example of using these convenience variables for | |
11211 | stepping through all the trace snapshots and printing some of their | |
f61e138d SS |
11212 | data. Note that these are not the same as trace state variables, |
11213 | which are managed by the target. | |
b37052ae EZ |
11214 | |
11215 | @smallexample | |
11216 | (@value{GDBP}) @b{tfind start} | |
11217 | ||
11218 | (@value{GDBP}) @b{while $trace_frame != -1} | |
11219 | > output $trace_file | |
11220 | > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint | |
11221 | > tfind | |
11222 | > end | |
11223 | @end smallexample | |
11224 | ||
00bf0b85 SS |
11225 | @node Trace Files |
11226 | @section Using Trace Files | |
11227 | @cindex trace files | |
11228 | ||
11229 | In some situations, the target running a trace experiment may no | |
11230 | longer be available; perhaps it crashed, or the hardware was needed | |
11231 | for a different activity. To handle these cases, you can arrange to | |
11232 | dump the trace data into a file, and later use that file as a source | |
11233 | of trace data, via the @code{target tfile} command. | |
11234 | ||
11235 | @table @code | |
11236 | ||
11237 | @kindex tsave | |
11238 | @item tsave [ -r ] @var{filename} | |
11239 | Save the trace data to @var{filename}. By default, this command | |
11240 | assumes that @var{filename} refers to the host filesystem, so if | |
11241 | necessary @value{GDBN} will copy raw trace data up from the target and | |
11242 | then save it. If the target supports it, you can also supply the | |
11243 | optional argument @code{-r} (``remote'') to direct the target to save | |
11244 | the data directly into @var{filename} in its own filesystem, which may be | |
11245 | more efficient if the trace buffer is very large. (Note, however, that | |
11246 | @code{target tfile} can only read from files accessible to the host.) | |
11247 | ||
11248 | @kindex target tfile | |
11249 | @kindex tfile | |
11250 | @item target tfile @var{filename} | |
11251 | Use the file named @var{filename} as a source of trace data. Commands | |
11252 | that examine data work as they do with a live target, but it is not | |
11253 | possible to run any new trace experiments. @code{tstatus} will report | |
11254 | the state of the trace run at the moment the data was saved, as well | |
11255 | as the current trace frame you are examining. @var{filename} must be | |
11256 | on a filesystem accessible to the host. | |
11257 | ||
11258 | @end table | |
11259 | ||
df0cd8c5 JB |
11260 | @node Overlays |
11261 | @chapter Debugging Programs That Use Overlays | |
11262 | @cindex overlays | |
11263 | ||
11264 | If your program is too large to fit completely in your target system's | |
11265 | memory, you can sometimes use @dfn{overlays} to work around this | |
11266 | problem. @value{GDBN} provides some support for debugging programs that | |
11267 | use overlays. | |
11268 | ||
11269 | @menu | |
11270 | * How Overlays Work:: A general explanation of overlays. | |
11271 | * Overlay Commands:: Managing overlays in @value{GDBN}. | |
11272 | * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are | |
11273 | mapped by asking the inferior. | |
11274 | * Overlay Sample Program:: A sample program using overlays. | |
11275 | @end menu | |
11276 | ||
11277 | @node How Overlays Work | |
11278 | @section How Overlays Work | |
11279 | @cindex mapped overlays | |
11280 | @cindex unmapped overlays | |
11281 | @cindex load address, overlay's | |
11282 | @cindex mapped address | |
11283 | @cindex overlay area | |
11284 | ||
11285 | Suppose you have a computer whose instruction address space is only 64 | |
11286 | kilobytes long, but which has much more memory which can be accessed by | |
11287 | other means: special instructions, segment registers, or memory | |
11288 | management hardware, for example. Suppose further that you want to | |
11289 | adapt a program which is larger than 64 kilobytes to run on this system. | |
11290 | ||
11291 | One solution is to identify modules of your program which are relatively | |
11292 | independent, and need not call each other directly; call these modules | |
11293 | @dfn{overlays}. Separate the overlays from the main program, and place | |
11294 | their machine code in the larger memory. Place your main program in | |
11295 | instruction memory, but leave at least enough space there to hold the | |
11296 | largest overlay as well. | |
11297 | ||
11298 | Now, to call a function located in an overlay, you must first copy that | |
11299 | overlay's machine code from the large memory into the space set aside | |
11300 | for it in the instruction memory, and then jump to its entry point | |
11301 | there. | |
11302 | ||
c928edc0 AC |
11303 | @c NB: In the below the mapped area's size is greater or equal to the |
11304 | @c size of all overlays. This is intentional to remind the developer | |
11305 | @c that overlays don't necessarily need to be the same size. | |
11306 | ||
474c8240 | 11307 | @smallexample |
df0cd8c5 | 11308 | @group |
c928edc0 AC |
11309 | Data Instruction Larger |
11310 | Address Space Address Space Address Space | |
11311 | +-----------+ +-----------+ +-----------+ | |
11312 | | | | | | | | |
11313 | +-----------+ +-----------+ +-----------+<-- overlay 1 | |
11314 | | program | | main | .----| overlay 1 | load address | |
11315 | | variables | | program | | +-----------+ | |
11316 | | and heap | | | | | | | |
11317 | +-----------+ | | | +-----------+<-- overlay 2 | |
11318 | | | +-----------+ | | | load address | |
11319 | +-----------+ | | | .-| overlay 2 | | |
11320 | | | | | | | | |
11321 | mapped --->+-----------+ | | +-----------+ | |
11322 | address | | | | | | | |
11323 | | overlay | <-' | | | | |
11324 | | area | <---' +-----------+<-- overlay 3 | |
11325 | | | <---. | | load address | |
11326 | +-----------+ `--| overlay 3 | | |
11327 | | | | | | |
11328 | +-----------+ | | | |
11329 | +-----------+ | |
11330 | | | | |
11331 | +-----------+ | |
11332 | ||
11333 | @anchor{A code overlay}A code overlay | |
df0cd8c5 | 11334 | @end group |
474c8240 | 11335 | @end smallexample |
df0cd8c5 | 11336 | |
c928edc0 AC |
11337 | The diagram (@pxref{A code overlay}) shows a system with separate data |
11338 | and instruction address spaces. To map an overlay, the program copies | |
11339 | its code from the larger address space to the instruction address space. | |
11340 | Since the overlays shown here all use the same mapped address, only one | |
11341 | may be mapped at a time. For a system with a single address space for | |
11342 | data and instructions, the diagram would be similar, except that the | |
11343 | program variables and heap would share an address space with the main | |
11344 | program and the overlay area. | |
df0cd8c5 JB |
11345 | |
11346 | An overlay loaded into instruction memory and ready for use is called a | |
11347 | @dfn{mapped} overlay; its @dfn{mapped address} is its address in the | |
11348 | instruction memory. An overlay not present (or only partially present) | |
11349 | in instruction memory is called @dfn{unmapped}; its @dfn{load address} | |
11350 | is its address in the larger memory. The mapped address is also called | |
11351 | the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also | |
11352 | called the @dfn{load memory address}, or @dfn{LMA}. | |
11353 | ||
11354 | Unfortunately, overlays are not a completely transparent way to adapt a | |
11355 | program to limited instruction memory. They introduce a new set of | |
11356 | global constraints you must keep in mind as you design your program: | |
11357 | ||
11358 | @itemize @bullet | |
11359 | ||
11360 | @item | |
11361 | Before calling or returning to a function in an overlay, your program | |
11362 | must make sure that overlay is actually mapped. Otherwise, the call or | |
11363 | return will transfer control to the right address, but in the wrong | |
11364 | overlay, and your program will probably crash. | |
11365 | ||
11366 | @item | |
11367 | If the process of mapping an overlay is expensive on your system, you | |
11368 | will need to choose your overlays carefully to minimize their effect on | |
11369 | your program's performance. | |
11370 | ||
11371 | @item | |
11372 | The executable file you load onto your system must contain each | |
11373 | overlay's instructions, appearing at the overlay's load address, not its | |
11374 | mapped address. However, each overlay's instructions must be relocated | |
11375 | and its symbols defined as if the overlay were at its mapped address. | |
11376 | You can use GNU linker scripts to specify different load and relocation | |
11377 | addresses for pieces of your program; see @ref{Overlay Description,,, | |
11378 | ld.info, Using ld: the GNU linker}. | |
11379 | ||
11380 | @item | |
11381 | The procedure for loading executable files onto your system must be able | |
11382 | to load their contents into the larger address space as well as the | |
11383 | instruction and data spaces. | |
11384 | ||
11385 | @end itemize | |
11386 | ||
11387 | The overlay system described above is rather simple, and could be | |
11388 | improved in many ways: | |
11389 | ||
11390 | @itemize @bullet | |
11391 | ||
11392 | @item | |
11393 | If your system has suitable bank switch registers or memory management | |
11394 | hardware, you could use those facilities to make an overlay's load area | |
11395 | contents simply appear at their mapped address in instruction space. | |
11396 | This would probably be faster than copying the overlay to its mapped | |
11397 | area in the usual way. | |
11398 | ||
11399 | @item | |
11400 | If your overlays are small enough, you could set aside more than one | |
11401 | overlay area, and have more than one overlay mapped at a time. | |
11402 | ||
11403 | @item | |
11404 | You can use overlays to manage data, as well as instructions. In | |
11405 | general, data overlays are even less transparent to your design than | |
11406 | code overlays: whereas code overlays only require care when you call or | |
11407 | return to functions, data overlays require care every time you access | |
11408 | the data. Also, if you change the contents of a data overlay, you | |
11409 | must copy its contents back out to its load address before you can copy a | |
11410 | different data overlay into the same mapped area. | |
11411 | ||
11412 | @end itemize | |
11413 | ||
11414 | ||
11415 | @node Overlay Commands | |
11416 | @section Overlay Commands | |
11417 | ||
11418 | To use @value{GDBN}'s overlay support, each overlay in your program must | |
11419 | correspond to a separate section of the executable file. The section's | |
11420 | virtual memory address and load memory address must be the overlay's | |
11421 | mapped and load addresses. Identifying overlays with sections allows | |
11422 | @value{GDBN} to determine the appropriate address of a function or | |
11423 | variable, depending on whether the overlay is mapped or not. | |
11424 | ||
11425 | @value{GDBN}'s overlay commands all start with the word @code{overlay}; | |
11426 | you can abbreviate this as @code{ov} or @code{ovly}. The commands are: | |
11427 | ||
11428 | @table @code | |
11429 | @item overlay off | |
4644b6e3 | 11430 | @kindex overlay |
df0cd8c5 JB |
11431 | Disable @value{GDBN}'s overlay support. When overlay support is |
11432 | disabled, @value{GDBN} assumes that all functions and variables are | |
11433 | always present at their mapped addresses. By default, @value{GDBN}'s | |
11434 | overlay support is disabled. | |
11435 | ||
11436 | @item overlay manual | |
df0cd8c5 JB |
11437 | @cindex manual overlay debugging |
11438 | Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN} | |
11439 | relies on you to tell it which overlays are mapped, and which are not, | |
11440 | using the @code{overlay map-overlay} and @code{overlay unmap-overlay} | |
11441 | commands described below. | |
11442 | ||
11443 | @item overlay map-overlay @var{overlay} | |
11444 | @itemx overlay map @var{overlay} | |
df0cd8c5 JB |
11445 | @cindex map an overlay |
11446 | Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must | |
11447 | be the name of the object file section containing the overlay. When an | |
11448 | overlay is mapped, @value{GDBN} assumes it can find the overlay's | |
11449 | functions and variables at their mapped addresses. @value{GDBN} assumes | |
11450 | that any other overlays whose mapped ranges overlap that of | |
11451 | @var{overlay} are now unmapped. | |
11452 | ||
11453 | @item overlay unmap-overlay @var{overlay} | |
11454 | @itemx overlay unmap @var{overlay} | |
df0cd8c5 JB |
11455 | @cindex unmap an overlay |
11456 | Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay} | |
11457 | must be the name of the object file section containing the overlay. | |
11458 | When an overlay is unmapped, @value{GDBN} assumes it can find the | |
11459 | overlay's functions and variables at their load addresses. | |
11460 | ||
11461 | @item overlay auto | |
df0cd8c5 JB |
11462 | Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN} |
11463 | consults a data structure the overlay manager maintains in the inferior | |
11464 | to see which overlays are mapped. For details, see @ref{Automatic | |
11465 | Overlay Debugging}. | |
11466 | ||
11467 | @item overlay load-target | |
11468 | @itemx overlay load | |
df0cd8c5 JB |
11469 | @cindex reloading the overlay table |
11470 | Re-read the overlay table from the inferior. Normally, @value{GDBN} | |
11471 | re-reads the table @value{GDBN} automatically each time the inferior | |
11472 | stops, so this command should only be necessary if you have changed the | |
11473 | overlay mapping yourself using @value{GDBN}. This command is only | |
11474 | useful when using automatic overlay debugging. | |
11475 | ||
11476 | @item overlay list-overlays | |
11477 | @itemx overlay list | |
11478 | @cindex listing mapped overlays | |
11479 | Display a list of the overlays currently mapped, along with their mapped | |
11480 | addresses, load addresses, and sizes. | |
11481 | ||
11482 | @end table | |
11483 | ||
11484 | Normally, when @value{GDBN} prints a code address, it includes the name | |
11485 | of the function the address falls in: | |
11486 | ||
474c8240 | 11487 | @smallexample |
f7dc1244 | 11488 | (@value{GDBP}) print main |
df0cd8c5 | 11489 | $3 = @{int ()@} 0x11a0 <main> |
474c8240 | 11490 | @end smallexample |
df0cd8c5 JB |
11491 | @noindent |
11492 | When overlay debugging is enabled, @value{GDBN} recognizes code in | |
11493 | unmapped overlays, and prints the names of unmapped functions with | |
11494 | asterisks around them. For example, if @code{foo} is a function in an | |
11495 | unmapped overlay, @value{GDBN} prints it this way: | |
11496 | ||
474c8240 | 11497 | @smallexample |
f7dc1244 | 11498 | (@value{GDBP}) overlay list |
df0cd8c5 | 11499 | No sections are mapped. |
f7dc1244 | 11500 | (@value{GDBP}) print foo |
df0cd8c5 | 11501 | $5 = @{int (int)@} 0x100000 <*foo*> |
474c8240 | 11502 | @end smallexample |
df0cd8c5 JB |
11503 | @noindent |
11504 | When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's | |
11505 | name normally: | |
11506 | ||
474c8240 | 11507 | @smallexample |
f7dc1244 | 11508 | (@value{GDBP}) overlay list |
b383017d | 11509 | Section .ov.foo.text, loaded at 0x100000 - 0x100034, |
df0cd8c5 | 11510 | mapped at 0x1016 - 0x104a |
f7dc1244 | 11511 | (@value{GDBP}) print foo |
df0cd8c5 | 11512 | $6 = @{int (int)@} 0x1016 <foo> |
474c8240 | 11513 | @end smallexample |
df0cd8c5 JB |
11514 | |
11515 | When overlay debugging is enabled, @value{GDBN} can find the correct | |
11516 | address for functions and variables in an overlay, whether or not the | |
11517 | overlay is mapped. This allows most @value{GDBN} commands, like | |
11518 | @code{break} and @code{disassemble}, to work normally, even on unmapped | |
11519 | code. However, @value{GDBN}'s breakpoint support has some limitations: | |
11520 | ||
11521 | @itemize @bullet | |
11522 | @item | |
11523 | @cindex breakpoints in overlays | |
11524 | @cindex overlays, setting breakpoints in | |
11525 | You can set breakpoints in functions in unmapped overlays, as long as | |
11526 | @value{GDBN} can write to the overlay at its load address. | |
11527 | @item | |
11528 | @value{GDBN} can not set hardware or simulator-based breakpoints in | |
11529 | unmapped overlays. However, if you set a breakpoint at the end of your | |
11530 | overlay manager (and tell @value{GDBN} which overlays are now mapped, if | |
11531 | you are using manual overlay management), @value{GDBN} will re-set its | |
11532 | breakpoints properly. | |
11533 | @end itemize | |
11534 | ||
11535 | ||
11536 | @node Automatic Overlay Debugging | |
11537 | @section Automatic Overlay Debugging | |
11538 | @cindex automatic overlay debugging | |
11539 | ||
11540 | @value{GDBN} can automatically track which overlays are mapped and which | |
11541 | are not, given some simple co-operation from the overlay manager in the | |
11542 | inferior. If you enable automatic overlay debugging with the | |
11543 | @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN} | |
11544 | looks in the inferior's memory for certain variables describing the | |
11545 | current state of the overlays. | |
11546 | ||
11547 | Here are the variables your overlay manager must define to support | |
11548 | @value{GDBN}'s automatic overlay debugging: | |
11549 | ||
11550 | @table @asis | |
11551 | ||
11552 | @item @code{_ovly_table}: | |
11553 | This variable must be an array of the following structures: | |
11554 | ||
474c8240 | 11555 | @smallexample |
df0cd8c5 JB |
11556 | struct |
11557 | @{ | |
11558 | /* The overlay's mapped address. */ | |
11559 | unsigned long vma; | |
11560 | ||
11561 | /* The size of the overlay, in bytes. */ | |
11562 | unsigned long size; | |
11563 | ||
11564 | /* The overlay's load address. */ | |
11565 | unsigned long lma; | |
11566 | ||
11567 | /* Non-zero if the overlay is currently mapped; | |
11568 | zero otherwise. */ | |
11569 | unsigned long mapped; | |
11570 | @} | |
474c8240 | 11571 | @end smallexample |
df0cd8c5 JB |
11572 | |
11573 | @item @code{_novlys}: | |
11574 | This variable must be a four-byte signed integer, holding the total | |
11575 | number of elements in @code{_ovly_table}. | |
11576 | ||
11577 | @end table | |
11578 | ||
11579 | To decide whether a particular overlay is mapped or not, @value{GDBN} | |
11580 | looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and | |
11581 | @code{lma} members equal the VMA and LMA of the overlay's section in the | |
11582 | executable file. When @value{GDBN} finds a matching entry, it consults | |
11583 | the entry's @code{mapped} member to determine whether the overlay is | |
11584 | currently mapped. | |
11585 | ||
81d46470 | 11586 | In addition, your overlay manager may define a function called |
def71bfa | 11587 | @code{_ovly_debug_event}. If this function is defined, @value{GDBN} |
81d46470 MS |
11588 | will silently set a breakpoint there. If the overlay manager then |
11589 | calls this function whenever it has changed the overlay table, this | |
11590 | will enable @value{GDBN} to accurately keep track of which overlays | |
11591 | are in program memory, and update any breakpoints that may be set | |
b383017d | 11592 | in overlays. This will allow breakpoints to work even if the |
81d46470 MS |
11593 | overlays are kept in ROM or other non-writable memory while they |
11594 | are not being executed. | |
df0cd8c5 JB |
11595 | |
11596 | @node Overlay Sample Program | |
11597 | @section Overlay Sample Program | |
11598 | @cindex overlay example program | |
11599 | ||
11600 | When linking a program which uses overlays, you must place the overlays | |
11601 | at their load addresses, while relocating them to run at their mapped | |
11602 | addresses. To do this, you must write a linker script (@pxref{Overlay | |
11603 | Description,,, ld.info, Using ld: the GNU linker}). Unfortunately, | |
11604 | since linker scripts are specific to a particular host system, target | |
11605 | architecture, and target memory layout, this manual cannot provide | |
11606 | portable sample code demonstrating @value{GDBN}'s overlay support. | |
11607 | ||
11608 | However, the @value{GDBN} source distribution does contain an overlaid | |
11609 | program, with linker scripts for a few systems, as part of its test | |
11610 | suite. The program consists of the following files from | |
11611 | @file{gdb/testsuite/gdb.base}: | |
11612 | ||
11613 | @table @file | |
11614 | @item overlays.c | |
11615 | The main program file. | |
11616 | @item ovlymgr.c | |
11617 | A simple overlay manager, used by @file{overlays.c}. | |
11618 | @item foo.c | |
11619 | @itemx bar.c | |
11620 | @itemx baz.c | |
11621 | @itemx grbx.c | |
11622 | Overlay modules, loaded and used by @file{overlays.c}. | |
11623 | @item d10v.ld | |
11624 | @itemx m32r.ld | |
11625 | Linker scripts for linking the test program on the @code{d10v-elf} | |
11626 | and @code{m32r-elf} targets. | |
11627 | @end table | |
11628 | ||
11629 | You can build the test program using the @code{d10v-elf} GCC | |
11630 | cross-compiler like this: | |
11631 | ||
474c8240 | 11632 | @smallexample |
df0cd8c5 JB |
11633 | $ d10v-elf-gcc -g -c overlays.c |
11634 | $ d10v-elf-gcc -g -c ovlymgr.c | |
11635 | $ d10v-elf-gcc -g -c foo.c | |
11636 | $ d10v-elf-gcc -g -c bar.c | |
11637 | $ d10v-elf-gcc -g -c baz.c | |
11638 | $ d10v-elf-gcc -g -c grbx.c | |
11639 | $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \ | |
11640 | baz.o grbx.o -Wl,-Td10v.ld -o overlays | |
474c8240 | 11641 | @end smallexample |
df0cd8c5 JB |
11642 | |
11643 | The build process is identical for any other architecture, except that | |
11644 | you must substitute the appropriate compiler and linker script for the | |
11645 | target system for @code{d10v-elf-gcc} and @code{d10v.ld}. | |
11646 | ||
11647 | ||
6d2ebf8b | 11648 | @node Languages |
c906108c SS |
11649 | @chapter Using @value{GDBN} with Different Languages |
11650 | @cindex languages | |
11651 | ||
c906108c SS |
11652 | Although programming languages generally have common aspects, they are |
11653 | rarely expressed in the same manner. For instance, in ANSI C, | |
11654 | dereferencing a pointer @code{p} is accomplished by @code{*p}, but in | |
11655 | Modula-2, it is accomplished by @code{p^}. Values can also be | |
5d161b24 | 11656 | represented (and displayed) differently. Hex numbers in C appear as |
c906108c | 11657 | @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}. |
c906108c SS |
11658 | |
11659 | @cindex working language | |
11660 | Language-specific information is built into @value{GDBN} for some languages, | |
11661 | allowing you to express operations like the above in your program's | |
11662 | native language, and allowing @value{GDBN} to output values in a manner | |
11663 | consistent with the syntax of your program's native language. The | |
11664 | language you use to build expressions is called the @dfn{working | |
11665 | language}. | |
11666 | ||
11667 | @menu | |
11668 | * Setting:: Switching between source languages | |
11669 | * Show:: Displaying the language | |
c906108c | 11670 | * Checks:: Type and range checks |
79a6e687 BW |
11671 | * Supported Languages:: Supported languages |
11672 | * Unsupported Languages:: Unsupported languages | |
c906108c SS |
11673 | @end menu |
11674 | ||
6d2ebf8b | 11675 | @node Setting |
79a6e687 | 11676 | @section Switching Between Source Languages |
c906108c SS |
11677 | |
11678 | There are two ways to control the working language---either have @value{GDBN} | |
11679 | set it automatically, or select it manually yourself. You can use the | |
11680 | @code{set language} command for either purpose. On startup, @value{GDBN} | |
11681 | defaults to setting the language automatically. The working language is | |
11682 | used to determine how expressions you type are interpreted, how values | |
11683 | are printed, etc. | |
11684 | ||
11685 | In addition to the working language, every source file that | |
11686 | @value{GDBN} knows about has its own working language. For some object | |
11687 | file formats, the compiler might indicate which language a particular | |
11688 | source file is in. However, most of the time @value{GDBN} infers the | |
11689 | language from the name of the file. The language of a source file | |
b37052ae | 11690 | controls whether C@t{++} names are demangled---this way @code{backtrace} can |
c906108c | 11691 | show each frame appropriately for its own language. There is no way to |
d4f3574e SS |
11692 | set the language of a source file from within @value{GDBN}, but you can |
11693 | set the language associated with a filename extension. @xref{Show, , | |
79a6e687 | 11694 | Displaying the Language}. |
c906108c SS |
11695 | |
11696 | This is most commonly a problem when you use a program, such | |
5d161b24 | 11697 | as @code{cfront} or @code{f2c}, that generates C but is written in |
c906108c SS |
11698 | another language. In that case, make the |
11699 | program use @code{#line} directives in its C output; that way | |
11700 | @value{GDBN} will know the correct language of the source code of the original | |
11701 | program, and will display that source code, not the generated C code. | |
11702 | ||
11703 | @menu | |
11704 | * Filenames:: Filename extensions and languages. | |
11705 | * Manually:: Setting the working language manually | |
11706 | * Automatically:: Having @value{GDBN} infer the source language | |
11707 | @end menu | |
11708 | ||
6d2ebf8b | 11709 | @node Filenames |
79a6e687 | 11710 | @subsection List of Filename Extensions and Languages |
c906108c SS |
11711 | |
11712 | If a source file name ends in one of the following extensions, then | |
11713 | @value{GDBN} infers that its language is the one indicated. | |
11714 | ||
11715 | @table @file | |
e07c999f PH |
11716 | @item .ada |
11717 | @itemx .ads | |
11718 | @itemx .adb | |
11719 | @itemx .a | |
11720 | Ada source file. | |
c906108c SS |
11721 | |
11722 | @item .c | |
11723 | C source file | |
11724 | ||
11725 | @item .C | |
11726 | @itemx .cc | |
11727 | @itemx .cp | |
11728 | @itemx .cpp | |
11729 | @itemx .cxx | |
11730 | @itemx .c++ | |
b37052ae | 11731 | C@t{++} source file |
c906108c | 11732 | |
6aecb9c2 JB |
11733 | @item .d |
11734 | D source file | |
11735 | ||
b37303ee AF |
11736 | @item .m |
11737 | Objective-C source file | |
11738 | ||
c906108c SS |
11739 | @item .f |
11740 | @itemx .F | |
11741 | Fortran source file | |
11742 | ||
c906108c SS |
11743 | @item .mod |
11744 | Modula-2 source file | |
c906108c SS |
11745 | |
11746 | @item .s | |
11747 | @itemx .S | |
11748 | Assembler source file. This actually behaves almost like C, but | |
11749 | @value{GDBN} does not skip over function prologues when stepping. | |
11750 | @end table | |
11751 | ||
11752 | In addition, you may set the language associated with a filename | |
79a6e687 | 11753 | extension. @xref{Show, , Displaying the Language}. |
c906108c | 11754 | |
6d2ebf8b | 11755 | @node Manually |
79a6e687 | 11756 | @subsection Setting the Working Language |
c906108c SS |
11757 | |
11758 | If you allow @value{GDBN} to set the language automatically, | |
11759 | expressions are interpreted the same way in your debugging session and | |
11760 | your program. | |
11761 | ||
11762 | @kindex set language | |
11763 | If you wish, you may set the language manually. To do this, issue the | |
11764 | command @samp{set language @var{lang}}, where @var{lang} is the name of | |
5d161b24 | 11765 | a language, such as |
c906108c | 11766 | @code{c} or @code{modula-2}. |
c906108c SS |
11767 | For a list of the supported languages, type @samp{set language}. |
11768 | ||
c906108c SS |
11769 | Setting the language manually prevents @value{GDBN} from updating the working |
11770 | language automatically. This can lead to confusion if you try | |
11771 | to debug a program when the working language is not the same as the | |
11772 | source language, when an expression is acceptable to both | |
11773 | languages---but means different things. For instance, if the current | |
11774 | source file were written in C, and @value{GDBN} was parsing Modula-2, a | |
11775 | command such as: | |
11776 | ||
474c8240 | 11777 | @smallexample |
c906108c | 11778 | print a = b + c |
474c8240 | 11779 | @end smallexample |
c906108c SS |
11780 | |
11781 | @noindent | |
11782 | might not have the effect you intended. In C, this means to add | |
11783 | @code{b} and @code{c} and place the result in @code{a}. The result | |
11784 | printed would be the value of @code{a}. In Modula-2, this means to compare | |
11785 | @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value. | |
c906108c | 11786 | |
6d2ebf8b | 11787 | @node Automatically |
79a6e687 | 11788 | @subsection Having @value{GDBN} Infer the Source Language |
c906108c SS |
11789 | |
11790 | To have @value{GDBN} set the working language automatically, use | |
11791 | @samp{set language local} or @samp{set language auto}. @value{GDBN} | |
11792 | then infers the working language. That is, when your program stops in a | |
11793 | frame (usually by encountering a breakpoint), @value{GDBN} sets the | |
11794 | working language to the language recorded for the function in that | |
11795 | frame. If the language for a frame is unknown (that is, if the function | |
11796 | or block corresponding to the frame was defined in a source file that | |
11797 | does not have a recognized extension), the current working language is | |
11798 | not changed, and @value{GDBN} issues a warning. | |
11799 | ||
11800 | This may not seem necessary for most programs, which are written | |
11801 | entirely in one source language. However, program modules and libraries | |
11802 | written in one source language can be used by a main program written in | |
11803 | a different source language. Using @samp{set language auto} in this | |
11804 | case frees you from having to set the working language manually. | |
11805 | ||
6d2ebf8b | 11806 | @node Show |
79a6e687 | 11807 | @section Displaying the Language |
c906108c SS |
11808 | |
11809 | The following commands help you find out which language is the | |
11810 | working language, and also what language source files were written in. | |
11811 | ||
c906108c SS |
11812 | @table @code |
11813 | @item show language | |
9c16f35a | 11814 | @kindex show language |
c906108c SS |
11815 | Display the current working language. This is the |
11816 | language you can use with commands such as @code{print} to | |
11817 | build and compute expressions that may involve variables in your program. | |
11818 | ||
11819 | @item info frame | |
4644b6e3 | 11820 | @kindex info frame@r{, show the source language} |
5d161b24 | 11821 | Display the source language for this frame. This language becomes the |
c906108c | 11822 | working language if you use an identifier from this frame. |
79a6e687 | 11823 | @xref{Frame Info, ,Information about a Frame}, to identify the other |
c906108c SS |
11824 | information listed here. |
11825 | ||
11826 | @item info source | |
4644b6e3 | 11827 | @kindex info source@r{, show the source language} |
c906108c | 11828 | Display the source language of this source file. |
5d161b24 | 11829 | @xref{Symbols, ,Examining the Symbol Table}, to identify the other |
c906108c SS |
11830 | information listed here. |
11831 | @end table | |
11832 | ||
11833 | In unusual circumstances, you may have source files with extensions | |
11834 | not in the standard list. You can then set the extension associated | |
11835 | with a language explicitly: | |
11836 | ||
c906108c | 11837 | @table @code |
09d4efe1 | 11838 | @item set extension-language @var{ext} @var{language} |
9c16f35a | 11839 | @kindex set extension-language |
09d4efe1 EZ |
11840 | Tell @value{GDBN} that source files with extension @var{ext} are to be |
11841 | assumed as written in the source language @var{language}. | |
c906108c SS |
11842 | |
11843 | @item info extensions | |
9c16f35a | 11844 | @kindex info extensions |
c906108c SS |
11845 | List all the filename extensions and the associated languages. |
11846 | @end table | |
11847 | ||
6d2ebf8b | 11848 | @node Checks |
79a6e687 | 11849 | @section Type and Range Checking |
c906108c SS |
11850 | |
11851 | @quotation | |
11852 | @emph{Warning:} In this release, the @value{GDBN} commands for type and range | |
11853 | checking are included, but they do not yet have any effect. This | |
11854 | section documents the intended facilities. | |
11855 | @end quotation | |
11856 | @c FIXME remove warning when type/range code added | |
11857 | ||
11858 | Some languages are designed to guard you against making seemingly common | |
11859 | errors through a series of compile- and run-time checks. These include | |
11860 | checking the type of arguments to functions and operators, and making | |
11861 | sure mathematical overflows are caught at run time. Checks such as | |
11862 | these help to ensure a program's correctness once it has been compiled | |
11863 | by eliminating type mismatches, and providing active checks for range | |
11864 | errors when your program is running. | |
11865 | ||
11866 | @value{GDBN} can check for conditions like the above if you wish. | |
9c16f35a EZ |
11867 | Although @value{GDBN} does not check the statements in your program, |
11868 | it can check expressions entered directly into @value{GDBN} for | |
11869 | evaluation via the @code{print} command, for example. As with the | |
11870 | working language, @value{GDBN} can also decide whether or not to check | |
11871 | automatically based on your program's source language. | |
79a6e687 | 11872 | @xref{Supported Languages, ,Supported Languages}, for the default |
9c16f35a | 11873 | settings of supported languages. |
c906108c SS |
11874 | |
11875 | @menu | |
11876 | * Type Checking:: An overview of type checking | |
11877 | * Range Checking:: An overview of range checking | |
11878 | @end menu | |
11879 | ||
11880 | @cindex type checking | |
11881 | @cindex checks, type | |
6d2ebf8b | 11882 | @node Type Checking |
79a6e687 | 11883 | @subsection An Overview of Type Checking |
c906108c SS |
11884 | |
11885 | Some languages, such as Modula-2, are strongly typed, meaning that the | |
11886 | arguments to operators and functions have to be of the correct type, | |
11887 | otherwise an error occurs. These checks prevent type mismatch | |
11888 | errors from ever causing any run-time problems. For example, | |
11889 | ||
11890 | @smallexample | |
11891 | 1 + 2 @result{} 3 | |
11892 | @exdent but | |
11893 | @error{} 1 + 2.3 | |
11894 | @end smallexample | |
11895 | ||
11896 | The second example fails because the @code{CARDINAL} 1 is not | |
11897 | type-compatible with the @code{REAL} 2.3. | |
11898 | ||
5d161b24 DB |
11899 | For the expressions you use in @value{GDBN} commands, you can tell the |
11900 | @value{GDBN} type checker to skip checking; | |
11901 | to treat any mismatches as errors and abandon the expression; | |
11902 | or to only issue warnings when type mismatches occur, | |
c906108c SS |
11903 | but evaluate the expression anyway. When you choose the last of |
11904 | these, @value{GDBN} evaluates expressions like the second example above, but | |
11905 | also issues a warning. | |
11906 | ||
5d161b24 DB |
11907 | Even if you turn type checking off, there may be other reasons |
11908 | related to type that prevent @value{GDBN} from evaluating an expression. | |
11909 | For instance, @value{GDBN} does not know how to add an @code{int} and | |
11910 | a @code{struct foo}. These particular type errors have nothing to do | |
11911 | with the language in use, and usually arise from expressions, such as | |
c906108c SS |
11912 | the one described above, which make little sense to evaluate anyway. |
11913 | ||
11914 | Each language defines to what degree it is strict about type. For | |
11915 | instance, both Modula-2 and C require the arguments to arithmetical | |
11916 | operators to be numbers. In C, enumerated types and pointers can be | |
11917 | represented as numbers, so that they are valid arguments to mathematical | |
79a6e687 | 11918 | operators. @xref{Supported Languages, ,Supported Languages}, for further |
c906108c SS |
11919 | details on specific languages. |
11920 | ||
11921 | @value{GDBN} provides some additional commands for controlling the type checker: | |
11922 | ||
c906108c SS |
11923 | @kindex set check type |
11924 | @kindex show check type | |
11925 | @table @code | |
11926 | @item set check type auto | |
11927 | Set type checking on or off based on the current working language. | |
79a6e687 | 11928 | @xref{Supported Languages, ,Supported Languages}, for the default settings for |
c906108c SS |
11929 | each language. |
11930 | ||
11931 | @item set check type on | |
11932 | @itemx set check type off | |
11933 | Set type checking on or off, overriding the default setting for the | |
11934 | current working language. Issue a warning if the setting does not | |
11935 | match the language default. If any type mismatches occur in | |
d4f3574e | 11936 | evaluating an expression while type checking is on, @value{GDBN} prints a |
c906108c SS |
11937 | message and aborts evaluation of the expression. |
11938 | ||
11939 | @item set check type warn | |
11940 | Cause the type checker to issue warnings, but to always attempt to | |
11941 | evaluate the expression. Evaluating the expression may still | |
11942 | be impossible for other reasons. For example, @value{GDBN} cannot add | |
11943 | numbers and structures. | |
11944 | ||
11945 | @item show type | |
5d161b24 | 11946 | Show the current setting of the type checker, and whether or not @value{GDBN} |
c906108c SS |
11947 | is setting it automatically. |
11948 | @end table | |
11949 | ||
11950 | @cindex range checking | |
11951 | @cindex checks, range | |
6d2ebf8b | 11952 | @node Range Checking |
79a6e687 | 11953 | @subsection An Overview of Range Checking |
c906108c SS |
11954 | |
11955 | In some languages (such as Modula-2), it is an error to exceed the | |
11956 | bounds of a type; this is enforced with run-time checks. Such range | |
11957 | checking is meant to ensure program correctness by making sure | |
11958 | computations do not overflow, or indices on an array element access do | |
11959 | not exceed the bounds of the array. | |
11960 | ||
11961 | For expressions you use in @value{GDBN} commands, you can tell | |
11962 | @value{GDBN} to treat range errors in one of three ways: ignore them, | |
11963 | always treat them as errors and abandon the expression, or issue | |
11964 | warnings but evaluate the expression anyway. | |
11965 | ||
11966 | A range error can result from numerical overflow, from exceeding an | |
11967 | array index bound, or when you type a constant that is not a member | |
11968 | of any type. Some languages, however, do not treat overflows as an | |
11969 | error. In many implementations of C, mathematical overflow causes the | |
11970 | result to ``wrap around'' to lower values---for example, if @var{m} is | |
11971 | the largest integer value, and @var{s} is the smallest, then | |
11972 | ||
474c8240 | 11973 | @smallexample |
c906108c | 11974 | @var{m} + 1 @result{} @var{s} |
474c8240 | 11975 | @end smallexample |
c906108c SS |
11976 | |
11977 | This, too, is specific to individual languages, and in some cases | |
79a6e687 BW |
11978 | specific to individual compilers or machines. @xref{Supported Languages, , |
11979 | Supported Languages}, for further details on specific languages. | |
c906108c SS |
11980 | |
11981 | @value{GDBN} provides some additional commands for controlling the range checker: | |
11982 | ||
c906108c SS |
11983 | @kindex set check range |
11984 | @kindex show check range | |
11985 | @table @code | |
11986 | @item set check range auto | |
11987 | Set range checking on or off based on the current working language. | |
79a6e687 | 11988 | @xref{Supported Languages, ,Supported Languages}, for the default settings for |
c906108c SS |
11989 | each language. |
11990 | ||
11991 | @item set check range on | |
11992 | @itemx set check range off | |
11993 | Set range checking on or off, overriding the default setting for the | |
11994 | current working language. A warning is issued if the setting does not | |
c3f6f71d JM |
11995 | match the language default. If a range error occurs and range checking is on, |
11996 | then a message is printed and evaluation of the expression is aborted. | |
c906108c SS |
11997 | |
11998 | @item set check range warn | |
11999 | Output messages when the @value{GDBN} range checker detects a range error, | |
12000 | but attempt to evaluate the expression anyway. Evaluating the | |
12001 | expression may still be impossible for other reasons, such as accessing | |
12002 | memory that the process does not own (a typical example from many Unix | |
12003 | systems). | |
12004 | ||
12005 | @item show range | |
12006 | Show the current setting of the range checker, and whether or not it is | |
12007 | being set automatically by @value{GDBN}. | |
12008 | @end table | |
c906108c | 12009 | |
79a6e687 BW |
12010 | @node Supported Languages |
12011 | @section Supported Languages | |
c906108c | 12012 | |
f4b8a18d | 12013 | @value{GDBN} supports C, C@t{++}, D, Objective-C, Fortran, Java, OpenCL C, Pascal, |
9c16f35a | 12014 | assembly, Modula-2, and Ada. |
cce74817 | 12015 | @c This is false ... |
c906108c SS |
12016 | Some @value{GDBN} features may be used in expressions regardless of the |
12017 | language you use: the @value{GDBN} @code{@@} and @code{::} operators, | |
12018 | and the @samp{@{type@}addr} construct (@pxref{Expressions, | |
12019 | ,Expressions}) can be used with the constructs of any supported | |
12020 | language. | |
12021 | ||
12022 | The following sections detail to what degree each source language is | |
12023 | supported by @value{GDBN}. These sections are not meant to be language | |
12024 | tutorials or references, but serve only as a reference guide to what the | |
12025 | @value{GDBN} expression parser accepts, and what input and output | |
12026 | formats should look like for different languages. There are many good | |
12027 | books written on each of these languages; please look to these for a | |
12028 | language reference or tutorial. | |
12029 | ||
c906108c | 12030 | @menu |
b37303ee | 12031 | * C:: C and C@t{++} |
6aecb9c2 | 12032 | * D:: D |
b383017d | 12033 | * Objective-C:: Objective-C |
f4b8a18d | 12034 | * OpenCL C:: OpenCL C |
09d4efe1 | 12035 | * Fortran:: Fortran |
9c16f35a | 12036 | * Pascal:: Pascal |
b37303ee | 12037 | * Modula-2:: Modula-2 |
e07c999f | 12038 | * Ada:: Ada |
c906108c SS |
12039 | @end menu |
12040 | ||
6d2ebf8b | 12041 | @node C |
b37052ae | 12042 | @subsection C and C@t{++} |
7a292a7a | 12043 | |
b37052ae EZ |
12044 | @cindex C and C@t{++} |
12045 | @cindex expressions in C or C@t{++} | |
c906108c | 12046 | |
b37052ae | 12047 | Since C and C@t{++} are so closely related, many features of @value{GDBN} apply |
c906108c SS |
12048 | to both languages. Whenever this is the case, we discuss those languages |
12049 | together. | |
12050 | ||
41afff9a EZ |
12051 | @cindex C@t{++} |
12052 | @cindex @code{g++}, @sc{gnu} C@t{++} compiler | |
b37052ae EZ |
12053 | @cindex @sc{gnu} C@t{++} |
12054 | The C@t{++} debugging facilities are jointly implemented by the C@t{++} | |
12055 | compiler and @value{GDBN}. Therefore, to debug your C@t{++} code | |
12056 | effectively, you must compile your C@t{++} programs with a supported | |
12057 | C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++} | |
c906108c SS |
12058 | compiler (@code{aCC}). |
12059 | ||
0179ffac DC |
12060 | For best results when using @sc{gnu} C@t{++}, use the DWARF 2 debugging |
12061 | format; if it doesn't work on your system, try the stabs+ debugging | |
12062 | format. You can select those formats explicitly with the @code{g++} | |
12063 | command-line options @option{-gdwarf-2} and @option{-gstabs+}. | |
ce9341a1 BW |
12064 | @xref{Debugging Options,,Options for Debugging Your Program or GCC, |
12065 | gcc.info, Using the @sc{gnu} Compiler Collection (GCC)}. | |
c906108c | 12066 | |
c906108c | 12067 | @menu |
b37052ae EZ |
12068 | * C Operators:: C and C@t{++} operators |
12069 | * C Constants:: C and C@t{++} constants | |
79a6e687 | 12070 | * C Plus Plus Expressions:: C@t{++} expressions |
b37052ae EZ |
12071 | * C Defaults:: Default settings for C and C@t{++} |
12072 | * C Checks:: C and C@t{++} type and range checks | |
c906108c | 12073 | * Debugging C:: @value{GDBN} and C |
79a6e687 | 12074 | * Debugging C Plus Plus:: @value{GDBN} features for C@t{++} |
febe4383 | 12075 | * Decimal Floating Point:: Numbers in Decimal Floating Point format |
c906108c | 12076 | @end menu |
c906108c | 12077 | |
6d2ebf8b | 12078 | @node C Operators |
79a6e687 | 12079 | @subsubsection C and C@t{++} Operators |
7a292a7a | 12080 | |
b37052ae | 12081 | @cindex C and C@t{++} operators |
c906108c SS |
12082 | |
12083 | Operators must be defined on values of specific types. For instance, | |
12084 | @code{+} is defined on numbers, but not on structures. Operators are | |
5d161b24 | 12085 | often defined on groups of types. |
c906108c | 12086 | |
b37052ae | 12087 | For the purposes of C and C@t{++}, the following definitions hold: |
c906108c SS |
12088 | |
12089 | @itemize @bullet | |
53a5351d | 12090 | |
c906108c | 12091 | @item |
c906108c | 12092 | @emph{Integral types} include @code{int} with any of its storage-class |
b37052ae | 12093 | specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}. |
c906108c SS |
12094 | |
12095 | @item | |
d4f3574e SS |
12096 | @emph{Floating-point types} include @code{float}, @code{double}, and |
12097 | @code{long double} (if supported by the target platform). | |
c906108c SS |
12098 | |
12099 | @item | |
53a5351d | 12100 | @emph{Pointer types} include all types defined as @code{(@var{type} *)}. |
c906108c SS |
12101 | |
12102 | @item | |
12103 | @emph{Scalar types} include all of the above. | |
53a5351d | 12104 | |
c906108c SS |
12105 | @end itemize |
12106 | ||
12107 | @noindent | |
12108 | The following operators are supported. They are listed here | |
12109 | in order of increasing precedence: | |
12110 | ||
12111 | @table @code | |
12112 | @item , | |
12113 | The comma or sequencing operator. Expressions in a comma-separated list | |
12114 | are evaluated from left to right, with the result of the entire | |
12115 | expression being the last expression evaluated. | |
12116 | ||
12117 | @item = | |
12118 | Assignment. The value of an assignment expression is the value | |
12119 | assigned. Defined on scalar types. | |
12120 | ||
12121 | @item @var{op}= | |
12122 | Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}}, | |
12123 | and translated to @w{@code{@var{a} = @var{a op b}}}. | |
d4f3574e | 12124 | @w{@code{@var{op}=}} and @code{=} have the same precedence. |
c906108c SS |
12125 | @var{op} is any one of the operators @code{|}, @code{^}, @code{&}, |
12126 | @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}. | |
12127 | ||
12128 | @item ?: | |
12129 | The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought | |
12130 | of as: if @var{a} then @var{b} else @var{c}. @var{a} should be of an | |
12131 | integral type. | |
12132 | ||
12133 | @item || | |
12134 | Logical @sc{or}. Defined on integral types. | |
12135 | ||
12136 | @item && | |
12137 | Logical @sc{and}. Defined on integral types. | |
12138 | ||
12139 | @item | | |
12140 | Bitwise @sc{or}. Defined on integral types. | |
12141 | ||
12142 | @item ^ | |
12143 | Bitwise exclusive-@sc{or}. Defined on integral types. | |
12144 | ||
12145 | @item & | |
12146 | Bitwise @sc{and}. Defined on integral types. | |
12147 | ||
12148 | @item ==@r{, }!= | |
12149 | Equality and inequality. Defined on scalar types. The value of these | |
12150 | expressions is 0 for false and non-zero for true. | |
12151 | ||
12152 | @item <@r{, }>@r{, }<=@r{, }>= | |
12153 | Less than, greater than, less than or equal, greater than or equal. | |
12154 | Defined on scalar types. The value of these expressions is 0 for false | |
12155 | and non-zero for true. | |
12156 | ||
12157 | @item <<@r{, }>> | |
12158 | left shift, and right shift. Defined on integral types. | |
12159 | ||
12160 | @item @@ | |
12161 | The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}). | |
12162 | ||
12163 | @item +@r{, }- | |
12164 | Addition and subtraction. Defined on integral types, floating-point types and | |
12165 | pointer types. | |
12166 | ||
12167 | @item *@r{, }/@r{, }% | |
12168 | Multiplication, division, and modulus. Multiplication and division are | |
12169 | defined on integral and floating-point types. Modulus is defined on | |
12170 | integral types. | |
12171 | ||
12172 | @item ++@r{, }-- | |
12173 | Increment and decrement. When appearing before a variable, the | |
12174 | operation is performed before the variable is used in an expression; | |
12175 | when appearing after it, the variable's value is used before the | |
12176 | operation takes place. | |
12177 | ||
12178 | @item * | |
12179 | Pointer dereferencing. Defined on pointer types. Same precedence as | |
12180 | @code{++}. | |
12181 | ||
12182 | @item & | |
12183 | Address operator. Defined on variables. Same precedence as @code{++}. | |
12184 | ||
b37052ae EZ |
12185 | For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is |
12186 | allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})} | |
b17828ca | 12187 | to examine the address |
b37052ae | 12188 | where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is |
c906108c | 12189 | stored. |
c906108c SS |
12190 | |
12191 | @item - | |
12192 | Negative. Defined on integral and floating-point types. Same | |
12193 | precedence as @code{++}. | |
12194 | ||
12195 | @item ! | |
12196 | Logical negation. Defined on integral types. Same precedence as | |
12197 | @code{++}. | |
12198 | ||
12199 | @item ~ | |
12200 | Bitwise complement operator. Defined on integral types. Same precedence as | |
12201 | @code{++}. | |
12202 | ||
12203 | ||
12204 | @item .@r{, }-> | |
12205 | Structure member, and pointer-to-structure member. For convenience, | |
12206 | @value{GDBN} regards the two as equivalent, choosing whether to dereference a | |
12207 | pointer based on the stored type information. | |
12208 | Defined on @code{struct} and @code{union} data. | |
12209 | ||
c906108c SS |
12210 | @item .*@r{, }->* |
12211 | Dereferences of pointers to members. | |
c906108c SS |
12212 | |
12213 | @item [] | |
12214 | Array indexing. @code{@var{a}[@var{i}]} is defined as | |
12215 | @code{*(@var{a}+@var{i})}. Same precedence as @code{->}. | |
12216 | ||
12217 | @item () | |
12218 | Function parameter list. Same precedence as @code{->}. | |
12219 | ||
c906108c | 12220 | @item :: |
b37052ae | 12221 | C@t{++} scope resolution operator. Defined on @code{struct}, @code{union}, |
7a292a7a | 12222 | and @code{class} types. |
c906108c SS |
12223 | |
12224 | @item :: | |
7a292a7a SS |
12225 | Doubled colons also represent the @value{GDBN} scope operator |
12226 | (@pxref{Expressions, ,Expressions}). Same precedence as @code{::}, | |
12227 | above. | |
c906108c SS |
12228 | @end table |
12229 | ||
c906108c SS |
12230 | If an operator is redefined in the user code, @value{GDBN} usually |
12231 | attempts to invoke the redefined version instead of using the operator's | |
12232 | predefined meaning. | |
c906108c | 12233 | |
6d2ebf8b | 12234 | @node C Constants |
79a6e687 | 12235 | @subsubsection C and C@t{++} Constants |
c906108c | 12236 | |
b37052ae | 12237 | @cindex C and C@t{++} constants |
c906108c | 12238 | |
b37052ae | 12239 | @value{GDBN} allows you to express the constants of C and C@t{++} in the |
c906108c | 12240 | following ways: |
c906108c SS |
12241 | |
12242 | @itemize @bullet | |
12243 | @item | |
12244 | Integer constants are a sequence of digits. Octal constants are | |
6ca652b0 EZ |
12245 | specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants |
12246 | by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter | |
c906108c SS |
12247 | @samp{l}, specifying that the constant should be treated as a |
12248 | @code{long} value. | |
12249 | ||
12250 | @item | |
12251 | Floating point constants are a sequence of digits, followed by a decimal | |
12252 | point, followed by a sequence of digits, and optionally followed by an | |
12253 | exponent. An exponent is of the form: | |
12254 | @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another | |
12255 | sequence of digits. The @samp{+} is optional for positive exponents. | |
d4f3574e SS |
12256 | A floating-point constant may also end with a letter @samp{f} or |
12257 | @samp{F}, specifying that the constant should be treated as being of | |
12258 | the @code{float} (as opposed to the default @code{double}) type; or with | |
12259 | a letter @samp{l} or @samp{L}, which specifies a @code{long double} | |
12260 | constant. | |
c906108c SS |
12261 | |
12262 | @item | |
12263 | Enumerated constants consist of enumerated identifiers, or their | |
12264 | integral equivalents. | |
12265 | ||
12266 | @item | |
12267 | Character constants are a single character surrounded by single quotes | |
12268 | (@code{'}), or a number---the ordinal value of the corresponding character | |
d4f3574e | 12269 | (usually its @sc{ascii} value). Within quotes, the single character may |
c906108c SS |
12270 | be represented by a letter or by @dfn{escape sequences}, which are of |
12271 | the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation | |
12272 | of the character's ordinal value; or of the form @samp{\@var{x}}, where | |
12273 | @samp{@var{x}} is a predefined special character---for example, | |
12274 | @samp{\n} for newline. | |
12275 | ||
12276 | @item | |
96a2c332 SS |
12277 | String constants are a sequence of character constants surrounded by |
12278 | double quotes (@code{"}). Any valid character constant (as described | |
12279 | above) may appear. Double quotes within the string must be preceded by | |
12280 | a backslash, so for instance @samp{"a\"b'c"} is a string of five | |
12281 | characters. | |
c906108c SS |
12282 | |
12283 | @item | |
12284 | Pointer constants are an integral value. You can also write pointers | |
12285 | to constants using the C operator @samp{&}. | |
12286 | ||
12287 | @item | |
12288 | Array constants are comma-separated lists surrounded by braces @samp{@{} | |
12289 | and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of | |
12290 | integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array, | |
12291 | and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers. | |
12292 | @end itemize | |
12293 | ||
79a6e687 BW |
12294 | @node C Plus Plus Expressions |
12295 | @subsubsection C@t{++} Expressions | |
b37052ae EZ |
12296 | |
12297 | @cindex expressions in C@t{++} | |
12298 | @value{GDBN} expression handling can interpret most C@t{++} expressions. | |
12299 | ||
0179ffac DC |
12300 | @cindex debugging C@t{++} programs |
12301 | @cindex C@t{++} compilers | |
12302 | @cindex debug formats and C@t{++} | |
12303 | @cindex @value{NGCC} and C@t{++} | |
c906108c | 12304 | @quotation |
b37052ae | 12305 | @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use the |
0179ffac DC |
12306 | proper compiler and the proper debug format. Currently, @value{GDBN} |
12307 | works best when debugging C@t{++} code that is compiled with | |
12308 | @value{NGCC} 2.95.3 or with @value{NGCC} 3.1 or newer, using the options | |
12309 | @option{-gdwarf-2} or @option{-gstabs+}. DWARF 2 is preferred over | |
12310 | stabs+. Most configurations of @value{NGCC} emit either DWARF 2 or | |
12311 | stabs+ as their default debug format, so you usually don't need to | |
12312 | specify a debug format explicitly. Other compilers and/or debug formats | |
12313 | are likely to work badly or not at all when using @value{GDBN} to debug | |
12314 | C@t{++} code. | |
c906108c | 12315 | @end quotation |
c906108c SS |
12316 | |
12317 | @enumerate | |
12318 | ||
12319 | @cindex member functions | |
12320 | @item | |
12321 | Member function calls are allowed; you can use expressions like | |
12322 | ||
474c8240 | 12323 | @smallexample |
c906108c | 12324 | count = aml->GetOriginal(x, y) |
474c8240 | 12325 | @end smallexample |
c906108c | 12326 | |
41afff9a | 12327 | @vindex this@r{, inside C@t{++} member functions} |
b37052ae | 12328 | @cindex namespace in C@t{++} |
c906108c SS |
12329 | @item |
12330 | While a member function is active (in the selected stack frame), your | |
12331 | expressions have the same namespace available as the member function; | |
12332 | that is, @value{GDBN} allows implicit references to the class instance | |
b37052ae | 12333 | pointer @code{this} following the same rules as C@t{++}. |
c906108c | 12334 | |
c906108c | 12335 | @cindex call overloaded functions |
d4f3574e | 12336 | @cindex overloaded functions, calling |
b37052ae | 12337 | @cindex type conversions in C@t{++} |
c906108c SS |
12338 | @item |
12339 | You can call overloaded functions; @value{GDBN} resolves the function | |
d4f3574e | 12340 | call to the right definition, with some restrictions. @value{GDBN} does not |
c906108c SS |
12341 | perform overload resolution involving user-defined type conversions, |
12342 | calls to constructors, or instantiations of templates that do not exist | |
12343 | in the program. It also cannot handle ellipsis argument lists or | |
12344 | default arguments. | |
12345 | ||
12346 | It does perform integral conversions and promotions, floating-point | |
12347 | promotions, arithmetic conversions, pointer conversions, conversions of | |
12348 | class objects to base classes, and standard conversions such as those of | |
12349 | functions or arrays to pointers; it requires an exact match on the | |
12350 | number of function arguments. | |
12351 | ||
12352 | Overload resolution is always performed, unless you have specified | |
79a6e687 BW |
12353 | @code{set overload-resolution off}. @xref{Debugging C Plus Plus, |
12354 | ,@value{GDBN} Features for C@t{++}}. | |
c906108c | 12355 | |
d4f3574e | 12356 | You must specify @code{set overload-resolution off} in order to use an |
c906108c SS |
12357 | explicit function signature to call an overloaded function, as in |
12358 | @smallexample | |
12359 | p 'foo(char,int)'('x', 13) | |
12360 | @end smallexample | |
d4f3574e | 12361 | |
c906108c | 12362 | The @value{GDBN} command-completion facility can simplify this; |
79a6e687 | 12363 | see @ref{Completion, ,Command Completion}. |
c906108c | 12364 | |
c906108c SS |
12365 | @cindex reference declarations |
12366 | @item | |
b37052ae EZ |
12367 | @value{GDBN} understands variables declared as C@t{++} references; you can use |
12368 | them in expressions just as you do in C@t{++} source---they are automatically | |
c906108c SS |
12369 | dereferenced. |
12370 | ||
12371 | In the parameter list shown when @value{GDBN} displays a frame, the values of | |
12372 | reference variables are not displayed (unlike other variables); this | |
12373 | avoids clutter, since references are often used for large structures. | |
12374 | The @emph{address} of a reference variable is always shown, unless | |
12375 | you have specified @samp{set print address off}. | |
12376 | ||
12377 | @item | |
b37052ae | 12378 | @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your |
c906108c SS |
12379 | expressions can use it just as expressions in your program do. Since |
12380 | one scope may be defined in another, you can use @code{::} repeatedly if | |
12381 | necessary, for example in an expression like | |
12382 | @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows | |
b37052ae | 12383 | resolving name scope by reference to source files, in both C and C@t{++} |
79a6e687 | 12384 | debugging (@pxref{Variables, ,Program Variables}). |
c906108c SS |
12385 | @end enumerate |
12386 | ||
b37052ae | 12387 | In addition, when used with HP's C@t{++} compiler, @value{GDBN} supports |
53a5351d JM |
12388 | calling virtual functions correctly, printing out virtual bases of |
12389 | objects, calling functions in a base subobject, casting objects, and | |
12390 | invoking user-defined operators. | |
c906108c | 12391 | |
6d2ebf8b | 12392 | @node C Defaults |
79a6e687 | 12393 | @subsubsection C and C@t{++} Defaults |
7a292a7a | 12394 | |
b37052ae | 12395 | @cindex C and C@t{++} defaults |
c906108c | 12396 | |
c906108c SS |
12397 | If you allow @value{GDBN} to set type and range checking automatically, they |
12398 | both default to @code{off} whenever the working language changes to | |
b37052ae | 12399 | C or C@t{++}. This happens regardless of whether you or @value{GDBN} |
c906108c | 12400 | selects the working language. |
c906108c SS |
12401 | |
12402 | If you allow @value{GDBN} to set the language automatically, it | |
12403 | recognizes source files whose names end with @file{.c}, @file{.C}, or | |
12404 | @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of | |
b37052ae | 12405 | these files, it sets the working language to C or C@t{++}. |
79a6e687 | 12406 | @xref{Automatically, ,Having @value{GDBN} Infer the Source Language}, |
c906108c SS |
12407 | for further details. |
12408 | ||
c906108c SS |
12409 | @c Type checking is (a) primarily motivated by Modula-2, and (b) |
12410 | @c unimplemented. If (b) changes, it might make sense to let this node | |
12411 | @c appear even if Mod-2 does not, but meanwhile ignore it. roland 16jul93. | |
7a292a7a | 12412 | |
6d2ebf8b | 12413 | @node C Checks |
79a6e687 | 12414 | @subsubsection C and C@t{++} Type and Range Checks |
7a292a7a | 12415 | |
b37052ae | 12416 | @cindex C and C@t{++} checks |
c906108c | 12417 | |
b37052ae | 12418 | By default, when @value{GDBN} parses C or C@t{++} expressions, type checking |
c906108c SS |
12419 | is not used. However, if you turn type checking on, @value{GDBN} |
12420 | considers two variables type equivalent if: | |
12421 | ||
12422 | @itemize @bullet | |
12423 | @item | |
12424 | The two variables are structured and have the same structure, union, or | |
12425 | enumerated tag. | |
12426 | ||
12427 | @item | |
12428 | The two variables have the same type name, or types that have been | |
12429 | declared equivalent through @code{typedef}. | |
12430 | ||
12431 | @ignore | |
12432 | @c leaving this out because neither J Gilmore nor R Pesch understand it. | |
12433 | @c FIXME--beers? | |
12434 | @item | |
12435 | The two @code{struct}, @code{union}, or @code{enum} variables are | |
12436 | declared in the same declaration. (Note: this may not be true for all C | |
12437 | compilers.) | |
12438 | @end ignore | |
12439 | @end itemize | |
12440 | ||
12441 | Range checking, if turned on, is done on mathematical operations. Array | |
12442 | indices are not checked, since they are often used to index a pointer | |
12443 | that is not itself an array. | |
c906108c | 12444 | |
6d2ebf8b | 12445 | @node Debugging C |
c906108c | 12446 | @subsubsection @value{GDBN} and C |
c906108c SS |
12447 | |
12448 | The @code{set print union} and @code{show print union} commands apply to | |
12449 | the @code{union} type. When set to @samp{on}, any @code{union} that is | |
7a292a7a SS |
12450 | inside a @code{struct} or @code{class} is also printed. Otherwise, it |
12451 | appears as @samp{@{...@}}. | |
c906108c SS |
12452 | |
12453 | The @code{@@} operator aids in the debugging of dynamic arrays, formed | |
12454 | with pointers and a memory allocation function. @xref{Expressions, | |
12455 | ,Expressions}. | |
12456 | ||
79a6e687 BW |
12457 | @node Debugging C Plus Plus |
12458 | @subsubsection @value{GDBN} Features for C@t{++} | |
c906108c | 12459 | |
b37052ae | 12460 | @cindex commands for C@t{++} |
7a292a7a | 12461 | |
b37052ae EZ |
12462 | Some @value{GDBN} commands are particularly useful with C@t{++}, and some are |
12463 | designed specifically for use with C@t{++}. Here is a summary: | |
c906108c SS |
12464 | |
12465 | @table @code | |
12466 | @cindex break in overloaded functions | |
12467 | @item @r{breakpoint menus} | |
12468 | When you want a breakpoint in a function whose name is overloaded, | |
6ba66d6a JB |
12469 | @value{GDBN} has the capability to display a menu of possible breakpoint |
12470 | locations to help you specify which function definition you want. | |
12471 | @xref{Ambiguous Expressions,,Ambiguous Expressions}. | |
c906108c | 12472 | |
b37052ae | 12473 | @cindex overloading in C@t{++} |
c906108c SS |
12474 | @item rbreak @var{regex} |
12475 | Setting breakpoints using regular expressions is helpful for setting | |
12476 | breakpoints on overloaded functions that are not members of any special | |
12477 | classes. | |
79a6e687 | 12478 | @xref{Set Breaks, ,Setting Breakpoints}. |
c906108c | 12479 | |
b37052ae | 12480 | @cindex C@t{++} exception handling |
c906108c SS |
12481 | @item catch throw |
12482 | @itemx catch catch | |
b37052ae | 12483 | Debug C@t{++} exception handling using these commands. @xref{Set |
79a6e687 | 12484 | Catchpoints, , Setting Catchpoints}. |
c906108c SS |
12485 | |
12486 | @cindex inheritance | |
12487 | @item ptype @var{typename} | |
12488 | Print inheritance relationships as well as other information for type | |
12489 | @var{typename}. | |
12490 | @xref{Symbols, ,Examining the Symbol Table}. | |
12491 | ||
b37052ae | 12492 | @cindex C@t{++} symbol display |
c906108c SS |
12493 | @item set print demangle |
12494 | @itemx show print demangle | |
12495 | @itemx set print asm-demangle | |
12496 | @itemx show print asm-demangle | |
b37052ae EZ |
12497 | Control whether C@t{++} symbols display in their source form, both when |
12498 | displaying code as C@t{++} source and when displaying disassemblies. | |
79a6e687 | 12499 | @xref{Print Settings, ,Print Settings}. |
c906108c SS |
12500 | |
12501 | @item set print object | |
12502 | @itemx show print object | |
12503 | Choose whether to print derived (actual) or declared types of objects. | |
79a6e687 | 12504 | @xref{Print Settings, ,Print Settings}. |
c906108c SS |
12505 | |
12506 | @item set print vtbl | |
12507 | @itemx show print vtbl | |
12508 | Control the format for printing virtual function tables. | |
79a6e687 | 12509 | @xref{Print Settings, ,Print Settings}. |
c906108c | 12510 | (The @code{vtbl} commands do not work on programs compiled with the HP |
b37052ae | 12511 | ANSI C@t{++} compiler (@code{aCC}).) |
c906108c SS |
12512 | |
12513 | @kindex set overload-resolution | |
d4f3574e | 12514 | @cindex overloaded functions, overload resolution |
c906108c | 12515 | @item set overload-resolution on |
b37052ae | 12516 | Enable overload resolution for C@t{++} expression evaluation. The default |
c906108c SS |
12517 | is on. For overloaded functions, @value{GDBN} evaluates the arguments |
12518 | and searches for a function whose signature matches the argument types, | |
79a6e687 BW |
12519 | using the standard C@t{++} conversion rules (see @ref{C Plus Plus |
12520 | Expressions, ,C@t{++} Expressions}, for details). | |
12521 | If it cannot find a match, it emits a message. | |
c906108c SS |
12522 | |
12523 | @item set overload-resolution off | |
b37052ae | 12524 | Disable overload resolution for C@t{++} expression evaluation. For |
c906108c SS |
12525 | overloaded functions that are not class member functions, @value{GDBN} |
12526 | chooses the first function of the specified name that it finds in the | |
12527 | symbol table, whether or not its arguments are of the correct type. For | |
12528 | overloaded functions that are class member functions, @value{GDBN} | |
12529 | searches for a function whose signature @emph{exactly} matches the | |
12530 | argument types. | |
c906108c | 12531 | |
9c16f35a EZ |
12532 | @kindex show overload-resolution |
12533 | @item show overload-resolution | |
12534 | Show the current setting of overload resolution. | |
12535 | ||
c906108c SS |
12536 | @item @r{Overloaded symbol names} |
12537 | You can specify a particular definition of an overloaded symbol, using | |
b37052ae | 12538 | the same notation that is used to declare such symbols in C@t{++}: type |
c906108c SS |
12539 | @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can |
12540 | also use the @value{GDBN} command-line word completion facilities to list the | |
12541 | available choices, or to finish the type list for you. | |
79a6e687 | 12542 | @xref{Completion,, Command Completion}, for details on how to do this. |
c906108c | 12543 | @end table |
c906108c | 12544 | |
febe4383 TJB |
12545 | @node Decimal Floating Point |
12546 | @subsubsection Decimal Floating Point format | |
12547 | @cindex decimal floating point format | |
12548 | ||
12549 | @value{GDBN} can examine, set and perform computations with numbers in | |
12550 | decimal floating point format, which in the C language correspond to the | |
12551 | @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as | |
12552 | specified by the extension to support decimal floating-point arithmetic. | |
12553 | ||
12554 | There are two encodings in use, depending on the architecture: BID (Binary | |
12555 | Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for | |
99e008fe | 12556 | PowerPC. @value{GDBN} will use the appropriate encoding for the configured |
febe4383 TJB |
12557 | target. |
12558 | ||
12559 | Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN} | |
12560 | to manipulate decimal floating point numbers, it is not possible to convert | |
12561 | (using a cast, for example) integers wider than 32-bit to decimal float. | |
12562 | ||
12563 | In addition, in order to imitate @value{GDBN}'s behaviour with binary floating | |
12564 | point computations, error checking in decimal float operations ignores | |
12565 | underflow, overflow and divide by zero exceptions. | |
12566 | ||
4acd40f3 | 12567 | In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers |
99e008fe EZ |
12568 | to inspect @code{_Decimal128} values stored in floating point registers. |
12569 | See @ref{PowerPC,,PowerPC} for more details. | |
4acd40f3 | 12570 | |
6aecb9c2 JB |
12571 | @node D |
12572 | @subsection D | |
12573 | ||
12574 | @cindex D | |
12575 | @value{GDBN} can be used to debug programs written in D and compiled with | |
12576 | GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D | |
12577 | specific feature --- dynamic arrays. | |
12578 | ||
b37303ee AF |
12579 | @node Objective-C |
12580 | @subsection Objective-C | |
12581 | ||
12582 | @cindex Objective-C | |
12583 | This section provides information about some commands and command | |
721c2651 EZ |
12584 | options that are useful for debugging Objective-C code. See also |
12585 | @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a | |
12586 | few more commands specific to Objective-C support. | |
b37303ee AF |
12587 | |
12588 | @menu | |
b383017d RM |
12589 | * Method Names in Commands:: |
12590 | * The Print Command with Objective-C:: | |
b37303ee AF |
12591 | @end menu |
12592 | ||
c8f4133a | 12593 | @node Method Names in Commands |
b37303ee AF |
12594 | @subsubsection Method Names in Commands |
12595 | ||
12596 | The following commands have been extended to accept Objective-C method | |
12597 | names as line specifications: | |
12598 | ||
12599 | @kindex clear@r{, and Objective-C} | |
12600 | @kindex break@r{, and Objective-C} | |
12601 | @kindex info line@r{, and Objective-C} | |
12602 | @kindex jump@r{, and Objective-C} | |
12603 | @kindex list@r{, and Objective-C} | |
12604 | @itemize | |
12605 | @item @code{clear} | |
12606 | @item @code{break} | |
12607 | @item @code{info line} | |
12608 | @item @code{jump} | |
12609 | @item @code{list} | |
12610 | @end itemize | |
12611 | ||
12612 | A fully qualified Objective-C method name is specified as | |
12613 | ||
12614 | @smallexample | |
12615 | -[@var{Class} @var{methodName}] | |
12616 | @end smallexample | |
12617 | ||
c552b3bb JM |
12618 | where the minus sign is used to indicate an instance method and a |
12619 | plus sign (not shown) is used to indicate a class method. The class | |
12620 | name @var{Class} and method name @var{methodName} are enclosed in | |
12621 | brackets, similar to the way messages are specified in Objective-C | |
12622 | source code. For example, to set a breakpoint at the @code{create} | |
12623 | instance method of class @code{Fruit} in the program currently being | |
12624 | debugged, enter: | |
b37303ee AF |
12625 | |
12626 | @smallexample | |
12627 | break -[Fruit create] | |
12628 | @end smallexample | |
12629 | ||
12630 | To list ten program lines around the @code{initialize} class method, | |
12631 | enter: | |
12632 | ||
12633 | @smallexample | |
12634 | list +[NSText initialize] | |
12635 | @end smallexample | |
12636 | ||
c552b3bb JM |
12637 | In the current version of @value{GDBN}, the plus or minus sign is |
12638 | required. In future versions of @value{GDBN}, the plus or minus | |
12639 | sign will be optional, but you can use it to narrow the search. It | |
12640 | is also possible to specify just a method name: | |
b37303ee AF |
12641 | |
12642 | @smallexample | |
12643 | break create | |
12644 | @end smallexample | |
12645 | ||
12646 | You must specify the complete method name, including any colons. If | |
12647 | your program's source files contain more than one @code{create} method, | |
12648 | you'll be presented with a numbered list of classes that implement that | |
12649 | method. Indicate your choice by number, or type @samp{0} to exit if | |
12650 | none apply. | |
12651 | ||
12652 | As another example, to clear a breakpoint established at the | |
12653 | @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter: | |
12654 | ||
12655 | @smallexample | |
12656 | clear -[NSWindow makeKeyAndOrderFront:] | |
12657 | @end smallexample | |
12658 | ||
12659 | @node The Print Command with Objective-C | |
12660 | @subsubsection The Print Command With Objective-C | |
721c2651 | 12661 | @cindex Objective-C, print objects |
c552b3bb JM |
12662 | @kindex print-object |
12663 | @kindex po @r{(@code{print-object})} | |
b37303ee | 12664 | |
c552b3bb | 12665 | The print command has also been extended to accept methods. For example: |
b37303ee AF |
12666 | |
12667 | @smallexample | |
c552b3bb | 12668 | print -[@var{object} hash] |
b37303ee AF |
12669 | @end smallexample |
12670 | ||
12671 | @cindex print an Objective-C object description | |
c552b3bb JM |
12672 | @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects |
12673 | @noindent | |
12674 | will tell @value{GDBN} to send the @code{hash} message to @var{object} | |
12675 | and print the result. Also, an additional command has been added, | |
12676 | @code{print-object} or @code{po} for short, which is meant to print | |
12677 | the description of an object. However, this command may only work | |
12678 | with certain Objective-C libraries that have a particular hook | |
12679 | function, @code{_NSPrintForDebugger}, defined. | |
b37303ee | 12680 | |
f4b8a18d KW |
12681 | @node OpenCL C |
12682 | @subsection OpenCL C | |
12683 | ||
12684 | @cindex OpenCL C | |
12685 | This section provides information about @value{GDBN}s OpenCL C support. | |
12686 | ||
12687 | @menu | |
12688 | * OpenCL C Datatypes:: | |
12689 | * OpenCL C Expressions:: | |
12690 | * OpenCL C Operators:: | |
12691 | @end menu | |
12692 | ||
12693 | @node OpenCL C Datatypes | |
12694 | @subsubsection OpenCL C Datatypes | |
12695 | ||
12696 | @cindex OpenCL C Datatypes | |
12697 | @value{GDBN} supports the builtin scalar and vector datatypes specified | |
12698 | by OpenCL 1.1. In addition the half- and double-precision floating point | |
12699 | data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL | |
12700 | extensions are also known to @value{GDBN}. | |
12701 | ||
12702 | @node OpenCL C Expressions | |
12703 | @subsubsection OpenCL C Expressions | |
12704 | ||
12705 | @cindex OpenCL C Expressions | |
12706 | @value{GDBN} supports accesses to vector components including the access as | |
12707 | lvalue where possible. Since OpenCL C is based on C99 most C expressions | |
12708 | supported by @value{GDBN} can be used as well. | |
12709 | ||
12710 | @node OpenCL C Operators | |
12711 | @subsubsection OpenCL C Operators | |
12712 | ||
12713 | @cindex OpenCL C Operators | |
12714 | @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and | |
12715 | vector data types. | |
12716 | ||
09d4efe1 EZ |
12717 | @node Fortran |
12718 | @subsection Fortran | |
12719 | @cindex Fortran-specific support in @value{GDBN} | |
12720 | ||
814e32d7 WZ |
12721 | @value{GDBN} can be used to debug programs written in Fortran, but it |
12722 | currently supports only the features of Fortran 77 language. | |
12723 | ||
12724 | @cindex trailing underscore, in Fortran symbols | |
12725 | Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers | |
12726 | among them) append an underscore to the names of variables and | |
12727 | functions. When you debug programs compiled by those compilers, you | |
12728 | will need to refer to variables and functions with a trailing | |
12729 | underscore. | |
12730 | ||
12731 | @menu | |
12732 | * Fortran Operators:: Fortran operators and expressions | |
12733 | * Fortran Defaults:: Default settings for Fortran | |
79a6e687 | 12734 | * Special Fortran Commands:: Special @value{GDBN} commands for Fortran |
814e32d7 WZ |
12735 | @end menu |
12736 | ||
12737 | @node Fortran Operators | |
79a6e687 | 12738 | @subsubsection Fortran Operators and Expressions |
814e32d7 WZ |
12739 | |
12740 | @cindex Fortran operators and expressions | |
12741 | ||
12742 | Operators must be defined on values of specific types. For instance, | |
12743 | @code{+} is defined on numbers, but not on characters or other non- | |
ff2587ec | 12744 | arithmetic types. Operators are often defined on groups of types. |
814e32d7 WZ |
12745 | |
12746 | @table @code | |
12747 | @item ** | |
99e008fe | 12748 | The exponentiation operator. It raises the first operand to the power |
814e32d7 WZ |
12749 | of the second one. |
12750 | ||
12751 | @item : | |
12752 | The range operator. Normally used in the form of array(low:high) to | |
12753 | represent a section of array. | |
68837c9d MD |
12754 | |
12755 | @item % | |
12756 | The access component operator. Normally used to access elements in derived | |
12757 | types. Also suitable for unions. As unions aren't part of regular Fortran, | |
12758 | this can only happen when accessing a register that uses a gdbarch-defined | |
12759 | union type. | |
814e32d7 WZ |
12760 | @end table |
12761 | ||
12762 | @node Fortran Defaults | |
12763 | @subsubsection Fortran Defaults | |
12764 | ||
12765 | @cindex Fortran Defaults | |
12766 | ||
12767 | Fortran symbols are usually case-insensitive, so @value{GDBN} by | |
12768 | default uses case-insensitive matches for Fortran symbols. You can | |
12769 | change that with the @samp{set case-insensitive} command, see | |
12770 | @ref{Symbols}, for the details. | |
12771 | ||
79a6e687 BW |
12772 | @node Special Fortran Commands |
12773 | @subsubsection Special Fortran Commands | |
814e32d7 WZ |
12774 | |
12775 | @cindex Special Fortran commands | |
12776 | ||
db2e3e2e BW |
12777 | @value{GDBN} has some commands to support Fortran-specific features, |
12778 | such as displaying common blocks. | |
814e32d7 | 12779 | |
09d4efe1 EZ |
12780 | @table @code |
12781 | @cindex @code{COMMON} blocks, Fortran | |
12782 | @kindex info common | |
12783 | @item info common @r{[}@var{common-name}@r{]} | |
12784 | This command prints the values contained in the Fortran @code{COMMON} | |
12785 | block whose name is @var{common-name}. With no argument, the names of | |
d52fb0e9 | 12786 | all @code{COMMON} blocks visible at the current program location are |
09d4efe1 EZ |
12787 | printed. |
12788 | @end table | |
12789 | ||
9c16f35a EZ |
12790 | @node Pascal |
12791 | @subsection Pascal | |
12792 | ||
12793 | @cindex Pascal support in @value{GDBN}, limitations | |
12794 | Debugging Pascal programs which use sets, subranges, file variables, or | |
12795 | nested functions does not currently work. @value{GDBN} does not support | |
12796 | entering expressions, printing values, or similar features using Pascal | |
12797 | syntax. | |
12798 | ||
12799 | The Pascal-specific command @code{set print pascal_static-members} | |
12800 | controls whether static members of Pascal objects are displayed. | |
12801 | @xref{Print Settings, pascal_static-members}. | |
12802 | ||
09d4efe1 | 12803 | @node Modula-2 |
c906108c | 12804 | @subsection Modula-2 |
7a292a7a | 12805 | |
d4f3574e | 12806 | @cindex Modula-2, @value{GDBN} support |
c906108c SS |
12807 | |
12808 | The extensions made to @value{GDBN} to support Modula-2 only support | |
12809 | output from the @sc{gnu} Modula-2 compiler (which is currently being | |
12810 | developed). Other Modula-2 compilers are not currently supported, and | |
12811 | attempting to debug executables produced by them is most likely | |
12812 | to give an error as @value{GDBN} reads in the executable's symbol | |
12813 | table. | |
12814 | ||
12815 | @cindex expressions in Modula-2 | |
12816 | @menu | |
12817 | * M2 Operators:: Built-in operators | |
12818 | * Built-In Func/Proc:: Built-in functions and procedures | |
12819 | * M2 Constants:: Modula-2 constants | |
72019c9c | 12820 | * M2 Types:: Modula-2 types |
c906108c SS |
12821 | * M2 Defaults:: Default settings for Modula-2 |
12822 | * Deviations:: Deviations from standard Modula-2 | |
12823 | * M2 Checks:: Modula-2 type and range checks | |
12824 | * M2 Scope:: The scope operators @code{::} and @code{.} | |
12825 | * GDB/M2:: @value{GDBN} and Modula-2 | |
12826 | @end menu | |
12827 | ||
6d2ebf8b | 12828 | @node M2 Operators |
c906108c SS |
12829 | @subsubsection Operators |
12830 | @cindex Modula-2 operators | |
12831 | ||
12832 | Operators must be defined on values of specific types. For instance, | |
12833 | @code{+} is defined on numbers, but not on structures. Operators are | |
12834 | often defined on groups of types. For the purposes of Modula-2, the | |
12835 | following definitions hold: | |
12836 | ||
12837 | @itemize @bullet | |
12838 | ||
12839 | @item | |
12840 | @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and | |
12841 | their subranges. | |
12842 | ||
12843 | @item | |
12844 | @emph{Character types} consist of @code{CHAR} and its subranges. | |
12845 | ||
12846 | @item | |
12847 | @emph{Floating-point types} consist of @code{REAL}. | |
12848 | ||
12849 | @item | |
12850 | @emph{Pointer types} consist of anything declared as @code{POINTER TO | |
12851 | @var{type}}. | |
12852 | ||
12853 | @item | |
12854 | @emph{Scalar types} consist of all of the above. | |
12855 | ||
12856 | @item | |
12857 | @emph{Set types} consist of @code{SET} and @code{BITSET} types. | |
12858 | ||
12859 | @item | |
12860 | @emph{Boolean types} consist of @code{BOOLEAN}. | |
12861 | @end itemize | |
12862 | ||
12863 | @noindent | |
12864 | The following operators are supported, and appear in order of | |
12865 | increasing precedence: | |
12866 | ||
12867 | @table @code | |
12868 | @item , | |
12869 | Function argument or array index separator. | |
12870 | ||
12871 | @item := | |
12872 | Assignment. The value of @var{var} @code{:=} @var{value} is | |
12873 | @var{value}. | |
12874 | ||
12875 | @item <@r{, }> | |
12876 | Less than, greater than on integral, floating-point, or enumerated | |
12877 | types. | |
12878 | ||
12879 | @item <=@r{, }>= | |
96a2c332 | 12880 | Less than or equal to, greater than or equal to |
c906108c SS |
12881 | on integral, floating-point and enumerated types, or set inclusion on |
12882 | set types. Same precedence as @code{<}. | |
12883 | ||
12884 | @item =@r{, }<>@r{, }# | |
12885 | Equality and two ways of expressing inequality, valid on scalar types. | |
12886 | Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is | |
12887 | available for inequality, since @code{#} conflicts with the script | |
12888 | comment character. | |
12889 | ||
12890 | @item IN | |
12891 | Set membership. Defined on set types and the types of their members. | |
12892 | Same precedence as @code{<}. | |
12893 | ||
12894 | @item OR | |
12895 | Boolean disjunction. Defined on boolean types. | |
12896 | ||
12897 | @item AND@r{, }& | |
d4f3574e | 12898 | Boolean conjunction. Defined on boolean types. |
c906108c SS |
12899 | |
12900 | @item @@ | |
12901 | The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}). | |
12902 | ||
12903 | @item +@r{, }- | |
12904 | Addition and subtraction on integral and floating-point types, or union | |
12905 | and difference on set types. | |
12906 | ||
12907 | @item * | |
12908 | Multiplication on integral and floating-point types, or set intersection | |
12909 | on set types. | |
12910 | ||
12911 | @item / | |
12912 | Division on floating-point types, or symmetric set difference on set | |
12913 | types. Same precedence as @code{*}. | |
12914 | ||
12915 | @item DIV@r{, }MOD | |
12916 | Integer division and remainder. Defined on integral types. Same | |
12917 | precedence as @code{*}. | |
12918 | ||
12919 | @item - | |
99e008fe | 12920 | Negative. Defined on @code{INTEGER} and @code{REAL} data. |
c906108c SS |
12921 | |
12922 | @item ^ | |
12923 | Pointer dereferencing. Defined on pointer types. | |
12924 | ||
12925 | @item NOT | |
12926 | Boolean negation. Defined on boolean types. Same precedence as | |
12927 | @code{^}. | |
12928 | ||
12929 | @item . | |
12930 | @code{RECORD} field selector. Defined on @code{RECORD} data. Same | |
12931 | precedence as @code{^}. | |
12932 | ||
12933 | @item [] | |
12934 | Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}. | |
12935 | ||
12936 | @item () | |
12937 | Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence | |
12938 | as @code{^}. | |
12939 | ||
12940 | @item ::@r{, }. | |
12941 | @value{GDBN} and Modula-2 scope operators. | |
12942 | @end table | |
12943 | ||
12944 | @quotation | |
72019c9c | 12945 | @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN} |
c906108c SS |
12946 | treats the use of the operator @code{IN}, or the use of operators |
12947 | @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#}, | |
12948 | @code{<=}, and @code{>=} on sets as an error. | |
12949 | @end quotation | |
12950 | ||
cb51c4e0 | 12951 | |
6d2ebf8b | 12952 | @node Built-In Func/Proc |
79a6e687 | 12953 | @subsubsection Built-in Functions and Procedures |
cb51c4e0 | 12954 | @cindex Modula-2 built-ins |
c906108c SS |
12955 | |
12956 | Modula-2 also makes available several built-in procedures and functions. | |
12957 | In describing these, the following metavariables are used: | |
12958 | ||
12959 | @table @var | |
12960 | ||
12961 | @item a | |
12962 | represents an @code{ARRAY} variable. | |
12963 | ||
12964 | @item c | |
12965 | represents a @code{CHAR} constant or variable. | |
12966 | ||
12967 | @item i | |
12968 | represents a variable or constant of integral type. | |
12969 | ||
12970 | @item m | |
12971 | represents an identifier that belongs to a set. Generally used in the | |
12972 | same function with the metavariable @var{s}. The type of @var{s} should | |
12973 | be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}). | |
12974 | ||
12975 | @item n | |
12976 | represents a variable or constant of integral or floating-point type. | |
12977 | ||
12978 | @item r | |
12979 | represents a variable or constant of floating-point type. | |
12980 | ||
12981 | @item t | |
12982 | represents a type. | |
12983 | ||
12984 | @item v | |
12985 | represents a variable. | |
12986 | ||
12987 | @item x | |
12988 | represents a variable or constant of one of many types. See the | |
12989 | explanation of the function for details. | |
12990 | @end table | |
12991 | ||
12992 | All Modula-2 built-in procedures also return a result, described below. | |
12993 | ||
12994 | @table @code | |
12995 | @item ABS(@var{n}) | |
12996 | Returns the absolute value of @var{n}. | |
12997 | ||
12998 | @item CAP(@var{c}) | |
12999 | If @var{c} is a lower case letter, it returns its upper case | |
c3f6f71d | 13000 | equivalent, otherwise it returns its argument. |
c906108c SS |
13001 | |
13002 | @item CHR(@var{i}) | |
13003 | Returns the character whose ordinal value is @var{i}. | |
13004 | ||
13005 | @item DEC(@var{v}) | |
c3f6f71d | 13006 | Decrements the value in the variable @var{v} by one. Returns the new value. |
c906108c SS |
13007 | |
13008 | @item DEC(@var{v},@var{i}) | |
13009 | Decrements the value in the variable @var{v} by @var{i}. Returns the | |
13010 | new value. | |
13011 | ||
13012 | @item EXCL(@var{m},@var{s}) | |
13013 | Removes the element @var{m} from the set @var{s}. Returns the new | |
13014 | set. | |
13015 | ||
13016 | @item FLOAT(@var{i}) | |
13017 | Returns the floating point equivalent of the integer @var{i}. | |
13018 | ||
13019 | @item HIGH(@var{a}) | |
13020 | Returns the index of the last member of @var{a}. | |
13021 | ||
13022 | @item INC(@var{v}) | |
c3f6f71d | 13023 | Increments the value in the variable @var{v} by one. Returns the new value. |
c906108c SS |
13024 | |
13025 | @item INC(@var{v},@var{i}) | |
13026 | Increments the value in the variable @var{v} by @var{i}. Returns the | |
13027 | new value. | |
13028 | ||
13029 | @item INCL(@var{m},@var{s}) | |
13030 | Adds the element @var{m} to the set @var{s} if it is not already | |
13031 | there. Returns the new set. | |
13032 | ||
13033 | @item MAX(@var{t}) | |
13034 | Returns the maximum value of the type @var{t}. | |
13035 | ||
13036 | @item MIN(@var{t}) | |
13037 | Returns the minimum value of the type @var{t}. | |
13038 | ||
13039 | @item ODD(@var{i}) | |
13040 | Returns boolean TRUE if @var{i} is an odd number. | |
13041 | ||
13042 | @item ORD(@var{x}) | |
13043 | Returns the ordinal value of its argument. For example, the ordinal | |
c3f6f71d JM |
13044 | value of a character is its @sc{ascii} value (on machines supporting the |
13045 | @sc{ascii} character set). @var{x} must be of an ordered type, which include | |
c906108c SS |
13046 | integral, character and enumerated types. |
13047 | ||
13048 | @item SIZE(@var{x}) | |
13049 | Returns the size of its argument. @var{x} can be a variable or a type. | |
13050 | ||
13051 | @item TRUNC(@var{r}) | |
13052 | Returns the integral part of @var{r}. | |
13053 | ||
844781a1 GM |
13054 | @item TSIZE(@var{x}) |
13055 | Returns the size of its argument. @var{x} can be a variable or a type. | |
13056 | ||
c906108c SS |
13057 | @item VAL(@var{t},@var{i}) |
13058 | Returns the member of the type @var{t} whose ordinal value is @var{i}. | |
13059 | @end table | |
13060 | ||
13061 | @quotation | |
13062 | @emph{Warning:} Sets and their operations are not yet supported, so | |
13063 | @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as | |
13064 | an error. | |
13065 | @end quotation | |
13066 | ||
13067 | @cindex Modula-2 constants | |
6d2ebf8b | 13068 | @node M2 Constants |
c906108c SS |
13069 | @subsubsection Constants |
13070 | ||
13071 | @value{GDBN} allows you to express the constants of Modula-2 in the following | |
13072 | ways: | |
13073 | ||
13074 | @itemize @bullet | |
13075 | ||
13076 | @item | |
13077 | Integer constants are simply a sequence of digits. When used in an | |
13078 | expression, a constant is interpreted to be type-compatible with the | |
13079 | rest of the expression. Hexadecimal integers are specified by a | |
13080 | trailing @samp{H}, and octal integers by a trailing @samp{B}. | |
13081 | ||
13082 | @item | |
13083 | Floating point constants appear as a sequence of digits, followed by a | |
13084 | decimal point and another sequence of digits. An optional exponent can | |
13085 | then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where | |
13086 | @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the | |
13087 | digits of the floating point constant must be valid decimal (base 10) | |
13088 | digits. | |
13089 | ||
13090 | @item | |
13091 | Character constants consist of a single character enclosed by a pair of | |
13092 | like quotes, either single (@code{'}) or double (@code{"}). They may | |
c3f6f71d | 13093 | also be expressed by their ordinal value (their @sc{ascii} value, usually) |
c906108c SS |
13094 | followed by a @samp{C}. |
13095 | ||
13096 | @item | |
13097 | String constants consist of a sequence of characters enclosed by a | |
13098 | pair of like quotes, either single (@code{'}) or double (@code{"}). | |
13099 | Escape sequences in the style of C are also allowed. @xref{C | |
79a6e687 | 13100 | Constants, ,C and C@t{++} Constants}, for a brief explanation of escape |
c906108c SS |
13101 | sequences. |
13102 | ||
13103 | @item | |
13104 | Enumerated constants consist of an enumerated identifier. | |
13105 | ||
13106 | @item | |
13107 | Boolean constants consist of the identifiers @code{TRUE} and | |
13108 | @code{FALSE}. | |
13109 | ||
13110 | @item | |
13111 | Pointer constants consist of integral values only. | |
13112 | ||
13113 | @item | |
13114 | Set constants are not yet supported. | |
13115 | @end itemize | |
13116 | ||
72019c9c GM |
13117 | @node M2 Types |
13118 | @subsubsection Modula-2 Types | |
13119 | @cindex Modula-2 types | |
13120 | ||
13121 | Currently @value{GDBN} can print the following data types in Modula-2 | |
13122 | syntax: array types, record types, set types, pointer types, procedure | |
13123 | types, enumerated types, subrange types and base types. You can also | |
13124 | print the contents of variables declared using these type. | |
13125 | This section gives a number of simple source code examples together with | |
13126 | sample @value{GDBN} sessions. | |
13127 | ||
13128 | The first example contains the following section of code: | |
13129 | ||
13130 | @smallexample | |
13131 | VAR | |
13132 | s: SET OF CHAR ; | |
13133 | r: [20..40] ; | |
13134 | @end smallexample | |
13135 | ||
13136 | @noindent | |
13137 | and you can request @value{GDBN} to interrogate the type and value of | |
13138 | @code{r} and @code{s}. | |
13139 | ||
13140 | @smallexample | |
13141 | (@value{GDBP}) print s | |
13142 | @{'A'..'C', 'Z'@} | |
13143 | (@value{GDBP}) ptype s | |
13144 | SET OF CHAR | |
13145 | (@value{GDBP}) print r | |
13146 | 21 | |
13147 | (@value{GDBP}) ptype r | |
13148 | [20..40] | |
13149 | @end smallexample | |
13150 | ||
13151 | @noindent | |
13152 | Likewise if your source code declares @code{s} as: | |
13153 | ||
13154 | @smallexample | |
13155 | VAR | |
13156 | s: SET ['A'..'Z'] ; | |
13157 | @end smallexample | |
13158 | ||
13159 | @noindent | |
13160 | then you may query the type of @code{s} by: | |
13161 | ||
13162 | @smallexample | |
13163 | (@value{GDBP}) ptype s | |
13164 | type = SET ['A'..'Z'] | |
13165 | @end smallexample | |
13166 | ||
13167 | @noindent | |
13168 | Note that at present you cannot interactively manipulate set | |
13169 | expressions using the debugger. | |
13170 | ||
13171 | The following example shows how you might declare an array in Modula-2 | |
13172 | and how you can interact with @value{GDBN} to print its type and contents: | |
13173 | ||
13174 | @smallexample | |
13175 | VAR | |
13176 | s: ARRAY [-10..10] OF CHAR ; | |
13177 | @end smallexample | |
13178 | ||
13179 | @smallexample | |
13180 | (@value{GDBP}) ptype s | |
13181 | ARRAY [-10..10] OF CHAR | |
13182 | @end smallexample | |
13183 | ||
13184 | Note that the array handling is not yet complete and although the type | |
13185 | is printed correctly, expression handling still assumes that all | |
13186 | arrays have a lower bound of zero and not @code{-10} as in the example | |
844781a1 | 13187 | above. |
72019c9c GM |
13188 | |
13189 | Here are some more type related Modula-2 examples: | |
13190 | ||
13191 | @smallexample | |
13192 | TYPE | |
13193 | colour = (blue, red, yellow, green) ; | |
13194 | t = [blue..yellow] ; | |
13195 | VAR | |
13196 | s: t ; | |
13197 | BEGIN | |
13198 | s := blue ; | |
13199 | @end smallexample | |
13200 | ||
13201 | @noindent | |
13202 | The @value{GDBN} interaction shows how you can query the data type | |
13203 | and value of a variable. | |
13204 | ||
13205 | @smallexample | |
13206 | (@value{GDBP}) print s | |
13207 | $1 = blue | |
13208 | (@value{GDBP}) ptype t | |
13209 | type = [blue..yellow] | |
13210 | @end smallexample | |
13211 | ||
13212 | @noindent | |
13213 | In this example a Modula-2 array is declared and its contents | |
13214 | displayed. Observe that the contents are written in the same way as | |
13215 | their @code{C} counterparts. | |
13216 | ||
13217 | @smallexample | |
13218 | VAR | |
13219 | s: ARRAY [1..5] OF CARDINAL ; | |
13220 | BEGIN | |
13221 | s[1] := 1 ; | |
13222 | @end smallexample | |
13223 | ||
13224 | @smallexample | |
13225 | (@value{GDBP}) print s | |
13226 | $1 = @{1, 0, 0, 0, 0@} | |
13227 | (@value{GDBP}) ptype s | |
13228 | type = ARRAY [1..5] OF CARDINAL | |
13229 | @end smallexample | |
13230 | ||
13231 | The Modula-2 language interface to @value{GDBN} also understands | |
13232 | pointer types as shown in this example: | |
13233 | ||
13234 | @smallexample | |
13235 | VAR | |
13236 | s: POINTER TO ARRAY [1..5] OF CARDINAL ; | |
13237 | BEGIN | |
13238 | NEW(s) ; | |
13239 | s^[1] := 1 ; | |
13240 | @end smallexample | |
13241 | ||
13242 | @noindent | |
13243 | and you can request that @value{GDBN} describes the type of @code{s}. | |
13244 | ||
13245 | @smallexample | |
13246 | (@value{GDBP}) ptype s | |
13247 | type = POINTER TO ARRAY [1..5] OF CARDINAL | |
13248 | @end smallexample | |
13249 | ||
13250 | @value{GDBN} handles compound types as we can see in this example. | |
13251 | Here we combine array types, record types, pointer types and subrange | |
13252 | types: | |
13253 | ||
13254 | @smallexample | |
13255 | TYPE | |
13256 | foo = RECORD | |
13257 | f1: CARDINAL ; | |
13258 | f2: CHAR ; | |
13259 | f3: myarray ; | |
13260 | END ; | |
13261 | ||
13262 | myarray = ARRAY myrange OF CARDINAL ; | |
13263 | myrange = [-2..2] ; | |
13264 | VAR | |
13265 | s: POINTER TO ARRAY myrange OF foo ; | |
13266 | @end smallexample | |
13267 | ||
13268 | @noindent | |
13269 | and you can ask @value{GDBN} to describe the type of @code{s} as shown | |
13270 | below. | |
13271 | ||
13272 | @smallexample | |
13273 | (@value{GDBP}) ptype s | |
13274 | type = POINTER TO ARRAY [-2..2] OF foo = RECORD | |
13275 | f1 : CARDINAL; | |
13276 | f2 : CHAR; | |
13277 | f3 : ARRAY [-2..2] OF CARDINAL; | |
13278 | END | |
13279 | @end smallexample | |
13280 | ||
6d2ebf8b | 13281 | @node M2 Defaults |
79a6e687 | 13282 | @subsubsection Modula-2 Defaults |
c906108c SS |
13283 | @cindex Modula-2 defaults |
13284 | ||
13285 | If type and range checking are set automatically by @value{GDBN}, they | |
13286 | both default to @code{on} whenever the working language changes to | |
d4f3574e | 13287 | Modula-2. This happens regardless of whether you or @value{GDBN} |
c906108c SS |
13288 | selected the working language. |
13289 | ||
13290 | If you allow @value{GDBN} to set the language automatically, then entering | |
13291 | code compiled from a file whose name ends with @file{.mod} sets the | |
79a6e687 BW |
13292 | working language to Modula-2. @xref{Automatically, ,Having @value{GDBN} |
13293 | Infer the Source Language}, for further details. | |
c906108c | 13294 | |
6d2ebf8b | 13295 | @node Deviations |
79a6e687 | 13296 | @subsubsection Deviations from Standard Modula-2 |
c906108c SS |
13297 | @cindex Modula-2, deviations from |
13298 | ||
13299 | A few changes have been made to make Modula-2 programs easier to debug. | |
13300 | This is done primarily via loosening its type strictness: | |
13301 | ||
13302 | @itemize @bullet | |
13303 | @item | |
13304 | Unlike in standard Modula-2, pointer constants can be formed by | |
13305 | integers. This allows you to modify pointer variables during | |
13306 | debugging. (In standard Modula-2, the actual address contained in a | |
13307 | pointer variable is hidden from you; it can only be modified | |
13308 | through direct assignment to another pointer variable or expression that | |
13309 | returned a pointer.) | |
13310 | ||
13311 | @item | |
13312 | C escape sequences can be used in strings and characters to represent | |
13313 | non-printable characters. @value{GDBN} prints out strings with these | |
13314 | escape sequences embedded. Single non-printable characters are | |
13315 | printed using the @samp{CHR(@var{nnn})} format. | |
13316 | ||
13317 | @item | |
13318 | The assignment operator (@code{:=}) returns the value of its right-hand | |
13319 | argument. | |
13320 | ||
13321 | @item | |
13322 | All built-in procedures both modify @emph{and} return their argument. | |
13323 | @end itemize | |
13324 | ||
6d2ebf8b | 13325 | @node M2 Checks |
79a6e687 | 13326 | @subsubsection Modula-2 Type and Range Checks |
c906108c SS |
13327 | @cindex Modula-2 checks |
13328 | ||
13329 | @quotation | |
13330 | @emph{Warning:} in this release, @value{GDBN} does not yet perform type or | |
13331 | range checking. | |
13332 | @end quotation | |
13333 | @c FIXME remove warning when type/range checks added | |
13334 | ||
13335 | @value{GDBN} considers two Modula-2 variables type equivalent if: | |
13336 | ||
13337 | @itemize @bullet | |
13338 | @item | |
13339 | They are of types that have been declared equivalent via a @code{TYPE | |
13340 | @var{t1} = @var{t2}} statement | |
13341 | ||
13342 | @item | |
13343 | They have been declared on the same line. (Note: This is true of the | |
13344 | @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.) | |
13345 | @end itemize | |
13346 | ||
13347 | As long as type checking is enabled, any attempt to combine variables | |
13348 | whose types are not equivalent is an error. | |
13349 | ||
13350 | Range checking is done on all mathematical operations, assignment, array | |
13351 | index bounds, and all built-in functions and procedures. | |
13352 | ||
6d2ebf8b | 13353 | @node M2 Scope |
79a6e687 | 13354 | @subsubsection The Scope Operators @code{::} and @code{.} |
c906108c | 13355 | @cindex scope |
41afff9a | 13356 | @cindex @code{.}, Modula-2 scope operator |
c906108c SS |
13357 | @cindex colon, doubled as scope operator |
13358 | @ifinfo | |
41afff9a | 13359 | @vindex colon-colon@r{, in Modula-2} |
c906108c SS |
13360 | @c Info cannot handle :: but TeX can. |
13361 | @end ifinfo | |
a67ec3f4 | 13362 | @ifnotinfo |
41afff9a | 13363 | @vindex ::@r{, in Modula-2} |
a67ec3f4 | 13364 | @end ifnotinfo |
c906108c SS |
13365 | |
13366 | There are a few subtle differences between the Modula-2 scope operator | |
13367 | (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have | |
13368 | similar syntax: | |
13369 | ||
474c8240 | 13370 | @smallexample |
c906108c SS |
13371 | |
13372 | @var{module} . @var{id} | |
13373 | @var{scope} :: @var{id} | |
474c8240 | 13374 | @end smallexample |
c906108c SS |
13375 | |
13376 | @noindent | |
13377 | where @var{scope} is the name of a module or a procedure, | |
13378 | @var{module} the name of a module, and @var{id} is any declared | |
13379 | identifier within your program, except another module. | |
13380 | ||
13381 | Using the @code{::} operator makes @value{GDBN} search the scope | |
13382 | specified by @var{scope} for the identifier @var{id}. If it is not | |
13383 | found in the specified scope, then @value{GDBN} searches all scopes | |
13384 | enclosing the one specified by @var{scope}. | |
13385 | ||
13386 | Using the @code{.} operator makes @value{GDBN} search the current scope for | |
13387 | the identifier specified by @var{id} that was imported from the | |
13388 | definition module specified by @var{module}. With this operator, it is | |
13389 | an error if the identifier @var{id} was not imported from definition | |
13390 | module @var{module}, or if @var{id} is not an identifier in | |
13391 | @var{module}. | |
13392 | ||
6d2ebf8b | 13393 | @node GDB/M2 |
c906108c SS |
13394 | @subsubsection @value{GDBN} and Modula-2 |
13395 | ||
13396 | Some @value{GDBN} commands have little use when debugging Modula-2 programs. | |
13397 | Five subcommands of @code{set print} and @code{show print} apply | |
b37052ae | 13398 | specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle}, |
c906108c | 13399 | @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four |
b37052ae | 13400 | apply to C@t{++}, and the last to the C @code{union} type, which has no direct |
c906108c SS |
13401 | analogue in Modula-2. |
13402 | ||
13403 | The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available | |
d4f3574e | 13404 | with any language, is not useful with Modula-2. Its |
c906108c | 13405 | intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be |
b37052ae | 13406 | created in Modula-2 as they can in C or C@t{++}. However, because an |
c906108c | 13407 | address can be specified by an integral constant, the construct |
d4f3574e | 13408 | @samp{@{@var{type}@}@var{adrexp}} is still useful. |
c906108c SS |
13409 | |
13410 | @cindex @code{#} in Modula-2 | |
13411 | In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is | |
13412 | interpreted as the beginning of a comment. Use @code{<>} instead. | |
c906108c | 13413 | |
e07c999f PH |
13414 | @node Ada |
13415 | @subsection Ada | |
13416 | @cindex Ada | |
13417 | ||
13418 | The extensions made to @value{GDBN} for Ada only support | |
13419 | output from the @sc{gnu} Ada (GNAT) compiler. | |
13420 | Other Ada compilers are not currently supported, and | |
13421 | attempting to debug executables produced by them is most likely | |
13422 | to be difficult. | |
13423 | ||
13424 | ||
13425 | @cindex expressions in Ada | |
13426 | @menu | |
13427 | * Ada Mode Intro:: General remarks on the Ada syntax | |
13428 | and semantics supported by Ada mode | |
13429 | in @value{GDBN}. | |
13430 | * Omissions from Ada:: Restrictions on the Ada expression syntax. | |
13431 | * Additions to Ada:: Extensions of the Ada expression syntax. | |
13432 | * Stopping Before Main Program:: Debugging the program during elaboration. | |
20924a55 JB |
13433 | * Ada Tasks:: Listing and setting breakpoints in tasks. |
13434 | * Ada Tasks and Core Files:: Tasking Support when Debugging Core Files | |
6e1bb179 JB |
13435 | * Ravenscar Profile:: Tasking Support when using the Ravenscar |
13436 | Profile | |
e07c999f PH |
13437 | * Ada Glitches:: Known peculiarities of Ada mode. |
13438 | @end menu | |
13439 | ||
13440 | @node Ada Mode Intro | |
13441 | @subsubsection Introduction | |
13442 | @cindex Ada mode, general | |
13443 | ||
13444 | The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression | |
13445 | syntax, with some extensions. | |
13446 | The philosophy behind the design of this subset is | |
13447 | ||
13448 | @itemize @bullet | |
13449 | @item | |
13450 | That @value{GDBN} should provide basic literals and access to operations for | |
13451 | arithmetic, dereferencing, field selection, indexing, and subprogram calls, | |
13452 | leaving more sophisticated computations to subprograms written into the | |
13453 | program (which therefore may be called from @value{GDBN}). | |
13454 | ||
13455 | @item | |
13456 | That type safety and strict adherence to Ada language restrictions | |
13457 | are not particularly important to the @value{GDBN} user. | |
13458 | ||
13459 | @item | |
13460 | That brevity is important to the @value{GDBN} user. | |
13461 | @end itemize | |
13462 | ||
f3a2dd1a JB |
13463 | Thus, for brevity, the debugger acts as if all names declared in |
13464 | user-written packages are directly visible, even if they are not visible | |
13465 | according to Ada rules, thus making it unnecessary to fully qualify most | |
13466 | names with their packages, regardless of context. Where this causes | |
13467 | ambiguity, @value{GDBN} asks the user's intent. | |
e07c999f PH |
13468 | |
13469 | The debugger will start in Ada mode if it detects an Ada main program. | |
13470 | As for other languages, it will enter Ada mode when stopped in a program that | |
13471 | was translated from an Ada source file. | |
13472 | ||
13473 | While in Ada mode, you may use `@t{--}' for comments. This is useful | |
13474 | mostly for documenting command files. The standard @value{GDBN} comment | |
13475 | (@samp{#}) still works at the beginning of a line in Ada mode, but not in the | |
13476 | middle (to allow based literals). | |
13477 | ||
13478 | The debugger supports limited overloading. Given a subprogram call in which | |
13479 | the function symbol has multiple definitions, it will use the number of | |
13480 | actual parameters and some information about their types to attempt to narrow | |
13481 | the set of definitions. It also makes very limited use of context, preferring | |
13482 | procedures to functions in the context of the @code{call} command, and | |
13483 | functions to procedures elsewhere. | |
13484 | ||
13485 | @node Omissions from Ada | |
13486 | @subsubsection Omissions from Ada | |
13487 | @cindex Ada, omissions from | |
13488 | ||
13489 | Here are the notable omissions from the subset: | |
13490 | ||
13491 | @itemize @bullet | |
13492 | @item | |
13493 | Only a subset of the attributes are supported: | |
13494 | ||
13495 | @itemize @minus | |
13496 | @item | |
13497 | @t{'First}, @t{'Last}, and @t{'Length} | |
13498 | on array objects (not on types and subtypes). | |
13499 | ||
13500 | @item | |
13501 | @t{'Min} and @t{'Max}. | |
13502 | ||
13503 | @item | |
13504 | @t{'Pos} and @t{'Val}. | |
13505 | ||
13506 | @item | |
13507 | @t{'Tag}. | |
13508 | ||
13509 | @item | |
13510 | @t{'Range} on array objects (not subtypes), but only as the right | |
13511 | operand of the membership (@code{in}) operator. | |
13512 | ||
13513 | @item | |
13514 | @t{'Access}, @t{'Unchecked_Access}, and | |
13515 | @t{'Unrestricted_Access} (a GNAT extension). | |
13516 | ||
13517 | @item | |
13518 | @t{'Address}. | |
13519 | @end itemize | |
13520 | ||
13521 | @item | |
13522 | The names in | |
13523 | @code{Characters.Latin_1} are not available and | |
13524 | concatenation is not implemented. Thus, escape characters in strings are | |
13525 | not currently available. | |
13526 | ||
13527 | @item | |
13528 | Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise | |
13529 | equality of representations. They will generally work correctly | |
13530 | for strings and arrays whose elements have integer or enumeration types. | |
13531 | They may not work correctly for arrays whose element | |
13532 | types have user-defined equality, for arrays of real values | |
13533 | (in particular, IEEE-conformant floating point, because of negative | |
13534 | zeroes and NaNs), and for arrays whose elements contain unused bits with | |
13535 | indeterminate values. | |
13536 | ||
13537 | @item | |
13538 | The other component-by-component array operations (@code{and}, @code{or}, | |
13539 | @code{xor}, @code{not}, and relational tests other than equality) | |
13540 | are not implemented. | |
13541 | ||
13542 | @item | |
860701dc PH |
13543 | @cindex array aggregates (Ada) |
13544 | @cindex record aggregates (Ada) | |
13545 | @cindex aggregates (Ada) | |
13546 | There is limited support for array and record aggregates. They are | |
13547 | permitted only on the right sides of assignments, as in these examples: | |
13548 | ||
13549 | @smallexample | |
077e0a52 JB |
13550 | (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6) |
13551 | (@value{GDBP}) set An_Array := (1, others => 0) | |
13552 | (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6) | |
13553 | (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9)) | |
13554 | (@value{GDBP}) set A_Record := (1, "Peter", True); | |
13555 | (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True) | |
860701dc PH |
13556 | @end smallexample |
13557 | ||
13558 | Changing a | |
13559 | discriminant's value by assigning an aggregate has an | |
13560 | undefined effect if that discriminant is used within the record. | |
13561 | However, you can first modify discriminants by directly assigning to | |
13562 | them (which normally would not be allowed in Ada), and then performing an | |
13563 | aggregate assignment. For example, given a variable @code{A_Rec} | |
13564 | declared to have a type such as: | |
13565 | ||
13566 | @smallexample | |
13567 | type Rec (Len : Small_Integer := 0) is record | |
13568 | Id : Integer; | |
13569 | Vals : IntArray (1 .. Len); | |
13570 | end record; | |
13571 | @end smallexample | |
13572 | ||
13573 | you can assign a value with a different size of @code{Vals} with two | |
13574 | assignments: | |
13575 | ||
13576 | @smallexample | |
077e0a52 JB |
13577 | (@value{GDBP}) set A_Rec.Len := 4 |
13578 | (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4)) | |
860701dc PH |
13579 | @end smallexample |
13580 | ||
13581 | As this example also illustrates, @value{GDBN} is very loose about the usual | |
13582 | rules concerning aggregates. You may leave out some of the | |
13583 | components of an array or record aggregate (such as the @code{Len} | |
13584 | component in the assignment to @code{A_Rec} above); they will retain their | |
13585 | original values upon assignment. You may freely use dynamic values as | |
13586 | indices in component associations. You may even use overlapping or | |
13587 | redundant component associations, although which component values are | |
13588 | assigned in such cases is not defined. | |
e07c999f PH |
13589 | |
13590 | @item | |
13591 | Calls to dispatching subprograms are not implemented. | |
13592 | ||
13593 | @item | |
13594 | The overloading algorithm is much more limited (i.e., less selective) | |
ae21e955 BW |
13595 | than that of real Ada. It makes only limited use of the context in |
13596 | which a subexpression appears to resolve its meaning, and it is much | |
13597 | looser in its rules for allowing type matches. As a result, some | |
13598 | function calls will be ambiguous, and the user will be asked to choose | |
13599 | the proper resolution. | |
e07c999f PH |
13600 | |
13601 | @item | |
13602 | The @code{new} operator is not implemented. | |
13603 | ||
13604 | @item | |
13605 | Entry calls are not implemented. | |
13606 | ||
13607 | @item | |
13608 | Aside from printing, arithmetic operations on the native VAX floating-point | |
13609 | formats are not supported. | |
13610 | ||
13611 | @item | |
13612 | It is not possible to slice a packed array. | |
158c7665 PH |
13613 | |
13614 | @item | |
13615 | The names @code{True} and @code{False}, when not part of a qualified name, | |
13616 | are interpreted as if implicitly prefixed by @code{Standard}, regardless of | |
13617 | context. | |
13618 | Should your program | |
13619 | redefine these names in a package or procedure (at best a dubious practice), | |
13620 | you will have to use fully qualified names to access their new definitions. | |
e07c999f PH |
13621 | @end itemize |
13622 | ||
13623 | @node Additions to Ada | |
13624 | @subsubsection Additions to Ada | |
13625 | @cindex Ada, deviations from | |
13626 | ||
13627 | As it does for other languages, @value{GDBN} makes certain generic | |
13628 | extensions to Ada (@pxref{Expressions}): | |
13629 | ||
13630 | @itemize @bullet | |
13631 | @item | |
ae21e955 BW |
13632 | If the expression @var{E} is a variable residing in memory (typically |
13633 | a local variable or array element) and @var{N} is a positive integer, | |
13634 | then @code{@var{E}@@@var{N}} displays the values of @var{E} and the | |
13635 | @var{N}-1 adjacent variables following it in memory as an array. In | |
13636 | Ada, this operator is generally not necessary, since its prime use is | |
13637 | in displaying parts of an array, and slicing will usually do this in | |
13638 | Ada. However, there are occasional uses when debugging programs in | |
13639 | which certain debugging information has been optimized away. | |
e07c999f PH |
13640 | |
13641 | @item | |
ae21e955 BW |
13642 | @code{@var{B}::@var{var}} means ``the variable named @var{var} that |
13643 | appears in function or file @var{B}.'' When @var{B} is a file name, | |
13644 | you must typically surround it in single quotes. | |
e07c999f PH |
13645 | |
13646 | @item | |
13647 | The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type | |
13648 | @var{type} that appears at address @var{addr}.'' | |
13649 | ||
13650 | @item | |
13651 | A name starting with @samp{$} is a convenience variable | |
13652 | (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}). | |
13653 | @end itemize | |
13654 | ||
ae21e955 BW |
13655 | In addition, @value{GDBN} provides a few other shortcuts and outright |
13656 | additions specific to Ada: | |
e07c999f PH |
13657 | |
13658 | @itemize @bullet | |
13659 | @item | |
13660 | The assignment statement is allowed as an expression, returning | |
13661 | its right-hand operand as its value. Thus, you may enter | |
13662 | ||
13663 | @smallexample | |
077e0a52 JB |
13664 | (@value{GDBP}) set x := y + 3 |
13665 | (@value{GDBP}) print A(tmp := y + 1) | |
e07c999f PH |
13666 | @end smallexample |
13667 | ||
13668 | @item | |
13669 | The semicolon is allowed as an ``operator,'' returning as its value | |
13670 | the value of its right-hand operand. | |
13671 | This allows, for example, | |
13672 | complex conditional breaks: | |
13673 | ||
13674 | @smallexample | |
077e0a52 JB |
13675 | (@value{GDBP}) break f |
13676 | (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100) | |
e07c999f PH |
13677 | @end smallexample |
13678 | ||
13679 | @item | |
13680 | Rather than use catenation and symbolic character names to introduce special | |
13681 | characters into strings, one may instead use a special bracket notation, | |
13682 | which is also used to print strings. A sequence of characters of the form | |
13683 | @samp{["@var{XX}"]} within a string or character literal denotes the | |
13684 | (single) character whose numeric encoding is @var{XX} in hexadecimal. The | |
13685 | sequence of characters @samp{["""]} also denotes a single quotation mark | |
13686 | in strings. For example, | |
13687 | @smallexample | |
13688 | "One line.["0a"]Next line.["0a"]" | |
13689 | @end smallexample | |
13690 | @noindent | |
ae21e955 BW |
13691 | contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF}) |
13692 | after each period. | |
e07c999f PH |
13693 | |
13694 | @item | |
13695 | The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and | |
13696 | @t{'Max} is optional (and is ignored in any case). For example, it is valid | |
13697 | to write | |
13698 | ||
13699 | @smallexample | |
077e0a52 | 13700 | (@value{GDBP}) print 'max(x, y) |
e07c999f PH |
13701 | @end smallexample |
13702 | ||
13703 | @item | |
13704 | When printing arrays, @value{GDBN} uses positional notation when the | |
13705 | array has a lower bound of 1, and uses a modified named notation otherwise. | |
ae21e955 BW |
13706 | For example, a one-dimensional array of three integers with a lower bound |
13707 | of 3 might print as | |
e07c999f PH |
13708 | |
13709 | @smallexample | |
13710 | (3 => 10, 17, 1) | |
13711 | @end smallexample | |
13712 | ||
13713 | @noindent | |
13714 | That is, in contrast to valid Ada, only the first component has a @code{=>} | |
13715 | clause. | |
13716 | ||
13717 | @item | |
13718 | You may abbreviate attributes in expressions with any unique, | |
13719 | multi-character subsequence of | |
13720 | their names (an exact match gets preference). | |
13721 | For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh} | |
13722 | in place of @t{a'length}. | |
13723 | ||
13724 | @item | |
13725 | @cindex quoting Ada internal identifiers | |
13726 | Since Ada is case-insensitive, the debugger normally maps identifiers you type | |
13727 | to lower case. The GNAT compiler uses upper-case characters for | |
13728 | some of its internal identifiers, which are normally of no interest to users. | |
13729 | For the rare occasions when you actually have to look at them, | |
13730 | enclose them in angle brackets to avoid the lower-case mapping. | |
13731 | For example, | |
13732 | @smallexample | |
077e0a52 | 13733 | (@value{GDBP}) print <JMPBUF_SAVE>[0] |
e07c999f PH |
13734 | @end smallexample |
13735 | ||
13736 | @item | |
13737 | Printing an object of class-wide type or dereferencing an | |
13738 | access-to-class-wide value will display all the components of the object's | |
13739 | specific type (as indicated by its run-time tag). Likewise, component | |
13740 | selection on such a value will operate on the specific type of the | |
13741 | object. | |
13742 | ||
13743 | @end itemize | |
13744 | ||
13745 | @node Stopping Before Main Program | |
13746 | @subsubsection Stopping at the Very Beginning | |
13747 | ||
13748 | @cindex breakpointing Ada elaboration code | |
13749 | It is sometimes necessary to debug the program during elaboration, and | |
13750 | before reaching the main procedure. | |
13751 | As defined in the Ada Reference | |
13752 | Manual, the elaboration code is invoked from a procedure called | |
13753 | @code{adainit}. To run your program up to the beginning of | |
13754 | elaboration, simply use the following two commands: | |
13755 | @code{tbreak adainit} and @code{run}. | |
13756 | ||
20924a55 JB |
13757 | @node Ada Tasks |
13758 | @subsubsection Extensions for Ada Tasks | |
13759 | @cindex Ada, tasking | |
13760 | ||
13761 | Support for Ada tasks is analogous to that for threads (@pxref{Threads}). | |
13762 | @value{GDBN} provides the following task-related commands: | |
13763 | ||
13764 | @table @code | |
13765 | @kindex info tasks | |
13766 | @item info tasks | |
13767 | This command shows a list of current Ada tasks, as in the following example: | |
13768 | ||
13769 | ||
13770 | @smallexample | |
13771 | @iftex | |
13772 | @leftskip=0.5cm | |
13773 | @end iftex | |
13774 | (@value{GDBP}) info tasks | |
13775 | ID TID P-ID Pri State Name | |
13776 | 1 8088000 0 15 Child Activation Wait main_task | |
13777 | 2 80a4000 1 15 Accept Statement b | |
13778 | 3 809a800 1 15 Child Activation Wait a | |
32cd1edc | 13779 | * 4 80ae800 3 15 Runnable c |
20924a55 JB |
13780 | |
13781 | @end smallexample | |
13782 | ||
13783 | @noindent | |
13784 | In this listing, the asterisk before the last task indicates it to be the | |
13785 | task currently being inspected. | |
13786 | ||
13787 | @table @asis | |
13788 | @item ID | |
13789 | Represents @value{GDBN}'s internal task number. | |
13790 | ||
13791 | @item TID | |
13792 | The Ada task ID. | |
13793 | ||
13794 | @item P-ID | |
13795 | The parent's task ID (@value{GDBN}'s internal task number). | |
13796 | ||
13797 | @item Pri | |
13798 | The base priority of the task. | |
13799 | ||
13800 | @item State | |
13801 | Current state of the task. | |
13802 | ||
13803 | @table @code | |
13804 | @item Unactivated | |
13805 | The task has been created but has not been activated. It cannot be | |
13806 | executing. | |
13807 | ||
20924a55 JB |
13808 | @item Runnable |
13809 | The task is not blocked for any reason known to Ada. (It may be waiting | |
13810 | for a mutex, though.) It is conceptually "executing" in normal mode. | |
13811 | ||
13812 | @item Terminated | |
13813 | The task is terminated, in the sense of ARM 9.3 (5). Any dependents | |
13814 | that were waiting on terminate alternatives have been awakened and have | |
13815 | terminated themselves. | |
13816 | ||
13817 | @item Child Activation Wait | |
13818 | The task is waiting for created tasks to complete activation. | |
13819 | ||
13820 | @item Accept Statement | |
13821 | The task is waiting on an accept or selective wait statement. | |
13822 | ||
13823 | @item Waiting on entry call | |
13824 | The task is waiting on an entry call. | |
13825 | ||
13826 | @item Async Select Wait | |
13827 | The task is waiting to start the abortable part of an asynchronous | |
13828 | select statement. | |
13829 | ||
13830 | @item Delay Sleep | |
13831 | The task is waiting on a select statement with only a delay | |
13832 | alternative open. | |
13833 | ||
13834 | @item Child Termination Wait | |
13835 | The task is sleeping having completed a master within itself, and is | |
13836 | waiting for the tasks dependent on that master to become terminated or | |
13837 | waiting on a terminate Phase. | |
13838 | ||
13839 | @item Wait Child in Term Alt | |
13840 | The task is sleeping waiting for tasks on terminate alternatives to | |
13841 | finish terminating. | |
13842 | ||
13843 | @item Accepting RV with @var{taskno} | |
13844 | The task is accepting a rendez-vous with the task @var{taskno}. | |
13845 | @end table | |
13846 | ||
13847 | @item Name | |
13848 | Name of the task in the program. | |
13849 | ||
13850 | @end table | |
13851 | ||
13852 | @kindex info task @var{taskno} | |
13853 | @item info task @var{taskno} | |
13854 | This command shows detailled informations on the specified task, as in | |
13855 | the following example: | |
13856 | @smallexample | |
13857 | @iftex | |
13858 | @leftskip=0.5cm | |
13859 | @end iftex | |
13860 | (@value{GDBP}) info tasks | |
13861 | ID TID P-ID Pri State Name | |
13862 | 1 8077880 0 15 Child Activation Wait main_task | |
32cd1edc | 13863 | * 2 807c468 1 15 Runnable task_1 |
20924a55 JB |
13864 | (@value{GDBP}) info task 2 |
13865 | Ada Task: 0x807c468 | |
13866 | Name: task_1 | |
13867 | Thread: 0x807f378 | |
13868 | Parent: 1 (main_task) | |
13869 | Base Priority: 15 | |
13870 | State: Runnable | |
13871 | @end smallexample | |
13872 | ||
13873 | @item task | |
13874 | @kindex task@r{ (Ada)} | |
13875 | @cindex current Ada task ID | |
13876 | This command prints the ID of the current task. | |
13877 | ||
13878 | @smallexample | |
13879 | @iftex | |
13880 | @leftskip=0.5cm | |
13881 | @end iftex | |
13882 | (@value{GDBP}) info tasks | |
13883 | ID TID P-ID Pri State Name | |
13884 | 1 8077870 0 15 Child Activation Wait main_task | |
32cd1edc | 13885 | * 2 807c458 1 15 Runnable t |
20924a55 JB |
13886 | (@value{GDBP}) task |
13887 | [Current task is 2] | |
13888 | @end smallexample | |
13889 | ||
13890 | @item task @var{taskno} | |
13891 | @cindex Ada task switching | |
13892 | This command is like the @code{thread @var{threadno}} | |
13893 | command (@pxref{Threads}). It switches the context of debugging | |
13894 | from the current task to the given task. | |
13895 | ||
13896 | @smallexample | |
13897 | @iftex | |
13898 | @leftskip=0.5cm | |
13899 | @end iftex | |
13900 | (@value{GDBP}) info tasks | |
13901 | ID TID P-ID Pri State Name | |
13902 | 1 8077870 0 15 Child Activation Wait main_task | |
32cd1edc | 13903 | * 2 807c458 1 15 Runnable t |
20924a55 JB |
13904 | (@value{GDBP}) task 1 |
13905 | [Switching to task 1] | |
13906 | #0 0x8067726 in pthread_cond_wait () | |
13907 | (@value{GDBP}) bt | |
13908 | #0 0x8067726 in pthread_cond_wait () | |
13909 | #1 0x8056714 in system.os_interface.pthread_cond_wait () | |
13910 | #2 0x805cb63 in system.task_primitives.operations.sleep () | |
13911 | #3 0x806153e in system.tasking.stages.activate_tasks () | |
13912 | #4 0x804aacc in un () at un.adb:5 | |
13913 | @end smallexample | |
13914 | ||
45ac276d JB |
13915 | @item break @var{linespec} task @var{taskno} |
13916 | @itemx break @var{linespec} task @var{taskno} if @dots{} | |
13917 | @cindex breakpoints and tasks, in Ada | |
13918 | @cindex task breakpoints, in Ada | |
13919 | @kindex break @dots{} task @var{taskno}@r{ (Ada)} | |
13920 | These commands are like the @code{break @dots{} thread @dots{}} | |
13921 | command (@pxref{Thread Stops}). | |
13922 | @var{linespec} specifies source lines, as described | |
13923 | in @ref{Specify Location}. | |
13924 | ||
13925 | Use the qualifier @samp{task @var{taskno}} with a breakpoint command | |
13926 | to specify that you only want @value{GDBN} to stop the program when a | |
13927 | particular Ada task reaches this breakpoint. @var{taskno} is one of the | |
13928 | numeric task identifiers assigned by @value{GDBN}, shown in the first | |
13929 | column of the @samp{info tasks} display. | |
13930 | ||
13931 | If you do not specify @samp{task @var{taskno}} when you set a | |
13932 | breakpoint, the breakpoint applies to @emph{all} tasks of your | |
13933 | program. | |
13934 | ||
13935 | You can use the @code{task} qualifier on conditional breakpoints as | |
13936 | well; in this case, place @samp{task @var{taskno}} before the | |
13937 | breakpoint condition (before the @code{if}). | |
13938 | ||
13939 | For example, | |
13940 | ||
13941 | @smallexample | |
13942 | @iftex | |
13943 | @leftskip=0.5cm | |
13944 | @end iftex | |
13945 | (@value{GDBP}) info tasks | |
13946 | ID TID P-ID Pri State Name | |
13947 | 1 140022020 0 15 Child Activation Wait main_task | |
13948 | 2 140045060 1 15 Accept/Select Wait t2 | |
13949 | 3 140044840 1 15 Runnable t1 | |
13950 | * 4 140056040 1 15 Runnable t3 | |
13951 | (@value{GDBP}) b 15 task 2 | |
13952 | Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15. | |
13953 | (@value{GDBP}) cont | |
13954 | Continuing. | |
13955 | task # 1 running | |
13956 | task # 2 running | |
13957 | ||
13958 | Breakpoint 5, test_task_debug () at test_task_debug.adb:15 | |
13959 | 15 flush; | |
13960 | (@value{GDBP}) info tasks | |
13961 | ID TID P-ID Pri State Name | |
13962 | 1 140022020 0 15 Child Activation Wait main_task | |
13963 | * 2 140045060 1 15 Runnable t2 | |
13964 | 3 140044840 1 15 Runnable t1 | |
13965 | 4 140056040 1 15 Delay Sleep t3 | |
13966 | @end smallexample | |
20924a55 JB |
13967 | @end table |
13968 | ||
13969 | @node Ada Tasks and Core Files | |
13970 | @subsubsection Tasking Support when Debugging Core Files | |
13971 | @cindex Ada tasking and core file debugging | |
13972 | ||
13973 | When inspecting a core file, as opposed to debugging a live program, | |
13974 | tasking support may be limited or even unavailable, depending on | |
13975 | the platform being used. | |
13976 | For instance, on x86-linux, the list of tasks is available, but task | |
13977 | switching is not supported. On Tru64, however, task switching will work | |
13978 | as usual. | |
13979 | ||
13980 | On certain platforms, including Tru64, the debugger needs to perform some | |
13981 | memory writes in order to provide Ada tasking support. When inspecting | |
13982 | a core file, this means that the core file must be opened with read-write | |
13983 | privileges, using the command @samp{"set write on"} (@pxref{Patching}). | |
13984 | Under these circumstances, you should make a backup copy of the core | |
13985 | file before inspecting it with @value{GDBN}. | |
13986 | ||
6e1bb179 JB |
13987 | @node Ravenscar Profile |
13988 | @subsubsection Tasking Support when using the Ravenscar Profile | |
13989 | @cindex Ravenscar Profile | |
13990 | ||
13991 | The @dfn{Ravenscar Profile} is a subset of the Ada tasking features, | |
13992 | specifically designed for systems with safety-critical real-time | |
13993 | requirements. | |
13994 | ||
13995 | @table @code | |
13996 | @kindex set ravenscar task-switching on | |
13997 | @cindex task switching with program using Ravenscar Profile | |
13998 | @item set ravenscar task-switching on | |
13999 | Allows task switching when debugging a program that uses the Ravenscar | |
14000 | Profile. This is the default. | |
14001 | ||
14002 | @kindex set ravenscar task-switching off | |
14003 | @item set ravenscar task-switching off | |
14004 | Turn off task switching when debugging a program that uses the Ravenscar | |
14005 | Profile. This is mostly intended to disable the code that adds support | |
14006 | for the Ravenscar Profile, in case a bug in either @value{GDBN} or in | |
14007 | the Ravenscar runtime is preventing @value{GDBN} from working properly. | |
14008 | To be effective, this command should be run before the program is started. | |
14009 | ||
14010 | @kindex show ravenscar task-switching | |
14011 | @item show ravenscar task-switching | |
14012 | Show whether it is possible to switch from task to task in a program | |
14013 | using the Ravenscar Profile. | |
14014 | ||
14015 | @end table | |
14016 | ||
e07c999f PH |
14017 | @node Ada Glitches |
14018 | @subsubsection Known Peculiarities of Ada Mode | |
14019 | @cindex Ada, problems | |
14020 | ||
14021 | Besides the omissions listed previously (@pxref{Omissions from Ada}), | |
14022 | we know of several problems with and limitations of Ada mode in | |
14023 | @value{GDBN}, | |
14024 | some of which will be fixed with planned future releases of the debugger | |
14025 | and the GNU Ada compiler. | |
14026 | ||
14027 | @itemize @bullet | |
e07c999f PH |
14028 | @item |
14029 | Static constants that the compiler chooses not to materialize as objects in | |
14030 | storage are invisible to the debugger. | |
14031 | ||
14032 | @item | |
14033 | Named parameter associations in function argument lists are ignored (the | |
14034 | argument lists are treated as positional). | |
14035 | ||
14036 | @item | |
14037 | Many useful library packages are currently invisible to the debugger. | |
14038 | ||
14039 | @item | |
14040 | Fixed-point arithmetic, conversions, input, and output is carried out using | |
14041 | floating-point arithmetic, and may give results that only approximate those on | |
14042 | the host machine. | |
14043 | ||
e07c999f PH |
14044 | @item |
14045 | The GNAT compiler never generates the prefix @code{Standard} for any of | |
14046 | the standard symbols defined by the Ada language. @value{GDBN} knows about | |
14047 | this: it will strip the prefix from names when you use it, and will never | |
14048 | look for a name you have so qualified among local symbols, nor match against | |
14049 | symbols in other packages or subprograms. If you have | |
14050 | defined entities anywhere in your program other than parameters and | |
14051 | local variables whose simple names match names in @code{Standard}, | |
14052 | GNAT's lack of qualification here can cause confusion. When this happens, | |
14053 | you can usually resolve the confusion | |
14054 | by qualifying the problematic names with package | |
14055 | @code{Standard} explicitly. | |
14056 | @end itemize | |
14057 | ||
95433b34 JB |
14058 | Older versions of the compiler sometimes generate erroneous debugging |
14059 | information, resulting in the debugger incorrectly printing the value | |
14060 | of affected entities. In some cases, the debugger is able to work | |
14061 | around an issue automatically. In other cases, the debugger is able | |
14062 | to work around the issue, but the work-around has to be specifically | |
14063 | enabled. | |
14064 | ||
14065 | @kindex set ada trust-PAD-over-XVS | |
14066 | @kindex show ada trust-PAD-over-XVS | |
14067 | @table @code | |
14068 | ||
14069 | @item set ada trust-PAD-over-XVS on | |
14070 | Configure GDB to strictly follow the GNAT encoding when computing the | |
14071 | value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS} | |
14072 | types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for | |
14073 | a complete description of the encoding used by the GNAT compiler). | |
14074 | This is the default. | |
14075 | ||
14076 | @item set ada trust-PAD-over-XVS off | |
14077 | This is related to the encoding using by the GNAT compiler. If @value{GDBN} | |
14078 | sometimes prints the wrong value for certain entities, changing @code{ada | |
14079 | trust-PAD-over-XVS} to @code{off} activates a work-around which may fix | |
14080 | the issue. It is always safe to set @code{ada trust-PAD-over-XVS} to | |
14081 | @code{off}, but this incurs a slight performance penalty, so it is | |
14082 | recommended to leave this setting to @code{on} unless necessary. | |
14083 | ||
14084 | @end table | |
14085 | ||
79a6e687 BW |
14086 | @node Unsupported Languages |
14087 | @section Unsupported Languages | |
4e562065 JB |
14088 | |
14089 | @cindex unsupported languages | |
14090 | @cindex minimal language | |
14091 | In addition to the other fully-supported programming languages, | |
14092 | @value{GDBN} also provides a pseudo-language, called @code{minimal}. | |
14093 | It does not represent a real programming language, but provides a set | |
14094 | of capabilities close to what the C or assembly languages provide. | |
14095 | This should allow most simple operations to be performed while debugging | |
14096 | an application that uses a language currently not supported by @value{GDBN}. | |
14097 | ||
14098 | If the language is set to @code{auto}, @value{GDBN} will automatically | |
14099 | select this language if the current frame corresponds to an unsupported | |
14100 | language. | |
14101 | ||
6d2ebf8b | 14102 | @node Symbols |
c906108c SS |
14103 | @chapter Examining the Symbol Table |
14104 | ||
d4f3574e | 14105 | The commands described in this chapter allow you to inquire about the |
c906108c SS |
14106 | symbols (names of variables, functions and types) defined in your |
14107 | program. This information is inherent in the text of your program and | |
14108 | does not change as your program executes. @value{GDBN} finds it in your | |
14109 | program's symbol table, in the file indicated when you started @value{GDBN} | |
79a6e687 BW |
14110 | (@pxref{File Options, ,Choosing Files}), or by one of the |
14111 | file-management commands (@pxref{Files, ,Commands to Specify Files}). | |
c906108c SS |
14112 | |
14113 | @cindex symbol names | |
14114 | @cindex names of symbols | |
14115 | @cindex quoting names | |
14116 | Occasionally, you may need to refer to symbols that contain unusual | |
14117 | characters, which @value{GDBN} ordinarily treats as word delimiters. The | |
14118 | most frequent case is in referring to static variables in other | |
79a6e687 | 14119 | source files (@pxref{Variables,,Program Variables}). File names |
c906108c SS |
14120 | are recorded in object files as debugging symbols, but @value{GDBN} would |
14121 | ordinarily parse a typical file name, like @file{foo.c}, as the three words | |
14122 | @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize | |
14123 | @samp{foo.c} as a single symbol, enclose it in single quotes; for example, | |
14124 | ||
474c8240 | 14125 | @smallexample |
c906108c | 14126 | p 'foo.c'::x |
474c8240 | 14127 | @end smallexample |
c906108c SS |
14128 | |
14129 | @noindent | |
14130 | looks up the value of @code{x} in the scope of the file @file{foo.c}. | |
14131 | ||
14132 | @table @code | |
a8f24a35 EZ |
14133 | @cindex case-insensitive symbol names |
14134 | @cindex case sensitivity in symbol names | |
14135 | @kindex set case-sensitive | |
14136 | @item set case-sensitive on | |
14137 | @itemx set case-sensitive off | |
14138 | @itemx set case-sensitive auto | |
14139 | Normally, when @value{GDBN} looks up symbols, it matches their names | |
14140 | with case sensitivity determined by the current source language. | |
14141 | Occasionally, you may wish to control that. The command @code{set | |
14142 | case-sensitive} lets you do that by specifying @code{on} for | |
14143 | case-sensitive matches or @code{off} for case-insensitive ones. If | |
14144 | you specify @code{auto}, case sensitivity is reset to the default | |
14145 | suitable for the source language. The default is case-sensitive | |
14146 | matches for all languages except for Fortran, for which the default is | |
14147 | case-insensitive matches. | |
14148 | ||
9c16f35a EZ |
14149 | @kindex show case-sensitive |
14150 | @item show case-sensitive | |
a8f24a35 EZ |
14151 | This command shows the current setting of case sensitivity for symbols |
14152 | lookups. | |
14153 | ||
c906108c | 14154 | @kindex info address |
b37052ae | 14155 | @cindex address of a symbol |
c906108c SS |
14156 | @item info address @var{symbol} |
14157 | Describe where the data for @var{symbol} is stored. For a register | |
14158 | variable, this says which register it is kept in. For a non-register | |
14159 | local variable, this prints the stack-frame offset at which the variable | |
14160 | is always stored. | |
14161 | ||
14162 | Note the contrast with @samp{print &@var{symbol}}, which does not work | |
14163 | at all for a register variable, and for a stack local variable prints | |
14164 | the exact address of the current instantiation of the variable. | |
14165 | ||
3d67e040 | 14166 | @kindex info symbol |
b37052ae | 14167 | @cindex symbol from address |
9c16f35a | 14168 | @cindex closest symbol and offset for an address |
3d67e040 EZ |
14169 | @item info symbol @var{addr} |
14170 | Print the name of a symbol which is stored at the address @var{addr}. | |
14171 | If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the | |
14172 | nearest symbol and an offset from it: | |
14173 | ||
474c8240 | 14174 | @smallexample |
3d67e040 EZ |
14175 | (@value{GDBP}) info symbol 0x54320 |
14176 | _initialize_vx + 396 in section .text | |
474c8240 | 14177 | @end smallexample |
3d67e040 EZ |
14178 | |
14179 | @noindent | |
14180 | This is the opposite of the @code{info address} command. You can use | |
14181 | it to find out the name of a variable or a function given its address. | |
14182 | ||
c14c28ba PP |
14183 | For dynamically linked executables, the name of executable or shared |
14184 | library containing the symbol is also printed: | |
14185 | ||
14186 | @smallexample | |
14187 | (@value{GDBP}) info symbol 0x400225 | |
14188 | _start + 5 in section .text of /tmp/a.out | |
14189 | (@value{GDBP}) info symbol 0x2aaaac2811cf | |
14190 | __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6 | |
14191 | @end smallexample | |
14192 | ||
c906108c | 14193 | @kindex whatis |
62f3a2ba | 14194 | @item whatis [@var{arg}] |
177bc839 JK |
14195 | Print the data type of @var{arg}, which can be either an expression |
14196 | or a name of a data type. With no argument, print the data type of | |
14197 | @code{$}, the last value in the value history. | |
14198 | ||
14199 | If @var{arg} is an expression (@pxref{Expressions, ,Expressions}), it | |
14200 | is not actually evaluated, and any side-effecting operations (such as | |
14201 | assignments or function calls) inside it do not take place. | |
14202 | ||
14203 | If @var{arg} is a variable or an expression, @code{whatis} prints its | |
14204 | literal type as it is used in the source code. If the type was | |
14205 | defined using a @code{typedef}, @code{whatis} will @emph{not} print | |
14206 | the data type underlying the @code{typedef}. If the type of the | |
14207 | variable or the expression is a compound data type, such as | |
14208 | @code{struct} or @code{class}, @code{whatis} never prints their | |
14209 | fields or methods. It just prints the @code{struct}/@code{class} | |
14210 | name (a.k.a.@: its @dfn{tag}). If you want to see the members of | |
14211 | such a compound data type, use @code{ptype}. | |
14212 | ||
14213 | If @var{arg} is a type name that was defined using @code{typedef}, | |
14214 | @code{whatis} @dfn{unrolls} only one level of that @code{typedef}. | |
14215 | Unrolling means that @code{whatis} will show the underlying type used | |
14216 | in the @code{typedef} declaration of @var{arg}. However, if that | |
14217 | underlying type is also a @code{typedef}, @code{whatis} will not | |
14218 | unroll it. | |
14219 | ||
14220 | For C code, the type names may also have the form @samp{class | |
14221 | @var{class-name}}, @samp{struct @var{struct-tag}}, @samp{union | |
14222 | @var{union-tag}} or @samp{enum @var{enum-tag}}. | |
c906108c | 14223 | |
c906108c | 14224 | @kindex ptype |
62f3a2ba FF |
14225 | @item ptype [@var{arg}] |
14226 | @code{ptype} accepts the same arguments as @code{whatis}, but prints a | |
14227 | detailed description of the type, instead of just the name of the type. | |
14228 | @xref{Expressions, ,Expressions}. | |
c906108c | 14229 | |
177bc839 JK |
14230 | Contrary to @code{whatis}, @code{ptype} always unrolls any |
14231 | @code{typedef}s in its argument declaration, whether the argument is | |
14232 | a variable, expression, or a data type. This means that @code{ptype} | |
14233 | of a variable or an expression will not print literally its type as | |
14234 | present in the source code---use @code{whatis} for that. @code{typedef}s at | |
14235 | the pointer or reference targets are also unrolled. Only @code{typedef}s of | |
14236 | fields, methods and inner @code{class typedef}s of @code{struct}s, | |
14237 | @code{class}es and @code{union}s are not unrolled even with @code{ptype}. | |
14238 | ||
c906108c SS |
14239 | For example, for this variable declaration: |
14240 | ||
474c8240 | 14241 | @smallexample |
177bc839 JK |
14242 | typedef double real_t; |
14243 | struct complex @{ real_t real; double imag; @}; | |
14244 | typedef struct complex complex_t; | |
14245 | complex_t var; | |
14246 | real_t *real_pointer_var; | |
474c8240 | 14247 | @end smallexample |
c906108c SS |
14248 | |
14249 | @noindent | |
14250 | the two commands give this output: | |
14251 | ||
474c8240 | 14252 | @smallexample |
c906108c | 14253 | @group |
177bc839 JK |
14254 | (@value{GDBP}) whatis var |
14255 | type = complex_t | |
14256 | (@value{GDBP}) ptype var | |
14257 | type = struct complex @{ | |
14258 | real_t real; | |
14259 | double imag; | |
14260 | @} | |
14261 | (@value{GDBP}) whatis complex_t | |
14262 | type = struct complex | |
14263 | (@value{GDBP}) whatis struct complex | |
c906108c | 14264 | type = struct complex |
177bc839 | 14265 | (@value{GDBP}) ptype struct complex |
c906108c | 14266 | type = struct complex @{ |
177bc839 | 14267 | real_t real; |
c906108c SS |
14268 | double imag; |
14269 | @} | |
177bc839 JK |
14270 | (@value{GDBP}) whatis real_pointer_var |
14271 | type = real_t * | |
14272 | (@value{GDBP}) ptype real_pointer_var | |
14273 | type = double * | |
c906108c | 14274 | @end group |
474c8240 | 14275 | @end smallexample |
c906108c SS |
14276 | |
14277 | @noindent | |
14278 | As with @code{whatis}, using @code{ptype} without an argument refers to | |
14279 | the type of @code{$}, the last value in the value history. | |
14280 | ||
ab1adacd EZ |
14281 | @cindex incomplete type |
14282 | Sometimes, programs use opaque data types or incomplete specifications | |
14283 | of complex data structure. If the debug information included in the | |
14284 | program does not allow @value{GDBN} to display a full declaration of | |
14285 | the data type, it will say @samp{<incomplete type>}. For example, | |
14286 | given these declarations: | |
14287 | ||
14288 | @smallexample | |
14289 | struct foo; | |
14290 | struct foo *fooptr; | |
14291 | @end smallexample | |
14292 | ||
14293 | @noindent | |
14294 | but no definition for @code{struct foo} itself, @value{GDBN} will say: | |
14295 | ||
14296 | @smallexample | |
ddb50cd7 | 14297 | (@value{GDBP}) ptype foo |
ab1adacd EZ |
14298 | $1 = <incomplete type> |
14299 | @end smallexample | |
14300 | ||
14301 | @noindent | |
14302 | ``Incomplete type'' is C terminology for data types that are not | |
14303 | completely specified. | |
14304 | ||
c906108c SS |
14305 | @kindex info types |
14306 | @item info types @var{regexp} | |
14307 | @itemx info types | |
09d4efe1 EZ |
14308 | Print a brief description of all types whose names match the regular |
14309 | expression @var{regexp} (or all types in your program, if you supply | |
14310 | no argument). Each complete typename is matched as though it were a | |
14311 | complete line; thus, @samp{i type value} gives information on all | |
14312 | types in your program whose names include the string @code{value}, but | |
14313 | @samp{i type ^value$} gives information only on types whose complete | |
14314 | name is @code{value}. | |
c906108c SS |
14315 | |
14316 | This command differs from @code{ptype} in two ways: first, like | |
14317 | @code{whatis}, it does not print a detailed description; second, it | |
14318 | lists all source files where a type is defined. | |
14319 | ||
b37052ae EZ |
14320 | @kindex info scope |
14321 | @cindex local variables | |
09d4efe1 | 14322 | @item info scope @var{location} |
b37052ae | 14323 | List all the variables local to a particular scope. This command |
09d4efe1 EZ |
14324 | accepts a @var{location} argument---a function name, a source line, or |
14325 | an address preceded by a @samp{*}, and prints all the variables local | |
2a25a5ba EZ |
14326 | to the scope defined by that location. (@xref{Specify Location}, for |
14327 | details about supported forms of @var{location}.) For example: | |
b37052ae EZ |
14328 | |
14329 | @smallexample | |
14330 | (@value{GDBP}) @b{info scope command_line_handler} | |
14331 | Scope for command_line_handler: | |
14332 | Symbol rl is an argument at stack/frame offset 8, length 4. | |
14333 | Symbol linebuffer is in static storage at address 0x150a18, length 4. | |
14334 | Symbol linelength is in static storage at address 0x150a1c, length 4. | |
14335 | Symbol p is a local variable in register $esi, length 4. | |
14336 | Symbol p1 is a local variable in register $ebx, length 4. | |
14337 | Symbol nline is a local variable in register $edx, length 4. | |
14338 | Symbol repeat is a local variable at frame offset -8, length 4. | |
14339 | @end smallexample | |
14340 | ||
f5c37c66 EZ |
14341 | @noindent |
14342 | This command is especially useful for determining what data to collect | |
14343 | during a @dfn{trace experiment}, see @ref{Tracepoint Actions, | |
14344 | collect}. | |
14345 | ||
c906108c SS |
14346 | @kindex info source |
14347 | @item info source | |
919d772c JB |
14348 | Show information about the current source file---that is, the source file for |
14349 | the function containing the current point of execution: | |
14350 | @itemize @bullet | |
14351 | @item | |
14352 | the name of the source file, and the directory containing it, | |
14353 | @item | |
14354 | the directory it was compiled in, | |
14355 | @item | |
14356 | its length, in lines, | |
14357 | @item | |
14358 | which programming language it is written in, | |
14359 | @item | |
14360 | whether the executable includes debugging information for that file, and | |
14361 | if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and | |
14362 | @item | |
14363 | whether the debugging information includes information about | |
14364 | preprocessor macros. | |
14365 | @end itemize | |
14366 | ||
c906108c SS |
14367 | |
14368 | @kindex info sources | |
14369 | @item info sources | |
14370 | Print the names of all source files in your program for which there is | |
14371 | debugging information, organized into two lists: files whose symbols | |
14372 | have already been read, and files whose symbols will be read when needed. | |
14373 | ||
14374 | @kindex info functions | |
14375 | @item info functions | |
14376 | Print the names and data types of all defined functions. | |
14377 | ||
14378 | @item info functions @var{regexp} | |
14379 | Print the names and data types of all defined functions | |
14380 | whose names contain a match for regular expression @var{regexp}. | |
14381 | Thus, @samp{info fun step} finds all functions whose names | |
14382 | include @code{step}; @samp{info fun ^step} finds those whose names | |
b383017d | 14383 | start with @code{step}. If a function name contains characters |
c1468174 | 14384 | that conflict with the regular expression language (e.g.@: |
1c5dfdad | 14385 | @samp{operator*()}), they may be quoted with a backslash. |
c906108c SS |
14386 | |
14387 | @kindex info variables | |
14388 | @item info variables | |
0fe7935b | 14389 | Print the names and data types of all variables that are defined |
6ca652b0 | 14390 | outside of functions (i.e.@: excluding local variables). |
c906108c SS |
14391 | |
14392 | @item info variables @var{regexp} | |
14393 | Print the names and data types of all variables (except for local | |
14394 | variables) whose names contain a match for regular expression | |
14395 | @var{regexp}. | |
14396 | ||
b37303ee | 14397 | @kindex info classes |
721c2651 | 14398 | @cindex Objective-C, classes and selectors |
b37303ee AF |
14399 | @item info classes |
14400 | @itemx info classes @var{regexp} | |
14401 | Display all Objective-C classes in your program, or | |
14402 | (with the @var{regexp} argument) all those matching a particular regular | |
14403 | expression. | |
14404 | ||
14405 | @kindex info selectors | |
14406 | @item info selectors | |
14407 | @itemx info selectors @var{regexp} | |
14408 | Display all Objective-C selectors in your program, or | |
14409 | (with the @var{regexp} argument) all those matching a particular regular | |
14410 | expression. | |
14411 | ||
c906108c SS |
14412 | @ignore |
14413 | This was never implemented. | |
14414 | @kindex info methods | |
14415 | @item info methods | |
14416 | @itemx info methods @var{regexp} | |
14417 | The @code{info methods} command permits the user to examine all defined | |
b37052ae EZ |
14418 | methods within C@t{++} program, or (with the @var{regexp} argument) a |
14419 | specific set of methods found in the various C@t{++} classes. Many | |
14420 | C@t{++} classes provide a large number of methods. Thus, the output | |
c906108c SS |
14421 | from the @code{ptype} command can be overwhelming and hard to use. The |
14422 | @code{info-methods} command filters the methods, printing only those | |
14423 | which match the regular-expression @var{regexp}. | |
14424 | @end ignore | |
14425 | ||
c906108c SS |
14426 | @cindex reloading symbols |
14427 | Some systems allow individual object files that make up your program to | |
7a292a7a SS |
14428 | be replaced without stopping and restarting your program. For example, |
14429 | in VxWorks you can simply recompile a defective object file and keep on | |
14430 | running. If you are running on one of these systems, you can allow | |
14431 | @value{GDBN} to reload the symbols for automatically relinked modules: | |
c906108c SS |
14432 | |
14433 | @table @code | |
14434 | @kindex set symbol-reloading | |
14435 | @item set symbol-reloading on | |
14436 | Replace symbol definitions for the corresponding source file when an | |
14437 | object file with a particular name is seen again. | |
14438 | ||
14439 | @item set symbol-reloading off | |
6d2ebf8b SS |
14440 | Do not replace symbol definitions when encountering object files of the |
14441 | same name more than once. This is the default state; if you are not | |
14442 | running on a system that permits automatic relinking of modules, you | |
14443 | should leave @code{symbol-reloading} off, since otherwise @value{GDBN} | |
14444 | may discard symbols when linking large programs, that may contain | |
14445 | several modules (from different directories or libraries) with the same | |
14446 | name. | |
c906108c SS |
14447 | |
14448 | @kindex show symbol-reloading | |
14449 | @item show symbol-reloading | |
14450 | Show the current @code{on} or @code{off} setting. | |
14451 | @end table | |
c906108c | 14452 | |
9c16f35a | 14453 | @cindex opaque data types |
c906108c SS |
14454 | @kindex set opaque-type-resolution |
14455 | @item set opaque-type-resolution on | |
14456 | Tell @value{GDBN} to resolve opaque types. An opaque type is a type | |
14457 | declared as a pointer to a @code{struct}, @code{class}, or | |
14458 | @code{union}---for example, @code{struct MyType *}---that is used in one | |
14459 | source file although the full declaration of @code{struct MyType} is in | |
14460 | another source file. The default is on. | |
14461 | ||
14462 | A change in the setting of this subcommand will not take effect until | |
14463 | the next time symbols for a file are loaded. | |
14464 | ||
14465 | @item set opaque-type-resolution off | |
14466 | Tell @value{GDBN} not to resolve opaque types. In this case, the type | |
14467 | is printed as follows: | |
14468 | @smallexample | |
14469 | @{<no data fields>@} | |
14470 | @end smallexample | |
14471 | ||
14472 | @kindex show opaque-type-resolution | |
14473 | @item show opaque-type-resolution | |
14474 | Show whether opaque types are resolved or not. | |
c906108c SS |
14475 | |
14476 | @kindex maint print symbols | |
14477 | @cindex symbol dump | |
14478 | @kindex maint print psymbols | |
14479 | @cindex partial symbol dump | |
14480 | @item maint print symbols @var{filename} | |
14481 | @itemx maint print psymbols @var{filename} | |
14482 | @itemx maint print msymbols @var{filename} | |
14483 | Write a dump of debugging symbol data into the file @var{filename}. | |
14484 | These commands are used to debug the @value{GDBN} symbol-reading code. Only | |
14485 | symbols with debugging data are included. If you use @samp{maint print | |
14486 | symbols}, @value{GDBN} includes all the symbols for which it has already | |
14487 | collected full details: that is, @var{filename} reflects symbols for | |
14488 | only those files whose symbols @value{GDBN} has read. You can use the | |
14489 | command @code{info sources} to find out which files these are. If you | |
14490 | use @samp{maint print psymbols} instead, the dump shows information about | |
14491 | symbols that @value{GDBN} only knows partially---that is, symbols defined in | |
14492 | files that @value{GDBN} has skimmed, but not yet read completely. Finally, | |
14493 | @samp{maint print msymbols} dumps just the minimal symbol information | |
14494 | required for each object file from which @value{GDBN} has read some symbols. | |
79a6e687 | 14495 | @xref{Files, ,Commands to Specify Files}, for a discussion of how |
c906108c | 14496 | @value{GDBN} reads symbols (in the description of @code{symbol-file}). |
44ea7b70 | 14497 | |
5e7b2f39 JB |
14498 | @kindex maint info symtabs |
14499 | @kindex maint info psymtabs | |
44ea7b70 JB |
14500 | @cindex listing @value{GDBN}'s internal symbol tables |
14501 | @cindex symbol tables, listing @value{GDBN}'s internal | |
14502 | @cindex full symbol tables, listing @value{GDBN}'s internal | |
14503 | @cindex partial symbol tables, listing @value{GDBN}'s internal | |
5e7b2f39 JB |
14504 | @item maint info symtabs @r{[} @var{regexp} @r{]} |
14505 | @itemx maint info psymtabs @r{[} @var{regexp} @r{]} | |
44ea7b70 JB |
14506 | |
14507 | List the @code{struct symtab} or @code{struct partial_symtab} | |
14508 | structures whose names match @var{regexp}. If @var{regexp} is not | |
14509 | given, list them all. The output includes expressions which you can | |
14510 | copy into a @value{GDBN} debugging this one to examine a particular | |
14511 | structure in more detail. For example: | |
14512 | ||
14513 | @smallexample | |
5e7b2f39 | 14514 | (@value{GDBP}) maint info psymtabs dwarf2read |
44ea7b70 JB |
14515 | @{ objfile /home/gnu/build/gdb/gdb |
14516 | ((struct objfile *) 0x82e69d0) | |
b383017d | 14517 | @{ psymtab /home/gnu/src/gdb/dwarf2read.c |
44ea7b70 JB |
14518 | ((struct partial_symtab *) 0x8474b10) |
14519 | readin no | |
14520 | fullname (null) | |
14521 | text addresses 0x814d3c8 -- 0x8158074 | |
14522 | globals (* (struct partial_symbol **) 0x8507a08 @@ 9) | |
14523 | statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882) | |
14524 | dependencies (none) | |
14525 | @} | |
14526 | @} | |
5e7b2f39 | 14527 | (@value{GDBP}) maint info symtabs |
44ea7b70 JB |
14528 | (@value{GDBP}) |
14529 | @end smallexample | |
14530 | @noindent | |
14531 | We see that there is one partial symbol table whose filename contains | |
14532 | the string @samp{dwarf2read}, belonging to the @samp{gdb} executable; | |
14533 | and we see that @value{GDBN} has not read in any symtabs yet at all. | |
14534 | If we set a breakpoint on a function, that will cause @value{GDBN} to | |
14535 | read the symtab for the compilation unit containing that function: | |
14536 | ||
14537 | @smallexample | |
14538 | (@value{GDBP}) break dwarf2_psymtab_to_symtab | |
14539 | Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c, | |
14540 | line 1574. | |
5e7b2f39 | 14541 | (@value{GDBP}) maint info symtabs |
b383017d | 14542 | @{ objfile /home/gnu/build/gdb/gdb |
44ea7b70 | 14543 | ((struct objfile *) 0x82e69d0) |
b383017d | 14544 | @{ symtab /home/gnu/src/gdb/dwarf2read.c |
44ea7b70 JB |
14545 | ((struct symtab *) 0x86c1f38) |
14546 | dirname (null) | |
14547 | fullname (null) | |
14548 | blockvector ((struct blockvector *) 0x86c1bd0) (primary) | |
1b39d5c0 | 14549 | linetable ((struct linetable *) 0x8370fa0) |
44ea7b70 JB |
14550 | debugformat DWARF 2 |
14551 | @} | |
14552 | @} | |
b383017d | 14553 | (@value{GDBP}) |
44ea7b70 | 14554 | @end smallexample |
c906108c SS |
14555 | @end table |
14556 | ||
44ea7b70 | 14557 | |
6d2ebf8b | 14558 | @node Altering |
c906108c SS |
14559 | @chapter Altering Execution |
14560 | ||
14561 | Once you think you have found an error in your program, you might want to | |
14562 | find out for certain whether correcting the apparent error would lead to | |
14563 | correct results in the rest of the run. You can find the answer by | |
14564 | experiment, using the @value{GDBN} features for altering execution of the | |
14565 | program. | |
14566 | ||
14567 | For example, you can store new values into variables or memory | |
7a292a7a SS |
14568 | locations, give your program a signal, restart it at a different |
14569 | address, or even return prematurely from a function. | |
c906108c SS |
14570 | |
14571 | @menu | |
14572 | * Assignment:: Assignment to variables | |
14573 | * Jumping:: Continuing at a different address | |
c906108c | 14574 | * Signaling:: Giving your program a signal |
c906108c SS |
14575 | * Returning:: Returning from a function |
14576 | * Calling:: Calling your program's functions | |
14577 | * Patching:: Patching your program | |
14578 | @end menu | |
14579 | ||
6d2ebf8b | 14580 | @node Assignment |
79a6e687 | 14581 | @section Assignment to Variables |
c906108c SS |
14582 | |
14583 | @cindex assignment | |
14584 | @cindex setting variables | |
14585 | To alter the value of a variable, evaluate an assignment expression. | |
14586 | @xref{Expressions, ,Expressions}. For example, | |
14587 | ||
474c8240 | 14588 | @smallexample |
c906108c | 14589 | print x=4 |
474c8240 | 14590 | @end smallexample |
c906108c SS |
14591 | |
14592 | @noindent | |
14593 | stores the value 4 into the variable @code{x}, and then prints the | |
5d161b24 | 14594 | value of the assignment expression (which is 4). |
c906108c SS |
14595 | @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more |
14596 | information on operators in supported languages. | |
c906108c SS |
14597 | |
14598 | @kindex set variable | |
14599 | @cindex variables, setting | |
14600 | If you are not interested in seeing the value of the assignment, use the | |
14601 | @code{set} command instead of the @code{print} command. @code{set} is | |
14602 | really the same as @code{print} except that the expression's value is | |
14603 | not printed and is not put in the value history (@pxref{Value History, | |
79a6e687 | 14604 | ,Value History}). The expression is evaluated only for its effects. |
c906108c | 14605 | |
c906108c SS |
14606 | If the beginning of the argument string of the @code{set} command |
14607 | appears identical to a @code{set} subcommand, use the @code{set | |
14608 | variable} command instead of just @code{set}. This command is identical | |
14609 | to @code{set} except for its lack of subcommands. For example, if your | |
14610 | program has a variable @code{width}, you get an error if you try to set | |
14611 | a new value with just @samp{set width=13}, because @value{GDBN} has the | |
14612 | command @code{set width}: | |
14613 | ||
474c8240 | 14614 | @smallexample |
c906108c SS |
14615 | (@value{GDBP}) whatis width |
14616 | type = double | |
14617 | (@value{GDBP}) p width | |
14618 | $4 = 13 | |
14619 | (@value{GDBP}) set width=47 | |
14620 | Invalid syntax in expression. | |
474c8240 | 14621 | @end smallexample |
c906108c SS |
14622 | |
14623 | @noindent | |
14624 | The invalid expression, of course, is @samp{=47}. In | |
14625 | order to actually set the program's variable @code{width}, use | |
14626 | ||
474c8240 | 14627 | @smallexample |
c906108c | 14628 | (@value{GDBP}) set var width=47 |
474c8240 | 14629 | @end smallexample |
53a5351d | 14630 | |
c906108c SS |
14631 | Because the @code{set} command has many subcommands that can conflict |
14632 | with the names of program variables, it is a good idea to use the | |
14633 | @code{set variable} command instead of just @code{set}. For example, if | |
14634 | your program has a variable @code{g}, you run into problems if you try | |
14635 | to set a new value with just @samp{set g=4}, because @value{GDBN} has | |
14636 | the command @code{set gnutarget}, abbreviated @code{set g}: | |
14637 | ||
474c8240 | 14638 | @smallexample |
c906108c SS |
14639 | @group |
14640 | (@value{GDBP}) whatis g | |
14641 | type = double | |
14642 | (@value{GDBP}) p g | |
14643 | $1 = 1 | |
14644 | (@value{GDBP}) set g=4 | |
2df3850c | 14645 | (@value{GDBP}) p g |
c906108c SS |
14646 | $2 = 1 |
14647 | (@value{GDBP}) r | |
14648 | The program being debugged has been started already. | |
14649 | Start it from the beginning? (y or n) y | |
14650 | Starting program: /home/smith/cc_progs/a.out | |
6d2ebf8b SS |
14651 | "/home/smith/cc_progs/a.out": can't open to read symbols: |
14652 | Invalid bfd target. | |
c906108c SS |
14653 | (@value{GDBP}) show g |
14654 | The current BFD target is "=4". | |
14655 | @end group | |
474c8240 | 14656 | @end smallexample |
c906108c SS |
14657 | |
14658 | @noindent | |
14659 | The program variable @code{g} did not change, and you silently set the | |
14660 | @code{gnutarget} to an invalid value. In order to set the variable | |
14661 | @code{g}, use | |
14662 | ||
474c8240 | 14663 | @smallexample |
c906108c | 14664 | (@value{GDBP}) set var g=4 |
474c8240 | 14665 | @end smallexample |
c906108c SS |
14666 | |
14667 | @value{GDBN} allows more implicit conversions in assignments than C; you can | |
14668 | freely store an integer value into a pointer variable or vice versa, | |
14669 | and you can convert any structure to any other structure that is the | |
14670 | same length or shorter. | |
14671 | @comment FIXME: how do structs align/pad in these conversions? | |
14672 | @comment /doc@cygnus.com 18dec1990 | |
14673 | ||
14674 | To store values into arbitrary places in memory, use the @samp{@{@dots{}@}} | |
14675 | construct to generate a value of specified type at a specified address | |
14676 | (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers | |
14677 | to memory location @code{0x83040} as an integer (which implies a certain size | |
14678 | and representation in memory), and | |
14679 | ||
474c8240 | 14680 | @smallexample |
c906108c | 14681 | set @{int@}0x83040 = 4 |
474c8240 | 14682 | @end smallexample |
c906108c SS |
14683 | |
14684 | @noindent | |
14685 | stores the value 4 into that memory location. | |
14686 | ||
6d2ebf8b | 14687 | @node Jumping |
79a6e687 | 14688 | @section Continuing at a Different Address |
c906108c SS |
14689 | |
14690 | Ordinarily, when you continue your program, you do so at the place where | |
14691 | it stopped, with the @code{continue} command. You can instead continue at | |
14692 | an address of your own choosing, with the following commands: | |
14693 | ||
14694 | @table @code | |
14695 | @kindex jump | |
14696 | @item jump @var{linespec} | |
2a25a5ba EZ |
14697 | @itemx jump @var{location} |
14698 | Resume execution at line @var{linespec} or at address given by | |
14699 | @var{location}. Execution stops again immediately if there is a | |
14700 | breakpoint there. @xref{Specify Location}, for a description of the | |
14701 | different forms of @var{linespec} and @var{location}. It is common | |
14702 | practice to use the @code{tbreak} command in conjunction with | |
14703 | @code{jump}. @xref{Set Breaks, ,Setting Breakpoints}. | |
c906108c SS |
14704 | |
14705 | The @code{jump} command does not change the current stack frame, or | |
14706 | the stack pointer, or the contents of any memory location or any | |
14707 | register other than the program counter. If line @var{linespec} is in | |
14708 | a different function from the one currently executing, the results may | |
14709 | be bizarre if the two functions expect different patterns of arguments or | |
14710 | of local variables. For this reason, the @code{jump} command requests | |
14711 | confirmation if the specified line is not in the function currently | |
14712 | executing. However, even bizarre results are predictable if you are | |
14713 | well acquainted with the machine-language code of your program. | |
c906108c SS |
14714 | @end table |
14715 | ||
c906108c | 14716 | @c Doesn't work on HP-UX; have to set $pcoqh and $pcoqt. |
53a5351d JM |
14717 | On many systems, you can get much the same effect as the @code{jump} |
14718 | command by storing a new value into the register @code{$pc}. The | |
14719 | difference is that this does not start your program running; it only | |
14720 | changes the address of where it @emph{will} run when you continue. For | |
14721 | example, | |
c906108c | 14722 | |
474c8240 | 14723 | @smallexample |
c906108c | 14724 | set $pc = 0x485 |
474c8240 | 14725 | @end smallexample |
c906108c SS |
14726 | |
14727 | @noindent | |
14728 | makes the next @code{continue} command or stepping command execute at | |
14729 | address @code{0x485}, rather than at the address where your program stopped. | |
79a6e687 | 14730 | @xref{Continuing and Stepping, ,Continuing and Stepping}. |
c906108c SS |
14731 | |
14732 | The most common occasion to use the @code{jump} command is to back | |
14733 | up---perhaps with more breakpoints set---over a portion of a program | |
14734 | that has already executed, in order to examine its execution in more | |
14735 | detail. | |
14736 | ||
c906108c | 14737 | @c @group |
6d2ebf8b | 14738 | @node Signaling |
79a6e687 | 14739 | @section Giving your Program a Signal |
9c16f35a | 14740 | @cindex deliver a signal to a program |
c906108c SS |
14741 | |
14742 | @table @code | |
14743 | @kindex signal | |
14744 | @item signal @var{signal} | |
14745 | Resume execution where your program stopped, but immediately give it the | |
14746 | signal @var{signal}. @var{signal} can be the name or the number of a | |
14747 | signal. For example, on many systems @code{signal 2} and @code{signal | |
14748 | SIGINT} are both ways of sending an interrupt signal. | |
14749 | ||
14750 | Alternatively, if @var{signal} is zero, continue execution without | |
14751 | giving a signal. This is useful when your program stopped on account of | |
14752 | a signal and would ordinary see the signal when resumed with the | |
14753 | @code{continue} command; @samp{signal 0} causes it to resume without a | |
14754 | signal. | |
14755 | ||
14756 | @code{signal} does not repeat when you press @key{RET} a second time | |
14757 | after executing the command. | |
14758 | @end table | |
14759 | @c @end group | |
14760 | ||
14761 | Invoking the @code{signal} command is not the same as invoking the | |
14762 | @code{kill} utility from the shell. Sending a signal with @code{kill} | |
14763 | causes @value{GDBN} to decide what to do with the signal depending on | |
14764 | the signal handling tables (@pxref{Signals}). The @code{signal} command | |
14765 | passes the signal directly to your program. | |
14766 | ||
c906108c | 14767 | |
6d2ebf8b | 14768 | @node Returning |
79a6e687 | 14769 | @section Returning from a Function |
c906108c SS |
14770 | |
14771 | @table @code | |
14772 | @cindex returning from a function | |
14773 | @kindex return | |
14774 | @item return | |
14775 | @itemx return @var{expression} | |
14776 | You can cancel execution of a function call with the @code{return} | |
14777 | command. If you give an | |
14778 | @var{expression} argument, its value is used as the function's return | |
14779 | value. | |
14780 | @end table | |
14781 | ||
14782 | When you use @code{return}, @value{GDBN} discards the selected stack frame | |
14783 | (and all frames within it). You can think of this as making the | |
14784 | discarded frame return prematurely. If you wish to specify a value to | |
14785 | be returned, give that value as the argument to @code{return}. | |
14786 | ||
14787 | This pops the selected stack frame (@pxref{Selection, ,Selecting a | |
79a6e687 | 14788 | Frame}), and any other frames inside of it, leaving its caller as the |
c906108c SS |
14789 | innermost remaining frame. That frame becomes selected. The |
14790 | specified value is stored in the registers used for returning values | |
14791 | of functions. | |
14792 | ||
14793 | The @code{return} command does not resume execution; it leaves the | |
14794 | program stopped in the state that would exist if the function had just | |
14795 | returned. In contrast, the @code{finish} command (@pxref{Continuing | |
79a6e687 | 14796 | and Stepping, ,Continuing and Stepping}) resumes execution until the |
c906108c SS |
14797 | selected stack frame returns naturally. |
14798 | ||
61ff14c6 JK |
14799 | @value{GDBN} needs to know how the @var{expression} argument should be set for |
14800 | the inferior. The concrete registers assignment depends on the OS ABI and the | |
14801 | type being returned by the selected stack frame. For example it is common for | |
14802 | OS ABI to return floating point values in FPU registers while integer values in | |
14803 | CPU registers. Still some ABIs return even floating point values in CPU | |
14804 | registers. Larger integer widths (such as @code{long long int}) also have | |
14805 | specific placement rules. @value{GDBN} already knows the OS ABI from its | |
14806 | current target so it needs to find out also the type being returned to make the | |
14807 | assignment into the right register(s). | |
14808 | ||
14809 | Normally, the selected stack frame has debug info. @value{GDBN} will always | |
14810 | use the debug info instead of the implicit type of @var{expression} when the | |
14811 | debug info is available. For example, if you type @kbd{return -1}, and the | |
14812 | function in the current stack frame is declared to return a @code{long long | |
14813 | int}, @value{GDBN} transparently converts the implicit @code{int} value of -1 | |
14814 | into a @code{long long int}: | |
14815 | ||
14816 | @smallexample | |
14817 | Breakpoint 1, func () at gdb.base/return-nodebug.c:29 | |
14818 | 29 return 31; | |
14819 | (@value{GDBP}) return -1 | |
14820 | Make func return now? (y or n) y | |
14821 | #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43 | |
14822 | 43 printf ("result=%lld\n", func ()); | |
14823 | (@value{GDBP}) | |
14824 | @end smallexample | |
14825 | ||
14826 | However, if the selected stack frame does not have a debug info, e.g., if the | |
14827 | function was compiled without debug info, @value{GDBN} has to find out the type | |
14828 | to return from user. Specifying a different type by mistake may set the value | |
14829 | in different inferior registers than the caller code expects. For example, | |
14830 | typing @kbd{return -1} with its implicit type @code{int} would set only a part | |
14831 | of a @code{long long int} result for a debug info less function (on 32-bit | |
14832 | architectures). Therefore the user is required to specify the return type by | |
14833 | an appropriate cast explicitly: | |
14834 | ||
14835 | @smallexample | |
14836 | Breakpoint 2, 0x0040050b in func () | |
14837 | (@value{GDBP}) return -1 | |
14838 | Return value type not available for selected stack frame. | |
14839 | Please use an explicit cast of the value to return. | |
14840 | (@value{GDBP}) return (long long int) -1 | |
14841 | Make selected stack frame return now? (y or n) y | |
14842 | #0 0x00400526 in main () | |
14843 | (@value{GDBP}) | |
14844 | @end smallexample | |
14845 | ||
6d2ebf8b | 14846 | @node Calling |
79a6e687 | 14847 | @section Calling Program Functions |
c906108c | 14848 | |
f8568604 | 14849 | @table @code |
c906108c | 14850 | @cindex calling functions |
f8568604 EZ |
14851 | @cindex inferior functions, calling |
14852 | @item print @var{expr} | |
d3e8051b | 14853 | Evaluate the expression @var{expr} and display the resulting value. |
f8568604 EZ |
14854 | @var{expr} may include calls to functions in the program being |
14855 | debugged. | |
14856 | ||
c906108c | 14857 | @kindex call |
c906108c SS |
14858 | @item call @var{expr} |
14859 | Evaluate the expression @var{expr} without displaying @code{void} | |
14860 | returned values. | |
c906108c SS |
14861 | |
14862 | You can use this variant of the @code{print} command if you want to | |
f8568604 EZ |
14863 | execute a function from your program that does not return anything |
14864 | (a.k.a.@: @dfn{a void function}), but without cluttering the output | |
14865 | with @code{void} returned values that @value{GDBN} will otherwise | |
14866 | print. If the result is not void, it is printed and saved in the | |
14867 | value history. | |
14868 | @end table | |
14869 | ||
9c16f35a EZ |
14870 | It is possible for the function you call via the @code{print} or |
14871 | @code{call} command to generate a signal (e.g., if there's a bug in | |
14872 | the function, or if you passed it incorrect arguments). What happens | |
14873 | in that case is controlled by the @code{set unwindonsignal} command. | |
14874 | ||
7cd1089b PM |
14875 | Similarly, with a C@t{++} program it is possible for the function you |
14876 | call via the @code{print} or @code{call} command to generate an | |
14877 | exception that is not handled due to the constraints of the dummy | |
14878 | frame. In this case, any exception that is raised in the frame, but has | |
14879 | an out-of-frame exception handler will not be found. GDB builds a | |
14880 | dummy-frame for the inferior function call, and the unwinder cannot | |
14881 | seek for exception handlers outside of this dummy-frame. What happens | |
14882 | in that case is controlled by the | |
14883 | @code{set unwind-on-terminating-exception} command. | |
14884 | ||
9c16f35a EZ |
14885 | @table @code |
14886 | @item set unwindonsignal | |
14887 | @kindex set unwindonsignal | |
14888 | @cindex unwind stack in called functions | |
14889 | @cindex call dummy stack unwinding | |
14890 | Set unwinding of the stack if a signal is received while in a function | |
14891 | that @value{GDBN} called in the program being debugged. If set to on, | |
14892 | @value{GDBN} unwinds the stack it created for the call and restores | |
14893 | the context to what it was before the call. If set to off (the | |
14894 | default), @value{GDBN} stops in the frame where the signal was | |
14895 | received. | |
14896 | ||
14897 | @item show unwindonsignal | |
14898 | @kindex show unwindonsignal | |
14899 | Show the current setting of stack unwinding in the functions called by | |
14900 | @value{GDBN}. | |
7cd1089b PM |
14901 | |
14902 | @item set unwind-on-terminating-exception | |
14903 | @kindex set unwind-on-terminating-exception | |
14904 | @cindex unwind stack in called functions with unhandled exceptions | |
14905 | @cindex call dummy stack unwinding on unhandled exception. | |
14906 | Set unwinding of the stack if a C@t{++} exception is raised, but left | |
14907 | unhandled while in a function that @value{GDBN} called in the program being | |
14908 | debugged. If set to on (the default), @value{GDBN} unwinds the stack | |
14909 | it created for the call and restores the context to what it was before | |
14910 | the call. If set to off, @value{GDBN} the exception is delivered to | |
14911 | the default C@t{++} exception handler and the inferior terminated. | |
14912 | ||
14913 | @item show unwind-on-terminating-exception | |
14914 | @kindex show unwind-on-terminating-exception | |
14915 | Show the current setting of stack unwinding in the functions called by | |
14916 | @value{GDBN}. | |
14917 | ||
9c16f35a EZ |
14918 | @end table |
14919 | ||
f8568604 EZ |
14920 | @cindex weak alias functions |
14921 | Sometimes, a function you wish to call is actually a @dfn{weak alias} | |
14922 | for another function. In such case, @value{GDBN} might not pick up | |
14923 | the type information, including the types of the function arguments, | |
14924 | which causes @value{GDBN} to call the inferior function incorrectly. | |
14925 | As a result, the called function will function erroneously and may | |
14926 | even crash. A solution to that is to use the name of the aliased | |
14927 | function instead. | |
c906108c | 14928 | |
6d2ebf8b | 14929 | @node Patching |
79a6e687 | 14930 | @section Patching Programs |
7a292a7a | 14931 | |
c906108c SS |
14932 | @cindex patching binaries |
14933 | @cindex writing into executables | |
c906108c | 14934 | @cindex writing into corefiles |
c906108c | 14935 | |
7a292a7a SS |
14936 | By default, @value{GDBN} opens the file containing your program's |
14937 | executable code (or the corefile) read-only. This prevents accidental | |
14938 | alterations to machine code; but it also prevents you from intentionally | |
14939 | patching your program's binary. | |
c906108c SS |
14940 | |
14941 | If you'd like to be able to patch the binary, you can specify that | |
14942 | explicitly with the @code{set write} command. For example, you might | |
14943 | want to turn on internal debugging flags, or even to make emergency | |
14944 | repairs. | |
14945 | ||
14946 | @table @code | |
14947 | @kindex set write | |
14948 | @item set write on | |
14949 | @itemx set write off | |
7a292a7a | 14950 | If you specify @samp{set write on}, @value{GDBN} opens executable and |
20924a55 | 14951 | core files for both reading and writing; if you specify @kbd{set write |
c906108c SS |
14952 | off} (the default), @value{GDBN} opens them read-only. |
14953 | ||
14954 | If you have already loaded a file, you must load it again (using the | |
7a292a7a SS |
14955 | @code{exec-file} or @code{core-file} command) after changing @code{set |
14956 | write}, for your new setting to take effect. | |
c906108c SS |
14957 | |
14958 | @item show write | |
14959 | @kindex show write | |
7a292a7a SS |
14960 | Display whether executable files and core files are opened for writing |
14961 | as well as reading. | |
c906108c SS |
14962 | @end table |
14963 | ||
6d2ebf8b | 14964 | @node GDB Files |
c906108c SS |
14965 | @chapter @value{GDBN} Files |
14966 | ||
7a292a7a SS |
14967 | @value{GDBN} needs to know the file name of the program to be debugged, |
14968 | both in order to read its symbol table and in order to start your | |
14969 | program. To debug a core dump of a previous run, you must also tell | |
14970 | @value{GDBN} the name of the core dump file. | |
c906108c SS |
14971 | |
14972 | @menu | |
14973 | * Files:: Commands to specify files | |
5b5d99cf | 14974 | * Separate Debug Files:: Debugging information in separate files |
9291a0cd | 14975 | * Index Files:: Index files speed up GDB |
c906108c | 14976 | * Symbol Errors:: Errors reading symbol files |
b14b1491 | 14977 | * Data Files:: GDB data files |
c906108c SS |
14978 | @end menu |
14979 | ||
6d2ebf8b | 14980 | @node Files |
79a6e687 | 14981 | @section Commands to Specify Files |
c906108c | 14982 | |
7a292a7a | 14983 | @cindex symbol table |
c906108c | 14984 | @cindex core dump file |
7a292a7a SS |
14985 | |
14986 | You may want to specify executable and core dump file names. The usual | |
14987 | way to do this is at start-up time, using the arguments to | |
14988 | @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and | |
14989 | Out of @value{GDBN}}). | |
c906108c SS |
14990 | |
14991 | Occasionally it is necessary to change to a different file during a | |
397ca115 EZ |
14992 | @value{GDBN} session. Or you may run @value{GDBN} and forget to |
14993 | specify a file you want to use. Or you are debugging a remote target | |
79a6e687 BW |
14994 | via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver} |
14995 | Program}). In these situations the @value{GDBN} commands to specify | |
0869d01b | 14996 | new files are useful. |
c906108c SS |
14997 | |
14998 | @table @code | |
14999 | @cindex executable file | |
15000 | @kindex file | |
15001 | @item file @var{filename} | |
15002 | Use @var{filename} as the program to be debugged. It is read for its | |
15003 | symbols and for the contents of pure memory. It is also the program | |
15004 | executed when you use the @code{run} command. If you do not specify a | |
5d161b24 DB |
15005 | directory and the file is not found in the @value{GDBN} working directory, |
15006 | @value{GDBN} uses the environment variable @code{PATH} as a list of | |
15007 | directories to search, just as the shell does when looking for a program | |
15008 | to run. You can change the value of this variable, for both @value{GDBN} | |
c906108c SS |
15009 | and your program, using the @code{path} command. |
15010 | ||
fc8be69e EZ |
15011 | @cindex unlinked object files |
15012 | @cindex patching object files | |
15013 | You can load unlinked object @file{.o} files into @value{GDBN} using | |
15014 | the @code{file} command. You will not be able to ``run'' an object | |
15015 | file, but you can disassemble functions and inspect variables. Also, | |
15016 | if the underlying BFD functionality supports it, you could use | |
15017 | @kbd{gdb -write} to patch object files using this technique. Note | |
15018 | that @value{GDBN} can neither interpret nor modify relocations in this | |
15019 | case, so branches and some initialized variables will appear to go to | |
15020 | the wrong place. But this feature is still handy from time to time. | |
15021 | ||
c906108c SS |
15022 | @item file |
15023 | @code{file} with no argument makes @value{GDBN} discard any information it | |
15024 | has on both executable file and the symbol table. | |
15025 | ||
15026 | @kindex exec-file | |
15027 | @item exec-file @r{[} @var{filename} @r{]} | |
15028 | Specify that the program to be run (but not the symbol table) is found | |
15029 | in @var{filename}. @value{GDBN} searches the environment variable @code{PATH} | |
15030 | if necessary to locate your program. Omitting @var{filename} means to | |
15031 | discard information on the executable file. | |
15032 | ||
15033 | @kindex symbol-file | |
15034 | @item symbol-file @r{[} @var{filename} @r{]} | |
15035 | Read symbol table information from file @var{filename}. @code{PATH} is | |
15036 | searched when necessary. Use the @code{file} command to get both symbol | |
15037 | table and program to run from the same file. | |
15038 | ||
15039 | @code{symbol-file} with no argument clears out @value{GDBN} information on your | |
15040 | program's symbol table. | |
15041 | ||
ae5a43e0 DJ |
15042 | The @code{symbol-file} command causes @value{GDBN} to forget the contents of |
15043 | some breakpoints and auto-display expressions. This is because they may | |
15044 | contain pointers to the internal data recording symbols and data types, | |
15045 | which are part of the old symbol table data being discarded inside | |
15046 | @value{GDBN}. | |
c906108c SS |
15047 | |
15048 | @code{symbol-file} does not repeat if you press @key{RET} again after | |
15049 | executing it once. | |
15050 | ||
15051 | When @value{GDBN} is configured for a particular environment, it | |
15052 | understands debugging information in whatever format is the standard | |
15053 | generated for that environment; you may use either a @sc{gnu} compiler, or | |
15054 | other compilers that adhere to the local conventions. | |
c906108c | 15055 | Best results are usually obtained from @sc{gnu} compilers; for example, |
e22ea452 | 15056 | using @code{@value{NGCC}} you can generate debugging information for |
c906108c | 15057 | optimized code. |
c906108c SS |
15058 | |
15059 | For most kinds of object files, with the exception of old SVR3 systems | |
15060 | using COFF, the @code{symbol-file} command does not normally read the | |
15061 | symbol table in full right away. Instead, it scans the symbol table | |
15062 | quickly to find which source files and which symbols are present. The | |
15063 | details are read later, one source file at a time, as they are needed. | |
15064 | ||
15065 | The purpose of this two-stage reading strategy is to make @value{GDBN} | |
15066 | start up faster. For the most part, it is invisible except for | |
15067 | occasional pauses while the symbol table details for a particular source | |
15068 | file are being read. (The @code{set verbose} command can turn these | |
15069 | pauses into messages if desired. @xref{Messages/Warnings, ,Optional | |
79a6e687 | 15070 | Warnings and Messages}.) |
c906108c | 15071 | |
c906108c SS |
15072 | We have not implemented the two-stage strategy for COFF yet. When the |
15073 | symbol table is stored in COFF format, @code{symbol-file} reads the | |
15074 | symbol table data in full right away. Note that ``stabs-in-COFF'' | |
15075 | still does the two-stage strategy, since the debug info is actually | |
15076 | in stabs format. | |
15077 | ||
15078 | @kindex readnow | |
15079 | @cindex reading symbols immediately | |
15080 | @cindex symbols, reading immediately | |
6ac33a4e TT |
15081 | @item symbol-file @r{[} -readnow @r{]} @var{filename} |
15082 | @itemx file @r{[} -readnow @r{]} @var{filename} | |
c906108c SS |
15083 | You can override the @value{GDBN} two-stage strategy for reading symbol |
15084 | tables by using the @samp{-readnow} option with any of the commands that | |
15085 | load symbol table information, if you want to be sure @value{GDBN} has the | |
5d161b24 | 15086 | entire symbol table available. |
c906108c | 15087 | |
c906108c SS |
15088 | @c FIXME: for now no mention of directories, since this seems to be in |
15089 | @c flux. 13mar1992 status is that in theory GDB would look either in | |
15090 | @c current dir or in same dir as myprog; but issues like competing | |
15091 | @c GDB's, or clutter in system dirs, mean that in practice right now | |
15092 | @c only current dir is used. FFish says maybe a special GDB hierarchy | |
15093 | @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol | |
15094 | @c files. | |
15095 | ||
c906108c | 15096 | @kindex core-file |
09d4efe1 | 15097 | @item core-file @r{[}@var{filename}@r{]} |
4644b6e3 | 15098 | @itemx core |
c906108c SS |
15099 | Specify the whereabouts of a core dump file to be used as the ``contents |
15100 | of memory''. Traditionally, core files contain only some parts of the | |
15101 | address space of the process that generated them; @value{GDBN} can access the | |
15102 | executable file itself for other parts. | |
15103 | ||
15104 | @code{core-file} with no argument specifies that no core file is | |
15105 | to be used. | |
15106 | ||
15107 | Note that the core file is ignored when your program is actually running | |
7a292a7a SS |
15108 | under @value{GDBN}. So, if you have been running your program and you |
15109 | wish to debug a core file instead, you must kill the subprocess in which | |
15110 | the program is running. To do this, use the @code{kill} command | |
79a6e687 | 15111 | (@pxref{Kill Process, ,Killing the Child Process}). |
c906108c | 15112 | |
c906108c SS |
15113 | @kindex add-symbol-file |
15114 | @cindex dynamic linking | |
15115 | @item add-symbol-file @var{filename} @var{address} | |
a94ab193 | 15116 | @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]} |
24bdad53 | 15117 | @itemx add-symbol-file @var{filename} @var{address} -s @var{section} @var{address} @dots{} |
96a2c332 SS |
15118 | The @code{add-symbol-file} command reads additional symbol table |
15119 | information from the file @var{filename}. You would use this command | |
15120 | when @var{filename} has been dynamically loaded (by some other means) | |
15121 | into the program that is running. @var{address} should be the memory | |
15122 | address at which the file has been loaded; @value{GDBN} cannot figure | |
d167840f | 15123 | this out for itself. You can additionally specify an arbitrary number |
24bdad53 | 15124 | of @samp{-s @var{section} @var{address}} pairs, to give an explicit |
d167840f EZ |
15125 | section name and base address for that section. You can specify any |
15126 | @var{address} as an expression. | |
c906108c SS |
15127 | |
15128 | The symbol table of the file @var{filename} is added to the symbol table | |
15129 | originally read with the @code{symbol-file} command. You can use the | |
96a2c332 SS |
15130 | @code{add-symbol-file} command any number of times; the new symbol data |
15131 | thus read keeps adding to the old. To discard all old symbol data | |
15132 | instead, use the @code{symbol-file} command without any arguments. | |
c906108c | 15133 | |
17d9d558 JB |
15134 | @cindex relocatable object files, reading symbols from |
15135 | @cindex object files, relocatable, reading symbols from | |
15136 | @cindex reading symbols from relocatable object files | |
15137 | @cindex symbols, reading from relocatable object files | |
15138 | @cindex @file{.o} files, reading symbols from | |
15139 | Although @var{filename} is typically a shared library file, an | |
15140 | executable file, or some other object file which has been fully | |
15141 | relocated for loading into a process, you can also load symbolic | |
15142 | information from relocatable @file{.o} files, as long as: | |
15143 | ||
15144 | @itemize @bullet | |
15145 | @item | |
15146 | the file's symbolic information refers only to linker symbols defined in | |
15147 | that file, not to symbols defined by other object files, | |
15148 | @item | |
15149 | every section the file's symbolic information refers to has actually | |
15150 | been loaded into the inferior, as it appears in the file, and | |
15151 | @item | |
15152 | you can determine the address at which every section was loaded, and | |
15153 | provide these to the @code{add-symbol-file} command. | |
15154 | @end itemize | |
15155 | ||
15156 | @noindent | |
15157 | Some embedded operating systems, like Sun Chorus and VxWorks, can load | |
15158 | relocatable files into an already running program; such systems | |
15159 | typically make the requirements above easy to meet. However, it's | |
15160 | important to recognize that many native systems use complex link | |
49efadf5 | 15161 | procedures (@code{.linkonce} section factoring and C@t{++} constructor table |
17d9d558 JB |
15162 | assembly, for example) that make the requirements difficult to meet. In |
15163 | general, one cannot assume that using @code{add-symbol-file} to read a | |
15164 | relocatable object file's symbolic information will have the same effect | |
15165 | as linking the relocatable object file into the program in the normal | |
15166 | way. | |
15167 | ||
c906108c SS |
15168 | @code{add-symbol-file} does not repeat if you press @key{RET} after using it. |
15169 | ||
c45da7e6 EZ |
15170 | @kindex add-symbol-file-from-memory |
15171 | @cindex @code{syscall DSO} | |
15172 | @cindex load symbols from memory | |
15173 | @item add-symbol-file-from-memory @var{address} | |
15174 | Load symbols from the given @var{address} in a dynamically loaded | |
15175 | object file whose image is mapped directly into the inferior's memory. | |
15176 | For example, the Linux kernel maps a @code{syscall DSO} into each | |
15177 | process's address space; this DSO provides kernel-specific code for | |
15178 | some system calls. The argument can be any expression whose | |
15179 | evaluation yields the address of the file's shared object file header. | |
15180 | For this command to work, you must have used @code{symbol-file} or | |
15181 | @code{exec-file} commands in advance. | |
15182 | ||
09d4efe1 EZ |
15183 | @kindex add-shared-symbol-files |
15184 | @kindex assf | |
15185 | @item add-shared-symbol-files @var{library-file} | |
15186 | @itemx assf @var{library-file} | |
15187 | The @code{add-shared-symbol-files} command can currently be used only | |
15188 | in the Cygwin build of @value{GDBN} on MS-Windows OS, where it is an | |
15189 | alias for the @code{dll-symbols} command (@pxref{Cygwin Native}). | |
15190 | @value{GDBN} automatically looks for shared libraries, however if | |
15191 | @value{GDBN} does not find yours, you can invoke | |
15192 | @code{add-shared-symbol-files}. It takes one argument: the shared | |
15193 | library's file name. @code{assf} is a shorthand alias for | |
15194 | @code{add-shared-symbol-files}. | |
c906108c | 15195 | |
c906108c | 15196 | @kindex section |
09d4efe1 EZ |
15197 | @item section @var{section} @var{addr} |
15198 | The @code{section} command changes the base address of the named | |
15199 | @var{section} of the exec file to @var{addr}. This can be used if the | |
15200 | exec file does not contain section addresses, (such as in the | |
15201 | @code{a.out} format), or when the addresses specified in the file | |
15202 | itself are wrong. Each section must be changed separately. The | |
15203 | @code{info files} command, described below, lists all the sections and | |
15204 | their addresses. | |
c906108c SS |
15205 | |
15206 | @kindex info files | |
15207 | @kindex info target | |
15208 | @item info files | |
15209 | @itemx info target | |
7a292a7a SS |
15210 | @code{info files} and @code{info target} are synonymous; both print the |
15211 | current target (@pxref{Targets, ,Specifying a Debugging Target}), | |
15212 | including the names of the executable and core dump files currently in | |
15213 | use by @value{GDBN}, and the files from which symbols were loaded. The | |
15214 | command @code{help target} lists all possible targets rather than | |
15215 | current ones. | |
15216 | ||
fe95c787 MS |
15217 | @kindex maint info sections |
15218 | @item maint info sections | |
15219 | Another command that can give you extra information about program sections | |
15220 | is @code{maint info sections}. In addition to the section information | |
15221 | displayed by @code{info files}, this command displays the flags and file | |
15222 | offset of each section in the executable and core dump files. In addition, | |
15223 | @code{maint info sections} provides the following command options (which | |
15224 | may be arbitrarily combined): | |
15225 | ||
15226 | @table @code | |
15227 | @item ALLOBJ | |
15228 | Display sections for all loaded object files, including shared libraries. | |
15229 | @item @var{sections} | |
6600abed | 15230 | Display info only for named @var{sections}. |
fe95c787 MS |
15231 | @item @var{section-flags} |
15232 | Display info only for sections for which @var{section-flags} are true. | |
15233 | The section flags that @value{GDBN} currently knows about are: | |
15234 | @table @code | |
15235 | @item ALLOC | |
15236 | Section will have space allocated in the process when loaded. | |
15237 | Set for all sections except those containing debug information. | |
15238 | @item LOAD | |
15239 | Section will be loaded from the file into the child process memory. | |
15240 | Set for pre-initialized code and data, clear for @code{.bss} sections. | |
15241 | @item RELOC | |
15242 | Section needs to be relocated before loading. | |
15243 | @item READONLY | |
15244 | Section cannot be modified by the child process. | |
15245 | @item CODE | |
15246 | Section contains executable code only. | |
6600abed | 15247 | @item DATA |
fe95c787 MS |
15248 | Section contains data only (no executable code). |
15249 | @item ROM | |
15250 | Section will reside in ROM. | |
15251 | @item CONSTRUCTOR | |
15252 | Section contains data for constructor/destructor lists. | |
15253 | @item HAS_CONTENTS | |
15254 | Section is not empty. | |
15255 | @item NEVER_LOAD | |
15256 | An instruction to the linker to not output the section. | |
15257 | @item COFF_SHARED_LIBRARY | |
15258 | A notification to the linker that the section contains | |
15259 | COFF shared library information. | |
15260 | @item IS_COMMON | |
15261 | Section contains common symbols. | |
15262 | @end table | |
15263 | @end table | |
6763aef9 | 15264 | @kindex set trust-readonly-sections |
9c16f35a | 15265 | @cindex read-only sections |
6763aef9 MS |
15266 | @item set trust-readonly-sections on |
15267 | Tell @value{GDBN} that readonly sections in your object file | |
6ca652b0 | 15268 | really are read-only (i.e.@: that their contents will not change). |
6763aef9 MS |
15269 | In that case, @value{GDBN} can fetch values from these sections |
15270 | out of the object file, rather than from the target program. | |
15271 | For some targets (notably embedded ones), this can be a significant | |
15272 | enhancement to debugging performance. | |
15273 | ||
15274 | The default is off. | |
15275 | ||
15276 | @item set trust-readonly-sections off | |
15110bc3 | 15277 | Tell @value{GDBN} not to trust readonly sections. This means that |
6763aef9 MS |
15278 | the contents of the section might change while the program is running, |
15279 | and must therefore be fetched from the target when needed. | |
9c16f35a EZ |
15280 | |
15281 | @item show trust-readonly-sections | |
15282 | Show the current setting of trusting readonly sections. | |
c906108c SS |
15283 | @end table |
15284 | ||
15285 | All file-specifying commands allow both absolute and relative file names | |
15286 | as arguments. @value{GDBN} always converts the file name to an absolute file | |
15287 | name and remembers it that way. | |
15288 | ||
c906108c | 15289 | @cindex shared libraries |
9cceb671 DJ |
15290 | @anchor{Shared Libraries} |
15291 | @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, HP-UX, SunOS, SVr4, Irix, | |
9c16f35a | 15292 | and IBM RS/6000 AIX shared libraries. |
53a5351d | 15293 | |
9cceb671 DJ |
15294 | On MS-Windows @value{GDBN} must be linked with the Expat library to support |
15295 | shared libraries. @xref{Expat}. | |
15296 | ||
c906108c SS |
15297 | @value{GDBN} automatically loads symbol definitions from shared libraries |
15298 | when you use the @code{run} command, or when you examine a core file. | |
15299 | (Before you issue the @code{run} command, @value{GDBN} does not understand | |
15300 | references to a function in a shared library, however---unless you are | |
15301 | debugging a core file). | |
53a5351d JM |
15302 | |
15303 | On HP-UX, if the program loads a library explicitly, @value{GDBN} | |
15304 | automatically loads the symbols at the time of the @code{shl_load} call. | |
15305 | ||
c906108c SS |
15306 | @c FIXME: some @value{GDBN} release may permit some refs to undef |
15307 | @c FIXME...symbols---eg in a break cmd---assuming they are from a shared | |
15308 | @c FIXME...lib; check this from time to time when updating manual | |
15309 | ||
b7209cb4 FF |
15310 | There are times, however, when you may wish to not automatically load |
15311 | symbol definitions from shared libraries, such as when they are | |
15312 | particularly large or there are many of them. | |
15313 | ||
15314 | To control the automatic loading of shared library symbols, use the | |
15315 | commands: | |
15316 | ||
15317 | @table @code | |
15318 | @kindex set auto-solib-add | |
15319 | @item set auto-solib-add @var{mode} | |
15320 | If @var{mode} is @code{on}, symbols from all shared object libraries | |
15321 | will be loaded automatically when the inferior begins execution, you | |
15322 | attach to an independently started inferior, or when the dynamic linker | |
15323 | informs @value{GDBN} that a new library has been loaded. If @var{mode} | |
15324 | is @code{off}, symbols must be loaded manually, using the | |
15325 | @code{sharedlibrary} command. The default value is @code{on}. | |
15326 | ||
dcaf7c2c EZ |
15327 | @cindex memory used for symbol tables |
15328 | If your program uses lots of shared libraries with debug info that | |
15329 | takes large amounts of memory, you can decrease the @value{GDBN} | |
15330 | memory footprint by preventing it from automatically loading the | |
15331 | symbols from shared libraries. To that end, type @kbd{set | |
15332 | auto-solib-add off} before running the inferior, then load each | |
15333 | library whose debug symbols you do need with @kbd{sharedlibrary | |
d3e8051b | 15334 | @var{regexp}}, where @var{regexp} is a regular expression that matches |
dcaf7c2c EZ |
15335 | the libraries whose symbols you want to be loaded. |
15336 | ||
b7209cb4 FF |
15337 | @kindex show auto-solib-add |
15338 | @item show auto-solib-add | |
15339 | Display the current autoloading mode. | |
15340 | @end table | |
15341 | ||
c45da7e6 | 15342 | @cindex load shared library |
b7209cb4 FF |
15343 | To explicitly load shared library symbols, use the @code{sharedlibrary} |
15344 | command: | |
15345 | ||
c906108c SS |
15346 | @table @code |
15347 | @kindex info sharedlibrary | |
15348 | @kindex info share | |
55333a84 DE |
15349 | @item info share @var{regex} |
15350 | @itemx info sharedlibrary @var{regex} | |
15351 | Print the names of the shared libraries which are currently loaded | |
15352 | that match @var{regex}. If @var{regex} is omitted then print | |
15353 | all shared libraries that are loaded. | |
c906108c SS |
15354 | |
15355 | @kindex sharedlibrary | |
15356 | @kindex share | |
15357 | @item sharedlibrary @var{regex} | |
15358 | @itemx share @var{regex} | |
c906108c SS |
15359 | Load shared object library symbols for files matching a |
15360 | Unix regular expression. | |
15361 | As with files loaded automatically, it only loads shared libraries | |
15362 | required by your program for a core file or after typing @code{run}. If | |
15363 | @var{regex} is omitted all shared libraries required by your program are | |
15364 | loaded. | |
c45da7e6 EZ |
15365 | |
15366 | @item nosharedlibrary | |
15367 | @kindex nosharedlibrary | |
15368 | @cindex unload symbols from shared libraries | |
15369 | Unload all shared object library symbols. This discards all symbols | |
15370 | that have been loaded from all shared libraries. Symbols from shared | |
15371 | libraries that were loaded by explicit user requests are not | |
15372 | discarded. | |
c906108c SS |
15373 | @end table |
15374 | ||
721c2651 EZ |
15375 | Sometimes you may wish that @value{GDBN} stops and gives you control |
15376 | when any of shared library events happen. Use the @code{set | |
15377 | stop-on-solib-events} command for this: | |
15378 | ||
15379 | @table @code | |
15380 | @item set stop-on-solib-events | |
15381 | @kindex set stop-on-solib-events | |
15382 | This command controls whether @value{GDBN} should give you control | |
15383 | when the dynamic linker notifies it about some shared library event. | |
15384 | The most common event of interest is loading or unloading of a new | |
15385 | shared library. | |
15386 | ||
15387 | @item show stop-on-solib-events | |
15388 | @kindex show stop-on-solib-events | |
15389 | Show whether @value{GDBN} stops and gives you control when shared | |
15390 | library events happen. | |
15391 | @end table | |
15392 | ||
f5ebfba0 | 15393 | Shared libraries are also supported in many cross or remote debugging |
f1838a98 UW |
15394 | configurations. @value{GDBN} needs to have access to the target's libraries; |
15395 | this can be accomplished either by providing copies of the libraries | |
15396 | on the host system, or by asking @value{GDBN} to automatically retrieve the | |
15397 | libraries from the target. If copies of the target libraries are | |
15398 | provided, they need to be the same as the target libraries, although the | |
f5ebfba0 DJ |
15399 | copies on the target can be stripped as long as the copies on the host are |
15400 | not. | |
15401 | ||
59b7b46f EZ |
15402 | @cindex where to look for shared libraries |
15403 | For remote debugging, you need to tell @value{GDBN} where the target | |
15404 | libraries are, so that it can load the correct copies---otherwise, it | |
15405 | may try to load the host's libraries. @value{GDBN} has two variables | |
15406 | to specify the search directories for target libraries. | |
f5ebfba0 DJ |
15407 | |
15408 | @table @code | |
59b7b46f | 15409 | @cindex prefix for shared library file names |
f822c95b | 15410 | @cindex system root, alternate |
f5ebfba0 | 15411 | @kindex set solib-absolute-prefix |
f822c95b DJ |
15412 | @kindex set sysroot |
15413 | @item set sysroot @var{path} | |
15414 | Use @var{path} as the system root for the program being debugged. Any | |
15415 | absolute shared library paths will be prefixed with @var{path}; many | |
15416 | runtime loaders store the absolute paths to the shared library in the | |
15417 | target program's memory. If you use @code{set sysroot} to find shared | |
15418 | libraries, they need to be laid out in the same way that they are on | |
15419 | the target, with e.g.@: a @file{/lib} and @file{/usr/lib} hierarchy | |
15420 | under @var{path}. | |
15421 | ||
f1838a98 UW |
15422 | If @var{path} starts with the sequence @file{remote:}, @value{GDBN} will |
15423 | retrieve the target libraries from the remote system. This is only | |
15424 | supported when using a remote target that supports the @code{remote get} | |
15425 | command (@pxref{File Transfer,,Sending files to a remote system}). | |
15426 | The part of @var{path} following the initial @file{remote:} | |
15427 | (if present) is used as system root prefix on the remote file system. | |
15428 | @footnote{If you want to specify a local system root using a directory | |
15429 | that happens to be named @file{remote:}, you need to use some equivalent | |
15430 | variant of the name like @file{./remote:}.} | |
15431 | ||
ab38a727 PA |
15432 | For targets with an MS-DOS based filesystem, such as MS-Windows and |
15433 | SymbianOS, @value{GDBN} tries prefixing a few variants of the target | |
15434 | absolute file name with @var{path}. But first, on Unix hosts, | |
15435 | @value{GDBN} converts all backslash directory separators into forward | |
15436 | slashes, because the backslash is not a directory separator on Unix: | |
15437 | ||
15438 | @smallexample | |
15439 | c:\foo\bar.dll @result{} c:/foo/bar.dll | |
15440 | @end smallexample | |
15441 | ||
15442 | Then, @value{GDBN} attempts prefixing the target file name with | |
15443 | @var{path}, and looks for the resulting file name in the host file | |
15444 | system: | |
15445 | ||
15446 | @smallexample | |
15447 | c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll | |
15448 | @end smallexample | |
15449 | ||
15450 | If that does not find the shared library, @value{GDBN} tries removing | |
15451 | the @samp{:} character from the drive spec, both for convenience, and, | |
15452 | for the case of the host file system not supporting file names with | |
15453 | colons: | |
15454 | ||
15455 | @smallexample | |
15456 | c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll | |
15457 | @end smallexample | |
15458 | ||
15459 | This makes it possible to have a system root that mirrors a target | |
15460 | with more than one drive. E.g., you may want to setup your local | |
15461 | copies of the target system shared libraries like so (note @samp{c} vs | |
15462 | @samp{z}): | |
15463 | ||
15464 | @smallexample | |
15465 | @file{/path/to/sysroot/c/sys/bin/foo.dll} | |
15466 | @file{/path/to/sysroot/c/sys/bin/bar.dll} | |
15467 | @file{/path/to/sysroot/z/sys/bin/bar.dll} | |
15468 | @end smallexample | |
15469 | ||
15470 | @noindent | |
15471 | and point the system root at @file{/path/to/sysroot}, so that | |
15472 | @value{GDBN} can find the correct copies of both | |
15473 | @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}. | |
15474 | ||
15475 | If that still does not find the shared library, @value{GDBN} tries | |
15476 | removing the whole drive spec from the target file name: | |
15477 | ||
15478 | @smallexample | |
15479 | c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll | |
15480 | @end smallexample | |
15481 | ||
15482 | This last lookup makes it possible to not care about the drive name, | |
15483 | if you don't want or need to. | |
15484 | ||
f822c95b DJ |
15485 | The @code{set solib-absolute-prefix} command is an alias for @code{set |
15486 | sysroot}. | |
15487 | ||
15488 | @cindex default system root | |
59b7b46f | 15489 | @cindex @samp{--with-sysroot} |
f822c95b DJ |
15490 | You can set the default system root by using the configure-time |
15491 | @samp{--with-sysroot} option. If the system root is inside | |
15492 | @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or | |
15493 | @samp{--exec-prefix}), then the default system root will be updated | |
15494 | automatically if the installed @value{GDBN} is moved to a new | |
15495 | location. | |
15496 | ||
15497 | @kindex show sysroot | |
15498 | @item show sysroot | |
f5ebfba0 DJ |
15499 | Display the current shared library prefix. |
15500 | ||
15501 | @kindex set solib-search-path | |
15502 | @item set solib-search-path @var{path} | |
f822c95b DJ |
15503 | If this variable is set, @var{path} is a colon-separated list of |
15504 | directories to search for shared libraries. @samp{solib-search-path} | |
15505 | is used after @samp{sysroot} fails to locate the library, or if the | |
15506 | path to the library is relative instead of absolute. If you want to | |
15507 | use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set | |
d3e8051b | 15508 | @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from |
f822c95b | 15509 | finding your host's libraries. @samp{sysroot} is preferred; setting |
d3e8051b | 15510 | it to a nonexistent directory may interfere with automatic loading |
f822c95b | 15511 | of shared library symbols. |
f5ebfba0 DJ |
15512 | |
15513 | @kindex show solib-search-path | |
15514 | @item show solib-search-path | |
15515 | Display the current shared library search path. | |
ab38a727 PA |
15516 | |
15517 | @cindex DOS file-name semantics of file names. | |
15518 | @kindex set target-file-system-kind (unix|dos-based|auto) | |
15519 | @kindex show target-file-system-kind | |
15520 | @item set target-file-system-kind @var{kind} | |
15521 | Set assumed file system kind for target reported file names. | |
15522 | ||
15523 | Shared library file names as reported by the target system may not | |
15524 | make sense as is on the system @value{GDBN} is running on. For | |
15525 | example, when remote debugging a target that has MS-DOS based file | |
15526 | system semantics, from a Unix host, the target may be reporting to | |
15527 | @value{GDBN} a list of loaded shared libraries with file names such as | |
15528 | @file{c:\Windows\kernel32.dll}. On Unix hosts, there's no concept of | |
15529 | drive letters, so the @samp{c:\} prefix is not normally understood as | |
15530 | indicating an absolute file name, and neither is the backslash | |
15531 | normally considered a directory separator character. In that case, | |
15532 | the native file system would interpret this whole absolute file name | |
15533 | as a relative file name with no directory components. This would make | |
15534 | it impossible to point @value{GDBN} at a copy of the remote target's | |
15535 | shared libraries on the host using @code{set sysroot}, and impractical | |
15536 | with @code{set solib-search-path}. Setting | |
15537 | @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN} | |
15538 | to interpret such file names similarly to how the target would, and to | |
15539 | map them to file names valid on @value{GDBN}'s native file system | |
15540 | semantics. The value of @var{kind} can be @code{"auto"}, in addition | |
15541 | to one of the supported file system kinds. In that case, @value{GDBN} | |
15542 | tries to determine the appropriate file system variant based on the | |
15543 | current target's operating system (@pxref{ABI, ,Configuring the | |
15544 | Current ABI}). The supported file system settings are: | |
15545 | ||
15546 | @table @code | |
15547 | @item unix | |
15548 | Instruct @value{GDBN} to assume the target file system is of Unix | |
15549 | kind. Only file names starting the forward slash (@samp{/}) character | |
15550 | are considered absolute, and the directory separator character is also | |
15551 | the forward slash. | |
15552 | ||
15553 | @item dos-based | |
15554 | Instruct @value{GDBN} to assume the target file system is DOS based. | |
15555 | File names starting with either a forward slash, or a drive letter | |
15556 | followed by a colon (e.g., @samp{c:}), are considered absolute, and | |
15557 | both the slash (@samp{/}) and the backslash (@samp{\\}) characters are | |
15558 | considered directory separators. | |
15559 | ||
15560 | @item auto | |
15561 | Instruct @value{GDBN} to use the file system kind associated with the | |
15562 | target operating system (@pxref{ABI, ,Configuring the Current ABI}). | |
15563 | This is the default. | |
15564 | @end table | |
f5ebfba0 DJ |
15565 | @end table |
15566 | ||
5b5d99cf JB |
15567 | |
15568 | @node Separate Debug Files | |
15569 | @section Debugging Information in Separate Files | |
15570 | @cindex separate debugging information files | |
15571 | @cindex debugging information in separate files | |
15572 | @cindex @file{.debug} subdirectories | |
15573 | @cindex debugging information directory, global | |
15574 | @cindex global debugging information directory | |
c7e83d54 EZ |
15575 | @cindex build ID, and separate debugging files |
15576 | @cindex @file{.build-id} directory | |
5b5d99cf JB |
15577 | |
15578 | @value{GDBN} allows you to put a program's debugging information in a | |
15579 | file separate from the executable itself, in a way that allows | |
15580 | @value{GDBN} to find and load the debugging information automatically. | |
c7e83d54 EZ |
15581 | Since debugging information can be very large---sometimes larger |
15582 | than the executable code itself---some systems distribute debugging | |
5b5d99cf JB |
15583 | information for their executables in separate files, which users can |
15584 | install only when they need to debug a problem. | |
15585 | ||
c7e83d54 EZ |
15586 | @value{GDBN} supports two ways of specifying the separate debug info |
15587 | file: | |
5b5d99cf JB |
15588 | |
15589 | @itemize @bullet | |
15590 | @item | |
c7e83d54 EZ |
15591 | The executable contains a @dfn{debug link} that specifies the name of |
15592 | the separate debug info file. The separate debug file's name is | |
15593 | usually @file{@var{executable}.debug}, where @var{executable} is the | |
15594 | name of the corresponding executable file without leading directories | |
15595 | (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the | |
99e008fe EZ |
15596 | debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC) |
15597 | checksum for the debug file, which @value{GDBN} uses to validate that | |
15598 | the executable and the debug file came from the same build. | |
c7e83d54 EZ |
15599 | |
15600 | @item | |
7e27a47a | 15601 | The executable contains a @dfn{build ID}, a unique bit string that is |
c7e83d54 | 15602 | also present in the corresponding debug info file. (This is supported |
7e27a47a EZ |
15603 | only on some operating systems, notably those which use the ELF format |
15604 | for binary files and the @sc{gnu} Binutils.) For more details about | |
15605 | this feature, see the description of the @option{--build-id} | |
15606 | command-line option in @ref{Options, , Command Line Options, ld.info, | |
15607 | The GNU Linker}. The debug info file's name is not specified | |
15608 | explicitly by the build ID, but can be computed from the build ID, see | |
15609 | below. | |
d3750b24 JK |
15610 | @end itemize |
15611 | ||
c7e83d54 EZ |
15612 | Depending on the way the debug info file is specified, @value{GDBN} |
15613 | uses two different methods of looking for the debug file: | |
d3750b24 JK |
15614 | |
15615 | @itemize @bullet | |
15616 | @item | |
c7e83d54 EZ |
15617 | For the ``debug link'' method, @value{GDBN} looks up the named file in |
15618 | the directory of the executable file, then in a subdirectory of that | |
15619 | directory named @file{.debug}, and finally under the global debug | |
15620 | directory, in a subdirectory whose name is identical to the leading | |
15621 | directories of the executable's absolute file name. | |
15622 | ||
15623 | @item | |
83f83d7f | 15624 | For the ``build ID'' method, @value{GDBN} looks in the |
c7e83d54 EZ |
15625 | @file{.build-id} subdirectory of the global debug directory for a file |
15626 | named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the | |
7e27a47a EZ |
15627 | first 2 hex characters of the build ID bit string, and @var{nnnnnnnn} |
15628 | are the rest of the bit string. (Real build ID strings are 32 or more | |
15629 | hex characters, not 10.) | |
c7e83d54 EZ |
15630 | @end itemize |
15631 | ||
15632 | So, for example, suppose you ask @value{GDBN} to debug | |
7e27a47a EZ |
15633 | @file{/usr/bin/ls}, which has a debug link that specifies the |
15634 | file @file{ls.debug}, and a build ID whose value in hex is | |
c7e83d54 EZ |
15635 | @code{abcdef1234}. If the global debug directory is |
15636 | @file{/usr/lib/debug}, then @value{GDBN} will look for the following | |
15637 | debug information files, in the indicated order: | |
15638 | ||
15639 | @itemize @minus | |
15640 | @item | |
15641 | @file{/usr/lib/debug/.build-id/ab/cdef1234.debug} | |
d3750b24 | 15642 | @item |
c7e83d54 | 15643 | @file{/usr/bin/ls.debug} |
5b5d99cf | 15644 | @item |
c7e83d54 | 15645 | @file{/usr/bin/.debug/ls.debug} |
5b5d99cf | 15646 | @item |
c7e83d54 | 15647 | @file{/usr/lib/debug/usr/bin/ls.debug}. |
5b5d99cf | 15648 | @end itemize |
5b5d99cf JB |
15649 | |
15650 | You can set the global debugging info directory's name, and view the | |
15651 | name @value{GDBN} is currently using. | |
15652 | ||
15653 | @table @code | |
15654 | ||
15655 | @kindex set debug-file-directory | |
24ddea62 JK |
15656 | @item set debug-file-directory @var{directories} |
15657 | Set the directories which @value{GDBN} searches for separate debugging | |
15658 | information files to @var{directory}. Multiple directory components can be set | |
15659 | concatenating them by a directory separator. | |
5b5d99cf JB |
15660 | |
15661 | @kindex show debug-file-directory | |
15662 | @item show debug-file-directory | |
24ddea62 | 15663 | Show the directories @value{GDBN} searches for separate debugging |
5b5d99cf JB |
15664 | information files. |
15665 | ||
15666 | @end table | |
15667 | ||
15668 | @cindex @code{.gnu_debuglink} sections | |
c7e83d54 | 15669 | @cindex debug link sections |
5b5d99cf JB |
15670 | A debug link is a special section of the executable file named |
15671 | @code{.gnu_debuglink}. The section must contain: | |
15672 | ||
15673 | @itemize | |
15674 | @item | |
15675 | A filename, with any leading directory components removed, followed by | |
15676 | a zero byte, | |
15677 | @item | |
15678 | zero to three bytes of padding, as needed to reach the next four-byte | |
15679 | boundary within the section, and | |
15680 | @item | |
15681 | a four-byte CRC checksum, stored in the same endianness used for the | |
15682 | executable file itself. The checksum is computed on the debugging | |
15683 | information file's full contents by the function given below, passing | |
15684 | zero as the @var{crc} argument. | |
15685 | @end itemize | |
15686 | ||
15687 | Any executable file format can carry a debug link, as long as it can | |
15688 | contain a section named @code{.gnu_debuglink} with the contents | |
15689 | described above. | |
15690 | ||
d3750b24 | 15691 | @cindex @code{.note.gnu.build-id} sections |
c7e83d54 | 15692 | @cindex build ID sections |
7e27a47a EZ |
15693 | The build ID is a special section in the executable file (and in other |
15694 | ELF binary files that @value{GDBN} may consider). This section is | |
15695 | often named @code{.note.gnu.build-id}, but that name is not mandatory. | |
15696 | It contains unique identification for the built files---the ID remains | |
15697 | the same across multiple builds of the same build tree. The default | |
15698 | algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the | |
15699 | content for the build ID string. The same section with an identical | |
15700 | value is present in the original built binary with symbols, in its | |
15701 | stripped variant, and in the separate debugging information file. | |
d3750b24 | 15702 | |
5b5d99cf JB |
15703 | The debugging information file itself should be an ordinary |
15704 | executable, containing a full set of linker symbols, sections, and | |
15705 | debugging information. The sections of the debugging information file | |
c7e83d54 EZ |
15706 | should have the same names, addresses, and sizes as the original file, |
15707 | but they need not contain any data---much like a @code{.bss} section | |
5b5d99cf JB |
15708 | in an ordinary executable. |
15709 | ||
7e27a47a | 15710 | The @sc{gnu} binary utilities (Binutils) package includes the |
c7e83d54 EZ |
15711 | @samp{objcopy} utility that can produce |
15712 | the separated executable / debugging information file pairs using the | |
15713 | following commands: | |
15714 | ||
15715 | @smallexample | |
15716 | @kbd{objcopy --only-keep-debug foo foo.debug} | |
15717 | @kbd{strip -g foo} | |
c7e83d54 EZ |
15718 | @end smallexample |
15719 | ||
15720 | @noindent | |
15721 | These commands remove the debugging | |
83f83d7f JK |
15722 | information from the executable file @file{foo} and place it in the file |
15723 | @file{foo.debug}. You can use the first, second or both methods to link the | |
15724 | two files: | |
15725 | ||
15726 | @itemize @bullet | |
15727 | @item | |
15728 | The debug link method needs the following additional command to also leave | |
15729 | behind a debug link in @file{foo}: | |
15730 | ||
15731 | @smallexample | |
15732 | @kbd{objcopy --add-gnu-debuglink=foo.debug foo} | |
15733 | @end smallexample | |
15734 | ||
15735 | Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains | |
d3750b24 | 15736 | a version of the @code{strip} command such that the command @kbd{strip foo -f |
83f83d7f JK |
15737 | foo.debug} has the same functionality as the two @code{objcopy} commands and |
15738 | the @code{ln -s} command above, together. | |
15739 | ||
15740 | @item | |
15741 | Build ID gets embedded into the main executable using @code{ld --build-id} or | |
15742 | the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus | |
15743 | compatibility fixes for debug files separation are present in @sc{gnu} binary | |
7e27a47a | 15744 | utilities (Binutils) package since version 2.18. |
83f83d7f JK |
15745 | @end itemize |
15746 | ||
15747 | @noindent | |
d3750b24 | 15748 | |
99e008fe EZ |
15749 | @cindex CRC algorithm definition |
15750 | The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in | |
15751 | IEEE 802.3 using the polynomial: | |
15752 | ||
15753 | @c TexInfo requires naked braces for multi-digit exponents for Tex | |
15754 | @c output, but this causes HTML output to barf. HTML has to be set using | |
15755 | @c raw commands. So we end up having to specify this equation in 2 | |
15756 | @c different ways! | |
15757 | @ifhtml | |
15758 | @display | |
15759 | @html | |
15760 | <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> | |
15761 | + <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 | |
15762 | @end html | |
15763 | @end display | |
15764 | @end ifhtml | |
15765 | @ifnothtml | |
15766 | @display | |
15767 | @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}} | |
15768 | @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1} | |
15769 | @end display | |
15770 | @end ifnothtml | |
15771 | ||
15772 | The function is computed byte at a time, taking the least | |
15773 | significant bit of each byte first. The initial pattern | |
15774 | @code{0xffffffff} is used, to ensure leading zeros affect the CRC and | |
15775 | the final result is inverted to ensure trailing zeros also affect the | |
15776 | CRC. | |
15777 | ||
15778 | @emph{Note:} This is the same CRC polynomial as used in handling the | |
15779 | @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{Remote Protocol, | |
15780 | , @value{GDBN} Remote Serial Protocol}). However in the | |
15781 | case of the Remote Serial Protocol, the CRC is computed @emph{most} | |
15782 | significant bit first, and the result is not inverted, so trailing | |
15783 | zeros have no effect on the CRC value. | |
15784 | ||
15785 | To complete the description, we show below the code of the function | |
15786 | which produces the CRC used in @code{.gnu_debuglink}. Inverting the | |
15787 | initially supplied @code{crc} argument means that an initial call to | |
15788 | this function passing in zero will start computing the CRC using | |
15789 | @code{0xffffffff}. | |
5b5d99cf | 15790 | |
4644b6e3 | 15791 | @kindex gnu_debuglink_crc32 |
5b5d99cf JB |
15792 | @smallexample |
15793 | unsigned long | |
15794 | gnu_debuglink_crc32 (unsigned long crc, | |
15795 | unsigned char *buf, size_t len) | |
15796 | @{ | |
15797 | static const unsigned long crc32_table[256] = | |
15798 | @{ | |
15799 | 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, | |
15800 | 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, | |
15801 | 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, | |
15802 | 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, | |
15803 | 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856, | |
15804 | 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, | |
15805 | 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, | |
15806 | 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, | |
15807 | 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, | |
15808 | 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, | |
15809 | 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, | |
15810 | 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, | |
15811 | 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, | |
15812 | 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, | |
15813 | 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, | |
15814 | 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, | |
15815 | 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, | |
15816 | 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, | |
15817 | 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, | |
15818 | 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, | |
15819 | 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, | |
15820 | 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, | |
15821 | 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010, | |
15822 | 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, | |
15823 | 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, | |
15824 | 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, | |
15825 | 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, | |
15826 | 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, | |
15827 | 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, | |
15828 | 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, | |
15829 | 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, | |
15830 | 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, | |
15831 | 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, | |
15832 | 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c, | |
15833 | 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, | |
15834 | 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, | |
15835 | 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, | |
15836 | 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, | |
15837 | 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c, | |
15838 | 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, | |
15839 | 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, | |
15840 | 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, | |
15841 | 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, | |
15842 | 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, | |
15843 | 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278, | |
15844 | 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, | |
15845 | 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, | |
15846 | 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, | |
15847 | 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, | |
15848 | 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, | |
15849 | 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, | |
15850 | 0x2d02ef8d | |
15851 | @}; | |
15852 | unsigned char *end; | |
15853 | ||
15854 | crc = ~crc & 0xffffffff; | |
15855 | for (end = buf + len; buf < end; ++buf) | |
15856 | crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8); | |
e7a3abfc | 15857 | return ~crc & 0xffffffff; |
5b5d99cf JB |
15858 | @} |
15859 | @end smallexample | |
15860 | ||
c7e83d54 EZ |
15861 | @noindent |
15862 | This computation does not apply to the ``build ID'' method. | |
15863 | ||
5b5d99cf | 15864 | |
9291a0cd TT |
15865 | @node Index Files |
15866 | @section Index Files Speed Up @value{GDBN} | |
15867 | @cindex index files | |
15868 | @cindex @samp{.gdb_index} section | |
15869 | ||
15870 | When @value{GDBN} finds a symbol file, it scans the symbols in the | |
15871 | file in order to construct an internal symbol table. This lets most | |
15872 | @value{GDBN} operations work quickly---at the cost of a delay early | |
15873 | on. For large programs, this delay can be quite lengthy, so | |
15874 | @value{GDBN} provides a way to build an index, which speeds up | |
15875 | startup. | |
15876 | ||
15877 | The index is stored as a section in the symbol file. @value{GDBN} can | |
15878 | write the index to a file, then you can put it into the symbol file | |
15879 | using @command{objcopy}. | |
15880 | ||
15881 | To create an index file, use the @code{save gdb-index} command: | |
15882 | ||
15883 | @table @code | |
15884 | @item save gdb-index @var{directory} | |
15885 | @kindex save gdb-index | |
15886 | Create an index file for each symbol file currently known by | |
15887 | @value{GDBN}. Each file is named after its corresponding symbol file, | |
15888 | with @samp{.gdb-index} appended, and is written into the given | |
15889 | @var{directory}. | |
15890 | @end table | |
15891 | ||
15892 | Once you have created an index file you can merge it into your symbol | |
15893 | file, here named @file{symfile}, using @command{objcopy}: | |
15894 | ||
15895 | @smallexample | |
15896 | $ objcopy --add-section .gdb_index=symfile.gdb-index \ | |
15897 | --set-section-flags .gdb_index=readonly symfile symfile | |
15898 | @end smallexample | |
15899 | ||
15900 | There are currently some limitation on indices. They only work when | |
15901 | for DWARF debugging information, not stabs. And, they do not | |
15902 | currently work for programs using Ada. | |
15903 | ||
6d2ebf8b | 15904 | @node Symbol Errors |
79a6e687 | 15905 | @section Errors Reading Symbol Files |
c906108c SS |
15906 | |
15907 | While reading a symbol file, @value{GDBN} occasionally encounters problems, | |
15908 | such as symbol types it does not recognize, or known bugs in compiler | |
15909 | output. By default, @value{GDBN} does not notify you of such problems, since | |
15910 | they are relatively common and primarily of interest to people | |
15911 | debugging compilers. If you are interested in seeing information | |
15912 | about ill-constructed symbol tables, you can either ask @value{GDBN} to print | |
15913 | only one message about each such type of problem, no matter how many | |
15914 | times the problem occurs; or you can ask @value{GDBN} to print more messages, | |
15915 | to see how many times the problems occur, with the @code{set | |
79a6e687 BW |
15916 | complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and |
15917 | Messages}). | |
c906108c SS |
15918 | |
15919 | The messages currently printed, and their meanings, include: | |
15920 | ||
15921 | @table @code | |
15922 | @item inner block not inside outer block in @var{symbol} | |
15923 | ||
15924 | The symbol information shows where symbol scopes begin and end | |
15925 | (such as at the start of a function or a block of statements). This | |
15926 | error indicates that an inner scope block is not fully contained | |
15927 | in its outer scope blocks. | |
15928 | ||
15929 | @value{GDBN} circumvents the problem by treating the inner block as if it had | |
15930 | the same scope as the outer block. In the error message, @var{symbol} | |
15931 | may be shown as ``@code{(don't know)}'' if the outer block is not a | |
15932 | function. | |
15933 | ||
15934 | @item block at @var{address} out of order | |
15935 | ||
15936 | The symbol information for symbol scope blocks should occur in | |
15937 | order of increasing addresses. This error indicates that it does not | |
15938 | do so. | |
15939 | ||
15940 | @value{GDBN} does not circumvent this problem, and has trouble | |
15941 | locating symbols in the source file whose symbols it is reading. (You | |
15942 | can often determine what source file is affected by specifying | |
79a6e687 BW |
15943 | @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and |
15944 | Messages}.) | |
c906108c SS |
15945 | |
15946 | @item bad block start address patched | |
15947 | ||
15948 | The symbol information for a symbol scope block has a start address | |
15949 | smaller than the address of the preceding source line. This is known | |
15950 | to occur in the SunOS 4.1.1 (and earlier) C compiler. | |
15951 | ||
15952 | @value{GDBN} circumvents the problem by treating the symbol scope block as | |
15953 | starting on the previous source line. | |
15954 | ||
15955 | @item bad string table offset in symbol @var{n} | |
15956 | ||
15957 | @cindex foo | |
15958 | Symbol number @var{n} contains a pointer into the string table which is | |
15959 | larger than the size of the string table. | |
15960 | ||
15961 | @value{GDBN} circumvents the problem by considering the symbol to have the | |
15962 | name @code{foo}, which may cause other problems if many symbols end up | |
15963 | with this name. | |
15964 | ||
15965 | @item unknown symbol type @code{0x@var{nn}} | |
15966 | ||
7a292a7a SS |
15967 | The symbol information contains new data types that @value{GDBN} does |
15968 | not yet know how to read. @code{0x@var{nn}} is the symbol type of the | |
d4f3574e | 15969 | uncomprehended information, in hexadecimal. |
c906108c | 15970 | |
7a292a7a SS |
15971 | @value{GDBN} circumvents the error by ignoring this symbol information. |
15972 | This usually allows you to debug your program, though certain symbols | |
c906108c | 15973 | are not accessible. If you encounter such a problem and feel like |
7a292a7a SS |
15974 | debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint |
15975 | on @code{complain}, then go up to the function @code{read_dbx_symtab} | |
15976 | and examine @code{*bufp} to see the symbol. | |
c906108c SS |
15977 | |
15978 | @item stub type has NULL name | |
c906108c | 15979 | |
7a292a7a | 15980 | @value{GDBN} could not find the full definition for a struct or class. |
c906108c | 15981 | |
7a292a7a | 15982 | @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{} |
b37052ae | 15983 | The symbol information for a C@t{++} member function is missing some |
7a292a7a SS |
15984 | information that recent versions of the compiler should have output for |
15985 | it. | |
c906108c SS |
15986 | |
15987 | @item info mismatch between compiler and debugger | |
15988 | ||
15989 | @value{GDBN} could not parse a type specification output by the compiler. | |
7a292a7a | 15990 | |
c906108c SS |
15991 | @end table |
15992 | ||
b14b1491 TT |
15993 | @node Data Files |
15994 | @section GDB Data Files | |
15995 | ||
15996 | @cindex prefix for data files | |
15997 | @value{GDBN} will sometimes read an auxiliary data file. These files | |
15998 | are kept in a directory known as the @dfn{data directory}. | |
15999 | ||
16000 | You can set the data directory's name, and view the name @value{GDBN} | |
16001 | is currently using. | |
16002 | ||
16003 | @table @code | |
16004 | @kindex set data-directory | |
16005 | @item set data-directory @var{directory} | |
16006 | Set the directory which @value{GDBN} searches for auxiliary data files | |
16007 | to @var{directory}. | |
16008 | ||
16009 | @kindex show data-directory | |
16010 | @item show data-directory | |
16011 | Show the directory @value{GDBN} searches for auxiliary data files. | |
16012 | @end table | |
16013 | ||
16014 | @cindex default data directory | |
16015 | @cindex @samp{--with-gdb-datadir} | |
16016 | You can set the default data directory by using the configure-time | |
16017 | @samp{--with-gdb-datadir} option. If the data directory is inside | |
16018 | @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or | |
16019 | @samp{--exec-prefix}), then the default data directory will be updated | |
16020 | automatically if the installed @value{GDBN} is moved to a new | |
16021 | location. | |
16022 | ||
aae1c79a DE |
16023 | The data directory may also be specified with the |
16024 | @code{--data-directory} command line option. | |
16025 | @xref{Mode Options}. | |
16026 | ||
6d2ebf8b | 16027 | @node Targets |
c906108c | 16028 | @chapter Specifying a Debugging Target |
7a292a7a | 16029 | |
c906108c | 16030 | @cindex debugging target |
c906108c | 16031 | A @dfn{target} is the execution environment occupied by your program. |
53a5351d JM |
16032 | |
16033 | Often, @value{GDBN} runs in the same host environment as your program; | |
16034 | in that case, the debugging target is specified as a side effect when | |
16035 | you use the @code{file} or @code{core} commands. When you need more | |
c906108c SS |
16036 | flexibility---for example, running @value{GDBN} on a physically separate |
16037 | host, or controlling a standalone system over a serial port or a | |
53a5351d JM |
16038 | realtime system over a TCP/IP connection---you can use the @code{target} |
16039 | command to specify one of the target types configured for @value{GDBN} | |
79a6e687 | 16040 | (@pxref{Target Commands, ,Commands for Managing Targets}). |
c906108c | 16041 | |
a8f24a35 EZ |
16042 | @cindex target architecture |
16043 | It is possible to build @value{GDBN} for several different @dfn{target | |
16044 | architectures}. When @value{GDBN} is built like that, you can choose | |
16045 | one of the available architectures with the @kbd{set architecture} | |
16046 | command. | |
16047 | ||
16048 | @table @code | |
16049 | @kindex set architecture | |
16050 | @kindex show architecture | |
16051 | @item set architecture @var{arch} | |
16052 | This command sets the current target architecture to @var{arch}. The | |
16053 | value of @var{arch} can be @code{"auto"}, in addition to one of the | |
16054 | supported architectures. | |
16055 | ||
16056 | @item show architecture | |
16057 | Show the current target architecture. | |
9c16f35a EZ |
16058 | |
16059 | @item set processor | |
16060 | @itemx processor | |
16061 | @kindex set processor | |
16062 | @kindex show processor | |
16063 | These are alias commands for, respectively, @code{set architecture} | |
16064 | and @code{show architecture}. | |
a8f24a35 EZ |
16065 | @end table |
16066 | ||
c906108c SS |
16067 | @menu |
16068 | * Active Targets:: Active targets | |
16069 | * Target Commands:: Commands for managing targets | |
c906108c | 16070 | * Byte Order:: Choosing target byte order |
c906108c SS |
16071 | @end menu |
16072 | ||
6d2ebf8b | 16073 | @node Active Targets |
79a6e687 | 16074 | @section Active Targets |
7a292a7a | 16075 | |
c906108c SS |
16076 | @cindex stacking targets |
16077 | @cindex active targets | |
16078 | @cindex multiple targets | |
16079 | ||
8ea5bce5 | 16080 | There are multiple classes of targets such as: processes, executable files or |
c0edd9ed JK |
16081 | recording sessions. Core files belong to the process class, making core file |
16082 | and process mutually exclusive. Otherwise, @value{GDBN} can work concurrently | |
16083 | on multiple active targets, one in each class. This allows you to (for | |
16084 | example) start a process and inspect its activity, while still having access to | |
16085 | the executable file after the process finishes. Or if you start process | |
16086 | recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are | |
16087 | presented a virtual layer of the recording target, while the process target | |
16088 | remains stopped at the chronologically last point of the process execution. | |
16089 | ||
16090 | Use the @code{core-file} and @code{exec-file} commands to select a new core | |
16091 | file or executable target (@pxref{Files, ,Commands to Specify Files}). To | |
16092 | specify as a target a process that is already running, use the @code{attach} | |
16093 | command (@pxref{Attach, ,Debugging an Already-running Process}). | |
c906108c | 16094 | |
6d2ebf8b | 16095 | @node Target Commands |
79a6e687 | 16096 | @section Commands for Managing Targets |
c906108c SS |
16097 | |
16098 | @table @code | |
16099 | @item target @var{type} @var{parameters} | |
7a292a7a SS |
16100 | Connects the @value{GDBN} host environment to a target machine or |
16101 | process. A target is typically a protocol for talking to debugging | |
16102 | facilities. You use the argument @var{type} to specify the type or | |
16103 | protocol of the target machine. | |
c906108c SS |
16104 | |
16105 | Further @var{parameters} are interpreted by the target protocol, but | |
16106 | typically include things like device names or host names to connect | |
16107 | with, process numbers, and baud rates. | |
c906108c SS |
16108 | |
16109 | The @code{target} command does not repeat if you press @key{RET} again | |
16110 | after executing the command. | |
16111 | ||
16112 | @kindex help target | |
16113 | @item help target | |
16114 | Displays the names of all targets available. To display targets | |
16115 | currently selected, use either @code{info target} or @code{info files} | |
79a6e687 | 16116 | (@pxref{Files, ,Commands to Specify Files}). |
c906108c SS |
16117 | |
16118 | @item help target @var{name} | |
16119 | Describe a particular target, including any parameters necessary to | |
16120 | select it. | |
16121 | ||
16122 | @kindex set gnutarget | |
16123 | @item set gnutarget @var{args} | |
5d161b24 | 16124 | @value{GDBN} uses its own library BFD to read your files. @value{GDBN} |
c906108c | 16125 | knows whether it is reading an @dfn{executable}, |
5d161b24 DB |
16126 | a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format |
16127 | with the @code{set gnutarget} command. Unlike most @code{target} commands, | |
c906108c SS |
16128 | with @code{gnutarget} the @code{target} refers to a program, not a machine. |
16129 | ||
d4f3574e | 16130 | @quotation |
c906108c SS |
16131 | @emph{Warning:} To specify a file format with @code{set gnutarget}, |
16132 | you must know the actual BFD name. | |
d4f3574e | 16133 | @end quotation |
c906108c | 16134 | |
d4f3574e | 16135 | @noindent |
79a6e687 | 16136 | @xref{Files, , Commands to Specify Files}. |
c906108c | 16137 | |
5d161b24 | 16138 | @kindex show gnutarget |
c906108c SS |
16139 | @item show gnutarget |
16140 | Use the @code{show gnutarget} command to display what file format | |
16141 | @code{gnutarget} is set to read. If you have not set @code{gnutarget}, | |
16142 | @value{GDBN} will determine the file format for each file automatically, | |
16143 | and @code{show gnutarget} displays @samp{The current BDF target is "auto"}. | |
16144 | @end table | |
16145 | ||
4644b6e3 | 16146 | @cindex common targets |
c906108c SS |
16147 | Here are some common targets (available, or not, depending on the GDB |
16148 | configuration): | |
c906108c SS |
16149 | |
16150 | @table @code | |
4644b6e3 | 16151 | @kindex target |
c906108c | 16152 | @item target exec @var{program} |
4644b6e3 | 16153 | @cindex executable file target |
c906108c SS |
16154 | An executable file. @samp{target exec @var{program}} is the same as |
16155 | @samp{exec-file @var{program}}. | |
16156 | ||
c906108c | 16157 | @item target core @var{filename} |
4644b6e3 | 16158 | @cindex core dump file target |
c906108c SS |
16159 | A core dump file. @samp{target core @var{filename}} is the same as |
16160 | @samp{core-file @var{filename}}. | |
c906108c | 16161 | |
1a10341b | 16162 | @item target remote @var{medium} |
4644b6e3 | 16163 | @cindex remote target |
1a10341b JB |
16164 | A remote system connected to @value{GDBN} via a serial line or network |
16165 | connection. This command tells @value{GDBN} to use its own remote | |
16166 | protocol over @var{medium} for debugging. @xref{Remote Debugging}. | |
16167 | ||
16168 | For example, if you have a board connected to @file{/dev/ttya} on the | |
16169 | machine running @value{GDBN}, you could say: | |
16170 | ||
16171 | @smallexample | |
16172 | target remote /dev/ttya | |
16173 | @end smallexample | |
16174 | ||
16175 | @code{target remote} supports the @code{load} command. This is only | |
16176 | useful if you have some other way of getting the stub to the target | |
16177 | system, and you can put it somewhere in memory where it won't get | |
16178 | clobbered by the download. | |
c906108c | 16179 | |
ee8e71d4 | 16180 | @item target sim @r{[}@var{simargs}@r{]} @dots{} |
4644b6e3 | 16181 | @cindex built-in simulator target |
2df3850c | 16182 | Builtin CPU simulator. @value{GDBN} includes simulators for most architectures. |
104c1213 | 16183 | In general, |
474c8240 | 16184 | @smallexample |
104c1213 JM |
16185 | target sim |
16186 | load | |
16187 | run | |
474c8240 | 16188 | @end smallexample |
d4f3574e | 16189 | @noindent |
104c1213 | 16190 | works; however, you cannot assume that a specific memory map, device |
d4f3574e | 16191 | drivers, or even basic I/O is available, although some simulators do |
104c1213 JM |
16192 | provide these. For info about any processor-specific simulator details, |
16193 | see the appropriate section in @ref{Embedded Processors, ,Embedded | |
16194 | Processors}. | |
16195 | ||
c906108c SS |
16196 | @end table |
16197 | ||
104c1213 | 16198 | Some configurations may include these targets as well: |
c906108c SS |
16199 | |
16200 | @table @code | |
16201 | ||
c906108c | 16202 | @item target nrom @var{dev} |
4644b6e3 | 16203 | @cindex NetROM ROM emulator target |
c906108c SS |
16204 | NetROM ROM emulator. This target only supports downloading. |
16205 | ||
c906108c SS |
16206 | @end table |
16207 | ||
5d161b24 | 16208 | Different targets are available on different configurations of @value{GDBN}; |
c906108c | 16209 | your configuration may have more or fewer targets. |
c906108c | 16210 | |
721c2651 EZ |
16211 | Many remote targets require you to download the executable's code once |
16212 | you've successfully established a connection. You may wish to control | |
3d00d119 DJ |
16213 | various aspects of this process. |
16214 | ||
16215 | @table @code | |
721c2651 EZ |
16216 | |
16217 | @item set hash | |
16218 | @kindex set hash@r{, for remote monitors} | |
16219 | @cindex hash mark while downloading | |
16220 | This command controls whether a hash mark @samp{#} is displayed while | |
16221 | downloading a file to the remote monitor. If on, a hash mark is | |
16222 | displayed after each S-record is successfully downloaded to the | |
16223 | monitor. | |
16224 | ||
16225 | @item show hash | |
16226 | @kindex show hash@r{, for remote monitors} | |
16227 | Show the current status of displaying the hash mark. | |
16228 | ||
16229 | @item set debug monitor | |
16230 | @kindex set debug monitor | |
16231 | @cindex display remote monitor communications | |
16232 | Enable or disable display of communications messages between | |
16233 | @value{GDBN} and the remote monitor. | |
16234 | ||
16235 | @item show debug monitor | |
16236 | @kindex show debug monitor | |
16237 | Show the current status of displaying communications between | |
16238 | @value{GDBN} and the remote monitor. | |
a8f24a35 | 16239 | @end table |
c906108c SS |
16240 | |
16241 | @table @code | |
16242 | ||
16243 | @kindex load @var{filename} | |
16244 | @item load @var{filename} | |
8edfe269 | 16245 | @anchor{load} |
c906108c SS |
16246 | Depending on what remote debugging facilities are configured into |
16247 | @value{GDBN}, the @code{load} command may be available. Where it exists, it | |
16248 | is meant to make @var{filename} (an executable) available for debugging | |
16249 | on the remote system---by downloading, or dynamic linking, for example. | |
16250 | @code{load} also records the @var{filename} symbol table in @value{GDBN}, like | |
16251 | the @code{add-symbol-file} command. | |
16252 | ||
16253 | If your @value{GDBN} does not have a @code{load} command, attempting to | |
16254 | execute it gets the error message ``@code{You can't do that when your | |
16255 | target is @dots{}}'' | |
c906108c SS |
16256 | |
16257 | The file is loaded at whatever address is specified in the executable. | |
16258 | For some object file formats, you can specify the load address when you | |
16259 | link the program; for other formats, like a.out, the object file format | |
16260 | specifies a fixed address. | |
16261 | @c FIXME! This would be a good place for an xref to the GNU linker doc. | |
16262 | ||
68437a39 DJ |
16263 | Depending on the remote side capabilities, @value{GDBN} may be able to |
16264 | load programs into flash memory. | |
16265 | ||
c906108c SS |
16266 | @code{load} does not repeat if you press @key{RET} again after using it. |
16267 | @end table | |
16268 | ||
6d2ebf8b | 16269 | @node Byte Order |
79a6e687 | 16270 | @section Choosing Target Byte Order |
7a292a7a | 16271 | |
c906108c SS |
16272 | @cindex choosing target byte order |
16273 | @cindex target byte order | |
c906108c | 16274 | |
172c2a43 | 16275 | Some types of processors, such as the MIPS, PowerPC, and Renesas SH, |
c906108c SS |
16276 | offer the ability to run either big-endian or little-endian byte |
16277 | orders. Usually the executable or symbol will include a bit to | |
16278 | designate the endian-ness, and you will not need to worry about | |
16279 | which to use. However, you may still find it useful to adjust | |
d4f3574e | 16280 | @value{GDBN}'s idea of processor endian-ness manually. |
c906108c SS |
16281 | |
16282 | @table @code | |
4644b6e3 | 16283 | @kindex set endian |
c906108c SS |
16284 | @item set endian big |
16285 | Instruct @value{GDBN} to assume the target is big-endian. | |
16286 | ||
c906108c SS |
16287 | @item set endian little |
16288 | Instruct @value{GDBN} to assume the target is little-endian. | |
16289 | ||
c906108c SS |
16290 | @item set endian auto |
16291 | Instruct @value{GDBN} to use the byte order associated with the | |
16292 | executable. | |
16293 | ||
16294 | @item show endian | |
16295 | Display @value{GDBN}'s current idea of the target byte order. | |
16296 | ||
16297 | @end table | |
16298 | ||
16299 | Note that these commands merely adjust interpretation of symbolic | |
16300 | data on the host, and that they have absolutely no effect on the | |
16301 | target system. | |
16302 | ||
ea35711c DJ |
16303 | |
16304 | @node Remote Debugging | |
16305 | @chapter Debugging Remote Programs | |
c906108c SS |
16306 | @cindex remote debugging |
16307 | ||
16308 | If you are trying to debug a program running on a machine that cannot run | |
5d161b24 DB |
16309 | @value{GDBN} in the usual way, it is often useful to use remote debugging. |
16310 | For example, you might use remote debugging on an operating system kernel, | |
c906108c SS |
16311 | or on a small system which does not have a general purpose operating system |
16312 | powerful enough to run a full-featured debugger. | |
16313 | ||
16314 | Some configurations of @value{GDBN} have special serial or TCP/IP interfaces | |
16315 | to make this work with particular debugging targets. In addition, | |
5d161b24 | 16316 | @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN}, |
c906108c SS |
16317 | but not specific to any particular target system) which you can use if you |
16318 | write the remote stubs---the code that runs on the remote system to | |
16319 | communicate with @value{GDBN}. | |
16320 | ||
16321 | Other remote targets may be available in your | |
16322 | configuration of @value{GDBN}; use @code{help target} to list them. | |
c906108c | 16323 | |
6b2f586d | 16324 | @menu |
07f31aa6 | 16325 | * Connecting:: Connecting to a remote target |
a6b151f1 | 16326 | * File Transfer:: Sending files to a remote system |
6b2f586d | 16327 | * Server:: Using the gdbserver program |
79a6e687 BW |
16328 | * Remote Configuration:: Remote configuration |
16329 | * Remote Stub:: Implementing a remote stub | |
6b2f586d AC |
16330 | @end menu |
16331 | ||
07f31aa6 | 16332 | @node Connecting |
79a6e687 | 16333 | @section Connecting to a Remote Target |
07f31aa6 DJ |
16334 | |
16335 | On the @value{GDBN} host machine, you will need an unstripped copy of | |
d3e8051b | 16336 | your program, since @value{GDBN} needs symbol and debugging information. |
07f31aa6 DJ |
16337 | Start up @value{GDBN} as usual, using the name of the local copy of your |
16338 | program as the first argument. | |
16339 | ||
86941c27 JB |
16340 | @cindex @code{target remote} |
16341 | @value{GDBN} can communicate with the target over a serial line, or | |
16342 | over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In | |
16343 | each case, @value{GDBN} uses the same protocol for debugging your | |
16344 | program; only the medium carrying the debugging packets varies. The | |
16345 | @code{target remote} command establishes a connection to the target. | |
16346 | Its arguments indicate which medium to use: | |
16347 | ||
16348 | @table @code | |
16349 | ||
16350 | @item target remote @var{serial-device} | |
07f31aa6 | 16351 | @cindex serial line, @code{target remote} |
86941c27 JB |
16352 | Use @var{serial-device} to communicate with the target. For example, |
16353 | to use a serial line connected to the device named @file{/dev/ttyb}: | |
16354 | ||
16355 | @smallexample | |
16356 | target remote /dev/ttyb | |
16357 | @end smallexample | |
16358 | ||
07f31aa6 DJ |
16359 | If you're using a serial line, you may want to give @value{GDBN} the |
16360 | @w{@samp{--baud}} option, or use the @code{set remotebaud} command | |
79a6e687 | 16361 | (@pxref{Remote Configuration, set remotebaud}) before the |
9c16f35a | 16362 | @code{target} command. |
07f31aa6 | 16363 | |
86941c27 JB |
16364 | @item target remote @code{@var{host}:@var{port}} |
16365 | @itemx target remote @code{tcp:@var{host}:@var{port}} | |
16366 | @cindex @acronym{TCP} port, @code{target remote} | |
16367 | Debug using a @acronym{TCP} connection to @var{port} on @var{host}. | |
16368 | The @var{host} may be either a host name or a numeric @acronym{IP} | |
16369 | address; @var{port} must be a decimal number. The @var{host} could be | |
16370 | the target machine itself, if it is directly connected to the net, or | |
16371 | it might be a terminal server which in turn has a serial line to the | |
16372 | target. | |
07f31aa6 | 16373 | |
86941c27 JB |
16374 | For example, to connect to port 2828 on a terminal server named |
16375 | @code{manyfarms}: | |
07f31aa6 DJ |
16376 | |
16377 | @smallexample | |
16378 | target remote manyfarms:2828 | |
16379 | @end smallexample | |
16380 | ||
86941c27 JB |
16381 | If your remote target is actually running on the same machine as your |
16382 | debugger session (e.g.@: a simulator for your target running on the | |
16383 | same host), you can omit the hostname. For example, to connect to | |
16384 | port 1234 on your local machine: | |
07f31aa6 DJ |
16385 | |
16386 | @smallexample | |
16387 | target remote :1234 | |
16388 | @end smallexample | |
16389 | @noindent | |
16390 | ||
16391 | Note that the colon is still required here. | |
16392 | ||
86941c27 JB |
16393 | @item target remote @code{udp:@var{host}:@var{port}} |
16394 | @cindex @acronym{UDP} port, @code{target remote} | |
16395 | Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to | |
16396 | connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}: | |
07f31aa6 DJ |
16397 | |
16398 | @smallexample | |
16399 | target remote udp:manyfarms:2828 | |
16400 | @end smallexample | |
16401 | ||
86941c27 JB |
16402 | When using a @acronym{UDP} connection for remote debugging, you should |
16403 | keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP} | |
16404 | can silently drop packets on busy or unreliable networks, which will | |
16405 | cause havoc with your debugging session. | |
16406 | ||
66b8c7f6 JB |
16407 | @item target remote | @var{command} |
16408 | @cindex pipe, @code{target remote} to | |
16409 | Run @var{command} in the background and communicate with it using a | |
16410 | pipe. The @var{command} is a shell command, to be parsed and expanded | |
16411 | by the system's command shell, @code{/bin/sh}; it should expect remote | |
16412 | protocol packets on its standard input, and send replies on its | |
16413 | standard output. You could use this to run a stand-alone simulator | |
16414 | that speaks the remote debugging protocol, to make net connections | |
16415 | using programs like @code{ssh}, or for other similar tricks. | |
16416 | ||
16417 | If @var{command} closes its standard output (perhaps by exiting), | |
16418 | @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the | |
16419 | program has already exited, this will have no effect.) | |
16420 | ||
86941c27 | 16421 | @end table |
07f31aa6 | 16422 | |
86941c27 | 16423 | Once the connection has been established, you can use all the usual |
8edfe269 DJ |
16424 | commands to examine and change data. The remote program is already |
16425 | running; you can use @kbd{step} and @kbd{continue}, and you do not | |
16426 | need to use @kbd{run}. | |
07f31aa6 DJ |
16427 | |
16428 | @cindex interrupting remote programs | |
16429 | @cindex remote programs, interrupting | |
16430 | Whenever @value{GDBN} is waiting for the remote program, if you type the | |
c8aa23ab | 16431 | interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the |
07f31aa6 DJ |
16432 | program. This may or may not succeed, depending in part on the hardware |
16433 | and the serial drivers the remote system uses. If you type the | |
16434 | interrupt character once again, @value{GDBN} displays this prompt: | |
16435 | ||
16436 | @smallexample | |
16437 | Interrupted while waiting for the program. | |
16438 | Give up (and stop debugging it)? (y or n) | |
16439 | @end smallexample | |
16440 | ||
16441 | If you type @kbd{y}, @value{GDBN} abandons the remote debugging session. | |
16442 | (If you decide you want to try again later, you can use @samp{target | |
16443 | remote} again to connect once more.) If you type @kbd{n}, @value{GDBN} | |
16444 | goes back to waiting. | |
16445 | ||
16446 | @table @code | |
16447 | @kindex detach (remote) | |
16448 | @item detach | |
16449 | When you have finished debugging the remote program, you can use the | |
16450 | @code{detach} command to release it from @value{GDBN} control. | |
16451 | Detaching from the target normally resumes its execution, but the results | |
16452 | will depend on your particular remote stub. After the @code{detach} | |
16453 | command, @value{GDBN} is free to connect to another target. | |
16454 | ||
16455 | @kindex disconnect | |
16456 | @item disconnect | |
16457 | The @code{disconnect} command behaves like @code{detach}, except that | |
16458 | the target is generally not resumed. It will wait for @value{GDBN} | |
16459 | (this instance or another one) to connect and continue debugging. After | |
16460 | the @code{disconnect} command, @value{GDBN} is again free to connect to | |
16461 | another target. | |
09d4efe1 EZ |
16462 | |
16463 | @cindex send command to remote monitor | |
fad38dfa EZ |
16464 | @cindex extend @value{GDBN} for remote targets |
16465 | @cindex add new commands for external monitor | |
09d4efe1 EZ |
16466 | @kindex monitor |
16467 | @item monitor @var{cmd} | |
fad38dfa EZ |
16468 | This command allows you to send arbitrary commands directly to the |
16469 | remote monitor. Since @value{GDBN} doesn't care about the commands it | |
16470 | sends like this, this command is the way to extend @value{GDBN}---you | |
16471 | can add new commands that only the external monitor will understand | |
16472 | and implement. | |
07f31aa6 DJ |
16473 | @end table |
16474 | ||
a6b151f1 DJ |
16475 | @node File Transfer |
16476 | @section Sending files to a remote system | |
16477 | @cindex remote target, file transfer | |
16478 | @cindex file transfer | |
16479 | @cindex sending files to remote systems | |
16480 | ||
16481 | Some remote targets offer the ability to transfer files over the same | |
16482 | connection used to communicate with @value{GDBN}. This is convenient | |
16483 | for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems | |
16484 | running @code{gdbserver} over a network interface. For other targets, | |
16485 | e.g.@: embedded devices with only a single serial port, this may be | |
16486 | the only way to upload or download files. | |
16487 | ||
16488 | Not all remote targets support these commands. | |
16489 | ||
16490 | @table @code | |
16491 | @kindex remote put | |
16492 | @item remote put @var{hostfile} @var{targetfile} | |
16493 | Copy file @var{hostfile} from the host system (the machine running | |
16494 | @value{GDBN}) to @var{targetfile} on the target system. | |
16495 | ||
16496 | @kindex remote get | |
16497 | @item remote get @var{targetfile} @var{hostfile} | |
16498 | Copy file @var{targetfile} from the target system to @var{hostfile} | |
16499 | on the host system. | |
16500 | ||
16501 | @kindex remote delete | |
16502 | @item remote delete @var{targetfile} | |
16503 | Delete @var{targetfile} from the target system. | |
16504 | ||
16505 | @end table | |
16506 | ||
6f05cf9f | 16507 | @node Server |
79a6e687 | 16508 | @section Using the @code{gdbserver} Program |
6f05cf9f AC |
16509 | |
16510 | @kindex gdbserver | |
16511 | @cindex remote connection without stubs | |
16512 | @code{gdbserver} is a control program for Unix-like systems, which | |
16513 | allows you to connect your program with a remote @value{GDBN} via | |
16514 | @code{target remote}---but without linking in the usual debugging stub. | |
16515 | ||
16516 | @code{gdbserver} is not a complete replacement for the debugging stubs, | |
16517 | because it requires essentially the same operating-system facilities | |
16518 | that @value{GDBN} itself does. In fact, a system that can run | |
16519 | @code{gdbserver} to connect to a remote @value{GDBN} could also run | |
16520 | @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless, | |
16521 | because it is a much smaller program than @value{GDBN} itself. It is | |
16522 | also easier to port than all of @value{GDBN}, so you may be able to get | |
16523 | started more quickly on a new system by using @code{gdbserver}. | |
16524 | Finally, if you develop code for real-time systems, you may find that | |
16525 | the tradeoffs involved in real-time operation make it more convenient to | |
16526 | do as much development work as possible on another system, for example | |
16527 | by cross-compiling. You can use @code{gdbserver} to make a similar | |
16528 | choice for debugging. | |
16529 | ||
16530 | @value{GDBN} and @code{gdbserver} communicate via either a serial line | |
16531 | or a TCP connection, using the standard @value{GDBN} remote serial | |
16532 | protocol. | |
16533 | ||
2d717e4f DJ |
16534 | @quotation |
16535 | @emph{Warning:} @code{gdbserver} does not have any built-in security. | |
16536 | Do not run @code{gdbserver} connected to any public network; a | |
16537 | @value{GDBN} connection to @code{gdbserver} provides access to the | |
16538 | target system with the same privileges as the user running | |
16539 | @code{gdbserver}. | |
16540 | @end quotation | |
16541 | ||
16542 | @subsection Running @code{gdbserver} | |
16543 | @cindex arguments, to @code{gdbserver} | |
d9b1a651 | 16544 | @cindex @code{gdbserver}, command-line arguments |
2d717e4f DJ |
16545 | |
16546 | Run @code{gdbserver} on the target system. You need a copy of the | |
16547 | program you want to debug, including any libraries it requires. | |
6f05cf9f AC |
16548 | @code{gdbserver} does not need your program's symbol table, so you can |
16549 | strip the program if necessary to save space. @value{GDBN} on the host | |
16550 | system does all the symbol handling. | |
16551 | ||
16552 | To use the server, you must tell it how to communicate with @value{GDBN}; | |
56460a61 | 16553 | the name of your program; and the arguments for your program. The usual |
6f05cf9f AC |
16554 | syntax is: |
16555 | ||
16556 | @smallexample | |
16557 | target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ] | |
16558 | @end smallexample | |
16559 | ||
16560 | @var{comm} is either a device name (to use a serial line) or a TCP | |
16561 | hostname and portnumber. For example, to debug Emacs with the argument | |
16562 | @samp{foo.txt} and communicate with @value{GDBN} over the serial port | |
16563 | @file{/dev/com1}: | |
16564 | ||
16565 | @smallexample | |
16566 | target> gdbserver /dev/com1 emacs foo.txt | |
16567 | @end smallexample | |
16568 | ||
16569 | @code{gdbserver} waits passively for the host @value{GDBN} to communicate | |
16570 | with it. | |
16571 | ||
16572 | To use a TCP connection instead of a serial line: | |
16573 | ||
16574 | @smallexample | |
16575 | target> gdbserver host:2345 emacs foo.txt | |
16576 | @end smallexample | |
16577 | ||
16578 | The only difference from the previous example is the first argument, | |
16579 | specifying that you are communicating with the host @value{GDBN} via | |
16580 | TCP. The @samp{host:2345} argument means that @code{gdbserver} is to | |
16581 | expect a TCP connection from machine @samp{host} to local TCP port 2345. | |
16582 | (Currently, the @samp{host} part is ignored.) You can choose any number | |
16583 | you want for the port number as long as it does not conflict with any | |
16584 | TCP ports already in use on the target system (for example, @code{23} is | |
16585 | reserved for @code{telnet}).@footnote{If you choose a port number that | |
16586 | conflicts with another service, @code{gdbserver} prints an error message | |
16587 | and exits.} You must use the same port number with the host @value{GDBN} | |
16588 | @code{target remote} command. | |
16589 | ||
2d717e4f | 16590 | @subsubsection Attaching to a Running Program |
d9b1a651 EZ |
16591 | @cindex attach to a program, @code{gdbserver} |
16592 | @cindex @option{--attach}, @code{gdbserver} option | |
2d717e4f | 16593 | |
56460a61 DJ |
16594 | On some targets, @code{gdbserver} can also attach to running programs. |
16595 | This is accomplished via the @code{--attach} argument. The syntax is: | |
16596 | ||
16597 | @smallexample | |
2d717e4f | 16598 | target> gdbserver --attach @var{comm} @var{pid} |
56460a61 DJ |
16599 | @end smallexample |
16600 | ||
16601 | @var{pid} is the process ID of a currently running process. It isn't necessary | |
16602 | to point @code{gdbserver} at a binary for the running process. | |
16603 | ||
b1fe9455 | 16604 | @pindex pidof |
b1fe9455 DJ |
16605 | You can debug processes by name instead of process ID if your target has the |
16606 | @code{pidof} utility: | |
16607 | ||
16608 | @smallexample | |
2d717e4f | 16609 | target> gdbserver --attach @var{comm} `pidof @var{program}` |
b1fe9455 DJ |
16610 | @end smallexample |
16611 | ||
f822c95b | 16612 | In case more than one copy of @var{program} is running, or @var{program} |
b1fe9455 DJ |
16613 | has multiple threads, most versions of @code{pidof} support the |
16614 | @code{-s} option to only return the first process ID. | |
16615 | ||
2d717e4f | 16616 | @subsubsection Multi-Process Mode for @code{gdbserver} |
d9b1a651 EZ |
16617 | @cindex @code{gdbserver}, multiple processes |
16618 | @cindex multiple processes with @code{gdbserver} | |
2d717e4f DJ |
16619 | |
16620 | When you connect to @code{gdbserver} using @code{target remote}, | |
16621 | @code{gdbserver} debugs the specified program only once. When the | |
16622 | program exits, or you detach from it, @value{GDBN} closes the connection | |
16623 | and @code{gdbserver} exits. | |
16624 | ||
6e6c6f50 | 16625 | If you connect using @kbd{target extended-remote}, @code{gdbserver} |
2d717e4f DJ |
16626 | enters multi-process mode. When the debugged program exits, or you |
16627 | detach from it, @value{GDBN} stays connected to @code{gdbserver} even | |
16628 | though no program is running. The @code{run} and @code{attach} | |
16629 | commands instruct @code{gdbserver} to run or attach to a new program. | |
16630 | The @code{run} command uses @code{set remote exec-file} (@pxref{set | |
16631 | remote exec-file}) to select the program to run. Command line | |
16632 | arguments are supported, except for wildcard expansion and I/O | |
16633 | redirection (@pxref{Arguments}). | |
16634 | ||
d9b1a651 | 16635 | @cindex @option{--multi}, @code{gdbserver} option |
2d717e4f DJ |
16636 | To start @code{gdbserver} without supplying an initial command to run |
16637 | or process ID to attach, use the @option{--multi} command line option. | |
6e6c6f50 | 16638 | Then you can connect using @kbd{target extended-remote} and start |
2d717e4f DJ |
16639 | the program you want to debug. |
16640 | ||
03f2bd59 JK |
16641 | In multi-process mode @code{gdbserver} does not automatically exit unless you |
16642 | use the option @option{--once}. You can terminate it by using | |
16643 | @code{monitor exit} (@pxref{Monitor Commands for gdbserver}). Note that the | |
16644 | conditions under which @code{gdbserver} terminates depend on how @value{GDBN} | |
16645 | connects to it (@kbd{target remote} or @kbd{target extended-remote}). The | |
16646 | @option{--multi} option to @code{gdbserver} has no influence on that. | |
16647 | ||
16648 | @subsubsection TCP port allocation lifecycle of @code{gdbserver} | |
16649 | ||
16650 | This section applies only when @code{gdbserver} is run to listen on a TCP port. | |
16651 | ||
16652 | @code{gdbserver} normally terminates after all of its debugged processes have | |
16653 | terminated in @kbd{target remote} mode. On the other hand, for @kbd{target | |
16654 | extended-remote}, @code{gdbserver} stays running even with no processes left. | |
16655 | @value{GDBN} normally terminates the spawned debugged process on its exit, | |
16656 | which normally also terminates @code{gdbserver} in the @kbd{target remote} | |
16657 | mode. Therefore, when the connection drops unexpectedly, and @value{GDBN} | |
16658 | cannot ask @code{gdbserver} to kill its debugged processes, @code{gdbserver} | |
16659 | stays running even in the @kbd{target remote} mode. | |
16660 | ||
16661 | When @code{gdbserver} stays running, @value{GDBN} can connect to it again later. | |
16662 | Such reconnecting is useful for features like @ref{disconnected tracing}. For | |
16663 | completeness, at most one @value{GDBN} can be connected at a time. | |
16664 | ||
16665 | @cindex @option{--once}, @code{gdbserver} option | |
16666 | By default, @code{gdbserver} keeps the listening TCP port open, so that | |
16667 | additional connections are possible. However, if you start @code{gdbserver} | |
16668 | with the @option{--once} option, it will stop listening for any further | |
16669 | connection attempts after connecting to the first @value{GDBN} session. This | |
16670 | means no further connections to @code{gdbserver} will be possible after the | |
16671 | first one. It also means @code{gdbserver} will terminate after the first | |
16672 | connection with remote @value{GDBN} has closed, even for unexpectedly closed | |
16673 | connections and even in the @kbd{target extended-remote} mode. The | |
16674 | @option{--once} option allows reusing the same port number for connecting to | |
16675 | multiple instances of @code{gdbserver} running on the same host, since each | |
16676 | instance closes its port after the first connection. | |
2d717e4f DJ |
16677 | |
16678 | @subsubsection Other Command-Line Arguments for @code{gdbserver} | |
16679 | ||
d9b1a651 | 16680 | @cindex @option{--debug}, @code{gdbserver} option |
62709adf | 16681 | The @option{--debug} option tells @code{gdbserver} to display extra |
d9b1a651 EZ |
16682 | status information about the debugging process. |
16683 | @cindex @option{--remote-debug}, @code{gdbserver} option | |
16684 | The @option{--remote-debug} option tells @code{gdbserver} to display | |
62709adf PA |
16685 | remote protocol debug output. These options are intended for |
16686 | @code{gdbserver} development and for bug reports to the developers. | |
2d717e4f | 16687 | |
d9b1a651 | 16688 | @cindex @option{--wrapper}, @code{gdbserver} option |
ccd213ac DJ |
16689 | The @option{--wrapper} option specifies a wrapper to launch programs |
16690 | for debugging. The option should be followed by the name of the | |
16691 | wrapper, then any command-line arguments to pass to the wrapper, then | |
16692 | @kbd{--} indicating the end of the wrapper arguments. | |
16693 | ||
16694 | @code{gdbserver} runs the specified wrapper program with a combined | |
16695 | command line including the wrapper arguments, then the name of the | |
16696 | program to debug, then any arguments to the program. The wrapper | |
16697 | runs until it executes your program, and then @value{GDBN} gains control. | |
16698 | ||
16699 | You can use any program that eventually calls @code{execve} with | |
16700 | its arguments as a wrapper. Several standard Unix utilities do | |
16701 | this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending | |
16702 | with @code{exec "$@@"} will also work. | |
16703 | ||
16704 | For example, you can use @code{env} to pass an environment variable to | |
16705 | the debugged program, without setting the variable in @code{gdbserver}'s | |
16706 | environment: | |
16707 | ||
16708 | @smallexample | |
16709 | $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog | |
16710 | @end smallexample | |
16711 | ||
2d717e4f DJ |
16712 | @subsection Connecting to @code{gdbserver} |
16713 | ||
16714 | Run @value{GDBN} on the host system. | |
16715 | ||
16716 | First make sure you have the necessary symbol files. Load symbols for | |
f822c95b DJ |
16717 | your application using the @code{file} command before you connect. Use |
16718 | @code{set sysroot} to locate target libraries (unless your @value{GDBN} | |
2d717e4f | 16719 | was compiled with the correct sysroot using @code{--with-sysroot}). |
f822c95b DJ |
16720 | |
16721 | The symbol file and target libraries must exactly match the executable | |
16722 | and libraries on the target, with one exception: the files on the host | |
16723 | system should not be stripped, even if the files on the target system | |
16724 | are. Mismatched or missing files will lead to confusing results | |
16725 | during debugging. On @sc{gnu}/Linux targets, mismatched or missing | |
16726 | files may also prevent @code{gdbserver} from debugging multi-threaded | |
16727 | programs. | |
16728 | ||
79a6e687 | 16729 | Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}). |
6f05cf9f AC |
16730 | For TCP connections, you must start up @code{gdbserver} prior to using |
16731 | the @code{target remote} command. Otherwise you may get an error whose | |
16732 | text depends on the host system, but which usually looks something like | |
2d717e4f | 16733 | @samp{Connection refused}. Don't use the @code{load} |
397ca115 | 16734 | command in @value{GDBN} when using @code{gdbserver}, since the program is |
f822c95b | 16735 | already on the target. |
07f31aa6 | 16736 | |
79a6e687 | 16737 | @subsection Monitor Commands for @code{gdbserver} |
c74d0ad8 | 16738 | @cindex monitor commands, for @code{gdbserver} |
2d717e4f | 16739 | @anchor{Monitor Commands for gdbserver} |
c74d0ad8 DJ |
16740 | |
16741 | During a @value{GDBN} session using @code{gdbserver}, you can use the | |
16742 | @code{monitor} command to send special requests to @code{gdbserver}. | |
2d717e4f | 16743 | Here are the available commands. |
c74d0ad8 DJ |
16744 | |
16745 | @table @code | |
16746 | @item monitor help | |
16747 | List the available monitor commands. | |
16748 | ||
16749 | @item monitor set debug 0 | |
16750 | @itemx monitor set debug 1 | |
16751 | Disable or enable general debugging messages. | |
16752 | ||
16753 | @item monitor set remote-debug 0 | |
16754 | @itemx monitor set remote-debug 1 | |
16755 | Disable or enable specific debugging messages associated with the remote | |
16756 | protocol (@pxref{Remote Protocol}). | |
16757 | ||
cdbfd419 PP |
16758 | @item monitor set libthread-db-search-path [PATH] |
16759 | @cindex gdbserver, search path for @code{libthread_db} | |
16760 | When this command is issued, @var{path} is a colon-separated list of | |
16761 | directories to search for @code{libthread_db} (@pxref{Threads,,set | |
16762 | libthread-db-search-path}). If you omit @var{path}, | |
84e578fb | 16763 | @samp{libthread-db-search-path} will be reset to its default value. |
cdbfd419 | 16764 | |
98a5dd13 DE |
16765 | The special entry @samp{$pdir} for @samp{libthread-db-search-path} is |
16766 | not supported in @code{gdbserver}. | |
16767 | ||
2d717e4f DJ |
16768 | @item monitor exit |
16769 | Tell gdbserver to exit immediately. This command should be followed by | |
16770 | @code{disconnect} to close the debugging session. @code{gdbserver} will | |
16771 | detach from any attached processes and kill any processes it created. | |
16772 | Use @code{monitor exit} to terminate @code{gdbserver} at the end | |
16773 | of a multi-process mode debug session. | |
16774 | ||
c74d0ad8 DJ |
16775 | @end table |
16776 | ||
fa593d66 PA |
16777 | @subsection Tracepoints support in @code{gdbserver} |
16778 | @cindex tracepoints support in @code{gdbserver} | |
16779 | ||
0fb4aa4b PA |
16780 | On some targets, @code{gdbserver} supports tracepoints, fast |
16781 | tracepoints and static tracepoints. | |
fa593d66 | 16782 | |
0fb4aa4b | 16783 | For fast or static tracepoints to work, a special library called the |
fa593d66 PA |
16784 | @dfn{in-process agent} (IPA), must be loaded in the inferior process. |
16785 | This library is built and distributed as an integral part of | |
0fb4aa4b PA |
16786 | @code{gdbserver}. In addition, support for static tracepoints |
16787 | requires building the in-process agent library with static tracepoints | |
16788 | support. At present, the UST (LTTng Userspace Tracer, | |
16789 | @url{http://lttng.org/ust}) tracing engine is supported. This support | |
16790 | is automatically available if UST development headers are found in the | |
16791 | standard include path when @code{gdbserver} is built, or if | |
16792 | @code{gdbserver} was explicitly configured using @option{--with-ust} | |
16793 | to point at such headers. You can explicitly disable the support | |
16794 | using @option{--with-ust=no}. | |
fa593d66 PA |
16795 | |
16796 | There are several ways to load the in-process agent in your program: | |
16797 | ||
16798 | @table @code | |
16799 | @item Specifying it as dependency at link time | |
16800 | ||
16801 | You can link your program dynamically with the in-process agent | |
16802 | library. On most systems, this is accomplished by adding | |
16803 | @code{-linproctrace} to the link command. | |
16804 | ||
16805 | @item Using the system's preloading mechanisms | |
16806 | ||
16807 | You can force loading the in-process agent at startup time by using | |
16808 | your system's support for preloading shared libraries. Many Unixes | |
16809 | support the concept of preloading user defined libraries. In most | |
16810 | cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so} | |
16811 | in the environment. See also the description of @code{gdbserver}'s | |
16812 | @option{--wrapper} command line option. | |
16813 | ||
16814 | @item Using @value{GDBN} to force loading the agent at run time | |
16815 | ||
16816 | On some systems, you can force the inferior to load a shared library, | |
16817 | by calling a dynamic loader function in the inferior that takes care | |
16818 | of dynamically looking up and loading a shared library. On most Unix | |
16819 | systems, the function is @code{dlopen}. You'll use the @code{call} | |
16820 | command for that. For example: | |
16821 | ||
16822 | @smallexample | |
16823 | (@value{GDBP}) call dlopen ("libinproctrace.so", ...) | |
16824 | @end smallexample | |
16825 | ||
16826 | Note that on most Unix systems, for the @code{dlopen} function to be | |
16827 | available, the program needs to be linked with @code{-ldl}. | |
16828 | @end table | |
16829 | ||
16830 | On systems that have a userspace dynamic loader, like most Unix | |
16831 | systems, when you connect to @code{gdbserver} using @code{target | |
16832 | remote}, you'll find that the program is stopped at the dynamic | |
16833 | loader's entry point, and no shared library has been loaded in the | |
16834 | program's address space yet, including the in-process agent. In that | |
0fb4aa4b PA |
16835 | case, before being able to use any of the fast or static tracepoints |
16836 | features, you need to let the loader run and load the shared | |
16837 | libraries. The simplest way to do that is to run the program to the | |
16838 | main procedure. E.g., if debugging a C or C@t{++} program, start | |
fa593d66 PA |
16839 | @code{gdbserver} like so: |
16840 | ||
16841 | @smallexample | |
16842 | $ gdbserver :9999 myprogram | |
16843 | @end smallexample | |
16844 | ||
16845 | Start GDB and connect to @code{gdbserver} like so, and run to main: | |
16846 | ||
16847 | @smallexample | |
16848 | $ gdb myprogram | |
16849 | (@value{GDBP}) target remote myhost:9999 | |
16850 | 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2 | |
16851 | (@value{GDBP}) b main | |
16852 | (@value{GDBP}) continue | |
16853 | @end smallexample | |
16854 | ||
16855 | The in-process tracing agent library should now be loaded into the | |
16856 | process; you can confirm it with the @code{info sharedlibrary} | |
16857 | command, which will list @file{libinproctrace.so} as loaded in the | |
0fb4aa4b PA |
16858 | process. You are now ready to install fast tracepoints, list static |
16859 | tracepoint markers, probe static tracepoints markers, and start | |
fa593d66 PA |
16860 | tracing. |
16861 | ||
79a6e687 BW |
16862 | @node Remote Configuration |
16863 | @section Remote Configuration | |
501eef12 | 16864 | |
9c16f35a EZ |
16865 | @kindex set remote |
16866 | @kindex show remote | |
16867 | This section documents the configuration options available when | |
16868 | debugging remote programs. For the options related to the File I/O | |
fc320d37 | 16869 | extensions of the remote protocol, see @ref{system, |
9c16f35a | 16870 | system-call-allowed}. |
501eef12 AC |
16871 | |
16872 | @table @code | |
9c16f35a | 16873 | @item set remoteaddresssize @var{bits} |
d3e8051b | 16874 | @cindex address size for remote targets |
9c16f35a EZ |
16875 | @cindex bits in remote address |
16876 | Set the maximum size of address in a memory packet to the specified | |
16877 | number of bits. @value{GDBN} will mask off the address bits above | |
16878 | that number, when it passes addresses to the remote target. The | |
16879 | default value is the number of bits in the target's address. | |
16880 | ||
16881 | @item show remoteaddresssize | |
16882 | Show the current value of remote address size in bits. | |
16883 | ||
16884 | @item set remotebaud @var{n} | |
16885 | @cindex baud rate for remote targets | |
16886 | Set the baud rate for the remote serial I/O to @var{n} baud. The | |
16887 | value is used to set the speed of the serial port used for debugging | |
16888 | remote targets. | |
16889 | ||
16890 | @item show remotebaud | |
16891 | Show the current speed of the remote connection. | |
16892 | ||
16893 | @item set remotebreak | |
16894 | @cindex interrupt remote programs | |
16895 | @cindex BREAK signal instead of Ctrl-C | |
9a6253be | 16896 | @anchor{set remotebreak} |
9c16f35a | 16897 | If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote |
c8aa23ab | 16898 | when you type @kbd{Ctrl-c} to interrupt the program running |
9a7a1b36 | 16899 | on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C} |
9c16f35a EZ |
16900 | character instead. The default is off, since most remote systems |
16901 | expect to see @samp{Ctrl-C} as the interrupt signal. | |
16902 | ||
16903 | @item show remotebreak | |
16904 | Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to | |
16905 | interrupt the remote program. | |
16906 | ||
23776285 MR |
16907 | @item set remoteflow on |
16908 | @itemx set remoteflow off | |
16909 | @kindex set remoteflow | |
16910 | Enable or disable hardware flow control (@code{RTS}/@code{CTS}) | |
16911 | on the serial port used to communicate to the remote target. | |
16912 | ||
16913 | @item show remoteflow | |
16914 | @kindex show remoteflow | |
16915 | Show the current setting of hardware flow control. | |
16916 | ||
9c16f35a EZ |
16917 | @item set remotelogbase @var{base} |
16918 | Set the base (a.k.a.@: radix) of logging serial protocol | |
16919 | communications to @var{base}. Supported values of @var{base} are: | |
16920 | @code{ascii}, @code{octal}, and @code{hex}. The default is | |
16921 | @code{ascii}. | |
16922 | ||
16923 | @item show remotelogbase | |
16924 | Show the current setting of the radix for logging remote serial | |
16925 | protocol. | |
16926 | ||
16927 | @item set remotelogfile @var{file} | |
16928 | @cindex record serial communications on file | |
16929 | Record remote serial communications on the named @var{file}. The | |
16930 | default is not to record at all. | |
16931 | ||
16932 | @item show remotelogfile. | |
16933 | Show the current setting of the file name on which to record the | |
16934 | serial communications. | |
16935 | ||
16936 | @item set remotetimeout @var{num} | |
16937 | @cindex timeout for serial communications | |
16938 | @cindex remote timeout | |
16939 | Set the timeout limit to wait for the remote target to respond to | |
16940 | @var{num} seconds. The default is 2 seconds. | |
16941 | ||
16942 | @item show remotetimeout | |
16943 | Show the current number of seconds to wait for the remote target | |
16944 | responses. | |
16945 | ||
16946 | @cindex limit hardware breakpoints and watchpoints | |
16947 | @cindex remote target, limit break- and watchpoints | |
501eef12 AC |
16948 | @anchor{set remote hardware-watchpoint-limit} |
16949 | @anchor{set remote hardware-breakpoint-limit} | |
16950 | @item set remote hardware-watchpoint-limit @var{limit} | |
16951 | @itemx set remote hardware-breakpoint-limit @var{limit} | |
16952 | Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or | |
16953 | watchpoints. A limit of -1, the default, is treated as unlimited. | |
2d717e4f | 16954 | |
480a3f21 PW |
16955 | @cindex limit hardware watchpoints length |
16956 | @cindex remote target, limit watchpoints length | |
16957 | @anchor{set remote hardware-watchpoint-length-limit} | |
16958 | @item set remote hardware-watchpoint-length-limit @var{limit} | |
16959 | Restrict @value{GDBN} to using @var{limit} bytes for the maximum length of | |
16960 | a remote hardware watchpoint. A limit of -1, the default, is treated | |
16961 | as unlimited. | |
16962 | ||
16963 | @item show remote hardware-watchpoint-length-limit | |
16964 | Show the current limit (in bytes) of the maximum length of | |
16965 | a remote hardware watchpoint. | |
16966 | ||
2d717e4f DJ |
16967 | @item set remote exec-file @var{filename} |
16968 | @itemx show remote exec-file | |
16969 | @anchor{set remote exec-file} | |
16970 | @cindex executable file, for remote target | |
16971 | Select the file used for @code{run} with @code{target | |
16972 | extended-remote}. This should be set to a filename valid on the | |
16973 | target system. If it is not set, the target will use a default | |
16974 | filename (e.g.@: the last program run). | |
84603566 | 16975 | |
9a7071a8 JB |
16976 | @item set remote interrupt-sequence |
16977 | @cindex interrupt remote programs | |
16978 | @cindex select Ctrl-C, BREAK or BREAK-g | |
16979 | Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or | |
16980 | @samp{BREAK-g} as the | |
16981 | sequence to the remote target in order to interrupt the execution. | |
16982 | @samp{Ctrl-C} is a default. Some system prefers @code{BREAK} which | |
16983 | is high level of serial line for some certain time. | |
16984 | Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g. | |
16985 | It is @code{BREAK} signal followed by character @code{g}. | |
16986 | ||
16987 | @item show interrupt-sequence | |
16988 | Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g} | |
16989 | is sent by @value{GDBN} to interrupt the remote program. | |
16990 | @code{BREAK-g} is BREAK signal followed by @code{g} and | |
16991 | also known as Magic SysRq g. | |
16992 | ||
16993 | @item set remote interrupt-on-connect | |
16994 | @cindex send interrupt-sequence on start | |
16995 | Specify whether interrupt-sequence is sent to remote target when | |
16996 | @value{GDBN} connects to it. This is mostly needed when you debug | |
16997 | Linux kernel. Linux kernel expects @code{BREAK} followed by @code{g} | |
16998 | which is known as Magic SysRq g in order to connect @value{GDBN}. | |
16999 | ||
17000 | @item show interrupt-on-connect | |
17001 | Show whether interrupt-sequence is sent | |
17002 | to remote target when @value{GDBN} connects to it. | |
17003 | ||
84603566 SL |
17004 | @kindex set tcp |
17005 | @kindex show tcp | |
17006 | @item set tcp auto-retry on | |
17007 | @cindex auto-retry, for remote TCP target | |
17008 | Enable auto-retry for remote TCP connections. This is useful if the remote | |
17009 | debugging agent is launched in parallel with @value{GDBN}; there is a race | |
17010 | condition because the agent may not become ready to accept the connection | |
17011 | before @value{GDBN} attempts to connect. When auto-retry is | |
17012 | enabled, if the initial attempt to connect fails, @value{GDBN} reattempts | |
17013 | to establish the connection using the timeout specified by | |
17014 | @code{set tcp connect-timeout}. | |
17015 | ||
17016 | @item set tcp auto-retry off | |
17017 | Do not auto-retry failed TCP connections. | |
17018 | ||
17019 | @item show tcp auto-retry | |
17020 | Show the current auto-retry setting. | |
17021 | ||
17022 | @item set tcp connect-timeout @var{seconds} | |
17023 | @cindex connection timeout, for remote TCP target | |
17024 | @cindex timeout, for remote target connection | |
17025 | Set the timeout for establishing a TCP connection to the remote target to | |
17026 | @var{seconds}. The timeout affects both polling to retry failed connections | |
17027 | (enabled by @code{set tcp auto-retry on}) and waiting for connections | |
17028 | that are merely slow to complete, and represents an approximate cumulative | |
17029 | value. | |
17030 | ||
17031 | @item show tcp connect-timeout | |
17032 | Show the current connection timeout setting. | |
501eef12 AC |
17033 | @end table |
17034 | ||
427c3a89 DJ |
17035 | @cindex remote packets, enabling and disabling |
17036 | The @value{GDBN} remote protocol autodetects the packets supported by | |
17037 | your debugging stub. If you need to override the autodetection, you | |
17038 | can use these commands to enable or disable individual packets. Each | |
17039 | packet can be set to @samp{on} (the remote target supports this | |
17040 | packet), @samp{off} (the remote target does not support this packet), | |
17041 | or @samp{auto} (detect remote target support for this packet). They | |
17042 | all default to @samp{auto}. For more information about each packet, | |
17043 | see @ref{Remote Protocol}. | |
17044 | ||
17045 | During normal use, you should not have to use any of these commands. | |
17046 | If you do, that may be a bug in your remote debugging stub, or a bug | |
17047 | in @value{GDBN}. You may want to report the problem to the | |
17048 | @value{GDBN} developers. | |
17049 | ||
cfa9d6d9 DJ |
17050 | For each packet @var{name}, the command to enable or disable the |
17051 | packet is @code{set remote @var{name}-packet}. The available settings | |
17052 | are: | |
427c3a89 | 17053 | |
cfa9d6d9 | 17054 | @multitable @columnfractions 0.28 0.32 0.25 |
427c3a89 DJ |
17055 | @item Command Name |
17056 | @tab Remote Packet | |
17057 | @tab Related Features | |
17058 | ||
cfa9d6d9 | 17059 | @item @code{fetch-register} |
427c3a89 DJ |
17060 | @tab @code{p} |
17061 | @tab @code{info registers} | |
17062 | ||
cfa9d6d9 | 17063 | @item @code{set-register} |
427c3a89 DJ |
17064 | @tab @code{P} |
17065 | @tab @code{set} | |
17066 | ||
cfa9d6d9 | 17067 | @item @code{binary-download} |
427c3a89 DJ |
17068 | @tab @code{X} |
17069 | @tab @code{load}, @code{set} | |
17070 | ||
cfa9d6d9 | 17071 | @item @code{read-aux-vector} |
427c3a89 DJ |
17072 | @tab @code{qXfer:auxv:read} |
17073 | @tab @code{info auxv} | |
17074 | ||
cfa9d6d9 | 17075 | @item @code{symbol-lookup} |
427c3a89 DJ |
17076 | @tab @code{qSymbol} |
17077 | @tab Detecting multiple threads | |
17078 | ||
2d717e4f DJ |
17079 | @item @code{attach} |
17080 | @tab @code{vAttach} | |
17081 | @tab @code{attach} | |
17082 | ||
cfa9d6d9 | 17083 | @item @code{verbose-resume} |
427c3a89 DJ |
17084 | @tab @code{vCont} |
17085 | @tab Stepping or resuming multiple threads | |
17086 | ||
2d717e4f DJ |
17087 | @item @code{run} |
17088 | @tab @code{vRun} | |
17089 | @tab @code{run} | |
17090 | ||
cfa9d6d9 | 17091 | @item @code{software-breakpoint} |
427c3a89 DJ |
17092 | @tab @code{Z0} |
17093 | @tab @code{break} | |
17094 | ||
cfa9d6d9 | 17095 | @item @code{hardware-breakpoint} |
427c3a89 DJ |
17096 | @tab @code{Z1} |
17097 | @tab @code{hbreak} | |
17098 | ||
cfa9d6d9 | 17099 | @item @code{write-watchpoint} |
427c3a89 DJ |
17100 | @tab @code{Z2} |
17101 | @tab @code{watch} | |
17102 | ||
cfa9d6d9 | 17103 | @item @code{read-watchpoint} |
427c3a89 DJ |
17104 | @tab @code{Z3} |
17105 | @tab @code{rwatch} | |
17106 | ||
cfa9d6d9 | 17107 | @item @code{access-watchpoint} |
427c3a89 DJ |
17108 | @tab @code{Z4} |
17109 | @tab @code{awatch} | |
17110 | ||
cfa9d6d9 DJ |
17111 | @item @code{target-features} |
17112 | @tab @code{qXfer:features:read} | |
17113 | @tab @code{set architecture} | |
17114 | ||
17115 | @item @code{library-info} | |
17116 | @tab @code{qXfer:libraries:read} | |
17117 | @tab @code{info sharedlibrary} | |
17118 | ||
17119 | @item @code{memory-map} | |
17120 | @tab @code{qXfer:memory-map:read} | |
17121 | @tab @code{info mem} | |
17122 | ||
0fb4aa4b PA |
17123 | @item @code{read-sdata-object} |
17124 | @tab @code{qXfer:sdata:read} | |
17125 | @tab @code{print $_sdata} | |
17126 | ||
cfa9d6d9 DJ |
17127 | @item @code{read-spu-object} |
17128 | @tab @code{qXfer:spu:read} | |
17129 | @tab @code{info spu} | |
17130 | ||
17131 | @item @code{write-spu-object} | |
17132 | @tab @code{qXfer:spu:write} | |
17133 | @tab @code{info spu} | |
17134 | ||
4aa995e1 PA |
17135 | @item @code{read-siginfo-object} |
17136 | @tab @code{qXfer:siginfo:read} | |
17137 | @tab @code{print $_siginfo} | |
17138 | ||
17139 | @item @code{write-siginfo-object} | |
17140 | @tab @code{qXfer:siginfo:write} | |
17141 | @tab @code{set $_siginfo} | |
17142 | ||
dc146f7c VP |
17143 | @item @code{threads} |
17144 | @tab @code{qXfer:threads:read} | |
17145 | @tab @code{info threads} | |
17146 | ||
cfa9d6d9 | 17147 | @item @code{get-thread-local-@*storage-address} |
427c3a89 DJ |
17148 | @tab @code{qGetTLSAddr} |
17149 | @tab Displaying @code{__thread} variables | |
17150 | ||
711e434b PM |
17151 | @item @code{get-thread-information-block-address} |
17152 | @tab @code{qGetTIBAddr} | |
17153 | @tab Display MS-Windows Thread Information Block. | |
17154 | ||
08388c79 DE |
17155 | @item @code{search-memory} |
17156 | @tab @code{qSearch:memory} | |
17157 | @tab @code{find} | |
17158 | ||
427c3a89 DJ |
17159 | @item @code{supported-packets} |
17160 | @tab @code{qSupported} | |
17161 | @tab Remote communications parameters | |
17162 | ||
cfa9d6d9 | 17163 | @item @code{pass-signals} |
89be2091 DJ |
17164 | @tab @code{QPassSignals} |
17165 | @tab @code{handle @var{signal}} | |
17166 | ||
a6b151f1 DJ |
17167 | @item @code{hostio-close-packet} |
17168 | @tab @code{vFile:close} | |
17169 | @tab @code{remote get}, @code{remote put} | |
17170 | ||
17171 | @item @code{hostio-open-packet} | |
17172 | @tab @code{vFile:open} | |
17173 | @tab @code{remote get}, @code{remote put} | |
17174 | ||
17175 | @item @code{hostio-pread-packet} | |
17176 | @tab @code{vFile:pread} | |
17177 | @tab @code{remote get}, @code{remote put} | |
17178 | ||
17179 | @item @code{hostio-pwrite-packet} | |
17180 | @tab @code{vFile:pwrite} | |
17181 | @tab @code{remote get}, @code{remote put} | |
17182 | ||
17183 | @item @code{hostio-unlink-packet} | |
17184 | @tab @code{vFile:unlink} | |
17185 | @tab @code{remote delete} | |
a6f3e723 SL |
17186 | |
17187 | @item @code{noack-packet} | |
17188 | @tab @code{QStartNoAckMode} | |
17189 | @tab Packet acknowledgment | |
07e059b5 VP |
17190 | |
17191 | @item @code{osdata} | |
17192 | @tab @code{qXfer:osdata:read} | |
17193 | @tab @code{info os} | |
0b16c5cf PA |
17194 | |
17195 | @item @code{query-attached} | |
17196 | @tab @code{qAttached} | |
17197 | @tab Querying remote process attach state. | |
b3b9301e PA |
17198 | |
17199 | @item @code{traceframe-info} | |
17200 | @tab @code{qXfer:traceframe-info:read} | |
17201 | @tab Traceframe info | |
03583c20 UW |
17202 | |
17203 | @item @code{disable-randomization} | |
17204 | @tab @code{QDisableRandomization} | |
17205 | @tab @code{set disable-randomization} | |
427c3a89 DJ |
17206 | @end multitable |
17207 | ||
79a6e687 BW |
17208 | @node Remote Stub |
17209 | @section Implementing a Remote Stub | |
7a292a7a | 17210 | |
8e04817f AC |
17211 | @cindex debugging stub, example |
17212 | @cindex remote stub, example | |
17213 | @cindex stub example, remote debugging | |
17214 | The stub files provided with @value{GDBN} implement the target side of the | |
17215 | communication protocol, and the @value{GDBN} side is implemented in the | |
17216 | @value{GDBN} source file @file{remote.c}. Normally, you can simply allow | |
17217 | these subroutines to communicate, and ignore the details. (If you're | |
17218 | implementing your own stub file, you can still ignore the details: start | |
17219 | with one of the existing stub files. @file{sparc-stub.c} is the best | |
17220 | organized, and therefore the easiest to read.) | |
17221 | ||
104c1213 JM |
17222 | @cindex remote serial debugging, overview |
17223 | To debug a program running on another machine (the debugging | |
17224 | @dfn{target} machine), you must first arrange for all the usual | |
17225 | prerequisites for the program to run by itself. For example, for a C | |
17226 | program, you need: | |
c906108c | 17227 | |
104c1213 JM |
17228 | @enumerate |
17229 | @item | |
17230 | A startup routine to set up the C runtime environment; these usually | |
17231 | have a name like @file{crt0}. The startup routine may be supplied by | |
17232 | your hardware supplier, or you may have to write your own. | |
96baa820 | 17233 | |
5d161b24 | 17234 | @item |
d4f3574e | 17235 | A C subroutine library to support your program's |
104c1213 | 17236 | subroutine calls, notably managing input and output. |
96baa820 | 17237 | |
104c1213 JM |
17238 | @item |
17239 | A way of getting your program to the other machine---for example, a | |
17240 | download program. These are often supplied by the hardware | |
17241 | manufacturer, but you may have to write your own from hardware | |
17242 | documentation. | |
17243 | @end enumerate | |
96baa820 | 17244 | |
104c1213 JM |
17245 | The next step is to arrange for your program to use a serial port to |
17246 | communicate with the machine where @value{GDBN} is running (the @dfn{host} | |
17247 | machine). In general terms, the scheme looks like this: | |
96baa820 | 17248 | |
104c1213 JM |
17249 | @table @emph |
17250 | @item On the host, | |
17251 | @value{GDBN} already understands how to use this protocol; when everything | |
17252 | else is set up, you can simply use the @samp{target remote} command | |
17253 | (@pxref{Targets,,Specifying a Debugging Target}). | |
17254 | ||
17255 | @item On the target, | |
17256 | you must link with your program a few special-purpose subroutines that | |
17257 | implement the @value{GDBN} remote serial protocol. The file containing these | |
17258 | subroutines is called a @dfn{debugging stub}. | |
17259 | ||
17260 | On certain remote targets, you can use an auxiliary program | |
17261 | @code{gdbserver} instead of linking a stub into your program. | |
79a6e687 | 17262 | @xref{Server,,Using the @code{gdbserver} Program}, for details. |
104c1213 | 17263 | @end table |
96baa820 | 17264 | |
104c1213 JM |
17265 | The debugging stub is specific to the architecture of the remote |
17266 | machine; for example, use @file{sparc-stub.c} to debug programs on | |
17267 | @sc{sparc} boards. | |
96baa820 | 17268 | |
104c1213 JM |
17269 | @cindex remote serial stub list |
17270 | These working remote stubs are distributed with @value{GDBN}: | |
96baa820 | 17271 | |
104c1213 JM |
17272 | @table @code |
17273 | ||
17274 | @item i386-stub.c | |
41afff9a | 17275 | @cindex @file{i386-stub.c} |
104c1213 JM |
17276 | @cindex Intel |
17277 | @cindex i386 | |
17278 | For Intel 386 and compatible architectures. | |
17279 | ||
17280 | @item m68k-stub.c | |
41afff9a | 17281 | @cindex @file{m68k-stub.c} |
104c1213 JM |
17282 | @cindex Motorola 680x0 |
17283 | @cindex m680x0 | |
17284 | For Motorola 680x0 architectures. | |
17285 | ||
17286 | @item sh-stub.c | |
41afff9a | 17287 | @cindex @file{sh-stub.c} |
172c2a43 | 17288 | @cindex Renesas |
104c1213 | 17289 | @cindex SH |
172c2a43 | 17290 | For Renesas SH architectures. |
104c1213 JM |
17291 | |
17292 | @item sparc-stub.c | |
41afff9a | 17293 | @cindex @file{sparc-stub.c} |
104c1213 JM |
17294 | @cindex Sparc |
17295 | For @sc{sparc} architectures. | |
17296 | ||
17297 | @item sparcl-stub.c | |
41afff9a | 17298 | @cindex @file{sparcl-stub.c} |
104c1213 JM |
17299 | @cindex Fujitsu |
17300 | @cindex SparcLite | |
17301 | For Fujitsu @sc{sparclite} architectures. | |
17302 | ||
17303 | @end table | |
17304 | ||
17305 | The @file{README} file in the @value{GDBN} distribution may list other | |
17306 | recently added stubs. | |
17307 | ||
17308 | @menu | |
17309 | * Stub Contents:: What the stub can do for you | |
17310 | * Bootstrapping:: What you must do for the stub | |
17311 | * Debug Session:: Putting it all together | |
104c1213 JM |
17312 | @end menu |
17313 | ||
6d2ebf8b | 17314 | @node Stub Contents |
79a6e687 | 17315 | @subsection What the Stub Can Do for You |
104c1213 JM |
17316 | |
17317 | @cindex remote serial stub | |
17318 | The debugging stub for your architecture supplies these three | |
17319 | subroutines: | |
17320 | ||
17321 | @table @code | |
17322 | @item set_debug_traps | |
4644b6e3 | 17323 | @findex set_debug_traps |
104c1213 JM |
17324 | @cindex remote serial stub, initialization |
17325 | This routine arranges for @code{handle_exception} to run when your | |
17326 | program stops. You must call this subroutine explicitly near the | |
17327 | beginning of your program. | |
17328 | ||
17329 | @item handle_exception | |
4644b6e3 | 17330 | @findex handle_exception |
104c1213 JM |
17331 | @cindex remote serial stub, main routine |
17332 | This is the central workhorse, but your program never calls it | |
17333 | explicitly---the setup code arranges for @code{handle_exception} to | |
17334 | run when a trap is triggered. | |
17335 | ||
17336 | @code{handle_exception} takes control when your program stops during | |
17337 | execution (for example, on a breakpoint), and mediates communications | |
17338 | with @value{GDBN} on the host machine. This is where the communications | |
17339 | protocol is implemented; @code{handle_exception} acts as the @value{GDBN} | |
d4f3574e | 17340 | representative on the target machine. It begins by sending summary |
104c1213 JM |
17341 | information on the state of your program, then continues to execute, |
17342 | retrieving and transmitting any information @value{GDBN} needs, until you | |
17343 | execute a @value{GDBN} command that makes your program resume; at that point, | |
17344 | @code{handle_exception} returns control to your own code on the target | |
5d161b24 | 17345 | machine. |
104c1213 JM |
17346 | |
17347 | @item breakpoint | |
17348 | @cindex @code{breakpoint} subroutine, remote | |
17349 | Use this auxiliary subroutine to make your program contain a | |
17350 | breakpoint. Depending on the particular situation, this may be the only | |
17351 | way for @value{GDBN} to get control. For instance, if your target | |
17352 | machine has some sort of interrupt button, you won't need to call this; | |
17353 | pressing the interrupt button transfers control to | |
17354 | @code{handle_exception}---in effect, to @value{GDBN}. On some machines, | |
17355 | simply receiving characters on the serial port may also trigger a trap; | |
17356 | again, in that situation, you don't need to call @code{breakpoint} from | |
17357 | your own program---simply running @samp{target remote} from the host | |
5d161b24 | 17358 | @value{GDBN} session gets control. |
104c1213 JM |
17359 | |
17360 | Call @code{breakpoint} if none of these is true, or if you simply want | |
17361 | to make certain your program stops at a predetermined point for the | |
17362 | start of your debugging session. | |
17363 | @end table | |
17364 | ||
6d2ebf8b | 17365 | @node Bootstrapping |
79a6e687 | 17366 | @subsection What You Must Do for the Stub |
104c1213 JM |
17367 | |
17368 | @cindex remote stub, support routines | |
17369 | The debugging stubs that come with @value{GDBN} are set up for a particular | |
17370 | chip architecture, but they have no information about the rest of your | |
17371 | debugging target machine. | |
17372 | ||
17373 | First of all you need to tell the stub how to communicate with the | |
17374 | serial port. | |
17375 | ||
17376 | @table @code | |
17377 | @item int getDebugChar() | |
4644b6e3 | 17378 | @findex getDebugChar |
104c1213 JM |
17379 | Write this subroutine to read a single character from the serial port. |
17380 | It may be identical to @code{getchar} for your target system; a | |
17381 | different name is used to allow you to distinguish the two if you wish. | |
17382 | ||
17383 | @item void putDebugChar(int) | |
4644b6e3 | 17384 | @findex putDebugChar |
104c1213 | 17385 | Write this subroutine to write a single character to the serial port. |
5d161b24 | 17386 | It may be identical to @code{putchar} for your target system; a |
104c1213 JM |
17387 | different name is used to allow you to distinguish the two if you wish. |
17388 | @end table | |
17389 | ||
17390 | @cindex control C, and remote debugging | |
17391 | @cindex interrupting remote targets | |
17392 | If you want @value{GDBN} to be able to stop your program while it is | |
17393 | running, you need to use an interrupt-driven serial driver, and arrange | |
17394 | for it to stop when it receives a @code{^C} (@samp{\003}, the control-C | |
17395 | character). That is the character which @value{GDBN} uses to tell the | |
17396 | remote system to stop. | |
17397 | ||
17398 | Getting the debugging target to return the proper status to @value{GDBN} | |
17399 | probably requires changes to the standard stub; one quick and dirty way | |
17400 | is to just execute a breakpoint instruction (the ``dirty'' part is that | |
17401 | @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}). | |
17402 | ||
17403 | Other routines you need to supply are: | |
17404 | ||
17405 | @table @code | |
17406 | @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address}) | |
4644b6e3 | 17407 | @findex exceptionHandler |
104c1213 JM |
17408 | Write this function to install @var{exception_address} in the exception |
17409 | handling tables. You need to do this because the stub does not have any | |
17410 | way of knowing what the exception handling tables on your target system | |
17411 | are like (for example, the processor's table might be in @sc{rom}, | |
17412 | containing entries which point to a table in @sc{ram}). | |
17413 | @var{exception_number} is the exception number which should be changed; | |
17414 | its meaning is architecture-dependent (for example, different numbers | |
17415 | might represent divide by zero, misaligned access, etc). When this | |
17416 | exception occurs, control should be transferred directly to | |
17417 | @var{exception_address}, and the processor state (stack, registers, | |
17418 | and so on) should be just as it is when a processor exception occurs. So if | |
17419 | you want to use a jump instruction to reach @var{exception_address}, it | |
17420 | should be a simple jump, not a jump to subroutine. | |
17421 | ||
17422 | For the 386, @var{exception_address} should be installed as an interrupt | |
17423 | gate so that interrupts are masked while the handler runs. The gate | |
17424 | should be at privilege level 0 (the most privileged level). The | |
17425 | @sc{sparc} and 68k stubs are able to mask interrupts themselves without | |
17426 | help from @code{exceptionHandler}. | |
17427 | ||
17428 | @item void flush_i_cache() | |
4644b6e3 | 17429 | @findex flush_i_cache |
d4f3574e | 17430 | On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the |
104c1213 JM |
17431 | instruction cache, if any, on your target machine. If there is no |
17432 | instruction cache, this subroutine may be a no-op. | |
17433 | ||
17434 | On target machines that have instruction caches, @value{GDBN} requires this | |
17435 | function to make certain that the state of your program is stable. | |
17436 | @end table | |
17437 | ||
17438 | @noindent | |
17439 | You must also make sure this library routine is available: | |
17440 | ||
17441 | @table @code | |
17442 | @item void *memset(void *, int, int) | |
4644b6e3 | 17443 | @findex memset |
104c1213 JM |
17444 | This is the standard library function @code{memset} that sets an area of |
17445 | memory to a known value. If you have one of the free versions of | |
17446 | @code{libc.a}, @code{memset} can be found there; otherwise, you must | |
17447 | either obtain it from your hardware manufacturer, or write your own. | |
17448 | @end table | |
17449 | ||
17450 | If you do not use the GNU C compiler, you may need other standard | |
17451 | library subroutines as well; this varies from one stub to another, | |
17452 | but in general the stubs are likely to use any of the common library | |
e22ea452 | 17453 | subroutines which @code{@value{NGCC}} generates as inline code. |
104c1213 JM |
17454 | |
17455 | ||
6d2ebf8b | 17456 | @node Debug Session |
79a6e687 | 17457 | @subsection Putting it All Together |
104c1213 JM |
17458 | |
17459 | @cindex remote serial debugging summary | |
17460 | In summary, when your program is ready to debug, you must follow these | |
17461 | steps. | |
17462 | ||
17463 | @enumerate | |
17464 | @item | |
6d2ebf8b | 17465 | Make sure you have defined the supporting low-level routines |
79a6e687 | 17466 | (@pxref{Bootstrapping,,What You Must Do for the Stub}): |
104c1213 JM |
17467 | @display |
17468 | @code{getDebugChar}, @code{putDebugChar}, | |
17469 | @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}. | |
17470 | @end display | |
17471 | ||
17472 | @item | |
17473 | Insert these lines near the top of your program: | |
17474 | ||
474c8240 | 17475 | @smallexample |
104c1213 JM |
17476 | set_debug_traps(); |
17477 | breakpoint(); | |
474c8240 | 17478 | @end smallexample |
104c1213 JM |
17479 | |
17480 | @item | |
17481 | For the 680x0 stub only, you need to provide a variable called | |
17482 | @code{exceptionHook}. Normally you just use: | |
17483 | ||
474c8240 | 17484 | @smallexample |
104c1213 | 17485 | void (*exceptionHook)() = 0; |
474c8240 | 17486 | @end smallexample |
104c1213 | 17487 | |
d4f3574e | 17488 | @noindent |
104c1213 | 17489 | but if before calling @code{set_debug_traps}, you set it to point to a |
598ca718 | 17490 | function in your program, that function is called when |
104c1213 JM |
17491 | @code{@value{GDBN}} continues after stopping on a trap (for example, bus |
17492 | error). The function indicated by @code{exceptionHook} is called with | |
17493 | one parameter: an @code{int} which is the exception number. | |
17494 | ||
17495 | @item | |
17496 | Compile and link together: your program, the @value{GDBN} debugging stub for | |
17497 | your target architecture, and the supporting subroutines. | |
17498 | ||
17499 | @item | |
17500 | Make sure you have a serial connection between your target machine and | |
17501 | the @value{GDBN} host, and identify the serial port on the host. | |
17502 | ||
17503 | @item | |
17504 | @c The "remote" target now provides a `load' command, so we should | |
17505 | @c document that. FIXME. | |
17506 | Download your program to your target machine (or get it there by | |
17507 | whatever means the manufacturer provides), and start it. | |
17508 | ||
17509 | @item | |
07f31aa6 | 17510 | Start @value{GDBN} on the host, and connect to the target |
79a6e687 | 17511 | (@pxref{Connecting,,Connecting to a Remote Target}). |
9db8d71f | 17512 | |
104c1213 JM |
17513 | @end enumerate |
17514 | ||
8e04817f AC |
17515 | @node Configurations |
17516 | @chapter Configuration-Specific Information | |
104c1213 | 17517 | |
8e04817f AC |
17518 | While nearly all @value{GDBN} commands are available for all native and |
17519 | cross versions of the debugger, there are some exceptions. This chapter | |
17520 | describes things that are only available in certain configurations. | |
104c1213 | 17521 | |
8e04817f AC |
17522 | There are three major categories of configurations: native |
17523 | configurations, where the host and target are the same, embedded | |
17524 | operating system configurations, which are usually the same for several | |
17525 | different processor architectures, and bare embedded processors, which | |
17526 | are quite different from each other. | |
104c1213 | 17527 | |
8e04817f AC |
17528 | @menu |
17529 | * Native:: | |
17530 | * Embedded OS:: | |
17531 | * Embedded Processors:: | |
17532 | * Architectures:: | |
17533 | @end menu | |
104c1213 | 17534 | |
8e04817f AC |
17535 | @node Native |
17536 | @section Native | |
104c1213 | 17537 | |
8e04817f AC |
17538 | This section describes details specific to particular native |
17539 | configurations. | |
6cf7e474 | 17540 | |
8e04817f AC |
17541 | @menu |
17542 | * HP-UX:: HP-UX | |
7561d450 | 17543 | * BSD libkvm Interface:: Debugging BSD kernel memory images |
8e04817f AC |
17544 | * SVR4 Process Information:: SVR4 process information |
17545 | * DJGPP Native:: Features specific to the DJGPP port | |
78c47bea | 17546 | * Cygwin Native:: Features specific to the Cygwin port |
14d6dd68 | 17547 | * Hurd Native:: Features specific to @sc{gnu} Hurd |
a64548ea | 17548 | * Neutrino:: Features specific to QNX Neutrino |
a80b95ba | 17549 | * Darwin:: Features specific to Darwin |
8e04817f | 17550 | @end menu |
6cf7e474 | 17551 | |
8e04817f AC |
17552 | @node HP-UX |
17553 | @subsection HP-UX | |
104c1213 | 17554 | |
8e04817f AC |
17555 | On HP-UX systems, if you refer to a function or variable name that |
17556 | begins with a dollar sign, @value{GDBN} searches for a user or system | |
17557 | name first, before it searches for a convenience variable. | |
104c1213 | 17558 | |
9c16f35a | 17559 | |
7561d450 MK |
17560 | @node BSD libkvm Interface |
17561 | @subsection BSD libkvm Interface | |
17562 | ||
17563 | @cindex libkvm | |
17564 | @cindex kernel memory image | |
17565 | @cindex kernel crash dump | |
17566 | ||
17567 | BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory | |
17568 | interface that provides a uniform interface for accessing kernel virtual | |
17569 | memory images, including live systems and crash dumps. @value{GDBN} | |
17570 | uses this interface to allow you to debug live kernels and kernel crash | |
17571 | dumps on many native BSD configurations. This is implemented as a | |
17572 | special @code{kvm} debugging target. For debugging a live system, load | |
17573 | the currently running kernel into @value{GDBN} and connect to the | |
17574 | @code{kvm} target: | |
17575 | ||
17576 | @smallexample | |
17577 | (@value{GDBP}) @b{target kvm} | |
17578 | @end smallexample | |
17579 | ||
17580 | For debugging crash dumps, provide the file name of the crash dump as an | |
17581 | argument: | |
17582 | ||
17583 | @smallexample | |
17584 | (@value{GDBP}) @b{target kvm /var/crash/bsd.0} | |
17585 | @end smallexample | |
17586 | ||
17587 | Once connected to the @code{kvm} target, the following commands are | |
17588 | available: | |
17589 | ||
17590 | @table @code | |
17591 | @kindex kvm | |
17592 | @item kvm pcb | |
721c2651 | 17593 | Set current context from the @dfn{Process Control Block} (PCB) address. |
7561d450 MK |
17594 | |
17595 | @item kvm proc | |
17596 | Set current context from proc address. This command isn't available on | |
17597 | modern FreeBSD systems. | |
17598 | @end table | |
17599 | ||
8e04817f | 17600 | @node SVR4 Process Information |
79a6e687 | 17601 | @subsection SVR4 Process Information |
60bf7e09 EZ |
17602 | @cindex /proc |
17603 | @cindex examine process image | |
17604 | @cindex process info via @file{/proc} | |
104c1213 | 17605 | |
60bf7e09 EZ |
17606 | Many versions of SVR4 and compatible systems provide a facility called |
17607 | @samp{/proc} that can be used to examine the image of a running | |
17608 | process using file-system subroutines. If @value{GDBN} is configured | |
17609 | for an operating system with this facility, the command @code{info | |
17610 | proc} is available to report information about the process running | |
17611 | your program, or about any process running on your system. @code{info | |
17612 | proc} works only on SVR4 systems that include the @code{procfs} code. | |
17613 | This includes, as of this writing, @sc{gnu}/Linux, OSF/1 (Digital | |
17614 | Unix), Solaris, Irix, and Unixware, but not HP-UX, for example. | |
104c1213 | 17615 | |
8e04817f AC |
17616 | @table @code |
17617 | @kindex info proc | |
60bf7e09 | 17618 | @cindex process ID |
8e04817f | 17619 | @item info proc |
60bf7e09 EZ |
17620 | @itemx info proc @var{process-id} |
17621 | Summarize available information about any running process. If a | |
17622 | process ID is specified by @var{process-id}, display information about | |
17623 | that process; otherwise display information about the program being | |
17624 | debugged. The summary includes the debugged process ID, the command | |
17625 | line used to invoke it, its current working directory, and its | |
17626 | executable file's absolute file name. | |
17627 | ||
17628 | On some systems, @var{process-id} can be of the form | |
17629 | @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID | |
17630 | within a process. If the optional @var{pid} part is missing, it means | |
17631 | a thread from the process being debugged (the leading @samp{/} still | |
17632 | needs to be present, or else @value{GDBN} will interpret the number as | |
17633 | a process ID rather than a thread ID). | |
6cf7e474 | 17634 | |
8e04817f | 17635 | @item info proc mappings |
60bf7e09 EZ |
17636 | @cindex memory address space mappings |
17637 | Report the memory address space ranges accessible in the program, with | |
17638 | information on whether the process has read, write, or execute access | |
17639 | rights to each range. On @sc{gnu}/Linux systems, each memory range | |
17640 | includes the object file which is mapped to that range, instead of the | |
17641 | memory access rights to that range. | |
17642 | ||
17643 | @item info proc stat | |
17644 | @itemx info proc status | |
17645 | @cindex process detailed status information | |
17646 | These subcommands are specific to @sc{gnu}/Linux systems. They show | |
17647 | the process-related information, including the user ID and group ID; | |
17648 | how many threads are there in the process; its virtual memory usage; | |
17649 | the signals that are pending, blocked, and ignored; its TTY; its | |
17650 | consumption of system and user time; its stack size; its @samp{nice} | |
2eecc4ab | 17651 | value; etc. For more information, see the @samp{proc} man page |
60bf7e09 EZ |
17652 | (type @kbd{man 5 proc} from your shell prompt). |
17653 | ||
17654 | @item info proc all | |
17655 | Show all the information about the process described under all of the | |
17656 | above @code{info proc} subcommands. | |
17657 | ||
8e04817f AC |
17658 | @ignore |
17659 | @comment These sub-options of 'info proc' were not included when | |
17660 | @comment procfs.c was re-written. Keep their descriptions around | |
17661 | @comment against the day when someone finds the time to put them back in. | |
17662 | @kindex info proc times | |
17663 | @item info proc times | |
17664 | Starting time, user CPU time, and system CPU time for your program and | |
17665 | its children. | |
6cf7e474 | 17666 | |
8e04817f AC |
17667 | @kindex info proc id |
17668 | @item info proc id | |
17669 | Report on the process IDs related to your program: its own process ID, | |
17670 | the ID of its parent, the process group ID, and the session ID. | |
8e04817f | 17671 | @end ignore |
721c2651 EZ |
17672 | |
17673 | @item set procfs-trace | |
17674 | @kindex set procfs-trace | |
17675 | @cindex @code{procfs} API calls | |
17676 | This command enables and disables tracing of @code{procfs} API calls. | |
17677 | ||
17678 | @item show procfs-trace | |
17679 | @kindex show procfs-trace | |
17680 | Show the current state of @code{procfs} API call tracing. | |
17681 | ||
17682 | @item set procfs-file @var{file} | |
17683 | @kindex set procfs-file | |
17684 | Tell @value{GDBN} to write @code{procfs} API trace to the named | |
17685 | @var{file}. @value{GDBN} appends the trace info to the previous | |
17686 | contents of the file. The default is to display the trace on the | |
17687 | standard output. | |
17688 | ||
17689 | @item show procfs-file | |
17690 | @kindex show procfs-file | |
17691 | Show the file to which @code{procfs} API trace is written. | |
17692 | ||
17693 | @item proc-trace-entry | |
17694 | @itemx proc-trace-exit | |
17695 | @itemx proc-untrace-entry | |
17696 | @itemx proc-untrace-exit | |
17697 | @kindex proc-trace-entry | |
17698 | @kindex proc-trace-exit | |
17699 | @kindex proc-untrace-entry | |
17700 | @kindex proc-untrace-exit | |
17701 | These commands enable and disable tracing of entries into and exits | |
17702 | from the @code{syscall} interface. | |
17703 | ||
17704 | @item info pidlist | |
17705 | @kindex info pidlist | |
17706 | @cindex process list, QNX Neutrino | |
17707 | For QNX Neutrino only, this command displays the list of all the | |
17708 | processes and all the threads within each process. | |
17709 | ||
17710 | @item info meminfo | |
17711 | @kindex info meminfo | |
17712 | @cindex mapinfo list, QNX Neutrino | |
17713 | For QNX Neutrino only, this command displays the list of all mapinfos. | |
8e04817f | 17714 | @end table |
104c1213 | 17715 | |
8e04817f AC |
17716 | @node DJGPP Native |
17717 | @subsection Features for Debugging @sc{djgpp} Programs | |
17718 | @cindex @sc{djgpp} debugging | |
17719 | @cindex native @sc{djgpp} debugging | |
17720 | @cindex MS-DOS-specific commands | |
104c1213 | 17721 | |
514c4d71 EZ |
17722 | @cindex DPMI |
17723 | @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and | |
8e04817f AC |
17724 | MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs |
17725 | that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on | |
17726 | top of real-mode DOS systems and their emulations. | |
104c1213 | 17727 | |
8e04817f AC |
17728 | @value{GDBN} supports native debugging of @sc{djgpp} programs, and |
17729 | defines a few commands specific to the @sc{djgpp} port. This | |
17730 | subsection describes those commands. | |
104c1213 | 17731 | |
8e04817f AC |
17732 | @table @code |
17733 | @kindex info dos | |
17734 | @item info dos | |
17735 | This is a prefix of @sc{djgpp}-specific commands which print | |
17736 | information about the target system and important OS structures. | |
f1251bdd | 17737 | |
8e04817f AC |
17738 | @kindex sysinfo |
17739 | @cindex MS-DOS system info | |
17740 | @cindex free memory information (MS-DOS) | |
17741 | @item info dos sysinfo | |
17742 | This command displays assorted information about the underlying | |
17743 | platform: the CPU type and features, the OS version and flavor, the | |
17744 | DPMI version, and the available conventional and DPMI memory. | |
104c1213 | 17745 | |
8e04817f AC |
17746 | @cindex GDT |
17747 | @cindex LDT | |
17748 | @cindex IDT | |
17749 | @cindex segment descriptor tables | |
17750 | @cindex descriptor tables display | |
17751 | @item info dos gdt | |
17752 | @itemx info dos ldt | |
17753 | @itemx info dos idt | |
17754 | These 3 commands display entries from, respectively, Global, Local, | |
17755 | and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor | |
17756 | tables are data structures which store a descriptor for each segment | |
17757 | that is currently in use. The segment's selector is an index into a | |
17758 | descriptor table; the table entry for that index holds the | |
17759 | descriptor's base address and limit, and its attributes and access | |
17760 | rights. | |
104c1213 | 17761 | |
8e04817f AC |
17762 | A typical @sc{djgpp} program uses 3 segments: a code segment, a data |
17763 | segment (used for both data and the stack), and a DOS segment (which | |
17764 | allows access to DOS/BIOS data structures and absolute addresses in | |
17765 | conventional memory). However, the DPMI host will usually define | |
17766 | additional segments in order to support the DPMI environment. | |
d4f3574e | 17767 | |
8e04817f AC |
17768 | @cindex garbled pointers |
17769 | These commands allow to display entries from the descriptor tables. | |
17770 | Without an argument, all entries from the specified table are | |
17771 | displayed. An argument, which should be an integer expression, means | |
17772 | display a single entry whose index is given by the argument. For | |
17773 | example, here's a convenient way to display information about the | |
17774 | debugged program's data segment: | |
104c1213 | 17775 | |
8e04817f AC |
17776 | @smallexample |
17777 | @exdent @code{(@value{GDBP}) info dos ldt $ds} | |
17778 | @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)} | |
17779 | @end smallexample | |
104c1213 | 17780 | |
8e04817f AC |
17781 | @noindent |
17782 | This comes in handy when you want to see whether a pointer is outside | |
17783 | the data segment's limit (i.e.@: @dfn{garbled}). | |
104c1213 | 17784 | |
8e04817f AC |
17785 | @cindex page tables display (MS-DOS) |
17786 | @item info dos pde | |
17787 | @itemx info dos pte | |
17788 | These two commands display entries from, respectively, the Page | |
17789 | Directory and the Page Tables. Page Directories and Page Tables are | |
17790 | data structures which control how virtual memory addresses are mapped | |
17791 | into physical addresses. A Page Table includes an entry for every | |
17792 | page of memory that is mapped into the program's address space; there | |
17793 | may be several Page Tables, each one holding up to 4096 entries. A | |
17794 | Page Directory has up to 4096 entries, one each for every Page Table | |
17795 | that is currently in use. | |
104c1213 | 17796 | |
8e04817f AC |
17797 | Without an argument, @kbd{info dos pde} displays the entire Page |
17798 | Directory, and @kbd{info dos pte} displays all the entries in all of | |
17799 | the Page Tables. An argument, an integer expression, given to the | |
17800 | @kbd{info dos pde} command means display only that entry from the Page | |
17801 | Directory table. An argument given to the @kbd{info dos pte} command | |
17802 | means display entries from a single Page Table, the one pointed to by | |
17803 | the specified entry in the Page Directory. | |
104c1213 | 17804 | |
8e04817f AC |
17805 | @cindex direct memory access (DMA) on MS-DOS |
17806 | These commands are useful when your program uses @dfn{DMA} (Direct | |
17807 | Memory Access), which needs physical addresses to program the DMA | |
17808 | controller. | |
104c1213 | 17809 | |
8e04817f | 17810 | These commands are supported only with some DPMI servers. |
104c1213 | 17811 | |
8e04817f AC |
17812 | @cindex physical address from linear address |
17813 | @item info dos address-pte @var{addr} | |
17814 | This command displays the Page Table entry for a specified linear | |
514c4d71 EZ |
17815 | address. The argument @var{addr} is a linear address which should |
17816 | already have the appropriate segment's base address added to it, | |
17817 | because this command accepts addresses which may belong to @emph{any} | |
17818 | segment. For example, here's how to display the Page Table entry for | |
17819 | the page where a variable @code{i} is stored: | |
104c1213 | 17820 | |
b383017d | 17821 | @smallexample |
8e04817f AC |
17822 | @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i} |
17823 | @exdent @code{Page Table entry for address 0x11a00d30:} | |
b383017d | 17824 | @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30} |
8e04817f | 17825 | @end smallexample |
104c1213 | 17826 | |
8e04817f AC |
17827 | @noindent |
17828 | This says that @code{i} is stored at offset @code{0xd30} from the page | |
514c4d71 | 17829 | whose physical base address is @code{0x02698000}, and shows all the |
8e04817f | 17830 | attributes of that page. |
104c1213 | 17831 | |
8e04817f AC |
17832 | Note that you must cast the addresses of variables to a @code{char *}, |
17833 | since otherwise the value of @code{__djgpp_base_address}, the base | |
17834 | address of all variables and functions in a @sc{djgpp} program, will | |
17835 | be added using the rules of C pointer arithmetics: if @code{i} is | |
17836 | declared an @code{int}, @value{GDBN} will add 4 times the value of | |
17837 | @code{__djgpp_base_address} to the address of @code{i}. | |
104c1213 | 17838 | |
8e04817f AC |
17839 | Here's another example, it displays the Page Table entry for the |
17840 | transfer buffer: | |
104c1213 | 17841 | |
8e04817f AC |
17842 | @smallexample |
17843 | @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)} | |
17844 | @exdent @code{Page Table entry for address 0x29110:} | |
17845 | @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110} | |
17846 | @end smallexample | |
104c1213 | 17847 | |
8e04817f AC |
17848 | @noindent |
17849 | (The @code{+ 3} offset is because the transfer buffer's address is the | |
514c4d71 EZ |
17850 | 3rd member of the @code{_go32_info_block} structure.) The output |
17851 | clearly shows that this DPMI server maps the addresses in conventional | |
17852 | memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and | |
17853 | linear (@code{0x29110}) addresses are identical. | |
104c1213 | 17854 | |
8e04817f AC |
17855 | This command is supported only with some DPMI servers. |
17856 | @end table | |
104c1213 | 17857 | |
c45da7e6 | 17858 | @cindex DOS serial data link, remote debugging |
a8f24a35 EZ |
17859 | In addition to native debugging, the DJGPP port supports remote |
17860 | debugging via a serial data link. The following commands are specific | |
17861 | to remote serial debugging in the DJGPP port of @value{GDBN}. | |
17862 | ||
17863 | @table @code | |
17864 | @kindex set com1base | |
17865 | @kindex set com1irq | |
17866 | @kindex set com2base | |
17867 | @kindex set com2irq | |
17868 | @kindex set com3base | |
17869 | @kindex set com3irq | |
17870 | @kindex set com4base | |
17871 | @kindex set com4irq | |
17872 | @item set com1base @var{addr} | |
17873 | This command sets the base I/O port address of the @file{COM1} serial | |
17874 | port. | |
17875 | ||
17876 | @item set com1irq @var{irq} | |
17877 | This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use | |
17878 | for the @file{COM1} serial port. | |
17879 | ||
17880 | There are similar commands @samp{set com2base}, @samp{set com3irq}, | |
17881 | etc.@: for setting the port address and the @code{IRQ} lines for the | |
17882 | other 3 COM ports. | |
17883 | ||
17884 | @kindex show com1base | |
17885 | @kindex show com1irq | |
17886 | @kindex show com2base | |
17887 | @kindex show com2irq | |
17888 | @kindex show com3base | |
17889 | @kindex show com3irq | |
17890 | @kindex show com4base | |
17891 | @kindex show com4irq | |
17892 | The related commands @samp{show com1base}, @samp{show com1irq} etc.@: | |
17893 | display the current settings of the base address and the @code{IRQ} | |
17894 | lines used by the COM ports. | |
c45da7e6 EZ |
17895 | |
17896 | @item info serial | |
17897 | @kindex info serial | |
17898 | @cindex DOS serial port status | |
17899 | This command prints the status of the 4 DOS serial ports. For each | |
17900 | port, it prints whether it's active or not, its I/O base address and | |
17901 | IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the | |
17902 | counts of various errors encountered so far. | |
a8f24a35 EZ |
17903 | @end table |
17904 | ||
17905 | ||
78c47bea | 17906 | @node Cygwin Native |
79a6e687 | 17907 | @subsection Features for Debugging MS Windows PE Executables |
78c47bea PM |
17908 | @cindex MS Windows debugging |
17909 | @cindex native Cygwin debugging | |
17910 | @cindex Cygwin-specific commands | |
17911 | ||
be448670 | 17912 | @value{GDBN} supports native debugging of MS Windows programs, including |
cbb8f428 EZ |
17913 | DLLs with and without symbolic debugging information. |
17914 | ||
17915 | @cindex Ctrl-BREAK, MS-Windows | |
17916 | @cindex interrupt debuggee on MS-Windows | |
17917 | MS-Windows programs that call @code{SetConsoleMode} to switch off the | |
17918 | special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted | |
17919 | by typing @kbd{C-c}. For this reason, @value{GDBN} on MS-Windows | |
17920 | supports @kbd{C-@key{BREAK}} as an alternative interrupt key | |
17921 | sequence, which can be used to interrupt the debuggee even if it | |
17922 | ignores @kbd{C-c}. | |
17923 | ||
17924 | There are various additional Cygwin-specific commands, described in | |
17925 | this section. Working with DLLs that have no debugging symbols is | |
17926 | described in @ref{Non-debug DLL Symbols}. | |
78c47bea PM |
17927 | |
17928 | @table @code | |
17929 | @kindex info w32 | |
17930 | @item info w32 | |
db2e3e2e | 17931 | This is a prefix of MS Windows-specific commands which print |
78c47bea PM |
17932 | information about the target system and important OS structures. |
17933 | ||
17934 | @item info w32 selector | |
17935 | This command displays information returned by | |
17936 | the Win32 API @code{GetThreadSelectorEntry} function. | |
17937 | It takes an optional argument that is evaluated to | |
17938 | a long value to give the information about this given selector. | |
17939 | Without argument, this command displays information | |
d3e8051b | 17940 | about the six segment registers. |
78c47bea | 17941 | |
711e434b PM |
17942 | @item info w32 thread-information-block |
17943 | This command displays thread specific information stored in the | |
17944 | Thread Information Block (readable on the X86 CPU family using @code{$fs} | |
17945 | selector for 32-bit programs and @code{$gs} for 64-bit programs). | |
17946 | ||
78c47bea PM |
17947 | @kindex info dll |
17948 | @item info dll | |
db2e3e2e | 17949 | This is a Cygwin-specific alias of @code{info shared}. |
78c47bea PM |
17950 | |
17951 | @kindex dll-symbols | |
17952 | @item dll-symbols | |
17953 | This command loads symbols from a dll similarly to | |
17954 | add-sym command but without the need to specify a base address. | |
17955 | ||
be90c084 | 17956 | @kindex set cygwin-exceptions |
e16b02ee EZ |
17957 | @cindex debugging the Cygwin DLL |
17958 | @cindex Cygwin DLL, debugging | |
be90c084 | 17959 | @item set cygwin-exceptions @var{mode} |
e16b02ee EZ |
17960 | If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that |
17961 | happen inside the Cygwin DLL. If @var{mode} is @code{off}, | |
17962 | @value{GDBN} will delay recognition of exceptions, and may ignore some | |
17963 | exceptions which seem to be caused by internal Cygwin DLL | |
17964 | ``bookkeeping''. This option is meant primarily for debugging the | |
17965 | Cygwin DLL itself; the default value is @code{off} to avoid annoying | |
17966 | @value{GDBN} users with false @code{SIGSEGV} signals. | |
be90c084 CF |
17967 | |
17968 | @kindex show cygwin-exceptions | |
17969 | @item show cygwin-exceptions | |
e16b02ee EZ |
17970 | Displays whether @value{GDBN} will break on exceptions that happen |
17971 | inside the Cygwin DLL itself. | |
be90c084 | 17972 | |
b383017d | 17973 | @kindex set new-console |
78c47bea | 17974 | @item set new-console @var{mode} |
b383017d | 17975 | If @var{mode} is @code{on} the debuggee will |
78c47bea | 17976 | be started in a new console on next start. |
e03e5e7b | 17977 | If @var{mode} is @code{off}, the debuggee will |
78c47bea PM |
17978 | be started in the same console as the debugger. |
17979 | ||
17980 | @kindex show new-console | |
17981 | @item show new-console | |
17982 | Displays whether a new console is used | |
17983 | when the debuggee is started. | |
17984 | ||
17985 | @kindex set new-group | |
17986 | @item set new-group @var{mode} | |
17987 | This boolean value controls whether the debuggee should | |
17988 | start a new group or stay in the same group as the debugger. | |
17989 | This affects the way the Windows OS handles | |
c8aa23ab | 17990 | @samp{Ctrl-C}. |
78c47bea PM |
17991 | |
17992 | @kindex show new-group | |
17993 | @item show new-group | |
17994 | Displays current value of new-group boolean. | |
17995 | ||
17996 | @kindex set debugevents | |
17997 | @item set debugevents | |
219eec71 EZ |
17998 | This boolean value adds debug output concerning kernel events related |
17999 | to the debuggee seen by the debugger. This includes events that | |
18000 | signal thread and process creation and exit, DLL loading and | |
18001 | unloading, console interrupts, and debugging messages produced by the | |
18002 | Windows @code{OutputDebugString} API call. | |
78c47bea PM |
18003 | |
18004 | @kindex set debugexec | |
18005 | @item set debugexec | |
b383017d | 18006 | This boolean value adds debug output concerning execute events |
219eec71 | 18007 | (such as resume thread) seen by the debugger. |
78c47bea PM |
18008 | |
18009 | @kindex set debugexceptions | |
18010 | @item set debugexceptions | |
219eec71 EZ |
18011 | This boolean value adds debug output concerning exceptions in the |
18012 | debuggee seen by the debugger. | |
78c47bea PM |
18013 | |
18014 | @kindex set debugmemory | |
18015 | @item set debugmemory | |
219eec71 EZ |
18016 | This boolean value adds debug output concerning debuggee memory reads |
18017 | and writes by the debugger. | |
78c47bea PM |
18018 | |
18019 | @kindex set shell | |
18020 | @item set shell | |
18021 | This boolean values specifies whether the debuggee is called | |
18022 | via a shell or directly (default value is on). | |
18023 | ||
18024 | @kindex show shell | |
18025 | @item show shell | |
18026 | Displays if the debuggee will be started with a shell. | |
18027 | ||
18028 | @end table | |
18029 | ||
be448670 | 18030 | @menu |
79a6e687 | 18031 | * Non-debug DLL Symbols:: Support for DLLs without debugging symbols |
be448670 CF |
18032 | @end menu |
18033 | ||
79a6e687 BW |
18034 | @node Non-debug DLL Symbols |
18035 | @subsubsection Support for DLLs without Debugging Symbols | |
be448670 CF |
18036 | @cindex DLLs with no debugging symbols |
18037 | @cindex Minimal symbols and DLLs | |
18038 | ||
18039 | Very often on windows, some of the DLLs that your program relies on do | |
18040 | not include symbolic debugging information (for example, | |
db2e3e2e | 18041 | @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging |
be448670 | 18042 | symbols in a DLL, it relies on the minimal amount of symbolic |
db2e3e2e | 18043 | information contained in the DLL's export table. This section |
be448670 CF |
18044 | describes working with such symbols, known internally to @value{GDBN} as |
18045 | ``minimal symbols''. | |
18046 | ||
18047 | Note that before the debugged program has started execution, no DLLs | |
db2e3e2e | 18048 | will have been loaded. The easiest way around this problem is simply to |
be448670 | 18049 | start the program --- either by setting a breakpoint or letting the |
db2e3e2e | 18050 | program run once to completion. It is also possible to force |
be448670 | 18051 | @value{GDBN} to load a particular DLL before starting the executable --- |
12c27660 | 18052 | see the shared library information in @ref{Files}, or the |
db2e3e2e | 18053 | @code{dll-symbols} command in @ref{Cygwin Native}. Currently, |
be448670 CF |
18054 | explicitly loading symbols from a DLL with no debugging information will |
18055 | cause the symbol names to be duplicated in @value{GDBN}'s lookup table, | |
18056 | which may adversely affect symbol lookup performance. | |
18057 | ||
79a6e687 | 18058 | @subsubsection DLL Name Prefixes |
be448670 CF |
18059 | |
18060 | In keeping with the naming conventions used by the Microsoft debugging | |
18061 | tools, DLL export symbols are made available with a prefix based on the | |
18062 | DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is | |
18063 | also entered into the symbol table, so @code{CreateFileA} is often | |
99e008fe | 18064 | sufficient. In some cases there will be name clashes within a program |
be448670 CF |
18065 | (particularly if the executable itself includes full debugging symbols) |
18066 | necessitating the use of the fully qualified name when referring to the | |
99e008fe | 18067 | contents of the DLL. Use single-quotes around the name to avoid the |
be448670 CF |
18068 | exclamation mark (``!'') being interpreted as a language operator. |
18069 | ||
18070 | Note that the internal name of the DLL may be all upper-case, even | |
99e008fe | 18071 | though the file name of the DLL is lower-case, or vice-versa. Since |
be448670 CF |
18072 | symbols within @value{GDBN} are @emph{case-sensitive} this may cause |
18073 | some confusion. If in doubt, try the @code{info functions} and | |
0869d01b NR |
18074 | @code{info variables} commands or even @code{maint print msymbols} |
18075 | (@pxref{Symbols}). Here's an example: | |
be448670 CF |
18076 | |
18077 | @smallexample | |
f7dc1244 | 18078 | (@value{GDBP}) info function CreateFileA |
be448670 CF |
18079 | All functions matching regular expression "CreateFileA": |
18080 | ||
18081 | Non-debugging symbols: | |
18082 | 0x77e885f4 CreateFileA | |
18083 | 0x77e885f4 KERNEL32!CreateFileA | |
18084 | @end smallexample | |
18085 | ||
18086 | @smallexample | |
f7dc1244 | 18087 | (@value{GDBP}) info function ! |
be448670 CF |
18088 | All functions matching regular expression "!": |
18089 | ||
18090 | Non-debugging symbols: | |
18091 | 0x6100114c cygwin1!__assert | |
18092 | 0x61004034 cygwin1!_dll_crt0@@0 | |
18093 | 0x61004240 cygwin1!dll_crt0(per_process *) | |
18094 | [etc...] | |
18095 | @end smallexample | |
18096 | ||
79a6e687 | 18097 | @subsubsection Working with Minimal Symbols |
be448670 CF |
18098 | |
18099 | Symbols extracted from a DLL's export table do not contain very much | |
18100 | type information. All that @value{GDBN} can do is guess whether a symbol | |
18101 | refers to a function or variable depending on the linker section that | |
18102 | contains the symbol. Also note that the actual contents of the memory | |
18103 | contained in a DLL are not available unless the program is running. This | |
18104 | means that you cannot examine the contents of a variable or disassemble | |
18105 | a function within a DLL without a running program. | |
18106 | ||
18107 | Variables are generally treated as pointers and dereferenced | |
18108 | automatically. For this reason, it is often necessary to prefix a | |
18109 | variable name with the address-of operator (``&'') and provide explicit | |
18110 | type information in the command. Here's an example of the type of | |
18111 | problem: | |
18112 | ||
18113 | @smallexample | |
f7dc1244 | 18114 | (@value{GDBP}) print 'cygwin1!__argv' |
be448670 CF |
18115 | $1 = 268572168 |
18116 | @end smallexample | |
18117 | ||
18118 | @smallexample | |
f7dc1244 | 18119 | (@value{GDBP}) x 'cygwin1!__argv' |
be448670 CF |
18120 | 0x10021610: "\230y\"" |
18121 | @end smallexample | |
18122 | ||
18123 | And two possible solutions: | |
18124 | ||
18125 | @smallexample | |
f7dc1244 | 18126 | (@value{GDBP}) print ((char **)'cygwin1!__argv')[0] |
be448670 CF |
18127 | $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram" |
18128 | @end smallexample | |
18129 | ||
18130 | @smallexample | |
f7dc1244 | 18131 | (@value{GDBP}) x/2x &'cygwin1!__argv' |
be448670 | 18132 | 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000 |
f7dc1244 | 18133 | (@value{GDBP}) x/x 0x10021608 |
be448670 | 18134 | 0x10021608: 0x0022fd98 |
f7dc1244 | 18135 | (@value{GDBP}) x/s 0x0022fd98 |
be448670 CF |
18136 | 0x22fd98: "/cygdrive/c/mydirectory/myprogram" |
18137 | @end smallexample | |
18138 | ||
18139 | Setting a break point within a DLL is possible even before the program | |
18140 | starts execution. However, under these circumstances, @value{GDBN} can't | |
18141 | examine the initial instructions of the function in order to skip the | |
18142 | function's frame set-up code. You can work around this by using ``*&'' | |
18143 | to set the breakpoint at a raw memory address: | |
18144 | ||
18145 | @smallexample | |
f7dc1244 | 18146 | (@value{GDBP}) break *&'python22!PyOS_Readline' |
be448670 CF |
18147 | Breakpoint 1 at 0x1e04eff0 |
18148 | @end smallexample | |
18149 | ||
18150 | The author of these extensions is not entirely convinced that setting a | |
18151 | break point within a shared DLL like @file{kernel32.dll} is completely | |
18152 | safe. | |
18153 | ||
14d6dd68 | 18154 | @node Hurd Native |
79a6e687 | 18155 | @subsection Commands Specific to @sc{gnu} Hurd Systems |
14d6dd68 EZ |
18156 | @cindex @sc{gnu} Hurd debugging |
18157 | ||
18158 | This subsection describes @value{GDBN} commands specific to the | |
18159 | @sc{gnu} Hurd native debugging. | |
18160 | ||
18161 | @table @code | |
18162 | @item set signals | |
18163 | @itemx set sigs | |
18164 | @kindex set signals@r{, Hurd command} | |
18165 | @kindex set sigs@r{, Hurd command} | |
18166 | This command toggles the state of inferior signal interception by | |
18167 | @value{GDBN}. Mach exceptions, such as breakpoint traps, are not | |
18168 | affected by this command. @code{sigs} is a shorthand alias for | |
18169 | @code{signals}. | |
18170 | ||
18171 | @item show signals | |
18172 | @itemx show sigs | |
18173 | @kindex show signals@r{, Hurd command} | |
18174 | @kindex show sigs@r{, Hurd command} | |
18175 | Show the current state of intercepting inferior's signals. | |
18176 | ||
18177 | @item set signal-thread | |
18178 | @itemx set sigthread | |
18179 | @kindex set signal-thread | |
18180 | @kindex set sigthread | |
18181 | This command tells @value{GDBN} which thread is the @code{libc} signal | |
18182 | thread. That thread is run when a signal is delivered to a running | |
18183 | process. @code{set sigthread} is the shorthand alias of @code{set | |
18184 | signal-thread}. | |
18185 | ||
18186 | @item show signal-thread | |
18187 | @itemx show sigthread | |
18188 | @kindex show signal-thread | |
18189 | @kindex show sigthread | |
18190 | These two commands show which thread will run when the inferior is | |
18191 | delivered a signal. | |
18192 | ||
18193 | @item set stopped | |
18194 | @kindex set stopped@r{, Hurd command} | |
18195 | This commands tells @value{GDBN} that the inferior process is stopped, | |
18196 | as with the @code{SIGSTOP} signal. The stopped process can be | |
18197 | continued by delivering a signal to it. | |
18198 | ||
18199 | @item show stopped | |
18200 | @kindex show stopped@r{, Hurd command} | |
18201 | This command shows whether @value{GDBN} thinks the debuggee is | |
18202 | stopped. | |
18203 | ||
18204 | @item set exceptions | |
18205 | @kindex set exceptions@r{, Hurd command} | |
18206 | Use this command to turn off trapping of exceptions in the inferior. | |
18207 | When exception trapping is off, neither breakpoints nor | |
18208 | single-stepping will work. To restore the default, set exception | |
18209 | trapping on. | |
18210 | ||
18211 | @item show exceptions | |
18212 | @kindex show exceptions@r{, Hurd command} | |
18213 | Show the current state of trapping exceptions in the inferior. | |
18214 | ||
18215 | @item set task pause | |
18216 | @kindex set task@r{, Hurd commands} | |
18217 | @cindex task attributes (@sc{gnu} Hurd) | |
18218 | @cindex pause current task (@sc{gnu} Hurd) | |
18219 | This command toggles task suspension when @value{GDBN} has control. | |
18220 | Setting it to on takes effect immediately, and the task is suspended | |
18221 | whenever @value{GDBN} gets control. Setting it to off will take | |
18222 | effect the next time the inferior is continued. If this option is set | |
18223 | to off, you can use @code{set thread default pause on} or @code{set | |
18224 | thread pause on} (see below) to pause individual threads. | |
18225 | ||
18226 | @item show task pause | |
18227 | @kindex show task@r{, Hurd commands} | |
18228 | Show the current state of task suspension. | |
18229 | ||
18230 | @item set task detach-suspend-count | |
18231 | @cindex task suspend count | |
18232 | @cindex detach from task, @sc{gnu} Hurd | |
18233 | This command sets the suspend count the task will be left with when | |
18234 | @value{GDBN} detaches from it. | |
18235 | ||
18236 | @item show task detach-suspend-count | |
18237 | Show the suspend count the task will be left with when detaching. | |
18238 | ||
18239 | @item set task exception-port | |
18240 | @itemx set task excp | |
18241 | @cindex task exception port, @sc{gnu} Hurd | |
18242 | This command sets the task exception port to which @value{GDBN} will | |
18243 | forward exceptions. The argument should be the value of the @dfn{send | |
18244 | rights} of the task. @code{set task excp} is a shorthand alias. | |
18245 | ||
18246 | @item set noninvasive | |
18247 | @cindex noninvasive task options | |
18248 | This command switches @value{GDBN} to a mode that is the least | |
18249 | invasive as far as interfering with the inferior is concerned. This | |
18250 | is the same as using @code{set task pause}, @code{set exceptions}, and | |
18251 | @code{set signals} to values opposite to the defaults. | |
18252 | ||
18253 | @item info send-rights | |
18254 | @itemx info receive-rights | |
18255 | @itemx info port-rights | |
18256 | @itemx info port-sets | |
18257 | @itemx info dead-names | |
18258 | @itemx info ports | |
18259 | @itemx info psets | |
18260 | @cindex send rights, @sc{gnu} Hurd | |
18261 | @cindex receive rights, @sc{gnu} Hurd | |
18262 | @cindex port rights, @sc{gnu} Hurd | |
18263 | @cindex port sets, @sc{gnu} Hurd | |
18264 | @cindex dead names, @sc{gnu} Hurd | |
18265 | These commands display information about, respectively, send rights, | |
18266 | receive rights, port rights, port sets, and dead names of a task. | |
18267 | There are also shorthand aliases: @code{info ports} for @code{info | |
18268 | port-rights} and @code{info psets} for @code{info port-sets}. | |
18269 | ||
18270 | @item set thread pause | |
18271 | @kindex set thread@r{, Hurd command} | |
18272 | @cindex thread properties, @sc{gnu} Hurd | |
18273 | @cindex pause current thread (@sc{gnu} Hurd) | |
18274 | This command toggles current thread suspension when @value{GDBN} has | |
18275 | control. Setting it to on takes effect immediately, and the current | |
18276 | thread is suspended whenever @value{GDBN} gets control. Setting it to | |
18277 | off will take effect the next time the inferior is continued. | |
18278 | Normally, this command has no effect, since when @value{GDBN} has | |
18279 | control, the whole task is suspended. However, if you used @code{set | |
18280 | task pause off} (see above), this command comes in handy to suspend | |
18281 | only the current thread. | |
18282 | ||
18283 | @item show thread pause | |
18284 | @kindex show thread@r{, Hurd command} | |
18285 | This command shows the state of current thread suspension. | |
18286 | ||
18287 | @item set thread run | |
d3e8051b | 18288 | This command sets whether the current thread is allowed to run. |
14d6dd68 EZ |
18289 | |
18290 | @item show thread run | |
18291 | Show whether the current thread is allowed to run. | |
18292 | ||
18293 | @item set thread detach-suspend-count | |
18294 | @cindex thread suspend count, @sc{gnu} Hurd | |
18295 | @cindex detach from thread, @sc{gnu} Hurd | |
18296 | This command sets the suspend count @value{GDBN} will leave on a | |
18297 | thread when detaching. This number is relative to the suspend count | |
18298 | found by @value{GDBN} when it notices the thread; use @code{set thread | |
18299 | takeover-suspend-count} to force it to an absolute value. | |
18300 | ||
18301 | @item show thread detach-suspend-count | |
18302 | Show the suspend count @value{GDBN} will leave on the thread when | |
18303 | detaching. | |
18304 | ||
18305 | @item set thread exception-port | |
18306 | @itemx set thread excp | |
18307 | Set the thread exception port to which to forward exceptions. This | |
18308 | overrides the port set by @code{set task exception-port} (see above). | |
18309 | @code{set thread excp} is the shorthand alias. | |
18310 | ||
18311 | @item set thread takeover-suspend-count | |
18312 | Normally, @value{GDBN}'s thread suspend counts are relative to the | |
18313 | value @value{GDBN} finds when it notices each thread. This command | |
18314 | changes the suspend counts to be absolute instead. | |
18315 | ||
18316 | @item set thread default | |
18317 | @itemx show thread default | |
18318 | @cindex thread default settings, @sc{gnu} Hurd | |
18319 | Each of the above @code{set thread} commands has a @code{set thread | |
18320 | default} counterpart (e.g., @code{set thread default pause}, @code{set | |
18321 | thread default exception-port}, etc.). The @code{thread default} | |
18322 | variety of commands sets the default thread properties for all | |
18323 | threads; you can then change the properties of individual threads with | |
18324 | the non-default commands. | |
18325 | @end table | |
18326 | ||
18327 | ||
a64548ea EZ |
18328 | @node Neutrino |
18329 | @subsection QNX Neutrino | |
18330 | @cindex QNX Neutrino | |
18331 | ||
18332 | @value{GDBN} provides the following commands specific to the QNX | |
18333 | Neutrino target: | |
18334 | ||
18335 | @table @code | |
18336 | @item set debug nto-debug | |
18337 | @kindex set debug nto-debug | |
18338 | When set to on, enables debugging messages specific to the QNX | |
18339 | Neutrino support. | |
18340 | ||
18341 | @item show debug nto-debug | |
18342 | @kindex show debug nto-debug | |
18343 | Show the current state of QNX Neutrino messages. | |
18344 | @end table | |
18345 | ||
a80b95ba TG |
18346 | @node Darwin |
18347 | @subsection Darwin | |
18348 | @cindex Darwin | |
18349 | ||
18350 | @value{GDBN} provides the following commands specific to the Darwin target: | |
18351 | ||
18352 | @table @code | |
18353 | @item set debug darwin @var{num} | |
18354 | @kindex set debug darwin | |
18355 | When set to a non zero value, enables debugging messages specific to | |
18356 | the Darwin support. Higher values produce more verbose output. | |
18357 | ||
18358 | @item show debug darwin | |
18359 | @kindex show debug darwin | |
18360 | Show the current state of Darwin messages. | |
18361 | ||
18362 | @item set debug mach-o @var{num} | |
18363 | @kindex set debug mach-o | |
18364 | When set to a non zero value, enables debugging messages while | |
18365 | @value{GDBN} is reading Darwin object files. (@dfn{Mach-O} is the | |
18366 | file format used on Darwin for object and executable files.) Higher | |
18367 | values produce more verbose output. This is a command to diagnose | |
18368 | problems internal to @value{GDBN} and should not be needed in normal | |
18369 | usage. | |
18370 | ||
18371 | @item show debug mach-o | |
18372 | @kindex show debug mach-o | |
18373 | Show the current state of Mach-O file messages. | |
18374 | ||
18375 | @item set mach-exceptions on | |
18376 | @itemx set mach-exceptions off | |
18377 | @kindex set mach-exceptions | |
18378 | On Darwin, faults are first reported as a Mach exception and are then | |
18379 | mapped to a Posix signal. Use this command to turn on trapping of | |
18380 | Mach exceptions in the inferior. This might be sometimes useful to | |
18381 | better understand the cause of a fault. The default is off. | |
18382 | ||
18383 | @item show mach-exceptions | |
18384 | @kindex show mach-exceptions | |
18385 | Show the current state of exceptions trapping. | |
18386 | @end table | |
18387 | ||
a64548ea | 18388 | |
8e04817f AC |
18389 | @node Embedded OS |
18390 | @section Embedded Operating Systems | |
104c1213 | 18391 | |
8e04817f AC |
18392 | This section describes configurations involving the debugging of |
18393 | embedded operating systems that are available for several different | |
18394 | architectures. | |
d4f3574e | 18395 | |
8e04817f AC |
18396 | @menu |
18397 | * VxWorks:: Using @value{GDBN} with VxWorks | |
18398 | @end menu | |
104c1213 | 18399 | |
8e04817f AC |
18400 | @value{GDBN} includes the ability to debug programs running on |
18401 | various real-time operating systems. | |
104c1213 | 18402 | |
8e04817f AC |
18403 | @node VxWorks |
18404 | @subsection Using @value{GDBN} with VxWorks | |
104c1213 | 18405 | |
8e04817f | 18406 | @cindex VxWorks |
104c1213 | 18407 | |
8e04817f | 18408 | @table @code |
104c1213 | 18409 | |
8e04817f AC |
18410 | @kindex target vxworks |
18411 | @item target vxworks @var{machinename} | |
18412 | A VxWorks system, attached via TCP/IP. The argument @var{machinename} | |
18413 | is the target system's machine name or IP address. | |
104c1213 | 18414 | |
8e04817f | 18415 | @end table |
104c1213 | 18416 | |
8e04817f AC |
18417 | On VxWorks, @code{load} links @var{filename} dynamically on the |
18418 | current target system as well as adding its symbols in @value{GDBN}. | |
104c1213 | 18419 | |
8e04817f AC |
18420 | @value{GDBN} enables developers to spawn and debug tasks running on networked |
18421 | VxWorks targets from a Unix host. Already-running tasks spawned from | |
18422 | the VxWorks shell can also be debugged. @value{GDBN} uses code that runs on | |
18423 | both the Unix host and on the VxWorks target. The program | |
18424 | @code{@value{GDBP}} is installed and executed on the Unix host. (It may be | |
18425 | installed with the name @code{vxgdb}, to distinguish it from a | |
18426 | @value{GDBN} for debugging programs on the host itself.) | |
104c1213 | 18427 | |
8e04817f AC |
18428 | @table @code |
18429 | @item VxWorks-timeout @var{args} | |
18430 | @kindex vxworks-timeout | |
18431 | All VxWorks-based targets now support the option @code{vxworks-timeout}. | |
18432 | This option is set by the user, and @var{args} represents the number of | |
18433 | seconds @value{GDBN} waits for responses to rpc's. You might use this if | |
18434 | your VxWorks target is a slow software simulator or is on the far side | |
18435 | of a thin network line. | |
18436 | @end table | |
104c1213 | 18437 | |
8e04817f AC |
18438 | The following information on connecting to VxWorks was current when |
18439 | this manual was produced; newer releases of VxWorks may use revised | |
18440 | procedures. | |
104c1213 | 18441 | |
4644b6e3 | 18442 | @findex INCLUDE_RDB |
8e04817f AC |
18443 | To use @value{GDBN} with VxWorks, you must rebuild your VxWorks kernel |
18444 | to include the remote debugging interface routines in the VxWorks | |
18445 | library @file{rdb.a}. To do this, define @code{INCLUDE_RDB} in the | |
18446 | VxWorks configuration file @file{configAll.h} and rebuild your VxWorks | |
18447 | kernel. The resulting kernel contains @file{rdb.a}, and spawns the | |
18448 | source debugging task @code{tRdbTask} when VxWorks is booted. For more | |
18449 | information on configuring and remaking VxWorks, see the manufacturer's | |
18450 | manual. | |
18451 | @c VxWorks, see the @cite{VxWorks Programmer's Guide}. | |
104c1213 | 18452 | |
8e04817f AC |
18453 | Once you have included @file{rdb.a} in your VxWorks system image and set |
18454 | your Unix execution search path to find @value{GDBN}, you are ready to | |
18455 | run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} (or | |
18456 | @code{vxgdb}, depending on your installation). | |
104c1213 | 18457 | |
8e04817f | 18458 | @value{GDBN} comes up showing the prompt: |
104c1213 | 18459 | |
474c8240 | 18460 | @smallexample |
8e04817f | 18461 | (vxgdb) |
474c8240 | 18462 | @end smallexample |
104c1213 | 18463 | |
8e04817f AC |
18464 | @menu |
18465 | * VxWorks Connection:: Connecting to VxWorks | |
18466 | * VxWorks Download:: VxWorks download | |
18467 | * VxWorks Attach:: Running tasks | |
18468 | @end menu | |
104c1213 | 18469 | |
8e04817f AC |
18470 | @node VxWorks Connection |
18471 | @subsubsection Connecting to VxWorks | |
104c1213 | 18472 | |
8e04817f AC |
18473 | The @value{GDBN} command @code{target} lets you connect to a VxWorks target on the |
18474 | network. To connect to a target whose host name is ``@code{tt}'', type: | |
104c1213 | 18475 | |
474c8240 | 18476 | @smallexample |
8e04817f | 18477 | (vxgdb) target vxworks tt |
474c8240 | 18478 | @end smallexample |
104c1213 | 18479 | |
8e04817f AC |
18480 | @need 750 |
18481 | @value{GDBN} displays messages like these: | |
104c1213 | 18482 | |
8e04817f AC |
18483 | @smallexample |
18484 | Attaching remote machine across net... | |
18485 | Connected to tt. | |
18486 | @end smallexample | |
104c1213 | 18487 | |
8e04817f AC |
18488 | @need 1000 |
18489 | @value{GDBN} then attempts to read the symbol tables of any object modules | |
18490 | loaded into the VxWorks target since it was last booted. @value{GDBN} locates | |
18491 | these files by searching the directories listed in the command search | |
79a6e687 | 18492 | path (@pxref{Environment, ,Your Program's Environment}); if it fails |
8e04817f | 18493 | to find an object file, it displays a message such as: |
5d161b24 | 18494 | |
474c8240 | 18495 | @smallexample |
8e04817f | 18496 | prog.o: No such file or directory. |
474c8240 | 18497 | @end smallexample |
104c1213 | 18498 | |
8e04817f AC |
18499 | When this happens, add the appropriate directory to the search path with |
18500 | the @value{GDBN} command @code{path}, and execute the @code{target} | |
18501 | command again. | |
104c1213 | 18502 | |
8e04817f | 18503 | @node VxWorks Download |
79a6e687 | 18504 | @subsubsection VxWorks Download |
104c1213 | 18505 | |
8e04817f AC |
18506 | @cindex download to VxWorks |
18507 | If you have connected to the VxWorks target and you want to debug an | |
18508 | object that has not yet been loaded, you can use the @value{GDBN} | |
18509 | @code{load} command to download a file from Unix to VxWorks | |
18510 | incrementally. The object file given as an argument to the @code{load} | |
18511 | command is actually opened twice: first by the VxWorks target in order | |
18512 | to download the code, then by @value{GDBN} in order to read the symbol | |
18513 | table. This can lead to problems if the current working directories on | |
18514 | the two systems differ. If both systems have NFS mounted the same | |
18515 | filesystems, you can avoid these problems by using absolute paths. | |
18516 | Otherwise, it is simplest to set the working directory on both systems | |
18517 | to the directory in which the object file resides, and then to reference | |
18518 | the file by its name, without any path. For instance, a program | |
18519 | @file{prog.o} may reside in @file{@var{vxpath}/vw/demo/rdb} in VxWorks | |
18520 | and in @file{@var{hostpath}/vw/demo/rdb} on the host. To load this | |
18521 | program, type this on VxWorks: | |
104c1213 | 18522 | |
474c8240 | 18523 | @smallexample |
8e04817f | 18524 | -> cd "@var{vxpath}/vw/demo/rdb" |
474c8240 | 18525 | @end smallexample |
104c1213 | 18526 | |
8e04817f AC |
18527 | @noindent |
18528 | Then, in @value{GDBN}, type: | |
104c1213 | 18529 | |
474c8240 | 18530 | @smallexample |
8e04817f AC |
18531 | (vxgdb) cd @var{hostpath}/vw/demo/rdb |
18532 | (vxgdb) load prog.o | |
474c8240 | 18533 | @end smallexample |
104c1213 | 18534 | |
8e04817f | 18535 | @value{GDBN} displays a response similar to this: |
104c1213 | 18536 | |
8e04817f AC |
18537 | @smallexample |
18538 | Reading symbol data from wherever/vw/demo/rdb/prog.o... done. | |
18539 | @end smallexample | |
104c1213 | 18540 | |
8e04817f AC |
18541 | You can also use the @code{load} command to reload an object module |
18542 | after editing and recompiling the corresponding source file. Note that | |
18543 | this makes @value{GDBN} delete all currently-defined breakpoints, | |
18544 | auto-displays, and convenience variables, and to clear the value | |
18545 | history. (This is necessary in order to preserve the integrity of | |
18546 | debugger's data structures that reference the target system's symbol | |
18547 | table.) | |
104c1213 | 18548 | |
8e04817f | 18549 | @node VxWorks Attach |
79a6e687 | 18550 | @subsubsection Running Tasks |
104c1213 JM |
18551 | |
18552 | @cindex running VxWorks tasks | |
18553 | You can also attach to an existing task using the @code{attach} command as | |
18554 | follows: | |
18555 | ||
474c8240 | 18556 | @smallexample |
104c1213 | 18557 | (vxgdb) attach @var{task} |
474c8240 | 18558 | @end smallexample |
104c1213 JM |
18559 | |
18560 | @noindent | |
18561 | where @var{task} is the VxWorks hexadecimal task ID. The task can be running | |
18562 | or suspended when you attach to it. Running tasks are suspended at | |
18563 | the time of attachment. | |
18564 | ||
6d2ebf8b | 18565 | @node Embedded Processors |
104c1213 JM |
18566 | @section Embedded Processors |
18567 | ||
18568 | This section goes into details specific to particular embedded | |
18569 | configurations. | |
18570 | ||
c45da7e6 EZ |
18571 | @cindex send command to simulator |
18572 | Whenever a specific embedded processor has a simulator, @value{GDBN} | |
18573 | allows to send an arbitrary command to the simulator. | |
18574 | ||
18575 | @table @code | |
18576 | @item sim @var{command} | |
18577 | @kindex sim@r{, a command} | |
18578 | Send an arbitrary @var{command} string to the simulator. Consult the | |
18579 | documentation for the specific simulator in use for information about | |
18580 | acceptable commands. | |
18581 | @end table | |
18582 | ||
7d86b5d5 | 18583 | |
104c1213 | 18584 | @menu |
c45da7e6 | 18585 | * ARM:: ARM RDI |
172c2a43 | 18586 | * M32R/D:: Renesas M32R/D |
104c1213 | 18587 | * M68K:: Motorola M68K |
08be9d71 | 18588 | * MicroBlaze:: Xilinx MicroBlaze |
104c1213 | 18589 | * MIPS Embedded:: MIPS Embedded |
a37295f9 | 18590 | * OpenRISC 1000:: OpenRisc 1000 |
104c1213 | 18591 | * PA:: HP PA Embedded |
4acd40f3 | 18592 | * PowerPC Embedded:: PowerPC Embedded |
104c1213 JM |
18593 | * Sparclet:: Tsqware Sparclet |
18594 | * Sparclite:: Fujitsu Sparclite | |
104c1213 | 18595 | * Z8000:: Zilog Z8000 |
a64548ea EZ |
18596 | * AVR:: Atmel AVR |
18597 | * CRIS:: CRIS | |
18598 | * Super-H:: Renesas Super-H | |
104c1213 JM |
18599 | @end menu |
18600 | ||
6d2ebf8b | 18601 | @node ARM |
104c1213 | 18602 | @subsection ARM |
c45da7e6 | 18603 | @cindex ARM RDI |
104c1213 JM |
18604 | |
18605 | @table @code | |
8e04817f AC |
18606 | @kindex target rdi |
18607 | @item target rdi @var{dev} | |
18608 | ARM Angel monitor, via RDI library interface to ADP protocol. You may | |
18609 | use this target to communicate with both boards running the Angel | |
18610 | monitor, or with the EmbeddedICE JTAG debug device. | |
18611 | ||
18612 | @kindex target rdp | |
18613 | @item target rdp @var{dev} | |
18614 | ARM Demon monitor. | |
18615 | ||
18616 | @end table | |
18617 | ||
e2f4edfd EZ |
18618 | @value{GDBN} provides the following ARM-specific commands: |
18619 | ||
18620 | @table @code | |
18621 | @item set arm disassembler | |
18622 | @kindex set arm | |
18623 | This commands selects from a list of disassembly styles. The | |
18624 | @code{"std"} style is the standard style. | |
18625 | ||
18626 | @item show arm disassembler | |
18627 | @kindex show arm | |
18628 | Show the current disassembly style. | |
18629 | ||
18630 | @item set arm apcs32 | |
18631 | @cindex ARM 32-bit mode | |
18632 | This command toggles ARM operation mode between 32-bit and 26-bit. | |
18633 | ||
18634 | @item show arm apcs32 | |
18635 | Display the current usage of the ARM 32-bit mode. | |
18636 | ||
18637 | @item set arm fpu @var{fputype} | |
18638 | This command sets the ARM floating-point unit (FPU) type. The | |
18639 | argument @var{fputype} can be one of these: | |
18640 | ||
18641 | @table @code | |
18642 | @item auto | |
18643 | Determine the FPU type by querying the OS ABI. | |
18644 | @item softfpa | |
18645 | Software FPU, with mixed-endian doubles on little-endian ARM | |
18646 | processors. | |
18647 | @item fpa | |
18648 | GCC-compiled FPA co-processor. | |
18649 | @item softvfp | |
18650 | Software FPU with pure-endian doubles. | |
18651 | @item vfp | |
18652 | VFP co-processor. | |
18653 | @end table | |
18654 | ||
18655 | @item show arm fpu | |
18656 | Show the current type of the FPU. | |
18657 | ||
18658 | @item set arm abi | |
18659 | This command forces @value{GDBN} to use the specified ABI. | |
18660 | ||
18661 | @item show arm abi | |
18662 | Show the currently used ABI. | |
18663 | ||
0428b8f5 DJ |
18664 | @item set arm fallback-mode (arm|thumb|auto) |
18665 | @value{GDBN} uses the symbol table, when available, to determine | |
18666 | whether instructions are ARM or Thumb. This command controls | |
18667 | @value{GDBN}'s default behavior when the symbol table is not | |
18668 | available. The default is @samp{auto}, which causes @value{GDBN} to | |
18669 | use the current execution mode (from the @code{T} bit in the @code{CPSR} | |
18670 | register). | |
18671 | ||
18672 | @item show arm fallback-mode | |
18673 | Show the current fallback instruction mode. | |
18674 | ||
18675 | @item set arm force-mode (arm|thumb|auto) | |
18676 | This command overrides use of the symbol table to determine whether | |
18677 | instructions are ARM or Thumb. The default is @samp{auto}, which | |
18678 | causes @value{GDBN} to use the symbol table and then the setting | |
18679 | of @samp{set arm fallback-mode}. | |
18680 | ||
18681 | @item show arm force-mode | |
18682 | Show the current forced instruction mode. | |
18683 | ||
e2f4edfd EZ |
18684 | @item set debug arm |
18685 | Toggle whether to display ARM-specific debugging messages from the ARM | |
18686 | target support subsystem. | |
18687 | ||
18688 | @item show debug arm | |
18689 | Show whether ARM-specific debugging messages are enabled. | |
18690 | @end table | |
18691 | ||
c45da7e6 EZ |
18692 | The following commands are available when an ARM target is debugged |
18693 | using the RDI interface: | |
18694 | ||
18695 | @table @code | |
18696 | @item rdilogfile @r{[}@var{file}@r{]} | |
18697 | @kindex rdilogfile | |
18698 | @cindex ADP (Angel Debugger Protocol) logging | |
18699 | Set the filename for the ADP (Angel Debugger Protocol) packet log. | |
18700 | With an argument, sets the log file to the specified @var{file}. With | |
18701 | no argument, show the current log file name. The default log file is | |
18702 | @file{rdi.log}. | |
18703 | ||
18704 | @item rdilogenable @r{[}@var{arg}@r{]} | |
18705 | @kindex rdilogenable | |
18706 | Control logging of ADP packets. With an argument of 1 or @code{"yes"} | |
18707 | enables logging, with an argument 0 or @code{"no"} disables it. With | |
18708 | no arguments displays the current setting. When logging is enabled, | |
18709 | ADP packets exchanged between @value{GDBN} and the RDI target device | |
18710 | are logged to a file. | |
18711 | ||
18712 | @item set rdiromatzero | |
18713 | @kindex set rdiromatzero | |
18714 | @cindex ROM at zero address, RDI | |
18715 | Tell @value{GDBN} whether the target has ROM at address 0. If on, | |
18716 | vector catching is disabled, so that zero address can be used. If off | |
18717 | (the default), vector catching is enabled. For this command to take | |
18718 | effect, it needs to be invoked prior to the @code{target rdi} command. | |
18719 | ||
18720 | @item show rdiromatzero | |
18721 | @kindex show rdiromatzero | |
18722 | Show the current setting of ROM at zero address. | |
18723 | ||
18724 | @item set rdiheartbeat | |
18725 | @kindex set rdiheartbeat | |
18726 | @cindex RDI heartbeat | |
18727 | Enable or disable RDI heartbeat packets. It is not recommended to | |
18728 | turn on this option, since it confuses ARM and EPI JTAG interface, as | |
18729 | well as the Angel monitor. | |
18730 | ||
18731 | @item show rdiheartbeat | |
18732 | @kindex show rdiheartbeat | |
18733 | Show the setting of RDI heartbeat packets. | |
18734 | @end table | |
18735 | ||
ee8e71d4 EZ |
18736 | @table @code |
18737 | @item target sim @r{[}@var{simargs}@r{]} @dots{} | |
18738 | The @value{GDBN} ARM simulator accepts the following optional arguments. | |
18739 | ||
18740 | @table @code | |
18741 | @item --swi-support=@var{type} | |
18742 | Tell the simulator which SWI interfaces to support. | |
18743 | @var{type} may be a comma separated list of the following values. | |
18744 | The default value is @code{all}. | |
18745 | ||
18746 | @table @code | |
18747 | @item none | |
18748 | @item demon | |
18749 | @item angel | |
18750 | @item redboot | |
18751 | @item all | |
18752 | @end table | |
18753 | @end table | |
18754 | @end table | |
e2f4edfd | 18755 | |
8e04817f | 18756 | @node M32R/D |
ba04e063 | 18757 | @subsection Renesas M32R/D and M32R/SDI |
8e04817f AC |
18758 | |
18759 | @table @code | |
8e04817f AC |
18760 | @kindex target m32r |
18761 | @item target m32r @var{dev} | |
172c2a43 | 18762 | Renesas M32R/D ROM monitor. |
8e04817f | 18763 | |
fb3e19c0 KI |
18764 | @kindex target m32rsdi |
18765 | @item target m32rsdi @var{dev} | |
18766 | Renesas M32R SDI server, connected via parallel port to the board. | |
721c2651 EZ |
18767 | @end table |
18768 | ||
18769 | The following @value{GDBN} commands are specific to the M32R monitor: | |
18770 | ||
18771 | @table @code | |
18772 | @item set download-path @var{path} | |
18773 | @kindex set download-path | |
18774 | @cindex find downloadable @sc{srec} files (M32R) | |
d3e8051b | 18775 | Set the default path for finding downloadable @sc{srec} files. |
721c2651 EZ |
18776 | |
18777 | @item show download-path | |
18778 | @kindex show download-path | |
18779 | Show the default path for downloadable @sc{srec} files. | |
fb3e19c0 | 18780 | |
721c2651 EZ |
18781 | @item set board-address @var{addr} |
18782 | @kindex set board-address | |
18783 | @cindex M32-EVA target board address | |
18784 | Set the IP address for the M32R-EVA target board. | |
18785 | ||
18786 | @item show board-address | |
18787 | @kindex show board-address | |
18788 | Show the current IP address of the target board. | |
18789 | ||
18790 | @item set server-address @var{addr} | |
18791 | @kindex set server-address | |
18792 | @cindex download server address (M32R) | |
18793 | Set the IP address for the download server, which is the @value{GDBN}'s | |
18794 | host machine. | |
18795 | ||
18796 | @item show server-address | |
18797 | @kindex show server-address | |
18798 | Display the IP address of the download server. | |
18799 | ||
18800 | @item upload @r{[}@var{file}@r{]} | |
18801 | @kindex upload@r{, M32R} | |
18802 | Upload the specified @sc{srec} @var{file} via the monitor's Ethernet | |
18803 | upload capability. If no @var{file} argument is given, the current | |
18804 | executable file is uploaded. | |
18805 | ||
18806 | @item tload @r{[}@var{file}@r{]} | |
18807 | @kindex tload@r{, M32R} | |
18808 | Test the @code{upload} command. | |
8e04817f AC |
18809 | @end table |
18810 | ||
ba04e063 EZ |
18811 | The following commands are available for M32R/SDI: |
18812 | ||
18813 | @table @code | |
18814 | @item sdireset | |
18815 | @kindex sdireset | |
18816 | @cindex reset SDI connection, M32R | |
18817 | This command resets the SDI connection. | |
18818 | ||
18819 | @item sdistatus | |
18820 | @kindex sdistatus | |
18821 | This command shows the SDI connection status. | |
18822 | ||
18823 | @item debug_chaos | |
18824 | @kindex debug_chaos | |
18825 | @cindex M32R/Chaos debugging | |
18826 | Instructs the remote that M32R/Chaos debugging is to be used. | |
18827 | ||
18828 | @item use_debug_dma | |
18829 | @kindex use_debug_dma | |
18830 | Instructs the remote to use the DEBUG_DMA method of accessing memory. | |
18831 | ||
18832 | @item use_mon_code | |
18833 | @kindex use_mon_code | |
18834 | Instructs the remote to use the MON_CODE method of accessing memory. | |
18835 | ||
18836 | @item use_ib_break | |
18837 | @kindex use_ib_break | |
18838 | Instructs the remote to set breakpoints by IB break. | |
18839 | ||
18840 | @item use_dbt_break | |
18841 | @kindex use_dbt_break | |
18842 | Instructs the remote to set breakpoints by DBT. | |
18843 | @end table | |
18844 | ||
8e04817f AC |
18845 | @node M68K |
18846 | @subsection M68k | |
18847 | ||
7ce59000 DJ |
18848 | The Motorola m68k configuration includes ColdFire support, and a |
18849 | target command for the following ROM monitor. | |
8e04817f AC |
18850 | |
18851 | @table @code | |
18852 | ||
8e04817f AC |
18853 | @kindex target dbug |
18854 | @item target dbug @var{dev} | |
18855 | dBUG ROM monitor for Motorola ColdFire. | |
18856 | ||
8e04817f AC |
18857 | @end table |
18858 | ||
08be9d71 ME |
18859 | @node MicroBlaze |
18860 | @subsection MicroBlaze | |
18861 | @cindex Xilinx MicroBlaze | |
18862 | @cindex XMD, Xilinx Microprocessor Debugger | |
18863 | ||
18864 | The MicroBlaze is a soft-core processor supported on various Xilinx | |
18865 | FPGAs, such as Spartan or Virtex series. Boards with these processors | |
18866 | usually have JTAG ports which connect to a host system running the Xilinx | |
18867 | Embedded Development Kit (EDK) or Software Development Kit (SDK). | |
18868 | This host system is used to download the configuration bitstream to | |
18869 | the target FPGA. The Xilinx Microprocessor Debugger (XMD) program | |
18870 | communicates with the target board using the JTAG interface and | |
18871 | presents a @code{gdbserver} interface to the board. By default | |
18872 | @code{xmd} uses port @code{1234}. (While it is possible to change | |
18873 | this default port, it requires the use of undocumented @code{xmd} | |
18874 | commands. Contact Xilinx support if you need to do this.) | |
18875 | ||
18876 | Use these GDB commands to connect to the MicroBlaze target processor. | |
18877 | ||
18878 | @table @code | |
18879 | @item target remote :1234 | |
18880 | Use this command to connect to the target if you are running @value{GDBN} | |
18881 | on the same system as @code{xmd}. | |
18882 | ||
18883 | @item target remote @var{xmd-host}:1234 | |
18884 | Use this command to connect to the target if it is connected to @code{xmd} | |
18885 | running on a different system named @var{xmd-host}. | |
18886 | ||
18887 | @item load | |
18888 | Use this command to download a program to the MicroBlaze target. | |
18889 | ||
18890 | @item set debug microblaze @var{n} | |
18891 | Enable MicroBlaze-specific debugging messages if non-zero. | |
18892 | ||
18893 | @item show debug microblaze @var{n} | |
18894 | Show MicroBlaze-specific debugging level. | |
18895 | @end table | |
18896 | ||
8e04817f AC |
18897 | @node MIPS Embedded |
18898 | @subsection MIPS Embedded | |
18899 | ||
18900 | @cindex MIPS boards | |
18901 | @value{GDBN} can use the MIPS remote debugging protocol to talk to a | |
18902 | MIPS board attached to a serial line. This is available when | |
18903 | you configure @value{GDBN} with @samp{--target=mips-idt-ecoff}. | |
104c1213 | 18904 | |
8e04817f AC |
18905 | @need 1000 |
18906 | Use these @value{GDBN} commands to specify the connection to your target board: | |
104c1213 | 18907 | |
8e04817f AC |
18908 | @table @code |
18909 | @item target mips @var{port} | |
18910 | @kindex target mips @var{port} | |
18911 | To run a program on the board, start up @code{@value{GDBP}} with the | |
18912 | name of your program as the argument. To connect to the board, use the | |
18913 | command @samp{target mips @var{port}}, where @var{port} is the name of | |
18914 | the serial port connected to the board. If the program has not already | |
18915 | been downloaded to the board, you may use the @code{load} command to | |
18916 | download it. You can then use all the usual @value{GDBN} commands. | |
104c1213 | 18917 | |
8e04817f AC |
18918 | For example, this sequence connects to the target board through a serial |
18919 | port, and loads and runs a program called @var{prog} through the | |
18920 | debugger: | |
104c1213 | 18921 | |
474c8240 | 18922 | @smallexample |
8e04817f AC |
18923 | host$ @value{GDBP} @var{prog} |
18924 | @value{GDBN} is free software and @dots{} | |
18925 | (@value{GDBP}) target mips /dev/ttyb | |
18926 | (@value{GDBP}) load @var{prog} | |
18927 | (@value{GDBP}) run | |
474c8240 | 18928 | @end smallexample |
104c1213 | 18929 | |
8e04817f AC |
18930 | @item target mips @var{hostname}:@var{portnumber} |
18931 | On some @value{GDBN} host configurations, you can specify a TCP | |
18932 | connection (for instance, to a serial line managed by a terminal | |
18933 | concentrator) instead of a serial port, using the syntax | |
18934 | @samp{@var{hostname}:@var{portnumber}}. | |
104c1213 | 18935 | |
8e04817f AC |
18936 | @item target pmon @var{port} |
18937 | @kindex target pmon @var{port} | |
18938 | PMON ROM monitor. | |
104c1213 | 18939 | |
8e04817f AC |
18940 | @item target ddb @var{port} |
18941 | @kindex target ddb @var{port} | |
18942 | NEC's DDB variant of PMON for Vr4300. | |
104c1213 | 18943 | |
8e04817f AC |
18944 | @item target lsi @var{port} |
18945 | @kindex target lsi @var{port} | |
18946 | LSI variant of PMON. | |
104c1213 | 18947 | |
8e04817f AC |
18948 | @kindex target r3900 |
18949 | @item target r3900 @var{dev} | |
18950 | Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips. | |
104c1213 | 18951 | |
8e04817f AC |
18952 | @kindex target array |
18953 | @item target array @var{dev} | |
18954 | Array Tech LSI33K RAID controller board. | |
104c1213 | 18955 | |
8e04817f | 18956 | @end table |
104c1213 | 18957 | |
104c1213 | 18958 | |
8e04817f AC |
18959 | @noindent |
18960 | @value{GDBN} also supports these special commands for MIPS targets: | |
104c1213 | 18961 | |
8e04817f | 18962 | @table @code |
8e04817f AC |
18963 | @item set mipsfpu double |
18964 | @itemx set mipsfpu single | |
18965 | @itemx set mipsfpu none | |
a64548ea | 18966 | @itemx set mipsfpu auto |
8e04817f AC |
18967 | @itemx show mipsfpu |
18968 | @kindex set mipsfpu | |
18969 | @kindex show mipsfpu | |
18970 | @cindex MIPS remote floating point | |
18971 | @cindex floating point, MIPS remote | |
18972 | If your target board does not support the MIPS floating point | |
18973 | coprocessor, you should use the command @samp{set mipsfpu none} (if you | |
18974 | need this, you may wish to put the command in your @value{GDBN} init | |
18975 | file). This tells @value{GDBN} how to find the return value of | |
18976 | functions which return floating point values. It also allows | |
18977 | @value{GDBN} to avoid saving the floating point registers when calling | |
18978 | functions on the board. If you are using a floating point coprocessor | |
18979 | with only single precision floating point support, as on the @sc{r4650} | |
18980 | processor, use the command @samp{set mipsfpu single}. The default | |
18981 | double precision floating point coprocessor may be selected using | |
18982 | @samp{set mipsfpu double}. | |
104c1213 | 18983 | |
8e04817f AC |
18984 | In previous versions the only choices were double precision or no |
18985 | floating point, so @samp{set mipsfpu on} will select double precision | |
18986 | and @samp{set mipsfpu off} will select no floating point. | |
104c1213 | 18987 | |
8e04817f AC |
18988 | As usual, you can inquire about the @code{mipsfpu} variable with |
18989 | @samp{show mipsfpu}. | |
104c1213 | 18990 | |
8e04817f AC |
18991 | @item set timeout @var{seconds} |
18992 | @itemx set retransmit-timeout @var{seconds} | |
18993 | @itemx show timeout | |
18994 | @itemx show retransmit-timeout | |
18995 | @cindex @code{timeout}, MIPS protocol | |
18996 | @cindex @code{retransmit-timeout}, MIPS protocol | |
18997 | @kindex set timeout | |
18998 | @kindex show timeout | |
18999 | @kindex set retransmit-timeout | |
19000 | @kindex show retransmit-timeout | |
19001 | You can control the timeout used while waiting for a packet, in the MIPS | |
19002 | remote protocol, with the @code{set timeout @var{seconds}} command. The | |
19003 | default is 5 seconds. Similarly, you can control the timeout used while | |
a6f3e723 | 19004 | waiting for an acknowledgment of a packet with the @code{set |
8e04817f AC |
19005 | retransmit-timeout @var{seconds}} command. The default is 3 seconds. |
19006 | You can inspect both values with @code{show timeout} and @code{show | |
19007 | retransmit-timeout}. (These commands are @emph{only} available when | |
19008 | @value{GDBN} is configured for @samp{--target=mips-idt-ecoff}.) | |
104c1213 | 19009 | |
8e04817f AC |
19010 | The timeout set by @code{set timeout} does not apply when @value{GDBN} |
19011 | is waiting for your program to stop. In that case, @value{GDBN} waits | |
19012 | forever because it has no way of knowing how long the program is going | |
19013 | to run before stopping. | |
ba04e063 EZ |
19014 | |
19015 | @item set syn-garbage-limit @var{num} | |
19016 | @kindex set syn-garbage-limit@r{, MIPS remote} | |
19017 | @cindex synchronize with remote MIPS target | |
19018 | Limit the maximum number of characters @value{GDBN} should ignore when | |
19019 | it tries to synchronize with the remote target. The default is 10 | |
19020 | characters. Setting the limit to -1 means there's no limit. | |
19021 | ||
19022 | @item show syn-garbage-limit | |
19023 | @kindex show syn-garbage-limit@r{, MIPS remote} | |
19024 | Show the current limit on the number of characters to ignore when | |
19025 | trying to synchronize with the remote system. | |
19026 | ||
19027 | @item set monitor-prompt @var{prompt} | |
19028 | @kindex set monitor-prompt@r{, MIPS remote} | |
19029 | @cindex remote monitor prompt | |
19030 | Tell @value{GDBN} to expect the specified @var{prompt} string from the | |
19031 | remote monitor. The default depends on the target: | |
19032 | @table @asis | |
19033 | @item pmon target | |
19034 | @samp{PMON} | |
19035 | @item ddb target | |
19036 | @samp{NEC010} | |
19037 | @item lsi target | |
19038 | @samp{PMON>} | |
19039 | @end table | |
19040 | ||
19041 | @item show monitor-prompt | |
19042 | @kindex show monitor-prompt@r{, MIPS remote} | |
19043 | Show the current strings @value{GDBN} expects as the prompt from the | |
19044 | remote monitor. | |
19045 | ||
19046 | @item set monitor-warnings | |
19047 | @kindex set monitor-warnings@r{, MIPS remote} | |
19048 | Enable or disable monitor warnings about hardware breakpoints. This | |
19049 | has effect only for the @code{lsi} target. When on, @value{GDBN} will | |
19050 | display warning messages whose codes are returned by the @code{lsi} | |
19051 | PMON monitor for breakpoint commands. | |
19052 | ||
19053 | @item show monitor-warnings | |
19054 | @kindex show monitor-warnings@r{, MIPS remote} | |
19055 | Show the current setting of printing monitor warnings. | |
19056 | ||
19057 | @item pmon @var{command} | |
19058 | @kindex pmon@r{, MIPS remote} | |
19059 | @cindex send PMON command | |
19060 | This command allows sending an arbitrary @var{command} string to the | |
19061 | monitor. The monitor must be in debug mode for this to work. | |
8e04817f | 19062 | @end table |
104c1213 | 19063 | |
a37295f9 MM |
19064 | @node OpenRISC 1000 |
19065 | @subsection OpenRISC 1000 | |
19066 | @cindex OpenRISC 1000 | |
19067 | ||
19068 | @cindex or1k boards | |
19069 | See OR1k Architecture document (@uref{www.opencores.org}) for more information | |
19070 | about platform and commands. | |
19071 | ||
19072 | @table @code | |
19073 | ||
19074 | @kindex target jtag | |
19075 | @item target jtag jtag://@var{host}:@var{port} | |
19076 | ||
19077 | Connects to remote JTAG server. | |
19078 | JTAG remote server can be either an or1ksim or JTAG server, | |
19079 | connected via parallel port to the board. | |
19080 | ||
19081 | Example: @code{target jtag jtag://localhost:9999} | |
19082 | ||
19083 | @kindex or1ksim | |
19084 | @item or1ksim @var{command} | |
19085 | If connected to @code{or1ksim} OpenRISC 1000 Architectural | |
19086 | Simulator, proprietary commands can be executed. | |
19087 | ||
19088 | @kindex info or1k spr | |
19089 | @item info or1k spr | |
19090 | Displays spr groups. | |
19091 | ||
19092 | @item info or1k spr @var{group} | |
19093 | @itemx info or1k spr @var{groupno} | |
19094 | Displays register names in selected group. | |
19095 | ||
19096 | @item info or1k spr @var{group} @var{register} | |
19097 | @itemx info or1k spr @var{register} | |
19098 | @itemx info or1k spr @var{groupno} @var{registerno} | |
19099 | @itemx info or1k spr @var{registerno} | |
19100 | Shows information about specified spr register. | |
19101 | ||
19102 | @kindex spr | |
19103 | @item spr @var{group} @var{register} @var{value} | |
19104 | @itemx spr @var{register @var{value}} | |
19105 | @itemx spr @var{groupno} @var{registerno @var{value}} | |
19106 | @itemx spr @var{registerno @var{value}} | |
19107 | Writes @var{value} to specified spr register. | |
19108 | @end table | |
19109 | ||
19110 | Some implementations of OpenRISC 1000 Architecture also have hardware trace. | |
19111 | It is very similar to @value{GDBN} trace, except it does not interfere with normal | |
19112 | program execution and is thus much faster. Hardware breakpoints/watchpoint | |
19113 | triggers can be set using: | |
19114 | @table @code | |
19115 | @item $LEA/$LDATA | |
19116 | Load effective address/data | |
19117 | @item $SEA/$SDATA | |
19118 | Store effective address/data | |
19119 | @item $AEA/$ADATA | |
19120 | Access effective address ($SEA or $LEA) or data ($SDATA/$LDATA) | |
19121 | @item $FETCH | |
19122 | Fetch data | |
19123 | @end table | |
19124 | ||
19125 | When triggered, it can capture low level data, like: @code{PC}, @code{LSEA}, | |
19126 | @code{LDATA}, @code{SDATA}, @code{READSPR}, @code{WRITESPR}, @code{INSTR}. | |
19127 | ||
19128 | @code{htrace} commands: | |
19129 | @cindex OpenRISC 1000 htrace | |
19130 | @table @code | |
19131 | @kindex hwatch | |
19132 | @item hwatch @var{conditional} | |
d3e8051b | 19133 | Set hardware watchpoint on combination of Load/Store Effective Address(es) |
a37295f9 MM |
19134 | or Data. For example: |
19135 | ||
19136 | @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)} | |
19137 | ||
19138 | @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)} | |
19139 | ||
4644b6e3 | 19140 | @kindex htrace |
a37295f9 MM |
19141 | @item htrace info |
19142 | Display information about current HW trace configuration. | |
19143 | ||
a37295f9 MM |
19144 | @item htrace trigger @var{conditional} |
19145 | Set starting criteria for HW trace. | |
19146 | ||
a37295f9 MM |
19147 | @item htrace qualifier @var{conditional} |
19148 | Set acquisition qualifier for HW trace. | |
19149 | ||
a37295f9 MM |
19150 | @item htrace stop @var{conditional} |
19151 | Set HW trace stopping criteria. | |
19152 | ||
f153cc92 | 19153 | @item htrace record [@var{data}]* |
a37295f9 MM |
19154 | Selects the data to be recorded, when qualifier is met and HW trace was |
19155 | triggered. | |
19156 | ||
a37295f9 | 19157 | @item htrace enable |
a37295f9 MM |
19158 | @itemx htrace disable |
19159 | Enables/disables the HW trace. | |
19160 | ||
f153cc92 | 19161 | @item htrace rewind [@var{filename}] |
a37295f9 MM |
19162 | Clears currently recorded trace data. |
19163 | ||
19164 | If filename is specified, new trace file is made and any newly collected data | |
19165 | will be written there. | |
19166 | ||
f153cc92 | 19167 | @item htrace print [@var{start} [@var{len}]] |
a37295f9 MM |
19168 | Prints trace buffer, using current record configuration. |
19169 | ||
a37295f9 MM |
19170 | @item htrace mode continuous |
19171 | Set continuous trace mode. | |
19172 | ||
a37295f9 MM |
19173 | @item htrace mode suspend |
19174 | Set suspend trace mode. | |
19175 | ||
19176 | @end table | |
19177 | ||
4acd40f3 TJB |
19178 | @node PowerPC Embedded |
19179 | @subsection PowerPC Embedded | |
104c1213 | 19180 | |
66b73624 TJB |
19181 | @cindex DVC register |
19182 | @value{GDBN} supports using the DVC (Data Value Compare) register to | |
19183 | implement in hardware simple hardware watchpoint conditions of the form: | |
19184 | ||
19185 | @smallexample | |
19186 | (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \ | |
19187 | if @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION} | |
19188 | @end smallexample | |
19189 | ||
e09342b5 TJB |
19190 | The DVC register will be automatically used when @value{GDBN} detects |
19191 | such pattern in a condition expression, and the created watchpoint uses one | |
19192 | debug register (either the @code{exact-watchpoints} option is on and the | |
19193 | variable is scalar, or the variable has a length of one byte). This feature | |
19194 | is available in native @value{GDBN} running on a Linux kernel version 2.6.34 | |
19195 | or newer. | |
19196 | ||
19197 | When running on PowerPC embedded processors, @value{GDBN} automatically uses | |
19198 | ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on, | |
19199 | in which case watchpoints using only one debug register are created when | |
19200 | watching variables of scalar types. | |
19201 | ||
19202 | You can create an artificial array to watch an arbitrary memory | |
19203 | region using one of the following commands (@pxref{Expressions}): | |
19204 | ||
19205 | @smallexample | |
19206 | (@value{GDBP}) watch *((char *) @var{address})@@@var{length} | |
19207 | (@value{GDBP}) watch @{char[@var{length}]@} @var{address} | |
19208 | @end smallexample | |
66b73624 | 19209 | |
9c06b0b4 TJB |
19210 | PowerPC embedded processors support masked watchpoints. See the discussion |
19211 | about the @code{mask} argument in @ref{Set Watchpoints}. | |
19212 | ||
f1310107 TJB |
19213 | @cindex ranged breakpoint |
19214 | PowerPC embedded processors support hardware accelerated | |
19215 | @dfn{ranged breakpoints}. A ranged breakpoint stops execution of | |
19216 | the inferior whenever it executes an instruction at any address within | |
19217 | the range it specifies. To set a ranged breakpoint in @value{GDBN}, | |
19218 | use the @code{break-range} command. | |
19219 | ||
55eddb0f DJ |
19220 | @value{GDBN} provides the following PowerPC-specific commands: |
19221 | ||
104c1213 | 19222 | @table @code |
f1310107 TJB |
19223 | @kindex break-range |
19224 | @item break-range @var{start-location}, @var{end-location} | |
19225 | Set a breakpoint for an address range. | |
19226 | @var{start-location} and @var{end-location} can specify a function name, | |
19227 | a line number, an offset of lines from the current line or from the start | |
19228 | location, or an address of an instruction (see @ref{Specify Location}, | |
19229 | for a list of all the possible ways to specify a @var{location}.) | |
19230 | The breakpoint will stop execution of the inferior whenever it | |
19231 | executes an instruction at any address within the specified range, | |
19232 | (including @var{start-location} and @var{end-location}.) | |
19233 | ||
55eddb0f DJ |
19234 | @kindex set powerpc |
19235 | @item set powerpc soft-float | |
19236 | @itemx show powerpc soft-float | |
19237 | Force @value{GDBN} to use (or not use) a software floating point calling | |
19238 | convention. By default, @value{GDBN} selects the calling convention based | |
19239 | on the selected architecture and the provided executable file. | |
19240 | ||
19241 | @item set powerpc vector-abi | |
19242 | @itemx show powerpc vector-abi | |
19243 | Force @value{GDBN} to use the specified calling convention for vector | |
19244 | arguments and return values. The valid options are @samp{auto}; | |
19245 | @samp{generic}, to avoid vector registers even if they are present; | |
19246 | @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE | |
19247 | registers. By default, @value{GDBN} selects the calling convention | |
19248 | based on the selected architecture and the provided executable file. | |
19249 | ||
e09342b5 TJB |
19250 | @item set powerpc exact-watchpoints |
19251 | @itemx show powerpc exact-watchpoints | |
19252 | Allow @value{GDBN} to use only one debug register when watching a variable | |
19253 | of scalar type, thus assuming that the variable is accessed through the | |
19254 | address of its first byte. | |
19255 | ||
8e04817f AC |
19256 | @kindex target dink32 |
19257 | @item target dink32 @var{dev} | |
19258 | DINK32 ROM monitor. | |
104c1213 | 19259 | |
8e04817f AC |
19260 | @kindex target ppcbug |
19261 | @item target ppcbug @var{dev} | |
19262 | @kindex target ppcbug1 | |
19263 | @item target ppcbug1 @var{dev} | |
19264 | PPCBUG ROM monitor for PowerPC. | |
104c1213 | 19265 | |
8e04817f AC |
19266 | @kindex target sds |
19267 | @item target sds @var{dev} | |
19268 | SDS monitor, running on a PowerPC board (such as Motorola's ADS). | |
c45da7e6 | 19269 | @end table |
8e04817f | 19270 | |
c45da7e6 | 19271 | @cindex SDS protocol |
d52fb0e9 | 19272 | The following commands specific to the SDS protocol are supported |
55eddb0f | 19273 | by @value{GDBN}: |
c45da7e6 EZ |
19274 | |
19275 | @table @code | |
19276 | @item set sdstimeout @var{nsec} | |
19277 | @kindex set sdstimeout | |
19278 | Set the timeout for SDS protocol reads to be @var{nsec} seconds. The | |
19279 | default is 2 seconds. | |
19280 | ||
19281 | @item show sdstimeout | |
19282 | @kindex show sdstimeout | |
19283 | Show the current value of the SDS timeout. | |
19284 | ||
19285 | @item sds @var{command} | |
19286 | @kindex sds@r{, a command} | |
19287 | Send the specified @var{command} string to the SDS monitor. | |
8e04817f AC |
19288 | @end table |
19289 | ||
c45da7e6 | 19290 | |
8e04817f AC |
19291 | @node PA |
19292 | @subsection HP PA Embedded | |
104c1213 JM |
19293 | |
19294 | @table @code | |
19295 | ||
8e04817f AC |
19296 | @kindex target op50n |
19297 | @item target op50n @var{dev} | |
19298 | OP50N monitor, running on an OKI HPPA board. | |
19299 | ||
19300 | @kindex target w89k | |
19301 | @item target w89k @var{dev} | |
19302 | W89K monitor, running on a Winbond HPPA board. | |
104c1213 JM |
19303 | |
19304 | @end table | |
19305 | ||
8e04817f AC |
19306 | @node Sparclet |
19307 | @subsection Tsqware Sparclet | |
104c1213 | 19308 | |
8e04817f AC |
19309 | @cindex Sparclet |
19310 | ||
19311 | @value{GDBN} enables developers to debug tasks running on | |
19312 | Sparclet targets from a Unix host. | |
19313 | @value{GDBN} uses code that runs on | |
19314 | both the Unix host and on the Sparclet target. The program | |
19315 | @code{@value{GDBP}} is installed and executed on the Unix host. | |
104c1213 | 19316 | |
8e04817f AC |
19317 | @table @code |
19318 | @item remotetimeout @var{args} | |
19319 | @kindex remotetimeout | |
19320 | @value{GDBN} supports the option @code{remotetimeout}. | |
19321 | This option is set by the user, and @var{args} represents the number of | |
19322 | seconds @value{GDBN} waits for responses. | |
104c1213 JM |
19323 | @end table |
19324 | ||
8e04817f AC |
19325 | @cindex compiling, on Sparclet |
19326 | When compiling for debugging, include the options @samp{-g} to get debug | |
19327 | information and @samp{-Ttext} to relocate the program to where you wish to | |
19328 | load it on the target. You may also want to add the options @samp{-n} or | |
19329 | @samp{-N} in order to reduce the size of the sections. Example: | |
104c1213 | 19330 | |
474c8240 | 19331 | @smallexample |
8e04817f | 19332 | sparclet-aout-gcc prog.c -Ttext 0x12010000 -g -o prog -N |
474c8240 | 19333 | @end smallexample |
104c1213 | 19334 | |
8e04817f | 19335 | You can use @code{objdump} to verify that the addresses are what you intended: |
104c1213 | 19336 | |
474c8240 | 19337 | @smallexample |
8e04817f | 19338 | sparclet-aout-objdump --headers --syms prog |
474c8240 | 19339 | @end smallexample |
104c1213 | 19340 | |
8e04817f AC |
19341 | @cindex running, on Sparclet |
19342 | Once you have set | |
19343 | your Unix execution search path to find @value{GDBN}, you are ready to | |
19344 | run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} | |
19345 | (or @code{sparclet-aout-gdb}, depending on your installation). | |
104c1213 | 19346 | |
8e04817f AC |
19347 | @value{GDBN} comes up showing the prompt: |
19348 | ||
474c8240 | 19349 | @smallexample |
8e04817f | 19350 | (gdbslet) |
474c8240 | 19351 | @end smallexample |
104c1213 JM |
19352 | |
19353 | @menu | |
8e04817f AC |
19354 | * Sparclet File:: Setting the file to debug |
19355 | * Sparclet Connection:: Connecting to Sparclet | |
19356 | * Sparclet Download:: Sparclet download | |
19357 | * Sparclet Execution:: Running and debugging | |
104c1213 JM |
19358 | @end menu |
19359 | ||
8e04817f | 19360 | @node Sparclet File |
79a6e687 | 19361 | @subsubsection Setting File to Debug |
104c1213 | 19362 | |
8e04817f | 19363 | The @value{GDBN} command @code{file} lets you choose with program to debug. |
104c1213 | 19364 | |
474c8240 | 19365 | @smallexample |
8e04817f | 19366 | (gdbslet) file prog |
474c8240 | 19367 | @end smallexample |
104c1213 | 19368 | |
8e04817f AC |
19369 | @need 1000 |
19370 | @value{GDBN} then attempts to read the symbol table of @file{prog}. | |
19371 | @value{GDBN} locates | |
19372 | the file by searching the directories listed in the command search | |
19373 | path. | |
12c27660 | 19374 | If the file was compiled with debug information (option @samp{-g}), source |
8e04817f AC |
19375 | files will be searched as well. |
19376 | @value{GDBN} locates | |
19377 | the source files by searching the directories listed in the directory search | |
79a6e687 | 19378 | path (@pxref{Environment, ,Your Program's Environment}). |
8e04817f AC |
19379 | If it fails |
19380 | to find a file, it displays a message such as: | |
104c1213 | 19381 | |
474c8240 | 19382 | @smallexample |
8e04817f | 19383 | prog: No such file or directory. |
474c8240 | 19384 | @end smallexample |
104c1213 | 19385 | |
8e04817f AC |
19386 | When this happens, add the appropriate directories to the search paths with |
19387 | the @value{GDBN} commands @code{path} and @code{dir}, and execute the | |
19388 | @code{target} command again. | |
104c1213 | 19389 | |
8e04817f AC |
19390 | @node Sparclet Connection |
19391 | @subsubsection Connecting to Sparclet | |
104c1213 | 19392 | |
8e04817f AC |
19393 | The @value{GDBN} command @code{target} lets you connect to a Sparclet target. |
19394 | To connect to a target on serial port ``@code{ttya}'', type: | |
104c1213 | 19395 | |
474c8240 | 19396 | @smallexample |
8e04817f AC |
19397 | (gdbslet) target sparclet /dev/ttya |
19398 | Remote target sparclet connected to /dev/ttya | |
19399 | main () at ../prog.c:3 | |
474c8240 | 19400 | @end smallexample |
104c1213 | 19401 | |
8e04817f AC |
19402 | @need 750 |
19403 | @value{GDBN} displays messages like these: | |
104c1213 | 19404 | |
474c8240 | 19405 | @smallexample |
8e04817f | 19406 | Connected to ttya. |
474c8240 | 19407 | @end smallexample |
104c1213 | 19408 | |
8e04817f | 19409 | @node Sparclet Download |
79a6e687 | 19410 | @subsubsection Sparclet Download |
104c1213 | 19411 | |
8e04817f AC |
19412 | @cindex download to Sparclet |
19413 | Once connected to the Sparclet target, | |
19414 | you can use the @value{GDBN} | |
19415 | @code{load} command to download the file from the host to the target. | |
19416 | The file name and load offset should be given as arguments to the @code{load} | |
19417 | command. | |
19418 | Since the file format is aout, the program must be loaded to the starting | |
19419 | address. You can use @code{objdump} to find out what this value is. The load | |
19420 | offset is an offset which is added to the VMA (virtual memory address) | |
19421 | of each of the file's sections. | |
19422 | For instance, if the program | |
19423 | @file{prog} was linked to text address 0x1201000, with data at 0x12010160 | |
19424 | and bss at 0x12010170, in @value{GDBN}, type: | |
104c1213 | 19425 | |
474c8240 | 19426 | @smallexample |
8e04817f AC |
19427 | (gdbslet) load prog 0x12010000 |
19428 | Loading section .text, size 0xdb0 vma 0x12010000 | |
474c8240 | 19429 | @end smallexample |
104c1213 | 19430 | |
8e04817f AC |
19431 | If the code is loaded at a different address then what the program was linked |
19432 | to, you may need to use the @code{section} and @code{add-symbol-file} commands | |
19433 | to tell @value{GDBN} where to map the symbol table. | |
19434 | ||
19435 | @node Sparclet Execution | |
79a6e687 | 19436 | @subsubsection Running and Debugging |
8e04817f AC |
19437 | |
19438 | @cindex running and debugging Sparclet programs | |
19439 | You can now begin debugging the task using @value{GDBN}'s execution control | |
19440 | commands, @code{b}, @code{step}, @code{run}, etc. See the @value{GDBN} | |
19441 | manual for the list of commands. | |
19442 | ||
474c8240 | 19443 | @smallexample |
8e04817f AC |
19444 | (gdbslet) b main |
19445 | Breakpoint 1 at 0x12010000: file prog.c, line 3. | |
19446 | (gdbslet) run | |
19447 | Starting program: prog | |
19448 | Breakpoint 1, main (argc=1, argv=0xeffff21c) at prog.c:3 | |
19449 | 3 char *symarg = 0; | |
19450 | (gdbslet) step | |
19451 | 4 char *execarg = "hello!"; | |
19452 | (gdbslet) | |
474c8240 | 19453 | @end smallexample |
8e04817f AC |
19454 | |
19455 | @node Sparclite | |
19456 | @subsection Fujitsu Sparclite | |
104c1213 JM |
19457 | |
19458 | @table @code | |
19459 | ||
8e04817f AC |
19460 | @kindex target sparclite |
19461 | @item target sparclite @var{dev} | |
19462 | Fujitsu sparclite boards, used only for the purpose of loading. | |
19463 | You must use an additional command to debug the program. | |
19464 | For example: target remote @var{dev} using @value{GDBN} standard | |
19465 | remote protocol. | |
104c1213 JM |
19466 | |
19467 | @end table | |
19468 | ||
8e04817f AC |
19469 | @node Z8000 |
19470 | @subsection Zilog Z8000 | |
104c1213 | 19471 | |
8e04817f AC |
19472 | @cindex Z8000 |
19473 | @cindex simulator, Z8000 | |
19474 | @cindex Zilog Z8000 simulator | |
104c1213 | 19475 | |
8e04817f AC |
19476 | When configured for debugging Zilog Z8000 targets, @value{GDBN} includes |
19477 | a Z8000 simulator. | |
19478 | ||
19479 | For the Z8000 family, @samp{target sim} simulates either the Z8002 (the | |
19480 | unsegmented variant of the Z8000 architecture) or the Z8001 (the | |
19481 | segmented variant). The simulator recognizes which architecture is | |
19482 | appropriate by inspecting the object code. | |
104c1213 | 19483 | |
8e04817f AC |
19484 | @table @code |
19485 | @item target sim @var{args} | |
19486 | @kindex sim | |
19487 | @kindex target sim@r{, with Z8000} | |
19488 | Debug programs on a simulated CPU. If the simulator supports setup | |
19489 | options, specify them via @var{args}. | |
104c1213 JM |
19490 | @end table |
19491 | ||
8e04817f AC |
19492 | @noindent |
19493 | After specifying this target, you can debug programs for the simulated | |
19494 | CPU in the same style as programs for your host computer; use the | |
19495 | @code{file} command to load a new program image, the @code{run} command | |
19496 | to run your program, and so on. | |
19497 | ||
19498 | As well as making available all the usual machine registers | |
19499 | (@pxref{Registers, ,Registers}), the Z8000 simulator provides three | |
19500 | additional items of information as specially named registers: | |
104c1213 JM |
19501 | |
19502 | @table @code | |
19503 | ||
8e04817f AC |
19504 | @item cycles |
19505 | Counts clock-ticks in the simulator. | |
104c1213 | 19506 | |
8e04817f AC |
19507 | @item insts |
19508 | Counts instructions run in the simulator. | |
104c1213 | 19509 | |
8e04817f AC |
19510 | @item time |
19511 | Execution time in 60ths of a second. | |
104c1213 | 19512 | |
8e04817f | 19513 | @end table |
104c1213 | 19514 | |
8e04817f AC |
19515 | You can refer to these values in @value{GDBN} expressions with the usual |
19516 | conventions; for example, @w{@samp{b fputc if $cycles>5000}} sets a | |
19517 | conditional breakpoint that suspends only after at least 5000 | |
19518 | simulated clock ticks. | |
104c1213 | 19519 | |
a64548ea EZ |
19520 | @node AVR |
19521 | @subsection Atmel AVR | |
19522 | @cindex AVR | |
19523 | ||
19524 | When configured for debugging the Atmel AVR, @value{GDBN} supports the | |
19525 | following AVR-specific commands: | |
19526 | ||
19527 | @table @code | |
19528 | @item info io_registers | |
19529 | @kindex info io_registers@r{, AVR} | |
19530 | @cindex I/O registers (Atmel AVR) | |
19531 | This command displays information about the AVR I/O registers. For | |
19532 | each register, @value{GDBN} prints its number and value. | |
19533 | @end table | |
19534 | ||
19535 | @node CRIS | |
19536 | @subsection CRIS | |
19537 | @cindex CRIS | |
19538 | ||
19539 | When configured for debugging CRIS, @value{GDBN} provides the | |
19540 | following CRIS-specific commands: | |
19541 | ||
19542 | @table @code | |
19543 | @item set cris-version @var{ver} | |
19544 | @cindex CRIS version | |
e22e55c9 OF |
19545 | Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}. |
19546 | The CRIS version affects register names and sizes. This command is useful in | |
19547 | case autodetection of the CRIS version fails. | |
a64548ea EZ |
19548 | |
19549 | @item show cris-version | |
19550 | Show the current CRIS version. | |
19551 | ||
19552 | @item set cris-dwarf2-cfi | |
19553 | @cindex DWARF-2 CFI and CRIS | |
e22e55c9 OF |
19554 | Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}. |
19555 | Change to @samp{off} when using @code{gcc-cris} whose version is below | |
19556 | @code{R59}. | |
a64548ea EZ |
19557 | |
19558 | @item show cris-dwarf2-cfi | |
19559 | Show the current state of using DWARF-2 CFI. | |
e22e55c9 OF |
19560 | |
19561 | @item set cris-mode @var{mode} | |
19562 | @cindex CRIS mode | |
19563 | Set the current CRIS mode to @var{mode}. It should only be changed when | |
19564 | debugging in guru mode, in which case it should be set to | |
19565 | @samp{guru} (the default is @samp{normal}). | |
19566 | ||
19567 | @item show cris-mode | |
19568 | Show the current CRIS mode. | |
a64548ea EZ |
19569 | @end table |
19570 | ||
19571 | @node Super-H | |
19572 | @subsection Renesas Super-H | |
19573 | @cindex Super-H | |
19574 | ||
19575 | For the Renesas Super-H processor, @value{GDBN} provides these | |
19576 | commands: | |
19577 | ||
19578 | @table @code | |
19579 | @item regs | |
19580 | @kindex regs@r{, Super-H} | |
19581 | Show the values of all Super-H registers. | |
c055b101 CV |
19582 | |
19583 | @item set sh calling-convention @var{convention} | |
19584 | @kindex set sh calling-convention | |
19585 | Set the calling-convention used when calling functions from @value{GDBN}. | |
19586 | Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}. | |
19587 | With the @samp{gcc} setting, functions are called using the @value{NGCC} calling | |
19588 | convention. If the DWARF-2 information of the called function specifies | |
19589 | that the function follows the Renesas calling convention, the function | |
19590 | is called using the Renesas calling convention. If the calling convention | |
19591 | is set to @samp{renesas}, the Renesas calling convention is always used, | |
19592 | regardless of the DWARF-2 information. This can be used to override the | |
19593 | default of @samp{gcc} if debug information is missing, or the compiler | |
19594 | does not emit the DWARF-2 calling convention entry for a function. | |
19595 | ||
19596 | @item show sh calling-convention | |
19597 | @kindex show sh calling-convention | |
19598 | Show the current calling convention setting. | |
19599 | ||
a64548ea EZ |
19600 | @end table |
19601 | ||
19602 | ||
8e04817f AC |
19603 | @node Architectures |
19604 | @section Architectures | |
104c1213 | 19605 | |
8e04817f AC |
19606 | This section describes characteristics of architectures that affect |
19607 | all uses of @value{GDBN} with the architecture, both native and cross. | |
104c1213 | 19608 | |
8e04817f | 19609 | @menu |
9c16f35a | 19610 | * i386:: |
8e04817f AC |
19611 | * A29K:: |
19612 | * Alpha:: | |
19613 | * MIPS:: | |
a64548ea | 19614 | * HPPA:: HP PA architecture |
23d964e7 | 19615 | * SPU:: Cell Broadband Engine SPU architecture |
4acd40f3 | 19616 | * PowerPC:: |
8e04817f | 19617 | @end menu |
104c1213 | 19618 | |
9c16f35a | 19619 | @node i386 |
db2e3e2e | 19620 | @subsection x86 Architecture-specific Issues |
9c16f35a EZ |
19621 | |
19622 | @table @code | |
19623 | @item set struct-convention @var{mode} | |
19624 | @kindex set struct-convention | |
19625 | @cindex struct return convention | |
19626 | @cindex struct/union returned in registers | |
19627 | Set the convention used by the inferior to return @code{struct}s and | |
19628 | @code{union}s from functions to @var{mode}. Possible values of | |
19629 | @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the | |
19630 | default). @code{"default"} or @code{"pcc"} means that @code{struct}s | |
19631 | are returned on the stack, while @code{"reg"} means that a | |
19632 | @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will | |
19633 | be returned in a register. | |
19634 | ||
19635 | @item show struct-convention | |
19636 | @kindex show struct-convention | |
19637 | Show the current setting of the convention to return @code{struct}s | |
19638 | from functions. | |
19639 | @end table | |
19640 | ||
8e04817f AC |
19641 | @node A29K |
19642 | @subsection A29K | |
104c1213 JM |
19643 | |
19644 | @table @code | |
104c1213 | 19645 | |
8e04817f AC |
19646 | @kindex set rstack_high_address |
19647 | @cindex AMD 29K register stack | |
19648 | @cindex register stack, AMD29K | |
19649 | @item set rstack_high_address @var{address} | |
19650 | On AMD 29000 family processors, registers are saved in a separate | |
19651 | @dfn{register stack}. There is no way for @value{GDBN} to determine the | |
19652 | extent of this stack. Normally, @value{GDBN} just assumes that the | |
19653 | stack is ``large enough''. This may result in @value{GDBN} referencing | |
19654 | memory locations that do not exist. If necessary, you can get around | |
19655 | this problem by specifying the ending address of the register stack with | |
19656 | the @code{set rstack_high_address} command. The argument should be an | |
19657 | address, which you probably want to precede with @samp{0x} to specify in | |
19658 | hexadecimal. | |
104c1213 | 19659 | |
8e04817f AC |
19660 | @kindex show rstack_high_address |
19661 | @item show rstack_high_address | |
19662 | Display the current limit of the register stack, on AMD 29000 family | |
19663 | processors. | |
104c1213 | 19664 | |
8e04817f | 19665 | @end table |
104c1213 | 19666 | |
8e04817f AC |
19667 | @node Alpha |
19668 | @subsection Alpha | |
104c1213 | 19669 | |
8e04817f | 19670 | See the following section. |
104c1213 | 19671 | |
8e04817f AC |
19672 | @node MIPS |
19673 | @subsection MIPS | |
104c1213 | 19674 | |
8e04817f AC |
19675 | @cindex stack on Alpha |
19676 | @cindex stack on MIPS | |
19677 | @cindex Alpha stack | |
19678 | @cindex MIPS stack | |
19679 | Alpha- and MIPS-based computers use an unusual stack frame, which | |
19680 | sometimes requires @value{GDBN} to search backward in the object code to | |
19681 | find the beginning of a function. | |
104c1213 | 19682 | |
8e04817f AC |
19683 | @cindex response time, MIPS debugging |
19684 | To improve response time (especially for embedded applications, where | |
19685 | @value{GDBN} may be restricted to a slow serial line for this search) | |
19686 | you may want to limit the size of this search, using one of these | |
19687 | commands: | |
104c1213 | 19688 | |
8e04817f AC |
19689 | @table @code |
19690 | @cindex @code{heuristic-fence-post} (Alpha, MIPS) | |
19691 | @item set heuristic-fence-post @var{limit} | |
19692 | Restrict @value{GDBN} to examining at most @var{limit} bytes in its | |
19693 | search for the beginning of a function. A value of @var{0} (the | |
19694 | default) means there is no limit. However, except for @var{0}, the | |
19695 | larger the limit the more bytes @code{heuristic-fence-post} must search | |
e2f4edfd EZ |
19696 | and therefore the longer it takes to run. You should only need to use |
19697 | this command when debugging a stripped executable. | |
104c1213 | 19698 | |
8e04817f AC |
19699 | @item show heuristic-fence-post |
19700 | Display the current limit. | |
19701 | @end table | |
104c1213 JM |
19702 | |
19703 | @noindent | |
8e04817f AC |
19704 | These commands are available @emph{only} when @value{GDBN} is configured |
19705 | for debugging programs on Alpha or MIPS processors. | |
104c1213 | 19706 | |
a64548ea EZ |
19707 | Several MIPS-specific commands are available when debugging MIPS |
19708 | programs: | |
19709 | ||
19710 | @table @code | |
a64548ea EZ |
19711 | @item set mips abi @var{arg} |
19712 | @kindex set mips abi | |
19713 | @cindex set ABI for MIPS | |
19714 | Tell @value{GDBN} which MIPS ABI is used by the inferior. Possible | |
19715 | values of @var{arg} are: | |
19716 | ||
19717 | @table @samp | |
19718 | @item auto | |
19719 | The default ABI associated with the current binary (this is the | |
19720 | default). | |
19721 | @item o32 | |
19722 | @item o64 | |
19723 | @item n32 | |
19724 | @item n64 | |
19725 | @item eabi32 | |
19726 | @item eabi64 | |
19727 | @item auto | |
19728 | @end table | |
19729 | ||
19730 | @item show mips abi | |
19731 | @kindex show mips abi | |
19732 | Show the MIPS ABI used by @value{GDBN} to debug the inferior. | |
19733 | ||
19734 | @item set mipsfpu | |
19735 | @itemx show mipsfpu | |
19736 | @xref{MIPS Embedded, set mipsfpu}. | |
19737 | ||
19738 | @item set mips mask-address @var{arg} | |
19739 | @kindex set mips mask-address | |
19740 | @cindex MIPS addresses, masking | |
19741 | This command determines whether the most-significant 32 bits of 64-bit | |
19742 | MIPS addresses are masked off. The argument @var{arg} can be | |
19743 | @samp{on}, @samp{off}, or @samp{auto}. The latter is the default | |
19744 | setting, which lets @value{GDBN} determine the correct value. | |
19745 | ||
19746 | @item show mips mask-address | |
19747 | @kindex show mips mask-address | |
19748 | Show whether the upper 32 bits of MIPS addresses are masked off or | |
19749 | not. | |
19750 | ||
19751 | @item set remote-mips64-transfers-32bit-regs | |
19752 | @kindex set remote-mips64-transfers-32bit-regs | |
19753 | This command controls compatibility with 64-bit MIPS targets that | |
19754 | transfer data in 32-bit quantities. If you have an old MIPS 64 target | |
19755 | that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr}, | |
19756 | and 64 bits for other registers, set this option to @samp{on}. | |
19757 | ||
19758 | @item show remote-mips64-transfers-32bit-regs | |
19759 | @kindex show remote-mips64-transfers-32bit-regs | |
19760 | Show the current setting of compatibility with older MIPS 64 targets. | |
19761 | ||
19762 | @item set debug mips | |
19763 | @kindex set debug mips | |
19764 | This command turns on and off debugging messages for the MIPS-specific | |
19765 | target code in @value{GDBN}. | |
19766 | ||
19767 | @item show debug mips | |
19768 | @kindex show debug mips | |
19769 | Show the current setting of MIPS debugging messages. | |
19770 | @end table | |
19771 | ||
19772 | ||
19773 | @node HPPA | |
19774 | @subsection HPPA | |
19775 | @cindex HPPA support | |
19776 | ||
d3e8051b | 19777 | When @value{GDBN} is debugging the HP PA architecture, it provides the |
a64548ea EZ |
19778 | following special commands: |
19779 | ||
19780 | @table @code | |
19781 | @item set debug hppa | |
19782 | @kindex set debug hppa | |
db2e3e2e | 19783 | This command determines whether HPPA architecture-specific debugging |
a64548ea EZ |
19784 | messages are to be displayed. |
19785 | ||
19786 | @item show debug hppa | |
19787 | Show whether HPPA debugging messages are displayed. | |
19788 | ||
19789 | @item maint print unwind @var{address} | |
19790 | @kindex maint print unwind@r{, HPPA} | |
19791 | This command displays the contents of the unwind table entry at the | |
19792 | given @var{address}. | |
19793 | ||
19794 | @end table | |
19795 | ||
104c1213 | 19796 | |
23d964e7 UW |
19797 | @node SPU |
19798 | @subsection Cell Broadband Engine SPU architecture | |
19799 | @cindex Cell Broadband Engine | |
19800 | @cindex SPU | |
19801 | ||
19802 | When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture, | |
19803 | it provides the following special commands: | |
19804 | ||
19805 | @table @code | |
19806 | @item info spu event | |
19807 | @kindex info spu | |
19808 | Display SPU event facility status. Shows current event mask | |
19809 | and pending event status. | |
19810 | ||
19811 | @item info spu signal | |
19812 | Display SPU signal notification facility status. Shows pending | |
19813 | signal-control word and signal notification mode of both signal | |
19814 | notification channels. | |
19815 | ||
19816 | @item info spu mailbox | |
19817 | Display SPU mailbox facility status. Shows all pending entries, | |
19818 | in order of processing, in each of the SPU Write Outbound, | |
19819 | SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes. | |
19820 | ||
19821 | @item info spu dma | |
19822 | Display MFC DMA status. Shows all pending commands in the MFC | |
19823 | DMA queue. For each entry, opcode, tag, class IDs, effective | |
19824 | and local store addresses and transfer size are shown. | |
19825 | ||
19826 | @item info spu proxydma | |
19827 | Display MFC Proxy-DMA status. Shows all pending commands in the MFC | |
19828 | Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective | |
19829 | and local store addresses and transfer size are shown. | |
19830 | ||
19831 | @end table | |
19832 | ||
3285f3fe UW |
19833 | When @value{GDBN} is debugging a combined PowerPC/SPU application |
19834 | on the Cell Broadband Engine, it provides in addition the following | |
19835 | special commands: | |
19836 | ||
19837 | @table @code | |
19838 | @item set spu stop-on-load @var{arg} | |
19839 | @kindex set spu | |
19840 | Set whether to stop for new SPE threads. When set to @code{on}, @value{GDBN} | |
19841 | will give control to the user when a new SPE thread enters its @code{main} | |
19842 | function. The default is @code{off}. | |
19843 | ||
19844 | @item show spu stop-on-load | |
19845 | @kindex show spu | |
19846 | Show whether to stop for new SPE threads. | |
19847 | ||
ff1a52c6 UW |
19848 | @item set spu auto-flush-cache @var{arg} |
19849 | Set whether to automatically flush the software-managed cache. When set to | |
19850 | @code{on}, @value{GDBN} will automatically cause the SPE software-managed | |
19851 | cache to be flushed whenever SPE execution stops. This provides a consistent | |
19852 | view of PowerPC memory that is accessed via the cache. If an application | |
19853 | does not use the software-managed cache, this option has no effect. | |
19854 | ||
19855 | @item show spu auto-flush-cache | |
19856 | Show whether to automatically flush the software-managed cache. | |
19857 | ||
3285f3fe UW |
19858 | @end table |
19859 | ||
4acd40f3 TJB |
19860 | @node PowerPC |
19861 | @subsection PowerPC | |
19862 | @cindex PowerPC architecture | |
19863 | ||
19864 | When @value{GDBN} is debugging the PowerPC architecture, it provides a set of | |
19865 | pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point | |
19866 | numbers stored in the floating point registers. These values must be stored | |
19867 | in two consecutive registers, always starting at an even register like | |
19868 | @code{f0} or @code{f2}. | |
19869 | ||
19870 | The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed | |
19871 | by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0}, | |
19872 | @code{f2} and @code{f3} for @code{$dl1} and so on. | |
19873 | ||
aeac0ff9 | 19874 | For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit |
677c5bb1 LM |
19875 | wide Extended Floating Point Registers (@samp{f32} through @samp{f63}). |
19876 | ||
23d964e7 | 19877 | |
8e04817f AC |
19878 | @node Controlling GDB |
19879 | @chapter Controlling @value{GDBN} | |
19880 | ||
19881 | You can alter the way @value{GDBN} interacts with you by using the | |
19882 | @code{set} command. For commands controlling how @value{GDBN} displays | |
79a6e687 | 19883 | data, see @ref{Print Settings, ,Print Settings}. Other settings are |
8e04817f AC |
19884 | described here. |
19885 | ||
19886 | @menu | |
19887 | * Prompt:: Prompt | |
19888 | * Editing:: Command editing | |
d620b259 | 19889 | * Command History:: Command history |
8e04817f AC |
19890 | * Screen Size:: Screen size |
19891 | * Numbers:: Numbers | |
1e698235 | 19892 | * ABI:: Configuring the current ABI |
8e04817f AC |
19893 | * Messages/Warnings:: Optional warnings and messages |
19894 | * Debugging Output:: Optional messages about internal happenings | |
14fb1bac | 19895 | * Other Misc Settings:: Other Miscellaneous Settings |
8e04817f AC |
19896 | @end menu |
19897 | ||
19898 | @node Prompt | |
19899 | @section Prompt | |
104c1213 | 19900 | |
8e04817f | 19901 | @cindex prompt |
104c1213 | 19902 | |
8e04817f AC |
19903 | @value{GDBN} indicates its readiness to read a command by printing a string |
19904 | called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You | |
19905 | can change the prompt string with the @code{set prompt} command. For | |
19906 | instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change | |
19907 | the prompt in one of the @value{GDBN} sessions so that you can always tell | |
19908 | which one you are talking to. | |
104c1213 | 19909 | |
8e04817f AC |
19910 | @emph{Note:} @code{set prompt} does not add a space for you after the |
19911 | prompt you set. This allows you to set a prompt which ends in a space | |
19912 | or a prompt that does not. | |
104c1213 | 19913 | |
8e04817f AC |
19914 | @table @code |
19915 | @kindex set prompt | |
19916 | @item set prompt @var{newprompt} | |
19917 | Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth. | |
104c1213 | 19918 | |
8e04817f AC |
19919 | @kindex show prompt |
19920 | @item show prompt | |
19921 | Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}} | |
104c1213 JM |
19922 | @end table |
19923 | ||
fa3a4f15 PM |
19924 | Versions of @value{GDBN} that ship with Python scripting enabled have |
19925 | prompt extensions. The commands for interacting with these extensions | |
19926 | are: | |
19927 | ||
19928 | @table @code | |
19929 | @kindex set extended-prompt | |
19930 | @item set extended-prompt @var{prompt} | |
19931 | Set an extended prompt that allows for substitutions. | |
19932 | @xref{gdb.prompt}, for a list of escape sequences that can be used for | |
19933 | substitution. Any escape sequences specified as part of the prompt | |
19934 | string are replaced with the corresponding strings each time the prompt | |
19935 | is displayed. | |
19936 | ||
19937 | For example: | |
19938 | ||
19939 | @smallexample | |
19940 | set extended-prompt Current working directory: \w (gdb) | |
19941 | @end smallexample | |
19942 | ||
19943 | Note that when an extended-prompt is set, it takes control of the | |
19944 | @var{prompt_hook} hook. @xref{prompt_hook}, for further information. | |
19945 | ||
19946 | @kindex show extended-prompt | |
19947 | @item show extended-prompt | |
19948 | Prints the extended prompt. Any escape sequences specified as part of | |
19949 | the prompt string with @code{set extended-prompt}, are replaced with the | |
19950 | corresponding strings each time the prompt is displayed. | |
19951 | @end table | |
19952 | ||
8e04817f | 19953 | @node Editing |
79a6e687 | 19954 | @section Command Editing |
8e04817f AC |
19955 | @cindex readline |
19956 | @cindex command line editing | |
104c1213 | 19957 | |
703663ab | 19958 | @value{GDBN} reads its input commands via the @dfn{Readline} interface. This |
8e04817f AC |
19959 | @sc{gnu} library provides consistent behavior for programs which provide a |
19960 | command line interface to the user. Advantages are @sc{gnu} Emacs-style | |
19961 | or @dfn{vi}-style inline editing of commands, @code{csh}-like history | |
19962 | substitution, and a storage and recall of command history across | |
19963 | debugging sessions. | |
104c1213 | 19964 | |
8e04817f AC |
19965 | You may control the behavior of command line editing in @value{GDBN} with the |
19966 | command @code{set}. | |
104c1213 | 19967 | |
8e04817f AC |
19968 | @table @code |
19969 | @kindex set editing | |
19970 | @cindex editing | |
19971 | @item set editing | |
19972 | @itemx set editing on | |
19973 | Enable command line editing (enabled by default). | |
104c1213 | 19974 | |
8e04817f AC |
19975 | @item set editing off |
19976 | Disable command line editing. | |
104c1213 | 19977 | |
8e04817f AC |
19978 | @kindex show editing |
19979 | @item show editing | |
19980 | Show whether command line editing is enabled. | |
104c1213 JM |
19981 | @end table |
19982 | ||
39037522 TT |
19983 | @ifset SYSTEM_READLINE |
19984 | @xref{Command Line Editing, , , rluserman, GNU Readline Library}, | |
19985 | @end ifset | |
19986 | @ifclear SYSTEM_READLINE | |
19987 | @xref{Command Line Editing}, | |
19988 | @end ifclear | |
19989 | for more details about the Readline | |
703663ab EZ |
19990 | interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are |
19991 | encouraged to read that chapter. | |
19992 | ||
d620b259 | 19993 | @node Command History |
79a6e687 | 19994 | @section Command History |
703663ab | 19995 | @cindex command history |
8e04817f AC |
19996 | |
19997 | @value{GDBN} can keep track of the commands you type during your | |
19998 | debugging sessions, so that you can be certain of precisely what | |
19999 | happened. Use these commands to manage the @value{GDBN} command | |
20000 | history facility. | |
104c1213 | 20001 | |
703663ab | 20002 | @value{GDBN} uses the @sc{gnu} History library, a part of the Readline |
39037522 TT |
20003 | package, to provide the history facility. |
20004 | @ifset SYSTEM_READLINE | |
20005 | @xref{Using History Interactively, , , history, GNU History Library}, | |
20006 | @end ifset | |
20007 | @ifclear SYSTEM_READLINE | |
20008 | @xref{Using History Interactively}, | |
20009 | @end ifclear | |
20010 | for the detailed description of the History library. | |
703663ab | 20011 | |
d620b259 | 20012 | To issue a command to @value{GDBN} without affecting certain aspects of |
9e6c4bd5 NR |
20013 | the state which is seen by users, prefix it with @samp{server } |
20014 | (@pxref{Server Prefix}). This | |
d620b259 NR |
20015 | means that this command will not affect the command history, nor will it |
20016 | affect @value{GDBN}'s notion of which command to repeat if @key{RET} is | |
20017 | pressed on a line by itself. | |
20018 | ||
20019 | @cindex @code{server}, command prefix | |
20020 | The server prefix does not affect the recording of values into the value | |
20021 | history; to print a value without recording it into the value history, | |
20022 | use the @code{output} command instead of the @code{print} command. | |
20023 | ||
703663ab EZ |
20024 | Here is the description of @value{GDBN} commands related to command |
20025 | history. | |
20026 | ||
104c1213 | 20027 | @table @code |
8e04817f AC |
20028 | @cindex history substitution |
20029 | @cindex history file | |
20030 | @kindex set history filename | |
4644b6e3 | 20031 | @cindex @env{GDBHISTFILE}, environment variable |
8e04817f AC |
20032 | @item set history filename @var{fname} |
20033 | Set the name of the @value{GDBN} command history file to @var{fname}. | |
20034 | This is the file where @value{GDBN} reads an initial command history | |
20035 | list, and where it writes the command history from this session when it | |
20036 | exits. You can access this list through history expansion or through | |
20037 | the history command editing characters listed below. This file defaults | |
20038 | to the value of the environment variable @code{GDBHISTFILE}, or to | |
20039 | @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable | |
20040 | is not set. | |
104c1213 | 20041 | |
9c16f35a EZ |
20042 | @cindex save command history |
20043 | @kindex set history save | |
8e04817f AC |
20044 | @item set history save |
20045 | @itemx set history save on | |
20046 | Record command history in a file, whose name may be specified with the | |
20047 | @code{set history filename} command. By default, this option is disabled. | |
104c1213 | 20048 | |
8e04817f AC |
20049 | @item set history save off |
20050 | Stop recording command history in a file. | |
104c1213 | 20051 | |
8e04817f | 20052 | @cindex history size |
9c16f35a | 20053 | @kindex set history size |
6fc08d32 | 20054 | @cindex @env{HISTSIZE}, environment variable |
8e04817f AC |
20055 | @item set history size @var{size} |
20056 | Set the number of commands which @value{GDBN} keeps in its history list. | |
20057 | This defaults to the value of the environment variable | |
20058 | @code{HISTSIZE}, or to 256 if this variable is not set. | |
104c1213 JM |
20059 | @end table |
20060 | ||
8e04817f | 20061 | History expansion assigns special meaning to the character @kbd{!}. |
39037522 TT |
20062 | @ifset SYSTEM_READLINE |
20063 | @xref{Event Designators, , , history, GNU History Library}, | |
20064 | @end ifset | |
20065 | @ifclear SYSTEM_READLINE | |
20066 | @xref{Event Designators}, | |
20067 | @end ifclear | |
20068 | for more details. | |
8e04817f | 20069 | |
703663ab | 20070 | @cindex history expansion, turn on/off |
8e04817f AC |
20071 | Since @kbd{!} is also the logical not operator in C, history expansion |
20072 | is off by default. If you decide to enable history expansion with the | |
20073 | @code{set history expansion on} command, you may sometimes need to | |
20074 | follow @kbd{!} (when it is used as logical not, in an expression) with | |
20075 | a space or a tab to prevent it from being expanded. The readline | |
20076 | history facilities do not attempt substitution on the strings | |
20077 | @kbd{!=} and @kbd{!(}, even when history expansion is enabled. | |
20078 | ||
20079 | The commands to control history expansion are: | |
104c1213 JM |
20080 | |
20081 | @table @code | |
8e04817f AC |
20082 | @item set history expansion on |
20083 | @itemx set history expansion | |
703663ab | 20084 | @kindex set history expansion |
8e04817f | 20085 | Enable history expansion. History expansion is off by default. |
104c1213 | 20086 | |
8e04817f AC |
20087 | @item set history expansion off |
20088 | Disable history expansion. | |
104c1213 | 20089 | |
8e04817f AC |
20090 | @c @group |
20091 | @kindex show history | |
20092 | @item show history | |
20093 | @itemx show history filename | |
20094 | @itemx show history save | |
20095 | @itemx show history size | |
20096 | @itemx show history expansion | |
20097 | These commands display the state of the @value{GDBN} history parameters. | |
20098 | @code{show history} by itself displays all four states. | |
20099 | @c @end group | |
20100 | @end table | |
20101 | ||
20102 | @table @code | |
9c16f35a EZ |
20103 | @kindex show commands |
20104 | @cindex show last commands | |
20105 | @cindex display command history | |
8e04817f AC |
20106 | @item show commands |
20107 | Display the last ten commands in the command history. | |
104c1213 | 20108 | |
8e04817f AC |
20109 | @item show commands @var{n} |
20110 | Print ten commands centered on command number @var{n}. | |
20111 | ||
20112 | @item show commands + | |
20113 | Print ten commands just after the commands last printed. | |
104c1213 JM |
20114 | @end table |
20115 | ||
8e04817f | 20116 | @node Screen Size |
79a6e687 | 20117 | @section Screen Size |
8e04817f AC |
20118 | @cindex size of screen |
20119 | @cindex pauses in output | |
104c1213 | 20120 | |
8e04817f AC |
20121 | Certain commands to @value{GDBN} may produce large amounts of |
20122 | information output to the screen. To help you read all of it, | |
20123 | @value{GDBN} pauses and asks you for input at the end of each page of | |
20124 | output. Type @key{RET} when you want to continue the output, or @kbd{q} | |
20125 | to discard the remaining output. Also, the screen width setting | |
20126 | determines when to wrap lines of output. Depending on what is being | |
20127 | printed, @value{GDBN} tries to break the line at a readable place, | |
20128 | rather than simply letting it overflow onto the following line. | |
20129 | ||
20130 | Normally @value{GDBN} knows the size of the screen from the terminal | |
20131 | driver software. For example, on Unix @value{GDBN} uses the termcap data base | |
20132 | together with the value of the @code{TERM} environment variable and the | |
20133 | @code{stty rows} and @code{stty cols} settings. If this is not correct, | |
20134 | you can override it with the @code{set height} and @code{set | |
20135 | width} commands: | |
20136 | ||
20137 | @table @code | |
20138 | @kindex set height | |
20139 | @kindex set width | |
20140 | @kindex show width | |
20141 | @kindex show height | |
20142 | @item set height @var{lpp} | |
20143 | @itemx show height | |
20144 | @itemx set width @var{cpl} | |
20145 | @itemx show width | |
20146 | These @code{set} commands specify a screen height of @var{lpp} lines and | |
20147 | a screen width of @var{cpl} characters. The associated @code{show} | |
20148 | commands display the current settings. | |
104c1213 | 20149 | |
8e04817f AC |
20150 | If you specify a height of zero lines, @value{GDBN} does not pause during |
20151 | output no matter how long the output is. This is useful if output is to a | |
20152 | file or to an editor buffer. | |
104c1213 | 20153 | |
8e04817f AC |
20154 | Likewise, you can specify @samp{set width 0} to prevent @value{GDBN} |
20155 | from wrapping its output. | |
9c16f35a EZ |
20156 | |
20157 | @item set pagination on | |
20158 | @itemx set pagination off | |
20159 | @kindex set pagination | |
20160 | Turn the output pagination on or off; the default is on. Turning | |
7c953934 TT |
20161 | pagination off is the alternative to @code{set height 0}. Note that |
20162 | running @value{GDBN} with the @option{--batch} option (@pxref{Mode | |
20163 | Options, -batch}) also automatically disables pagination. | |
9c16f35a EZ |
20164 | |
20165 | @item show pagination | |
20166 | @kindex show pagination | |
20167 | Show the current pagination mode. | |
104c1213 JM |
20168 | @end table |
20169 | ||
8e04817f AC |
20170 | @node Numbers |
20171 | @section Numbers | |
20172 | @cindex number representation | |
20173 | @cindex entering numbers | |
104c1213 | 20174 | |
8e04817f AC |
20175 | You can always enter numbers in octal, decimal, or hexadecimal in |
20176 | @value{GDBN} by the usual conventions: octal numbers begin with | |
20177 | @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers | |
eb2dae08 EZ |
20178 | begin with @samp{0x}. Numbers that neither begin with @samp{0} or |
20179 | @samp{0x}, nor end with a @samp{.} are, by default, entered in base | |
20180 | 10; likewise, the default display for numbers---when no particular | |
20181 | format is specified---is base 10. You can change the default base for | |
20182 | both input and output with the commands described below. | |
104c1213 | 20183 | |
8e04817f AC |
20184 | @table @code |
20185 | @kindex set input-radix | |
20186 | @item set input-radix @var{base} | |
20187 | Set the default base for numeric input. Supported choices | |
20188 | for @var{base} are decimal 8, 10, or 16. @var{base} must itself be | |
eb2dae08 | 20189 | specified either unambiguously or using the current input radix; for |
8e04817f | 20190 | example, any of |
104c1213 | 20191 | |
8e04817f | 20192 | @smallexample |
9c16f35a EZ |
20193 | set input-radix 012 |
20194 | set input-radix 10. | |
20195 | set input-radix 0xa | |
8e04817f | 20196 | @end smallexample |
104c1213 | 20197 | |
8e04817f | 20198 | @noindent |
9c16f35a | 20199 | sets the input base to decimal. On the other hand, @samp{set input-radix 10} |
eb2dae08 EZ |
20200 | leaves the input radix unchanged, no matter what it was, since |
20201 | @samp{10}, being without any leading or trailing signs of its base, is | |
20202 | interpreted in the current radix. Thus, if the current radix is 16, | |
20203 | @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't | |
20204 | change the radix. | |
104c1213 | 20205 | |
8e04817f AC |
20206 | @kindex set output-radix |
20207 | @item set output-radix @var{base} | |
20208 | Set the default base for numeric display. Supported choices | |
20209 | for @var{base} are decimal 8, 10, or 16. @var{base} must itself be | |
eb2dae08 | 20210 | specified either unambiguously or using the current input radix. |
104c1213 | 20211 | |
8e04817f AC |
20212 | @kindex show input-radix |
20213 | @item show input-radix | |
20214 | Display the current default base for numeric input. | |
104c1213 | 20215 | |
8e04817f AC |
20216 | @kindex show output-radix |
20217 | @item show output-radix | |
20218 | Display the current default base for numeric display. | |
9c16f35a EZ |
20219 | |
20220 | @item set radix @r{[}@var{base}@r{]} | |
20221 | @itemx show radix | |
20222 | @kindex set radix | |
20223 | @kindex show radix | |
20224 | These commands set and show the default base for both input and output | |
20225 | of numbers. @code{set radix} sets the radix of input and output to | |
20226 | the same base; without an argument, it resets the radix back to its | |
20227 | default value of 10. | |
20228 | ||
8e04817f | 20229 | @end table |
104c1213 | 20230 | |
1e698235 | 20231 | @node ABI |
79a6e687 | 20232 | @section Configuring the Current ABI |
1e698235 DJ |
20233 | |
20234 | @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your | |
20235 | application automatically. However, sometimes you need to override its | |
20236 | conclusions. Use these commands to manage @value{GDBN}'s view of the | |
20237 | current ABI. | |
20238 | ||
98b45e30 DJ |
20239 | @cindex OS ABI |
20240 | @kindex set osabi | |
b4e9345d | 20241 | @kindex show osabi |
98b45e30 DJ |
20242 | |
20243 | One @value{GDBN} configuration can debug binaries for multiple operating | |
b383017d | 20244 | system targets, either via remote debugging or native emulation. |
98b45e30 DJ |
20245 | @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use, |
20246 | but you can override its conclusion using the @code{set osabi} command. | |
20247 | One example where this is useful is in debugging of binaries which use | |
20248 | an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does | |
20249 | not have the same identifying marks that the standard C library for your | |
20250 | platform provides. | |
20251 | ||
20252 | @table @code | |
20253 | @item show osabi | |
20254 | Show the OS ABI currently in use. | |
20255 | ||
20256 | @item set osabi | |
20257 | With no argument, show the list of registered available OS ABI's. | |
20258 | ||
20259 | @item set osabi @var{abi} | |
20260 | Set the current OS ABI to @var{abi}. | |
20261 | @end table | |
20262 | ||
1e698235 | 20263 | @cindex float promotion |
1e698235 DJ |
20264 | |
20265 | Generally, the way that an argument of type @code{float} is passed to a | |
20266 | function depends on whether the function is prototyped. For a prototyped | |
20267 | (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged, | |
20268 | according to the architecture's convention for @code{float}. For unprototyped | |
20269 | (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type | |
20270 | @code{double} and then passed. | |
20271 | ||
20272 | Unfortunately, some forms of debug information do not reliably indicate whether | |
20273 | a function is prototyped. If @value{GDBN} calls a function that is not marked | |
20274 | as prototyped, it consults @kbd{set coerce-float-to-double}. | |
20275 | ||
20276 | @table @code | |
a8f24a35 | 20277 | @kindex set coerce-float-to-double |
1e698235 DJ |
20278 | @item set coerce-float-to-double |
20279 | @itemx set coerce-float-to-double on | |
20280 | Arguments of type @code{float} will be promoted to @code{double} when passed | |
20281 | to an unprototyped function. This is the default setting. | |
20282 | ||
20283 | @item set coerce-float-to-double off | |
20284 | Arguments of type @code{float} will be passed directly to unprototyped | |
20285 | functions. | |
9c16f35a EZ |
20286 | |
20287 | @kindex show coerce-float-to-double | |
20288 | @item show coerce-float-to-double | |
20289 | Show the current setting of promoting @code{float} to @code{double}. | |
1e698235 DJ |
20290 | @end table |
20291 | ||
f1212245 DJ |
20292 | @kindex set cp-abi |
20293 | @kindex show cp-abi | |
20294 | @value{GDBN} needs to know the ABI used for your program's C@t{++} | |
20295 | objects. The correct C@t{++} ABI depends on which C@t{++} compiler was | |
20296 | used to build your application. @value{GDBN} only fully supports | |
20297 | programs with a single C@t{++} ABI; if your program contains code using | |
20298 | multiple C@t{++} ABI's or if @value{GDBN} can not identify your | |
20299 | program's ABI correctly, you can tell @value{GDBN} which ABI to use. | |
20300 | Currently supported ABI's include ``gnu-v2'', for @code{g++} versions | |
20301 | before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and | |
20302 | ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may | |
20303 | use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is | |
20304 | ``auto''. | |
20305 | ||
20306 | @table @code | |
20307 | @item show cp-abi | |
20308 | Show the C@t{++} ABI currently in use. | |
20309 | ||
20310 | @item set cp-abi | |
20311 | With no argument, show the list of supported C@t{++} ABI's. | |
20312 | ||
20313 | @item set cp-abi @var{abi} | |
20314 | @itemx set cp-abi auto | |
20315 | Set the current C@t{++} ABI to @var{abi}, or return to automatic detection. | |
20316 | @end table | |
20317 | ||
8e04817f | 20318 | @node Messages/Warnings |
79a6e687 | 20319 | @section Optional Warnings and Messages |
104c1213 | 20320 | |
9c16f35a EZ |
20321 | @cindex verbose operation |
20322 | @cindex optional warnings | |
8e04817f AC |
20323 | By default, @value{GDBN} is silent about its inner workings. If you are |
20324 | running on a slow machine, you may want to use the @code{set verbose} | |
20325 | command. This makes @value{GDBN} tell you when it does a lengthy | |
20326 | internal operation, so you will not think it has crashed. | |
104c1213 | 20327 | |
8e04817f AC |
20328 | Currently, the messages controlled by @code{set verbose} are those |
20329 | which announce that the symbol table for a source file is being read; | |
79a6e687 | 20330 | see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}. |
104c1213 | 20331 | |
8e04817f AC |
20332 | @table @code |
20333 | @kindex set verbose | |
20334 | @item set verbose on | |
20335 | Enables @value{GDBN} output of certain informational messages. | |
104c1213 | 20336 | |
8e04817f AC |
20337 | @item set verbose off |
20338 | Disables @value{GDBN} output of certain informational messages. | |
104c1213 | 20339 | |
8e04817f AC |
20340 | @kindex show verbose |
20341 | @item show verbose | |
20342 | Displays whether @code{set verbose} is on or off. | |
20343 | @end table | |
104c1213 | 20344 | |
8e04817f AC |
20345 | By default, if @value{GDBN} encounters bugs in the symbol table of an |
20346 | object file, it is silent; but if you are debugging a compiler, you may | |
79a6e687 BW |
20347 | find this information useful (@pxref{Symbol Errors, ,Errors Reading |
20348 | Symbol Files}). | |
104c1213 | 20349 | |
8e04817f | 20350 | @table @code |
104c1213 | 20351 | |
8e04817f AC |
20352 | @kindex set complaints |
20353 | @item set complaints @var{limit} | |
20354 | Permits @value{GDBN} to output @var{limit} complaints about each type of | |
20355 | unusual symbols before becoming silent about the problem. Set | |
20356 | @var{limit} to zero to suppress all complaints; set it to a large number | |
20357 | to prevent complaints from being suppressed. | |
104c1213 | 20358 | |
8e04817f AC |
20359 | @kindex show complaints |
20360 | @item show complaints | |
20361 | Displays how many symbol complaints @value{GDBN} is permitted to produce. | |
104c1213 | 20362 | |
8e04817f | 20363 | @end table |
104c1213 | 20364 | |
d837706a | 20365 | @anchor{confirmation requests} |
8e04817f AC |
20366 | By default, @value{GDBN} is cautious, and asks what sometimes seems to be a |
20367 | lot of stupid questions to confirm certain commands. For example, if | |
20368 | you try to run a program which is already running: | |
104c1213 | 20369 | |
474c8240 | 20370 | @smallexample |
8e04817f AC |
20371 | (@value{GDBP}) run |
20372 | The program being debugged has been started already. | |
20373 | Start it from the beginning? (y or n) | |
474c8240 | 20374 | @end smallexample |
104c1213 | 20375 | |
8e04817f AC |
20376 | If you are willing to unflinchingly face the consequences of your own |
20377 | commands, you can disable this ``feature'': | |
104c1213 | 20378 | |
8e04817f | 20379 | @table @code |
104c1213 | 20380 | |
8e04817f AC |
20381 | @kindex set confirm |
20382 | @cindex flinching | |
20383 | @cindex confirmation | |
20384 | @cindex stupid questions | |
20385 | @item set confirm off | |
7c953934 TT |
20386 | Disables confirmation requests. Note that running @value{GDBN} with |
20387 | the @option{--batch} option (@pxref{Mode Options, -batch}) also | |
20388 | automatically disables confirmation requests. | |
104c1213 | 20389 | |
8e04817f AC |
20390 | @item set confirm on |
20391 | Enables confirmation requests (the default). | |
104c1213 | 20392 | |
8e04817f AC |
20393 | @kindex show confirm |
20394 | @item show confirm | |
20395 | Displays state of confirmation requests. | |
20396 | ||
20397 | @end table | |
104c1213 | 20398 | |
16026cd7 AS |
20399 | @cindex command tracing |
20400 | If you need to debug user-defined commands or sourced files you may find it | |
20401 | useful to enable @dfn{command tracing}. In this mode each command will be | |
20402 | printed as it is executed, prefixed with one or more @samp{+} symbols, the | |
20403 | quantity denoting the call depth of each command. | |
20404 | ||
20405 | @table @code | |
20406 | @kindex set trace-commands | |
20407 | @cindex command scripts, debugging | |
20408 | @item set trace-commands on | |
20409 | Enable command tracing. | |
20410 | @item set trace-commands off | |
20411 | Disable command tracing. | |
20412 | @item show trace-commands | |
20413 | Display the current state of command tracing. | |
20414 | @end table | |
20415 | ||
8e04817f | 20416 | @node Debugging Output |
79a6e687 | 20417 | @section Optional Messages about Internal Happenings |
4644b6e3 EZ |
20418 | @cindex optional debugging messages |
20419 | ||
da316a69 EZ |
20420 | @value{GDBN} has commands that enable optional debugging messages from |
20421 | various @value{GDBN} subsystems; normally these commands are of | |
20422 | interest to @value{GDBN} maintainers, or when reporting a bug. This | |
20423 | section documents those commands. | |
20424 | ||
104c1213 | 20425 | @table @code |
a8f24a35 EZ |
20426 | @kindex set exec-done-display |
20427 | @item set exec-done-display | |
20428 | Turns on or off the notification of asynchronous commands' | |
20429 | completion. When on, @value{GDBN} will print a message when an | |
20430 | asynchronous command finishes its execution. The default is off. | |
20431 | @kindex show exec-done-display | |
20432 | @item show exec-done-display | |
20433 | Displays the current setting of asynchronous command completion | |
20434 | notification. | |
4644b6e3 EZ |
20435 | @kindex set debug |
20436 | @cindex gdbarch debugging info | |
a8f24a35 | 20437 | @cindex architecture debugging info |
8e04817f | 20438 | @item set debug arch |
a8f24a35 | 20439 | Turns on or off display of gdbarch debugging info. The default is off |
4644b6e3 | 20440 | @kindex show debug |
8e04817f AC |
20441 | @item show debug arch |
20442 | Displays the current state of displaying gdbarch debugging info. | |
721c2651 EZ |
20443 | @item set debug aix-thread |
20444 | @cindex AIX threads | |
20445 | Display debugging messages about inner workings of the AIX thread | |
20446 | module. | |
20447 | @item show debug aix-thread | |
20448 | Show the current state of AIX thread debugging info display. | |
900e11f9 JK |
20449 | @item set debug check-physname |
20450 | @cindex physname | |
20451 | Check the results of the ``physname'' computation. When reading DWARF | |
20452 | debugging information for C@t{++}, @value{GDBN} attempts to compute | |
20453 | each entity's name. @value{GDBN} can do this computation in two | |
20454 | different ways, depending on exactly what information is present. | |
20455 | When enabled, this setting causes @value{GDBN} to compute the names | |
20456 | both ways and display any discrepancies. | |
20457 | @item show debug check-physname | |
20458 | Show the current state of ``physname'' checking. | |
d97bc12b DE |
20459 | @item set debug dwarf2-die |
20460 | @cindex DWARF2 DIEs | |
20461 | Dump DWARF2 DIEs after they are read in. | |
20462 | The value is the number of nesting levels to print. | |
20463 | A value of zero turns off the display. | |
20464 | @item show debug dwarf2-die | |
20465 | Show the current state of DWARF2 DIE debugging. | |
237fc4c9 PA |
20466 | @item set debug displaced |
20467 | @cindex displaced stepping debugging info | |
20468 | Turns on or off display of @value{GDBN} debugging info for the | |
20469 | displaced stepping support. The default is off. | |
20470 | @item show debug displaced | |
20471 | Displays the current state of displaying @value{GDBN} debugging info | |
20472 | related to displaced stepping. | |
8e04817f | 20473 | @item set debug event |
4644b6e3 | 20474 | @cindex event debugging info |
a8f24a35 | 20475 | Turns on or off display of @value{GDBN} event debugging info. The |
8e04817f | 20476 | default is off. |
8e04817f AC |
20477 | @item show debug event |
20478 | Displays the current state of displaying @value{GDBN} event debugging | |
20479 | info. | |
8e04817f | 20480 | @item set debug expression |
4644b6e3 | 20481 | @cindex expression debugging info |
721c2651 EZ |
20482 | Turns on or off display of debugging info about @value{GDBN} |
20483 | expression parsing. The default is off. | |
8e04817f | 20484 | @item show debug expression |
721c2651 EZ |
20485 | Displays the current state of displaying debugging info about |
20486 | @value{GDBN} expression parsing. | |
7453dc06 | 20487 | @item set debug frame |
4644b6e3 | 20488 | @cindex frame debugging info |
7453dc06 AC |
20489 | Turns on or off display of @value{GDBN} frame debugging info. The |
20490 | default is off. | |
7453dc06 AC |
20491 | @item show debug frame |
20492 | Displays the current state of displaying @value{GDBN} frame debugging | |
20493 | info. | |
cbe54154 PA |
20494 | @item set debug gnu-nat |
20495 | @cindex @sc{gnu}/Hurd debug messages | |
20496 | Turns on or off debugging messages from the @sc{gnu}/Hurd debug support. | |
20497 | @item show debug gnu-nat | |
20498 | Show the current state of @sc{gnu}/Hurd debugging messages. | |
30e91e0b RC |
20499 | @item set debug infrun |
20500 | @cindex inferior debugging info | |
20501 | Turns on or off display of @value{GDBN} debugging info for running the inferior. | |
20502 | The default is off. @file{infrun.c} contains GDB's runtime state machine used | |
20503 | for implementing operations such as single-stepping the inferior. | |
20504 | @item show debug infrun | |
20505 | Displays the current state of @value{GDBN} inferior debugging. | |
a255712f PP |
20506 | @item set debug jit |
20507 | @cindex just-in-time compilation, debugging messages | |
20508 | Turns on or off debugging messages from JIT debug support. | |
20509 | @item show debug jit | |
20510 | Displays the current state of @value{GDBN} JIT debugging. | |
da316a69 EZ |
20511 | @item set debug lin-lwp |
20512 | @cindex @sc{gnu}/Linux LWP debug messages | |
20513 | @cindex Linux lightweight processes | |
721c2651 | 20514 | Turns on or off debugging messages from the Linux LWP debug support. |
da316a69 EZ |
20515 | @item show debug lin-lwp |
20516 | Show the current state of Linux LWP debugging messages. | |
2b4855ab | 20517 | @item set debug observer |
4644b6e3 | 20518 | @cindex observer debugging info |
2b4855ab AC |
20519 | Turns on or off display of @value{GDBN} observer debugging. This |
20520 | includes info such as the notification of observable events. | |
2b4855ab AC |
20521 | @item show debug observer |
20522 | Displays the current state of observer debugging. | |
8e04817f | 20523 | @item set debug overload |
4644b6e3 | 20524 | @cindex C@t{++} overload debugging info |
8e04817f | 20525 | Turns on or off display of @value{GDBN} C@t{++} overload debugging |
359df76b | 20526 | info. This includes info such as ranking of functions, etc. The default |
8e04817f | 20527 | is off. |
8e04817f AC |
20528 | @item show debug overload |
20529 | Displays the current state of displaying @value{GDBN} C@t{++} overload | |
20530 | debugging info. | |
92981e24 TT |
20531 | @cindex expression parser, debugging info |
20532 | @cindex debug expression parser | |
20533 | @item set debug parser | |
20534 | Turns on or off the display of expression parser debugging output. | |
20535 | Internally, this sets the @code{yydebug} variable in the expression | |
20536 | parser. @xref{Tracing, , Tracing Your Parser, bison, Bison}, for | |
20537 | details. The default is off. | |
20538 | @item show debug parser | |
20539 | Show the current state of expression parser debugging. | |
8e04817f AC |
20540 | @cindex packets, reporting on stdout |
20541 | @cindex serial connections, debugging | |
605a56cb DJ |
20542 | @cindex debug remote protocol |
20543 | @cindex remote protocol debugging | |
20544 | @cindex display remote packets | |
8e04817f AC |
20545 | @item set debug remote |
20546 | Turns on or off display of reports on all packets sent back and forth across | |
20547 | the serial line to the remote machine. The info is printed on the | |
20548 | @value{GDBN} standard output stream. The default is off. | |
8e04817f AC |
20549 | @item show debug remote |
20550 | Displays the state of display of remote packets. | |
8e04817f AC |
20551 | @item set debug serial |
20552 | Turns on or off display of @value{GDBN} serial debugging info. The | |
20553 | default is off. | |
8e04817f AC |
20554 | @item show debug serial |
20555 | Displays the current state of displaying @value{GDBN} serial debugging | |
20556 | info. | |
c45da7e6 EZ |
20557 | @item set debug solib-frv |
20558 | @cindex FR-V shared-library debugging | |
20559 | Turns on or off debugging messages for FR-V shared-library code. | |
20560 | @item show debug solib-frv | |
20561 | Display the current state of FR-V shared-library code debugging | |
20562 | messages. | |
8e04817f | 20563 | @item set debug target |
4644b6e3 | 20564 | @cindex target debugging info |
8e04817f AC |
20565 | Turns on or off display of @value{GDBN} target debugging info. This info |
20566 | includes what is going on at the target level of GDB, as it happens. The | |
701b08bb DJ |
20567 | default is 0. Set it to 1 to track events, and to 2 to also track the |
20568 | value of large memory transfers. Changes to this flag do not take effect | |
20569 | until the next time you connect to a target or use the @code{run} command. | |
8e04817f AC |
20570 | @item show debug target |
20571 | Displays the current state of displaying @value{GDBN} target debugging | |
20572 | info. | |
75feb17d DJ |
20573 | @item set debug timestamp |
20574 | @cindex timestampping debugging info | |
20575 | Turns on or off display of timestamps with @value{GDBN} debugging info. | |
20576 | When enabled, seconds and microseconds are displayed before each debugging | |
20577 | message. | |
20578 | @item show debug timestamp | |
20579 | Displays the current state of displaying timestamps with @value{GDBN} | |
20580 | debugging info. | |
c45da7e6 | 20581 | @item set debugvarobj |
4644b6e3 | 20582 | @cindex variable object debugging info |
8e04817f AC |
20583 | Turns on or off display of @value{GDBN} variable object debugging |
20584 | info. The default is off. | |
c45da7e6 | 20585 | @item show debugvarobj |
8e04817f AC |
20586 | Displays the current state of displaying @value{GDBN} variable object |
20587 | debugging info. | |
e776119f DJ |
20588 | @item set debug xml |
20589 | @cindex XML parser debugging | |
20590 | Turns on or off debugging messages for built-in XML parsers. | |
20591 | @item show debug xml | |
20592 | Displays the current state of XML debugging messages. | |
8e04817f | 20593 | @end table |
104c1213 | 20594 | |
14fb1bac JB |
20595 | @node Other Misc Settings |
20596 | @section Other Miscellaneous Settings | |
20597 | @cindex miscellaneous settings | |
20598 | ||
20599 | @table @code | |
20600 | @kindex set interactive-mode | |
20601 | @item set interactive-mode | |
7bfc9434 JB |
20602 | If @code{on}, forces @value{GDBN} to assume that GDB was started |
20603 | in a terminal. In practice, this means that @value{GDBN} should wait | |
20604 | for the user to answer queries generated by commands entered at | |
20605 | the command prompt. If @code{off}, forces @value{GDBN} to operate | |
20606 | in the opposite mode, and it uses the default answers to all queries. | |
20607 | If @code{auto} (the default), @value{GDBN} tries to determine whether | |
20608 | its standard input is a terminal, and works in interactive-mode if it | |
20609 | is, non-interactively otherwise. | |
14fb1bac JB |
20610 | |
20611 | In the vast majority of cases, the debugger should be able to guess | |
20612 | correctly which mode should be used. But this setting can be useful | |
20613 | in certain specific cases, such as running a MinGW @value{GDBN} | |
20614 | inside a cygwin window. | |
20615 | ||
20616 | @kindex show interactive-mode | |
20617 | @item show interactive-mode | |
20618 | Displays whether the debugger is operating in interactive mode or not. | |
20619 | @end table | |
20620 | ||
d57a3c85 TJB |
20621 | @node Extending GDB |
20622 | @chapter Extending @value{GDBN} | |
20623 | @cindex extending GDB | |
20624 | ||
5a56e9c5 DE |
20625 | @value{GDBN} provides three mechanisms for extension. The first is based |
20626 | on composition of @value{GDBN} commands, the second is based on the | |
20627 | Python scripting language, and the third is for defining new aliases of | |
20628 | existing commands. | |
d57a3c85 | 20629 | |
5a56e9c5 | 20630 | To facilitate the use of the first two extensions, @value{GDBN} is capable |
95433b34 JB |
20631 | of evaluating the contents of a file. When doing so, @value{GDBN} |
20632 | can recognize which scripting language is being used by looking at | |
20633 | the filename extension. Files with an unrecognized filename extension | |
20634 | are always treated as a @value{GDBN} Command Files. | |
20635 | @xref{Command Files,, Command files}. | |
20636 | ||
20637 | You can control how @value{GDBN} evaluates these files with the following | |
20638 | setting: | |
20639 | ||
20640 | @table @code | |
20641 | @kindex set script-extension | |
20642 | @kindex show script-extension | |
20643 | @item set script-extension off | |
20644 | All scripts are always evaluated as @value{GDBN} Command Files. | |
20645 | ||
20646 | @item set script-extension soft | |
20647 | The debugger determines the scripting language based on filename | |
20648 | extension. If this scripting language is supported, @value{GDBN} | |
20649 | evaluates the script using that language. Otherwise, it evaluates | |
20650 | the file as a @value{GDBN} Command File. | |
20651 | ||
20652 | @item set script-extension strict | |
20653 | The debugger determines the scripting language based on filename | |
20654 | extension, and evaluates the script using that language. If the | |
20655 | language is not supported, then the evaluation fails. | |
20656 | ||
20657 | @item show script-extension | |
20658 | Display the current value of the @code{script-extension} option. | |
20659 | ||
20660 | @end table | |
20661 | ||
d57a3c85 TJB |
20662 | @menu |
20663 | * Sequences:: Canned Sequences of Commands | |
20664 | * Python:: Scripting @value{GDBN} using Python | |
5a56e9c5 | 20665 | * Aliases:: Creating new spellings of existing commands |
d57a3c85 TJB |
20666 | @end menu |
20667 | ||
8e04817f | 20668 | @node Sequences |
d57a3c85 | 20669 | @section Canned Sequences of Commands |
104c1213 | 20670 | |
8e04817f | 20671 | Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint |
79a6e687 | 20672 | Command Lists}), @value{GDBN} provides two ways to store sequences of |
8e04817f AC |
20673 | commands for execution as a unit: user-defined commands and command |
20674 | files. | |
104c1213 | 20675 | |
8e04817f | 20676 | @menu |
fcc73fe3 EZ |
20677 | * Define:: How to define your own commands |
20678 | * Hooks:: Hooks for user-defined commands | |
20679 | * Command Files:: How to write scripts of commands to be stored in a file | |
20680 | * Output:: Commands for controlled output | |
8e04817f | 20681 | @end menu |
104c1213 | 20682 | |
8e04817f | 20683 | @node Define |
d57a3c85 | 20684 | @subsection User-defined Commands |
104c1213 | 20685 | |
8e04817f | 20686 | @cindex user-defined command |
fcc73fe3 | 20687 | @cindex arguments, to user-defined commands |
8e04817f AC |
20688 | A @dfn{user-defined command} is a sequence of @value{GDBN} commands to |
20689 | which you assign a new name as a command. This is done with the | |
20690 | @code{define} command. User commands may accept up to 10 arguments | |
20691 | separated by whitespace. Arguments are accessed within the user command | |
c03c782f | 20692 | via @code{$arg0@dots{}$arg9}. A trivial example: |
104c1213 | 20693 | |
8e04817f AC |
20694 | @smallexample |
20695 | define adder | |
20696 | print $arg0 + $arg1 + $arg2 | |
c03c782f | 20697 | end |
8e04817f | 20698 | @end smallexample |
104c1213 JM |
20699 | |
20700 | @noindent | |
8e04817f | 20701 | To execute the command use: |
104c1213 | 20702 | |
8e04817f AC |
20703 | @smallexample |
20704 | adder 1 2 3 | |
20705 | @end smallexample | |
104c1213 | 20706 | |
8e04817f AC |
20707 | @noindent |
20708 | This defines the command @code{adder}, which prints the sum of | |
20709 | its three arguments. Note the arguments are text substitutions, so they may | |
20710 | reference variables, use complex expressions, or even perform inferior | |
20711 | functions calls. | |
104c1213 | 20712 | |
fcc73fe3 EZ |
20713 | @cindex argument count in user-defined commands |
20714 | @cindex how many arguments (user-defined commands) | |
c03c782f AS |
20715 | In addition, @code{$argc} may be used to find out how many arguments have |
20716 | been passed. This expands to a number in the range 0@dots{}10. | |
20717 | ||
20718 | @smallexample | |
20719 | define adder | |
20720 | if $argc == 2 | |
20721 | print $arg0 + $arg1 | |
20722 | end | |
20723 | if $argc == 3 | |
20724 | print $arg0 + $arg1 + $arg2 | |
20725 | end | |
20726 | end | |
20727 | @end smallexample | |
20728 | ||
104c1213 | 20729 | @table @code |
104c1213 | 20730 | |
8e04817f AC |
20731 | @kindex define |
20732 | @item define @var{commandname} | |
20733 | Define a command named @var{commandname}. If there is already a command | |
20734 | by that name, you are asked to confirm that you want to redefine it. | |
adb483fe DJ |
20735 | @var{commandname} may be a bare command name consisting of letters, |
20736 | numbers, dashes, and underscores. It may also start with any predefined | |
20737 | prefix command. For example, @samp{define target my-target} creates | |
20738 | a user-defined @samp{target my-target} command. | |
104c1213 | 20739 | |
8e04817f AC |
20740 | The definition of the command is made up of other @value{GDBN} command lines, |
20741 | which are given following the @code{define} command. The end of these | |
20742 | commands is marked by a line containing @code{end}. | |
104c1213 | 20743 | |
8e04817f | 20744 | @kindex document |
ca91424e | 20745 | @kindex end@r{ (user-defined commands)} |
8e04817f AC |
20746 | @item document @var{commandname} |
20747 | Document the user-defined command @var{commandname}, so that it can be | |
20748 | accessed by @code{help}. The command @var{commandname} must already be | |
20749 | defined. This command reads lines of documentation just as @code{define} | |
20750 | reads the lines of the command definition, ending with @code{end}. | |
20751 | After the @code{document} command is finished, @code{help} on command | |
20752 | @var{commandname} displays the documentation you have written. | |
104c1213 | 20753 | |
8e04817f AC |
20754 | You may use the @code{document} command again to change the |
20755 | documentation of a command. Redefining the command with @code{define} | |
20756 | does not change the documentation. | |
104c1213 | 20757 | |
c45da7e6 EZ |
20758 | @kindex dont-repeat |
20759 | @cindex don't repeat command | |
20760 | @item dont-repeat | |
20761 | Used inside a user-defined command, this tells @value{GDBN} that this | |
20762 | command should not be repeated when the user hits @key{RET} | |
20763 | (@pxref{Command Syntax, repeat last command}). | |
20764 | ||
8e04817f AC |
20765 | @kindex help user-defined |
20766 | @item help user-defined | |
20767 | List all user-defined commands, with the first line of the documentation | |
20768 | (if any) for each. | |
104c1213 | 20769 | |
8e04817f AC |
20770 | @kindex show user |
20771 | @item show user | |
20772 | @itemx show user @var{commandname} | |
20773 | Display the @value{GDBN} commands used to define @var{commandname} (but | |
20774 | not its documentation). If no @var{commandname} is given, display the | |
20775 | definitions for all user-defined commands. | |
104c1213 | 20776 | |
fcc73fe3 | 20777 | @cindex infinite recursion in user-defined commands |
20f01a46 DH |
20778 | @kindex show max-user-call-depth |
20779 | @kindex set max-user-call-depth | |
20780 | @item show max-user-call-depth | |
5ca0cb28 DH |
20781 | @itemx set max-user-call-depth |
20782 | The value of @code{max-user-call-depth} controls how many recursion | |
3f94c067 | 20783 | levels are allowed in user-defined commands before @value{GDBN} suspects an |
5ca0cb28 | 20784 | infinite recursion and aborts the command. |
104c1213 JM |
20785 | @end table |
20786 | ||
fcc73fe3 EZ |
20787 | In addition to the above commands, user-defined commands frequently |
20788 | use control flow commands, described in @ref{Command Files}. | |
20789 | ||
8e04817f AC |
20790 | When user-defined commands are executed, the |
20791 | commands of the definition are not printed. An error in any command | |
20792 | stops execution of the user-defined command. | |
104c1213 | 20793 | |
8e04817f AC |
20794 | If used interactively, commands that would ask for confirmation proceed |
20795 | without asking when used inside a user-defined command. Many @value{GDBN} | |
20796 | commands that normally print messages to say what they are doing omit the | |
20797 | messages when used in a user-defined command. | |
104c1213 | 20798 | |
8e04817f | 20799 | @node Hooks |
d57a3c85 | 20800 | @subsection User-defined Command Hooks |
8e04817f AC |
20801 | @cindex command hooks |
20802 | @cindex hooks, for commands | |
20803 | @cindex hooks, pre-command | |
104c1213 | 20804 | |
8e04817f | 20805 | @kindex hook |
8e04817f AC |
20806 | You may define @dfn{hooks}, which are a special kind of user-defined |
20807 | command. Whenever you run the command @samp{foo}, if the user-defined | |
20808 | command @samp{hook-foo} exists, it is executed (with no arguments) | |
20809 | before that command. | |
104c1213 | 20810 | |
8e04817f AC |
20811 | @cindex hooks, post-command |
20812 | @kindex hookpost | |
8e04817f AC |
20813 | A hook may also be defined which is run after the command you executed. |
20814 | Whenever you run the command @samp{foo}, if the user-defined command | |
20815 | @samp{hookpost-foo} exists, it is executed (with no arguments) after | |
20816 | that command. Post-execution hooks may exist simultaneously with | |
20817 | pre-execution hooks, for the same command. | |
104c1213 | 20818 | |
8e04817f | 20819 | It is valid for a hook to call the command which it hooks. If this |
9f1c6395 | 20820 | occurs, the hook is not re-executed, thereby avoiding infinite recursion. |
104c1213 | 20821 | |
8e04817f AC |
20822 | @c It would be nice if hookpost could be passed a parameter indicating |
20823 | @c if the command it hooks executed properly or not. FIXME! | |
104c1213 | 20824 | |
8e04817f AC |
20825 | @kindex stop@r{, a pseudo-command} |
20826 | In addition, a pseudo-command, @samp{stop} exists. Defining | |
20827 | (@samp{hook-stop}) makes the associated commands execute every time | |
20828 | execution stops in your program: before breakpoint commands are run, | |
20829 | displays are printed, or the stack frame is printed. | |
104c1213 | 20830 | |
8e04817f AC |
20831 | For example, to ignore @code{SIGALRM} signals while |
20832 | single-stepping, but treat them normally during normal execution, | |
20833 | you could define: | |
104c1213 | 20834 | |
474c8240 | 20835 | @smallexample |
8e04817f AC |
20836 | define hook-stop |
20837 | handle SIGALRM nopass | |
20838 | end | |
104c1213 | 20839 | |
8e04817f AC |
20840 | define hook-run |
20841 | handle SIGALRM pass | |
20842 | end | |
104c1213 | 20843 | |
8e04817f | 20844 | define hook-continue |
d3e8051b | 20845 | handle SIGALRM pass |
8e04817f | 20846 | end |
474c8240 | 20847 | @end smallexample |
104c1213 | 20848 | |
d3e8051b | 20849 | As a further example, to hook at the beginning and end of the @code{echo} |
b383017d | 20850 | command, and to add extra text to the beginning and end of the message, |
8e04817f | 20851 | you could define: |
104c1213 | 20852 | |
474c8240 | 20853 | @smallexample |
8e04817f AC |
20854 | define hook-echo |
20855 | echo <<<--- | |
20856 | end | |
104c1213 | 20857 | |
8e04817f AC |
20858 | define hookpost-echo |
20859 | echo --->>>\n | |
20860 | end | |
104c1213 | 20861 | |
8e04817f AC |
20862 | (@value{GDBP}) echo Hello World |
20863 | <<<---Hello World--->>> | |
20864 | (@value{GDBP}) | |
104c1213 | 20865 | |
474c8240 | 20866 | @end smallexample |
104c1213 | 20867 | |
8e04817f AC |
20868 | You can define a hook for any single-word command in @value{GDBN}, but |
20869 | not for command aliases; you should define a hook for the basic command | |
c1468174 | 20870 | name, e.g.@: @code{backtrace} rather than @code{bt}. |
8e04817f AC |
20871 | @c FIXME! So how does Joe User discover whether a command is an alias |
20872 | @c or not? | |
adb483fe DJ |
20873 | You can hook a multi-word command by adding @code{hook-} or |
20874 | @code{hookpost-} to the last word of the command, e.g.@: | |
20875 | @samp{define target hook-remote} to add a hook to @samp{target remote}. | |
20876 | ||
8e04817f AC |
20877 | If an error occurs during the execution of your hook, execution of |
20878 | @value{GDBN} commands stops and @value{GDBN} issues a prompt | |
20879 | (before the command that you actually typed had a chance to run). | |
104c1213 | 20880 | |
8e04817f AC |
20881 | If you try to define a hook which does not match any known command, you |
20882 | get a warning from the @code{define} command. | |
c906108c | 20883 | |
8e04817f | 20884 | @node Command Files |
d57a3c85 | 20885 | @subsection Command Files |
c906108c | 20886 | |
8e04817f | 20887 | @cindex command files |
fcc73fe3 | 20888 | @cindex scripting commands |
6fc08d32 EZ |
20889 | A command file for @value{GDBN} is a text file made of lines that are |
20890 | @value{GDBN} commands. Comments (lines starting with @kbd{#}) may | |
20891 | also be included. An empty line in a command file does nothing; it | |
20892 | does not mean to repeat the last command, as it would from the | |
20893 | terminal. | |
c906108c | 20894 | |
6fc08d32 | 20895 | You can request the execution of a command file with the @code{source} |
95433b34 JB |
20896 | command. Note that the @code{source} command is also used to evaluate |
20897 | scripts that are not Command Files. The exact behavior can be configured | |
20898 | using the @code{script-extension} setting. | |
20899 | @xref{Extending GDB,, Extending GDB}. | |
c906108c | 20900 | |
8e04817f AC |
20901 | @table @code |
20902 | @kindex source | |
ca91424e | 20903 | @cindex execute commands from a file |
3f7b2faa | 20904 | @item source [-s] [-v] @var{filename} |
8e04817f | 20905 | Execute the command file @var{filename}. |
c906108c SS |
20906 | @end table |
20907 | ||
fcc73fe3 EZ |
20908 | The lines in a command file are generally executed sequentially, |
20909 | unless the order of execution is changed by one of the | |
20910 | @emph{flow-control commands} described below. The commands are not | |
a71ec265 DH |
20911 | printed as they are executed. An error in any command terminates |
20912 | execution of the command file and control is returned to the console. | |
c906108c | 20913 | |
08001717 DE |
20914 | @value{GDBN} first searches for @var{filename} in the current directory. |
20915 | If the file is not found there, and @var{filename} does not specify a | |
20916 | directory, then @value{GDBN} also looks for the file on the source search path | |
20917 | (specified with the @samp{directory} command); | |
20918 | except that @file{$cdir} is not searched because the compilation directory | |
20919 | is not relevant to scripts. | |
4b505b12 | 20920 | |
3f7b2faa DE |
20921 | If @code{-s} is specified, then @value{GDBN} searches for @var{filename} |
20922 | on the search path even if @var{filename} specifies a directory. | |
20923 | The search is done by appending @var{filename} to each element of the | |
20924 | search path. So, for example, if @var{filename} is @file{mylib/myscript} | |
20925 | and the search path contains @file{/home/user} then @value{GDBN} will | |
20926 | look for the script @file{/home/user/mylib/myscript}. | |
20927 | The search is also done if @var{filename} is an absolute path. | |
20928 | For example, if @var{filename} is @file{/tmp/myscript} and | |
20929 | the search path contains @file{/home/user} then @value{GDBN} will | |
20930 | look for the script @file{/home/user/tmp/myscript}. | |
20931 | For DOS-like systems, if @var{filename} contains a drive specification, | |
20932 | it is stripped before concatenation. For example, if @var{filename} is | |
20933 | @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN} | |
20934 | will look for the script @file{c:/tmp/myscript}. | |
20935 | ||
16026cd7 AS |
20936 | If @code{-v}, for verbose mode, is given then @value{GDBN} displays |
20937 | each command as it is executed. The option must be given before | |
20938 | @var{filename}, and is interpreted as part of the filename anywhere else. | |
20939 | ||
8e04817f AC |
20940 | Commands that would ask for confirmation if used interactively proceed |
20941 | without asking when used in a command file. Many @value{GDBN} commands that | |
20942 | normally print messages to say what they are doing omit the messages | |
20943 | when called from command files. | |
c906108c | 20944 | |
8e04817f AC |
20945 | @value{GDBN} also accepts command input from standard input. In this |
20946 | mode, normal output goes to standard output and error output goes to | |
20947 | standard error. Errors in a command file supplied on standard input do | |
6fc08d32 | 20948 | not terminate execution of the command file---execution continues with |
8e04817f | 20949 | the next command. |
c906108c | 20950 | |
474c8240 | 20951 | @smallexample |
8e04817f | 20952 | gdb < cmds > log 2>&1 |
474c8240 | 20953 | @end smallexample |
c906108c | 20954 | |
8e04817f AC |
20955 | (The syntax above will vary depending on the shell used.) This example |
20956 | will execute commands from the file @file{cmds}. All output and errors | |
20957 | would be directed to @file{log}. | |
c906108c | 20958 | |
fcc73fe3 EZ |
20959 | Since commands stored on command files tend to be more general than |
20960 | commands typed interactively, they frequently need to deal with | |
20961 | complicated situations, such as different or unexpected values of | |
20962 | variables and symbols, changes in how the program being debugged is | |
20963 | built, etc. @value{GDBN} provides a set of flow-control commands to | |
20964 | deal with these complexities. Using these commands, you can write | |
20965 | complex scripts that loop over data structures, execute commands | |
20966 | conditionally, etc. | |
20967 | ||
20968 | @table @code | |
20969 | @kindex if | |
20970 | @kindex else | |
20971 | @item if | |
20972 | @itemx else | |
20973 | This command allows to include in your script conditionally executed | |
20974 | commands. The @code{if} command takes a single argument, which is an | |
20975 | expression to evaluate. It is followed by a series of commands that | |
20976 | are executed only if the expression is true (its value is nonzero). | |
20977 | There can then optionally be an @code{else} line, followed by a series | |
20978 | of commands that are only executed if the expression was false. The | |
20979 | end of the list is marked by a line containing @code{end}. | |
20980 | ||
20981 | @kindex while | |
20982 | @item while | |
20983 | This command allows to write loops. Its syntax is similar to | |
20984 | @code{if}: the command takes a single argument, which is an expression | |
20985 | to evaluate, and must be followed by the commands to execute, one per | |
20986 | line, terminated by an @code{end}. These commands are called the | |
20987 | @dfn{body} of the loop. The commands in the body of @code{while} are | |
20988 | executed repeatedly as long as the expression evaluates to true. | |
20989 | ||
20990 | @kindex loop_break | |
20991 | @item loop_break | |
20992 | This command exits the @code{while} loop in whose body it is included. | |
20993 | Execution of the script continues after that @code{while}s @code{end} | |
20994 | line. | |
20995 | ||
20996 | @kindex loop_continue | |
20997 | @item loop_continue | |
20998 | This command skips the execution of the rest of the body of commands | |
20999 | in the @code{while} loop in whose body it is included. Execution | |
21000 | branches to the beginning of the @code{while} loop, where it evaluates | |
21001 | the controlling expression. | |
ca91424e EZ |
21002 | |
21003 | @kindex end@r{ (if/else/while commands)} | |
21004 | @item end | |
21005 | Terminate the block of commands that are the body of @code{if}, | |
21006 | @code{else}, or @code{while} flow-control commands. | |
fcc73fe3 EZ |
21007 | @end table |
21008 | ||
21009 | ||
8e04817f | 21010 | @node Output |
d57a3c85 | 21011 | @subsection Commands for Controlled Output |
c906108c | 21012 | |
8e04817f AC |
21013 | During the execution of a command file or a user-defined command, normal |
21014 | @value{GDBN} output is suppressed; the only output that appears is what is | |
21015 | explicitly printed by the commands in the definition. This section | |
21016 | describes three commands useful for generating exactly the output you | |
21017 | want. | |
c906108c SS |
21018 | |
21019 | @table @code | |
8e04817f AC |
21020 | @kindex echo |
21021 | @item echo @var{text} | |
21022 | @c I do not consider backslash-space a standard C escape sequence | |
21023 | @c because it is not in ANSI. | |
21024 | Print @var{text}. Nonprinting characters can be included in | |
21025 | @var{text} using C escape sequences, such as @samp{\n} to print a | |
21026 | newline. @strong{No newline is printed unless you specify one.} | |
21027 | In addition to the standard C escape sequences, a backslash followed | |
21028 | by a space stands for a space. This is useful for displaying a | |
21029 | string with spaces at the beginning or the end, since leading and | |
21030 | trailing spaces are otherwise trimmed from all arguments. | |
21031 | To print @samp{@w{ }and foo =@w{ }}, use the command | |
21032 | @samp{echo \@w{ }and foo = \@w{ }}. | |
c906108c | 21033 | |
8e04817f AC |
21034 | A backslash at the end of @var{text} can be used, as in C, to continue |
21035 | the command onto subsequent lines. For example, | |
c906108c | 21036 | |
474c8240 | 21037 | @smallexample |
8e04817f AC |
21038 | echo This is some text\n\ |
21039 | which is continued\n\ | |
21040 | onto several lines.\n | |
474c8240 | 21041 | @end smallexample |
c906108c | 21042 | |
8e04817f | 21043 | produces the same output as |
c906108c | 21044 | |
474c8240 | 21045 | @smallexample |
8e04817f AC |
21046 | echo This is some text\n |
21047 | echo which is continued\n | |
21048 | echo onto several lines.\n | |
474c8240 | 21049 | @end smallexample |
c906108c | 21050 | |
8e04817f AC |
21051 | @kindex output |
21052 | @item output @var{expression} | |
21053 | Print the value of @var{expression} and nothing but that value: no | |
21054 | newlines, no @samp{$@var{nn} = }. The value is not entered in the | |
21055 | value history either. @xref{Expressions, ,Expressions}, for more information | |
21056 | on expressions. | |
c906108c | 21057 | |
8e04817f AC |
21058 | @item output/@var{fmt} @var{expression} |
21059 | Print the value of @var{expression} in format @var{fmt}. You can use | |
21060 | the same formats as for @code{print}. @xref{Output Formats,,Output | |
79a6e687 | 21061 | Formats}, for more information. |
c906108c | 21062 | |
8e04817f | 21063 | @kindex printf |
82160952 EZ |
21064 | @item printf @var{template}, @var{expressions}@dots{} |
21065 | Print the values of one or more @var{expressions} under the control of | |
21066 | the string @var{template}. To print several values, make | |
21067 | @var{expressions} be a comma-separated list of individual expressions, | |
21068 | which may be either numbers or pointers. Their values are printed as | |
21069 | specified by @var{template}, exactly as a C program would do by | |
21070 | executing the code below: | |
c906108c | 21071 | |
474c8240 | 21072 | @smallexample |
82160952 | 21073 | printf (@var{template}, @var{expressions}@dots{}); |
474c8240 | 21074 | @end smallexample |
c906108c | 21075 | |
82160952 EZ |
21076 | As in @code{C} @code{printf}, ordinary characters in @var{template} |
21077 | are printed verbatim, while @dfn{conversion specification} introduced | |
21078 | by the @samp{%} character cause subsequent @var{expressions} to be | |
21079 | evaluated, their values converted and formatted according to type and | |
21080 | style information encoded in the conversion specifications, and then | |
21081 | printed. | |
21082 | ||
8e04817f | 21083 | For example, you can print two values in hex like this: |
c906108c | 21084 | |
8e04817f AC |
21085 | @smallexample |
21086 | printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo | |
21087 | @end smallexample | |
c906108c | 21088 | |
82160952 EZ |
21089 | @code{printf} supports all the standard @code{C} conversion |
21090 | specifications, including the flags and modifiers between the @samp{%} | |
21091 | character and the conversion letter, with the following exceptions: | |
21092 | ||
21093 | @itemize @bullet | |
21094 | @item | |
21095 | The argument-ordering modifiers, such as @samp{2$}, are not supported. | |
21096 | ||
21097 | @item | |
21098 | The modifier @samp{*} is not supported for specifying precision or | |
21099 | width. | |
21100 | ||
21101 | @item | |
21102 | The @samp{'} flag (for separation of digits into groups according to | |
21103 | @code{LC_NUMERIC'}) is not supported. | |
21104 | ||
21105 | @item | |
21106 | The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not | |
21107 | supported. | |
21108 | ||
21109 | @item | |
21110 | The conversion letter @samp{n} (as in @samp{%n}) is not supported. | |
21111 | ||
21112 | @item | |
21113 | The conversion letters @samp{a} and @samp{A} are not supported. | |
21114 | @end itemize | |
21115 | ||
21116 | @noindent | |
21117 | Note that the @samp{ll} type modifier is supported only if the | |
21118 | underlying @code{C} implementation used to build @value{GDBN} supports | |
21119 | the @code{long long int} type, and the @samp{L} type modifier is | |
21120 | supported only if @code{long double} type is available. | |
21121 | ||
21122 | As in @code{C}, @code{printf} supports simple backslash-escape | |
21123 | sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"}, | |
21124 | @samp{\a}, and @samp{\f}, that consist of backslash followed by a | |
21125 | single character. Octal and hexadecimal escape sequences are not | |
21126 | supported. | |
1a619819 LM |
21127 | |
21128 | Additionally, @code{printf} supports conversion specifications for DFP | |
0aea4bf3 LM |
21129 | (@dfn{Decimal Floating Point}) types using the following length modifiers |
21130 | together with a floating point specifier. | |
1a619819 LM |
21131 | letters: |
21132 | ||
21133 | @itemize @bullet | |
21134 | @item | |
21135 | @samp{H} for printing @code{Decimal32} types. | |
21136 | ||
21137 | @item | |
21138 | @samp{D} for printing @code{Decimal64} types. | |
21139 | ||
21140 | @item | |
21141 | @samp{DD} for printing @code{Decimal128} types. | |
21142 | @end itemize | |
21143 | ||
21144 | If the underlying @code{C} implementation used to build @value{GDBN} has | |
0aea4bf3 | 21145 | support for the three length modifiers for DFP types, other modifiers |
3b784c4f | 21146 | such as width and precision will also be available for @value{GDBN} to use. |
1a619819 LM |
21147 | |
21148 | In case there is no such @code{C} support, no additional modifiers will be | |
21149 | available and the value will be printed in the standard way. | |
21150 | ||
21151 | Here's an example of printing DFP types using the above conversion letters: | |
21152 | @smallexample | |
0aea4bf3 | 21153 | printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl |
1a619819 LM |
21154 | @end smallexample |
21155 | ||
f1421989 HZ |
21156 | @kindex eval |
21157 | @item eval @var{template}, @var{expressions}@dots{} | |
21158 | Convert the values of one or more @var{expressions} under the control of | |
21159 | the string @var{template} to a command line, and call it. | |
21160 | ||
c906108c SS |
21161 | @end table |
21162 | ||
d57a3c85 TJB |
21163 | @node Python |
21164 | @section Scripting @value{GDBN} using Python | |
21165 | @cindex python scripting | |
21166 | @cindex scripting with python | |
21167 | ||
21168 | You can script @value{GDBN} using the @uref{http://www.python.org/, | |
21169 | Python programming language}. This feature is available only if | |
21170 | @value{GDBN} was configured using @option{--with-python}. | |
21171 | ||
9279c692 JB |
21172 | @cindex python directory |
21173 | Python scripts used by @value{GDBN} should be installed in | |
21174 | @file{@var{data-directory}/python}, where @var{data-directory} is | |
9eeee977 DE |
21175 | the data directory as determined at @value{GDBN} startup (@pxref{Data Files}). |
21176 | This directory, known as the @dfn{python directory}, | |
9279c692 JB |
21177 | is automatically added to the Python Search Path in order to allow |
21178 | the Python interpreter to locate all scripts installed at this location. | |
21179 | ||
5e239b84 PM |
21180 | Additionally, @value{GDBN} commands and convenience functions which |
21181 | are written in Python and are located in the | |
21182 | @file{@var{data-directory}/python/gdb/command} or | |
21183 | @file{@var{data-directory}/python/gdb/function} directories are | |
21184 | automatically imported when @value{GDBN} starts. | |
21185 | ||
d57a3c85 TJB |
21186 | @menu |
21187 | * Python Commands:: Accessing Python from @value{GDBN}. | |
21188 | * Python API:: Accessing @value{GDBN} from Python. | |
8a1ea21f | 21189 | * Auto-loading:: Automatically loading Python code. |
0e3509db | 21190 | * Python modules:: Python modules provided by @value{GDBN}. |
d57a3c85 TJB |
21191 | @end menu |
21192 | ||
21193 | @node Python Commands | |
21194 | @subsection Python Commands | |
21195 | @cindex python commands | |
21196 | @cindex commands to access python | |
21197 | ||
21198 | @value{GDBN} provides one command for accessing the Python interpreter, | |
21199 | and one related setting: | |
21200 | ||
21201 | @table @code | |
21202 | @kindex python | |
21203 | @item python @r{[}@var{code}@r{]} | |
21204 | The @code{python} command can be used to evaluate Python code. | |
21205 | ||
21206 | If given an argument, the @code{python} command will evaluate the | |
21207 | argument as a Python command. For example: | |
21208 | ||
21209 | @smallexample | |
21210 | (@value{GDBP}) python print 23 | |
21211 | 23 | |
21212 | @end smallexample | |
21213 | ||
21214 | If you do not provide an argument to @code{python}, it will act as a | |
21215 | multi-line command, like @code{define}. In this case, the Python | |
21216 | script is made up of subsequent command lines, given after the | |
21217 | @code{python} command. This command list is terminated using a line | |
21218 | containing @code{end}. For example: | |
21219 | ||
21220 | @smallexample | |
21221 | (@value{GDBP}) python | |
21222 | Type python script | |
21223 | End with a line saying just "end". | |
21224 | >print 23 | |
21225 | >end | |
21226 | 23 | |
21227 | @end smallexample | |
21228 | ||
21229 | @kindex maint set python print-stack | |
21230 | @item maint set python print-stack | |
713389e0 PM |
21231 | This command is now deprecated. Instead use @code{set python |
21232 | print-stack} | |
21233 | ||
21234 | @kindex set python print-stack | |
21235 | @item set python print-stack | |
21236 | By default, @value{GDBN} will not print a stack trace when an error | |
21237 | occurs in a Python script. This can be controlled using @code{set | |
21238 | python print-stack}: if @code{on}, then Python stack printing is | |
21239 | enabled; if @code{off}, the default, then Python stack printing is | |
d57a3c85 TJB |
21240 | disabled. |
21241 | @end table | |
21242 | ||
95433b34 JB |
21243 | It is also possible to execute a Python script from the @value{GDBN} |
21244 | interpreter: | |
21245 | ||
21246 | @table @code | |
21247 | @item source @file{script-name} | |
21248 | The script name must end with @samp{.py} and @value{GDBN} must be configured | |
21249 | to recognize the script language based on filename extension using | |
21250 | the @code{script-extension} setting. @xref{Extending GDB, ,Extending GDB}. | |
21251 | ||
21252 | @item python execfile ("script-name") | |
21253 | This method is based on the @code{execfile} Python built-in function, | |
21254 | and thus is always available. | |
21255 | @end table | |
21256 | ||
d57a3c85 TJB |
21257 | @node Python API |
21258 | @subsection Python API | |
21259 | @cindex python api | |
21260 | @cindex programming in python | |
21261 | ||
21262 | @cindex python stdout | |
21263 | @cindex python pagination | |
21264 | At startup, @value{GDBN} overrides Python's @code{sys.stdout} and | |
21265 | @code{sys.stderr} to print using @value{GDBN}'s output-paging streams. | |
21266 | A Python program which outputs to one of these streams may have its | |
21267 | output interrupted by the user (@pxref{Screen Size}). In this | |
21268 | situation, a Python @code{KeyboardInterrupt} exception is thrown. | |
21269 | ||
21270 | @menu | |
21271 | * Basic Python:: Basic Python Functions. | |
06e65f44 TT |
21272 | * Exception Handling:: How Python exceptions are translated. |
21273 | * Values From Inferior:: Python representation of values. | |
4c374409 JK |
21274 | * Types In Python:: Python representation of types. |
21275 | * Pretty Printing API:: Pretty-printing values. | |
a6bac58e | 21276 | * Selecting Pretty-Printers:: How GDB chooses a pretty-printer. |
7b51bc51 | 21277 | * Writing a Pretty-Printer:: Writing a Pretty-Printer. |
595939de | 21278 | * Inferiors In Python:: Python representation of inferiors (processes) |
505500db | 21279 | * Events In Python:: Listening for events from @value{GDBN}. |
595939de | 21280 | * Threads In Python:: Accessing inferior threads from Python. |
d8906c6f | 21281 | * Commands In Python:: Implementing new commands in Python. |
d7b32ed3 | 21282 | * Parameters In Python:: Adding new @value{GDBN} parameters. |
bc3b79fd | 21283 | * Functions In Python:: Writing new convenience functions. |
fa33c3cd | 21284 | * Progspaces In Python:: Program spaces. |
89c73ade | 21285 | * Objfiles In Python:: Object files. |
f3e9a817 PM |
21286 | * Frames In Python:: Accessing inferior stack frames from Python. |
21287 | * Blocks In Python:: Accessing frame blocks from Python. | |
21288 | * Symbols In Python:: Python representation of symbols. | |
21289 | * Symbol Tables In Python:: Python representation of symbol tables. | |
be759fcf | 21290 | * Lazy Strings In Python:: Python representation of lazy strings. |
adc36818 | 21291 | * Breakpoints In Python:: Manipulating breakpoints using Python. |
d57a3c85 TJB |
21292 | @end menu |
21293 | ||
21294 | @node Basic Python | |
21295 | @subsubsection Basic Python | |
21296 | ||
21297 | @cindex python functions | |
21298 | @cindex python module | |
21299 | @cindex gdb module | |
21300 | @value{GDBN} introduces a new Python module, named @code{gdb}. All | |
21301 | methods and classes added by @value{GDBN} are placed in this module. | |
21302 | @value{GDBN} automatically @code{import}s the @code{gdb} module for | |
21303 | use in all scripts evaluated by the @code{python} command. | |
21304 | ||
9279c692 | 21305 | @findex gdb.PYTHONDIR |
d812018b | 21306 | @defvar gdb.PYTHONDIR |
9279c692 JB |
21307 | A string containing the python directory (@pxref{Python}). |
21308 | @end defvar | |
21309 | ||
d57a3c85 | 21310 | @findex gdb.execute |
d812018b | 21311 | @defun gdb.execute (command @r{[}, from_tty @r{[}, to_string@r{]]}) |
d57a3c85 TJB |
21312 | Evaluate @var{command}, a string, as a @value{GDBN} CLI command. |
21313 | If a GDB exception happens while @var{command} runs, it is | |
21314 | translated as described in @ref{Exception Handling,,Exception Handling}. | |
12453b93 TJB |
21315 | |
21316 | @var{from_tty} specifies whether @value{GDBN} ought to consider this | |
21317 | command as having originated from the user invoking it interactively. | |
21318 | It must be a boolean value. If omitted, it defaults to @code{False}. | |
bc9f0842 TT |
21319 | |
21320 | By default, any output produced by @var{command} is sent to | |
21321 | @value{GDBN}'s standard output. If the @var{to_string} parameter is | |
21322 | @code{True}, then output will be collected by @code{gdb.execute} and | |
21323 | returned as a string. The default is @code{False}, in which case the | |
5da1313b JK |
21324 | return value is @code{None}. If @var{to_string} is @code{True}, the |
21325 | @value{GDBN} virtual terminal will be temporarily set to unlimited width | |
21326 | and height, and its pagination will be disabled; @pxref{Screen Size}. | |
d57a3c85 TJB |
21327 | @end defun |
21328 | ||
adc36818 | 21329 | @findex gdb.breakpoints |
d812018b | 21330 | @defun gdb.breakpoints () |
adc36818 PM |
21331 | Return a sequence holding all of @value{GDBN}'s breakpoints. |
21332 | @xref{Breakpoints In Python}, for more information. | |
21333 | @end defun | |
21334 | ||
8f500870 | 21335 | @findex gdb.parameter |
d812018b | 21336 | @defun gdb.parameter (parameter) |
d57a3c85 TJB |
21337 | Return the value of a @value{GDBN} parameter. @var{parameter} is a |
21338 | string naming the parameter to look up; @var{parameter} may contain | |
21339 | spaces if the parameter has a multi-part name. For example, | |
21340 | @samp{print object} is a valid parameter name. | |
21341 | ||
21342 | If the named parameter does not exist, this function throws a | |
621c8364 TT |
21343 | @code{gdb.error} (@pxref{Exception Handling}). Otherwise, the |
21344 | parameter's value is converted to a Python value of the appropriate | |
21345 | type, and returned. | |
d57a3c85 TJB |
21346 | @end defun |
21347 | ||
08c637de | 21348 | @findex gdb.history |
d812018b | 21349 | @defun gdb.history (number) |
08c637de TJB |
21350 | Return a value from @value{GDBN}'s value history (@pxref{Value |
21351 | History}). @var{number} indicates which history element to return. | |
21352 | If @var{number} is negative, then @value{GDBN} will take its absolute value | |
21353 | and count backward from the last element (i.e., the most recent element) to | |
21354 | find the value to return. If @var{number} is zero, then @value{GDBN} will | |
a0c36267 | 21355 | return the most recent element. If the element specified by @var{number} |
621c8364 | 21356 | doesn't exist in the value history, a @code{gdb.error} exception will be |
08c637de TJB |
21357 | raised. |
21358 | ||
21359 | If no exception is raised, the return value is always an instance of | |
21360 | @code{gdb.Value} (@pxref{Values From Inferior}). | |
21361 | @end defun | |
21362 | ||
57a1d736 | 21363 | @findex gdb.parse_and_eval |
d812018b | 21364 | @defun gdb.parse_and_eval (expression) |
57a1d736 TT |
21365 | Parse @var{expression} as an expression in the current language, |
21366 | evaluate it, and return the result as a @code{gdb.Value}. | |
21367 | @var{expression} must be a string. | |
21368 | ||
21369 | This function can be useful when implementing a new command | |
21370 | (@pxref{Commands In Python}), as it provides a way to parse the | |
21371 | command's argument as an expression. It is also useful simply to | |
21372 | compute values, for example, it is the only way to get the value of a | |
21373 | convenience variable (@pxref{Convenience Vars}) as a @code{gdb.Value}. | |
21374 | @end defun | |
21375 | ||
ca5c20b6 | 21376 | @findex gdb.post_event |
d812018b | 21377 | @defun gdb.post_event (event) |
ca5c20b6 PM |
21378 | Put @var{event}, a callable object taking no arguments, into |
21379 | @value{GDBN}'s internal event queue. This callable will be invoked at | |
21380 | some later point, during @value{GDBN}'s event processing. Events | |
21381 | posted using @code{post_event} will be run in the order in which they | |
21382 | were posted; however, there is no way to know when they will be | |
21383 | processed relative to other events inside @value{GDBN}. | |
21384 | ||
21385 | @value{GDBN} is not thread-safe. If your Python program uses multiple | |
21386 | threads, you must be careful to only call @value{GDBN}-specific | |
21387 | functions in the main @value{GDBN} thread. @code{post_event} ensures | |
21388 | this. For example: | |
21389 | ||
21390 | @smallexample | |
21391 | (@value{GDBP}) python | |
21392 | >import threading | |
21393 | > | |
21394 | >class Writer(): | |
21395 | > def __init__(self, message): | |
21396 | > self.message = message; | |
21397 | > def __call__(self): | |
21398 | > gdb.write(self.message) | |
21399 | > | |
21400 | >class MyThread1 (threading.Thread): | |
21401 | > def run (self): | |
21402 | > gdb.post_event(Writer("Hello ")) | |
21403 | > | |
21404 | >class MyThread2 (threading.Thread): | |
21405 | > def run (self): | |
21406 | > gdb.post_event(Writer("World\n")) | |
21407 | > | |
21408 | >MyThread1().start() | |
21409 | >MyThread2().start() | |
21410 | >end | |
21411 | (@value{GDBP}) Hello World | |
21412 | @end smallexample | |
21413 | @end defun | |
21414 | ||
99c3dc11 | 21415 | @findex gdb.write |
d812018b | 21416 | @defun gdb.write (string @r{[}, stream{]}) |
99c3dc11 PM |
21417 | Print a string to @value{GDBN}'s paginated output stream. The |
21418 | optional @var{stream} determines the stream to print to. The default | |
21419 | stream is @value{GDBN}'s standard output stream. Possible stream | |
21420 | values are: | |
21421 | ||
21422 | @table @code | |
21423 | @findex STDOUT | |
21424 | @findex gdb.STDOUT | |
d812018b | 21425 | @item gdb.STDOUT |
99c3dc11 PM |
21426 | @value{GDBN}'s standard output stream. |
21427 | ||
21428 | @findex STDERR | |
21429 | @findex gdb.STDERR | |
d812018b | 21430 | @item gdb.STDERR |
99c3dc11 PM |
21431 | @value{GDBN}'s standard error stream. |
21432 | ||
21433 | @findex STDLOG | |
21434 | @findex gdb.STDLOG | |
d812018b | 21435 | @item gdb.STDLOG |
99c3dc11 PM |
21436 | @value{GDBN}'s log stream (@pxref{Logging Output}). |
21437 | @end table | |
21438 | ||
d57a3c85 | 21439 | Writing to @code{sys.stdout} or @code{sys.stderr} will automatically |
99c3dc11 PM |
21440 | call this function and will automatically direct the output to the |
21441 | relevant stream. | |
d57a3c85 TJB |
21442 | @end defun |
21443 | ||
21444 | @findex gdb.flush | |
d812018b | 21445 | @defun gdb.flush () |
99c3dc11 PM |
21446 | Flush the buffer of a @value{GDBN} paginated stream so that the |
21447 | contents are displayed immediately. @value{GDBN} will flush the | |
21448 | contents of a stream automatically when it encounters a newline in the | |
21449 | buffer. The optional @var{stream} determines the stream to flush. The | |
21450 | default stream is @value{GDBN}'s standard output stream. Possible | |
21451 | stream values are: | |
21452 | ||
21453 | @table @code | |
21454 | @findex STDOUT | |
21455 | @findex gdb.STDOUT | |
d812018b | 21456 | @item gdb.STDOUT |
99c3dc11 PM |
21457 | @value{GDBN}'s standard output stream. |
21458 | ||
21459 | @findex STDERR | |
21460 | @findex gdb.STDERR | |
d812018b | 21461 | @item gdb.STDERR |
99c3dc11 PM |
21462 | @value{GDBN}'s standard error stream. |
21463 | ||
21464 | @findex STDLOG | |
21465 | @findex gdb.STDLOG | |
d812018b | 21466 | @item gdb.STDLOG |
99c3dc11 PM |
21467 | @value{GDBN}'s log stream (@pxref{Logging Output}). |
21468 | ||
21469 | @end table | |
21470 | ||
21471 | Flushing @code{sys.stdout} or @code{sys.stderr} will automatically | |
21472 | call this function for the relevant stream. | |
d57a3c85 TJB |
21473 | @end defun |
21474 | ||
f870a310 | 21475 | @findex gdb.target_charset |
d812018b | 21476 | @defun gdb.target_charset () |
f870a310 TT |
21477 | Return the name of the current target character set (@pxref{Character |
21478 | Sets}). This differs from @code{gdb.parameter('target-charset')} in | |
21479 | that @samp{auto} is never returned. | |
21480 | @end defun | |
21481 | ||
21482 | @findex gdb.target_wide_charset | |
d812018b | 21483 | @defun gdb.target_wide_charset () |
f870a310 TT |
21484 | Return the name of the current target wide character set |
21485 | (@pxref{Character Sets}). This differs from | |
21486 | @code{gdb.parameter('target-wide-charset')} in that @samp{auto} is | |
21487 | never returned. | |
21488 | @end defun | |
21489 | ||
cb2e07a6 | 21490 | @findex gdb.solib_name |
d812018b | 21491 | @defun gdb.solib_name (address) |
cb2e07a6 PM |
21492 | Return the name of the shared library holding the given @var{address} |
21493 | as a string, or @code{None}. | |
21494 | @end defun | |
21495 | ||
21496 | @findex gdb.decode_line | |
d812018b | 21497 | @defun gdb.decode_line @r{[}expression@r{]} |
cb2e07a6 PM |
21498 | Return locations of the line specified by @var{expression}, or of the |
21499 | current line if no argument was given. This function returns a Python | |
21500 | tuple containing two elements. The first element contains a string | |
21501 | holding any unparsed section of @var{expression} (or @code{None} if | |
21502 | the expression has been fully parsed). The second element contains | |
21503 | either @code{None} or another tuple that contains all the locations | |
21504 | that match the expression represented as @code{gdb.Symtab_and_line} | |
21505 | objects (@pxref{Symbol Tables In Python}). If @var{expression} is | |
21506 | provided, it is decoded the way that @value{GDBN}'s inbuilt | |
21507 | @code{break} or @code{edit} commands do (@pxref{Specify Location}). | |
21508 | @end defun | |
21509 | ||
d812018b | 21510 | @defun gdb.prompt_hook (current_prompt) |
fa3a4f15 PM |
21511 | @anchor{prompt_hook} |
21512 | ||
d17b6f81 PM |
21513 | If @var{prompt_hook} is callable, @value{GDBN} will call the method |
21514 | assigned to this operation before a prompt is displayed by | |
21515 | @value{GDBN}. | |
21516 | ||
21517 | The parameter @code{current_prompt} contains the current @value{GDBN} | |
21518 | prompt. This method must return a Python string, or @code{None}. If | |
21519 | a string is returned, the @value{GDBN} prompt will be set to that | |
21520 | string. If @code{None} is returned, @value{GDBN} will continue to use | |
21521 | the current prompt. | |
21522 | ||
21523 | Some prompts cannot be substituted in @value{GDBN}. Secondary prompts | |
21524 | such as those used by readline for command input, and annotation | |
21525 | related prompts are prohibited from being changed. | |
d812018b | 21526 | @end defun |
d17b6f81 | 21527 | |
d57a3c85 TJB |
21528 | @node Exception Handling |
21529 | @subsubsection Exception Handling | |
21530 | @cindex python exceptions | |
21531 | @cindex exceptions, python | |
21532 | ||
21533 | When executing the @code{python} command, Python exceptions | |
21534 | uncaught within the Python code are translated to calls to | |
21535 | @value{GDBN} error-reporting mechanism. If the command that called | |
21536 | @code{python} does not handle the error, @value{GDBN} will | |
21537 | terminate it and print an error message containing the Python | |
21538 | exception name, the associated value, and the Python call stack | |
21539 | backtrace at the point where the exception was raised. Example: | |
21540 | ||
21541 | @smallexample | |
21542 | (@value{GDBP}) python print foo | |
21543 | Traceback (most recent call last): | |
21544 | File "<string>", line 1, in <module> | |
21545 | NameError: name 'foo' is not defined | |
21546 | @end smallexample | |
21547 | ||
621c8364 TT |
21548 | @value{GDBN} errors that happen in @value{GDBN} commands invoked by |
21549 | Python code are converted to Python exceptions. The type of the | |
21550 | Python exception depends on the error. | |
21551 | ||
21552 | @ftable @code | |
21553 | @item gdb.error | |
21554 | This is the base class for most exceptions generated by @value{GDBN}. | |
21555 | It is derived from @code{RuntimeError}, for compatibility with earlier | |
21556 | versions of @value{GDBN}. | |
21557 | ||
21558 | If an error occurring in @value{GDBN} does not fit into some more | |
21559 | specific category, then the generated exception will have this type. | |
21560 | ||
21561 | @item gdb.MemoryError | |
21562 | This is a subclass of @code{gdb.error} which is thrown when an | |
21563 | operation tried to access invalid memory in the inferior. | |
21564 | ||
21565 | @item KeyboardInterrupt | |
21566 | User interrupt (via @kbd{C-c} or by typing @kbd{q} at a pagination | |
21567 | prompt) is translated to a Python @code{KeyboardInterrupt} exception. | |
21568 | @end ftable | |
21569 | ||
21570 | In all cases, your exception handler will see the @value{GDBN} error | |
21571 | message as its value and the Python call stack backtrace at the Python | |
21572 | statement closest to where the @value{GDBN} error occured as the | |
d57a3c85 TJB |
21573 | traceback. |
21574 | ||
07ca107c DE |
21575 | @findex gdb.GdbError |
21576 | When implementing @value{GDBN} commands in Python via @code{gdb.Command}, | |
21577 | it is useful to be able to throw an exception that doesn't cause a | |
21578 | traceback to be printed. For example, the user may have invoked the | |
21579 | command incorrectly. Use the @code{gdb.GdbError} exception | |
21580 | to handle this case. Example: | |
21581 | ||
21582 | @smallexample | |
21583 | (gdb) python | |
21584 | >class HelloWorld (gdb.Command): | |
21585 | > """Greet the whole world.""" | |
21586 | > def __init__ (self): | |
21587 | > super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_OBSCURE) | |
21588 | > def invoke (self, args, from_tty): | |
21589 | > argv = gdb.string_to_argv (args) | |
21590 | > if len (argv) != 0: | |
21591 | > raise gdb.GdbError ("hello-world takes no arguments") | |
21592 | > print "Hello, World!" | |
21593 | >HelloWorld () | |
21594 | >end | |
21595 | (gdb) hello-world 42 | |
21596 | hello-world takes no arguments | |
21597 | @end smallexample | |
21598 | ||
a08702d6 TJB |
21599 | @node Values From Inferior |
21600 | @subsubsection Values From Inferior | |
21601 | @cindex values from inferior, with Python | |
21602 | @cindex python, working with values from inferior | |
21603 | ||
21604 | @cindex @code{gdb.Value} | |
21605 | @value{GDBN} provides values it obtains from the inferior program in | |
21606 | an object of type @code{gdb.Value}. @value{GDBN} uses this object | |
21607 | for its internal bookkeeping of the inferior's values, and for | |
21608 | fetching values when necessary. | |
21609 | ||
21610 | Inferior values that are simple scalars can be used directly in | |
21611 | Python expressions that are valid for the value's data type. Here's | |
21612 | an example for an integer or floating-point value @code{some_val}: | |
21613 | ||
21614 | @smallexample | |
21615 | bar = some_val + 2 | |
21616 | @end smallexample | |
21617 | ||
21618 | @noindent | |
21619 | As result of this, @code{bar} will also be a @code{gdb.Value} object | |
21620 | whose values are of the same type as those of @code{some_val}. | |
21621 | ||
21622 | Inferior values that are structures or instances of some class can | |
21623 | be accessed using the Python @dfn{dictionary syntax}. For example, if | |
21624 | @code{some_val} is a @code{gdb.Value} instance holding a structure, you | |
21625 | can access its @code{foo} element with: | |
21626 | ||
21627 | @smallexample | |
21628 | bar = some_val['foo'] | |
21629 | @end smallexample | |
21630 | ||
21631 | Again, @code{bar} will also be a @code{gdb.Value} object. | |
21632 | ||
5374244e PM |
21633 | A @code{gdb.Value} that represents a function can be executed via |
21634 | inferior function call. Any arguments provided to the call must match | |
21635 | the function's prototype, and must be provided in the order specified | |
21636 | by that prototype. | |
21637 | ||
21638 | For example, @code{some_val} is a @code{gdb.Value} instance | |
21639 | representing a function that takes two integers as arguments. To | |
21640 | execute this function, call it like so: | |
21641 | ||
21642 | @smallexample | |
21643 | result = some_val (10,20) | |
21644 | @end smallexample | |
21645 | ||
21646 | Any values returned from a function call will be stored as a | |
21647 | @code{gdb.Value}. | |
21648 | ||
c0c6f777 | 21649 | The following attributes are provided: |
a08702d6 | 21650 | |
def2b000 | 21651 | @table @code |
d812018b | 21652 | @defvar Value.address |
c0c6f777 TJB |
21653 | If this object is addressable, this read-only attribute holds a |
21654 | @code{gdb.Value} object representing the address. Otherwise, | |
21655 | this attribute holds @code{None}. | |
d812018b | 21656 | @end defvar |
c0c6f777 | 21657 | |
def2b000 | 21658 | @cindex optimized out value in Python |
d812018b | 21659 | @defvar Value.is_optimized_out |
def2b000 TJB |
21660 | This read-only boolean attribute is true if the compiler optimized out |
21661 | this value, thus it is not available for fetching from the inferior. | |
d812018b | 21662 | @end defvar |
2c74e833 | 21663 | |
d812018b | 21664 | @defvar Value.type |
2c74e833 | 21665 | The type of this @code{gdb.Value}. The value of this attribute is a |
44592cc4 | 21666 | @code{gdb.Type} object (@pxref{Types In Python}). |
d812018b | 21667 | @end defvar |
03f17ccf | 21668 | |
d812018b | 21669 | @defvar Value.dynamic_type |
03f17ccf | 21670 | The dynamic type of this @code{gdb.Value}. This uses C@t{++} run-time |
fccd1d1e EZ |
21671 | type information (@acronym{RTTI}) to determine the dynamic type of the |
21672 | value. If this value is of class type, it will return the class in | |
21673 | which the value is embedded, if any. If this value is of pointer or | |
21674 | reference to a class type, it will compute the dynamic type of the | |
21675 | referenced object, and return a pointer or reference to that type, | |
21676 | respectively. In all other cases, it will return the value's static | |
21677 | type. | |
21678 | ||
21679 | Note that this feature will only work when debugging a C@t{++} program | |
21680 | that includes @acronym{RTTI} for the object in question. Otherwise, | |
21681 | it will just return the static type of the value as in @kbd{ptype foo} | |
21682 | (@pxref{Symbols, ptype}). | |
d812018b | 21683 | @end defvar |
22dbab46 PK |
21684 | |
21685 | @defvar Value.is_lazy | |
21686 | The value of this read-only boolean attribute is @code{True} if this | |
21687 | @code{gdb.Value} has not yet been fetched from the inferior. | |
21688 | @value{GDBN} does not fetch values until necessary, for efficiency. | |
21689 | For example: | |
21690 | ||
21691 | @smallexample | |
21692 | myval = gdb.parse_and_eval ('somevar') | |
21693 | @end smallexample | |
21694 | ||
21695 | The value of @code{somevar} is not fetched at this time. It will be | |
21696 | fetched when the value is needed, or when the @code{fetch_lazy} | |
21697 | method is invoked. | |
21698 | @end defvar | |
def2b000 TJB |
21699 | @end table |
21700 | ||
21701 | The following methods are provided: | |
21702 | ||
21703 | @table @code | |
d812018b | 21704 | @defun Value.__init__ (@var{val}) |
e8467610 TT |
21705 | Many Python values can be converted directly to a @code{gdb.Value} via |
21706 | this object initializer. Specifically: | |
21707 | ||
21708 | @table @asis | |
21709 | @item Python boolean | |
21710 | A Python boolean is converted to the boolean type from the current | |
21711 | language. | |
21712 | ||
21713 | @item Python integer | |
21714 | A Python integer is converted to the C @code{long} type for the | |
21715 | current architecture. | |
21716 | ||
21717 | @item Python long | |
21718 | A Python long is converted to the C @code{long long} type for the | |
21719 | current architecture. | |
21720 | ||
21721 | @item Python float | |
21722 | A Python float is converted to the C @code{double} type for the | |
21723 | current architecture. | |
21724 | ||
21725 | @item Python string | |
21726 | A Python string is converted to a target string, using the current | |
21727 | target encoding. | |
21728 | ||
21729 | @item @code{gdb.Value} | |
21730 | If @code{val} is a @code{gdb.Value}, then a copy of the value is made. | |
21731 | ||
21732 | @item @code{gdb.LazyString} | |
21733 | If @code{val} is a @code{gdb.LazyString} (@pxref{Lazy Strings In | |
21734 | Python}), then the lazy string's @code{value} method is called, and | |
21735 | its result is used. | |
21736 | @end table | |
d812018b | 21737 | @end defun |
e8467610 | 21738 | |
d812018b | 21739 | @defun Value.cast (type) |
14ff2235 PM |
21740 | Return a new instance of @code{gdb.Value} that is the result of |
21741 | casting this instance to the type described by @var{type}, which must | |
21742 | be a @code{gdb.Type} object. If the cast cannot be performed for some | |
21743 | reason, this method throws an exception. | |
d812018b | 21744 | @end defun |
14ff2235 | 21745 | |
d812018b | 21746 | @defun Value.dereference () |
def2b000 TJB |
21747 | For pointer data types, this method returns a new @code{gdb.Value} object |
21748 | whose contents is the object pointed to by the pointer. For example, if | |
21749 | @code{foo} is a C pointer to an @code{int}, declared in your C program as | |
a08702d6 TJB |
21750 | |
21751 | @smallexample | |
21752 | int *foo; | |
21753 | @end smallexample | |
21754 | ||
21755 | @noindent | |
21756 | then you can use the corresponding @code{gdb.Value} to access what | |
21757 | @code{foo} points to like this: | |
21758 | ||
21759 | @smallexample | |
21760 | bar = foo.dereference () | |
21761 | @end smallexample | |
21762 | ||
21763 | The result @code{bar} will be a @code{gdb.Value} object holding the | |
21764 | value pointed to by @code{foo}. | |
d812018b | 21765 | @end defun |
a08702d6 | 21766 | |
d812018b | 21767 | @defun Value.dynamic_cast (type) |
f9ffd4bb TT |
21768 | Like @code{Value.cast}, but works as if the C@t{++} @code{dynamic_cast} |
21769 | operator were used. Consult a C@t{++} reference for details. | |
d812018b | 21770 | @end defun |
f9ffd4bb | 21771 | |
d812018b | 21772 | @defun Value.reinterpret_cast (type) |
f9ffd4bb TT |
21773 | Like @code{Value.cast}, but works as if the C@t{++} @code{reinterpret_cast} |
21774 | operator were used. Consult a C@t{++} reference for details. | |
d812018b | 21775 | @end defun |
f9ffd4bb | 21776 | |
d812018b | 21777 | @defun Value.string (@r{[}encoding@r{[}, errors@r{[}, length@r{]]]}) |
b6cb8e7d TJB |
21778 | If this @code{gdb.Value} represents a string, then this method |
21779 | converts the contents to a Python string. Otherwise, this method will | |
21780 | throw an exception. | |
21781 | ||
21782 | Strings are recognized in a language-specific way; whether a given | |
21783 | @code{gdb.Value} represents a string is determined by the current | |
21784 | language. | |
21785 | ||
21786 | For C-like languages, a value is a string if it is a pointer to or an | |
21787 | array of characters or ints. The string is assumed to be terminated | |
fbb8f299 PM |
21788 | by a zero of the appropriate width. However if the optional length |
21789 | argument is given, the string will be converted to that given length, | |
21790 | ignoring any embedded zeros that the string may contain. | |
b6cb8e7d TJB |
21791 | |
21792 | If the optional @var{encoding} argument is given, it must be a string | |
21793 | naming the encoding of the string in the @code{gdb.Value}, such as | |
21794 | @code{"ascii"}, @code{"iso-8859-6"} or @code{"utf-8"}. It accepts | |
21795 | the same encodings as the corresponding argument to Python's | |
21796 | @code{string.decode} method, and the Python codec machinery will be used | |
21797 | to convert the string. If @var{encoding} is not given, or if | |
21798 | @var{encoding} is the empty string, then either the @code{target-charset} | |
21799 | (@pxref{Character Sets}) will be used, or a language-specific encoding | |
21800 | will be used, if the current language is able to supply one. | |
21801 | ||
21802 | The optional @var{errors} argument is the same as the corresponding | |
21803 | argument to Python's @code{string.decode} method. | |
fbb8f299 PM |
21804 | |
21805 | If the optional @var{length} argument is given, the string will be | |
21806 | fetched and converted to the given length. | |
d812018b | 21807 | @end defun |
be759fcf | 21808 | |
d812018b | 21809 | @defun Value.lazy_string (@r{[}encoding @r{[}, length@r{]]}) |
be759fcf PM |
21810 | If this @code{gdb.Value} represents a string, then this method |
21811 | converts the contents to a @code{gdb.LazyString} (@pxref{Lazy Strings | |
21812 | In Python}). Otherwise, this method will throw an exception. | |
21813 | ||
21814 | If the optional @var{encoding} argument is given, it must be a string | |
21815 | naming the encoding of the @code{gdb.LazyString}. Some examples are: | |
21816 | @samp{ascii}, @samp{iso-8859-6} or @samp{utf-8}. If the | |
21817 | @var{encoding} argument is an encoding that @value{GDBN} does | |
21818 | recognize, @value{GDBN} will raise an error. | |
21819 | ||
21820 | When a lazy string is printed, the @value{GDBN} encoding machinery is | |
21821 | used to convert the string during printing. If the optional | |
21822 | @var{encoding} argument is not provided, or is an empty string, | |
21823 | @value{GDBN} will automatically select the encoding most suitable for | |
21824 | the string type. For further information on encoding in @value{GDBN} | |
21825 | please see @ref{Character Sets}. | |
21826 | ||
21827 | If the optional @var{length} argument is given, the string will be | |
21828 | fetched and encoded to the length of characters specified. If | |
21829 | the @var{length} argument is not provided, the string will be fetched | |
21830 | and encoded until a null of appropriate width is found. | |
d812018b | 21831 | @end defun |
22dbab46 PK |
21832 | |
21833 | @defun Value.fetch_lazy () | |
21834 | If the @code{gdb.Value} object is currently a lazy value | |
21835 | (@code{gdb.Value.is_lazy} is @code{True}), then the value is | |
21836 | fetched from the inferior. Any errors that occur in the process | |
21837 | will produce a Python exception. | |
21838 | ||
21839 | If the @code{gdb.Value} object is not a lazy value, this method | |
21840 | has no effect. | |
21841 | ||
21842 | This method does not return a value. | |
21843 | @end defun | |
21844 | ||
def2b000 | 21845 | @end table |
b6cb8e7d | 21846 | |
2c74e833 TT |
21847 | @node Types In Python |
21848 | @subsubsection Types In Python | |
21849 | @cindex types in Python | |
21850 | @cindex Python, working with types | |
21851 | ||
21852 | @tindex gdb.Type | |
21853 | @value{GDBN} represents types from the inferior using the class | |
21854 | @code{gdb.Type}. | |
21855 | ||
21856 | The following type-related functions are available in the @code{gdb} | |
21857 | module: | |
21858 | ||
21859 | @findex gdb.lookup_type | |
d812018b | 21860 | @defun gdb.lookup_type (name @r{[}, block@r{]}) |
2c74e833 TT |
21861 | This function looks up a type by name. @var{name} is the name of the |
21862 | type to look up. It must be a string. | |
21863 | ||
5107b149 PM |
21864 | If @var{block} is given, then @var{name} is looked up in that scope. |
21865 | Otherwise, it is searched for globally. | |
21866 | ||
2c74e833 TT |
21867 | Ordinarily, this function will return an instance of @code{gdb.Type}. |
21868 | If the named type cannot be found, it will throw an exception. | |
21869 | @end defun | |
21870 | ||
a73bb892 PK |
21871 | If the type is a structure or class type, or an enum type, the fields |
21872 | of that type can be accessed using the Python @dfn{dictionary syntax}. | |
21873 | For example, if @code{some_type} is a @code{gdb.Type} instance holding | |
21874 | a structure type, you can access its @code{foo} field with: | |
21875 | ||
21876 | @smallexample | |
21877 | bar = some_type['foo'] | |
21878 | @end smallexample | |
21879 | ||
21880 | @code{bar} will be a @code{gdb.Field} object; see below under the | |
21881 | description of the @code{Type.fields} method for a description of the | |
21882 | @code{gdb.Field} class. | |
21883 | ||
2c74e833 TT |
21884 | An instance of @code{Type} has the following attributes: |
21885 | ||
21886 | @table @code | |
d812018b | 21887 | @defvar Type.code |
2c74e833 TT |
21888 | The type code for this type. The type code will be one of the |
21889 | @code{TYPE_CODE_} constants defined below. | |
d812018b | 21890 | @end defvar |
2c74e833 | 21891 | |
d812018b | 21892 | @defvar Type.sizeof |
2c74e833 TT |
21893 | The size of this type, in target @code{char} units. Usually, a |
21894 | target's @code{char} type will be an 8-bit byte. However, on some | |
21895 | unusual platforms, this type may have a different size. | |
d812018b | 21896 | @end defvar |
2c74e833 | 21897 | |
d812018b | 21898 | @defvar Type.tag |
2c74e833 TT |
21899 | The tag name for this type. The tag name is the name after |
21900 | @code{struct}, @code{union}, or @code{enum} in C and C@t{++}; not all | |
21901 | languages have this concept. If this type has no tag name, then | |
21902 | @code{None} is returned. | |
d812018b | 21903 | @end defvar |
2c74e833 TT |
21904 | @end table |
21905 | ||
21906 | The following methods are provided: | |
21907 | ||
21908 | @table @code | |
d812018b | 21909 | @defun Type.fields () |
2c74e833 TT |
21910 | For structure and union types, this method returns the fields. Range |
21911 | types have two fields, the minimum and maximum values. Enum types | |
21912 | have one field per enum constant. Function and method types have one | |
21913 | field per parameter. The base types of C@t{++} classes are also | |
21914 | represented as fields. If the type has no fields, or does not fit | |
21915 | into one of these categories, an empty sequence will be returned. | |
21916 | ||
a73bb892 | 21917 | Each field is a @code{gdb.Field} object, with some pre-defined attributes: |
2c74e833 TT |
21918 | @table @code |
21919 | @item bitpos | |
21920 | This attribute is not available for @code{static} fields (as in | |
21921 | C@t{++} or Java). For non-@code{static} fields, the value is the bit | |
a9f54f60 TT |
21922 | position of the field. For @code{enum} fields, the value is the |
21923 | enumeration member's integer representation. | |
2c74e833 TT |
21924 | |
21925 | @item name | |
21926 | The name of the field, or @code{None} for anonymous fields. | |
21927 | ||
21928 | @item artificial | |
21929 | This is @code{True} if the field is artificial, usually meaning that | |
21930 | it was provided by the compiler and not the user. This attribute is | |
21931 | always provided, and is @code{False} if the field is not artificial. | |
21932 | ||
bfd31e71 PM |
21933 | @item is_base_class |
21934 | This is @code{True} if the field represents a base class of a C@t{++} | |
21935 | structure. This attribute is always provided, and is @code{False} | |
21936 | if the field is not a base class of the type that is the argument of | |
21937 | @code{fields}, or if that type was not a C@t{++} class. | |
21938 | ||
2c74e833 TT |
21939 | @item bitsize |
21940 | If the field is packed, or is a bitfield, then this will have a | |
21941 | non-zero value, which is the size of the field in bits. Otherwise, | |
21942 | this will be zero; in this case the field's size is given by its type. | |
21943 | ||
21944 | @item type | |
21945 | The type of the field. This is usually an instance of @code{Type}, | |
21946 | but it can be @code{None} in some situations. | |
21947 | @end table | |
d812018b | 21948 | @end defun |
2c74e833 | 21949 | |
d812018b | 21950 | @defun Type.array (@var{n1} @r{[}, @var{n2}@r{]}) |
702c2711 TT |
21951 | Return a new @code{gdb.Type} object which represents an array of this |
21952 | type. If one argument is given, it is the inclusive upper bound of | |
21953 | the array; in this case the lower bound is zero. If two arguments are | |
21954 | given, the first argument is the lower bound of the array, and the | |
21955 | second argument is the upper bound of the array. An array's length | |
21956 | must not be negative, but the bounds can be. | |
d812018b | 21957 | @end defun |
702c2711 | 21958 | |
d812018b | 21959 | @defun Type.const () |
2c74e833 TT |
21960 | Return a new @code{gdb.Type} object which represents a |
21961 | @code{const}-qualified variant of this type. | |
d812018b | 21962 | @end defun |
2c74e833 | 21963 | |
d812018b | 21964 | @defun Type.volatile () |
2c74e833 TT |
21965 | Return a new @code{gdb.Type} object which represents a |
21966 | @code{volatile}-qualified variant of this type. | |
d812018b | 21967 | @end defun |
2c74e833 | 21968 | |
d812018b | 21969 | @defun Type.unqualified () |
2c74e833 TT |
21970 | Return a new @code{gdb.Type} object which represents an unqualified |
21971 | variant of this type. That is, the result is neither @code{const} nor | |
21972 | @code{volatile}. | |
d812018b | 21973 | @end defun |
2c74e833 | 21974 | |
d812018b | 21975 | @defun Type.range () |
361ae042 PM |
21976 | Return a Python @code{Tuple} object that contains two elements: the |
21977 | low bound of the argument type and the high bound of that type. If | |
21978 | the type does not have a range, @value{GDBN} will raise a | |
621c8364 | 21979 | @code{gdb.error} exception (@pxref{Exception Handling}). |
d812018b | 21980 | @end defun |
361ae042 | 21981 | |
d812018b | 21982 | @defun Type.reference () |
2c74e833 TT |
21983 | Return a new @code{gdb.Type} object which represents a reference to this |
21984 | type. | |
d812018b | 21985 | @end defun |
2c74e833 | 21986 | |
d812018b | 21987 | @defun Type.pointer () |
7a6973ad TT |
21988 | Return a new @code{gdb.Type} object which represents a pointer to this |
21989 | type. | |
d812018b | 21990 | @end defun |
7a6973ad | 21991 | |
d812018b | 21992 | @defun Type.strip_typedefs () |
2c74e833 TT |
21993 | Return a new @code{gdb.Type} that represents the real type, |
21994 | after removing all layers of typedefs. | |
d812018b | 21995 | @end defun |
2c74e833 | 21996 | |
d812018b | 21997 | @defun Type.target () |
2c74e833 TT |
21998 | Return a new @code{gdb.Type} object which represents the target type |
21999 | of this type. | |
22000 | ||
22001 | For a pointer type, the target type is the type of the pointed-to | |
22002 | object. For an array type (meaning C-like arrays), the target type is | |
22003 | the type of the elements of the array. For a function or method type, | |
22004 | the target type is the type of the return value. For a complex type, | |
22005 | the target type is the type of the elements. For a typedef, the | |
22006 | target type is the aliased type. | |
22007 | ||
22008 | If the type does not have a target, this method will throw an | |
22009 | exception. | |
d812018b | 22010 | @end defun |
2c74e833 | 22011 | |
d812018b | 22012 | @defun Type.template_argument (n @r{[}, block@r{]}) |
2c74e833 TT |
22013 | If this @code{gdb.Type} is an instantiation of a template, this will |
22014 | return a new @code{gdb.Type} which represents the type of the | |
22015 | @var{n}th template argument. | |
22016 | ||
22017 | If this @code{gdb.Type} is not a template type, this will throw an | |
22018 | exception. Ordinarily, only C@t{++} code will have template types. | |
22019 | ||
5107b149 PM |
22020 | If @var{block} is given, then @var{name} is looked up in that scope. |
22021 | Otherwise, it is searched for globally. | |
d812018b | 22022 | @end defun |
2c74e833 TT |
22023 | @end table |
22024 | ||
22025 | ||
22026 | Each type has a code, which indicates what category this type falls | |
22027 | into. The available type categories are represented by constants | |
22028 | defined in the @code{gdb} module: | |
22029 | ||
22030 | @table @code | |
22031 | @findex TYPE_CODE_PTR | |
22032 | @findex gdb.TYPE_CODE_PTR | |
d812018b | 22033 | @item gdb.TYPE_CODE_PTR |
2c74e833 TT |
22034 | The type is a pointer. |
22035 | ||
22036 | @findex TYPE_CODE_ARRAY | |
22037 | @findex gdb.TYPE_CODE_ARRAY | |
d812018b | 22038 | @item gdb.TYPE_CODE_ARRAY |
2c74e833 TT |
22039 | The type is an array. |
22040 | ||
22041 | @findex TYPE_CODE_STRUCT | |
22042 | @findex gdb.TYPE_CODE_STRUCT | |
d812018b | 22043 | @item gdb.TYPE_CODE_STRUCT |
2c74e833 TT |
22044 | The type is a structure. |
22045 | ||
22046 | @findex TYPE_CODE_UNION | |
22047 | @findex gdb.TYPE_CODE_UNION | |
d812018b | 22048 | @item gdb.TYPE_CODE_UNION |
2c74e833 TT |
22049 | The type is a union. |
22050 | ||
22051 | @findex TYPE_CODE_ENUM | |
22052 | @findex gdb.TYPE_CODE_ENUM | |
d812018b | 22053 | @item gdb.TYPE_CODE_ENUM |
2c74e833 TT |
22054 | The type is an enum. |
22055 | ||
22056 | @findex TYPE_CODE_FLAGS | |
22057 | @findex gdb.TYPE_CODE_FLAGS | |
d812018b | 22058 | @item gdb.TYPE_CODE_FLAGS |
2c74e833 TT |
22059 | A bit flags type, used for things such as status registers. |
22060 | ||
22061 | @findex TYPE_CODE_FUNC | |
22062 | @findex gdb.TYPE_CODE_FUNC | |
d812018b | 22063 | @item gdb.TYPE_CODE_FUNC |
2c74e833 TT |
22064 | The type is a function. |
22065 | ||
22066 | @findex TYPE_CODE_INT | |
22067 | @findex gdb.TYPE_CODE_INT | |
d812018b | 22068 | @item gdb.TYPE_CODE_INT |
2c74e833 TT |
22069 | The type is an integer type. |
22070 | ||
22071 | @findex TYPE_CODE_FLT | |
22072 | @findex gdb.TYPE_CODE_FLT | |
d812018b | 22073 | @item gdb.TYPE_CODE_FLT |
2c74e833 TT |
22074 | A floating point type. |
22075 | ||
22076 | @findex TYPE_CODE_VOID | |
22077 | @findex gdb.TYPE_CODE_VOID | |
d812018b | 22078 | @item gdb.TYPE_CODE_VOID |
2c74e833 TT |
22079 | The special type @code{void}. |
22080 | ||
22081 | @findex TYPE_CODE_SET | |
22082 | @findex gdb.TYPE_CODE_SET | |
d812018b | 22083 | @item gdb.TYPE_CODE_SET |
2c74e833 TT |
22084 | A Pascal set type. |
22085 | ||
22086 | @findex TYPE_CODE_RANGE | |
22087 | @findex gdb.TYPE_CODE_RANGE | |
d812018b | 22088 | @item gdb.TYPE_CODE_RANGE |
2c74e833 TT |
22089 | A range type, that is, an integer type with bounds. |
22090 | ||
22091 | @findex TYPE_CODE_STRING | |
22092 | @findex gdb.TYPE_CODE_STRING | |
d812018b | 22093 | @item gdb.TYPE_CODE_STRING |
2c74e833 TT |
22094 | A string type. Note that this is only used for certain languages with |
22095 | language-defined string types; C strings are not represented this way. | |
22096 | ||
22097 | @findex TYPE_CODE_BITSTRING | |
22098 | @findex gdb.TYPE_CODE_BITSTRING | |
d812018b | 22099 | @item gdb.TYPE_CODE_BITSTRING |
2c74e833 TT |
22100 | A string of bits. |
22101 | ||
22102 | @findex TYPE_CODE_ERROR | |
22103 | @findex gdb.TYPE_CODE_ERROR | |
d812018b | 22104 | @item gdb.TYPE_CODE_ERROR |
2c74e833 TT |
22105 | An unknown or erroneous type. |
22106 | ||
22107 | @findex TYPE_CODE_METHOD | |
22108 | @findex gdb.TYPE_CODE_METHOD | |
d812018b | 22109 | @item gdb.TYPE_CODE_METHOD |
2c74e833 TT |
22110 | A method type, as found in C@t{++} or Java. |
22111 | ||
22112 | @findex TYPE_CODE_METHODPTR | |
22113 | @findex gdb.TYPE_CODE_METHODPTR | |
d812018b | 22114 | @item gdb.TYPE_CODE_METHODPTR |
2c74e833 TT |
22115 | A pointer-to-member-function. |
22116 | ||
22117 | @findex TYPE_CODE_MEMBERPTR | |
22118 | @findex gdb.TYPE_CODE_MEMBERPTR | |
d812018b | 22119 | @item gdb.TYPE_CODE_MEMBERPTR |
2c74e833 TT |
22120 | A pointer-to-member. |
22121 | ||
22122 | @findex TYPE_CODE_REF | |
22123 | @findex gdb.TYPE_CODE_REF | |
d812018b | 22124 | @item gdb.TYPE_CODE_REF |
2c74e833 TT |
22125 | A reference type. |
22126 | ||
22127 | @findex TYPE_CODE_CHAR | |
22128 | @findex gdb.TYPE_CODE_CHAR | |
d812018b | 22129 | @item gdb.TYPE_CODE_CHAR |
2c74e833 TT |
22130 | A character type. |
22131 | ||
22132 | @findex TYPE_CODE_BOOL | |
22133 | @findex gdb.TYPE_CODE_BOOL | |
d812018b | 22134 | @item gdb.TYPE_CODE_BOOL |
2c74e833 TT |
22135 | A boolean type. |
22136 | ||
22137 | @findex TYPE_CODE_COMPLEX | |
22138 | @findex gdb.TYPE_CODE_COMPLEX | |
d812018b | 22139 | @item gdb.TYPE_CODE_COMPLEX |
2c74e833 TT |
22140 | A complex float type. |
22141 | ||
22142 | @findex TYPE_CODE_TYPEDEF | |
22143 | @findex gdb.TYPE_CODE_TYPEDEF | |
d812018b | 22144 | @item gdb.TYPE_CODE_TYPEDEF |
2c74e833 TT |
22145 | A typedef to some other type. |
22146 | ||
22147 | @findex TYPE_CODE_NAMESPACE | |
22148 | @findex gdb.TYPE_CODE_NAMESPACE | |
d812018b | 22149 | @item gdb.TYPE_CODE_NAMESPACE |
2c74e833 TT |
22150 | A C@t{++} namespace. |
22151 | ||
22152 | @findex TYPE_CODE_DECFLOAT | |
22153 | @findex gdb.TYPE_CODE_DECFLOAT | |
d812018b | 22154 | @item gdb.TYPE_CODE_DECFLOAT |
2c74e833 TT |
22155 | A decimal floating point type. |
22156 | ||
22157 | @findex TYPE_CODE_INTERNAL_FUNCTION | |
22158 | @findex gdb.TYPE_CODE_INTERNAL_FUNCTION | |
d812018b | 22159 | @item gdb.TYPE_CODE_INTERNAL_FUNCTION |
2c74e833 TT |
22160 | A function internal to @value{GDBN}. This is the type used to represent |
22161 | convenience functions. | |
22162 | @end table | |
22163 | ||
0e3509db DE |
22164 | Further support for types is provided in the @code{gdb.types} |
22165 | Python module (@pxref{gdb.types}). | |
22166 | ||
4c374409 JK |
22167 | @node Pretty Printing API |
22168 | @subsubsection Pretty Printing API | |
a6bac58e | 22169 | |
4c374409 | 22170 | An example output is provided (@pxref{Pretty Printing}). |
a6bac58e TT |
22171 | |
22172 | A pretty-printer is just an object that holds a value and implements a | |
22173 | specific interface, defined here. | |
22174 | ||
d812018b | 22175 | @defun pretty_printer.children (self) |
a6bac58e TT |
22176 | @value{GDBN} will call this method on a pretty-printer to compute the |
22177 | children of the pretty-printer's value. | |
22178 | ||
22179 | This method must return an object conforming to the Python iterator | |
22180 | protocol. Each item returned by the iterator must be a tuple holding | |
22181 | two elements. The first element is the ``name'' of the child; the | |
22182 | second element is the child's value. The value can be any Python | |
22183 | object which is convertible to a @value{GDBN} value. | |
22184 | ||
22185 | This method is optional. If it does not exist, @value{GDBN} will act | |
22186 | as though the value has no children. | |
d812018b | 22187 | @end defun |
a6bac58e | 22188 | |
d812018b | 22189 | @defun pretty_printer.display_hint (self) |
a6bac58e TT |
22190 | The CLI may call this method and use its result to change the |
22191 | formatting of a value. The result will also be supplied to an MI | |
22192 | consumer as a @samp{displayhint} attribute of the variable being | |
22193 | printed. | |
22194 | ||
22195 | This method is optional. If it does exist, this method must return a | |
22196 | string. | |
22197 | ||
22198 | Some display hints are predefined by @value{GDBN}: | |
22199 | ||
22200 | @table @samp | |
22201 | @item array | |
22202 | Indicate that the object being printed is ``array-like''. The CLI | |
22203 | uses this to respect parameters such as @code{set print elements} and | |
22204 | @code{set print array}. | |
22205 | ||
22206 | @item map | |
22207 | Indicate that the object being printed is ``map-like'', and that the | |
22208 | children of this value can be assumed to alternate between keys and | |
22209 | values. | |
22210 | ||
22211 | @item string | |
22212 | Indicate that the object being printed is ``string-like''. If the | |
22213 | printer's @code{to_string} method returns a Python string of some | |
22214 | kind, then @value{GDBN} will call its internal language-specific | |
22215 | string-printing function to format the string. For the CLI this means | |
22216 | adding quotation marks, possibly escaping some characters, respecting | |
22217 | @code{set print elements}, and the like. | |
22218 | @end table | |
d812018b | 22219 | @end defun |
a6bac58e | 22220 | |
d812018b | 22221 | @defun pretty_printer.to_string (self) |
a6bac58e TT |
22222 | @value{GDBN} will call this method to display the string |
22223 | representation of the value passed to the object's constructor. | |
22224 | ||
22225 | When printing from the CLI, if the @code{to_string} method exists, | |
22226 | then @value{GDBN} will prepend its result to the values returned by | |
22227 | @code{children}. Exactly how this formatting is done is dependent on | |
22228 | the display hint, and may change as more hints are added. Also, | |
22229 | depending on the print settings (@pxref{Print Settings}), the CLI may | |
22230 | print just the result of @code{to_string} in a stack trace, omitting | |
22231 | the result of @code{children}. | |
22232 | ||
22233 | If this method returns a string, it is printed verbatim. | |
22234 | ||
22235 | Otherwise, if this method returns an instance of @code{gdb.Value}, | |
22236 | then @value{GDBN} prints this value. This may result in a call to | |
22237 | another pretty-printer. | |
22238 | ||
22239 | If instead the method returns a Python value which is convertible to a | |
22240 | @code{gdb.Value}, then @value{GDBN} performs the conversion and prints | |
22241 | the resulting value. Again, this may result in a call to another | |
22242 | pretty-printer. Python scalars (integers, floats, and booleans) and | |
22243 | strings are convertible to @code{gdb.Value}; other types are not. | |
22244 | ||
79f283fe PM |
22245 | Finally, if this method returns @code{None} then no further operations |
22246 | are peformed in this method and nothing is printed. | |
22247 | ||
a6bac58e | 22248 | If the result is not one of these types, an exception is raised. |
d812018b | 22249 | @end defun |
a6bac58e | 22250 | |
464b3efb TT |
22251 | @value{GDBN} provides a function which can be used to look up the |
22252 | default pretty-printer for a @code{gdb.Value}: | |
22253 | ||
22254 | @findex gdb.default_visualizer | |
d812018b | 22255 | @defun gdb.default_visualizer (value) |
464b3efb TT |
22256 | This function takes a @code{gdb.Value} object as an argument. If a |
22257 | pretty-printer for this value exists, then it is returned. If no such | |
22258 | printer exists, then this returns @code{None}. | |
22259 | @end defun | |
22260 | ||
a6bac58e TT |
22261 | @node Selecting Pretty-Printers |
22262 | @subsubsection Selecting Pretty-Printers | |
22263 | ||
22264 | The Python list @code{gdb.pretty_printers} contains an array of | |
967cf477 | 22265 | functions or callable objects that have been registered via addition |
7b51bc51 DE |
22266 | as a pretty-printer. Printers in this list are called @code{global} |
22267 | printers, they're available when debugging all inferiors. | |
fa33c3cd | 22268 | Each @code{gdb.Progspace} contains a @code{pretty_printers} attribute. |
a6bac58e TT |
22269 | Each @code{gdb.Objfile} also contains a @code{pretty_printers} |
22270 | attribute. | |
22271 | ||
7b51bc51 | 22272 | Each function on these lists is passed a single @code{gdb.Value} |
a6bac58e | 22273 | argument and should return a pretty-printer object conforming to the |
4c374409 | 22274 | interface definition above (@pxref{Pretty Printing API}). If a function |
a6bac58e TT |
22275 | cannot create a pretty-printer for the value, it should return |
22276 | @code{None}. | |
22277 | ||
22278 | @value{GDBN} first checks the @code{pretty_printers} attribute of each | |
fa33c3cd | 22279 | @code{gdb.Objfile} in the current program space and iteratively calls |
7b51bc51 DE |
22280 | each enabled lookup routine in the list for that @code{gdb.Objfile} |
22281 | until it receives a pretty-printer object. | |
fa33c3cd DE |
22282 | If no pretty-printer is found in the objfile lists, @value{GDBN} then |
22283 | searches the pretty-printer list of the current program space, | |
967cf477 | 22284 | calling each enabled function until an object is returned. |
a6bac58e | 22285 | After these lists have been exhausted, it tries the global |
967cf477 | 22286 | @code{gdb.pretty_printers} list, again calling each enabled function until an |
a6bac58e TT |
22287 | object is returned. |
22288 | ||
22289 | The order in which the objfiles are searched is not specified. For a | |
22290 | given list, functions are always invoked from the head of the list, | |
22291 | and iterated over sequentially until the end of the list, or a printer | |
22292 | object is returned. | |
22293 | ||
7b51bc51 DE |
22294 | For various reasons a pretty-printer may not work. |
22295 | For example, the underlying data structure may have changed and | |
22296 | the pretty-printer is out of date. | |
22297 | ||
22298 | The consequences of a broken pretty-printer are severe enough that | |
22299 | @value{GDBN} provides support for enabling and disabling individual | |
22300 | printers. For example, if @code{print frame-arguments} is on, | |
22301 | a backtrace can become highly illegible if any argument is printed | |
22302 | with a broken printer. | |
22303 | ||
22304 | Pretty-printers are enabled and disabled by attaching an @code{enabled} | |
22305 | attribute to the registered function or callable object. If this attribute | |
22306 | is present and its value is @code{False}, the printer is disabled, otherwise | |
22307 | the printer is enabled. | |
22308 | ||
22309 | @node Writing a Pretty-Printer | |
22310 | @subsubsection Writing a Pretty-Printer | |
22311 | @cindex writing a pretty-printer | |
22312 | ||
22313 | A pretty-printer consists of two parts: a lookup function to detect | |
22314 | if the type is supported, and the printer itself. | |
22315 | ||
a6bac58e | 22316 | Here is an example showing how a @code{std::string} printer might be |
7b51bc51 DE |
22317 | written. @xref{Pretty Printing API}, for details on the API this class |
22318 | must provide. | |
a6bac58e TT |
22319 | |
22320 | @smallexample | |
7b51bc51 | 22321 | class StdStringPrinter(object): |
a6bac58e TT |
22322 | "Print a std::string" |
22323 | ||
7b51bc51 | 22324 | def __init__(self, val): |
a6bac58e TT |
22325 | self.val = val |
22326 | ||
7b51bc51 | 22327 | def to_string(self): |
a6bac58e TT |
22328 | return self.val['_M_dataplus']['_M_p'] |
22329 | ||
7b51bc51 | 22330 | def display_hint(self): |
a6bac58e TT |
22331 | return 'string' |
22332 | @end smallexample | |
22333 | ||
22334 | And here is an example showing how a lookup function for the printer | |
22335 | example above might be written. | |
22336 | ||
22337 | @smallexample | |
7b51bc51 | 22338 | def str_lookup_function(val): |
a6bac58e | 22339 | lookup_tag = val.type.tag |
a6bac58e TT |
22340 | if lookup_tag == None: |
22341 | return None | |
7b51bc51 DE |
22342 | regex = re.compile("^std::basic_string<char,.*>$") |
22343 | if regex.match(lookup_tag): | |
22344 | return StdStringPrinter(val) | |
a6bac58e TT |
22345 | return None |
22346 | @end smallexample | |
22347 | ||
22348 | The example lookup function extracts the value's type, and attempts to | |
22349 | match it to a type that it can pretty-print. If it is a type the | |
22350 | printer can pretty-print, it will return a printer object. If not, it | |
22351 | returns @code{None}. | |
22352 | ||
22353 | We recommend that you put your core pretty-printers into a Python | |
22354 | package. If your pretty-printers are for use with a library, we | |
22355 | further recommend embedding a version number into the package name. | |
22356 | This practice will enable @value{GDBN} to load multiple versions of | |
22357 | your pretty-printers at the same time, because they will have | |
22358 | different names. | |
22359 | ||
22360 | You should write auto-loaded code (@pxref{Auto-loading}) such that it | |
22361 | can be evaluated multiple times without changing its meaning. An | |
22362 | ideal auto-load file will consist solely of @code{import}s of your | |
22363 | printer modules, followed by a call to a register pretty-printers with | |
22364 | the current objfile. | |
22365 | ||
22366 | Taken as a whole, this approach will scale nicely to multiple | |
22367 | inferiors, each potentially using a different library version. | |
22368 | Embedding a version number in the Python package name will ensure that | |
22369 | @value{GDBN} is able to load both sets of printers simultaneously. | |
22370 | Then, because the search for pretty-printers is done by objfile, and | |
22371 | because your auto-loaded code took care to register your library's | |
22372 | printers with a specific objfile, @value{GDBN} will find the correct | |
22373 | printers for the specific version of the library used by each | |
22374 | inferior. | |
22375 | ||
4c374409 | 22376 | To continue the @code{std::string} example (@pxref{Pretty Printing API}), |
a6bac58e TT |
22377 | this code might appear in @code{gdb.libstdcxx.v6}: |
22378 | ||
22379 | @smallexample | |
7b51bc51 DE |
22380 | def register_printers(objfile): |
22381 | objfile.pretty_printers.add(str_lookup_function) | |
a6bac58e TT |
22382 | @end smallexample |
22383 | ||
22384 | @noindent | |
22385 | And then the corresponding contents of the auto-load file would be: | |
22386 | ||
22387 | @smallexample | |
22388 | import gdb.libstdcxx.v6 | |
7b51bc51 | 22389 | gdb.libstdcxx.v6.register_printers(gdb.current_objfile()) |
a6bac58e TT |
22390 | @end smallexample |
22391 | ||
7b51bc51 DE |
22392 | The previous example illustrates a basic pretty-printer. |
22393 | There are a few things that can be improved on. | |
22394 | The printer doesn't have a name, making it hard to identify in a | |
22395 | list of installed printers. The lookup function has a name, but | |
22396 | lookup functions can have arbitrary, even identical, names. | |
967cf477 | 22397 | |
7b51bc51 DE |
22398 | Second, the printer only handles one type, whereas a library typically has |
22399 | several types. One could install a lookup function for each desired type | |
22400 | in the library, but one could also have a single lookup function recognize | |
22401 | several types. The latter is the conventional way this is handled. | |
22402 | If a pretty-printer can handle multiple data types, then its | |
22403 | @dfn{subprinters} are the printers for the individual data types. | |
967cf477 | 22404 | |
7b51bc51 DE |
22405 | The @code{gdb.printing} module provides a formal way of solving these |
22406 | problems (@pxref{gdb.printing}). | |
22407 | Here is another example that handles multiple types. | |
967cf477 | 22408 | |
7b51bc51 DE |
22409 | These are the types we are going to pretty-print: |
22410 | ||
22411 | @smallexample | |
22412 | struct foo @{ int a, b; @}; | |
22413 | struct bar @{ struct foo x, y; @}; | |
22414 | @end smallexample | |
22415 | ||
22416 | Here are the printers: | |
22417 | ||
22418 | @smallexample | |
22419 | class fooPrinter: | |
22420 | """Print a foo object.""" | |
22421 | ||
22422 | def __init__(self, val): | |
22423 | self.val = val | |
22424 | ||
22425 | def to_string(self): | |
22426 | return ("a=<" + str(self.val["a"]) + | |
22427 | "> b=<" + str(self.val["b"]) + ">") | |
22428 | ||
22429 | class barPrinter: | |
22430 | """Print a bar object.""" | |
22431 | ||
22432 | def __init__(self, val): | |
22433 | self.val = val | |
22434 | ||
22435 | def to_string(self): | |
22436 | return ("x=<" + str(self.val["x"]) + | |
22437 | "> y=<" + str(self.val["y"]) + ">") | |
22438 | @end smallexample | |
22439 | ||
22440 | This example doesn't need a lookup function, that is handled by the | |
22441 | @code{gdb.printing} module. Instead a function is provided to build up | |
22442 | the object that handles the lookup. | |
22443 | ||
22444 | @smallexample | |
22445 | import gdb.printing | |
22446 | ||
22447 | def build_pretty_printer(): | |
22448 | pp = gdb.printing.RegexpCollectionPrettyPrinter( | |
22449 | "my_library") | |
22450 | pp.add_printer('foo', '^foo$', fooPrinter) | |
22451 | pp.add_printer('bar', '^bar$', barPrinter) | |
22452 | return pp | |
22453 | @end smallexample | |
22454 | ||
22455 | And here is the autoload support: | |
22456 | ||
22457 | @smallexample | |
22458 | import gdb.printing | |
22459 | import my_library | |
22460 | gdb.printing.register_pretty_printer( | |
22461 | gdb.current_objfile(), | |
22462 | my_library.build_pretty_printer()) | |
22463 | @end smallexample | |
22464 | ||
22465 | Finally, when this printer is loaded into @value{GDBN}, here is the | |
22466 | corresponding output of @samp{info pretty-printer}: | |
22467 | ||
22468 | @smallexample | |
22469 | (gdb) info pretty-printer | |
22470 | my_library.so: | |
22471 | my_library | |
22472 | foo | |
22473 | bar | |
22474 | @end smallexample | |
967cf477 | 22475 | |
595939de PM |
22476 | @node Inferiors In Python |
22477 | @subsubsection Inferiors In Python | |
505500db | 22478 | @cindex inferiors in Python |
595939de PM |
22479 | |
22480 | @findex gdb.Inferior | |
22481 | Programs which are being run under @value{GDBN} are called inferiors | |
22482 | (@pxref{Inferiors and Programs}). Python scripts can access | |
22483 | information about and manipulate inferiors controlled by @value{GDBN} | |
22484 | via objects of the @code{gdb.Inferior} class. | |
22485 | ||
22486 | The following inferior-related functions are available in the @code{gdb} | |
22487 | module: | |
22488 | ||
d812018b | 22489 | @defun gdb.inferiors () |
595939de PM |
22490 | Return a tuple containing all inferior objects. |
22491 | @end defun | |
22492 | ||
d812018b | 22493 | @defun gdb.selected_inferior () |
2aa48337 KP |
22494 | Return an object representing the current inferior. |
22495 | @end defun | |
22496 | ||
595939de PM |
22497 | A @code{gdb.Inferior} object has the following attributes: |
22498 | ||
22499 | @table @code | |
d812018b | 22500 | @defvar Inferior.num |
595939de | 22501 | ID of inferior, as assigned by GDB. |
d812018b | 22502 | @end defvar |
595939de | 22503 | |
d812018b | 22504 | @defvar Inferior.pid |
595939de PM |
22505 | Process ID of the inferior, as assigned by the underlying operating |
22506 | system. | |
d812018b | 22507 | @end defvar |
595939de | 22508 | |
d812018b | 22509 | @defvar Inferior.was_attached |
595939de PM |
22510 | Boolean signaling whether the inferior was created using `attach', or |
22511 | started by @value{GDBN} itself. | |
d812018b | 22512 | @end defvar |
595939de PM |
22513 | @end table |
22514 | ||
22515 | A @code{gdb.Inferior} object has the following methods: | |
22516 | ||
22517 | @table @code | |
d812018b | 22518 | @defun Inferior.is_valid () |
29703da4 PM |
22519 | Returns @code{True} if the @code{gdb.Inferior} object is valid, |
22520 | @code{False} if not. A @code{gdb.Inferior} object will become invalid | |
22521 | if the inferior no longer exists within @value{GDBN}. All other | |
22522 | @code{gdb.Inferior} methods will throw an exception if it is invalid | |
22523 | at the time the method is called. | |
d812018b | 22524 | @end defun |
29703da4 | 22525 | |
d812018b | 22526 | @defun Inferior.threads () |
595939de PM |
22527 | This method returns a tuple holding all the threads which are valid |
22528 | when it is called. If there are no valid threads, the method will | |
22529 | return an empty tuple. | |
d812018b | 22530 | @end defun |
595939de PM |
22531 | |
22532 | @findex gdb.read_memory | |
d812018b | 22533 | @defun Inferior.read_memory (address, length) |
595939de PM |
22534 | Read @var{length} bytes of memory from the inferior, starting at |
22535 | @var{address}. Returns a buffer object, which behaves much like an array | |
22536 | or a string. It can be modified and given to the @code{gdb.write_memory} | |
22537 | function. | |
d812018b | 22538 | @end defun |
595939de PM |
22539 | |
22540 | @findex gdb.write_memory | |
d812018b | 22541 | @defun Inferior.write_memory (address, buffer @r{[}, length@r{]}) |
595939de PM |
22542 | Write the contents of @var{buffer} to the inferior, starting at |
22543 | @var{address}. The @var{buffer} parameter must be a Python object | |
22544 | which supports the buffer protocol, i.e., a string, an array or the | |
22545 | object returned from @code{gdb.read_memory}. If given, @var{length} | |
22546 | determines the number of bytes from @var{buffer} to be written. | |
d812018b | 22547 | @end defun |
595939de PM |
22548 | |
22549 | @findex gdb.search_memory | |
d812018b | 22550 | @defun Inferior.search_memory (address, length, pattern) |
595939de PM |
22551 | Search a region of the inferior memory starting at @var{address} with |
22552 | the given @var{length} using the search pattern supplied in | |
22553 | @var{pattern}. The @var{pattern} parameter must be a Python object | |
22554 | which supports the buffer protocol, i.e., a string, an array or the | |
22555 | object returned from @code{gdb.read_memory}. Returns a Python @code{Long} | |
22556 | containing the address where the pattern was found, or @code{None} if | |
22557 | the pattern could not be found. | |
d812018b | 22558 | @end defun |
595939de PM |
22559 | @end table |
22560 | ||
505500db SW |
22561 | @node Events In Python |
22562 | @subsubsection Events In Python | |
22563 | @cindex inferior events in Python | |
22564 | ||
22565 | @value{GDBN} provides a general event facility so that Python code can be | |
22566 | notified of various state changes, particularly changes that occur in | |
22567 | the inferior. | |
22568 | ||
22569 | An @dfn{event} is just an object that describes some state change. The | |
22570 | type of the object and its attributes will vary depending on the details | |
22571 | of the change. All the existing events are described below. | |
22572 | ||
22573 | In order to be notified of an event, you must register an event handler | |
22574 | with an @dfn{event registry}. An event registry is an object in the | |
22575 | @code{gdb.events} module which dispatches particular events. A registry | |
22576 | provides methods to register and unregister event handlers: | |
22577 | ||
22578 | @table @code | |
d812018b | 22579 | @defun EventRegistry.connect (object) |
505500db SW |
22580 | Add the given callable @var{object} to the registry. This object will be |
22581 | called when an event corresponding to this registry occurs. | |
d812018b | 22582 | @end defun |
505500db | 22583 | |
d812018b | 22584 | @defun EventRegistry.disconnect (object) |
505500db SW |
22585 | Remove the given @var{object} from the registry. Once removed, the object |
22586 | will no longer receive notifications of events. | |
d812018b | 22587 | @end defun |
505500db SW |
22588 | @end table |
22589 | ||
22590 | Here is an example: | |
22591 | ||
22592 | @smallexample | |
22593 | def exit_handler (event): | |
22594 | print "event type: exit" | |
22595 | print "exit code: %d" % (event.exit_code) | |
22596 | ||
22597 | gdb.events.exited.connect (exit_handler) | |
22598 | @end smallexample | |
22599 | ||
22600 | In the above example we connect our handler @code{exit_handler} to the | |
22601 | registry @code{events.exited}. Once connected, @code{exit_handler} gets | |
22602 | called when the inferior exits. The argument @dfn{event} in this example is | |
22603 | of type @code{gdb.ExitedEvent}. As you can see in the example the | |
22604 | @code{ExitedEvent} object has an attribute which indicates the exit code of | |
22605 | the inferior. | |
22606 | ||
22607 | The following is a listing of the event registries that are available and | |
22608 | details of the events they emit: | |
22609 | ||
22610 | @table @code | |
22611 | ||
22612 | @item events.cont | |
22613 | Emits @code{gdb.ThreadEvent}. | |
22614 | ||
22615 | Some events can be thread specific when @value{GDBN} is running in non-stop | |
22616 | mode. When represented in Python, these events all extend | |
22617 | @code{gdb.ThreadEvent}. Note, this event is not emitted directly; instead, | |
22618 | events which are emitted by this or other modules might extend this event. | |
22619 | Examples of these events are @code{gdb.BreakpointEvent} and | |
22620 | @code{gdb.ContinueEvent}. | |
22621 | ||
22622 | @table @code | |
d812018b | 22623 | @defvar ThreadEvent.inferior_thread |
505500db SW |
22624 | In non-stop mode this attribute will be set to the specific thread which was |
22625 | involved in the emitted event. Otherwise, it will be set to @code{None}. | |
d812018b | 22626 | @end defvar |
505500db SW |
22627 | @end table |
22628 | ||
22629 | Emits @code{gdb.ContinueEvent} which extends @code{gdb.ThreadEvent}. | |
22630 | ||
22631 | This event indicates that the inferior has been continued after a stop. For | |
22632 | inherited attribute refer to @code{gdb.ThreadEvent} above. | |
22633 | ||
22634 | @item events.exited | |
22635 | Emits @code{events.ExitedEvent} which indicates that the inferior has exited. | |
cb6be26b | 22636 | @code{events.ExitedEvent} has two attributes: |
505500db | 22637 | @table @code |
d812018b | 22638 | @defvar ExitedEvent.exit_code |
cb6be26b KP |
22639 | An integer representing the exit code, if available, which the inferior |
22640 | has returned. (The exit code could be unavailable if, for example, | |
22641 | @value{GDBN} detaches from the inferior.) If the exit code is unavailable, | |
22642 | the attribute does not exist. | |
22643 | @end defvar | |
22644 | @defvar ExitedEvent inferior | |
22645 | A reference to the inferior which triggered the @code{exited} event. | |
d812018b | 22646 | @end defvar |
505500db SW |
22647 | @end table |
22648 | ||
22649 | @item events.stop | |
22650 | Emits @code{gdb.StopEvent} which extends @code{gdb.ThreadEvent}. | |
22651 | ||
22652 | Indicates that the inferior has stopped. All events emitted by this registry | |
22653 | extend StopEvent. As a child of @code{gdb.ThreadEvent}, @code{gdb.StopEvent} | |
22654 | will indicate the stopped thread when @value{GDBN} is running in non-stop | |
22655 | mode. Refer to @code{gdb.ThreadEvent} above for more details. | |
22656 | ||
22657 | Emits @code{gdb.SignalEvent} which extends @code{gdb.StopEvent}. | |
22658 | ||
22659 | This event indicates that the inferior or one of its threads has received as | |
22660 | signal. @code{gdb.SignalEvent} has the following attributes: | |
22661 | ||
22662 | @table @code | |
d812018b | 22663 | @defvar SignalEvent.stop_signal |
505500db SW |
22664 | A string representing the signal received by the inferior. A list of possible |
22665 | signal values can be obtained by running the command @code{info signals} in | |
22666 | the @value{GDBN} command prompt. | |
d812018b | 22667 | @end defvar |
505500db SW |
22668 | @end table |
22669 | ||
22670 | Also emits @code{gdb.BreakpointEvent} which extends @code{gdb.StopEvent}. | |
22671 | ||
6839b47f KP |
22672 | @code{gdb.BreakpointEvent} event indicates that one or more breakpoints have |
22673 | been hit, and has the following attributes: | |
505500db SW |
22674 | |
22675 | @table @code | |
d812018b | 22676 | @defvar BreakpointEvent.breakpoints |
6839b47f KP |
22677 | A sequence containing references to all the breakpoints (type |
22678 | @code{gdb.Breakpoint}) that were hit. | |
505500db | 22679 | @xref{Breakpoints In Python}, for details of the @code{gdb.Breakpoint} object. |
d812018b PK |
22680 | @end defvar |
22681 | @defvar BreakpointEvent.breakpoint | |
6839b47f KP |
22682 | A reference to the first breakpoint that was hit. |
22683 | This function is maintained for backward compatibility and is now deprecated | |
d812018b PK |
22684 | in favor of the @code{gdb.BreakpointEvent.breakpoints} attribute. |
22685 | @end defvar | |
505500db SW |
22686 | @end table |
22687 | ||
20c168b5 KP |
22688 | @item events.new_objfile |
22689 | Emits @code{gdb.NewObjFileEvent} which indicates that a new object file has | |
22690 | been loaded by @value{GDBN}. @code{gdb.NewObjFileEvent} has one attribute: | |
22691 | ||
22692 | @table @code | |
22693 | @defvar NewObjFileEvent.new_objfile | |
22694 | A reference to the object file (@code{gdb.Objfile}) which has been loaded. | |
22695 | @xref{Objfiles In Python}, for details of the @code{gdb.Objfile} object. | |
22696 | @end defvar | |
22697 | @end table | |
22698 | ||
505500db SW |
22699 | @end table |
22700 | ||
595939de PM |
22701 | @node Threads In Python |
22702 | @subsubsection Threads In Python | |
22703 | @cindex threads in python | |
22704 | ||
22705 | @findex gdb.InferiorThread | |
22706 | Python scripts can access information about, and manipulate inferior threads | |
22707 | controlled by @value{GDBN}, via objects of the @code{gdb.InferiorThread} class. | |
22708 | ||
22709 | The following thread-related functions are available in the @code{gdb} | |
22710 | module: | |
22711 | ||
22712 | @findex gdb.selected_thread | |
d812018b | 22713 | @defun gdb.selected_thread () |
595939de PM |
22714 | This function returns the thread object for the selected thread. If there |
22715 | is no selected thread, this will return @code{None}. | |
22716 | @end defun | |
22717 | ||
22718 | A @code{gdb.InferiorThread} object has the following attributes: | |
22719 | ||
22720 | @table @code | |
d812018b | 22721 | @defvar InferiorThread.name |
4694da01 TT |
22722 | The name of the thread. If the user specified a name using |
22723 | @code{thread name}, then this returns that name. Otherwise, if an | |
22724 | OS-supplied name is available, then it is returned. Otherwise, this | |
22725 | returns @code{None}. | |
22726 | ||
22727 | This attribute can be assigned to. The new value must be a string | |
22728 | object, which sets the new name, or @code{None}, which removes any | |
22729 | user-specified thread name. | |
d812018b | 22730 | @end defvar |
4694da01 | 22731 | |
d812018b | 22732 | @defvar InferiorThread.num |
595939de | 22733 | ID of the thread, as assigned by GDB. |
d812018b | 22734 | @end defvar |
595939de | 22735 | |
d812018b | 22736 | @defvar InferiorThread.ptid |
595939de PM |
22737 | ID of the thread, as assigned by the operating system. This attribute is a |
22738 | tuple containing three integers. The first is the Process ID (PID); the second | |
22739 | is the Lightweight Process ID (LWPID), and the third is the Thread ID (TID). | |
22740 | Either the LWPID or TID may be 0, which indicates that the operating system | |
22741 | does not use that identifier. | |
d812018b | 22742 | @end defvar |
595939de PM |
22743 | @end table |
22744 | ||
22745 | A @code{gdb.InferiorThread} object has the following methods: | |
22746 | ||
dc3b15be | 22747 | @table @code |
d812018b | 22748 | @defun InferiorThread.is_valid () |
29703da4 PM |
22749 | Returns @code{True} if the @code{gdb.InferiorThread} object is valid, |
22750 | @code{False} if not. A @code{gdb.InferiorThread} object will become | |
22751 | invalid if the thread exits, or the inferior that the thread belongs | |
22752 | is deleted. All other @code{gdb.InferiorThread} methods will throw an | |
22753 | exception if it is invalid at the time the method is called. | |
d812018b | 22754 | @end defun |
29703da4 | 22755 | |
d812018b | 22756 | @defun InferiorThread.switch () |
595939de PM |
22757 | This changes @value{GDBN}'s currently selected thread to the one represented |
22758 | by this object. | |
d812018b | 22759 | @end defun |
595939de | 22760 | |
d812018b | 22761 | @defun InferiorThread.is_stopped () |
595939de | 22762 | Return a Boolean indicating whether the thread is stopped. |
d812018b | 22763 | @end defun |
595939de | 22764 | |
d812018b | 22765 | @defun InferiorThread.is_running () |
595939de | 22766 | Return a Boolean indicating whether the thread is running. |
d812018b | 22767 | @end defun |
595939de | 22768 | |
d812018b | 22769 | @defun InferiorThread.is_exited () |
595939de | 22770 | Return a Boolean indicating whether the thread is exited. |
d812018b | 22771 | @end defun |
595939de PM |
22772 | @end table |
22773 | ||
d8906c6f TJB |
22774 | @node Commands In Python |
22775 | @subsubsection Commands In Python | |
22776 | ||
22777 | @cindex commands in python | |
22778 | @cindex python commands | |
d8906c6f TJB |
22779 | You can implement new @value{GDBN} CLI commands in Python. A CLI |
22780 | command is implemented using an instance of the @code{gdb.Command} | |
22781 | class, most commonly using a subclass. | |
22782 | ||
f05e2e1d | 22783 | @defun Command.__init__ (name, @var{command_class} @r{[}, @var{completer_class} @r{[}, @var{prefix}@r{]]}) |
d8906c6f TJB |
22784 | The object initializer for @code{Command} registers the new command |
22785 | with @value{GDBN}. This initializer is normally invoked from the | |
22786 | subclass' own @code{__init__} method. | |
22787 | ||
22788 | @var{name} is the name of the command. If @var{name} consists of | |
22789 | multiple words, then the initial words are looked for as prefix | |
22790 | commands. In this case, if one of the prefix commands does not exist, | |
22791 | an exception is raised. | |
22792 | ||
22793 | There is no support for multi-line commands. | |
22794 | ||
cc924cad | 22795 | @var{command_class} should be one of the @samp{COMMAND_} constants |
d8906c6f TJB |
22796 | defined below. This argument tells @value{GDBN} how to categorize the |
22797 | new command in the help system. | |
22798 | ||
cc924cad | 22799 | @var{completer_class} is an optional argument. If given, it should be |
d8906c6f TJB |
22800 | one of the @samp{COMPLETE_} constants defined below. This argument |
22801 | tells @value{GDBN} how to perform completion for this command. If not | |
22802 | given, @value{GDBN} will attempt to complete using the object's | |
22803 | @code{complete} method (see below); if no such method is found, an | |
22804 | error will occur when completion is attempted. | |
22805 | ||
22806 | @var{prefix} is an optional argument. If @code{True}, then the new | |
22807 | command is a prefix command; sub-commands of this command may be | |
22808 | registered. | |
22809 | ||
22810 | The help text for the new command is taken from the Python | |
22811 | documentation string for the command's class, if there is one. If no | |
22812 | documentation string is provided, the default value ``This command is | |
22813 | not documented.'' is used. | |
d812018b | 22814 | @end defun |
d8906c6f | 22815 | |
a0c36267 | 22816 | @cindex don't repeat Python command |
d812018b | 22817 | @defun Command.dont_repeat () |
d8906c6f TJB |
22818 | By default, a @value{GDBN} command is repeated when the user enters a |
22819 | blank line at the command prompt. A command can suppress this | |
22820 | behavior by invoking the @code{dont_repeat} method. This is similar | |
22821 | to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}. | |
d812018b | 22822 | @end defun |
d8906c6f | 22823 | |
d812018b | 22824 | @defun Command.invoke (argument, from_tty) |
d8906c6f TJB |
22825 | This method is called by @value{GDBN} when this command is invoked. |
22826 | ||
22827 | @var{argument} is a string. It is the argument to the command, after | |
22828 | leading and trailing whitespace has been stripped. | |
22829 | ||
22830 | @var{from_tty} is a boolean argument. When true, this means that the | |
22831 | command was entered by the user at the terminal; when false it means | |
22832 | that the command came from elsewhere. | |
22833 | ||
22834 | If this method throws an exception, it is turned into a @value{GDBN} | |
22835 | @code{error} call. Otherwise, the return value is ignored. | |
07ca107c DE |
22836 | |
22837 | @findex gdb.string_to_argv | |
22838 | To break @var{argument} up into an argv-like string use | |
22839 | @code{gdb.string_to_argv}. This function behaves identically to | |
22840 | @value{GDBN}'s internal argument lexer @code{buildargv}. | |
22841 | It is recommended to use this for consistency. | |
22842 | Arguments are separated by spaces and may be quoted. | |
22843 | Example: | |
22844 | ||
22845 | @smallexample | |
22846 | print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"") | |
22847 | ['1', '2 "3', '4 "5', "6 '7"] | |
22848 | @end smallexample | |
22849 | ||
d812018b | 22850 | @end defun |
d8906c6f | 22851 | |
a0c36267 | 22852 | @cindex completion of Python commands |
d812018b | 22853 | @defun Command.complete (text, word) |
d8906c6f TJB |
22854 | This method is called by @value{GDBN} when the user attempts |
22855 | completion on this command. All forms of completion are handled by | |
a0c36267 EZ |
22856 | this method, that is, the @key{TAB} and @key{M-?} key bindings |
22857 | (@pxref{Completion}), and the @code{complete} command (@pxref{Help, | |
22858 | complete}). | |
d8906c6f TJB |
22859 | |
22860 | The arguments @var{text} and @var{word} are both strings. @var{text} | |
22861 | holds the complete command line up to the cursor's location. | |
22862 | @var{word} holds the last word of the command line; this is computed | |
22863 | using a word-breaking heuristic. | |
22864 | ||
22865 | The @code{complete} method can return several values: | |
22866 | @itemize @bullet | |
22867 | @item | |
22868 | If the return value is a sequence, the contents of the sequence are | |
22869 | used as the completions. It is up to @code{complete} to ensure that the | |
22870 | contents actually do complete the word. A zero-length sequence is | |
22871 | allowed, it means that there were no completions available. Only | |
22872 | string elements of the sequence are used; other elements in the | |
22873 | sequence are ignored. | |
22874 | ||
22875 | @item | |
22876 | If the return value is one of the @samp{COMPLETE_} constants defined | |
22877 | below, then the corresponding @value{GDBN}-internal completion | |
22878 | function is invoked, and its result is used. | |
22879 | ||
22880 | @item | |
22881 | All other results are treated as though there were no available | |
22882 | completions. | |
22883 | @end itemize | |
d812018b | 22884 | @end defun |
d8906c6f | 22885 | |
d8906c6f TJB |
22886 | When a new command is registered, it must be declared as a member of |
22887 | some general class of commands. This is used to classify top-level | |
22888 | commands in the on-line help system; note that prefix commands are not | |
22889 | listed under their own category but rather that of their top-level | |
22890 | command. The available classifications are represented by constants | |
22891 | defined in the @code{gdb} module: | |
22892 | ||
22893 | @table @code | |
22894 | @findex COMMAND_NONE | |
22895 | @findex gdb.COMMAND_NONE | |
d812018b | 22896 | @item gdb.COMMAND_NONE |
d8906c6f TJB |
22897 | The command does not belong to any particular class. A command in |
22898 | this category will not be displayed in any of the help categories. | |
22899 | ||
22900 | @findex COMMAND_RUNNING | |
22901 | @findex gdb.COMMAND_RUNNING | |
d812018b | 22902 | @item gdb.COMMAND_RUNNING |
d8906c6f TJB |
22903 | The command is related to running the inferior. For example, |
22904 | @code{start}, @code{step}, and @code{continue} are in this category. | |
a0c36267 | 22905 | Type @kbd{help running} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22906 | commands in this category. |
22907 | ||
22908 | @findex COMMAND_DATA | |
22909 | @findex gdb.COMMAND_DATA | |
d812018b | 22910 | @item gdb.COMMAND_DATA |
d8906c6f TJB |
22911 | The command is related to data or variables. For example, |
22912 | @code{call}, @code{find}, and @code{print} are in this category. Type | |
a0c36267 | 22913 | @kbd{help data} at the @value{GDBN} prompt to see a list of commands |
d8906c6f TJB |
22914 | in this category. |
22915 | ||
22916 | @findex COMMAND_STACK | |
22917 | @findex gdb.COMMAND_STACK | |
d812018b | 22918 | @item gdb.COMMAND_STACK |
d8906c6f TJB |
22919 | The command has to do with manipulation of the stack. For example, |
22920 | @code{backtrace}, @code{frame}, and @code{return} are in this | |
a0c36267 | 22921 | category. Type @kbd{help stack} at the @value{GDBN} prompt to see a |
d8906c6f TJB |
22922 | list of commands in this category. |
22923 | ||
22924 | @findex COMMAND_FILES | |
22925 | @findex gdb.COMMAND_FILES | |
d812018b | 22926 | @item gdb.COMMAND_FILES |
d8906c6f TJB |
22927 | This class is used for file-related commands. For example, |
22928 | @code{file}, @code{list} and @code{section} are in this category. | |
a0c36267 | 22929 | Type @kbd{help files} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22930 | commands in this category. |
22931 | ||
22932 | @findex COMMAND_SUPPORT | |
22933 | @findex gdb.COMMAND_SUPPORT | |
d812018b | 22934 | @item gdb.COMMAND_SUPPORT |
d8906c6f TJB |
22935 | This should be used for ``support facilities'', generally meaning |
22936 | things that are useful to the user when interacting with @value{GDBN}, | |
22937 | but not related to the state of the inferior. For example, | |
22938 | @code{help}, @code{make}, and @code{shell} are in this category. Type | |
a0c36267 | 22939 | @kbd{help support} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22940 | commands in this category. |
22941 | ||
22942 | @findex COMMAND_STATUS | |
22943 | @findex gdb.COMMAND_STATUS | |
d812018b | 22944 | @item gdb.COMMAND_STATUS |
d8906c6f TJB |
22945 | The command is an @samp{info}-related command, that is, related to the |
22946 | state of @value{GDBN} itself. For example, @code{info}, @code{macro}, | |
a0c36267 | 22947 | and @code{show} are in this category. Type @kbd{help status} at the |
d8906c6f TJB |
22948 | @value{GDBN} prompt to see a list of commands in this category. |
22949 | ||
22950 | @findex COMMAND_BREAKPOINTS | |
22951 | @findex gdb.COMMAND_BREAKPOINTS | |
d812018b | 22952 | @item gdb.COMMAND_BREAKPOINTS |
d8906c6f | 22953 | The command has to do with breakpoints. For example, @code{break}, |
a0c36267 | 22954 | @code{clear}, and @code{delete} are in this category. Type @kbd{help |
d8906c6f TJB |
22955 | breakpoints} at the @value{GDBN} prompt to see a list of commands in |
22956 | this category. | |
22957 | ||
22958 | @findex COMMAND_TRACEPOINTS | |
22959 | @findex gdb.COMMAND_TRACEPOINTS | |
d812018b | 22960 | @item gdb.COMMAND_TRACEPOINTS |
d8906c6f TJB |
22961 | The command has to do with tracepoints. For example, @code{trace}, |
22962 | @code{actions}, and @code{tfind} are in this category. Type | |
a0c36267 | 22963 | @kbd{help tracepoints} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22964 | commands in this category. |
22965 | ||
22966 | @findex COMMAND_OBSCURE | |
22967 | @findex gdb.COMMAND_OBSCURE | |
d812018b | 22968 | @item gdb.COMMAND_OBSCURE |
d8906c6f TJB |
22969 | The command is only used in unusual circumstances, or is not of |
22970 | general interest to users. For example, @code{checkpoint}, | |
a0c36267 | 22971 | @code{fork}, and @code{stop} are in this category. Type @kbd{help |
d8906c6f TJB |
22972 | obscure} at the @value{GDBN} prompt to see a list of commands in this |
22973 | category. | |
22974 | ||
22975 | @findex COMMAND_MAINTENANCE | |
22976 | @findex gdb.COMMAND_MAINTENANCE | |
d812018b | 22977 | @item gdb.COMMAND_MAINTENANCE |
d8906c6f TJB |
22978 | The command is only useful to @value{GDBN} maintainers. The |
22979 | @code{maintenance} and @code{flushregs} commands are in this category. | |
a0c36267 | 22980 | Type @kbd{help internals} at the @value{GDBN} prompt to see a list of |
d8906c6f TJB |
22981 | commands in this category. |
22982 | @end table | |
22983 | ||
d8906c6f TJB |
22984 | A new command can use a predefined completion function, either by |
22985 | specifying it via an argument at initialization, or by returning it | |
22986 | from the @code{complete} method. These predefined completion | |
22987 | constants are all defined in the @code{gdb} module: | |
22988 | ||
22989 | @table @code | |
22990 | @findex COMPLETE_NONE | |
22991 | @findex gdb.COMPLETE_NONE | |
d812018b | 22992 | @item gdb.COMPLETE_NONE |
d8906c6f TJB |
22993 | This constant means that no completion should be done. |
22994 | ||
22995 | @findex COMPLETE_FILENAME | |
22996 | @findex gdb.COMPLETE_FILENAME | |
d812018b | 22997 | @item gdb.COMPLETE_FILENAME |
d8906c6f TJB |
22998 | This constant means that filename completion should be performed. |
22999 | ||
23000 | @findex COMPLETE_LOCATION | |
23001 | @findex gdb.COMPLETE_LOCATION | |
d812018b | 23002 | @item gdb.COMPLETE_LOCATION |
d8906c6f TJB |
23003 | This constant means that location completion should be done. |
23004 | @xref{Specify Location}. | |
23005 | ||
23006 | @findex COMPLETE_COMMAND | |
23007 | @findex gdb.COMPLETE_COMMAND | |
d812018b | 23008 | @item gdb.COMPLETE_COMMAND |
d8906c6f TJB |
23009 | This constant means that completion should examine @value{GDBN} |
23010 | command names. | |
23011 | ||
23012 | @findex COMPLETE_SYMBOL | |
23013 | @findex gdb.COMPLETE_SYMBOL | |
d812018b | 23014 | @item gdb.COMPLETE_SYMBOL |
d8906c6f TJB |
23015 | This constant means that completion should be done using symbol names |
23016 | as the source. | |
23017 | @end table | |
23018 | ||
23019 | The following code snippet shows how a trivial CLI command can be | |
23020 | implemented in Python: | |
23021 | ||
23022 | @smallexample | |
23023 | class HelloWorld (gdb.Command): | |
23024 | """Greet the whole world.""" | |
23025 | ||
23026 | def __init__ (self): | |
23027 | super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_OBSCURE) | |
23028 | ||
23029 | def invoke (self, arg, from_tty): | |
23030 | print "Hello, World!" | |
23031 | ||
23032 | HelloWorld () | |
23033 | @end smallexample | |
23034 | ||
23035 | The last line instantiates the class, and is necessary to trigger the | |
23036 | registration of the command with @value{GDBN}. Depending on how the | |
23037 | Python code is read into @value{GDBN}, you may need to import the | |
23038 | @code{gdb} module explicitly. | |
23039 | ||
d7b32ed3 PM |
23040 | @node Parameters In Python |
23041 | @subsubsection Parameters In Python | |
23042 | ||
23043 | @cindex parameters in python | |
23044 | @cindex python parameters | |
23045 | @tindex gdb.Parameter | |
23046 | @tindex Parameter | |
23047 | You can implement new @value{GDBN} parameters using Python. A new | |
23048 | parameter is implemented as an instance of the @code{gdb.Parameter} | |
23049 | class. | |
23050 | ||
23051 | Parameters are exposed to the user via the @code{set} and | |
23052 | @code{show} commands. @xref{Help}. | |
23053 | ||
23054 | There are many parameters that already exist and can be set in | |
23055 | @value{GDBN}. Two examples are: @code{set follow fork} and | |
23056 | @code{set charset}. Setting these parameters influences certain | |
23057 | behavior in @value{GDBN}. Similarly, you can define parameters that | |
23058 | can be used to influence behavior in custom Python scripts and commands. | |
23059 | ||
d812018b | 23060 | @defun Parameter.__init__ (name, @var{command-class}, @var{parameter-class} @r{[}, @var{enum-sequence}@r{]}) |
d7b32ed3 PM |
23061 | The object initializer for @code{Parameter} registers the new |
23062 | parameter with @value{GDBN}. This initializer is normally invoked | |
23063 | from the subclass' own @code{__init__} method. | |
23064 | ||
23065 | @var{name} is the name of the new parameter. If @var{name} consists | |
23066 | of multiple words, then the initial words are looked for as prefix | |
23067 | parameters. An example of this can be illustrated with the | |
23068 | @code{set print} set of parameters. If @var{name} is | |
23069 | @code{print foo}, then @code{print} will be searched as the prefix | |
23070 | parameter. In this case the parameter can subsequently be accessed in | |
23071 | @value{GDBN} as @code{set print foo}. | |
23072 | ||
23073 | If @var{name} consists of multiple words, and no prefix parameter group | |
23074 | can be found, an exception is raised. | |
23075 | ||
23076 | @var{command-class} should be one of the @samp{COMMAND_} constants | |
23077 | (@pxref{Commands In Python}). This argument tells @value{GDBN} how to | |
23078 | categorize the new parameter in the help system. | |
23079 | ||
23080 | @var{parameter-class} should be one of the @samp{PARAM_} constants | |
23081 | defined below. This argument tells @value{GDBN} the type of the new | |
23082 | parameter; this information is used for input validation and | |
23083 | completion. | |
23084 | ||
23085 | If @var{parameter-class} is @code{PARAM_ENUM}, then | |
23086 | @var{enum-sequence} must be a sequence of strings. These strings | |
23087 | represent the possible values for the parameter. | |
23088 | ||
23089 | If @var{parameter-class} is not @code{PARAM_ENUM}, then the presence | |
23090 | of a fourth argument will cause an exception to be thrown. | |
23091 | ||
23092 | The help text for the new parameter is taken from the Python | |
23093 | documentation string for the parameter's class, if there is one. If | |
23094 | there is no documentation string, a default value is used. | |
d812018b | 23095 | @end defun |
d7b32ed3 | 23096 | |
d812018b | 23097 | @defvar Parameter.set_doc |
d7b32ed3 PM |
23098 | If this attribute exists, and is a string, then its value is used as |
23099 | the help text for this parameter's @code{set} command. The value is | |
23100 | examined when @code{Parameter.__init__} is invoked; subsequent changes | |
23101 | have no effect. | |
d812018b | 23102 | @end defvar |
d7b32ed3 | 23103 | |
d812018b | 23104 | @defvar Parameter.show_doc |
d7b32ed3 PM |
23105 | If this attribute exists, and is a string, then its value is used as |
23106 | the help text for this parameter's @code{show} command. The value is | |
23107 | examined when @code{Parameter.__init__} is invoked; subsequent changes | |
23108 | have no effect. | |
d812018b | 23109 | @end defvar |
d7b32ed3 | 23110 | |
d812018b | 23111 | @defvar Parameter.value |
d7b32ed3 PM |
23112 | The @code{value} attribute holds the underlying value of the |
23113 | parameter. It can be read and assigned to just as any other | |
23114 | attribute. @value{GDBN} does validation when assignments are made. | |
d812018b | 23115 | @end defvar |
d7b32ed3 | 23116 | |
ecec24e6 PM |
23117 | There are two methods that should be implemented in any |
23118 | @code{Parameter} class. These are: | |
23119 | ||
d812018b | 23120 | @defun Parameter.get_set_string (self) |
ecec24e6 PM |
23121 | @value{GDBN} will call this method when a @var{parameter}'s value has |
23122 | been changed via the @code{set} API (for example, @kbd{set foo off}). | |
23123 | The @code{value} attribute has already been populated with the new | |
23124 | value and may be used in output. This method must return a string. | |
d812018b | 23125 | @end defun |
ecec24e6 | 23126 | |
d812018b | 23127 | @defun Parameter.get_show_string (self, svalue) |
ecec24e6 PM |
23128 | @value{GDBN} will call this method when a @var{parameter}'s |
23129 | @code{show} API has been invoked (for example, @kbd{show foo}). The | |
23130 | argument @code{svalue} receives the string representation of the | |
23131 | current value. This method must return a string. | |
d812018b | 23132 | @end defun |
d7b32ed3 PM |
23133 | |
23134 | When a new parameter is defined, its type must be specified. The | |
23135 | available types are represented by constants defined in the @code{gdb} | |
23136 | module: | |
23137 | ||
23138 | @table @code | |
23139 | @findex PARAM_BOOLEAN | |
23140 | @findex gdb.PARAM_BOOLEAN | |
d812018b | 23141 | @item gdb.PARAM_BOOLEAN |
d7b32ed3 PM |
23142 | The value is a plain boolean. The Python boolean values, @code{True} |
23143 | and @code{False} are the only valid values. | |
23144 | ||
23145 | @findex PARAM_AUTO_BOOLEAN | |
23146 | @findex gdb.PARAM_AUTO_BOOLEAN | |
d812018b | 23147 | @item gdb.PARAM_AUTO_BOOLEAN |
d7b32ed3 PM |
23148 | The value has three possible states: true, false, and @samp{auto}. In |
23149 | Python, true and false are represented using boolean constants, and | |
23150 | @samp{auto} is represented using @code{None}. | |
23151 | ||
23152 | @findex PARAM_UINTEGER | |
23153 | @findex gdb.PARAM_UINTEGER | |
d812018b | 23154 | @item gdb.PARAM_UINTEGER |
d7b32ed3 PM |
23155 | The value is an unsigned integer. The value of 0 should be |
23156 | interpreted to mean ``unlimited''. | |
23157 | ||
23158 | @findex PARAM_INTEGER | |
23159 | @findex gdb.PARAM_INTEGER | |
d812018b | 23160 | @item gdb.PARAM_INTEGER |
d7b32ed3 PM |
23161 | The value is a signed integer. The value of 0 should be interpreted |
23162 | to mean ``unlimited''. | |
23163 | ||
23164 | @findex PARAM_STRING | |
23165 | @findex gdb.PARAM_STRING | |
d812018b | 23166 | @item gdb.PARAM_STRING |
d7b32ed3 PM |
23167 | The value is a string. When the user modifies the string, any escape |
23168 | sequences, such as @samp{\t}, @samp{\f}, and octal escapes, are | |
23169 | translated into corresponding characters and encoded into the current | |
23170 | host charset. | |
23171 | ||
23172 | @findex PARAM_STRING_NOESCAPE | |
23173 | @findex gdb.PARAM_STRING_NOESCAPE | |
d812018b | 23174 | @item gdb.PARAM_STRING_NOESCAPE |
d7b32ed3 PM |
23175 | The value is a string. When the user modifies the string, escapes are |
23176 | passed through untranslated. | |
23177 | ||
23178 | @findex PARAM_OPTIONAL_FILENAME | |
23179 | @findex gdb.PARAM_OPTIONAL_FILENAME | |
d812018b | 23180 | @item gdb.PARAM_OPTIONAL_FILENAME |
d7b32ed3 PM |
23181 | The value is a either a filename (a string), or @code{None}. |
23182 | ||
23183 | @findex PARAM_FILENAME | |
23184 | @findex gdb.PARAM_FILENAME | |
d812018b | 23185 | @item gdb.PARAM_FILENAME |
d7b32ed3 PM |
23186 | The value is a filename. This is just like |
23187 | @code{PARAM_STRING_NOESCAPE}, but uses file names for completion. | |
23188 | ||
23189 | @findex PARAM_ZINTEGER | |
23190 | @findex gdb.PARAM_ZINTEGER | |
d812018b | 23191 | @item gdb.PARAM_ZINTEGER |
d7b32ed3 PM |
23192 | The value is an integer. This is like @code{PARAM_INTEGER}, except 0 |
23193 | is interpreted as itself. | |
23194 | ||
23195 | @findex PARAM_ENUM | |
23196 | @findex gdb.PARAM_ENUM | |
d812018b | 23197 | @item gdb.PARAM_ENUM |
d7b32ed3 PM |
23198 | The value is a string, which must be one of a collection string |
23199 | constants provided when the parameter is created. | |
23200 | @end table | |
23201 | ||
bc3b79fd TJB |
23202 | @node Functions In Python |
23203 | @subsubsection Writing new convenience functions | |
23204 | ||
23205 | @cindex writing convenience functions | |
23206 | @cindex convenience functions in python | |
23207 | @cindex python convenience functions | |
23208 | @tindex gdb.Function | |
23209 | @tindex Function | |
23210 | You can implement new convenience functions (@pxref{Convenience Vars}) | |
23211 | in Python. A convenience function is an instance of a subclass of the | |
23212 | class @code{gdb.Function}. | |
23213 | ||
d812018b | 23214 | @defun Function.__init__ (name) |
bc3b79fd TJB |
23215 | The initializer for @code{Function} registers the new function with |
23216 | @value{GDBN}. The argument @var{name} is the name of the function, | |
23217 | a string. The function will be visible to the user as a convenience | |
23218 | variable of type @code{internal function}, whose name is the same as | |
23219 | the given @var{name}. | |
23220 | ||
23221 | The documentation for the new function is taken from the documentation | |
23222 | string for the new class. | |
d812018b | 23223 | @end defun |
bc3b79fd | 23224 | |
d812018b | 23225 | @defun Function.invoke (@var{*args}) |
bc3b79fd TJB |
23226 | When a convenience function is evaluated, its arguments are converted |
23227 | to instances of @code{gdb.Value}, and then the function's | |
23228 | @code{invoke} method is called. Note that @value{GDBN} does not | |
23229 | predetermine the arity of convenience functions. Instead, all | |
23230 | available arguments are passed to @code{invoke}, following the | |
23231 | standard Python calling convention. In particular, a convenience | |
23232 | function can have default values for parameters without ill effect. | |
23233 | ||
23234 | The return value of this method is used as its value in the enclosing | |
23235 | expression. If an ordinary Python value is returned, it is converted | |
23236 | to a @code{gdb.Value} following the usual rules. | |
d812018b | 23237 | @end defun |
bc3b79fd TJB |
23238 | |
23239 | The following code snippet shows how a trivial convenience function can | |
23240 | be implemented in Python: | |
23241 | ||
23242 | @smallexample | |
23243 | class Greet (gdb.Function): | |
23244 | """Return string to greet someone. | |
23245 | Takes a name as argument.""" | |
23246 | ||
23247 | def __init__ (self): | |
23248 | super (Greet, self).__init__ ("greet") | |
23249 | ||
23250 | def invoke (self, name): | |
23251 | return "Hello, %s!" % name.string () | |
23252 | ||
23253 | Greet () | |
23254 | @end smallexample | |
23255 | ||
23256 | The last line instantiates the class, and is necessary to trigger the | |
23257 | registration of the function with @value{GDBN}. Depending on how the | |
23258 | Python code is read into @value{GDBN}, you may need to import the | |
23259 | @code{gdb} module explicitly. | |
23260 | ||
fa33c3cd DE |
23261 | @node Progspaces In Python |
23262 | @subsubsection Program Spaces In Python | |
23263 | ||
23264 | @cindex progspaces in python | |
23265 | @tindex gdb.Progspace | |
23266 | @tindex Progspace | |
23267 | A program space, or @dfn{progspace}, represents a symbolic view | |
23268 | of an address space. | |
23269 | It consists of all of the objfiles of the program. | |
23270 | @xref{Objfiles In Python}. | |
23271 | @xref{Inferiors and Programs, program spaces}, for more details | |
23272 | about program spaces. | |
23273 | ||
23274 | The following progspace-related functions are available in the | |
23275 | @code{gdb} module: | |
23276 | ||
23277 | @findex gdb.current_progspace | |
d812018b | 23278 | @defun gdb.current_progspace () |
fa33c3cd DE |
23279 | This function returns the program space of the currently selected inferior. |
23280 | @xref{Inferiors and Programs}. | |
23281 | @end defun | |
23282 | ||
23283 | @findex gdb.progspaces | |
d812018b | 23284 | @defun gdb.progspaces () |
fa33c3cd DE |
23285 | Return a sequence of all the progspaces currently known to @value{GDBN}. |
23286 | @end defun | |
23287 | ||
23288 | Each progspace is represented by an instance of the @code{gdb.Progspace} | |
23289 | class. | |
23290 | ||
d812018b | 23291 | @defvar Progspace.filename |
fa33c3cd | 23292 | The file name of the progspace as a string. |
d812018b | 23293 | @end defvar |
fa33c3cd | 23294 | |
d812018b | 23295 | @defvar Progspace.pretty_printers |
fa33c3cd DE |
23296 | The @code{pretty_printers} attribute is a list of functions. It is |
23297 | used to look up pretty-printers. A @code{Value} is passed to each | |
23298 | function in order; if the function returns @code{None}, then the | |
23299 | search continues. Otherwise, the return value should be an object | |
4c374409 | 23300 | which is used to format the value. @xref{Pretty Printing API}, for more |
fa33c3cd | 23301 | information. |
d812018b | 23302 | @end defvar |
fa33c3cd | 23303 | |
89c73ade TT |
23304 | @node Objfiles In Python |
23305 | @subsubsection Objfiles In Python | |
23306 | ||
23307 | @cindex objfiles in python | |
23308 | @tindex gdb.Objfile | |
23309 | @tindex Objfile | |
23310 | @value{GDBN} loads symbols for an inferior from various | |
23311 | symbol-containing files (@pxref{Files}). These include the primary | |
23312 | executable file, any shared libraries used by the inferior, and any | |
23313 | separate debug info files (@pxref{Separate Debug Files}). | |
23314 | @value{GDBN} calls these symbol-containing files @dfn{objfiles}. | |
23315 | ||
23316 | The following objfile-related functions are available in the | |
23317 | @code{gdb} module: | |
23318 | ||
23319 | @findex gdb.current_objfile | |
d812018b | 23320 | @defun gdb.current_objfile () |
89c73ade TT |
23321 | When auto-loading a Python script (@pxref{Auto-loading}), @value{GDBN} |
23322 | sets the ``current objfile'' to the corresponding objfile. This | |
23323 | function returns the current objfile. If there is no current objfile, | |
23324 | this function returns @code{None}. | |
23325 | @end defun | |
23326 | ||
23327 | @findex gdb.objfiles | |
d812018b | 23328 | @defun gdb.objfiles () |
89c73ade TT |
23329 | Return a sequence of all the objfiles current known to @value{GDBN}. |
23330 | @xref{Objfiles In Python}. | |
23331 | @end defun | |
23332 | ||
23333 | Each objfile is represented by an instance of the @code{gdb.Objfile} | |
23334 | class. | |
23335 | ||
d812018b | 23336 | @defvar Objfile.filename |
89c73ade | 23337 | The file name of the objfile as a string. |
d812018b | 23338 | @end defvar |
89c73ade | 23339 | |
d812018b | 23340 | @defvar Objfile.pretty_printers |
89c73ade TT |
23341 | The @code{pretty_printers} attribute is a list of functions. It is |
23342 | used to look up pretty-printers. A @code{Value} is passed to each | |
23343 | function in order; if the function returns @code{None}, then the | |
23344 | search continues. Otherwise, the return value should be an object | |
4c374409 | 23345 | which is used to format the value. @xref{Pretty Printing API}, for more |
a6bac58e | 23346 | information. |
d812018b | 23347 | @end defvar |
89c73ade | 23348 | |
29703da4 PM |
23349 | A @code{gdb.Objfile} object has the following methods: |
23350 | ||
d812018b | 23351 | @defun Objfile.is_valid () |
29703da4 PM |
23352 | Returns @code{True} if the @code{gdb.Objfile} object is valid, |
23353 | @code{False} if not. A @code{gdb.Objfile} object can become invalid | |
23354 | if the object file it refers to is not loaded in @value{GDBN} any | |
23355 | longer. All other @code{gdb.Objfile} methods will throw an exception | |
23356 | if it is invalid at the time the method is called. | |
d812018b | 23357 | @end defun |
29703da4 | 23358 | |
f8f6f20b | 23359 | @node Frames In Python |
f3e9a817 | 23360 | @subsubsection Accessing inferior stack frames from Python. |
f8f6f20b TJB |
23361 | |
23362 | @cindex frames in python | |
23363 | When the debugged program stops, @value{GDBN} is able to analyze its call | |
23364 | stack (@pxref{Frames,,Stack frames}). The @code{gdb.Frame} class | |
23365 | represents a frame in the stack. A @code{gdb.Frame} object is only valid | |
23366 | while its corresponding frame exists in the inferior's stack. If you try | |
621c8364 TT |
23367 | to use an invalid frame object, @value{GDBN} will throw a @code{gdb.error} |
23368 | exception (@pxref{Exception Handling}). | |
f8f6f20b TJB |
23369 | |
23370 | Two @code{gdb.Frame} objects can be compared for equality with the @code{==} | |
23371 | operator, like: | |
23372 | ||
23373 | @smallexample | |
23374 | (@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame () | |
23375 | True | |
23376 | @end smallexample | |
23377 | ||
23378 | The following frame-related functions are available in the @code{gdb} module: | |
23379 | ||
23380 | @findex gdb.selected_frame | |
d812018b | 23381 | @defun gdb.selected_frame () |
f8f6f20b TJB |
23382 | Return the selected frame object. (@pxref{Selection,,Selecting a Frame}). |
23383 | @end defun | |
23384 | ||
d8e22779 | 23385 | @findex gdb.newest_frame |
d812018b | 23386 | @defun gdb.newest_frame () |
d8e22779 TT |
23387 | Return the newest frame object for the selected thread. |
23388 | @end defun | |
23389 | ||
d812018b | 23390 | @defun gdb.frame_stop_reason_string (reason) |
f8f6f20b TJB |
23391 | Return a string explaining the reason why @value{GDBN} stopped unwinding |
23392 | frames, as expressed by the given @var{reason} code (an integer, see the | |
23393 | @code{unwind_stop_reason} method further down in this section). | |
23394 | @end defun | |
23395 | ||
23396 | A @code{gdb.Frame} object has the following methods: | |
23397 | ||
23398 | @table @code | |
d812018b | 23399 | @defun Frame.is_valid () |
f8f6f20b TJB |
23400 | Returns true if the @code{gdb.Frame} object is valid, false if not. |
23401 | A frame object can become invalid if the frame it refers to doesn't | |
23402 | exist anymore in the inferior. All @code{gdb.Frame} methods will throw | |
23403 | an exception if it is invalid at the time the method is called. | |
d812018b | 23404 | @end defun |
f8f6f20b | 23405 | |
d812018b | 23406 | @defun Frame.name () |
f8f6f20b TJB |
23407 | Returns the function name of the frame, or @code{None} if it can't be |
23408 | obtained. | |
d812018b | 23409 | @end defun |
f8f6f20b | 23410 | |
d812018b | 23411 | @defun Frame.type () |
ccfc3d6e TT |
23412 | Returns the type of the frame. The value can be one of: |
23413 | @table @code | |
23414 | @item gdb.NORMAL_FRAME | |
23415 | An ordinary stack frame. | |
23416 | ||
23417 | @item gdb.DUMMY_FRAME | |
23418 | A fake stack frame that was created by @value{GDBN} when performing an | |
23419 | inferior function call. | |
23420 | ||
23421 | @item gdb.INLINE_FRAME | |
23422 | A frame representing an inlined function. The function was inlined | |
23423 | into a @code{gdb.NORMAL_FRAME} that is older than this one. | |
23424 | ||
111c6489 JK |
23425 | @item gdb.TAILCALL_FRAME |
23426 | A frame representing a tail call. @xref{Tail Call Frames}. | |
23427 | ||
ccfc3d6e TT |
23428 | @item gdb.SIGTRAMP_FRAME |
23429 | A signal trampoline frame. This is the frame created by the OS when | |
23430 | it calls into a signal handler. | |
23431 | ||
23432 | @item gdb.ARCH_FRAME | |
23433 | A fake stack frame representing a cross-architecture call. | |
23434 | ||
23435 | @item gdb.SENTINEL_FRAME | |
23436 | This is like @code{gdb.NORMAL_FRAME}, but it is only used for the | |
23437 | newest frame. | |
23438 | @end table | |
d812018b | 23439 | @end defun |
f8f6f20b | 23440 | |
d812018b | 23441 | @defun Frame.unwind_stop_reason () |
f8f6f20b TJB |
23442 | Return an integer representing the reason why it's not possible to find |
23443 | more frames toward the outermost frame. Use | |
23444 | @code{gdb.frame_stop_reason_string} to convert the value returned by this | |
a7fc3f37 KP |
23445 | function to a string. The value can be one of: |
23446 | ||
23447 | @table @code | |
23448 | @item gdb.FRAME_UNWIND_NO_REASON | |
23449 | No particular reason (older frames should be available). | |
23450 | ||
23451 | @item gdb.FRAME_UNWIND_NULL_ID | |
23452 | The previous frame's analyzer returns an invalid result. | |
23453 | ||
23454 | @item gdb.FRAME_UNWIND_OUTERMOST | |
23455 | This frame is the outermost. | |
23456 | ||
23457 | @item gdb.FRAME_UNWIND_UNAVAILABLE | |
23458 | Cannot unwind further, because that would require knowing the | |
23459 | values of registers or memory that have not been collected. | |
23460 | ||
23461 | @item gdb.FRAME_UNWIND_INNER_ID | |
23462 | This frame ID looks like it ought to belong to a NEXT frame, | |
23463 | but we got it for a PREV frame. Normally, this is a sign of | |
23464 | unwinder failure. It could also indicate stack corruption. | |
23465 | ||
23466 | @item gdb.FRAME_UNWIND_SAME_ID | |
23467 | This frame has the same ID as the previous one. That means | |
23468 | that unwinding further would almost certainly give us another | |
23469 | frame with exactly the same ID, so break the chain. Normally, | |
23470 | this is a sign of unwinder failure. It could also indicate | |
23471 | stack corruption. | |
23472 | ||
23473 | @item gdb.FRAME_UNWIND_NO_SAVED_PC | |
23474 | The frame unwinder did not find any saved PC, but we needed | |
23475 | one to unwind further. | |
2231f1fb KP |
23476 | |
23477 | @item gdb.FRAME_UNWIND_FIRST_ERROR | |
23478 | Any stop reason greater or equal to this value indicates some kind | |
23479 | of error. This special value facilitates writing code that tests | |
23480 | for errors in unwinding in a way that will work correctly even if | |
23481 | the list of the other values is modified in future @value{GDBN} | |
23482 | versions. Using it, you could write: | |
23483 | @smallexample | |
23484 | reason = gdb.selected_frame().unwind_stop_reason () | |
23485 | reason_str = gdb.frame_stop_reason_string (reason) | |
23486 | if reason >= gdb.FRAME_UNWIND_FIRST_ERROR: | |
23487 | print "An error occured: %s" % reason_str | |
23488 | @end smallexample | |
a7fc3f37 KP |
23489 | @end table |
23490 | ||
d812018b | 23491 | @end defun |
f8f6f20b | 23492 | |
d812018b | 23493 | @defun Frame.pc () |
f8f6f20b | 23494 | Returns the frame's resume address. |
d812018b | 23495 | @end defun |
f8f6f20b | 23496 | |
d812018b | 23497 | @defun Frame.block () |
f3e9a817 | 23498 | Return the frame's code block. @xref{Blocks In Python}. |
d812018b | 23499 | @end defun |
f3e9a817 | 23500 | |
d812018b | 23501 | @defun Frame.function () |
f3e9a817 PM |
23502 | Return the symbol for the function corresponding to this frame. |
23503 | @xref{Symbols In Python}. | |
d812018b | 23504 | @end defun |
f3e9a817 | 23505 | |
d812018b | 23506 | @defun Frame.older () |
f8f6f20b | 23507 | Return the frame that called this frame. |
d812018b | 23508 | @end defun |
f8f6f20b | 23509 | |
d812018b | 23510 | @defun Frame.newer () |
f8f6f20b | 23511 | Return the frame called by this frame. |
d812018b | 23512 | @end defun |
f8f6f20b | 23513 | |
d812018b | 23514 | @defun Frame.find_sal () |
f3e9a817 PM |
23515 | Return the frame's symtab and line object. |
23516 | @xref{Symbol Tables In Python}. | |
d812018b | 23517 | @end defun |
f3e9a817 | 23518 | |
d812018b | 23519 | @defun Frame.read_var (variable @r{[}, block@r{]}) |
dc00d89f PM |
23520 | Return the value of @var{variable} in this frame. If the optional |
23521 | argument @var{block} is provided, search for the variable from that | |
23522 | block; otherwise start at the frame's current block (which is | |
23523 | determined by the frame's current program counter). @var{variable} | |
23524 | must be a string or a @code{gdb.Symbol} object. @var{block} must be a | |
23525 | @code{gdb.Block} object. | |
d812018b | 23526 | @end defun |
f3e9a817 | 23527 | |
d812018b | 23528 | @defun Frame.select () |
f3e9a817 PM |
23529 | Set this frame to be the selected frame. @xref{Stack, ,Examining the |
23530 | Stack}. | |
d812018b | 23531 | @end defun |
f3e9a817 PM |
23532 | @end table |
23533 | ||
23534 | @node Blocks In Python | |
23535 | @subsubsection Accessing frame blocks from Python. | |
23536 | ||
23537 | @cindex blocks in python | |
23538 | @tindex gdb.Block | |
23539 | ||
23540 | Within each frame, @value{GDBN} maintains information on each block | |
23541 | stored in that frame. These blocks are organized hierarchically, and | |
23542 | are represented individually in Python as a @code{gdb.Block}. | |
23543 | Please see @ref{Frames In Python}, for a more in-depth discussion on | |
23544 | frames. Furthermore, see @ref{Stack, ,Examining the Stack}, for more | |
23545 | detailed technical information on @value{GDBN}'s book-keeping of the | |
23546 | stack. | |
23547 | ||
23548 | The following block-related functions are available in the @code{gdb} | |
23549 | module: | |
23550 | ||
23551 | @findex gdb.block_for_pc | |
d812018b | 23552 | @defun gdb.block_for_pc (pc) |
f3e9a817 PM |
23553 | Return the @code{gdb.Block} containing the given @var{pc} value. If the |
23554 | block cannot be found for the @var{pc} value specified, the function | |
23555 | will return @code{None}. | |
23556 | @end defun | |
23557 | ||
29703da4 PM |
23558 | A @code{gdb.Block} object has the following methods: |
23559 | ||
23560 | @table @code | |
d812018b | 23561 | @defun Block.is_valid () |
29703da4 PM |
23562 | Returns @code{True} if the @code{gdb.Block} object is valid, |
23563 | @code{False} if not. A block object can become invalid if the block it | |
23564 | refers to doesn't exist anymore in the inferior. All other | |
23565 | @code{gdb.Block} methods will throw an exception if it is invalid at | |
23566 | the time the method is called. This method is also made available to | |
23567 | the Python iterator object that @code{gdb.Block} provides in an iteration | |
23568 | context and via the Python @code{iter} built-in function. | |
d812018b | 23569 | @end defun |
29703da4 PM |
23570 | @end table |
23571 | ||
f3e9a817 PM |
23572 | A @code{gdb.Block} object has the following attributes: |
23573 | ||
23574 | @table @code | |
d812018b | 23575 | @defvar Block.start |
f3e9a817 | 23576 | The start address of the block. This attribute is not writable. |
d812018b | 23577 | @end defvar |
f3e9a817 | 23578 | |
d812018b | 23579 | @defvar Block.end |
f3e9a817 | 23580 | The end address of the block. This attribute is not writable. |
d812018b | 23581 | @end defvar |
f3e9a817 | 23582 | |
d812018b | 23583 | @defvar Block.function |
f3e9a817 PM |
23584 | The name of the block represented as a @code{gdb.Symbol}. If the |
23585 | block is not named, then this attribute holds @code{None}. This | |
23586 | attribute is not writable. | |
d812018b | 23587 | @end defvar |
f3e9a817 | 23588 | |
d812018b | 23589 | @defvar Block.superblock |
f3e9a817 PM |
23590 | The block containing this block. If this parent block does not exist, |
23591 | this attribute holds @code{None}. This attribute is not writable. | |
d812018b | 23592 | @end defvar |
9df2fbc4 PM |
23593 | |
23594 | @defvar Block.global_block | |
23595 | The global block associated with this block. This attribute is not | |
23596 | writable. | |
23597 | @end defvar | |
23598 | ||
23599 | @defvar Block.static_block | |
23600 | The static block associated with this block. This attribute is not | |
23601 | writable. | |
23602 | @end defvar | |
23603 | ||
23604 | @defvar Block.is_global | |
23605 | @code{True} if the @code{gdb.Block} object is a global block, | |
23606 | @code{False} if not. This attribute is not | |
23607 | writable. | |
23608 | @end defvar | |
23609 | ||
23610 | @defvar Block.is_static | |
23611 | @code{True} if the @code{gdb.Block} object is a static block, | |
23612 | @code{False} if not. This attribute is not writable. | |
23613 | @end defvar | |
f3e9a817 PM |
23614 | @end table |
23615 | ||
23616 | @node Symbols In Python | |
23617 | @subsubsection Python representation of Symbols. | |
23618 | ||
23619 | @cindex symbols in python | |
23620 | @tindex gdb.Symbol | |
23621 | ||
23622 | @value{GDBN} represents every variable, function and type as an | |
23623 | entry in a symbol table. @xref{Symbols, ,Examining the Symbol Table}. | |
23624 | Similarly, Python represents these symbols in @value{GDBN} with the | |
23625 | @code{gdb.Symbol} object. | |
23626 | ||
23627 | The following symbol-related functions are available in the @code{gdb} | |
23628 | module: | |
23629 | ||
23630 | @findex gdb.lookup_symbol | |
d812018b | 23631 | @defun gdb.lookup_symbol (name @r{[}, block @r{[}, domain@r{]]}) |
f3e9a817 PM |
23632 | This function searches for a symbol by name. The search scope can be |
23633 | restricted to the parameters defined in the optional domain and block | |
23634 | arguments. | |
23635 | ||
23636 | @var{name} is the name of the symbol. It must be a string. The | |
23637 | optional @var{block} argument restricts the search to symbols visible | |
23638 | in that @var{block}. The @var{block} argument must be a | |
6e6fbe60 DE |
23639 | @code{gdb.Block} object. If omitted, the block for the current frame |
23640 | is used. The optional @var{domain} argument restricts | |
f3e9a817 PM |
23641 | the search to the domain type. The @var{domain} argument must be a |
23642 | domain constant defined in the @code{gdb} module and described later | |
23643 | in this chapter. | |
6e6fbe60 DE |
23644 | |
23645 | The result is a tuple of two elements. | |
23646 | The first element is a @code{gdb.Symbol} object or @code{None} if the symbol | |
23647 | is not found. | |
23648 | If the symbol is found, the second element is @code{True} if the symbol | |
82809774 | 23649 | is a field of a method's object (e.g., @code{this} in C@t{++}), |
6e6fbe60 DE |
23650 | otherwise it is @code{False}. |
23651 | If the symbol is not found, the second element is @code{False}. | |
23652 | @end defun | |
23653 | ||
23654 | @findex gdb.lookup_global_symbol | |
d812018b | 23655 | @defun gdb.lookup_global_symbol (name @r{[}, domain@r{]}) |
6e6fbe60 DE |
23656 | This function searches for a global symbol by name. |
23657 | The search scope can be restricted to by the domain argument. | |
23658 | ||
23659 | @var{name} is the name of the symbol. It must be a string. | |
23660 | The optional @var{domain} argument restricts the search to the domain type. | |
23661 | The @var{domain} argument must be a domain constant defined in the @code{gdb} | |
23662 | module and described later in this chapter. | |
23663 | ||
23664 | The result is a @code{gdb.Symbol} object or @code{None} if the symbol | |
23665 | is not found. | |
f3e9a817 PM |
23666 | @end defun |
23667 | ||
23668 | A @code{gdb.Symbol} object has the following attributes: | |
23669 | ||
23670 | @table @code | |
d812018b | 23671 | @defvar Symbol.type |
457e09f0 DE |
23672 | The type of the symbol or @code{None} if no type is recorded. |
23673 | This attribute is represented as a @code{gdb.Type} object. | |
23674 | @xref{Types In Python}. This attribute is not writable. | |
d812018b | 23675 | @end defvar |
457e09f0 | 23676 | |
d812018b | 23677 | @defvar Symbol.symtab |
f3e9a817 PM |
23678 | The symbol table in which the symbol appears. This attribute is |
23679 | represented as a @code{gdb.Symtab} object. @xref{Symbol Tables In | |
23680 | Python}. This attribute is not writable. | |
d812018b | 23681 | @end defvar |
f3e9a817 | 23682 | |
d812018b | 23683 | @defvar Symbol.name |
f3e9a817 | 23684 | The name of the symbol as a string. This attribute is not writable. |
d812018b | 23685 | @end defvar |
f3e9a817 | 23686 | |
d812018b | 23687 | @defvar Symbol.linkage_name |
f3e9a817 PM |
23688 | The name of the symbol, as used by the linker (i.e., may be mangled). |
23689 | This attribute is not writable. | |
d812018b | 23690 | @end defvar |
f3e9a817 | 23691 | |
d812018b | 23692 | @defvar Symbol.print_name |
f3e9a817 PM |
23693 | The name of the symbol in a form suitable for output. This is either |
23694 | @code{name} or @code{linkage_name}, depending on whether the user | |
23695 | asked @value{GDBN} to display demangled or mangled names. | |
d812018b | 23696 | @end defvar |
f3e9a817 | 23697 | |
d812018b | 23698 | @defvar Symbol.addr_class |
f3e9a817 PM |
23699 | The address class of the symbol. This classifies how to find the value |
23700 | of a symbol. Each address class is a constant defined in the | |
23701 | @code{gdb} module and described later in this chapter. | |
d812018b | 23702 | @end defvar |
f3e9a817 | 23703 | |
d812018b | 23704 | @defvar Symbol.is_argument |
f3e9a817 | 23705 | @code{True} if the symbol is an argument of a function. |
d812018b | 23706 | @end defvar |
f3e9a817 | 23707 | |
d812018b | 23708 | @defvar Symbol.is_constant |
f3e9a817 | 23709 | @code{True} if the symbol is a constant. |
d812018b | 23710 | @end defvar |
f3e9a817 | 23711 | |
d812018b | 23712 | @defvar Symbol.is_function |
f3e9a817 | 23713 | @code{True} if the symbol is a function or a method. |
d812018b | 23714 | @end defvar |
f3e9a817 | 23715 | |
d812018b | 23716 | @defvar Symbol.is_variable |
f3e9a817 | 23717 | @code{True} if the symbol is a variable. |
d812018b | 23718 | @end defvar |
f3e9a817 PM |
23719 | @end table |
23720 | ||
29703da4 PM |
23721 | A @code{gdb.Symbol} object has the following methods: |
23722 | ||
23723 | @table @code | |
d812018b | 23724 | @defun Symbol.is_valid () |
29703da4 PM |
23725 | Returns @code{True} if the @code{gdb.Symbol} object is valid, |
23726 | @code{False} if not. A @code{gdb.Symbol} object can become invalid if | |
23727 | the symbol it refers to does not exist in @value{GDBN} any longer. | |
23728 | All other @code{gdb.Symbol} methods will throw an exception if it is | |
23729 | invalid at the time the method is called. | |
d812018b | 23730 | @end defun |
29703da4 PM |
23731 | @end table |
23732 | ||
f3e9a817 PM |
23733 | The available domain categories in @code{gdb.Symbol} are represented |
23734 | as constants in the @code{gdb} module: | |
23735 | ||
23736 | @table @code | |
23737 | @findex SYMBOL_UNDEF_DOMAIN | |
23738 | @findex gdb.SYMBOL_UNDEF_DOMAIN | |
d812018b | 23739 | @item gdb.SYMBOL_UNDEF_DOMAIN |
f3e9a817 PM |
23740 | This is used when a domain has not been discovered or none of the |
23741 | following domains apply. This usually indicates an error either | |
23742 | in the symbol information or in @value{GDBN}'s handling of symbols. | |
23743 | @findex SYMBOL_VAR_DOMAIN | |
23744 | @findex gdb.SYMBOL_VAR_DOMAIN | |
d812018b | 23745 | @item gdb.SYMBOL_VAR_DOMAIN |
f3e9a817 PM |
23746 | This domain contains variables, function names, typedef names and enum |
23747 | type values. | |
23748 | @findex SYMBOL_STRUCT_DOMAIN | |
23749 | @findex gdb.SYMBOL_STRUCT_DOMAIN | |
d812018b | 23750 | @item gdb.SYMBOL_STRUCT_DOMAIN |
f3e9a817 PM |
23751 | This domain holds struct, union and enum type names. |
23752 | @findex SYMBOL_LABEL_DOMAIN | |
23753 | @findex gdb.SYMBOL_LABEL_DOMAIN | |
d812018b | 23754 | @item gdb.SYMBOL_LABEL_DOMAIN |
f3e9a817 PM |
23755 | This domain contains names of labels (for gotos). |
23756 | @findex SYMBOL_VARIABLES_DOMAIN | |
23757 | @findex gdb.SYMBOL_VARIABLES_DOMAIN | |
d812018b | 23758 | @item gdb.SYMBOL_VARIABLES_DOMAIN |
f3e9a817 PM |
23759 | This domain holds a subset of the @code{SYMBOLS_VAR_DOMAIN}; it |
23760 | contains everything minus functions and types. | |
23761 | @findex SYMBOL_FUNCTIONS_DOMAIN | |
23762 | @findex gdb.SYMBOL_FUNCTIONS_DOMAIN | |
d812018b | 23763 | @item gdb.SYMBOL_FUNCTION_DOMAIN |
f3e9a817 PM |
23764 | This domain contains all functions. |
23765 | @findex SYMBOL_TYPES_DOMAIN | |
23766 | @findex gdb.SYMBOL_TYPES_DOMAIN | |
d812018b | 23767 | @item gdb.SYMBOL_TYPES_DOMAIN |
f3e9a817 PM |
23768 | This domain contains all types. |
23769 | @end table | |
23770 | ||
23771 | The available address class categories in @code{gdb.Symbol} are represented | |
23772 | as constants in the @code{gdb} module: | |
23773 | ||
23774 | @table @code | |
23775 | @findex SYMBOL_LOC_UNDEF | |
23776 | @findex gdb.SYMBOL_LOC_UNDEF | |
d812018b | 23777 | @item gdb.SYMBOL_LOC_UNDEF |
f3e9a817 PM |
23778 | If this is returned by address class, it indicates an error either in |
23779 | the symbol information or in @value{GDBN}'s handling of symbols. | |
23780 | @findex SYMBOL_LOC_CONST | |
23781 | @findex gdb.SYMBOL_LOC_CONST | |
d812018b | 23782 | @item gdb.SYMBOL_LOC_CONST |
f3e9a817 PM |
23783 | Value is constant int. |
23784 | @findex SYMBOL_LOC_STATIC | |
23785 | @findex gdb.SYMBOL_LOC_STATIC | |
d812018b | 23786 | @item gdb.SYMBOL_LOC_STATIC |
f3e9a817 PM |
23787 | Value is at a fixed address. |
23788 | @findex SYMBOL_LOC_REGISTER | |
23789 | @findex gdb.SYMBOL_LOC_REGISTER | |
d812018b | 23790 | @item gdb.SYMBOL_LOC_REGISTER |
f3e9a817 PM |
23791 | Value is in a register. |
23792 | @findex SYMBOL_LOC_ARG | |
23793 | @findex gdb.SYMBOL_LOC_ARG | |
d812018b | 23794 | @item gdb.SYMBOL_LOC_ARG |
f3e9a817 PM |
23795 | Value is an argument. This value is at the offset stored within the |
23796 | symbol inside the frame's argument list. | |
23797 | @findex SYMBOL_LOC_REF_ARG | |
23798 | @findex gdb.SYMBOL_LOC_REF_ARG | |
d812018b | 23799 | @item gdb.SYMBOL_LOC_REF_ARG |
f3e9a817 PM |
23800 | Value address is stored in the frame's argument list. Just like |
23801 | @code{LOC_ARG} except that the value's address is stored at the | |
23802 | offset, not the value itself. | |
23803 | @findex SYMBOL_LOC_REGPARM_ADDR | |
23804 | @findex gdb.SYMBOL_LOC_REGPARM_ADDR | |
d812018b | 23805 | @item gdb.SYMBOL_LOC_REGPARM_ADDR |
f3e9a817 PM |
23806 | Value is a specified register. Just like @code{LOC_REGISTER} except |
23807 | the register holds the address of the argument instead of the argument | |
23808 | itself. | |
23809 | @findex SYMBOL_LOC_LOCAL | |
23810 | @findex gdb.SYMBOL_LOC_LOCAL | |
d812018b | 23811 | @item gdb.SYMBOL_LOC_LOCAL |
f3e9a817 PM |
23812 | Value is a local variable. |
23813 | @findex SYMBOL_LOC_TYPEDEF | |
23814 | @findex gdb.SYMBOL_LOC_TYPEDEF | |
d812018b | 23815 | @item gdb.SYMBOL_LOC_TYPEDEF |
f3e9a817 PM |
23816 | Value not used. Symbols in the domain @code{SYMBOL_STRUCT_DOMAIN} all |
23817 | have this class. | |
23818 | @findex SYMBOL_LOC_BLOCK | |
23819 | @findex gdb.SYMBOL_LOC_BLOCK | |
d812018b | 23820 | @item gdb.SYMBOL_LOC_BLOCK |
f3e9a817 PM |
23821 | Value is a block. |
23822 | @findex SYMBOL_LOC_CONST_BYTES | |
23823 | @findex gdb.SYMBOL_LOC_CONST_BYTES | |
d812018b | 23824 | @item gdb.SYMBOL_LOC_CONST_BYTES |
f3e9a817 PM |
23825 | Value is a byte-sequence. |
23826 | @findex SYMBOL_LOC_UNRESOLVED | |
23827 | @findex gdb.SYMBOL_LOC_UNRESOLVED | |
d812018b | 23828 | @item gdb.SYMBOL_LOC_UNRESOLVED |
f3e9a817 PM |
23829 | Value is at a fixed address, but the address of the variable has to be |
23830 | determined from the minimal symbol table whenever the variable is | |
23831 | referenced. | |
23832 | @findex SYMBOL_LOC_OPTIMIZED_OUT | |
23833 | @findex gdb.SYMBOL_LOC_OPTIMIZED_OUT | |
d812018b | 23834 | @item gdb.SYMBOL_LOC_OPTIMIZED_OUT |
f3e9a817 PM |
23835 | The value does not actually exist in the program. |
23836 | @findex SYMBOL_LOC_COMPUTED | |
23837 | @findex gdb.SYMBOL_LOC_COMPUTED | |
d812018b | 23838 | @item gdb.SYMBOL_LOC_COMPUTED |
f3e9a817 PM |
23839 | The value's address is a computed location. |
23840 | @end table | |
23841 | ||
23842 | @node Symbol Tables In Python | |
23843 | @subsubsection Symbol table representation in Python. | |
23844 | ||
23845 | @cindex symbol tables in python | |
23846 | @tindex gdb.Symtab | |
23847 | @tindex gdb.Symtab_and_line | |
23848 | ||
23849 | Access to symbol table data maintained by @value{GDBN} on the inferior | |
23850 | is exposed to Python via two objects: @code{gdb.Symtab_and_line} and | |
23851 | @code{gdb.Symtab}. Symbol table and line data for a frame is returned | |
23852 | from the @code{find_sal} method in @code{gdb.Frame} object. | |
23853 | @xref{Frames In Python}. | |
23854 | ||
23855 | For more information on @value{GDBN}'s symbol table management, see | |
23856 | @ref{Symbols, ,Examining the Symbol Table}, for more information. | |
23857 | ||
23858 | A @code{gdb.Symtab_and_line} object has the following attributes: | |
23859 | ||
23860 | @table @code | |
d812018b | 23861 | @defvar Symtab_and_line.symtab |
f3e9a817 PM |
23862 | The symbol table object (@code{gdb.Symtab}) for this frame. |
23863 | This attribute is not writable. | |
d812018b | 23864 | @end defvar |
f3e9a817 | 23865 | |
d812018b | 23866 | @defvar Symtab_and_line.pc |
f3e9a817 PM |
23867 | Indicates the current program counter address. This attribute is not |
23868 | writable. | |
d812018b | 23869 | @end defvar |
f3e9a817 | 23870 | |
d812018b | 23871 | @defvar Symtab_and_line.line |
f3e9a817 PM |
23872 | Indicates the current line number for this object. This |
23873 | attribute is not writable. | |
d812018b | 23874 | @end defvar |
f3e9a817 PM |
23875 | @end table |
23876 | ||
29703da4 PM |
23877 | A @code{gdb.Symtab_and_line} object has the following methods: |
23878 | ||
23879 | @table @code | |
d812018b | 23880 | @defun Symtab_and_line.is_valid () |
29703da4 PM |
23881 | Returns @code{True} if the @code{gdb.Symtab_and_line} object is valid, |
23882 | @code{False} if not. A @code{gdb.Symtab_and_line} object can become | |
23883 | invalid if the Symbol table and line object it refers to does not | |
23884 | exist in @value{GDBN} any longer. All other | |
23885 | @code{gdb.Symtab_and_line} methods will throw an exception if it is | |
23886 | invalid at the time the method is called. | |
d812018b | 23887 | @end defun |
29703da4 PM |
23888 | @end table |
23889 | ||
f3e9a817 PM |
23890 | A @code{gdb.Symtab} object has the following attributes: |
23891 | ||
23892 | @table @code | |
d812018b | 23893 | @defvar Symtab.filename |
f3e9a817 | 23894 | The symbol table's source filename. This attribute is not writable. |
d812018b | 23895 | @end defvar |
f3e9a817 | 23896 | |
d812018b | 23897 | @defvar Symtab.objfile |
f3e9a817 PM |
23898 | The symbol table's backing object file. @xref{Objfiles In Python}. |
23899 | This attribute is not writable. | |
d812018b | 23900 | @end defvar |
f3e9a817 PM |
23901 | @end table |
23902 | ||
29703da4 | 23903 | A @code{gdb.Symtab} object has the following methods: |
f3e9a817 PM |
23904 | |
23905 | @table @code | |
d812018b | 23906 | @defun Symtab.is_valid () |
29703da4 PM |
23907 | Returns @code{True} if the @code{gdb.Symtab} object is valid, |
23908 | @code{False} if not. A @code{gdb.Symtab} object can become invalid if | |
23909 | the symbol table it refers to does not exist in @value{GDBN} any | |
23910 | longer. All other @code{gdb.Symtab} methods will throw an exception | |
23911 | if it is invalid at the time the method is called. | |
d812018b | 23912 | @end defun |
29703da4 | 23913 | |
d812018b | 23914 | @defun Symtab.fullname () |
f3e9a817 | 23915 | Return the symbol table's source absolute file name. |
d812018b | 23916 | @end defun |
f8f6f20b TJB |
23917 | @end table |
23918 | ||
adc36818 PM |
23919 | @node Breakpoints In Python |
23920 | @subsubsection Manipulating breakpoints using Python | |
23921 | ||
23922 | @cindex breakpoints in python | |
23923 | @tindex gdb.Breakpoint | |
23924 | ||
23925 | Python code can manipulate breakpoints via the @code{gdb.Breakpoint} | |
23926 | class. | |
23927 | ||
d812018b | 23928 | @defun Breakpoint.__init__ (spec @r{[}, type @r{[}, wp_class @r{[},internal@r{]]]}) |
adc36818 PM |
23929 | Create a new breakpoint. @var{spec} is a string naming the |
23930 | location of the breakpoint, or an expression that defines a | |
23931 | watchpoint. The contents can be any location recognized by the | |
23932 | @code{break} command, or in the case of a watchpoint, by the @code{watch} | |
23933 | command. The optional @var{type} denotes the breakpoint to create | |
23934 | from the types defined later in this chapter. This argument can be | |
d812018b PK |
23935 | either: @code{gdb.BP_BREAKPOINT} or @code{gdb.BP_WATCHPOINT}. @var{type} |
23936 | defaults to @code{gdb.BP_BREAKPOINT}. The optional @var{internal} argument | |
84f4c1fe PM |
23937 | allows the breakpoint to become invisible to the user. The breakpoint |
23938 | will neither be reported when created, nor will it be listed in the | |
23939 | output from @code{info breakpoints} (but will be listed with the | |
23940 | @code{maint info breakpoints} command). The optional @var{wp_class} | |
adc36818 | 23941 | argument defines the class of watchpoint to create, if @var{type} is |
d812018b PK |
23942 | @code{gdb.BP_WATCHPOINT}. If a watchpoint class is not provided, it is |
23943 | assumed to be a @code{gdb.WP_WRITE} class. | |
23944 | @end defun | |
adc36818 | 23945 | |
d812018b | 23946 | @defun Breakpoint.stop (self) |
7371cf6d PM |
23947 | The @code{gdb.Breakpoint} class can be sub-classed and, in |
23948 | particular, you may choose to implement the @code{stop} method. | |
23949 | If this method is defined as a sub-class of @code{gdb.Breakpoint}, | |
23950 | it will be called when the inferior reaches any location of a | |
23951 | breakpoint which instantiates that sub-class. If the method returns | |
23952 | @code{True}, the inferior will be stopped at the location of the | |
23953 | breakpoint, otherwise the inferior will continue. | |
23954 | ||
23955 | If there are multiple breakpoints at the same location with a | |
23956 | @code{stop} method, each one will be called regardless of the | |
23957 | return status of the previous. This ensures that all @code{stop} | |
23958 | methods have a chance to execute at that location. In this scenario | |
23959 | if one of the methods returns @code{True} but the others return | |
23960 | @code{False}, the inferior will still be stopped. | |
23961 | ||
99f5279d PM |
23962 | You should not alter the execution state of the inferior (i.e.@:, step, |
23963 | next, etc.), alter the current frame context (i.e.@:, change the current | |
23964 | active frame), or alter, add or delete any breakpoint. As a general | |
23965 | rule, you should not alter any data within @value{GDBN} or the inferior | |
23966 | at this time. | |
23967 | ||
7371cf6d PM |
23968 | Example @code{stop} implementation: |
23969 | ||
23970 | @smallexample | |
23971 | class MyBreakpoint (gdb.Breakpoint): | |
23972 | def stop (self): | |
23973 | inf_val = gdb.parse_and_eval("foo") | |
23974 | if inf_val == 3: | |
23975 | return True | |
23976 | return False | |
23977 | @end smallexample | |
d812018b | 23978 | @end defun |
7371cf6d | 23979 | |
adc36818 PM |
23980 | The available watchpoint types represented by constants are defined in the |
23981 | @code{gdb} module: | |
23982 | ||
23983 | @table @code | |
23984 | @findex WP_READ | |
23985 | @findex gdb.WP_READ | |
d812018b | 23986 | @item gdb.WP_READ |
adc36818 PM |
23987 | Read only watchpoint. |
23988 | ||
23989 | @findex WP_WRITE | |
23990 | @findex gdb.WP_WRITE | |
d812018b | 23991 | @item gdb.WP_WRITE |
adc36818 PM |
23992 | Write only watchpoint. |
23993 | ||
23994 | @findex WP_ACCESS | |
23995 | @findex gdb.WP_ACCESS | |
d812018b | 23996 | @item gdb.WP_ACCESS |
adc36818 PM |
23997 | Read/Write watchpoint. |
23998 | @end table | |
23999 | ||
d812018b | 24000 | @defun Breakpoint.is_valid () |
adc36818 PM |
24001 | Return @code{True} if this @code{Breakpoint} object is valid, |
24002 | @code{False} otherwise. A @code{Breakpoint} object can become invalid | |
24003 | if the user deletes the breakpoint. In this case, the object still | |
24004 | exists, but the underlying breakpoint does not. In the cases of | |
24005 | watchpoint scope, the watchpoint remains valid even if execution of the | |
24006 | inferior leaves the scope of that watchpoint. | |
d812018b | 24007 | @end defun |
adc36818 | 24008 | |
d812018b | 24009 | @defun Breakpoint.delete |
94b6973e PM |
24010 | Permanently deletes the @value{GDBN} breakpoint. This also |
24011 | invalidates the Python @code{Breakpoint} object. Any further access | |
24012 | to this object's attributes or methods will raise an error. | |
d812018b | 24013 | @end defun |
94b6973e | 24014 | |
d812018b | 24015 | @defvar Breakpoint.enabled |
adc36818 PM |
24016 | This attribute is @code{True} if the breakpoint is enabled, and |
24017 | @code{False} otherwise. This attribute is writable. | |
d812018b | 24018 | @end defvar |
adc36818 | 24019 | |
d812018b | 24020 | @defvar Breakpoint.silent |
adc36818 PM |
24021 | This attribute is @code{True} if the breakpoint is silent, and |
24022 | @code{False} otherwise. This attribute is writable. | |
24023 | ||
24024 | Note that a breakpoint can also be silent if it has commands and the | |
24025 | first command is @code{silent}. This is not reported by the | |
24026 | @code{silent} attribute. | |
d812018b | 24027 | @end defvar |
adc36818 | 24028 | |
d812018b | 24029 | @defvar Breakpoint.thread |
adc36818 PM |
24030 | If the breakpoint is thread-specific, this attribute holds the thread |
24031 | id. If the breakpoint is not thread-specific, this attribute is | |
24032 | @code{None}. This attribute is writable. | |
d812018b | 24033 | @end defvar |
adc36818 | 24034 | |
d812018b | 24035 | @defvar Breakpoint.task |
adc36818 PM |
24036 | If the breakpoint is Ada task-specific, this attribute holds the Ada task |
24037 | id. If the breakpoint is not task-specific (or the underlying | |
24038 | language is not Ada), this attribute is @code{None}. This attribute | |
24039 | is writable. | |
d812018b | 24040 | @end defvar |
adc36818 | 24041 | |
d812018b | 24042 | @defvar Breakpoint.ignore_count |
adc36818 PM |
24043 | This attribute holds the ignore count for the breakpoint, an integer. |
24044 | This attribute is writable. | |
d812018b | 24045 | @end defvar |
adc36818 | 24046 | |
d812018b | 24047 | @defvar Breakpoint.number |
adc36818 PM |
24048 | This attribute holds the breakpoint's number --- the identifier used by |
24049 | the user to manipulate the breakpoint. This attribute is not writable. | |
d812018b | 24050 | @end defvar |
adc36818 | 24051 | |
d812018b | 24052 | @defvar Breakpoint.type |
adc36818 PM |
24053 | This attribute holds the breakpoint's type --- the identifier used to |
24054 | determine the actual breakpoint type or use-case. This attribute is not | |
24055 | writable. | |
d812018b | 24056 | @end defvar |
adc36818 | 24057 | |
d812018b | 24058 | @defvar Breakpoint.visible |
84f4c1fe PM |
24059 | This attribute tells whether the breakpoint is visible to the user |
24060 | when set, or when the @samp{info breakpoints} command is run. This | |
24061 | attribute is not writable. | |
d812018b | 24062 | @end defvar |
84f4c1fe | 24063 | |
adc36818 PM |
24064 | The available types are represented by constants defined in the @code{gdb} |
24065 | module: | |
24066 | ||
24067 | @table @code | |
24068 | @findex BP_BREAKPOINT | |
24069 | @findex gdb.BP_BREAKPOINT | |
d812018b | 24070 | @item gdb.BP_BREAKPOINT |
adc36818 PM |
24071 | Normal code breakpoint. |
24072 | ||
24073 | @findex BP_WATCHPOINT | |
24074 | @findex gdb.BP_WATCHPOINT | |
d812018b | 24075 | @item gdb.BP_WATCHPOINT |
adc36818 PM |
24076 | Watchpoint breakpoint. |
24077 | ||
24078 | @findex BP_HARDWARE_WATCHPOINT | |
24079 | @findex gdb.BP_HARDWARE_WATCHPOINT | |
d812018b | 24080 | @item gdb.BP_HARDWARE_WATCHPOINT |
adc36818 PM |
24081 | Hardware assisted watchpoint. |
24082 | ||
24083 | @findex BP_READ_WATCHPOINT | |
24084 | @findex gdb.BP_READ_WATCHPOINT | |
d812018b | 24085 | @item gdb.BP_READ_WATCHPOINT |
adc36818 PM |
24086 | Hardware assisted read watchpoint. |
24087 | ||
24088 | @findex BP_ACCESS_WATCHPOINT | |
24089 | @findex gdb.BP_ACCESS_WATCHPOINT | |
d812018b | 24090 | @item gdb.BP_ACCESS_WATCHPOINT |
adc36818 PM |
24091 | Hardware assisted access watchpoint. |
24092 | @end table | |
24093 | ||
d812018b | 24094 | @defvar Breakpoint.hit_count |
adc36818 PM |
24095 | This attribute holds the hit count for the breakpoint, an integer. |
24096 | This attribute is writable, but currently it can only be set to zero. | |
d812018b | 24097 | @end defvar |
adc36818 | 24098 | |
d812018b | 24099 | @defvar Breakpoint.location |
adc36818 PM |
24100 | This attribute holds the location of the breakpoint, as specified by |
24101 | the user. It is a string. If the breakpoint does not have a location | |
24102 | (that is, it is a watchpoint) the attribute's value is @code{None}. This | |
24103 | attribute is not writable. | |
d812018b | 24104 | @end defvar |
adc36818 | 24105 | |
d812018b | 24106 | @defvar Breakpoint.expression |
adc36818 PM |
24107 | This attribute holds a breakpoint expression, as specified by |
24108 | the user. It is a string. If the breakpoint does not have an | |
24109 | expression (the breakpoint is not a watchpoint) the attribute's value | |
24110 | is @code{None}. This attribute is not writable. | |
d812018b | 24111 | @end defvar |
adc36818 | 24112 | |
d812018b | 24113 | @defvar Breakpoint.condition |
adc36818 PM |
24114 | This attribute holds the condition of the breakpoint, as specified by |
24115 | the user. It is a string. If there is no condition, this attribute's | |
24116 | value is @code{None}. This attribute is writable. | |
d812018b | 24117 | @end defvar |
adc36818 | 24118 | |
d812018b | 24119 | @defvar Breakpoint.commands |
adc36818 PM |
24120 | This attribute holds the commands attached to the breakpoint. If |
24121 | there are commands, this attribute's value is a string holding all the | |
24122 | commands, separated by newlines. If there are no commands, this | |
24123 | attribute is @code{None}. This attribute is not writable. | |
d812018b | 24124 | @end defvar |
adc36818 | 24125 | |
be759fcf PM |
24126 | @node Lazy Strings In Python |
24127 | @subsubsection Python representation of lazy strings. | |
24128 | ||
24129 | @cindex lazy strings in python | |
24130 | @tindex gdb.LazyString | |
24131 | ||
24132 | A @dfn{lazy string} is a string whose contents is not retrieved or | |
24133 | encoded until it is needed. | |
24134 | ||
24135 | A @code{gdb.LazyString} is represented in @value{GDBN} as an | |
24136 | @code{address} that points to a region of memory, an @code{encoding} | |
24137 | that will be used to encode that region of memory, and a @code{length} | |
24138 | to delimit the region of memory that represents the string. The | |
24139 | difference between a @code{gdb.LazyString} and a string wrapped within | |
24140 | a @code{gdb.Value} is that a @code{gdb.LazyString} will be treated | |
24141 | differently by @value{GDBN} when printing. A @code{gdb.LazyString} is | |
24142 | retrieved and encoded during printing, while a @code{gdb.Value} | |
24143 | wrapping a string is immediately retrieved and encoded on creation. | |
24144 | ||
24145 | A @code{gdb.LazyString} object has the following functions: | |
24146 | ||
d812018b | 24147 | @defun LazyString.value () |
be759fcf PM |
24148 | Convert the @code{gdb.LazyString} to a @code{gdb.Value}. This value |
24149 | will point to the string in memory, but will lose all the delayed | |
24150 | retrieval, encoding and handling that @value{GDBN} applies to a | |
24151 | @code{gdb.LazyString}. | |
d812018b | 24152 | @end defun |
be759fcf | 24153 | |
d812018b | 24154 | @defvar LazyString.address |
be759fcf PM |
24155 | This attribute holds the address of the string. This attribute is not |
24156 | writable. | |
d812018b | 24157 | @end defvar |
be759fcf | 24158 | |
d812018b | 24159 | @defvar LazyString.length |
be759fcf PM |
24160 | This attribute holds the length of the string in characters. If the |
24161 | length is -1, then the string will be fetched and encoded up to the | |
24162 | first null of appropriate width. This attribute is not writable. | |
d812018b | 24163 | @end defvar |
be759fcf | 24164 | |
d812018b | 24165 | @defvar LazyString.encoding |
be759fcf PM |
24166 | This attribute holds the encoding that will be applied to the string |
24167 | when the string is printed by @value{GDBN}. If the encoding is not | |
24168 | set, or contains an empty string, then @value{GDBN} will select the | |
24169 | most appropriate encoding when the string is printed. This attribute | |
24170 | is not writable. | |
d812018b | 24171 | @end defvar |
be759fcf | 24172 | |
d812018b | 24173 | @defvar LazyString.type |
be759fcf PM |
24174 | This attribute holds the type that is represented by the lazy string's |
24175 | type. For a lazy string this will always be a pointer type. To | |
24176 | resolve this to the lazy string's character type, use the type's | |
24177 | @code{target} method. @xref{Types In Python}. This attribute is not | |
24178 | writable. | |
d812018b | 24179 | @end defvar |
be759fcf | 24180 | |
8a1ea21f DE |
24181 | @node Auto-loading |
24182 | @subsection Auto-loading | |
24183 | @cindex auto-loading, Python | |
24184 | ||
24185 | When a new object file is read (for example, due to the @code{file} | |
24186 | command, or because the inferior has loaded a shared library), | |
24187 | @value{GDBN} will look for Python support scripts in several ways: | |
24188 | @file{@var{objfile}-gdb.py} and @code{.debug_gdb_scripts} section. | |
24189 | ||
24190 | @menu | |
24191 | * objfile-gdb.py file:: The @file{@var{objfile}-gdb.py} file | |
24192 | * .debug_gdb_scripts section:: The @code{.debug_gdb_scripts} section | |
24193 | * Which flavor to choose?:: | |
24194 | @end menu | |
24195 | ||
24196 | The auto-loading feature is useful for supplying application-specific | |
24197 | debugging commands and scripts. | |
24198 | ||
dbaefcf7 DE |
24199 | Auto-loading can be enabled or disabled, |
24200 | and the list of auto-loaded scripts can be printed. | |
8a1ea21f DE |
24201 | |
24202 | @table @code | |
a86caf66 DE |
24203 | @kindex set auto-load-scripts |
24204 | @item set auto-load-scripts [yes|no] | |
24205 | Enable or disable the auto-loading of Python scripts. | |
8a1ea21f | 24206 | |
a86caf66 DE |
24207 | @kindex show auto-load-scripts |
24208 | @item show auto-load-scripts | |
24209 | Show whether auto-loading of Python scripts is enabled or disabled. | |
dbaefcf7 DE |
24210 | |
24211 | @kindex info auto-load-scripts | |
24212 | @cindex print list of auto-loaded scripts | |
24213 | @item info auto-load-scripts [@var{regexp}] | |
75fc9810 DE |
24214 | Print the list of all scripts that @value{GDBN} auto-loaded. |
24215 | ||
24216 | Also printed is the list of scripts that were mentioned in | |
24217 | the @code{.debug_gdb_scripts} section and were not found | |
24218 | (@pxref{.debug_gdb_scripts section}). | |
24219 | This is useful because their names are not printed when @value{GDBN} | |
24220 | tries to load them and fails. There may be many of them, and printing | |
24221 | an error message for each one is problematic. | |
24222 | ||
dbaefcf7 DE |
24223 | If @var{regexp} is supplied only scripts with matching names are printed. |
24224 | ||
75fc9810 DE |
24225 | Example: |
24226 | ||
dbaefcf7 DE |
24227 | @smallexample |
24228 | (gdb) info auto-load-scripts | |
75fc9810 DE |
24229 | Loaded Script |
24230 | Yes py-section-script.py | |
24231 | full name: /tmp/py-section-script.py | |
24232 | Missing my-foo-pretty-printers.py | |
dbaefcf7 | 24233 | @end smallexample |
8a1ea21f DE |
24234 | @end table |
24235 | ||
24236 | When reading an auto-loaded file, @value{GDBN} sets the | |
24237 | @dfn{current objfile}. This is available via the @code{gdb.current_objfile} | |
24238 | function (@pxref{Objfiles In Python}). This can be useful for | |
24239 | registering objfile-specific pretty-printers. | |
24240 | ||
24241 | @node objfile-gdb.py file | |
24242 | @subsubsection The @file{@var{objfile}-gdb.py} file | |
24243 | @cindex @file{@var{objfile}-gdb.py} | |
24244 | ||
24245 | When a new object file is read, @value{GDBN} looks for | |
24246 | a file named @file{@var{objfile}-gdb.py}, | |
24247 | where @var{objfile} is the object file's real name, formed by ensuring | |
24248 | that the file name is absolute, following all symlinks, and resolving | |
24249 | @code{.} and @code{..} components. If this file exists and is | |
24250 | readable, @value{GDBN} will evaluate it as a Python script. | |
24251 | ||
24252 | If this file does not exist, and if the parameter | |
24253 | @code{debug-file-directory} is set (@pxref{Separate Debug Files}), | |
24254 | then @value{GDBN} will look for @var{real-name} in all of the | |
24255 | directories mentioned in the value of @code{debug-file-directory}. | |
24256 | ||
24257 | Finally, if this file does not exist, then @value{GDBN} will look for | |
24258 | a file named @file{@var{data-directory}/python/auto-load/@var{real-name}}, where | |
24259 | @var{data-directory} is @value{GDBN}'s data directory (available via | |
24260 | @code{show data-directory}, @pxref{Data Files}), and @var{real-name} | |
24261 | is the object file's real name, as described above. | |
24262 | ||
24263 | @value{GDBN} does not track which files it has already auto-loaded this way. | |
24264 | @value{GDBN} will load the associated script every time the corresponding | |
24265 | @var{objfile} is opened. | |
24266 | So your @file{-gdb.py} file should be careful to avoid errors if it | |
24267 | is evaluated more than once. | |
24268 | ||
24269 | @node .debug_gdb_scripts section | |
24270 | @subsubsection The @code{.debug_gdb_scripts} section | |
24271 | @cindex @code{.debug_gdb_scripts} section | |
24272 | ||
24273 | For systems using file formats like ELF and COFF, | |
24274 | when @value{GDBN} loads a new object file | |
24275 | it will look for a special section named @samp{.debug_gdb_scripts}. | |
24276 | If this section exists, its contents is a list of names of scripts to load. | |
24277 | ||
24278 | @value{GDBN} will look for each specified script file first in the | |
24279 | current directory and then along the source search path | |
24280 | (@pxref{Source Path, ,Specifying Source Directories}), | |
24281 | except that @file{$cdir} is not searched, since the compilation | |
24282 | directory is not relevant to scripts. | |
24283 | ||
24284 | Entries can be placed in section @code{.debug_gdb_scripts} with, | |
24285 | for example, this GCC macro: | |
24286 | ||
24287 | @example | |
a3a7127e | 24288 | /* Note: The "MS" section flags are to remove duplicates. */ |
8a1ea21f DE |
24289 | #define DEFINE_GDB_SCRIPT(script_name) \ |
24290 | asm("\ | |
24291 | .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\ | |
24292 | .byte 1\n\ | |
24293 | .asciz \"" script_name "\"\n\ | |
24294 | .popsection \n\ | |
24295 | "); | |
24296 | @end example | |
24297 | ||
24298 | @noindent | |
24299 | Then one can reference the macro in a header or source file like this: | |
24300 | ||
24301 | @example | |
24302 | DEFINE_GDB_SCRIPT ("my-app-scripts.py") | |
24303 | @end example | |
24304 | ||
24305 | The script name may include directories if desired. | |
24306 | ||
24307 | If the macro is put in a header, any application or library | |
24308 | using this header will get a reference to the specified script. | |
24309 | ||
24310 | @node Which flavor to choose? | |
24311 | @subsubsection Which flavor to choose? | |
24312 | ||
24313 | Given the multiple ways of auto-loading Python scripts, it might not always | |
24314 | be clear which one to choose. This section provides some guidance. | |
24315 | ||
24316 | Benefits of the @file{-gdb.py} way: | |
24317 | ||
24318 | @itemize @bullet | |
24319 | @item | |
24320 | Can be used with file formats that don't support multiple sections. | |
24321 | ||
24322 | @item | |
24323 | Ease of finding scripts for public libraries. | |
24324 | ||
24325 | Scripts specified in the @code{.debug_gdb_scripts} section are searched for | |
24326 | in the source search path. | |
24327 | For publicly installed libraries, e.g., @file{libstdc++}, there typically | |
24328 | isn't a source directory in which to find the script. | |
24329 | ||
24330 | @item | |
24331 | Doesn't require source code additions. | |
24332 | @end itemize | |
24333 | ||
24334 | Benefits of the @code{.debug_gdb_scripts} way: | |
24335 | ||
24336 | @itemize @bullet | |
24337 | @item | |
24338 | Works with static linking. | |
24339 | ||
24340 | Scripts for libraries done the @file{-gdb.py} way require an objfile to | |
24341 | trigger their loading. When an application is statically linked the only | |
24342 | objfile available is the executable, and it is cumbersome to attach all the | |
24343 | scripts from all the input libraries to the executable's @file{-gdb.py} script. | |
24344 | ||
24345 | @item | |
24346 | Works with classes that are entirely inlined. | |
24347 | ||
24348 | Some classes can be entirely inlined, and thus there may not be an associated | |
24349 | shared library to attach a @file{-gdb.py} script to. | |
24350 | ||
24351 | @item | |
24352 | Scripts needn't be copied out of the source tree. | |
24353 | ||
24354 | In some circumstances, apps can be built out of large collections of internal | |
24355 | libraries, and the build infrastructure necessary to install the | |
24356 | @file{-gdb.py} scripts in a place where @value{GDBN} can find them is | |
24357 | cumbersome. It may be easier to specify the scripts in the | |
24358 | @code{.debug_gdb_scripts} section as relative paths, and add a path to the | |
24359 | top of the source tree to the source search path. | |
24360 | @end itemize | |
24361 | ||
0e3509db DE |
24362 | @node Python modules |
24363 | @subsection Python modules | |
24364 | @cindex python modules | |
24365 | ||
fa3a4f15 | 24366 | @value{GDBN} comes with several modules to assist writing Python code. |
0e3509db DE |
24367 | |
24368 | @menu | |
7b51bc51 | 24369 | * gdb.printing:: Building and registering pretty-printers. |
0e3509db | 24370 | * gdb.types:: Utilities for working with types. |
fa3a4f15 | 24371 | * gdb.prompt:: Utilities for prompt value substitution. |
0e3509db DE |
24372 | @end menu |
24373 | ||
7b51bc51 DE |
24374 | @node gdb.printing |
24375 | @subsubsection gdb.printing | |
24376 | @cindex gdb.printing | |
24377 | ||
24378 | This module provides a collection of utilities for working with | |
24379 | pretty-printers. | |
24380 | ||
24381 | @table @code | |
24382 | @item PrettyPrinter (@var{name}, @var{subprinters}=None) | |
24383 | This class specifies the API that makes @samp{info pretty-printer}, | |
24384 | @samp{enable pretty-printer} and @samp{disable pretty-printer} work. | |
24385 | Pretty-printers should generally inherit from this class. | |
24386 | ||
24387 | @item SubPrettyPrinter (@var{name}) | |
24388 | For printers that handle multiple types, this class specifies the | |
24389 | corresponding API for the subprinters. | |
24390 | ||
24391 | @item RegexpCollectionPrettyPrinter (@var{name}) | |
24392 | Utility class for handling multiple printers, all recognized via | |
24393 | regular expressions. | |
24394 | @xref{Writing a Pretty-Printer}, for an example. | |
24395 | ||
9c15afc4 | 24396 | @item register_pretty_printer (@var{obj}, @var{printer}, @var{replace}=False) |
7b51bc51 | 24397 | Register @var{printer} with the pretty-printer list of @var{obj}. |
9c15afc4 DE |
24398 | If @var{replace} is @code{True} then any existing copy of the printer |
24399 | is replaced. Otherwise a @code{RuntimeError} exception is raised | |
24400 | if a printer with the same name already exists. | |
7b51bc51 DE |
24401 | @end table |
24402 | ||
0e3509db DE |
24403 | @node gdb.types |
24404 | @subsubsection gdb.types | |
7b51bc51 | 24405 | @cindex gdb.types |
0e3509db DE |
24406 | |
24407 | This module provides a collection of utilities for working with | |
24408 | @code{gdb.Types} objects. | |
24409 | ||
24410 | @table @code | |
24411 | @item get_basic_type (@var{type}) | |
24412 | Return @var{type} with const and volatile qualifiers stripped, | |
24413 | and with typedefs and C@t{++} references converted to the underlying type. | |
24414 | ||
24415 | C@t{++} example: | |
24416 | ||
24417 | @smallexample | |
24418 | typedef const int const_int; | |
24419 | const_int foo (3); | |
24420 | const_int& foo_ref (foo); | |
24421 | int main () @{ return 0; @} | |
24422 | @end smallexample | |
24423 | ||
24424 | Then in gdb: | |
24425 | ||
24426 | @smallexample | |
24427 | (gdb) start | |
24428 | (gdb) python import gdb.types | |
24429 | (gdb) python foo_ref = gdb.parse_and_eval("foo_ref") | |
24430 | (gdb) python print gdb.types.get_basic_type(foo_ref.type) | |
24431 | int | |
24432 | @end smallexample | |
24433 | ||
24434 | @item has_field (@var{type}, @var{field}) | |
24435 | Return @code{True} if @var{type}, assumed to be a type with fields | |
24436 | (e.g., a structure or union), has field @var{field}. | |
24437 | ||
24438 | @item make_enum_dict (@var{enum_type}) | |
24439 | Return a Python @code{dictionary} type produced from @var{enum_type}. | |
5110b5df PK |
24440 | |
24441 | @item deepitems (@var{type}) | |
24442 | Returns a Python iterator similar to the standard | |
24443 | @code{gdb.Type.iteritems} method, except that the iterator returned | |
24444 | by @code{deepitems} will recursively traverse anonymous struct or | |
24445 | union fields. For example: | |
24446 | ||
24447 | @smallexample | |
24448 | struct A | |
24449 | @{ | |
24450 | int a; | |
24451 | union @{ | |
24452 | int b0; | |
24453 | int b1; | |
24454 | @}; | |
24455 | @}; | |
24456 | @end smallexample | |
24457 | ||
24458 | @noindent | |
24459 | Then in @value{GDBN}: | |
24460 | @smallexample | |
24461 | (@value{GDBP}) python import gdb.types | |
24462 | (@value{GDBP}) python struct_a = gdb.lookup_type("struct A") | |
24463 | (@value{GDBP}) python print struct_a.keys () | |
24464 | @{['a', '']@} | |
24465 | (@value{GDBP}) python print [k for k,v in gdb.types.deepitems(struct_a)] | |
24466 | @{['a', 'b0', 'b1']@} | |
24467 | @end smallexample | |
24468 | ||
0e3509db | 24469 | @end table |
fa3a4f15 PM |
24470 | |
24471 | @node gdb.prompt | |
24472 | @subsubsection gdb.prompt | |
24473 | @cindex gdb.prompt | |
24474 | ||
24475 | This module provides a method for prompt value-substitution. | |
24476 | ||
24477 | @table @code | |
24478 | @item substitute_prompt (@var{string}) | |
24479 | Return @var{string} with escape sequences substituted by values. Some | |
24480 | escape sequences take arguments. You can specify arguments inside | |
24481 | ``@{@}'' immediately following the escape sequence. | |
24482 | ||
24483 | The escape sequences you can pass to this function are: | |
24484 | ||
24485 | @table @code | |
24486 | @item \\ | |
24487 | Substitute a backslash. | |
24488 | @item \e | |
24489 | Substitute an ESC character. | |
24490 | @item \f | |
24491 | Substitute the selected frame; an argument names a frame parameter. | |
24492 | @item \n | |
24493 | Substitute a newline. | |
24494 | @item \p | |
24495 | Substitute a parameter's value; the argument names the parameter. | |
24496 | @item \r | |
24497 | Substitute a carriage return. | |
24498 | @item \t | |
24499 | Substitute the selected thread; an argument names a thread parameter. | |
24500 | @item \v | |
24501 | Substitute the version of GDB. | |
24502 | @item \w | |
24503 | Substitute the current working directory. | |
24504 | @item \[ | |
24505 | Begin a sequence of non-printing characters. These sequences are | |
24506 | typically used with the ESC character, and are not counted in the string | |
24507 | length. Example: ``\[\e[0;34m\](gdb)\[\e[0m\]'' will return a | |
24508 | blue-colored ``(gdb)'' prompt where the length is five. | |
24509 | @item \] | |
24510 | End a sequence of non-printing characters. | |
24511 | @end table | |
24512 | ||
24513 | For example: | |
24514 | ||
24515 | @smallexample | |
24516 | substitute_prompt (``frame: \f, | |
24517 | print arguments: \p@{print frame-arguments@}'') | |
24518 | @end smallexample | |
24519 | ||
24520 | @exdent will return the string: | |
24521 | ||
24522 | @smallexample | |
24523 | "frame: main, print arguments: scalars" | |
24524 | @end smallexample | |
24525 | @end table | |
0e3509db | 24526 | |
5a56e9c5 DE |
24527 | @node Aliases |
24528 | @section Creating new spellings of existing commands | |
24529 | @cindex aliases for commands | |
24530 | ||
24531 | It is often useful to define alternate spellings of existing commands. | |
24532 | For example, if a new @value{GDBN} command defined in Python has | |
24533 | a long name to type, it is handy to have an abbreviated version of it | |
24534 | that involves less typing. | |
24535 | ||
24536 | @value{GDBN} itself uses aliases. For example @samp{s} is an alias | |
24537 | of the @samp{step} command even though it is otherwise an ambiguous | |
24538 | abbreviation of other commands like @samp{set} and @samp{show}. | |
24539 | ||
24540 | Aliases are also used to provide shortened or more common versions | |
24541 | of multi-word commands. For example, @value{GDBN} provides the | |
24542 | @samp{tty} alias of the @samp{set inferior-tty} command. | |
24543 | ||
24544 | You can define a new alias with the @samp{alias} command. | |
24545 | ||
24546 | @table @code | |
24547 | ||
24548 | @kindex alias | |
24549 | @item alias [-a] [--] @var{ALIAS} = @var{COMMAND} | |
24550 | ||
24551 | @end table | |
24552 | ||
24553 | @var{ALIAS} specifies the name of the new alias. | |
24554 | Each word of @var{ALIAS} must consist of letters, numbers, dashes and | |
24555 | underscores. | |
24556 | ||
24557 | @var{COMMAND} specifies the name of an existing command | |
24558 | that is being aliased. | |
24559 | ||
24560 | The @samp{-a} option specifies that the new alias is an abbreviation | |
24561 | of the command. Abbreviations are not shown in command | |
24562 | lists displayed by the @samp{help} command. | |
24563 | ||
24564 | The @samp{--} option specifies the end of options, | |
24565 | and is useful when @var{ALIAS} begins with a dash. | |
24566 | ||
24567 | Here is a simple example showing how to make an abbreviation | |
24568 | of a command so that there is less to type. | |
24569 | Suppose you were tired of typing @samp{disas}, the current | |
24570 | shortest unambiguous abbreviation of the @samp{disassemble} command | |
24571 | and you wanted an even shorter version named @samp{di}. | |
24572 | The following will accomplish this. | |
24573 | ||
24574 | @smallexample | |
24575 | (gdb) alias -a di = disas | |
24576 | @end smallexample | |
24577 | ||
24578 | Note that aliases are different from user-defined commands. | |
24579 | With a user-defined command, you also need to write documentation | |
24580 | for it with the @samp{document} command. | |
24581 | An alias automatically picks up the documentation of the existing command. | |
24582 | ||
24583 | Here is an example where we make @samp{elms} an abbreviation of | |
24584 | @samp{elements} in the @samp{set print elements} command. | |
24585 | This is to show that you can make an abbreviation of any part | |
24586 | of a command. | |
24587 | ||
24588 | @smallexample | |
24589 | (gdb) alias -a set print elms = set print elements | |
24590 | (gdb) alias -a show print elms = show print elements | |
24591 | (gdb) set p elms 20 | |
24592 | (gdb) show p elms | |
24593 | Limit on string chars or array elements to print is 200. | |
24594 | @end smallexample | |
24595 | ||
24596 | Note that if you are defining an alias of a @samp{set} command, | |
24597 | and you want to have an alias for the corresponding @samp{show} | |
24598 | command, then you need to define the latter separately. | |
24599 | ||
24600 | Unambiguously abbreviated commands are allowed in @var{COMMAND} and | |
24601 | @var{ALIAS}, just as they are normally. | |
24602 | ||
24603 | @smallexample | |
24604 | (gdb) alias -a set pr elms = set p ele | |
24605 | @end smallexample | |
24606 | ||
24607 | Finally, here is an example showing the creation of a one word | |
24608 | alias for a more complex command. | |
24609 | This creates alias @samp{spe} of the command @samp{set print elements}. | |
24610 | ||
24611 | @smallexample | |
24612 | (gdb) alias spe = set print elements | |
24613 | (gdb) spe 20 | |
24614 | @end smallexample | |
24615 | ||
21c294e6 AC |
24616 | @node Interpreters |
24617 | @chapter Command Interpreters | |
24618 | @cindex command interpreters | |
24619 | ||
24620 | @value{GDBN} supports multiple command interpreters, and some command | |
24621 | infrastructure to allow users or user interface writers to switch | |
24622 | between interpreters or run commands in other interpreters. | |
24623 | ||
24624 | @value{GDBN} currently supports two command interpreters, the console | |
24625 | interpreter (sometimes called the command-line interpreter or @sc{cli}) | |
24626 | and the machine interface interpreter (or @sc{gdb/mi}). This manual | |
24627 | describes both of these interfaces in great detail. | |
24628 | ||
24629 | By default, @value{GDBN} will start with the console interpreter. | |
24630 | However, the user may choose to start @value{GDBN} with another | |
24631 | interpreter by specifying the @option{-i} or @option{--interpreter} | |
24632 | startup options. Defined interpreters include: | |
24633 | ||
24634 | @table @code | |
24635 | @item console | |
24636 | @cindex console interpreter | |
24637 | The traditional console or command-line interpreter. This is the most often | |
24638 | used interpreter with @value{GDBN}. With no interpreter specified at runtime, | |
24639 | @value{GDBN} will use this interpreter. | |
24640 | ||
24641 | @item mi | |
24642 | @cindex mi interpreter | |
24643 | The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily | |
24644 | by programs wishing to use @value{GDBN} as a backend for a debugger GUI | |
24645 | or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi} | |
24646 | Interface}. | |
24647 | ||
24648 | @item mi2 | |
24649 | @cindex mi2 interpreter | |
24650 | The current @sc{gdb/mi} interface. | |
24651 | ||
24652 | @item mi1 | |
24653 | @cindex mi1 interpreter | |
24654 | The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3. | |
24655 | ||
24656 | @end table | |
24657 | ||
24658 | @cindex invoke another interpreter | |
24659 | The interpreter being used by @value{GDBN} may not be dynamically | |
24660 | switched at runtime. Although possible, this could lead to a very | |
24661 | precarious situation. Consider an IDE using @sc{gdb/mi}. If a user | |
24662 | enters the command "interpreter-set console" in a console view, | |
24663 | @value{GDBN} would switch to using the console interpreter, rendering | |
24664 | the IDE inoperable! | |
24665 | ||
24666 | @kindex interpreter-exec | |
24667 | Although you may only choose a single interpreter at startup, you may execute | |
24668 | commands in any interpreter from the current interpreter using the appropriate | |
24669 | command. If you are running the console interpreter, simply use the | |
24670 | @code{interpreter-exec} command: | |
24671 | ||
24672 | @smallexample | |
24673 | interpreter-exec mi "-data-list-register-names" | |
24674 | @end smallexample | |
24675 | ||
24676 | @sc{gdb/mi} has a similar command, although it is only available in versions of | |
24677 | @value{GDBN} which support @sc{gdb/mi} version 2 (or greater). | |
24678 | ||
8e04817f AC |
24679 | @node TUI |
24680 | @chapter @value{GDBN} Text User Interface | |
24681 | @cindex TUI | |
d0d5df6f | 24682 | @cindex Text User Interface |
c906108c | 24683 | |
8e04817f AC |
24684 | @menu |
24685 | * TUI Overview:: TUI overview | |
24686 | * TUI Keys:: TUI key bindings | |
7cf36c78 | 24687 | * TUI Single Key Mode:: TUI single key mode |
db2e3e2e | 24688 | * TUI Commands:: TUI-specific commands |
8e04817f AC |
24689 | * TUI Configuration:: TUI configuration variables |
24690 | @end menu | |
c906108c | 24691 | |
46ba6afa | 24692 | The @value{GDBN} Text User Interface (TUI) is a terminal |
d0d5df6f AC |
24693 | interface which uses the @code{curses} library to show the source |
24694 | file, the assembly output, the program registers and @value{GDBN} | |
46ba6afa BW |
24695 | commands in separate text windows. The TUI mode is supported only |
24696 | on platforms where a suitable version of the @code{curses} library | |
24697 | is available. | |
d0d5df6f | 24698 | |
46ba6afa BW |
24699 | @pindex @value{GDBTUI} |
24700 | The TUI mode is enabled by default when you invoke @value{GDBN} as | |
24701 | either @samp{@value{GDBTUI}} or @samp{@value{GDBP} -tui}. | |
24702 | You can also switch in and out of TUI mode while @value{GDBN} runs by | |
24703 | using various TUI commands and key bindings, such as @kbd{C-x C-a}. | |
24704 | @xref{TUI Keys, ,TUI Key Bindings}. | |
c906108c | 24705 | |
8e04817f | 24706 | @node TUI Overview |
79a6e687 | 24707 | @section TUI Overview |
c906108c | 24708 | |
46ba6afa | 24709 | In TUI mode, @value{GDBN} can display several text windows: |
c906108c | 24710 | |
8e04817f AC |
24711 | @table @emph |
24712 | @item command | |
24713 | This window is the @value{GDBN} command window with the @value{GDBN} | |
46ba6afa BW |
24714 | prompt and the @value{GDBN} output. The @value{GDBN} input is still |
24715 | managed using readline. | |
c906108c | 24716 | |
8e04817f AC |
24717 | @item source |
24718 | The source window shows the source file of the program. The current | |
46ba6afa | 24719 | line and active breakpoints are displayed in this window. |
c906108c | 24720 | |
8e04817f AC |
24721 | @item assembly |
24722 | The assembly window shows the disassembly output of the program. | |
c906108c | 24723 | |
8e04817f | 24724 | @item register |
46ba6afa BW |
24725 | This window shows the processor registers. Registers are highlighted |
24726 | when their values change. | |
c906108c SS |
24727 | @end table |
24728 | ||
269c21fe | 24729 | The source and assembly windows show the current program position |
46ba6afa BW |
24730 | by highlighting the current line and marking it with a @samp{>} marker. |
24731 | Breakpoints are indicated with two markers. The first marker | |
269c21fe SC |
24732 | indicates the breakpoint type: |
24733 | ||
24734 | @table @code | |
24735 | @item B | |
24736 | Breakpoint which was hit at least once. | |
24737 | ||
24738 | @item b | |
24739 | Breakpoint which was never hit. | |
24740 | ||
24741 | @item H | |
24742 | Hardware breakpoint which was hit at least once. | |
24743 | ||
24744 | @item h | |
24745 | Hardware breakpoint which was never hit. | |
269c21fe SC |
24746 | @end table |
24747 | ||
24748 | The second marker indicates whether the breakpoint is enabled or not: | |
24749 | ||
24750 | @table @code | |
24751 | @item + | |
24752 | Breakpoint is enabled. | |
24753 | ||
24754 | @item - | |
24755 | Breakpoint is disabled. | |
269c21fe SC |
24756 | @end table |
24757 | ||
46ba6afa BW |
24758 | The source, assembly and register windows are updated when the current |
24759 | thread changes, when the frame changes, or when the program counter | |
24760 | changes. | |
24761 | ||
24762 | These windows are not all visible at the same time. The command | |
24763 | window is always visible. The others can be arranged in several | |
24764 | layouts: | |
c906108c | 24765 | |
8e04817f AC |
24766 | @itemize @bullet |
24767 | @item | |
46ba6afa | 24768 | source only, |
2df3850c | 24769 | |
8e04817f | 24770 | @item |
46ba6afa | 24771 | assembly only, |
8e04817f AC |
24772 | |
24773 | @item | |
46ba6afa | 24774 | source and assembly, |
8e04817f AC |
24775 | |
24776 | @item | |
46ba6afa | 24777 | source and registers, or |
c906108c | 24778 | |
8e04817f | 24779 | @item |
46ba6afa | 24780 | assembly and registers. |
8e04817f | 24781 | @end itemize |
c906108c | 24782 | |
46ba6afa | 24783 | A status line above the command window shows the following information: |
b7bb15bc SC |
24784 | |
24785 | @table @emph | |
24786 | @item target | |
46ba6afa | 24787 | Indicates the current @value{GDBN} target. |
b7bb15bc SC |
24788 | (@pxref{Targets, ,Specifying a Debugging Target}). |
24789 | ||
24790 | @item process | |
46ba6afa | 24791 | Gives the current process or thread number. |
b7bb15bc SC |
24792 | When no process is being debugged, this field is set to @code{No process}. |
24793 | ||
24794 | @item function | |
24795 | Gives the current function name for the selected frame. | |
24796 | The name is demangled if demangling is turned on (@pxref{Print Settings}). | |
46ba6afa | 24797 | When there is no symbol corresponding to the current program counter, |
b7bb15bc SC |
24798 | the string @code{??} is displayed. |
24799 | ||
24800 | @item line | |
24801 | Indicates the current line number for the selected frame. | |
46ba6afa | 24802 | When the current line number is not known, the string @code{??} is displayed. |
b7bb15bc SC |
24803 | |
24804 | @item pc | |
24805 | Indicates the current program counter address. | |
b7bb15bc SC |
24806 | @end table |
24807 | ||
8e04817f AC |
24808 | @node TUI Keys |
24809 | @section TUI Key Bindings | |
24810 | @cindex TUI key bindings | |
c906108c | 24811 | |
8e04817f | 24812 | The TUI installs several key bindings in the readline keymaps |
39037522 TT |
24813 | @ifset SYSTEM_READLINE |
24814 | (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}). | |
24815 | @end ifset | |
24816 | @ifclear SYSTEM_READLINE | |
24817 | (@pxref{Command Line Editing}). | |
24818 | @end ifclear | |
24819 | The following key bindings are installed for both TUI mode and the | |
24820 | @value{GDBN} standard mode. | |
c906108c | 24821 | |
8e04817f AC |
24822 | @table @kbd |
24823 | @kindex C-x C-a | |
24824 | @item C-x C-a | |
24825 | @kindex C-x a | |
24826 | @itemx C-x a | |
24827 | @kindex C-x A | |
24828 | @itemx C-x A | |
46ba6afa BW |
24829 | Enter or leave the TUI mode. When leaving the TUI mode, |
24830 | the curses window management stops and @value{GDBN} operates using | |
24831 | its standard mode, writing on the terminal directly. When reentering | |
24832 | the TUI mode, control is given back to the curses windows. | |
8e04817f | 24833 | The screen is then refreshed. |
c906108c | 24834 | |
8e04817f AC |
24835 | @kindex C-x 1 |
24836 | @item C-x 1 | |
24837 | Use a TUI layout with only one window. The layout will | |
24838 | either be @samp{source} or @samp{assembly}. When the TUI mode | |
24839 | is not active, it will switch to the TUI mode. | |
2df3850c | 24840 | |
8e04817f | 24841 | Think of this key binding as the Emacs @kbd{C-x 1} binding. |
c906108c | 24842 | |
8e04817f AC |
24843 | @kindex C-x 2 |
24844 | @item C-x 2 | |
24845 | Use a TUI layout with at least two windows. When the current | |
46ba6afa | 24846 | layout already has two windows, the next layout with two windows is used. |
8e04817f AC |
24847 | When a new layout is chosen, one window will always be common to the |
24848 | previous layout and the new one. | |
c906108c | 24849 | |
8e04817f | 24850 | Think of it as the Emacs @kbd{C-x 2} binding. |
2df3850c | 24851 | |
72ffddc9 SC |
24852 | @kindex C-x o |
24853 | @item C-x o | |
24854 | Change the active window. The TUI associates several key bindings | |
46ba6afa | 24855 | (like scrolling and arrow keys) with the active window. This command |
72ffddc9 SC |
24856 | gives the focus to the next TUI window. |
24857 | ||
24858 | Think of it as the Emacs @kbd{C-x o} binding. | |
24859 | ||
7cf36c78 SC |
24860 | @kindex C-x s |
24861 | @item C-x s | |
46ba6afa BW |
24862 | Switch in and out of the TUI SingleKey mode that binds single |
24863 | keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}). | |
c906108c SS |
24864 | @end table |
24865 | ||
46ba6afa | 24866 | The following key bindings only work in the TUI mode: |
5d161b24 | 24867 | |
46ba6afa | 24868 | @table @asis |
8e04817f | 24869 | @kindex PgUp |
46ba6afa | 24870 | @item @key{PgUp} |
8e04817f | 24871 | Scroll the active window one page up. |
c906108c | 24872 | |
8e04817f | 24873 | @kindex PgDn |
46ba6afa | 24874 | @item @key{PgDn} |
8e04817f | 24875 | Scroll the active window one page down. |
c906108c | 24876 | |
8e04817f | 24877 | @kindex Up |
46ba6afa | 24878 | @item @key{Up} |
8e04817f | 24879 | Scroll the active window one line up. |
c906108c | 24880 | |
8e04817f | 24881 | @kindex Down |
46ba6afa | 24882 | @item @key{Down} |
8e04817f | 24883 | Scroll the active window one line down. |
c906108c | 24884 | |
8e04817f | 24885 | @kindex Left |
46ba6afa | 24886 | @item @key{Left} |
8e04817f | 24887 | Scroll the active window one column left. |
c906108c | 24888 | |
8e04817f | 24889 | @kindex Right |
46ba6afa | 24890 | @item @key{Right} |
8e04817f | 24891 | Scroll the active window one column right. |
c906108c | 24892 | |
8e04817f | 24893 | @kindex C-L |
46ba6afa | 24894 | @item @kbd{C-L} |
8e04817f | 24895 | Refresh the screen. |
8e04817f | 24896 | @end table |
c906108c | 24897 | |
46ba6afa BW |
24898 | Because the arrow keys scroll the active window in the TUI mode, they |
24899 | are not available for their normal use by readline unless the command | |
24900 | window has the focus. When another window is active, you must use | |
24901 | other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b} | |
24902 | and @kbd{C-f} to control the command window. | |
8e04817f | 24903 | |
7cf36c78 SC |
24904 | @node TUI Single Key Mode |
24905 | @section TUI Single Key Mode | |
24906 | @cindex TUI single key mode | |
24907 | ||
46ba6afa BW |
24908 | The TUI also provides a @dfn{SingleKey} mode, which binds several |
24909 | frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to | |
24910 | switch into this mode, where the following key bindings are used: | |
7cf36c78 SC |
24911 | |
24912 | @table @kbd | |
24913 | @kindex c @r{(SingleKey TUI key)} | |
24914 | @item c | |
24915 | continue | |
24916 | ||
24917 | @kindex d @r{(SingleKey TUI key)} | |
24918 | @item d | |
24919 | down | |
24920 | ||
24921 | @kindex f @r{(SingleKey TUI key)} | |
24922 | @item f | |
24923 | finish | |
24924 | ||
24925 | @kindex n @r{(SingleKey TUI key)} | |
24926 | @item n | |
24927 | next | |
24928 | ||
24929 | @kindex q @r{(SingleKey TUI key)} | |
24930 | @item q | |
46ba6afa | 24931 | exit the SingleKey mode. |
7cf36c78 SC |
24932 | |
24933 | @kindex r @r{(SingleKey TUI key)} | |
24934 | @item r | |
24935 | run | |
24936 | ||
24937 | @kindex s @r{(SingleKey TUI key)} | |
24938 | @item s | |
24939 | step | |
24940 | ||
24941 | @kindex u @r{(SingleKey TUI key)} | |
24942 | @item u | |
24943 | up | |
24944 | ||
24945 | @kindex v @r{(SingleKey TUI key)} | |
24946 | @item v | |
24947 | info locals | |
24948 | ||
24949 | @kindex w @r{(SingleKey TUI key)} | |
24950 | @item w | |
24951 | where | |
7cf36c78 SC |
24952 | @end table |
24953 | ||
24954 | Other keys temporarily switch to the @value{GDBN} command prompt. | |
24955 | The key that was pressed is inserted in the editing buffer so that | |
24956 | it is possible to type most @value{GDBN} commands without interaction | |
46ba6afa BW |
24957 | with the TUI SingleKey mode. Once the command is entered the TUI |
24958 | SingleKey mode is restored. The only way to permanently leave | |
7f9087cb | 24959 | this mode is by typing @kbd{q} or @kbd{C-x s}. |
7cf36c78 SC |
24960 | |
24961 | ||
8e04817f | 24962 | @node TUI Commands |
db2e3e2e | 24963 | @section TUI-specific Commands |
8e04817f AC |
24964 | @cindex TUI commands |
24965 | ||
24966 | The TUI has specific commands to control the text windows. | |
46ba6afa BW |
24967 | These commands are always available, even when @value{GDBN} is not in |
24968 | the TUI mode. When @value{GDBN} is in the standard mode, most | |
24969 | of these commands will automatically switch to the TUI mode. | |
c906108c | 24970 | |
ff12863f PA |
24971 | Note that if @value{GDBN}'s @code{stdout} is not connected to a |
24972 | terminal, or @value{GDBN} has been started with the machine interface | |
24973 | interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of | |
24974 | these commands will fail with an error, because it would not be | |
24975 | possible or desirable to enable curses window management. | |
24976 | ||
c906108c | 24977 | @table @code |
3d757584 SC |
24978 | @item info win |
24979 | @kindex info win | |
24980 | List and give the size of all displayed windows. | |
24981 | ||
8e04817f | 24982 | @item layout next |
4644b6e3 | 24983 | @kindex layout |
8e04817f | 24984 | Display the next layout. |
2df3850c | 24985 | |
8e04817f | 24986 | @item layout prev |
8e04817f | 24987 | Display the previous layout. |
c906108c | 24988 | |
8e04817f | 24989 | @item layout src |
8e04817f | 24990 | Display the source window only. |
c906108c | 24991 | |
8e04817f | 24992 | @item layout asm |
8e04817f | 24993 | Display the assembly window only. |
c906108c | 24994 | |
8e04817f | 24995 | @item layout split |
8e04817f | 24996 | Display the source and assembly window. |
c906108c | 24997 | |
8e04817f | 24998 | @item layout regs |
8e04817f AC |
24999 | Display the register window together with the source or assembly window. |
25000 | ||
46ba6afa | 25001 | @item focus next |
8e04817f | 25002 | @kindex focus |
46ba6afa BW |
25003 | Make the next window active for scrolling. |
25004 | ||
25005 | @item focus prev | |
25006 | Make the previous window active for scrolling. | |
25007 | ||
25008 | @item focus src | |
25009 | Make the source window active for scrolling. | |
25010 | ||
25011 | @item focus asm | |
25012 | Make the assembly window active for scrolling. | |
25013 | ||
25014 | @item focus regs | |
25015 | Make the register window active for scrolling. | |
25016 | ||
25017 | @item focus cmd | |
25018 | Make the command window active for scrolling. | |
c906108c | 25019 | |
8e04817f AC |
25020 | @item refresh |
25021 | @kindex refresh | |
7f9087cb | 25022 | Refresh the screen. This is similar to typing @kbd{C-L}. |
c906108c | 25023 | |
6a1b180d SC |
25024 | @item tui reg float |
25025 | @kindex tui reg | |
25026 | Show the floating point registers in the register window. | |
25027 | ||
25028 | @item tui reg general | |
25029 | Show the general registers in the register window. | |
25030 | ||
25031 | @item tui reg next | |
25032 | Show the next register group. The list of register groups as well as | |
25033 | their order is target specific. The predefined register groups are the | |
25034 | following: @code{general}, @code{float}, @code{system}, @code{vector}, | |
25035 | @code{all}, @code{save}, @code{restore}. | |
25036 | ||
25037 | @item tui reg system | |
25038 | Show the system registers in the register window. | |
25039 | ||
8e04817f AC |
25040 | @item update |
25041 | @kindex update | |
25042 | Update the source window and the current execution point. | |
c906108c | 25043 | |
8e04817f AC |
25044 | @item winheight @var{name} +@var{count} |
25045 | @itemx winheight @var{name} -@var{count} | |
25046 | @kindex winheight | |
25047 | Change the height of the window @var{name} by @var{count} | |
25048 | lines. Positive counts increase the height, while negative counts | |
25049 | decrease it. | |
2df3850c | 25050 | |
46ba6afa BW |
25051 | @item tabset @var{nchars} |
25052 | @kindex tabset | |
c45da7e6 | 25053 | Set the width of tab stops to be @var{nchars} characters. |
c906108c SS |
25054 | @end table |
25055 | ||
8e04817f | 25056 | @node TUI Configuration |
79a6e687 | 25057 | @section TUI Configuration Variables |
8e04817f | 25058 | @cindex TUI configuration variables |
c906108c | 25059 | |
46ba6afa | 25060 | Several configuration variables control the appearance of TUI windows. |
c906108c | 25061 | |
8e04817f AC |
25062 | @table @code |
25063 | @item set tui border-kind @var{kind} | |
25064 | @kindex set tui border-kind | |
25065 | Select the border appearance for the source, assembly and register windows. | |
25066 | The possible values are the following: | |
25067 | @table @code | |
25068 | @item space | |
25069 | Use a space character to draw the border. | |
c906108c | 25070 | |
8e04817f | 25071 | @item ascii |
46ba6afa | 25072 | Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border. |
c906108c | 25073 | |
8e04817f AC |
25074 | @item acs |
25075 | Use the Alternate Character Set to draw the border. The border is | |
25076 | drawn using character line graphics if the terminal supports them. | |
8e04817f | 25077 | @end table |
c78b4128 | 25078 | |
8e04817f AC |
25079 | @item set tui border-mode @var{mode} |
25080 | @kindex set tui border-mode | |
46ba6afa BW |
25081 | @itemx set tui active-border-mode @var{mode} |
25082 | @kindex set tui active-border-mode | |
25083 | Select the display attributes for the borders of the inactive windows | |
25084 | or the active window. The @var{mode} can be one of the following: | |
8e04817f AC |
25085 | @table @code |
25086 | @item normal | |
25087 | Use normal attributes to display the border. | |
c906108c | 25088 | |
8e04817f AC |
25089 | @item standout |
25090 | Use standout mode. | |
c906108c | 25091 | |
8e04817f AC |
25092 | @item reverse |
25093 | Use reverse video mode. | |
c906108c | 25094 | |
8e04817f AC |
25095 | @item half |
25096 | Use half bright mode. | |
c906108c | 25097 | |
8e04817f AC |
25098 | @item half-standout |
25099 | Use half bright and standout mode. | |
c906108c | 25100 | |
8e04817f AC |
25101 | @item bold |
25102 | Use extra bright or bold mode. | |
c78b4128 | 25103 | |
8e04817f AC |
25104 | @item bold-standout |
25105 | Use extra bright or bold and standout mode. | |
8e04817f | 25106 | @end table |
8e04817f | 25107 | @end table |
c78b4128 | 25108 | |
8e04817f AC |
25109 | @node Emacs |
25110 | @chapter Using @value{GDBN} under @sc{gnu} Emacs | |
c78b4128 | 25111 | |
8e04817f AC |
25112 | @cindex Emacs |
25113 | @cindex @sc{gnu} Emacs | |
25114 | A special interface allows you to use @sc{gnu} Emacs to view (and | |
25115 | edit) the source files for the program you are debugging with | |
25116 | @value{GDBN}. | |
c906108c | 25117 | |
8e04817f AC |
25118 | To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the |
25119 | executable file you want to debug as an argument. This command starts | |
25120 | @value{GDBN} as a subprocess of Emacs, with input and output through a newly | |
25121 | created Emacs buffer. | |
25122 | @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.) | |
c906108c | 25123 | |
5e252a2e | 25124 | Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two |
8e04817f | 25125 | things: |
c906108c | 25126 | |
8e04817f AC |
25127 | @itemize @bullet |
25128 | @item | |
5e252a2e NR |
25129 | All ``terminal'' input and output goes through an Emacs buffer, called |
25130 | the GUD buffer. | |
c906108c | 25131 | |
8e04817f AC |
25132 | This applies both to @value{GDBN} commands and their output, and to the input |
25133 | and output done by the program you are debugging. | |
bf0184be | 25134 | |
8e04817f AC |
25135 | This is useful because it means that you can copy the text of previous |
25136 | commands and input them again; you can even use parts of the output | |
25137 | in this way. | |
bf0184be | 25138 | |
8e04817f AC |
25139 | All the facilities of Emacs' Shell mode are available for interacting |
25140 | with your program. In particular, you can send signals the usual | |
25141 | way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a | |
25142 | stop. | |
bf0184be ND |
25143 | |
25144 | @item | |
8e04817f | 25145 | @value{GDBN} displays source code through Emacs. |
bf0184be | 25146 | |
8e04817f AC |
25147 | Each time @value{GDBN} displays a stack frame, Emacs automatically finds the |
25148 | source file for that frame and puts an arrow (@samp{=>}) at the | |
25149 | left margin of the current line. Emacs uses a separate buffer for | |
25150 | source display, and splits the screen to show both your @value{GDBN} session | |
25151 | and the source. | |
bf0184be | 25152 | |
8e04817f AC |
25153 | Explicit @value{GDBN} @code{list} or search commands still produce output as |
25154 | usual, but you probably have no reason to use them from Emacs. | |
5e252a2e NR |
25155 | @end itemize |
25156 | ||
25157 | We call this @dfn{text command mode}. Emacs 22.1, and later, also uses | |
25158 | a graphical mode, enabled by default, which provides further buffers | |
25159 | that can control the execution and describe the state of your program. | |
25160 | @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}. | |
c906108c | 25161 | |
64fabec2 AC |
25162 | If you specify an absolute file name when prompted for the @kbd{M-x |
25163 | gdb} argument, then Emacs sets your current working directory to where | |
25164 | your program resides. If you only specify the file name, then Emacs | |
7a9dd1b2 | 25165 | sets your current working directory to the directory associated |
64fabec2 AC |
25166 | with the previous buffer. In this case, @value{GDBN} may find your |
25167 | program by searching your environment's @code{PATH} variable, but on | |
25168 | some operating systems it might not find the source. So, although the | |
25169 | @value{GDBN} input and output session proceeds normally, the auxiliary | |
25170 | buffer does not display the current source and line of execution. | |
25171 | ||
25172 | The initial working directory of @value{GDBN} is printed on the top | |
5e252a2e NR |
25173 | line of the GUD buffer and this serves as a default for the commands |
25174 | that specify files for @value{GDBN} to operate on. @xref{Files, | |
25175 | ,Commands to Specify Files}. | |
64fabec2 AC |
25176 | |
25177 | By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you | |
25178 | need to call @value{GDBN} by a different name (for example, if you | |
25179 | keep several configurations around, with different names) you can | |
25180 | customize the Emacs variable @code{gud-gdb-command-name} to run the | |
25181 | one you want. | |
8e04817f | 25182 | |
5e252a2e | 25183 | In the GUD buffer, you can use these special Emacs commands in |
8e04817f | 25184 | addition to the standard Shell mode commands: |
c906108c | 25185 | |
8e04817f AC |
25186 | @table @kbd |
25187 | @item C-h m | |
5e252a2e | 25188 | Describe the features of Emacs' GUD Mode. |
c906108c | 25189 | |
64fabec2 | 25190 | @item C-c C-s |
8e04817f AC |
25191 | Execute to another source line, like the @value{GDBN} @code{step} command; also |
25192 | update the display window to show the current file and location. | |
c906108c | 25193 | |
64fabec2 | 25194 | @item C-c C-n |
8e04817f AC |
25195 | Execute to next source line in this function, skipping all function |
25196 | calls, like the @value{GDBN} @code{next} command. Then update the display window | |
25197 | to show the current file and location. | |
c906108c | 25198 | |
64fabec2 | 25199 | @item C-c C-i |
8e04817f AC |
25200 | Execute one instruction, like the @value{GDBN} @code{stepi} command; update |
25201 | display window accordingly. | |
c906108c | 25202 | |
8e04817f AC |
25203 | @item C-c C-f |
25204 | Execute until exit from the selected stack frame, like the @value{GDBN} | |
25205 | @code{finish} command. | |
c906108c | 25206 | |
64fabec2 | 25207 | @item C-c C-r |
8e04817f AC |
25208 | Continue execution of your program, like the @value{GDBN} @code{continue} |
25209 | command. | |
b433d00b | 25210 | |
64fabec2 | 25211 | @item C-c < |
8e04817f AC |
25212 | Go up the number of frames indicated by the numeric argument |
25213 | (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}), | |
25214 | like the @value{GDBN} @code{up} command. | |
b433d00b | 25215 | |
64fabec2 | 25216 | @item C-c > |
8e04817f AC |
25217 | Go down the number of frames indicated by the numeric argument, like the |
25218 | @value{GDBN} @code{down} command. | |
8e04817f | 25219 | @end table |
c906108c | 25220 | |
7f9087cb | 25221 | In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break}) |
8e04817f | 25222 | tells @value{GDBN} to set a breakpoint on the source line point is on. |
c906108c | 25223 | |
5e252a2e NR |
25224 | In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a |
25225 | separate frame which shows a backtrace when the GUD buffer is current. | |
25226 | Move point to any frame in the stack and type @key{RET} to make it | |
25227 | become the current frame and display the associated source in the | |
25228 | source buffer. Alternatively, click @kbd{Mouse-2} to make the | |
25229 | selected frame become the current one. In graphical mode, the | |
25230 | speedbar displays watch expressions. | |
64fabec2 | 25231 | |
8e04817f AC |
25232 | If you accidentally delete the source-display buffer, an easy way to get |
25233 | it back is to type the command @code{f} in the @value{GDBN} buffer, to | |
25234 | request a frame display; when you run under Emacs, this recreates | |
25235 | the source buffer if necessary to show you the context of the current | |
25236 | frame. | |
c906108c | 25237 | |
8e04817f AC |
25238 | The source files displayed in Emacs are in ordinary Emacs buffers |
25239 | which are visiting the source files in the usual way. You can edit | |
25240 | the files with these buffers if you wish; but keep in mind that @value{GDBN} | |
25241 | communicates with Emacs in terms of line numbers. If you add or | |
25242 | delete lines from the text, the line numbers that @value{GDBN} knows cease | |
25243 | to correspond properly with the code. | |
b383017d | 25244 | |
5e252a2e NR |
25245 | A more detailed description of Emacs' interaction with @value{GDBN} is |
25246 | given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu} | |
25247 | Emacs Manual}). | |
c906108c | 25248 | |
8e04817f AC |
25249 | @c The following dropped because Epoch is nonstandard. Reactivate |
25250 | @c if/when v19 does something similar. ---doc@cygnus.com 19dec1990 | |
25251 | @ignore | |
25252 | @kindex Emacs Epoch environment | |
25253 | @kindex Epoch | |
25254 | @kindex inspect | |
c906108c | 25255 | |
8e04817f AC |
25256 | Version 18 of @sc{gnu} Emacs has a built-in window system |
25257 | called the @code{epoch} | |
25258 | environment. Users of this environment can use a new command, | |
25259 | @code{inspect} which performs identically to @code{print} except that | |
25260 | each value is printed in its own window. | |
25261 | @end ignore | |
c906108c | 25262 | |
922fbb7b AC |
25263 | |
25264 | @node GDB/MI | |
25265 | @chapter The @sc{gdb/mi} Interface | |
25266 | ||
25267 | @unnumberedsec Function and Purpose | |
25268 | ||
25269 | @cindex @sc{gdb/mi}, its purpose | |
6b5e8c01 NR |
25270 | @sc{gdb/mi} is a line based machine oriented text interface to |
25271 | @value{GDBN} and is activated by specifying using the | |
25272 | @option{--interpreter} command line option (@pxref{Mode Options}). It | |
25273 | is specifically intended to support the development of systems which | |
25274 | use the debugger as just one small component of a larger system. | |
922fbb7b AC |
25275 | |
25276 | This chapter is a specification of the @sc{gdb/mi} interface. It is written | |
25277 | in the form of a reference manual. | |
25278 | ||
25279 | Note that @sc{gdb/mi} is still under construction, so some of the | |
af6eff6f NR |
25280 | features described below are incomplete and subject to change |
25281 | (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}). | |
922fbb7b AC |
25282 | |
25283 | @unnumberedsec Notation and Terminology | |
25284 | ||
25285 | @cindex notational conventions, for @sc{gdb/mi} | |
25286 | This chapter uses the following notation: | |
25287 | ||
25288 | @itemize @bullet | |
25289 | @item | |
25290 | @code{|} separates two alternatives. | |
25291 | ||
25292 | @item | |
25293 | @code{[ @var{something} ]} indicates that @var{something} is optional: | |
25294 | it may or may not be given. | |
25295 | ||
25296 | @item | |
25297 | @code{( @var{group} )*} means that @var{group} inside the parentheses | |
25298 | may repeat zero or more times. | |
25299 | ||
25300 | @item | |
25301 | @code{( @var{group} )+} means that @var{group} inside the parentheses | |
25302 | may repeat one or more times. | |
25303 | ||
25304 | @item | |
25305 | @code{"@var{string}"} means a literal @var{string}. | |
25306 | @end itemize | |
25307 | ||
25308 | @ignore | |
25309 | @heading Dependencies | |
25310 | @end ignore | |
25311 | ||
922fbb7b | 25312 | @menu |
c3b108f7 | 25313 | * GDB/MI General Design:: |
922fbb7b AC |
25314 | * GDB/MI Command Syntax:: |
25315 | * GDB/MI Compatibility with CLI:: | |
af6eff6f | 25316 | * GDB/MI Development and Front Ends:: |
922fbb7b | 25317 | * GDB/MI Output Records:: |
ef21caaf | 25318 | * GDB/MI Simple Examples:: |
922fbb7b | 25319 | * GDB/MI Command Description Format:: |
ef21caaf | 25320 | * GDB/MI Breakpoint Commands:: |
a2c02241 NR |
25321 | * GDB/MI Program Context:: |
25322 | * GDB/MI Thread Commands:: | |
5d77fe44 | 25323 | * GDB/MI Ada Tasking Commands:: |
a2c02241 NR |
25324 | * GDB/MI Program Execution:: |
25325 | * GDB/MI Stack Manipulation:: | |
25326 | * GDB/MI Variable Objects:: | |
922fbb7b | 25327 | * GDB/MI Data Manipulation:: |
a2c02241 NR |
25328 | * GDB/MI Tracepoint Commands:: |
25329 | * GDB/MI Symbol Query:: | |
351ff01a | 25330 | * GDB/MI File Commands:: |
922fbb7b AC |
25331 | @ignore |
25332 | * GDB/MI Kod Commands:: | |
25333 | * GDB/MI Memory Overlay Commands:: | |
25334 | * GDB/MI Signal Handling Commands:: | |
25335 | @end ignore | |
922fbb7b | 25336 | * GDB/MI Target Manipulation:: |
a6b151f1 | 25337 | * GDB/MI File Transfer Commands:: |
ef21caaf | 25338 | * GDB/MI Miscellaneous Commands:: |
922fbb7b AC |
25339 | @end menu |
25340 | ||
c3b108f7 VP |
25341 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25342 | @node GDB/MI General Design | |
25343 | @section @sc{gdb/mi} General Design | |
25344 | @cindex GDB/MI General Design | |
25345 | ||
25346 | Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three | |
25347 | parts---commands sent to @value{GDBN}, responses to those commands | |
25348 | and notifications. Each command results in exactly one response, | |
25349 | indicating either successful completion of the command, or an error. | |
25350 | For the commands that do not resume the target, the response contains the | |
25351 | requested information. For the commands that resume the target, the | |
25352 | response only indicates whether the target was successfully resumed. | |
25353 | Notifications is the mechanism for reporting changes in the state of the | |
25354 | target, or in @value{GDBN} state, that cannot conveniently be associated with | |
25355 | a command and reported as part of that command response. | |
25356 | ||
25357 | The important examples of notifications are: | |
25358 | @itemize @bullet | |
25359 | ||
25360 | @item | |
25361 | Exec notifications. These are used to report changes in | |
25362 | target state---when a target is resumed, or stopped. It would not | |
25363 | be feasible to include this information in response of resuming | |
25364 | commands, because one resume commands can result in multiple events in | |
25365 | different threads. Also, quite some time may pass before any event | |
25366 | happens in the target, while a frontend needs to know whether the resuming | |
25367 | command itself was successfully executed. | |
25368 | ||
25369 | @item | |
25370 | Console output, and status notifications. Console output | |
25371 | notifications are used to report output of CLI commands, as well as | |
25372 | diagnostics for other commands. Status notifications are used to | |
25373 | report the progress of a long-running operation. Naturally, including | |
25374 | this information in command response would mean no output is produced | |
25375 | until the command is finished, which is undesirable. | |
25376 | ||
25377 | @item | |
25378 | General notifications. Commands may have various side effects on | |
25379 | the @value{GDBN} or target state beyond their official purpose. For example, | |
25380 | a command may change the selected thread. Although such changes can | |
25381 | be included in command response, using notification allows for more | |
25382 | orthogonal frontend design. | |
25383 | ||
25384 | @end itemize | |
25385 | ||
25386 | There's no guarantee that whenever an MI command reports an error, | |
25387 | @value{GDBN} or the target are in any specific state, and especially, | |
25388 | the state is not reverted to the state before the MI command was | |
25389 | processed. Therefore, whenever an MI command results in an error, | |
25390 | we recommend that the frontend refreshes all the information shown in | |
25391 | the user interface. | |
25392 | ||
508094de NR |
25393 | |
25394 | @menu | |
25395 | * Context management:: | |
25396 | * Asynchronous and non-stop modes:: | |
25397 | * Thread groups:: | |
25398 | @end menu | |
25399 | ||
25400 | @node Context management | |
c3b108f7 VP |
25401 | @subsection Context management |
25402 | ||
25403 | In most cases when @value{GDBN} accesses the target, this access is | |
25404 | done in context of a specific thread and frame (@pxref{Frames}). | |
25405 | Often, even when accessing global data, the target requires that a thread | |
25406 | be specified. The CLI interface maintains the selected thread and frame, | |
25407 | and supplies them to target on each command. This is convenient, | |
25408 | because a command line user would not want to specify that information | |
25409 | explicitly on each command, and because user interacts with | |
25410 | @value{GDBN} via a single terminal, so no confusion is possible as | |
25411 | to what thread and frame are the current ones. | |
25412 | ||
25413 | In the case of MI, the concept of selected thread and frame is less | |
25414 | useful. First, a frontend can easily remember this information | |
25415 | itself. Second, a graphical frontend can have more than one window, | |
25416 | each one used for debugging a different thread, and the frontend might | |
25417 | want to access additional threads for internal purposes. This | |
25418 | increases the risk that by relying on implicitly selected thread, the | |
25419 | frontend may be operating on a wrong one. Therefore, each MI command | |
25420 | should explicitly specify which thread and frame to operate on. To | |
25421 | make it possible, each MI command accepts the @samp{--thread} and | |
25422 | @samp{--frame} options, the value to each is @value{GDBN} identifier | |
25423 | for thread and frame to operate on. | |
25424 | ||
25425 | Usually, each top-level window in a frontend allows the user to select | |
25426 | a thread and a frame, and remembers the user selection for further | |
25427 | operations. However, in some cases @value{GDBN} may suggest that the | |
25428 | current thread be changed. For example, when stopping on a breakpoint | |
25429 | it is reasonable to switch to the thread where breakpoint is hit. For | |
25430 | another example, if the user issues the CLI @samp{thread} command via | |
25431 | the frontend, it is desirable to change the frontend's selected thread to the | |
25432 | one specified by user. @value{GDBN} communicates the suggestion to | |
25433 | change current thread using the @samp{=thread-selected} notification. | |
25434 | No such notification is available for the selected frame at the moment. | |
25435 | ||
25436 | Note that historically, MI shares the selected thread with CLI, so | |
25437 | frontends used the @code{-thread-select} to execute commands in the | |
25438 | right context. However, getting this to work right is cumbersome. The | |
25439 | simplest way is for frontend to emit @code{-thread-select} command | |
25440 | before every command. This doubles the number of commands that need | |
25441 | to be sent. The alternative approach is to suppress @code{-thread-select} | |
25442 | if the selected thread in @value{GDBN} is supposed to be identical to the | |
25443 | thread the frontend wants to operate on. However, getting this | |
25444 | optimization right can be tricky. In particular, if the frontend | |
25445 | sends several commands to @value{GDBN}, and one of the commands changes the | |
25446 | selected thread, then the behaviour of subsequent commands will | |
25447 | change. So, a frontend should either wait for response from such | |
25448 | problematic commands, or explicitly add @code{-thread-select} for | |
25449 | all subsequent commands. No frontend is known to do this exactly | |
25450 | right, so it is suggested to just always pass the @samp{--thread} and | |
25451 | @samp{--frame} options. | |
25452 | ||
508094de | 25453 | @node Asynchronous and non-stop modes |
c3b108f7 VP |
25454 | @subsection Asynchronous command execution and non-stop mode |
25455 | ||
25456 | On some targets, @value{GDBN} is capable of processing MI commands | |
25457 | even while the target is running. This is called @dfn{asynchronous | |
25458 | command execution} (@pxref{Background Execution}). The frontend may | |
25459 | specify a preferrence for asynchronous execution using the | |
25460 | @code{-gdb-set target-async 1} command, which should be emitted before | |
25461 | either running the executable or attaching to the target. After the | |
25462 | frontend has started the executable or attached to the target, it can | |
25463 | find if asynchronous execution is enabled using the | |
25464 | @code{-list-target-features} command. | |
25465 | ||
25466 | Even if @value{GDBN} can accept a command while target is running, | |
25467 | many commands that access the target do not work when the target is | |
25468 | running. Therefore, asynchronous command execution is most useful | |
25469 | when combined with non-stop mode (@pxref{Non-Stop Mode}). Then, | |
25470 | it is possible to examine the state of one thread, while other threads | |
25471 | are running. | |
25472 | ||
25473 | When a given thread is running, MI commands that try to access the | |
25474 | target in the context of that thread may not work, or may work only on | |
25475 | some targets. In particular, commands that try to operate on thread's | |
25476 | stack will not work, on any target. Commands that read memory, or | |
25477 | modify breakpoints, may work or not work, depending on the target. Note | |
25478 | that even commands that operate on global state, such as @code{print}, | |
25479 | @code{set}, and breakpoint commands, still access the target in the | |
25480 | context of a specific thread, so frontend should try to find a | |
25481 | stopped thread and perform the operation on that thread (using the | |
25482 | @samp{--thread} option). | |
25483 | ||
25484 | Which commands will work in the context of a running thread is | |
25485 | highly target dependent. However, the two commands | |
25486 | @code{-exec-interrupt}, to stop a thread, and @code{-thread-info}, | |
25487 | to find the state of a thread, will always work. | |
25488 | ||
508094de | 25489 | @node Thread groups |
c3b108f7 VP |
25490 | @subsection Thread groups |
25491 | @value{GDBN} may be used to debug several processes at the same time. | |
25492 | On some platfroms, @value{GDBN} may support debugging of several | |
25493 | hardware systems, each one having several cores with several different | |
25494 | processes running on each core. This section describes the MI | |
25495 | mechanism to support such debugging scenarios. | |
25496 | ||
25497 | The key observation is that regardless of the structure of the | |
25498 | target, MI can have a global list of threads, because most commands that | |
25499 | accept the @samp{--thread} option do not need to know what process that | |
25500 | thread belongs to. Therefore, it is not necessary to introduce | |
25501 | neither additional @samp{--process} option, nor an notion of the | |
25502 | current process in the MI interface. The only strictly new feature | |
25503 | that is required is the ability to find how the threads are grouped | |
25504 | into processes. | |
25505 | ||
25506 | To allow the user to discover such grouping, and to support arbitrary | |
25507 | hierarchy of machines/cores/processes, MI introduces the concept of a | |
25508 | @dfn{thread group}. Thread group is a collection of threads and other | |
25509 | thread groups. A thread group always has a string identifier, a type, | |
25510 | and may have additional attributes specific to the type. A new | |
25511 | command, @code{-list-thread-groups}, returns the list of top-level | |
25512 | thread groups, which correspond to processes that @value{GDBN} is | |
25513 | debugging at the moment. By passing an identifier of a thread group | |
25514 | to the @code{-list-thread-groups} command, it is possible to obtain | |
25515 | the members of specific thread group. | |
25516 | ||
25517 | To allow the user to easily discover processes, and other objects, he | |
25518 | wishes to debug, a concept of @dfn{available thread group} is | |
25519 | introduced. Available thread group is an thread group that | |
25520 | @value{GDBN} is not debugging, but that can be attached to, using the | |
25521 | @code{-target-attach} command. The list of available top-level thread | |
25522 | groups can be obtained using @samp{-list-thread-groups --available}. | |
25523 | In general, the content of a thread group may be only retrieved only | |
25524 | after attaching to that thread group. | |
25525 | ||
a79b8f6e VP |
25526 | Thread groups are related to inferiors (@pxref{Inferiors and |
25527 | Programs}). Each inferior corresponds to a thread group of a special | |
25528 | type @samp{process}, and some additional operations are permitted on | |
25529 | such thread groups. | |
25530 | ||
922fbb7b AC |
25531 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25532 | @node GDB/MI Command Syntax | |
25533 | @section @sc{gdb/mi} Command Syntax | |
25534 | ||
25535 | @menu | |
25536 | * GDB/MI Input Syntax:: | |
25537 | * GDB/MI Output Syntax:: | |
922fbb7b AC |
25538 | @end menu |
25539 | ||
25540 | @node GDB/MI Input Syntax | |
25541 | @subsection @sc{gdb/mi} Input Syntax | |
25542 | ||
25543 | @cindex input syntax for @sc{gdb/mi} | |
25544 | @cindex @sc{gdb/mi}, input syntax | |
25545 | @table @code | |
25546 | @item @var{command} @expansion{} | |
25547 | @code{@var{cli-command} | @var{mi-command}} | |
25548 | ||
25549 | @item @var{cli-command} @expansion{} | |
25550 | @code{[ @var{token} ] @var{cli-command} @var{nl}}, where | |
25551 | @var{cli-command} is any existing @value{GDBN} CLI command. | |
25552 | ||
25553 | @item @var{mi-command} @expansion{} | |
25554 | @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )* | |
25555 | @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}} | |
25556 | ||
25557 | @item @var{token} @expansion{} | |
25558 | "any sequence of digits" | |
25559 | ||
25560 | @item @var{option} @expansion{} | |
25561 | @code{"-" @var{parameter} [ " " @var{parameter} ]} | |
25562 | ||
25563 | @item @var{parameter} @expansion{} | |
25564 | @code{@var{non-blank-sequence} | @var{c-string}} | |
25565 | ||
25566 | @item @var{operation} @expansion{} | |
25567 | @emph{any of the operations described in this chapter} | |
25568 | ||
25569 | @item @var{non-blank-sequence} @expansion{} | |
25570 | @emph{anything, provided it doesn't contain special characters such as | |
25571 | "-", @var{nl}, """ and of course " "} | |
25572 | ||
25573 | @item @var{c-string} @expansion{} | |
25574 | @code{""" @var{seven-bit-iso-c-string-content} """} | |
25575 | ||
25576 | @item @var{nl} @expansion{} | |
25577 | @code{CR | CR-LF} | |
25578 | @end table | |
25579 | ||
25580 | @noindent | |
25581 | Notes: | |
25582 | ||
25583 | @itemize @bullet | |
25584 | @item | |
25585 | The CLI commands are still handled by the @sc{mi} interpreter; their | |
25586 | output is described below. | |
25587 | ||
25588 | @item | |
25589 | The @code{@var{token}}, when present, is passed back when the command | |
25590 | finishes. | |
25591 | ||
25592 | @item | |
25593 | Some @sc{mi} commands accept optional arguments as part of the parameter | |
25594 | list. Each option is identified by a leading @samp{-} (dash) and may be | |
25595 | followed by an optional argument parameter. Options occur first in the | |
25596 | parameter list and can be delimited from normal parameters using | |
25597 | @samp{--} (this is useful when some parameters begin with a dash). | |
25598 | @end itemize | |
25599 | ||
25600 | Pragmatics: | |
25601 | ||
25602 | @itemize @bullet | |
25603 | @item | |
25604 | We want easy access to the existing CLI syntax (for debugging). | |
25605 | ||
25606 | @item | |
25607 | We want it to be easy to spot a @sc{mi} operation. | |
25608 | @end itemize | |
25609 | ||
25610 | @node GDB/MI Output Syntax | |
25611 | @subsection @sc{gdb/mi} Output Syntax | |
25612 | ||
25613 | @cindex output syntax of @sc{gdb/mi} | |
25614 | @cindex @sc{gdb/mi}, output syntax | |
25615 | The output from @sc{gdb/mi} consists of zero or more out-of-band records | |
25616 | followed, optionally, by a single result record. This result record | |
25617 | is for the most recent command. The sequence of output records is | |
594fe323 | 25618 | terminated by @samp{(gdb)}. |
922fbb7b AC |
25619 | |
25620 | If an input command was prefixed with a @code{@var{token}} then the | |
25621 | corresponding output for that command will also be prefixed by that same | |
25622 | @var{token}. | |
25623 | ||
25624 | @table @code | |
25625 | @item @var{output} @expansion{} | |
594fe323 | 25626 | @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}} |
922fbb7b AC |
25627 | |
25628 | @item @var{result-record} @expansion{} | |
25629 | @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}} | |
25630 | ||
25631 | @item @var{out-of-band-record} @expansion{} | |
25632 | @code{@var{async-record} | @var{stream-record}} | |
25633 | ||
25634 | @item @var{async-record} @expansion{} | |
25635 | @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}} | |
25636 | ||
25637 | @item @var{exec-async-output} @expansion{} | |
25638 | @code{[ @var{token} ] "*" @var{async-output}} | |
25639 | ||
25640 | @item @var{status-async-output} @expansion{} | |
25641 | @code{[ @var{token} ] "+" @var{async-output}} | |
25642 | ||
25643 | @item @var{notify-async-output} @expansion{} | |
25644 | @code{[ @var{token} ] "=" @var{async-output}} | |
25645 | ||
25646 | @item @var{async-output} @expansion{} | |
25647 | @code{@var{async-class} ( "," @var{result} )* @var{nl}} | |
25648 | ||
25649 | @item @var{result-class} @expansion{} | |
25650 | @code{"done" | "running" | "connected" | "error" | "exit"} | |
25651 | ||
25652 | @item @var{async-class} @expansion{} | |
25653 | @code{"stopped" | @var{others}} (where @var{others} will be added | |
25654 | depending on the needs---this is still in development). | |
25655 | ||
25656 | @item @var{result} @expansion{} | |
25657 | @code{ @var{variable} "=" @var{value}} | |
25658 | ||
25659 | @item @var{variable} @expansion{} | |
25660 | @code{ @var{string} } | |
25661 | ||
25662 | @item @var{value} @expansion{} | |
25663 | @code{ @var{const} | @var{tuple} | @var{list} } | |
25664 | ||
25665 | @item @var{const} @expansion{} | |
25666 | @code{@var{c-string}} | |
25667 | ||
25668 | @item @var{tuple} @expansion{} | |
25669 | @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" } | |
25670 | ||
25671 | @item @var{list} @expansion{} | |
25672 | @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "[" | |
25673 | @var{result} ( "," @var{result} )* "]" } | |
25674 | ||
25675 | @item @var{stream-record} @expansion{} | |
25676 | @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}} | |
25677 | ||
25678 | @item @var{console-stream-output} @expansion{} | |
25679 | @code{"~" @var{c-string}} | |
25680 | ||
25681 | @item @var{target-stream-output} @expansion{} | |
25682 | @code{"@@" @var{c-string}} | |
25683 | ||
25684 | @item @var{log-stream-output} @expansion{} | |
25685 | @code{"&" @var{c-string}} | |
25686 | ||
25687 | @item @var{nl} @expansion{} | |
25688 | @code{CR | CR-LF} | |
25689 | ||
25690 | @item @var{token} @expansion{} | |
25691 | @emph{any sequence of digits}. | |
25692 | @end table | |
25693 | ||
25694 | @noindent | |
25695 | Notes: | |
25696 | ||
25697 | @itemize @bullet | |
25698 | @item | |
25699 | All output sequences end in a single line containing a period. | |
25700 | ||
25701 | @item | |
721c02de VP |
25702 | The @code{@var{token}} is from the corresponding request. Note that |
25703 | for all async output, while the token is allowed by the grammar and | |
25704 | may be output by future versions of @value{GDBN} for select async | |
25705 | output messages, it is generally omitted. Frontends should treat | |
25706 | all async output as reporting general changes in the state of the | |
25707 | target and there should be no need to associate async output to any | |
25708 | prior command. | |
922fbb7b AC |
25709 | |
25710 | @item | |
25711 | @cindex status output in @sc{gdb/mi} | |
25712 | @var{status-async-output} contains on-going status information about the | |
25713 | progress of a slow operation. It can be discarded. All status output is | |
25714 | prefixed by @samp{+}. | |
25715 | ||
25716 | @item | |
25717 | @cindex async output in @sc{gdb/mi} | |
25718 | @var{exec-async-output} contains asynchronous state change on the target | |
25719 | (stopped, started, disappeared). All async output is prefixed by | |
25720 | @samp{*}. | |
25721 | ||
25722 | @item | |
25723 | @cindex notify output in @sc{gdb/mi} | |
25724 | @var{notify-async-output} contains supplementary information that the | |
25725 | client should handle (e.g., a new breakpoint information). All notify | |
25726 | output is prefixed by @samp{=}. | |
25727 | ||
25728 | @item | |
25729 | @cindex console output in @sc{gdb/mi} | |
25730 | @var{console-stream-output} is output that should be displayed as is in the | |
25731 | console. It is the textual response to a CLI command. All the console | |
25732 | output is prefixed by @samp{~}. | |
25733 | ||
25734 | @item | |
25735 | @cindex target output in @sc{gdb/mi} | |
25736 | @var{target-stream-output} is the output produced by the target program. | |
25737 | All the target output is prefixed by @samp{@@}. | |
25738 | ||
25739 | @item | |
25740 | @cindex log output in @sc{gdb/mi} | |
25741 | @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for | |
25742 | instance messages that should be displayed as part of an error log. All | |
25743 | the log output is prefixed by @samp{&}. | |
25744 | ||
25745 | @item | |
25746 | @cindex list output in @sc{gdb/mi} | |
25747 | New @sc{gdb/mi} commands should only output @var{lists} containing | |
25748 | @var{values}. | |
25749 | ||
25750 | ||
25751 | @end itemize | |
25752 | ||
25753 | @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more | |
25754 | details about the various output records. | |
25755 | ||
922fbb7b AC |
25756 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25757 | @node GDB/MI Compatibility with CLI | |
25758 | @section @sc{gdb/mi} Compatibility with CLI | |
25759 | ||
25760 | @cindex compatibility, @sc{gdb/mi} and CLI | |
25761 | @cindex @sc{gdb/mi}, compatibility with CLI | |
922fbb7b | 25762 | |
a2c02241 NR |
25763 | For the developers convenience CLI commands can be entered directly, |
25764 | but there may be some unexpected behaviour. For example, commands | |
25765 | that query the user will behave as if the user replied yes, breakpoint | |
25766 | command lists are not executed and some CLI commands, such as | |
25767 | @code{if}, @code{when} and @code{define}, prompt for further input with | |
25768 | @samp{>}, which is not valid MI output. | |
ef21caaf NR |
25769 | |
25770 | This feature may be removed at some stage in the future and it is | |
a2c02241 NR |
25771 | recommended that front ends use the @code{-interpreter-exec} command |
25772 | (@pxref{-interpreter-exec}). | |
922fbb7b | 25773 | |
af6eff6f NR |
25774 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25775 | @node GDB/MI Development and Front Ends | |
25776 | @section @sc{gdb/mi} Development and Front Ends | |
25777 | @cindex @sc{gdb/mi} development | |
25778 | ||
25779 | The application which takes the MI output and presents the state of the | |
25780 | program being debugged to the user is called a @dfn{front end}. | |
25781 | ||
25782 | Although @sc{gdb/mi} is still incomplete, it is currently being used | |
25783 | by a variety of front ends to @value{GDBN}. This makes it difficult | |
25784 | to introduce new functionality without breaking existing usage. This | |
25785 | section tries to minimize the problems by describing how the protocol | |
25786 | might change. | |
25787 | ||
25788 | Some changes in MI need not break a carefully designed front end, and | |
25789 | for these the MI version will remain unchanged. The following is a | |
25790 | list of changes that may occur within one level, so front ends should | |
25791 | parse MI output in a way that can handle them: | |
25792 | ||
25793 | @itemize @bullet | |
25794 | @item | |
25795 | New MI commands may be added. | |
25796 | ||
25797 | @item | |
25798 | New fields may be added to the output of any MI command. | |
25799 | ||
36ece8b3 NR |
25800 | @item |
25801 | The range of values for fields with specified values, e.g., | |
9f708cb2 | 25802 | @code{in_scope} (@pxref{-var-update}) may be extended. |
36ece8b3 | 25803 | |
af6eff6f NR |
25804 | @c The format of field's content e.g type prefix, may change so parse it |
25805 | @c at your own risk. Yes, in general? | |
25806 | ||
25807 | @c The order of fields may change? Shouldn't really matter but it might | |
25808 | @c resolve inconsistencies. | |
25809 | @end itemize | |
25810 | ||
25811 | If the changes are likely to break front ends, the MI version level | |
25812 | will be increased by one. This will allow the front end to parse the | |
25813 | output according to the MI version. Apart from mi0, new versions of | |
25814 | @value{GDBN} will not support old versions of MI and it will be the | |
25815 | responsibility of the front end to work with the new one. | |
25816 | ||
25817 | @c Starting with mi3, add a new command -mi-version that prints the MI | |
25818 | @c version? | |
25819 | ||
25820 | The best way to avoid unexpected changes in MI that might break your front | |
25821 | end is to make your project known to @value{GDBN} developers and | |
7a9a6b69 | 25822 | follow development on @email{gdb@@sourceware.org} and |
fa0f268d | 25823 | @email{gdb-patches@@sourceware.org}. |
af6eff6f NR |
25824 | @cindex mailing lists |
25825 | ||
922fbb7b AC |
25826 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
25827 | @node GDB/MI Output Records | |
25828 | @section @sc{gdb/mi} Output Records | |
25829 | ||
25830 | @menu | |
25831 | * GDB/MI Result Records:: | |
25832 | * GDB/MI Stream Records:: | |
82f68b1c | 25833 | * GDB/MI Async Records:: |
c3b108f7 | 25834 | * GDB/MI Frame Information:: |
dc146f7c | 25835 | * GDB/MI Thread Information:: |
4368ebeb | 25836 | * GDB/MI Ada Exception Information:: |
922fbb7b AC |
25837 | @end menu |
25838 | ||
25839 | @node GDB/MI Result Records | |
25840 | @subsection @sc{gdb/mi} Result Records | |
25841 | ||
25842 | @cindex result records in @sc{gdb/mi} | |
25843 | @cindex @sc{gdb/mi}, result records | |
25844 | In addition to a number of out-of-band notifications, the response to a | |
25845 | @sc{gdb/mi} command includes one of the following result indications: | |
25846 | ||
25847 | @table @code | |
25848 | @findex ^done | |
25849 | @item "^done" [ "," @var{results} ] | |
25850 | The synchronous operation was successful, @code{@var{results}} are the return | |
25851 | values. | |
25852 | ||
25853 | @item "^running" | |
25854 | @findex ^running | |
8e9c5e02 VP |
25855 | This result record is equivalent to @samp{^done}. Historically, it |
25856 | was output instead of @samp{^done} if the command has resumed the | |
25857 | target. This behaviour is maintained for backward compatibility, but | |
25858 | all frontends should treat @samp{^done} and @samp{^running} | |
25859 | identically and rely on the @samp{*running} output record to determine | |
25860 | which threads are resumed. | |
922fbb7b | 25861 | |
ef21caaf NR |
25862 | @item "^connected" |
25863 | @findex ^connected | |
3f94c067 | 25864 | @value{GDBN} has connected to a remote target. |
ef21caaf | 25865 | |
922fbb7b AC |
25866 | @item "^error" "," @var{c-string} |
25867 | @findex ^error | |
25868 | The operation failed. The @code{@var{c-string}} contains the corresponding | |
25869 | error message. | |
ef21caaf NR |
25870 | |
25871 | @item "^exit" | |
25872 | @findex ^exit | |
3f94c067 | 25873 | @value{GDBN} has terminated. |
ef21caaf | 25874 | |
922fbb7b AC |
25875 | @end table |
25876 | ||
25877 | @node GDB/MI Stream Records | |
25878 | @subsection @sc{gdb/mi} Stream Records | |
25879 | ||
25880 | @cindex @sc{gdb/mi}, stream records | |
25881 | @cindex stream records in @sc{gdb/mi} | |
25882 | @value{GDBN} internally maintains a number of output streams: the console, the | |
25883 | target, and the log. The output intended for each of these streams is | |
25884 | funneled through the @sc{gdb/mi} interface using @dfn{stream records}. | |
25885 | ||
25886 | Each stream record begins with a unique @dfn{prefix character} which | |
25887 | identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output | |
25888 | Syntax}). In addition to the prefix, each stream record contains a | |
25889 | @code{@var{string-output}}. This is either raw text (with an implicit new | |
25890 | line) or a quoted C string (which does not contain an implicit newline). | |
25891 | ||
25892 | @table @code | |
25893 | @item "~" @var{string-output} | |
25894 | The console output stream contains text that should be displayed in the | |
25895 | CLI console window. It contains the textual responses to CLI commands. | |
25896 | ||
25897 | @item "@@" @var{string-output} | |
25898 | The target output stream contains any textual output from the running | |
ef21caaf NR |
25899 | target. This is only present when GDB's event loop is truly |
25900 | asynchronous, which is currently only the case for remote targets. | |
922fbb7b AC |
25901 | |
25902 | @item "&" @var{string-output} | |
25903 | The log stream contains debugging messages being produced by @value{GDBN}'s | |
25904 | internals. | |
25905 | @end table | |
25906 | ||
82f68b1c VP |
25907 | @node GDB/MI Async Records |
25908 | @subsection @sc{gdb/mi} Async Records | |
922fbb7b | 25909 | |
82f68b1c VP |
25910 | @cindex async records in @sc{gdb/mi} |
25911 | @cindex @sc{gdb/mi}, async records | |
25912 | @dfn{Async} records are used to notify the @sc{gdb/mi} client of | |
922fbb7b | 25913 | additional changes that have occurred. Those changes can either be a |
82f68b1c | 25914 | consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of |
922fbb7b AC |
25915 | target activity (e.g., target stopped). |
25916 | ||
8eb41542 | 25917 | The following is the list of possible async records: |
922fbb7b AC |
25918 | |
25919 | @table @code | |
034dad6f | 25920 | |
e1ac3328 VP |
25921 | @item *running,thread-id="@var{thread}" |
25922 | The target is now running. The @var{thread} field tells which | |
25923 | specific thread is now running, and can be @samp{all} if all threads | |
25924 | are running. The frontend should assume that no interaction with a | |
25925 | running thread is possible after this notification is produced. | |
25926 | The frontend should not assume that this notification is output | |
25927 | only once for any command. @value{GDBN} may emit this notification | |
25928 | several times, either for different threads, because it cannot resume | |
25929 | all threads together, or even for a single thread, if the thread must | |
25930 | be stepped though some code before letting it run freely. | |
25931 | ||
dc146f7c | 25932 | @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}" |
82f68b1c VP |
25933 | The target has stopped. The @var{reason} field can have one of the |
25934 | following values: | |
034dad6f BR |
25935 | |
25936 | @table @code | |
25937 | @item breakpoint-hit | |
25938 | A breakpoint was reached. | |
25939 | @item watchpoint-trigger | |
25940 | A watchpoint was triggered. | |
25941 | @item read-watchpoint-trigger | |
25942 | A read watchpoint was triggered. | |
25943 | @item access-watchpoint-trigger | |
25944 | An access watchpoint was triggered. | |
25945 | @item function-finished | |
25946 | An -exec-finish or similar CLI command was accomplished. | |
25947 | @item location-reached | |
25948 | An -exec-until or similar CLI command was accomplished. | |
25949 | @item watchpoint-scope | |
25950 | A watchpoint has gone out of scope. | |
25951 | @item end-stepping-range | |
25952 | An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or | |
25953 | similar CLI command was accomplished. | |
25954 | @item exited-signalled | |
25955 | The inferior exited because of a signal. | |
25956 | @item exited | |
25957 | The inferior exited. | |
25958 | @item exited-normally | |
25959 | The inferior exited normally. | |
25960 | @item signal-received | |
25961 | A signal was received by the inferior. | |
922fbb7b AC |
25962 | @end table |
25963 | ||
c3b108f7 VP |
25964 | The @var{id} field identifies the thread that directly caused the stop |
25965 | -- for example by hitting a breakpoint. Depending on whether all-stop | |
25966 | mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either | |
25967 | stop all threads, or only the thread that directly triggered the stop. | |
25968 | If all threads are stopped, the @var{stopped} field will have the | |
25969 | value of @code{"all"}. Otherwise, the value of the @var{stopped} | |
25970 | field will be a list of thread identifiers. Presently, this list will | |
25971 | always include a single thread, but frontend should be prepared to see | |
dc146f7c VP |
25972 | several threads in the list. The @var{core} field reports the |
25973 | processor core on which the stop event has happened. This field may be absent | |
25974 | if such information is not available. | |
c3b108f7 | 25975 | |
a79b8f6e VP |
25976 | @item =thread-group-added,id="@var{id}" |
25977 | @itemx =thread-group-removed,id="@var{id}" | |
25978 | A thread group was either added or removed. The @var{id} field | |
25979 | contains the @value{GDBN} identifier of the thread group. When a thread | |
25980 | group is added, it generally might not be associated with a running | |
25981 | process. When a thread group is removed, its id becomes invalid and | |
25982 | cannot be used in any way. | |
25983 | ||
25984 | @item =thread-group-started,id="@var{id}",pid="@var{pid}" | |
25985 | A thread group became associated with a running program, | |
25986 | either because the program was just started or the thread group | |
25987 | was attached to a program. The @var{id} field contains the | |
25988 | @value{GDBN} identifier of the thread group. The @var{pid} field | |
25989 | contains process identifier, specific to the operating system. | |
25990 | ||
8cf64490 | 25991 | @item =thread-group-exited,id="@var{id}"[,exit-code="@var{code}"] |
a79b8f6e VP |
25992 | A thread group is no longer associated with a running program, |
25993 | either because the program has exited, or because it was detached | |
c3b108f7 | 25994 | from. The @var{id} field contains the @value{GDBN} identifier of the |
8cf64490 TT |
25995 | thread group. @var{code} is the exit code of the inferior; it exists |
25996 | only when the inferior exited with some code. | |
c3b108f7 VP |
25997 | |
25998 | @item =thread-created,id="@var{id}",group-id="@var{gid}" | |
25999 | @itemx =thread-exited,id="@var{id}",group-id="@var{gid}" | |
82f68b1c | 26000 | A thread either was created, or has exited. The @var{id} field |
c3b108f7 VP |
26001 | contains the @value{GDBN} identifier of the thread. The @var{gid} |
26002 | field identifies the thread group this thread belongs to. | |
66bb093b VP |
26003 | |
26004 | @item =thread-selected,id="@var{id}" | |
26005 | Informs that the selected thread was changed as result of the last | |
26006 | command. This notification is not emitted as result of @code{-thread-select} | |
26007 | command but is emitted whenever an MI command that is not documented | |
26008 | to change the selected thread actually changes it. In particular, | |
26009 | invoking, directly or indirectly (via user-defined command), the CLI | |
26010 | @code{thread} command, will generate this notification. | |
26011 | ||
26012 | We suggest that in response to this notification, front ends | |
26013 | highlight the selected thread and cause subsequent commands to apply to | |
26014 | that thread. | |
26015 | ||
c86cf029 VP |
26016 | @item =library-loaded,... |
26017 | Reports that a new library file was loaded by the program. This | |
26018 | notification has 4 fields---@var{id}, @var{target-name}, | |
134eb42c | 26019 | @var{host-name}, and @var{symbols-loaded}. The @var{id} field is an |
c86cf029 VP |
26020 | opaque identifier of the library. For remote debugging case, |
26021 | @var{target-name} and @var{host-name} fields give the name of the | |
134eb42c VP |
26022 | library file on the target, and on the host respectively. For native |
26023 | debugging, both those fields have the same value. The | |
f1cbe1d3 TT |
26024 | @var{symbols-loaded} field is emitted only for backward compatibility |
26025 | and should not be relied on to convey any useful information. The | |
26026 | @var{thread-group} field, if present, specifies the id of the thread | |
26027 | group in whose context the library was loaded. If the field is | |
26028 | absent, it means the library was loaded in the context of all present | |
26029 | thread groups. | |
c86cf029 VP |
26030 | |
26031 | @item =library-unloaded,... | |
134eb42c | 26032 | Reports that a library was unloaded by the program. This notification |
c86cf029 | 26033 | has 3 fields---@var{id}, @var{target-name} and @var{host-name} with |
a79b8f6e VP |
26034 | the same meaning as for the @code{=library-loaded} notification. |
26035 | The @var{thread-group} field, if present, specifies the id of the | |
26036 | thread group in whose context the library was unloaded. If the field is | |
26037 | absent, it means the library was unloaded in the context of all present | |
26038 | thread groups. | |
c86cf029 | 26039 | |
8d3788bd VP |
26040 | @item =breakpoint-created,bkpt=@{...@} |
26041 | @itemx =breakpoint-modified,bkpt=@{...@} | |
26042 | @itemx =breakpoint-deleted,bkpt=@{...@} | |
26043 | Reports that a breakpoint was created, modified, or deleted, | |
26044 | respectively. Only user-visible breakpoints are reported to the MI | |
26045 | user. | |
26046 | ||
26047 | The @var{bkpt} argument is of the same form as returned by the various | |
26048 | breakpoint commands; @xref{GDB/MI Breakpoint Commands}. | |
26049 | ||
26050 | Note that if a breakpoint is emitted in the result record of a | |
26051 | command, then it will not also be emitted in an async record. | |
26052 | ||
82f68b1c VP |
26053 | @end table |
26054 | ||
c3b108f7 VP |
26055 | @node GDB/MI Frame Information |
26056 | @subsection @sc{gdb/mi} Frame Information | |
26057 | ||
26058 | Response from many MI commands includes an information about stack | |
26059 | frame. This information is a tuple that may have the following | |
26060 | fields: | |
26061 | ||
26062 | @table @code | |
26063 | @item level | |
26064 | The level of the stack frame. The innermost frame has the level of | |
26065 | zero. This field is always present. | |
26066 | ||
26067 | @item func | |
26068 | The name of the function corresponding to the frame. This field may | |
26069 | be absent if @value{GDBN} is unable to determine the function name. | |
26070 | ||
26071 | @item addr | |
26072 | The code address for the frame. This field is always present. | |
26073 | ||
26074 | @item file | |
26075 | The name of the source files that correspond to the frame's code | |
26076 | address. This field may be absent. | |
26077 | ||
26078 | @item line | |
26079 | The source line corresponding to the frames' code address. This field | |
26080 | may be absent. | |
26081 | ||
26082 | @item from | |
26083 | The name of the binary file (either executable or shared library) the | |
26084 | corresponds to the frame's code address. This field may be absent. | |
26085 | ||
26086 | @end table | |
82f68b1c | 26087 | |
dc146f7c VP |
26088 | @node GDB/MI Thread Information |
26089 | @subsection @sc{gdb/mi} Thread Information | |
26090 | ||
26091 | Whenever @value{GDBN} has to report an information about a thread, it | |
26092 | uses a tuple with the following fields: | |
26093 | ||
26094 | @table @code | |
26095 | @item id | |
26096 | The numeric id assigned to the thread by @value{GDBN}. This field is | |
26097 | always present. | |
26098 | ||
26099 | @item target-id | |
26100 | Target-specific string identifying the thread. This field is always present. | |
26101 | ||
26102 | @item details | |
26103 | Additional information about the thread provided by the target. | |
26104 | It is supposed to be human-readable and not interpreted by the | |
26105 | frontend. This field is optional. | |
26106 | ||
26107 | @item state | |
26108 | Either @samp{stopped} or @samp{running}, depending on whether the | |
26109 | thread is presently running. This field is always present. | |
26110 | ||
26111 | @item core | |
26112 | The value of this field is an integer number of the processor core the | |
26113 | thread was last seen on. This field is optional. | |
26114 | @end table | |
26115 | ||
956a9fb9 JB |
26116 | @node GDB/MI Ada Exception Information |
26117 | @subsection @sc{gdb/mi} Ada Exception Information | |
26118 | ||
26119 | Whenever a @code{*stopped} record is emitted because the program | |
26120 | stopped after hitting an exception catchpoint (@pxref{Set Catchpoints}), | |
26121 | @value{GDBN} provides the name of the exception that was raised via | |
26122 | the @code{exception-name} field. | |
922fbb7b | 26123 | |
ef21caaf NR |
26124 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
26125 | @node GDB/MI Simple Examples | |
26126 | @section Simple Examples of @sc{gdb/mi} Interaction | |
26127 | @cindex @sc{gdb/mi}, simple examples | |
26128 | ||
26129 | This subsection presents several simple examples of interaction using | |
26130 | the @sc{gdb/mi} interface. In these examples, @samp{->} means that the | |
26131 | following line is passed to @sc{gdb/mi} as input, while @samp{<-} means | |
26132 | the output received from @sc{gdb/mi}. | |
26133 | ||
d3e8051b | 26134 | Note the line breaks shown in the examples are here only for |
ef21caaf NR |
26135 | readability, they don't appear in the real output. |
26136 | ||
79a6e687 | 26137 | @subheading Setting a Breakpoint |
ef21caaf NR |
26138 | |
26139 | Setting a breakpoint generates synchronous output which contains detailed | |
26140 | information of the breakpoint. | |
26141 | ||
26142 | @smallexample | |
26143 | -> -break-insert main | |
26144 | <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep", | |
26145 | enabled="y",addr="0x08048564",func="main",file="myprog.c", | |
26146 | fullname="/home/nickrob/myprog.c",line="68",times="0"@} | |
26147 | <- (gdb) | |
26148 | @end smallexample | |
26149 | ||
26150 | @subheading Program Execution | |
26151 | ||
26152 | Program execution generates asynchronous records and MI gives the | |
26153 | reason that execution stopped. | |
26154 | ||
26155 | @smallexample | |
26156 | -> -exec-run | |
26157 | <- ^running | |
26158 | <- (gdb) | |
a47ec5fe | 26159 | <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0", |
ef21caaf NR |
26160 | frame=@{addr="0x08048564",func="main", |
26161 | args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}], | |
26162 | file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@} | |
26163 | <- (gdb) | |
26164 | -> -exec-continue | |
26165 | <- ^running | |
26166 | <- (gdb) | |
26167 | <- *stopped,reason="exited-normally" | |
26168 | <- (gdb) | |
26169 | @end smallexample | |
26170 | ||
3f94c067 | 26171 | @subheading Quitting @value{GDBN} |
ef21caaf | 26172 | |
3f94c067 | 26173 | Quitting @value{GDBN} just prints the result class @samp{^exit}. |
ef21caaf NR |
26174 | |
26175 | @smallexample | |
26176 | -> (gdb) | |
26177 | <- -gdb-exit | |
26178 | <- ^exit | |
26179 | @end smallexample | |
26180 | ||
a6b29f87 VP |
26181 | Please note that @samp{^exit} is printed immediately, but it might |
26182 | take some time for @value{GDBN} to actually exit. During that time, @value{GDBN} | |
26183 | performs necessary cleanups, including killing programs being debugged | |
26184 | or disconnecting from debug hardware, so the frontend should wait till | |
26185 | @value{GDBN} exits and should only forcibly kill @value{GDBN} if it | |
26186 | fails to exit in reasonable time. | |
26187 | ||
a2c02241 | 26188 | @subheading A Bad Command |
ef21caaf NR |
26189 | |
26190 | Here's what happens if you pass a non-existent command: | |
26191 | ||
26192 | @smallexample | |
26193 | -> -rubbish | |
26194 | <- ^error,msg="Undefined MI command: rubbish" | |
594fe323 | 26195 | <- (gdb) |
ef21caaf NR |
26196 | @end smallexample |
26197 | ||
26198 | ||
922fbb7b AC |
26199 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
26200 | @node GDB/MI Command Description Format | |
26201 | @section @sc{gdb/mi} Command Description Format | |
26202 | ||
26203 | The remaining sections describe blocks of commands. Each block of | |
26204 | commands is laid out in a fashion similar to this section. | |
26205 | ||
922fbb7b AC |
26206 | @subheading Motivation |
26207 | ||
26208 | The motivation for this collection of commands. | |
26209 | ||
26210 | @subheading Introduction | |
26211 | ||
26212 | A brief introduction to this collection of commands as a whole. | |
26213 | ||
26214 | @subheading Commands | |
26215 | ||
26216 | For each command in the block, the following is described: | |
26217 | ||
26218 | @subsubheading Synopsis | |
26219 | ||
26220 | @smallexample | |
26221 | -command @var{args}@dots{} | |
26222 | @end smallexample | |
26223 | ||
922fbb7b AC |
26224 | @subsubheading Result |
26225 | ||
265eeb58 | 26226 | @subsubheading @value{GDBN} Command |
922fbb7b | 26227 | |
265eeb58 | 26228 | The corresponding @value{GDBN} CLI command(s), if any. |
922fbb7b AC |
26229 | |
26230 | @subsubheading Example | |
26231 | ||
ef21caaf NR |
26232 | Example(s) formatted for readability. Some of the described commands have |
26233 | not been implemented yet and these are labeled N.A.@: (not available). | |
26234 | ||
26235 | ||
922fbb7b | 26236 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
ef21caaf NR |
26237 | @node GDB/MI Breakpoint Commands |
26238 | @section @sc{gdb/mi} Breakpoint Commands | |
922fbb7b AC |
26239 | |
26240 | @cindex breakpoint commands for @sc{gdb/mi} | |
26241 | @cindex @sc{gdb/mi}, breakpoint commands | |
26242 | This section documents @sc{gdb/mi} commands for manipulating | |
26243 | breakpoints. | |
26244 | ||
26245 | @subheading The @code{-break-after} Command | |
26246 | @findex -break-after | |
26247 | ||
26248 | @subsubheading Synopsis | |
26249 | ||
26250 | @smallexample | |
26251 | -break-after @var{number} @var{count} | |
26252 | @end smallexample | |
26253 | ||
26254 | The breakpoint number @var{number} is not in effect until it has been | |
26255 | hit @var{count} times. To see how this is reflected in the output of | |
26256 | the @samp{-break-list} command, see the description of the | |
26257 | @samp{-break-list} command below. | |
26258 | ||
26259 | @subsubheading @value{GDBN} Command | |
26260 | ||
26261 | The corresponding @value{GDBN} command is @samp{ignore}. | |
26262 | ||
26263 | @subsubheading Example | |
26264 | ||
26265 | @smallexample | |
594fe323 | 26266 | (gdb) |
922fbb7b | 26267 | -break-insert main |
a47ec5fe AR |
26268 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep", |
26269 | enabled="y",addr="0x000100d0",func="main",file="hello.c", | |
948d5102 | 26270 | fullname="/home/foo/hello.c",line="5",times="0"@} |
594fe323 | 26271 | (gdb) |
922fbb7b AC |
26272 | -break-after 1 3 |
26273 | ~ | |
26274 | ^done | |
594fe323 | 26275 | (gdb) |
922fbb7b AC |
26276 | -break-list |
26277 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
26278 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26279 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26280 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26281 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26282 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26283 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26284 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
26285 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
26286 | line="5",times="0",ignore="3"@}]@} | |
594fe323 | 26287 | (gdb) |
922fbb7b AC |
26288 | @end smallexample |
26289 | ||
26290 | @ignore | |
26291 | @subheading The @code{-break-catch} Command | |
26292 | @findex -break-catch | |
48cb2d85 | 26293 | @end ignore |
922fbb7b AC |
26294 | |
26295 | @subheading The @code{-break-commands} Command | |
26296 | @findex -break-commands | |
922fbb7b | 26297 | |
48cb2d85 VP |
26298 | @subsubheading Synopsis |
26299 | ||
26300 | @smallexample | |
26301 | -break-commands @var{number} [ @var{command1} ... @var{commandN} ] | |
26302 | @end smallexample | |
26303 | ||
26304 | Specifies the CLI commands that should be executed when breakpoint | |
26305 | @var{number} is hit. The parameters @var{command1} to @var{commandN} | |
26306 | are the commands. If no command is specified, any previously-set | |
26307 | commands are cleared. @xref{Break Commands}. Typical use of this | |
26308 | functionality is tracing a program, that is, printing of values of | |
26309 | some variables whenever breakpoint is hit and then continuing. | |
26310 | ||
26311 | @subsubheading @value{GDBN} Command | |
26312 | ||
26313 | The corresponding @value{GDBN} command is @samp{commands}. | |
26314 | ||
26315 | @subsubheading Example | |
26316 | ||
26317 | @smallexample | |
26318 | (gdb) | |
26319 | -break-insert main | |
26320 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep", | |
26321 | enabled="y",addr="0x000100d0",func="main",file="hello.c", | |
26322 | fullname="/home/foo/hello.c",line="5",times="0"@} | |
26323 | (gdb) | |
26324 | -break-commands 1 "print v" "continue" | |
26325 | ^done | |
26326 | (gdb) | |
26327 | @end smallexample | |
922fbb7b AC |
26328 | |
26329 | @subheading The @code{-break-condition} Command | |
26330 | @findex -break-condition | |
26331 | ||
26332 | @subsubheading Synopsis | |
26333 | ||
26334 | @smallexample | |
26335 | -break-condition @var{number} @var{expr} | |
26336 | @end smallexample | |
26337 | ||
26338 | Breakpoint @var{number} will stop the program only if the condition in | |
26339 | @var{expr} is true. The condition becomes part of the | |
26340 | @samp{-break-list} output (see the description of the @samp{-break-list} | |
26341 | command below). | |
26342 | ||
26343 | @subsubheading @value{GDBN} Command | |
26344 | ||
26345 | The corresponding @value{GDBN} command is @samp{condition}. | |
26346 | ||
26347 | @subsubheading Example | |
26348 | ||
26349 | @smallexample | |
594fe323 | 26350 | (gdb) |
922fbb7b AC |
26351 | -break-condition 1 1 |
26352 | ^done | |
594fe323 | 26353 | (gdb) |
922fbb7b AC |
26354 | -break-list |
26355 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
26356 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26357 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26358 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26359 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26360 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26361 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26362 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
26363 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
26364 | line="5",cond="1",times="0",ignore="3"@}]@} | |
594fe323 | 26365 | (gdb) |
922fbb7b AC |
26366 | @end smallexample |
26367 | ||
26368 | @subheading The @code{-break-delete} Command | |
26369 | @findex -break-delete | |
26370 | ||
26371 | @subsubheading Synopsis | |
26372 | ||
26373 | @smallexample | |
26374 | -break-delete ( @var{breakpoint} )+ | |
26375 | @end smallexample | |
26376 | ||
26377 | Delete the breakpoint(s) whose number(s) are specified in the argument | |
26378 | list. This is obviously reflected in the breakpoint list. | |
26379 | ||
79a6e687 | 26380 | @subsubheading @value{GDBN} Command |
922fbb7b AC |
26381 | |
26382 | The corresponding @value{GDBN} command is @samp{delete}. | |
26383 | ||
26384 | @subsubheading Example | |
26385 | ||
26386 | @smallexample | |
594fe323 | 26387 | (gdb) |
922fbb7b AC |
26388 | -break-delete 1 |
26389 | ^done | |
594fe323 | 26390 | (gdb) |
922fbb7b AC |
26391 | -break-list |
26392 | ^done,BreakpointTable=@{nr_rows="0",nr_cols="6", | |
26393 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26394 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26395 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26396 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26397 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26398 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26399 | body=[]@} | |
594fe323 | 26400 | (gdb) |
922fbb7b AC |
26401 | @end smallexample |
26402 | ||
26403 | @subheading The @code{-break-disable} Command | |
26404 | @findex -break-disable | |
26405 | ||
26406 | @subsubheading Synopsis | |
26407 | ||
26408 | @smallexample | |
26409 | -break-disable ( @var{breakpoint} )+ | |
26410 | @end smallexample | |
26411 | ||
26412 | Disable the named @var{breakpoint}(s). The field @samp{enabled} in the | |
26413 | break list is now set to @samp{n} for the named @var{breakpoint}(s). | |
26414 | ||
26415 | @subsubheading @value{GDBN} Command | |
26416 | ||
26417 | The corresponding @value{GDBN} command is @samp{disable}. | |
26418 | ||
26419 | @subsubheading Example | |
26420 | ||
26421 | @smallexample | |
594fe323 | 26422 | (gdb) |
922fbb7b AC |
26423 | -break-disable 2 |
26424 | ^done | |
594fe323 | 26425 | (gdb) |
922fbb7b AC |
26426 | -break-list |
26427 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
26428 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26429 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26430 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26431 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26432 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26433 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26434 | body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n", | |
948d5102 NR |
26435 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
26436 | line="5",times="0"@}]@} | |
594fe323 | 26437 | (gdb) |
922fbb7b AC |
26438 | @end smallexample |
26439 | ||
26440 | @subheading The @code{-break-enable} Command | |
26441 | @findex -break-enable | |
26442 | ||
26443 | @subsubheading Synopsis | |
26444 | ||
26445 | @smallexample | |
26446 | -break-enable ( @var{breakpoint} )+ | |
26447 | @end smallexample | |
26448 | ||
26449 | Enable (previously disabled) @var{breakpoint}(s). | |
26450 | ||
26451 | @subsubheading @value{GDBN} Command | |
26452 | ||
26453 | The corresponding @value{GDBN} command is @samp{enable}. | |
26454 | ||
26455 | @subsubheading Example | |
26456 | ||
26457 | @smallexample | |
594fe323 | 26458 | (gdb) |
922fbb7b AC |
26459 | -break-enable 2 |
26460 | ^done | |
594fe323 | 26461 | (gdb) |
922fbb7b AC |
26462 | -break-list |
26463 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
26464 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26465 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26466 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26467 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26468 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26469 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26470 | body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
26471 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
26472 | line="5",times="0"@}]@} | |
594fe323 | 26473 | (gdb) |
922fbb7b AC |
26474 | @end smallexample |
26475 | ||
26476 | @subheading The @code{-break-info} Command | |
26477 | @findex -break-info | |
26478 | ||
26479 | @subsubheading Synopsis | |
26480 | ||
26481 | @smallexample | |
26482 | -break-info @var{breakpoint} | |
26483 | @end smallexample | |
26484 | ||
26485 | @c REDUNDANT??? | |
26486 | Get information about a single breakpoint. | |
26487 | ||
79a6e687 | 26488 | @subsubheading @value{GDBN} Command |
922fbb7b AC |
26489 | |
26490 | The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}. | |
26491 | ||
26492 | @subsubheading Example | |
26493 | N.A. | |
26494 | ||
26495 | @subheading The @code{-break-insert} Command | |
26496 | @findex -break-insert | |
26497 | ||
26498 | @subsubheading Synopsis | |
26499 | ||
26500 | @smallexample | |
18148017 | 26501 | -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ] |
922fbb7b | 26502 | [ -c @var{condition} ] [ -i @var{ignore-count} ] |
afe8ab22 | 26503 | [ -p @var{thread} ] [ @var{location} ] |
922fbb7b AC |
26504 | @end smallexample |
26505 | ||
26506 | @noindent | |
afe8ab22 | 26507 | If specified, @var{location}, can be one of: |
922fbb7b AC |
26508 | |
26509 | @itemize @bullet | |
26510 | @item function | |
26511 | @c @item +offset | |
26512 | @c @item -offset | |
26513 | @c @item linenum | |
26514 | @item filename:linenum | |
26515 | @item filename:function | |
26516 | @item *address | |
26517 | @end itemize | |
26518 | ||
26519 | The possible optional parameters of this command are: | |
26520 | ||
26521 | @table @samp | |
26522 | @item -t | |
948d5102 | 26523 | Insert a temporary breakpoint. |
922fbb7b AC |
26524 | @item -h |
26525 | Insert a hardware breakpoint. | |
26526 | @item -c @var{condition} | |
26527 | Make the breakpoint conditional on @var{condition}. | |
26528 | @item -i @var{ignore-count} | |
26529 | Initialize the @var{ignore-count}. | |
afe8ab22 VP |
26530 | @item -f |
26531 | If @var{location} cannot be parsed (for example if it | |
26532 | refers to unknown files or functions), create a pending | |
26533 | breakpoint. Without this flag, @value{GDBN} will report | |
26534 | an error, and won't create a breakpoint, if @var{location} | |
26535 | cannot be parsed. | |
41447f92 VP |
26536 | @item -d |
26537 | Create a disabled breakpoint. | |
18148017 VP |
26538 | @item -a |
26539 | Create a tracepoint. @xref{Tracepoints}. When this parameter | |
26540 | is used together with @samp{-h}, a fast tracepoint is created. | |
922fbb7b AC |
26541 | @end table |
26542 | ||
26543 | @subsubheading Result | |
26544 | ||
26545 | The result is in the form: | |
26546 | ||
26547 | @smallexample | |
948d5102 NR |
26548 | ^done,bkpt=@{number="@var{number}",type="@var{type}",disp="del"|"keep", |
26549 | enabled="y"|"n",addr="@var{hex}",func="@var{funcname}",file="@var{filename}", | |
ef21caaf NR |
26550 | fullname="@var{full_filename}",line="@var{lineno}",[thread="@var{threadno},] |
26551 | times="@var{times}"@} | |
922fbb7b AC |
26552 | @end smallexample |
26553 | ||
26554 | @noindent | |
948d5102 NR |
26555 | where @var{number} is the @value{GDBN} number for this breakpoint, |
26556 | @var{funcname} is the name of the function where the breakpoint was | |
26557 | inserted, @var{filename} is the name of the source file which contains | |
26558 | this function, @var{lineno} is the source line number within that file | |
26559 | and @var{times} the number of times that the breakpoint has been hit | |
26560 | (always 0 for -break-insert but may be greater for -break-info or -break-list | |
26561 | which use the same output). | |
922fbb7b AC |
26562 | |
26563 | Note: this format is open to change. | |
26564 | @c An out-of-band breakpoint instead of part of the result? | |
26565 | ||
26566 | @subsubheading @value{GDBN} Command | |
26567 | ||
26568 | The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak}, | |
26569 | @samp{hbreak}, @samp{thbreak}, and @samp{rbreak}. | |
26570 | ||
26571 | @subsubheading Example | |
26572 | ||
26573 | @smallexample | |
594fe323 | 26574 | (gdb) |
922fbb7b | 26575 | -break-insert main |
948d5102 NR |
26576 | ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c", |
26577 | fullname="/home/foo/recursive2.c,line="4",times="0"@} | |
594fe323 | 26578 | (gdb) |
922fbb7b | 26579 | -break-insert -t foo |
948d5102 NR |
26580 | ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c", |
26581 | fullname="/home/foo/recursive2.c,line="11",times="0"@} | |
594fe323 | 26582 | (gdb) |
922fbb7b AC |
26583 | -break-list |
26584 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
26585 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26586 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26587 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26588 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26589 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26590 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26591 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
26592 | addr="0x0001072c", func="main",file="recursive2.c", |
26593 | fullname="/home/foo/recursive2.c,"line="4",times="0"@}, | |
922fbb7b | 26594 | bkpt=@{number="2",type="breakpoint",disp="del",enabled="y", |
948d5102 NR |
26595 | addr="0x00010774",func="foo",file="recursive2.c", |
26596 | fullname="/home/foo/recursive2.c",line="11",times="0"@}]@} | |
594fe323 | 26597 | (gdb) |
922fbb7b AC |
26598 | -break-insert -r foo.* |
26599 | ~int foo(int, int); | |
948d5102 NR |
26600 | ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c, |
26601 | "fullname="/home/foo/recursive2.c",line="11",times="0"@} | |
594fe323 | 26602 | (gdb) |
922fbb7b AC |
26603 | @end smallexample |
26604 | ||
26605 | @subheading The @code{-break-list} Command | |
26606 | @findex -break-list | |
26607 | ||
26608 | @subsubheading Synopsis | |
26609 | ||
26610 | @smallexample | |
26611 | -break-list | |
26612 | @end smallexample | |
26613 | ||
26614 | Displays the list of inserted breakpoints, showing the following fields: | |
26615 | ||
26616 | @table @samp | |
26617 | @item Number | |
26618 | number of the breakpoint | |
26619 | @item Type | |
26620 | type of the breakpoint: @samp{breakpoint} or @samp{watchpoint} | |
26621 | @item Disposition | |
26622 | should the breakpoint be deleted or disabled when it is hit: @samp{keep} | |
26623 | or @samp{nokeep} | |
26624 | @item Enabled | |
26625 | is the breakpoint enabled or no: @samp{y} or @samp{n} | |
26626 | @item Address | |
26627 | memory location at which the breakpoint is set | |
26628 | @item What | |
26629 | logical location of the breakpoint, expressed by function name, file | |
26630 | name, line number | |
26631 | @item Times | |
26632 | number of times the breakpoint has been hit | |
26633 | @end table | |
26634 | ||
26635 | If there are no breakpoints or watchpoints, the @code{BreakpointTable} | |
26636 | @code{body} field is an empty list. | |
26637 | ||
26638 | @subsubheading @value{GDBN} Command | |
26639 | ||
26640 | The corresponding @value{GDBN} command is @samp{info break}. | |
26641 | ||
26642 | @subsubheading Example | |
26643 | ||
26644 | @smallexample | |
594fe323 | 26645 | (gdb) |
922fbb7b AC |
26646 | -break-list |
26647 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
26648 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26649 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26650 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26651 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26652 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26653 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26654 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
26655 | addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}, | |
26656 | bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y", | |
948d5102 NR |
26657 | addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c", |
26658 | line="13",times="0"@}]@} | |
594fe323 | 26659 | (gdb) |
922fbb7b AC |
26660 | @end smallexample |
26661 | ||
26662 | Here's an example of the result when there are no breakpoints: | |
26663 | ||
26664 | @smallexample | |
594fe323 | 26665 | (gdb) |
922fbb7b AC |
26666 | -break-list |
26667 | ^done,BreakpointTable=@{nr_rows="0",nr_cols="6", | |
26668 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26669 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26670 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26671 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26672 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26673 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26674 | body=[]@} | |
594fe323 | 26675 | (gdb) |
922fbb7b AC |
26676 | @end smallexample |
26677 | ||
18148017 VP |
26678 | @subheading The @code{-break-passcount} Command |
26679 | @findex -break-passcount | |
26680 | ||
26681 | @subsubheading Synopsis | |
26682 | ||
26683 | @smallexample | |
26684 | -break-passcount @var{tracepoint-number} @var{passcount} | |
26685 | @end smallexample | |
26686 | ||
26687 | Set the passcount for tracepoint @var{tracepoint-number} to | |
26688 | @var{passcount}. If the breakpoint referred to by @var{tracepoint-number} | |
26689 | is not a tracepoint, error is emitted. This corresponds to CLI | |
26690 | command @samp{passcount}. | |
26691 | ||
922fbb7b AC |
26692 | @subheading The @code{-break-watch} Command |
26693 | @findex -break-watch | |
26694 | ||
26695 | @subsubheading Synopsis | |
26696 | ||
26697 | @smallexample | |
26698 | -break-watch [ -a | -r ] | |
26699 | @end smallexample | |
26700 | ||
26701 | Create a watchpoint. With the @samp{-a} option it will create an | |
d3e8051b | 26702 | @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a |
922fbb7b | 26703 | read from or on a write to the memory location. With the @samp{-r} |
d3e8051b | 26704 | option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will |
922fbb7b AC |
26705 | trigger only when the memory location is accessed for reading. Without |
26706 | either of the options, the watchpoint created is a regular watchpoint, | |
d3e8051b | 26707 | i.e., it will trigger when the memory location is accessed for writing. |
79a6e687 | 26708 | @xref{Set Watchpoints, , Setting Watchpoints}. |
922fbb7b AC |
26709 | |
26710 | Note that @samp{-break-list} will report a single list of watchpoints and | |
26711 | breakpoints inserted. | |
26712 | ||
26713 | @subsubheading @value{GDBN} Command | |
26714 | ||
26715 | The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and | |
26716 | @samp{rwatch}. | |
26717 | ||
26718 | @subsubheading Example | |
26719 | ||
26720 | Setting a watchpoint on a variable in the @code{main} function: | |
26721 | ||
26722 | @smallexample | |
594fe323 | 26723 | (gdb) |
922fbb7b AC |
26724 | -break-watch x |
26725 | ^done,wpt=@{number="2",exp="x"@} | |
594fe323 | 26726 | (gdb) |
922fbb7b AC |
26727 | -exec-continue |
26728 | ^running | |
0869d01b NR |
26729 | (gdb) |
26730 | *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@}, | |
922fbb7b | 26731 | value=@{old="-268439212",new="55"@}, |
76ff342d | 26732 | frame=@{func="main",args=[],file="recursive2.c", |
948d5102 | 26733 | fullname="/home/foo/bar/recursive2.c",line="5"@} |
594fe323 | 26734 | (gdb) |
922fbb7b AC |
26735 | @end smallexample |
26736 | ||
26737 | Setting a watchpoint on a variable local to a function. @value{GDBN} will stop | |
26738 | the program execution twice: first for the variable changing value, then | |
26739 | for the watchpoint going out of scope. | |
26740 | ||
26741 | @smallexample | |
594fe323 | 26742 | (gdb) |
922fbb7b AC |
26743 | -break-watch C |
26744 | ^done,wpt=@{number="5",exp="C"@} | |
594fe323 | 26745 | (gdb) |
922fbb7b AC |
26746 | -exec-continue |
26747 | ^running | |
0869d01b NR |
26748 | (gdb) |
26749 | *stopped,reason="watchpoint-trigger", | |
922fbb7b AC |
26750 | wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@}, |
26751 | frame=@{func="callee4",args=[], | |
76ff342d DJ |
26752 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26753 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@} | |
594fe323 | 26754 | (gdb) |
922fbb7b AC |
26755 | -exec-continue |
26756 | ^running | |
0869d01b NR |
26757 | (gdb) |
26758 | *stopped,reason="watchpoint-scope",wpnum="5", | |
922fbb7b AC |
26759 | frame=@{func="callee3",args=[@{name="strarg", |
26760 | value="0x11940 \"A string argument.\""@}], | |
76ff342d DJ |
26761 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26762 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} | |
594fe323 | 26763 | (gdb) |
922fbb7b AC |
26764 | @end smallexample |
26765 | ||
26766 | Listing breakpoints and watchpoints, at different points in the program | |
26767 | execution. Note that once the watchpoint goes out of scope, it is | |
26768 | deleted. | |
26769 | ||
26770 | @smallexample | |
594fe323 | 26771 | (gdb) |
922fbb7b AC |
26772 | -break-watch C |
26773 | ^done,wpt=@{number="2",exp="C"@} | |
594fe323 | 26774 | (gdb) |
922fbb7b AC |
26775 | -break-list |
26776 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
26777 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26778 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26779 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26780 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26781 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26782 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26783 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
26784 | addr="0x00010734",func="callee4", | |
948d5102 NR |
26785 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26786 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",times="1"@}, | |
922fbb7b AC |
26787 | bkpt=@{number="2",type="watchpoint",disp="keep", |
26788 | enabled="y",addr="",what="C",times="0"@}]@} | |
594fe323 | 26789 | (gdb) |
922fbb7b AC |
26790 | -exec-continue |
26791 | ^running | |
0869d01b NR |
26792 | (gdb) |
26793 | *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@}, | |
922fbb7b AC |
26794 | value=@{old="-276895068",new="3"@}, |
26795 | frame=@{func="callee4",args=[], | |
76ff342d DJ |
26796 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26797 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@} | |
594fe323 | 26798 | (gdb) |
922fbb7b AC |
26799 | -break-list |
26800 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", | |
26801 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26802 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26803 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26804 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26805 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26806 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26807 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
26808 | addr="0x00010734",func="callee4", | |
948d5102 NR |
26809 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26810 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"@}, | |
922fbb7b AC |
26811 | bkpt=@{number="2",type="watchpoint",disp="keep", |
26812 | enabled="y",addr="",what="C",times="-5"@}]@} | |
594fe323 | 26813 | (gdb) |
922fbb7b AC |
26814 | -exec-continue |
26815 | ^running | |
26816 | ^done,reason="watchpoint-scope",wpnum="2", | |
26817 | frame=@{func="callee3",args=[@{name="strarg", | |
26818 | value="0x11940 \"A string argument.\""@}], | |
76ff342d DJ |
26819 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26820 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} | |
594fe323 | 26821 | (gdb) |
922fbb7b AC |
26822 | -break-list |
26823 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", | |
26824 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, | |
26825 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, | |
26826 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, | |
26827 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, | |
26828 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, | |
26829 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], | |
26830 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
26831 | addr="0x00010734",func="callee4", | |
948d5102 NR |
26832 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
26833 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8", | |
26834 | times="1"@}]@} | |
594fe323 | 26835 | (gdb) |
922fbb7b AC |
26836 | @end smallexample |
26837 | ||
26838 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
a2c02241 NR |
26839 | @node GDB/MI Program Context |
26840 | @section @sc{gdb/mi} Program Context | |
922fbb7b | 26841 | |
a2c02241 NR |
26842 | @subheading The @code{-exec-arguments} Command |
26843 | @findex -exec-arguments | |
922fbb7b | 26844 | |
922fbb7b AC |
26845 | |
26846 | @subsubheading Synopsis | |
26847 | ||
26848 | @smallexample | |
a2c02241 | 26849 | -exec-arguments @var{args} |
922fbb7b AC |
26850 | @end smallexample |
26851 | ||
a2c02241 NR |
26852 | Set the inferior program arguments, to be used in the next |
26853 | @samp{-exec-run}. | |
922fbb7b | 26854 | |
a2c02241 | 26855 | @subsubheading @value{GDBN} Command |
922fbb7b | 26856 | |
a2c02241 | 26857 | The corresponding @value{GDBN} command is @samp{set args}. |
922fbb7b | 26858 | |
a2c02241 | 26859 | @subsubheading Example |
922fbb7b | 26860 | |
fbc5282e MK |
26861 | @smallexample |
26862 | (gdb) | |
26863 | -exec-arguments -v word | |
26864 | ^done | |
26865 | (gdb) | |
26866 | @end smallexample | |
922fbb7b | 26867 | |
a2c02241 | 26868 | |
9901a55b | 26869 | @ignore |
a2c02241 NR |
26870 | @subheading The @code{-exec-show-arguments} Command |
26871 | @findex -exec-show-arguments | |
26872 | ||
26873 | @subsubheading Synopsis | |
26874 | ||
26875 | @smallexample | |
26876 | -exec-show-arguments | |
26877 | @end smallexample | |
26878 | ||
26879 | Print the arguments of the program. | |
922fbb7b AC |
26880 | |
26881 | @subsubheading @value{GDBN} Command | |
26882 | ||
a2c02241 | 26883 | The corresponding @value{GDBN} command is @samp{show args}. |
922fbb7b AC |
26884 | |
26885 | @subsubheading Example | |
a2c02241 | 26886 | N.A. |
9901a55b | 26887 | @end ignore |
922fbb7b | 26888 | |
922fbb7b | 26889 | |
a2c02241 NR |
26890 | @subheading The @code{-environment-cd} Command |
26891 | @findex -environment-cd | |
922fbb7b | 26892 | |
a2c02241 | 26893 | @subsubheading Synopsis |
922fbb7b AC |
26894 | |
26895 | @smallexample | |
a2c02241 | 26896 | -environment-cd @var{pathdir} |
922fbb7b AC |
26897 | @end smallexample |
26898 | ||
a2c02241 | 26899 | Set @value{GDBN}'s working directory. |
922fbb7b | 26900 | |
a2c02241 | 26901 | @subsubheading @value{GDBN} Command |
922fbb7b | 26902 | |
a2c02241 NR |
26903 | The corresponding @value{GDBN} command is @samp{cd}. |
26904 | ||
26905 | @subsubheading Example | |
922fbb7b AC |
26906 | |
26907 | @smallexample | |
594fe323 | 26908 | (gdb) |
a2c02241 NR |
26909 | -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb |
26910 | ^done | |
594fe323 | 26911 | (gdb) |
922fbb7b AC |
26912 | @end smallexample |
26913 | ||
26914 | ||
a2c02241 NR |
26915 | @subheading The @code{-environment-directory} Command |
26916 | @findex -environment-directory | |
922fbb7b AC |
26917 | |
26918 | @subsubheading Synopsis | |
26919 | ||
26920 | @smallexample | |
a2c02241 | 26921 | -environment-directory [ -r ] [ @var{pathdir} ]+ |
922fbb7b AC |
26922 | @end smallexample |
26923 | ||
a2c02241 NR |
26924 | Add directories @var{pathdir} to beginning of search path for source files. |
26925 | If the @samp{-r} option is used, the search path is reset to the default | |
26926 | search path. If directories @var{pathdir} are supplied in addition to the | |
26927 | @samp{-r} option, the search path is first reset and then addition | |
26928 | occurs as normal. | |
26929 | Multiple directories may be specified, separated by blanks. Specifying | |
26930 | multiple directories in a single command | |
26931 | results in the directories added to the beginning of the | |
26932 | search path in the same order they were presented in the command. | |
26933 | If blanks are needed as | |
26934 | part of a directory name, double-quotes should be used around | |
26935 | the name. In the command output, the path will show up separated | |
d3e8051b | 26936 | by the system directory-separator character. The directory-separator |
a2c02241 NR |
26937 | character must not be used |
26938 | in any directory name. | |
26939 | If no directories are specified, the current search path is displayed. | |
922fbb7b AC |
26940 | |
26941 | @subsubheading @value{GDBN} Command | |
26942 | ||
a2c02241 | 26943 | The corresponding @value{GDBN} command is @samp{dir}. |
922fbb7b AC |
26944 | |
26945 | @subsubheading Example | |
26946 | ||
922fbb7b | 26947 | @smallexample |
594fe323 | 26948 | (gdb) |
a2c02241 NR |
26949 | -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb |
26950 | ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" | |
594fe323 | 26951 | (gdb) |
a2c02241 NR |
26952 | -environment-directory "" |
26953 | ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" | |
594fe323 | 26954 | (gdb) |
a2c02241 NR |
26955 | -environment-directory -r /home/jjohnstn/src/gdb /usr/src |
26956 | ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd" | |
594fe323 | 26957 | (gdb) |
a2c02241 NR |
26958 | -environment-directory -r |
26959 | ^done,source-path="$cdir:$cwd" | |
594fe323 | 26960 | (gdb) |
922fbb7b AC |
26961 | @end smallexample |
26962 | ||
26963 | ||
a2c02241 NR |
26964 | @subheading The @code{-environment-path} Command |
26965 | @findex -environment-path | |
922fbb7b AC |
26966 | |
26967 | @subsubheading Synopsis | |
26968 | ||
26969 | @smallexample | |
a2c02241 | 26970 | -environment-path [ -r ] [ @var{pathdir} ]+ |
922fbb7b AC |
26971 | @end smallexample |
26972 | ||
a2c02241 NR |
26973 | Add directories @var{pathdir} to beginning of search path for object files. |
26974 | If the @samp{-r} option is used, the search path is reset to the original | |
26975 | search path that existed at gdb start-up. If directories @var{pathdir} are | |
26976 | supplied in addition to the | |
26977 | @samp{-r} option, the search path is first reset and then addition | |
26978 | occurs as normal. | |
26979 | Multiple directories may be specified, separated by blanks. Specifying | |
26980 | multiple directories in a single command | |
26981 | results in the directories added to the beginning of the | |
26982 | search path in the same order they were presented in the command. | |
26983 | If blanks are needed as | |
26984 | part of a directory name, double-quotes should be used around | |
26985 | the name. In the command output, the path will show up separated | |
d3e8051b | 26986 | by the system directory-separator character. The directory-separator |
a2c02241 NR |
26987 | character must not be used |
26988 | in any directory name. | |
26989 | If no directories are specified, the current path is displayed. | |
26990 | ||
922fbb7b AC |
26991 | |
26992 | @subsubheading @value{GDBN} Command | |
26993 | ||
a2c02241 | 26994 | The corresponding @value{GDBN} command is @samp{path}. |
922fbb7b AC |
26995 | |
26996 | @subsubheading Example | |
26997 | ||
922fbb7b | 26998 | @smallexample |
594fe323 | 26999 | (gdb) |
a2c02241 NR |
27000 | -environment-path |
27001 | ^done,path="/usr/bin" | |
594fe323 | 27002 | (gdb) |
a2c02241 NR |
27003 | -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin |
27004 | ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin" | |
594fe323 | 27005 | (gdb) |
a2c02241 NR |
27006 | -environment-path -r /usr/local/bin |
27007 | ^done,path="/usr/local/bin:/usr/bin" | |
594fe323 | 27008 | (gdb) |
922fbb7b AC |
27009 | @end smallexample |
27010 | ||
27011 | ||
a2c02241 NR |
27012 | @subheading The @code{-environment-pwd} Command |
27013 | @findex -environment-pwd | |
922fbb7b AC |
27014 | |
27015 | @subsubheading Synopsis | |
27016 | ||
27017 | @smallexample | |
a2c02241 | 27018 | -environment-pwd |
922fbb7b AC |
27019 | @end smallexample |
27020 | ||
a2c02241 | 27021 | Show the current working directory. |
922fbb7b | 27022 | |
79a6e687 | 27023 | @subsubheading @value{GDBN} Command |
922fbb7b | 27024 | |
a2c02241 | 27025 | The corresponding @value{GDBN} command is @samp{pwd}. |
922fbb7b AC |
27026 | |
27027 | @subsubheading Example | |
27028 | ||
922fbb7b | 27029 | @smallexample |
594fe323 | 27030 | (gdb) |
a2c02241 NR |
27031 | -environment-pwd |
27032 | ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb" | |
594fe323 | 27033 | (gdb) |
922fbb7b AC |
27034 | @end smallexample |
27035 | ||
a2c02241 NR |
27036 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
27037 | @node GDB/MI Thread Commands | |
27038 | @section @sc{gdb/mi} Thread Commands | |
27039 | ||
27040 | ||
27041 | @subheading The @code{-thread-info} Command | |
27042 | @findex -thread-info | |
922fbb7b AC |
27043 | |
27044 | @subsubheading Synopsis | |
27045 | ||
27046 | @smallexample | |
8e8901c5 | 27047 | -thread-info [ @var{thread-id} ] |
922fbb7b AC |
27048 | @end smallexample |
27049 | ||
8e8901c5 VP |
27050 | Reports information about either a specific thread, if |
27051 | the @var{thread-id} parameter is present, or about all | |
27052 | threads. When printing information about all threads, | |
27053 | also reports the current thread. | |
27054 | ||
79a6e687 | 27055 | @subsubheading @value{GDBN} Command |
922fbb7b | 27056 | |
8e8901c5 VP |
27057 | The @samp{info thread} command prints the same information |
27058 | about all threads. | |
922fbb7b | 27059 | |
4694da01 | 27060 | @subsubheading Result |
922fbb7b | 27061 | |
4694da01 TT |
27062 | The result is a list of threads. The following attributes are |
27063 | defined for a given thread: | |
27064 | ||
27065 | @table @samp | |
27066 | @item current | |
27067 | This field exists only for the current thread. It has the value @samp{*}. | |
27068 | ||
27069 | @item id | |
27070 | The identifier that @value{GDBN} uses to refer to the thread. | |
27071 | ||
27072 | @item target-id | |
27073 | The identifier that the target uses to refer to the thread. | |
27074 | ||
27075 | @item details | |
27076 | Extra information about the thread, in a target-specific format. This | |
27077 | field is optional. | |
27078 | ||
27079 | @item name | |
27080 | The name of the thread. If the user specified a name using the | |
27081 | @code{thread name} command, then this name is given. Otherwise, if | |
27082 | @value{GDBN} can extract the thread name from the target, then that | |
27083 | name is given. If @value{GDBN} cannot find the thread name, then this | |
27084 | field is omitted. | |
27085 | ||
27086 | @item frame | |
27087 | The stack frame currently executing in the thread. | |
922fbb7b | 27088 | |
4694da01 TT |
27089 | @item state |
27090 | The thread's state. The @samp{state} field may have the following | |
27091 | values: | |
c3b108f7 VP |
27092 | |
27093 | @table @code | |
27094 | @item stopped | |
27095 | The thread is stopped. Frame information is available for stopped | |
27096 | threads. | |
27097 | ||
27098 | @item running | |
27099 | The thread is running. There's no frame information for running | |
27100 | threads. | |
27101 | ||
27102 | @end table | |
27103 | ||
4694da01 TT |
27104 | @item core |
27105 | If @value{GDBN} can find the CPU core on which this thread is running, | |
27106 | then this field is the core identifier. This field is optional. | |
27107 | ||
27108 | @end table | |
27109 | ||
27110 | @subsubheading Example | |
27111 | ||
27112 | @smallexample | |
27113 | -thread-info | |
27114 | ^done,threads=[ | |
27115 | @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)", | |
27116 | frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall", | |
27117 | args=[]@},state="running"@}, | |
27118 | @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)", | |
27119 | frame=@{level="0",addr="0x0804891f",func="foo", | |
27120 | args=[@{name="i",value="10"@}], | |
27121 | file="/tmp/a.c",fullname="/tmp/a.c",line="158"@}, | |
27122 | state="running"@}], | |
27123 | current-thread-id="1" | |
27124 | (gdb) | |
27125 | @end smallexample | |
27126 | ||
a2c02241 NR |
27127 | @subheading The @code{-thread-list-ids} Command |
27128 | @findex -thread-list-ids | |
922fbb7b | 27129 | |
a2c02241 | 27130 | @subsubheading Synopsis |
922fbb7b | 27131 | |
a2c02241 NR |
27132 | @smallexample |
27133 | -thread-list-ids | |
27134 | @end smallexample | |
922fbb7b | 27135 | |
a2c02241 NR |
27136 | Produces a list of the currently known @value{GDBN} thread ids. At the |
27137 | end of the list it also prints the total number of such threads. | |
922fbb7b | 27138 | |
c3b108f7 VP |
27139 | This command is retained for historical reasons, the |
27140 | @code{-thread-info} command should be used instead. | |
27141 | ||
922fbb7b AC |
27142 | @subsubheading @value{GDBN} Command |
27143 | ||
a2c02241 | 27144 | Part of @samp{info threads} supplies the same information. |
922fbb7b AC |
27145 | |
27146 | @subsubheading Example | |
27147 | ||
922fbb7b | 27148 | @smallexample |
594fe323 | 27149 | (gdb) |
a2c02241 NR |
27150 | -thread-list-ids |
27151 | ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@}, | |
592375cd | 27152 | current-thread-id="1",number-of-threads="3" |
594fe323 | 27153 | (gdb) |
922fbb7b AC |
27154 | @end smallexample |
27155 | ||
a2c02241 NR |
27156 | |
27157 | @subheading The @code{-thread-select} Command | |
27158 | @findex -thread-select | |
922fbb7b AC |
27159 | |
27160 | @subsubheading Synopsis | |
27161 | ||
27162 | @smallexample | |
a2c02241 | 27163 | -thread-select @var{threadnum} |
922fbb7b AC |
27164 | @end smallexample |
27165 | ||
a2c02241 NR |
27166 | Make @var{threadnum} the current thread. It prints the number of the new |
27167 | current thread, and the topmost frame for that thread. | |
922fbb7b | 27168 | |
c3b108f7 VP |
27169 | This command is deprecated in favor of explicitly using the |
27170 | @samp{--thread} option to each command. | |
27171 | ||
922fbb7b AC |
27172 | @subsubheading @value{GDBN} Command |
27173 | ||
a2c02241 | 27174 | The corresponding @value{GDBN} command is @samp{thread}. |
922fbb7b AC |
27175 | |
27176 | @subsubheading Example | |
922fbb7b AC |
27177 | |
27178 | @smallexample | |
594fe323 | 27179 | (gdb) |
a2c02241 NR |
27180 | -exec-next |
27181 | ^running | |
594fe323 | 27182 | (gdb) |
a2c02241 NR |
27183 | *stopped,reason="end-stepping-range",thread-id="2",line="187", |
27184 | file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c" | |
594fe323 | 27185 | (gdb) |
a2c02241 NR |
27186 | -thread-list-ids |
27187 | ^done, | |
27188 | thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@}, | |
27189 | number-of-threads="3" | |
594fe323 | 27190 | (gdb) |
a2c02241 NR |
27191 | -thread-select 3 |
27192 | ^done,new-thread-id="3", | |
27193 | frame=@{level="0",func="vprintf", | |
27194 | args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@}, | |
27195 | @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@} | |
594fe323 | 27196 | (gdb) |
922fbb7b AC |
27197 | @end smallexample |
27198 | ||
5d77fe44 JB |
27199 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
27200 | @node GDB/MI Ada Tasking Commands | |
27201 | @section @sc{gdb/mi} Ada Tasking Commands | |
27202 | ||
27203 | @subheading The @code{-ada-task-info} Command | |
27204 | @findex -ada-task-info | |
27205 | ||
27206 | @subsubheading Synopsis | |
27207 | ||
27208 | @smallexample | |
27209 | -ada-task-info [ @var{task-id} ] | |
27210 | @end smallexample | |
27211 | ||
27212 | Reports information about either a specific Ada task, if the | |
27213 | @var{task-id} parameter is present, or about all Ada tasks. | |
27214 | ||
27215 | @subsubheading @value{GDBN} Command | |
27216 | ||
27217 | The @samp{info tasks} command prints the same information | |
27218 | about all Ada tasks (@pxref{Ada Tasks}). | |
27219 | ||
27220 | @subsubheading Result | |
27221 | ||
27222 | The result is a table of Ada tasks. The following columns are | |
27223 | defined for each Ada task: | |
27224 | ||
27225 | @table @samp | |
27226 | @item current | |
27227 | This field exists only for the current thread. It has the value @samp{*}. | |
27228 | ||
27229 | @item id | |
27230 | The identifier that @value{GDBN} uses to refer to the Ada task. | |
27231 | ||
27232 | @item task-id | |
27233 | The identifier that the target uses to refer to the Ada task. | |
27234 | ||
27235 | @item thread-id | |
27236 | The identifier of the thread corresponding to the Ada task. | |
27237 | ||
27238 | This field should always exist, as Ada tasks are always implemented | |
27239 | on top of a thread. But if @value{GDBN} cannot find this corresponding | |
27240 | thread for any reason, the field is omitted. | |
27241 | ||
27242 | @item parent-id | |
27243 | This field exists only when the task was created by another task. | |
27244 | In this case, it provides the ID of the parent task. | |
27245 | ||
27246 | @item priority | |
27247 | The base priority of the task. | |
27248 | ||
27249 | @item state | |
27250 | The current state of the task. For a detailed description of the | |
27251 | possible states, see @ref{Ada Tasks}. | |
27252 | ||
27253 | @item name | |
27254 | The name of the task. | |
27255 | ||
27256 | @end table | |
27257 | ||
27258 | @subsubheading Example | |
27259 | ||
27260 | @smallexample | |
27261 | -ada-task-info | |
27262 | ^done,tasks=@{nr_rows="3",nr_cols="8", | |
27263 | hdr=[@{width="1",alignment="-1",col_name="current",colhdr=""@}, | |
27264 | @{width="3",alignment="1",col_name="id",colhdr="ID"@}, | |
27265 | @{width="9",alignment="1",col_name="task-id",colhdr="TID"@}, | |
27266 | @{width="4",alignment="1",col_name="thread-id",colhdr=""@}, | |
27267 | @{width="4",alignment="1",col_name="parent-id",colhdr="P-ID"@}, | |
27268 | @{width="3",alignment="1",col_name="priority",colhdr="Pri"@}, | |
27269 | @{width="22",alignment="-1",col_name="state",colhdr="State"@}, | |
27270 | @{width="1",alignment="2",col_name="name",colhdr="Name"@}], | |
27271 | body=[@{current="*",id="1",task-id=" 644010",thread-id="1",priority="48", | |
27272 | state="Child Termination Wait",name="main_task"@}]@} | |
27273 | (gdb) | |
27274 | @end smallexample | |
27275 | ||
a2c02241 NR |
27276 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
27277 | @node GDB/MI Program Execution | |
27278 | @section @sc{gdb/mi} Program Execution | |
922fbb7b | 27279 | |
ef21caaf | 27280 | These are the asynchronous commands which generate the out-of-band |
3f94c067 | 27281 | record @samp{*stopped}. Currently @value{GDBN} only really executes |
ef21caaf NR |
27282 | asynchronously with remote targets and this interaction is mimicked in |
27283 | other cases. | |
922fbb7b | 27284 | |
922fbb7b AC |
27285 | @subheading The @code{-exec-continue} Command |
27286 | @findex -exec-continue | |
27287 | ||
27288 | @subsubheading Synopsis | |
27289 | ||
27290 | @smallexample | |
540aa8e7 | 27291 | -exec-continue [--reverse] [--all|--thread-group N] |
922fbb7b AC |
27292 | @end smallexample |
27293 | ||
540aa8e7 MS |
27294 | Resumes the execution of the inferior program, which will continue |
27295 | to execute until it reaches a debugger stop event. If the | |
27296 | @samp{--reverse} option is specified, execution resumes in reverse until | |
27297 | it reaches a stop event. Stop events may include | |
27298 | @itemize @bullet | |
27299 | @item | |
27300 | breakpoints or watchpoints | |
27301 | @item | |
27302 | signals or exceptions | |
27303 | @item | |
27304 | the end of the process (or its beginning under @samp{--reverse}) | |
27305 | @item | |
27306 | the end or beginning of a replay log if one is being used. | |
27307 | @end itemize | |
27308 | In all-stop mode (@pxref{All-Stop | |
27309 | Mode}), may resume only one thread, or all threads, depending on the | |
27310 | value of the @samp{scheduler-locking} variable. If @samp{--all} is | |
a79b8f6e | 27311 | specified, all threads (in all inferiors) will be resumed. The @samp{--all} option is |
540aa8e7 MS |
27312 | ignored in all-stop mode. If the @samp{--thread-group} options is |
27313 | specified, then all threads in that thread group are resumed. | |
922fbb7b AC |
27314 | |
27315 | @subsubheading @value{GDBN} Command | |
27316 | ||
27317 | The corresponding @value{GDBN} corresponding is @samp{continue}. | |
27318 | ||
27319 | @subsubheading Example | |
27320 | ||
27321 | @smallexample | |
27322 | -exec-continue | |
27323 | ^running | |
594fe323 | 27324 | (gdb) |
922fbb7b | 27325 | @@Hello world |
a47ec5fe AR |
27326 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{ |
27327 | func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c", | |
27328 | line="13"@} | |
594fe323 | 27329 | (gdb) |
922fbb7b AC |
27330 | @end smallexample |
27331 | ||
27332 | ||
27333 | @subheading The @code{-exec-finish} Command | |
27334 | @findex -exec-finish | |
27335 | ||
27336 | @subsubheading Synopsis | |
27337 | ||
27338 | @smallexample | |
540aa8e7 | 27339 | -exec-finish [--reverse] |
922fbb7b AC |
27340 | @end smallexample |
27341 | ||
ef21caaf NR |
27342 | Resumes the execution of the inferior program until the current |
27343 | function is exited. Displays the results returned by the function. | |
540aa8e7 MS |
27344 | If the @samp{--reverse} option is specified, resumes the reverse |
27345 | execution of the inferior program until the point where current | |
27346 | function was called. | |
922fbb7b AC |
27347 | |
27348 | @subsubheading @value{GDBN} Command | |
27349 | ||
27350 | The corresponding @value{GDBN} command is @samp{finish}. | |
27351 | ||
27352 | @subsubheading Example | |
27353 | ||
27354 | Function returning @code{void}. | |
27355 | ||
27356 | @smallexample | |
27357 | -exec-finish | |
27358 | ^running | |
594fe323 | 27359 | (gdb) |
922fbb7b AC |
27360 | @@hello from foo |
27361 | *stopped,reason="function-finished",frame=@{func="main",args=[], | |
948d5102 | 27362 | file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@} |
594fe323 | 27363 | (gdb) |
922fbb7b AC |
27364 | @end smallexample |
27365 | ||
27366 | Function returning other than @code{void}. The name of the internal | |
27367 | @value{GDBN} variable storing the result is printed, together with the | |
27368 | value itself. | |
27369 | ||
27370 | @smallexample | |
27371 | -exec-finish | |
27372 | ^running | |
594fe323 | 27373 | (gdb) |
922fbb7b AC |
27374 | *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo", |
27375 | args=[@{name="a",value="1"],@{name="b",value="9"@}@}, | |
948d5102 | 27376 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
922fbb7b | 27377 | gdb-result-var="$1",return-value="0" |
594fe323 | 27378 | (gdb) |
922fbb7b AC |
27379 | @end smallexample |
27380 | ||
27381 | ||
27382 | @subheading The @code{-exec-interrupt} Command | |
27383 | @findex -exec-interrupt | |
27384 | ||
27385 | @subsubheading Synopsis | |
27386 | ||
27387 | @smallexample | |
c3b108f7 | 27388 | -exec-interrupt [--all|--thread-group N] |
922fbb7b AC |
27389 | @end smallexample |
27390 | ||
ef21caaf NR |
27391 | Interrupts the background execution of the target. Note how the token |
27392 | associated with the stop message is the one for the execution command | |
27393 | that has been interrupted. The token for the interrupt itself only | |
27394 | appears in the @samp{^done} output. If the user is trying to | |
922fbb7b AC |
27395 | interrupt a non-running program, an error message will be printed. |
27396 | ||
c3b108f7 VP |
27397 | Note that when asynchronous execution is enabled, this command is |
27398 | asynchronous just like other execution commands. That is, first the | |
27399 | @samp{^done} response will be printed, and the target stop will be | |
27400 | reported after that using the @samp{*stopped} notification. | |
27401 | ||
27402 | In non-stop mode, only the context thread is interrupted by default. | |
a79b8f6e VP |
27403 | All threads (in all inferiors) will be interrupted if the |
27404 | @samp{--all} option is specified. If the @samp{--thread-group} | |
27405 | option is specified, all threads in that group will be interrupted. | |
c3b108f7 | 27406 | |
922fbb7b AC |
27407 | @subsubheading @value{GDBN} Command |
27408 | ||
27409 | The corresponding @value{GDBN} command is @samp{interrupt}. | |
27410 | ||
27411 | @subsubheading Example | |
27412 | ||
27413 | @smallexample | |
594fe323 | 27414 | (gdb) |
922fbb7b AC |
27415 | 111-exec-continue |
27416 | 111^running | |
27417 | ||
594fe323 | 27418 | (gdb) |
922fbb7b AC |
27419 | 222-exec-interrupt |
27420 | 222^done | |
594fe323 | 27421 | (gdb) |
922fbb7b | 27422 | 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt", |
76ff342d | 27423 | frame=@{addr="0x00010140",func="foo",args=[],file="try.c", |
948d5102 | 27424 | fullname="/home/foo/bar/try.c",line="13"@} |
594fe323 | 27425 | (gdb) |
922fbb7b | 27426 | |
594fe323 | 27427 | (gdb) |
922fbb7b AC |
27428 | -exec-interrupt |
27429 | ^error,msg="mi_cmd_exec_interrupt: Inferior not executing." | |
594fe323 | 27430 | (gdb) |
922fbb7b AC |
27431 | @end smallexample |
27432 | ||
83eba9b7 VP |
27433 | @subheading The @code{-exec-jump} Command |
27434 | @findex -exec-jump | |
27435 | ||
27436 | @subsubheading Synopsis | |
27437 | ||
27438 | @smallexample | |
27439 | -exec-jump @var{location} | |
27440 | @end smallexample | |
27441 | ||
27442 | Resumes execution of the inferior program at the location specified by | |
27443 | parameter. @xref{Specify Location}, for a description of the | |
27444 | different forms of @var{location}. | |
27445 | ||
27446 | @subsubheading @value{GDBN} Command | |
27447 | ||
27448 | The corresponding @value{GDBN} command is @samp{jump}. | |
27449 | ||
27450 | @subsubheading Example | |
27451 | ||
27452 | @smallexample | |
27453 | -exec-jump foo.c:10 | |
27454 | *running,thread-id="all" | |
27455 | ^running | |
27456 | @end smallexample | |
27457 | ||
922fbb7b AC |
27458 | |
27459 | @subheading The @code{-exec-next} Command | |
27460 | @findex -exec-next | |
27461 | ||
27462 | @subsubheading Synopsis | |
27463 | ||
27464 | @smallexample | |
540aa8e7 | 27465 | -exec-next [--reverse] |
922fbb7b AC |
27466 | @end smallexample |
27467 | ||
ef21caaf NR |
27468 | Resumes execution of the inferior program, stopping when the beginning |
27469 | of the next source line is reached. | |
922fbb7b | 27470 | |
540aa8e7 MS |
27471 | If the @samp{--reverse} option is specified, resumes reverse execution |
27472 | of the inferior program, stopping at the beginning of the previous | |
27473 | source line. If you issue this command on the first line of a | |
27474 | function, it will take you back to the caller of that function, to the | |
27475 | source line where the function was called. | |
27476 | ||
27477 | ||
922fbb7b AC |
27478 | @subsubheading @value{GDBN} Command |
27479 | ||
27480 | The corresponding @value{GDBN} command is @samp{next}. | |
27481 | ||
27482 | @subsubheading Example | |
27483 | ||
27484 | @smallexample | |
27485 | -exec-next | |
27486 | ^running | |
594fe323 | 27487 | (gdb) |
922fbb7b | 27488 | *stopped,reason="end-stepping-range",line="8",file="hello.c" |
594fe323 | 27489 | (gdb) |
922fbb7b AC |
27490 | @end smallexample |
27491 | ||
27492 | ||
27493 | @subheading The @code{-exec-next-instruction} Command | |
27494 | @findex -exec-next-instruction | |
27495 | ||
27496 | @subsubheading Synopsis | |
27497 | ||
27498 | @smallexample | |
540aa8e7 | 27499 | -exec-next-instruction [--reverse] |
922fbb7b AC |
27500 | @end smallexample |
27501 | ||
ef21caaf NR |
27502 | Executes one machine instruction. If the instruction is a function |
27503 | call, continues until the function returns. If the program stops at an | |
27504 | instruction in the middle of a source line, the address will be | |
27505 | printed as well. | |
922fbb7b | 27506 | |
540aa8e7 MS |
27507 | If the @samp{--reverse} option is specified, resumes reverse execution |
27508 | of the inferior program, stopping at the previous instruction. If the | |
27509 | previously executed instruction was a return from another function, | |
27510 | it will continue to execute in reverse until the call to that function | |
27511 | (from the current stack frame) is reached. | |
27512 | ||
922fbb7b AC |
27513 | @subsubheading @value{GDBN} Command |
27514 | ||
27515 | The corresponding @value{GDBN} command is @samp{nexti}. | |
27516 | ||
27517 | @subsubheading Example | |
27518 | ||
27519 | @smallexample | |
594fe323 | 27520 | (gdb) |
922fbb7b AC |
27521 | -exec-next-instruction |
27522 | ^running | |
27523 | ||
594fe323 | 27524 | (gdb) |
922fbb7b AC |
27525 | *stopped,reason="end-stepping-range", |
27526 | addr="0x000100d4",line="5",file="hello.c" | |
594fe323 | 27527 | (gdb) |
922fbb7b AC |
27528 | @end smallexample |
27529 | ||
27530 | ||
27531 | @subheading The @code{-exec-return} Command | |
27532 | @findex -exec-return | |
27533 | ||
27534 | @subsubheading Synopsis | |
27535 | ||
27536 | @smallexample | |
27537 | -exec-return | |
27538 | @end smallexample | |
27539 | ||
27540 | Makes current function return immediately. Doesn't execute the inferior. | |
27541 | Displays the new current frame. | |
27542 | ||
27543 | @subsubheading @value{GDBN} Command | |
27544 | ||
27545 | The corresponding @value{GDBN} command is @samp{return}. | |
27546 | ||
27547 | @subsubheading Example | |
27548 | ||
27549 | @smallexample | |
594fe323 | 27550 | (gdb) |
922fbb7b AC |
27551 | 200-break-insert callee4 |
27552 | 200^done,bkpt=@{number="1",addr="0x00010734", | |
27553 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@} | |
594fe323 | 27554 | (gdb) |
922fbb7b AC |
27555 | 000-exec-run |
27556 | 000^running | |
594fe323 | 27557 | (gdb) |
a47ec5fe | 27558 | 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1", |
922fbb7b | 27559 | frame=@{func="callee4",args=[], |
76ff342d DJ |
27560 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
27561 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@} | |
594fe323 | 27562 | (gdb) |
922fbb7b AC |
27563 | 205-break-delete |
27564 | 205^done | |
594fe323 | 27565 | (gdb) |
922fbb7b AC |
27566 | 111-exec-return |
27567 | 111^done,frame=@{level="0",func="callee3", | |
27568 | args=[@{name="strarg", | |
27569 | value="0x11940 \"A string argument.\""@}], | |
76ff342d DJ |
27570 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
27571 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} | |
594fe323 | 27572 | (gdb) |
922fbb7b AC |
27573 | @end smallexample |
27574 | ||
27575 | ||
27576 | @subheading The @code{-exec-run} Command | |
27577 | @findex -exec-run | |
27578 | ||
27579 | @subsubheading Synopsis | |
27580 | ||
27581 | @smallexample | |
a79b8f6e | 27582 | -exec-run [--all | --thread-group N] |
922fbb7b AC |
27583 | @end smallexample |
27584 | ||
ef21caaf NR |
27585 | Starts execution of the inferior from the beginning. The inferior |
27586 | executes until either a breakpoint is encountered or the program | |
27587 | exits. In the latter case the output will include an exit code, if | |
27588 | the program has exited exceptionally. | |
922fbb7b | 27589 | |
a79b8f6e VP |
27590 | When no option is specified, the current inferior is started. If the |
27591 | @samp{--thread-group} option is specified, it should refer to a thread | |
27592 | group of type @samp{process}, and that thread group will be started. | |
27593 | If the @samp{--all} option is specified, then all inferiors will be started. | |
27594 | ||
922fbb7b AC |
27595 | @subsubheading @value{GDBN} Command |
27596 | ||
27597 | The corresponding @value{GDBN} command is @samp{run}. | |
27598 | ||
ef21caaf | 27599 | @subsubheading Examples |
922fbb7b AC |
27600 | |
27601 | @smallexample | |
594fe323 | 27602 | (gdb) |
922fbb7b AC |
27603 | -break-insert main |
27604 | ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@} | |
594fe323 | 27605 | (gdb) |
922fbb7b AC |
27606 | -exec-run |
27607 | ^running | |
594fe323 | 27608 | (gdb) |
a47ec5fe | 27609 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1", |
76ff342d | 27610 | frame=@{func="main",args=[],file="recursive2.c", |
948d5102 | 27611 | fullname="/home/foo/bar/recursive2.c",line="4"@} |
594fe323 | 27612 | (gdb) |
922fbb7b AC |
27613 | @end smallexample |
27614 | ||
ef21caaf NR |
27615 | @noindent |
27616 | Program exited normally: | |
27617 | ||
27618 | @smallexample | |
594fe323 | 27619 | (gdb) |
ef21caaf NR |
27620 | -exec-run |
27621 | ^running | |
594fe323 | 27622 | (gdb) |
ef21caaf NR |
27623 | x = 55 |
27624 | *stopped,reason="exited-normally" | |
594fe323 | 27625 | (gdb) |
ef21caaf NR |
27626 | @end smallexample |
27627 | ||
27628 | @noindent | |
27629 | Program exited exceptionally: | |
27630 | ||
27631 | @smallexample | |
594fe323 | 27632 | (gdb) |
ef21caaf NR |
27633 | -exec-run |
27634 | ^running | |
594fe323 | 27635 | (gdb) |
ef21caaf NR |
27636 | x = 55 |
27637 | *stopped,reason="exited",exit-code="01" | |
594fe323 | 27638 | (gdb) |
ef21caaf NR |
27639 | @end smallexample |
27640 | ||
27641 | Another way the program can terminate is if it receives a signal such as | |
27642 | @code{SIGINT}. In this case, @sc{gdb/mi} displays this: | |
27643 | ||
27644 | @smallexample | |
594fe323 | 27645 | (gdb) |
ef21caaf NR |
27646 | *stopped,reason="exited-signalled",signal-name="SIGINT", |
27647 | signal-meaning="Interrupt" | |
27648 | @end smallexample | |
27649 | ||
922fbb7b | 27650 | |
a2c02241 NR |
27651 | @c @subheading -exec-signal |
27652 | ||
27653 | ||
27654 | @subheading The @code{-exec-step} Command | |
27655 | @findex -exec-step | |
922fbb7b AC |
27656 | |
27657 | @subsubheading Synopsis | |
27658 | ||
27659 | @smallexample | |
540aa8e7 | 27660 | -exec-step [--reverse] |
922fbb7b AC |
27661 | @end smallexample |
27662 | ||
a2c02241 NR |
27663 | Resumes execution of the inferior program, stopping when the beginning |
27664 | of the next source line is reached, if the next source line is not a | |
27665 | function call. If it is, stop at the first instruction of the called | |
540aa8e7 MS |
27666 | function. If the @samp{--reverse} option is specified, resumes reverse |
27667 | execution of the inferior program, stopping at the beginning of the | |
27668 | previously executed source line. | |
922fbb7b AC |
27669 | |
27670 | @subsubheading @value{GDBN} Command | |
27671 | ||
a2c02241 | 27672 | The corresponding @value{GDBN} command is @samp{step}. |
922fbb7b AC |
27673 | |
27674 | @subsubheading Example | |
27675 | ||
27676 | Stepping into a function: | |
27677 | ||
27678 | @smallexample | |
27679 | -exec-step | |
27680 | ^running | |
594fe323 | 27681 | (gdb) |
922fbb7b AC |
27682 | *stopped,reason="end-stepping-range", |
27683 | frame=@{func="foo",args=[@{name="a",value="10"@}, | |
76ff342d | 27684 | @{name="b",value="0"@}],file="recursive2.c", |
948d5102 | 27685 | fullname="/home/foo/bar/recursive2.c",line="11"@} |
594fe323 | 27686 | (gdb) |
922fbb7b AC |
27687 | @end smallexample |
27688 | ||
27689 | Regular stepping: | |
27690 | ||
27691 | @smallexample | |
27692 | -exec-step | |
27693 | ^running | |
594fe323 | 27694 | (gdb) |
922fbb7b | 27695 | *stopped,reason="end-stepping-range",line="14",file="recursive2.c" |
594fe323 | 27696 | (gdb) |
922fbb7b AC |
27697 | @end smallexample |
27698 | ||
27699 | ||
27700 | @subheading The @code{-exec-step-instruction} Command | |
27701 | @findex -exec-step-instruction | |
27702 | ||
27703 | @subsubheading Synopsis | |
27704 | ||
27705 | @smallexample | |
540aa8e7 | 27706 | -exec-step-instruction [--reverse] |
922fbb7b AC |
27707 | @end smallexample |
27708 | ||
540aa8e7 MS |
27709 | Resumes the inferior which executes one machine instruction. If the |
27710 | @samp{--reverse} option is specified, resumes reverse execution of the | |
27711 | inferior program, stopping at the previously executed instruction. | |
27712 | The output, once @value{GDBN} has stopped, will vary depending on | |
27713 | whether we have stopped in the middle of a source line or not. In the | |
27714 | former case, the address at which the program stopped will be printed | |
27715 | as well. | |
922fbb7b AC |
27716 | |
27717 | @subsubheading @value{GDBN} Command | |
27718 | ||
27719 | The corresponding @value{GDBN} command is @samp{stepi}. | |
27720 | ||
27721 | @subsubheading Example | |
27722 | ||
27723 | @smallexample | |
594fe323 | 27724 | (gdb) |
922fbb7b AC |
27725 | -exec-step-instruction |
27726 | ^running | |
27727 | ||
594fe323 | 27728 | (gdb) |
922fbb7b | 27729 | *stopped,reason="end-stepping-range", |
76ff342d | 27730 | frame=@{func="foo",args=[],file="try.c", |
948d5102 | 27731 | fullname="/home/foo/bar/try.c",line="10"@} |
594fe323 | 27732 | (gdb) |
922fbb7b AC |
27733 | -exec-step-instruction |
27734 | ^running | |
27735 | ||
594fe323 | 27736 | (gdb) |
922fbb7b | 27737 | *stopped,reason="end-stepping-range", |
76ff342d | 27738 | frame=@{addr="0x000100f4",func="foo",args=[],file="try.c", |
948d5102 | 27739 | fullname="/home/foo/bar/try.c",line="10"@} |
594fe323 | 27740 | (gdb) |
922fbb7b AC |
27741 | @end smallexample |
27742 | ||
27743 | ||
27744 | @subheading The @code{-exec-until} Command | |
27745 | @findex -exec-until | |
27746 | ||
27747 | @subsubheading Synopsis | |
27748 | ||
27749 | @smallexample | |
27750 | -exec-until [ @var{location} ] | |
27751 | @end smallexample | |
27752 | ||
ef21caaf NR |
27753 | Executes the inferior until the @var{location} specified in the |
27754 | argument is reached. If there is no argument, the inferior executes | |
27755 | until a source line greater than the current one is reached. The | |
27756 | reason for stopping in this case will be @samp{location-reached}. | |
922fbb7b AC |
27757 | |
27758 | @subsubheading @value{GDBN} Command | |
27759 | ||
27760 | The corresponding @value{GDBN} command is @samp{until}. | |
27761 | ||
27762 | @subsubheading Example | |
27763 | ||
27764 | @smallexample | |
594fe323 | 27765 | (gdb) |
922fbb7b AC |
27766 | -exec-until recursive2.c:6 |
27767 | ^running | |
594fe323 | 27768 | (gdb) |
922fbb7b AC |
27769 | x = 55 |
27770 | *stopped,reason="location-reached",frame=@{func="main",args=[], | |
948d5102 | 27771 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@} |
594fe323 | 27772 | (gdb) |
922fbb7b AC |
27773 | @end smallexample |
27774 | ||
27775 | @ignore | |
27776 | @subheading -file-clear | |
27777 | Is this going away???? | |
27778 | @end ignore | |
27779 | ||
351ff01a | 27780 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
a2c02241 NR |
27781 | @node GDB/MI Stack Manipulation |
27782 | @section @sc{gdb/mi} Stack Manipulation Commands | |
351ff01a | 27783 | |
922fbb7b | 27784 | |
a2c02241 NR |
27785 | @subheading The @code{-stack-info-frame} Command |
27786 | @findex -stack-info-frame | |
922fbb7b AC |
27787 | |
27788 | @subsubheading Synopsis | |
27789 | ||
27790 | @smallexample | |
a2c02241 | 27791 | -stack-info-frame |
922fbb7b AC |
27792 | @end smallexample |
27793 | ||
a2c02241 | 27794 | Get info on the selected frame. |
922fbb7b AC |
27795 | |
27796 | @subsubheading @value{GDBN} Command | |
27797 | ||
a2c02241 NR |
27798 | The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame} |
27799 | (without arguments). | |
922fbb7b AC |
27800 | |
27801 | @subsubheading Example | |
27802 | ||
27803 | @smallexample | |
594fe323 | 27804 | (gdb) |
a2c02241 NR |
27805 | -stack-info-frame |
27806 | ^done,frame=@{level="1",addr="0x0001076c",func="callee3", | |
27807 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27808 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@} | |
594fe323 | 27809 | (gdb) |
922fbb7b AC |
27810 | @end smallexample |
27811 | ||
a2c02241 NR |
27812 | @subheading The @code{-stack-info-depth} Command |
27813 | @findex -stack-info-depth | |
922fbb7b AC |
27814 | |
27815 | @subsubheading Synopsis | |
27816 | ||
27817 | @smallexample | |
a2c02241 | 27818 | -stack-info-depth [ @var{max-depth} ] |
922fbb7b AC |
27819 | @end smallexample |
27820 | ||
a2c02241 NR |
27821 | Return the depth of the stack. If the integer argument @var{max-depth} |
27822 | is specified, do not count beyond @var{max-depth} frames. | |
922fbb7b AC |
27823 | |
27824 | @subsubheading @value{GDBN} Command | |
27825 | ||
a2c02241 | 27826 | There's no equivalent @value{GDBN} command. |
922fbb7b AC |
27827 | |
27828 | @subsubheading Example | |
27829 | ||
a2c02241 NR |
27830 | For a stack with frame levels 0 through 11: |
27831 | ||
922fbb7b | 27832 | @smallexample |
594fe323 | 27833 | (gdb) |
a2c02241 NR |
27834 | -stack-info-depth |
27835 | ^done,depth="12" | |
594fe323 | 27836 | (gdb) |
a2c02241 NR |
27837 | -stack-info-depth 4 |
27838 | ^done,depth="4" | |
594fe323 | 27839 | (gdb) |
a2c02241 NR |
27840 | -stack-info-depth 12 |
27841 | ^done,depth="12" | |
594fe323 | 27842 | (gdb) |
a2c02241 NR |
27843 | -stack-info-depth 11 |
27844 | ^done,depth="11" | |
594fe323 | 27845 | (gdb) |
a2c02241 NR |
27846 | -stack-info-depth 13 |
27847 | ^done,depth="12" | |
594fe323 | 27848 | (gdb) |
922fbb7b AC |
27849 | @end smallexample |
27850 | ||
a2c02241 NR |
27851 | @subheading The @code{-stack-list-arguments} Command |
27852 | @findex -stack-list-arguments | |
922fbb7b AC |
27853 | |
27854 | @subsubheading Synopsis | |
27855 | ||
27856 | @smallexample | |
3afae151 | 27857 | -stack-list-arguments @var{print-values} |
a2c02241 | 27858 | [ @var{low-frame} @var{high-frame} ] |
922fbb7b AC |
27859 | @end smallexample |
27860 | ||
a2c02241 NR |
27861 | Display a list of the arguments for the frames between @var{low-frame} |
27862 | and @var{high-frame} (inclusive). If @var{low-frame} and | |
2f1acb09 VP |
27863 | @var{high-frame} are not provided, list the arguments for the whole |
27864 | call stack. If the two arguments are equal, show the single frame | |
27865 | at the corresponding level. It is an error if @var{low-frame} is | |
27866 | larger than the actual number of frames. On the other hand, | |
27867 | @var{high-frame} may be larger than the actual number of frames, in | |
27868 | which case only existing frames will be returned. | |
a2c02241 | 27869 | |
3afae151 VP |
27870 | If @var{print-values} is 0 or @code{--no-values}, print only the names of |
27871 | the variables; if it is 1 or @code{--all-values}, print also their | |
27872 | values; and if it is 2 or @code{--simple-values}, print the name, | |
27873 | type and value for simple data types, and the name and type for arrays, | |
27874 | structures and unions. | |
922fbb7b | 27875 | |
b3372f91 VP |
27876 | Use of this command to obtain arguments in a single frame is |
27877 | deprecated in favor of the @samp{-stack-list-variables} command. | |
27878 | ||
922fbb7b AC |
27879 | @subsubheading @value{GDBN} Command |
27880 | ||
a2c02241 NR |
27881 | @value{GDBN} does not have an equivalent command. @code{gdbtk} has a |
27882 | @samp{gdb_get_args} command which partially overlaps with the | |
27883 | functionality of @samp{-stack-list-arguments}. | |
922fbb7b AC |
27884 | |
27885 | @subsubheading Example | |
922fbb7b | 27886 | |
a2c02241 | 27887 | @smallexample |
594fe323 | 27888 | (gdb) |
a2c02241 NR |
27889 | -stack-list-frames |
27890 | ^done, | |
27891 | stack=[ | |
27892 | frame=@{level="0",addr="0x00010734",func="callee4", | |
27893 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27894 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}, | |
27895 | frame=@{level="1",addr="0x0001076c",func="callee3", | |
27896 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27897 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}, | |
27898 | frame=@{level="2",addr="0x0001078c",func="callee2", | |
27899 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27900 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@}, | |
27901 | frame=@{level="3",addr="0x000107b4",func="callee1", | |
27902 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27903 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@}, | |
27904 | frame=@{level="4",addr="0x000107e0",func="main", | |
27905 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", | |
27906 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}] | |
594fe323 | 27907 | (gdb) |
a2c02241 NR |
27908 | -stack-list-arguments 0 |
27909 | ^done, | |
27910 | stack-args=[ | |
27911 | frame=@{level="0",args=[]@}, | |
27912 | frame=@{level="1",args=[name="strarg"]@}, | |
27913 | frame=@{level="2",args=[name="intarg",name="strarg"]@}, | |
27914 | frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@}, | |
27915 | frame=@{level="4",args=[]@}] | |
594fe323 | 27916 | (gdb) |
a2c02241 NR |
27917 | -stack-list-arguments 1 |
27918 | ^done, | |
27919 | stack-args=[ | |
27920 | frame=@{level="0",args=[]@}, | |
27921 | frame=@{level="1", | |
27922 | args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@}, | |
27923 | frame=@{level="2",args=[ | |
27924 | @{name="intarg",value="2"@}, | |
27925 | @{name="strarg",value="0x11940 \"A string argument.\""@}]@}, | |
27926 | @{frame=@{level="3",args=[ | |
27927 | @{name="intarg",value="2"@}, | |
27928 | @{name="strarg",value="0x11940 \"A string argument.\""@}, | |
27929 | @{name="fltarg",value="3.5"@}]@}, | |
27930 | frame=@{level="4",args=[]@}] | |
594fe323 | 27931 | (gdb) |
a2c02241 NR |
27932 | -stack-list-arguments 0 2 2 |
27933 | ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}] | |
594fe323 | 27934 | (gdb) |
a2c02241 NR |
27935 | -stack-list-arguments 1 2 2 |
27936 | ^done,stack-args=[frame=@{level="2", | |
27937 | args=[@{name="intarg",value="2"@}, | |
27938 | @{name="strarg",value="0x11940 \"A string argument.\""@}]@}] | |
594fe323 | 27939 | (gdb) |
a2c02241 NR |
27940 | @end smallexample |
27941 | ||
27942 | @c @subheading -stack-list-exception-handlers | |
922fbb7b | 27943 | |
a2c02241 NR |
27944 | |
27945 | @subheading The @code{-stack-list-frames} Command | |
27946 | @findex -stack-list-frames | |
1abaf70c BR |
27947 | |
27948 | @subsubheading Synopsis | |
27949 | ||
27950 | @smallexample | |
a2c02241 | 27951 | -stack-list-frames [ @var{low-frame} @var{high-frame} ] |
1abaf70c BR |
27952 | @end smallexample |
27953 | ||
a2c02241 NR |
27954 | List the frames currently on the stack. For each frame it displays the |
27955 | following info: | |
27956 | ||
27957 | @table @samp | |
27958 | @item @var{level} | |
d3e8051b | 27959 | The frame number, 0 being the topmost frame, i.e., the innermost function. |
a2c02241 NR |
27960 | @item @var{addr} |
27961 | The @code{$pc} value for that frame. | |
27962 | @item @var{func} | |
27963 | Function name. | |
27964 | @item @var{file} | |
27965 | File name of the source file where the function lives. | |
7d288aaa TT |
27966 | @item @var{fullname} |
27967 | The full file name of the source file where the function lives. | |
a2c02241 NR |
27968 | @item @var{line} |
27969 | Line number corresponding to the @code{$pc}. | |
7d288aaa TT |
27970 | @item @var{from} |
27971 | The shared library where this function is defined. This is only given | |
27972 | if the frame's function is not known. | |
a2c02241 NR |
27973 | @end table |
27974 | ||
27975 | If invoked without arguments, this command prints a backtrace for the | |
27976 | whole stack. If given two integer arguments, it shows the frames whose | |
27977 | levels are between the two arguments (inclusive). If the two arguments | |
2ab1eb7a VP |
27978 | are equal, it shows the single frame at the corresponding level. It is |
27979 | an error if @var{low-frame} is larger than the actual number of | |
a5451f4e | 27980 | frames. On the other hand, @var{high-frame} may be larger than the |
2ab1eb7a | 27981 | actual number of frames, in which case only existing frames will be returned. |
1abaf70c BR |
27982 | |
27983 | @subsubheading @value{GDBN} Command | |
27984 | ||
a2c02241 | 27985 | The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}. |
1abaf70c BR |
27986 | |
27987 | @subsubheading Example | |
27988 | ||
a2c02241 NR |
27989 | Full stack backtrace: |
27990 | ||
1abaf70c | 27991 | @smallexample |
594fe323 | 27992 | (gdb) |
a2c02241 NR |
27993 | -stack-list-frames |
27994 | ^done,stack= | |
27995 | [frame=@{level="0",addr="0x0001076c",func="foo", | |
27996 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@}, | |
27997 | frame=@{level="1",addr="0x000107a4",func="foo", | |
27998 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
27999 | frame=@{level="2",addr="0x000107a4",func="foo", | |
28000 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28001 | frame=@{level="3",addr="0x000107a4",func="foo", | |
28002 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28003 | frame=@{level="4",addr="0x000107a4",func="foo", | |
28004 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28005 | frame=@{level="5",addr="0x000107a4",func="foo", | |
28006 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28007 | frame=@{level="6",addr="0x000107a4",func="foo", | |
28008 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28009 | frame=@{level="7",addr="0x000107a4",func="foo", | |
28010 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28011 | frame=@{level="8",addr="0x000107a4",func="foo", | |
28012 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28013 | frame=@{level="9",addr="0x000107a4",func="foo", | |
28014 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28015 | frame=@{level="10",addr="0x000107a4",func="foo", | |
28016 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28017 | frame=@{level="11",addr="0x00010738",func="main", | |
28018 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}] | |
594fe323 | 28019 | (gdb) |
1abaf70c BR |
28020 | @end smallexample |
28021 | ||
a2c02241 | 28022 | Show frames between @var{low_frame} and @var{high_frame}: |
1abaf70c | 28023 | |
a2c02241 | 28024 | @smallexample |
594fe323 | 28025 | (gdb) |
a2c02241 NR |
28026 | -stack-list-frames 3 5 |
28027 | ^done,stack= | |
28028 | [frame=@{level="3",addr="0x000107a4",func="foo", | |
28029 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28030 | frame=@{level="4",addr="0x000107a4",func="foo", | |
28031 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, | |
28032 | frame=@{level="5",addr="0x000107a4",func="foo", | |
28033 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}] | |
594fe323 | 28034 | (gdb) |
a2c02241 | 28035 | @end smallexample |
922fbb7b | 28036 | |
a2c02241 | 28037 | Show a single frame: |
922fbb7b AC |
28038 | |
28039 | @smallexample | |
594fe323 | 28040 | (gdb) |
a2c02241 NR |
28041 | -stack-list-frames 3 3 |
28042 | ^done,stack= | |
28043 | [frame=@{level="3",addr="0x000107a4",func="foo", | |
28044 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}] | |
594fe323 | 28045 | (gdb) |
922fbb7b AC |
28046 | @end smallexample |
28047 | ||
922fbb7b | 28048 | |
a2c02241 NR |
28049 | @subheading The @code{-stack-list-locals} Command |
28050 | @findex -stack-list-locals | |
57c22c6c | 28051 | |
a2c02241 | 28052 | @subsubheading Synopsis |
922fbb7b AC |
28053 | |
28054 | @smallexample | |
a2c02241 | 28055 | -stack-list-locals @var{print-values} |
922fbb7b AC |
28056 | @end smallexample |
28057 | ||
a2c02241 NR |
28058 | Display the local variable names for the selected frame. If |
28059 | @var{print-values} is 0 or @code{--no-values}, print only the names of | |
28060 | the variables; if it is 1 or @code{--all-values}, print also their | |
28061 | values; and if it is 2 or @code{--simple-values}, print the name, | |
3afae151 | 28062 | type and value for simple data types, and the name and type for arrays, |
a2c02241 NR |
28063 | structures and unions. In this last case, a frontend can immediately |
28064 | display the value of simple data types and create variable objects for | |
d3e8051b | 28065 | other data types when the user wishes to explore their values in |
a2c02241 | 28066 | more detail. |
922fbb7b | 28067 | |
b3372f91 VP |
28068 | This command is deprecated in favor of the |
28069 | @samp{-stack-list-variables} command. | |
28070 | ||
922fbb7b AC |
28071 | @subsubheading @value{GDBN} Command |
28072 | ||
a2c02241 | 28073 | @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}. |
922fbb7b AC |
28074 | |
28075 | @subsubheading Example | |
922fbb7b AC |
28076 | |
28077 | @smallexample | |
594fe323 | 28078 | (gdb) |
a2c02241 NR |
28079 | -stack-list-locals 0 |
28080 | ^done,locals=[name="A",name="B",name="C"] | |
594fe323 | 28081 | (gdb) |
a2c02241 NR |
28082 | -stack-list-locals --all-values |
28083 | ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@}, | |
28084 | @{name="C",value="@{1, 2, 3@}"@}] | |
28085 | -stack-list-locals --simple-values | |
28086 | ^done,locals=[@{name="A",type="int",value="1"@}, | |
28087 | @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}] | |
594fe323 | 28088 | (gdb) |
922fbb7b AC |
28089 | @end smallexample |
28090 | ||
b3372f91 VP |
28091 | @subheading The @code{-stack-list-variables} Command |
28092 | @findex -stack-list-variables | |
28093 | ||
28094 | @subsubheading Synopsis | |
28095 | ||
28096 | @smallexample | |
28097 | -stack-list-variables @var{print-values} | |
28098 | @end smallexample | |
28099 | ||
28100 | Display the names of local variables and function arguments for the selected frame. If | |
28101 | @var{print-values} is 0 or @code{--no-values}, print only the names of | |
28102 | the variables; if it is 1 or @code{--all-values}, print also their | |
28103 | values; and if it is 2 or @code{--simple-values}, print the name, | |
3afae151 | 28104 | type and value for simple data types, and the name and type for arrays, |
b3372f91 VP |
28105 | structures and unions. |
28106 | ||
28107 | @subsubheading Example | |
28108 | ||
28109 | @smallexample | |
28110 | (gdb) | |
28111 | -stack-list-variables --thread 1 --frame 0 --all-values | |
4f412fd0 | 28112 | ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}] |
b3372f91 VP |
28113 | (gdb) |
28114 | @end smallexample | |
28115 | ||
922fbb7b | 28116 | |
a2c02241 NR |
28117 | @subheading The @code{-stack-select-frame} Command |
28118 | @findex -stack-select-frame | |
922fbb7b AC |
28119 | |
28120 | @subsubheading Synopsis | |
28121 | ||
28122 | @smallexample | |
a2c02241 | 28123 | -stack-select-frame @var{framenum} |
922fbb7b AC |
28124 | @end smallexample |
28125 | ||
a2c02241 NR |
28126 | Change the selected frame. Select a different frame @var{framenum} on |
28127 | the stack. | |
922fbb7b | 28128 | |
c3b108f7 VP |
28129 | This command in deprecated in favor of passing the @samp{--frame} |
28130 | option to every command. | |
28131 | ||
922fbb7b AC |
28132 | @subsubheading @value{GDBN} Command |
28133 | ||
a2c02241 NR |
28134 | The corresponding @value{GDBN} commands are @samp{frame}, @samp{up}, |
28135 | @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}. | |
922fbb7b AC |
28136 | |
28137 | @subsubheading Example | |
28138 | ||
28139 | @smallexample | |
594fe323 | 28140 | (gdb) |
a2c02241 | 28141 | -stack-select-frame 2 |
922fbb7b | 28142 | ^done |
594fe323 | 28143 | (gdb) |
922fbb7b AC |
28144 | @end smallexample |
28145 | ||
28146 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
a2c02241 NR |
28147 | @node GDB/MI Variable Objects |
28148 | @section @sc{gdb/mi} Variable Objects | |
922fbb7b | 28149 | |
a1b5960f | 28150 | @ignore |
922fbb7b | 28151 | |
a2c02241 | 28152 | @subheading Motivation for Variable Objects in @sc{gdb/mi} |
922fbb7b | 28153 | |
a2c02241 NR |
28154 | For the implementation of a variable debugger window (locals, watched |
28155 | expressions, etc.), we are proposing the adaptation of the existing code | |
28156 | used by @code{Insight}. | |
922fbb7b | 28157 | |
a2c02241 | 28158 | The two main reasons for that are: |
922fbb7b | 28159 | |
a2c02241 NR |
28160 | @enumerate 1 |
28161 | @item | |
28162 | It has been proven in practice (it is already on its second generation). | |
922fbb7b | 28163 | |
a2c02241 NR |
28164 | @item |
28165 | It will shorten development time (needless to say how important it is | |
28166 | now). | |
28167 | @end enumerate | |
922fbb7b | 28168 | |
a2c02241 NR |
28169 | The original interface was designed to be used by Tcl code, so it was |
28170 | slightly changed so it could be used through @sc{gdb/mi}. This section | |
28171 | describes the @sc{gdb/mi} operations that will be available and gives some | |
28172 | hints about their use. | |
922fbb7b | 28173 | |
a2c02241 NR |
28174 | @emph{Note}: In addition to the set of operations described here, we |
28175 | expect the @sc{gui} implementation of a variable window to require, at | |
28176 | least, the following operations: | |
922fbb7b | 28177 | |
a2c02241 NR |
28178 | @itemize @bullet |
28179 | @item @code{-gdb-show} @code{output-radix} | |
28180 | @item @code{-stack-list-arguments} | |
28181 | @item @code{-stack-list-locals} | |
28182 | @item @code{-stack-select-frame} | |
28183 | @end itemize | |
922fbb7b | 28184 | |
a1b5960f VP |
28185 | @end ignore |
28186 | ||
c8b2f53c | 28187 | @subheading Introduction to Variable Objects |
922fbb7b | 28188 | |
a2c02241 | 28189 | @cindex variable objects in @sc{gdb/mi} |
c8b2f53c VP |
28190 | |
28191 | Variable objects are "object-oriented" MI interface for examining and | |
28192 | changing values of expressions. Unlike some other MI interfaces that | |
28193 | work with expressions, variable objects are specifically designed for | |
28194 | simple and efficient presentation in the frontend. A variable object | |
28195 | is identified by string name. When a variable object is created, the | |
28196 | frontend specifies the expression for that variable object. The | |
28197 | expression can be a simple variable, or it can be an arbitrary complex | |
28198 | expression, and can even involve CPU registers. After creating a | |
28199 | variable object, the frontend can invoke other variable object | |
28200 | operations---for example to obtain or change the value of a variable | |
28201 | object, or to change display format. | |
28202 | ||
28203 | Variable objects have hierarchical tree structure. Any variable object | |
28204 | that corresponds to a composite type, such as structure in C, has | |
28205 | a number of child variable objects, for example corresponding to each | |
28206 | element of a structure. A child variable object can itself have | |
28207 | children, recursively. Recursion ends when we reach | |
25d5ea92 VP |
28208 | leaf variable objects, which always have built-in types. Child variable |
28209 | objects are created only by explicit request, so if a frontend | |
28210 | is not interested in the children of a particular variable object, no | |
28211 | child will be created. | |
c8b2f53c VP |
28212 | |
28213 | For a leaf variable object it is possible to obtain its value as a | |
28214 | string, or set the value from a string. String value can be also | |
28215 | obtained for a non-leaf variable object, but it's generally a string | |
28216 | that only indicates the type of the object, and does not list its | |
28217 | contents. Assignment to a non-leaf variable object is not allowed. | |
28218 | ||
28219 | A frontend does not need to read the values of all variable objects each time | |
28220 | the program stops. Instead, MI provides an update command that lists all | |
28221 | variable objects whose values has changed since the last update | |
28222 | operation. This considerably reduces the amount of data that must | |
25d5ea92 VP |
28223 | be transferred to the frontend. As noted above, children variable |
28224 | objects are created on demand, and only leaf variable objects have a | |
28225 | real value. As result, gdb will read target memory only for leaf | |
28226 | variables that frontend has created. | |
28227 | ||
28228 | The automatic update is not always desirable. For example, a frontend | |
28229 | might want to keep a value of some expression for future reference, | |
28230 | and never update it. For another example, fetching memory is | |
28231 | relatively slow for embedded targets, so a frontend might want | |
28232 | to disable automatic update for the variables that are either not | |
28233 | visible on the screen, or ``closed''. This is possible using so | |
28234 | called ``frozen variable objects''. Such variable objects are never | |
28235 | implicitly updated. | |
922fbb7b | 28236 | |
c3b108f7 VP |
28237 | Variable objects can be either @dfn{fixed} or @dfn{floating}. For the |
28238 | fixed variable object, the expression is parsed when the variable | |
28239 | object is created, including associating identifiers to specific | |
28240 | variables. The meaning of expression never changes. For a floating | |
28241 | variable object the values of variables whose names appear in the | |
28242 | expressions are re-evaluated every time in the context of the current | |
28243 | frame. Consider this example: | |
28244 | ||
28245 | @smallexample | |
28246 | void do_work(...) | |
28247 | @{ | |
28248 | struct work_state state; | |
28249 | ||
28250 | if (...) | |
28251 | do_work(...); | |
28252 | @} | |
28253 | @end smallexample | |
28254 | ||
28255 | If a fixed variable object for the @code{state} variable is created in | |
7a9dd1b2 | 28256 | this function, and we enter the recursive call, the variable |
c3b108f7 VP |
28257 | object will report the value of @code{state} in the top-level |
28258 | @code{do_work} invocation. On the other hand, a floating variable | |
28259 | object will report the value of @code{state} in the current frame. | |
28260 | ||
28261 | If an expression specified when creating a fixed variable object | |
28262 | refers to a local variable, the variable object becomes bound to the | |
28263 | thread and frame in which the variable object is created. When such | |
28264 | variable object is updated, @value{GDBN} makes sure that the | |
28265 | thread/frame combination the variable object is bound to still exists, | |
28266 | and re-evaluates the variable object in context of that thread/frame. | |
28267 | ||
a2c02241 NR |
28268 | The following is the complete set of @sc{gdb/mi} operations defined to |
28269 | access this functionality: | |
922fbb7b | 28270 | |
a2c02241 NR |
28271 | @multitable @columnfractions .4 .6 |
28272 | @item @strong{Operation} | |
28273 | @tab @strong{Description} | |
922fbb7b | 28274 | |
0cc7d26f TT |
28275 | @item @code{-enable-pretty-printing} |
28276 | @tab enable Python-based pretty-printing | |
a2c02241 NR |
28277 | @item @code{-var-create} |
28278 | @tab create a variable object | |
28279 | @item @code{-var-delete} | |
22d8a470 | 28280 | @tab delete the variable object and/or its children |
a2c02241 NR |
28281 | @item @code{-var-set-format} |
28282 | @tab set the display format of this variable | |
28283 | @item @code{-var-show-format} | |
28284 | @tab show the display format of this variable | |
28285 | @item @code{-var-info-num-children} | |
28286 | @tab tells how many children this object has | |
28287 | @item @code{-var-list-children} | |
28288 | @tab return a list of the object's children | |
28289 | @item @code{-var-info-type} | |
28290 | @tab show the type of this variable object | |
28291 | @item @code{-var-info-expression} | |
02142340 VP |
28292 | @tab print parent-relative expression that this variable object represents |
28293 | @item @code{-var-info-path-expression} | |
28294 | @tab print full expression that this variable object represents | |
a2c02241 NR |
28295 | @item @code{-var-show-attributes} |
28296 | @tab is this variable editable? does it exist here? | |
28297 | @item @code{-var-evaluate-expression} | |
28298 | @tab get the value of this variable | |
28299 | @item @code{-var-assign} | |
28300 | @tab set the value of this variable | |
28301 | @item @code{-var-update} | |
28302 | @tab update the variable and its children | |
25d5ea92 VP |
28303 | @item @code{-var-set-frozen} |
28304 | @tab set frozeness attribute | |
0cc7d26f TT |
28305 | @item @code{-var-set-update-range} |
28306 | @tab set range of children to display on update | |
a2c02241 | 28307 | @end multitable |
922fbb7b | 28308 | |
a2c02241 NR |
28309 | In the next subsection we describe each operation in detail and suggest |
28310 | how it can be used. | |
922fbb7b | 28311 | |
a2c02241 | 28312 | @subheading Description And Use of Operations on Variable Objects |
922fbb7b | 28313 | |
0cc7d26f TT |
28314 | @subheading The @code{-enable-pretty-printing} Command |
28315 | @findex -enable-pretty-printing | |
28316 | ||
28317 | @smallexample | |
28318 | -enable-pretty-printing | |
28319 | @end smallexample | |
28320 | ||
28321 | @value{GDBN} allows Python-based visualizers to affect the output of the | |
28322 | MI variable object commands. However, because there was no way to | |
28323 | implement this in a fully backward-compatible way, a front end must | |
28324 | request that this functionality be enabled. | |
28325 | ||
28326 | Once enabled, this feature cannot be disabled. | |
28327 | ||
28328 | Note that if Python support has not been compiled into @value{GDBN}, | |
28329 | this command will still succeed (and do nothing). | |
28330 | ||
f43030c4 TT |
28331 | This feature is currently (as of @value{GDBN} 7.0) experimental, and |
28332 | may work differently in future versions of @value{GDBN}. | |
28333 | ||
a2c02241 NR |
28334 | @subheading The @code{-var-create} Command |
28335 | @findex -var-create | |
ef21caaf | 28336 | |
a2c02241 | 28337 | @subsubheading Synopsis |
ef21caaf | 28338 | |
a2c02241 NR |
28339 | @smallexample |
28340 | -var-create @{@var{name} | "-"@} | |
c3b108f7 | 28341 | @{@var{frame-addr} | "*" | "@@"@} @var{expression} |
a2c02241 NR |
28342 | @end smallexample |
28343 | ||
28344 | This operation creates a variable object, which allows the monitoring of | |
28345 | a variable, the result of an expression, a memory cell or a CPU | |
28346 | register. | |
ef21caaf | 28347 | |
a2c02241 NR |
28348 | The @var{name} parameter is the string by which the object can be |
28349 | referenced. It must be unique. If @samp{-} is specified, the varobj | |
28350 | system will generate a string ``varNNNNNN'' automatically. It will be | |
c3b108f7 | 28351 | unique provided that one does not specify @var{name} of that format. |
a2c02241 | 28352 | The command fails if a duplicate name is found. |
ef21caaf | 28353 | |
a2c02241 NR |
28354 | The frame under which the expression should be evaluated can be |
28355 | specified by @var{frame-addr}. A @samp{*} indicates that the current | |
c3b108f7 VP |
28356 | frame should be used. A @samp{@@} indicates that a floating variable |
28357 | object must be created. | |
922fbb7b | 28358 | |
a2c02241 NR |
28359 | @var{expression} is any expression valid on the current language set (must not |
28360 | begin with a @samp{*}), or one of the following: | |
922fbb7b | 28361 | |
a2c02241 NR |
28362 | @itemize @bullet |
28363 | @item | |
28364 | @samp{*@var{addr}}, where @var{addr} is the address of a memory cell | |
922fbb7b | 28365 | |
a2c02241 NR |
28366 | @item |
28367 | @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD) | |
922fbb7b | 28368 | |
a2c02241 NR |
28369 | @item |
28370 | @samp{$@var{regname}} --- a CPU register name | |
28371 | @end itemize | |
922fbb7b | 28372 | |
0cc7d26f TT |
28373 | @cindex dynamic varobj |
28374 | A varobj's contents may be provided by a Python-based pretty-printer. In this | |
28375 | case the varobj is known as a @dfn{dynamic varobj}. Dynamic varobjs | |
28376 | have slightly different semantics in some cases. If the | |
28377 | @code{-enable-pretty-printing} command is not sent, then @value{GDBN} | |
28378 | will never create a dynamic varobj. This ensures backward | |
28379 | compatibility for existing clients. | |
28380 | ||
a2c02241 | 28381 | @subsubheading Result |
922fbb7b | 28382 | |
0cc7d26f TT |
28383 | This operation returns attributes of the newly-created varobj. These |
28384 | are: | |
28385 | ||
28386 | @table @samp | |
28387 | @item name | |
28388 | The name of the varobj. | |
28389 | ||
28390 | @item numchild | |
28391 | The number of children of the varobj. This number is not necessarily | |
28392 | reliable for a dynamic varobj. Instead, you must examine the | |
28393 | @samp{has_more} attribute. | |
28394 | ||
28395 | @item value | |
28396 | The varobj's scalar value. For a varobj whose type is some sort of | |
28397 | aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value | |
28398 | will not be interesting. | |
28399 | ||
28400 | @item type | |
28401 | The varobj's type. This is a string representation of the type, as | |
28402 | would be printed by the @value{GDBN} CLI. | |
28403 | ||
28404 | @item thread-id | |
28405 | If a variable object is bound to a specific thread, then this is the | |
28406 | thread's identifier. | |
28407 | ||
28408 | @item has_more | |
28409 | For a dynamic varobj, this indicates whether there appear to be any | |
28410 | children available. For a non-dynamic varobj, this will be 0. | |
28411 | ||
28412 | @item dynamic | |
28413 | This attribute will be present and have the value @samp{1} if the | |
28414 | varobj is a dynamic varobj. If the varobj is not a dynamic varobj, | |
28415 | then this attribute will not be present. | |
28416 | ||
28417 | @item displayhint | |
28418 | A dynamic varobj can supply a display hint to the front end. The | |
28419 | value comes directly from the Python pretty-printer object's | |
4c374409 | 28420 | @code{display_hint} method. @xref{Pretty Printing API}. |
0cc7d26f TT |
28421 | @end table |
28422 | ||
28423 | Typical output will look like this: | |
922fbb7b AC |
28424 | |
28425 | @smallexample | |
0cc7d26f TT |
28426 | name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}", |
28427 | has_more="@var{has_more}" | |
dcaaae04 NR |
28428 | @end smallexample |
28429 | ||
a2c02241 NR |
28430 | |
28431 | @subheading The @code{-var-delete} Command | |
28432 | @findex -var-delete | |
922fbb7b AC |
28433 | |
28434 | @subsubheading Synopsis | |
28435 | ||
28436 | @smallexample | |
22d8a470 | 28437 | -var-delete [ -c ] @var{name} |
922fbb7b AC |
28438 | @end smallexample |
28439 | ||
a2c02241 | 28440 | Deletes a previously created variable object and all of its children. |
22d8a470 | 28441 | With the @samp{-c} option, just deletes the children. |
922fbb7b | 28442 | |
a2c02241 | 28443 | Returns an error if the object @var{name} is not found. |
922fbb7b | 28444 | |
922fbb7b | 28445 | |
a2c02241 NR |
28446 | @subheading The @code{-var-set-format} Command |
28447 | @findex -var-set-format | |
922fbb7b | 28448 | |
a2c02241 | 28449 | @subsubheading Synopsis |
922fbb7b AC |
28450 | |
28451 | @smallexample | |
a2c02241 | 28452 | -var-set-format @var{name} @var{format-spec} |
922fbb7b AC |
28453 | @end smallexample |
28454 | ||
a2c02241 NR |
28455 | Sets the output format for the value of the object @var{name} to be |
28456 | @var{format-spec}. | |
28457 | ||
de051565 | 28458 | @anchor{-var-set-format} |
a2c02241 NR |
28459 | The syntax for the @var{format-spec} is as follows: |
28460 | ||
28461 | @smallexample | |
28462 | @var{format-spec} @expansion{} | |
28463 | @{binary | decimal | hexadecimal | octal | natural@} | |
28464 | @end smallexample | |
28465 | ||
c8b2f53c VP |
28466 | The natural format is the default format choosen automatically |
28467 | based on the variable type (like decimal for an @code{int}, hex | |
28468 | for pointers, etc.). | |
28469 | ||
28470 | For a variable with children, the format is set only on the | |
28471 | variable itself, and the children are not affected. | |
a2c02241 NR |
28472 | |
28473 | @subheading The @code{-var-show-format} Command | |
28474 | @findex -var-show-format | |
922fbb7b AC |
28475 | |
28476 | @subsubheading Synopsis | |
28477 | ||
28478 | @smallexample | |
a2c02241 | 28479 | -var-show-format @var{name} |
922fbb7b AC |
28480 | @end smallexample |
28481 | ||
a2c02241 | 28482 | Returns the format used to display the value of the object @var{name}. |
922fbb7b | 28483 | |
a2c02241 NR |
28484 | @smallexample |
28485 | @var{format} @expansion{} | |
28486 | @var{format-spec} | |
28487 | @end smallexample | |
922fbb7b | 28488 | |
922fbb7b | 28489 | |
a2c02241 NR |
28490 | @subheading The @code{-var-info-num-children} Command |
28491 | @findex -var-info-num-children | |
28492 | ||
28493 | @subsubheading Synopsis | |
28494 | ||
28495 | @smallexample | |
28496 | -var-info-num-children @var{name} | |
28497 | @end smallexample | |
28498 | ||
28499 | Returns the number of children of a variable object @var{name}: | |
28500 | ||
28501 | @smallexample | |
28502 | numchild=@var{n} | |
28503 | @end smallexample | |
28504 | ||
0cc7d26f TT |
28505 | Note that this number is not completely reliable for a dynamic varobj. |
28506 | It will return the current number of children, but more children may | |
28507 | be available. | |
28508 | ||
a2c02241 NR |
28509 | |
28510 | @subheading The @code{-var-list-children} Command | |
28511 | @findex -var-list-children | |
28512 | ||
28513 | @subsubheading Synopsis | |
28514 | ||
28515 | @smallexample | |
0cc7d26f | 28516 | -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}] |
a2c02241 | 28517 | @end smallexample |
b569d230 | 28518 | @anchor{-var-list-children} |
a2c02241 NR |
28519 | |
28520 | Return a list of the children of the specified variable object and | |
28521 | create variable objects for them, if they do not already exist. With | |
f5011d11 | 28522 | a single argument or if @var{print-values} has a value of 0 or |
a2c02241 NR |
28523 | @code{--no-values}, print only the names of the variables; if |
28524 | @var{print-values} is 1 or @code{--all-values}, also print their | |
28525 | values; and if it is 2 or @code{--simple-values} print the name and | |
28526 | value for simple data types and just the name for arrays, structures | |
28527 | and unions. | |
922fbb7b | 28528 | |
0cc7d26f TT |
28529 | @var{from} and @var{to}, if specified, indicate the range of children |
28530 | to report. If @var{from} or @var{to} is less than zero, the range is | |
28531 | reset and all children will be reported. Otherwise, children starting | |
28532 | at @var{from} (zero-based) and up to and excluding @var{to} will be | |
28533 | reported. | |
28534 | ||
28535 | If a child range is requested, it will only affect the current call to | |
28536 | @code{-var-list-children}, but not future calls to @code{-var-update}. | |
28537 | For this, you must instead use @code{-var-set-update-range}. The | |
28538 | intent of this approach is to enable a front end to implement any | |
28539 | update approach it likes; for example, scrolling a view may cause the | |
28540 | front end to request more children with @code{-var-list-children}, and | |
28541 | then the front end could call @code{-var-set-update-range} with a | |
28542 | different range to ensure that future updates are restricted to just | |
28543 | the visible items. | |
28544 | ||
b569d230 EZ |
28545 | For each child the following results are returned: |
28546 | ||
28547 | @table @var | |
28548 | ||
28549 | @item name | |
28550 | Name of the variable object created for this child. | |
28551 | ||
28552 | @item exp | |
28553 | The expression to be shown to the user by the front end to designate this child. | |
28554 | For example this may be the name of a structure member. | |
28555 | ||
0cc7d26f TT |
28556 | For a dynamic varobj, this value cannot be used to form an |
28557 | expression. There is no way to do this at all with a dynamic varobj. | |
28558 | ||
b569d230 EZ |
28559 | For C/C@t{++} structures there are several pseudo children returned to |
28560 | designate access qualifiers. For these pseudo children @var{exp} is | |
28561 | @samp{public}, @samp{private}, or @samp{protected}. In this case the | |
28562 | type and value are not present. | |
28563 | ||
0cc7d26f TT |
28564 | A dynamic varobj will not report the access qualifying |
28565 | pseudo-children, regardless of the language. This information is not | |
28566 | available at all with a dynamic varobj. | |
28567 | ||
b569d230 | 28568 | @item numchild |
0cc7d26f TT |
28569 | Number of children this child has. For a dynamic varobj, this will be |
28570 | 0. | |
b569d230 EZ |
28571 | |
28572 | @item type | |
28573 | The type of the child. | |
28574 | ||
28575 | @item value | |
28576 | If values were requested, this is the value. | |
28577 | ||
28578 | @item thread-id | |
28579 | If this variable object is associated with a thread, this is the thread id. | |
28580 | Otherwise this result is not present. | |
28581 | ||
28582 | @item frozen | |
28583 | If the variable object is frozen, this variable will be present with a value of 1. | |
28584 | @end table | |
28585 | ||
0cc7d26f TT |
28586 | The result may have its own attributes: |
28587 | ||
28588 | @table @samp | |
28589 | @item displayhint | |
28590 | A dynamic varobj can supply a display hint to the front end. The | |
28591 | value comes directly from the Python pretty-printer object's | |
4c374409 | 28592 | @code{display_hint} method. @xref{Pretty Printing API}. |
0cc7d26f TT |
28593 | |
28594 | @item has_more | |
28595 | This is an integer attribute which is nonzero if there are children | |
28596 | remaining after the end of the selected range. | |
28597 | @end table | |
28598 | ||
922fbb7b AC |
28599 | @subsubheading Example |
28600 | ||
28601 | @smallexample | |
594fe323 | 28602 | (gdb) |
a2c02241 | 28603 | -var-list-children n |
b569d230 | 28604 | ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp}, |
a2c02241 | 28605 | numchild=@var{n},type=@var{type}@},@r{(repeats N times)}] |
594fe323 | 28606 | (gdb) |
a2c02241 | 28607 | -var-list-children --all-values n |
b569d230 | 28608 | ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp}, |
a2c02241 | 28609 | numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}] |
922fbb7b AC |
28610 | @end smallexample |
28611 | ||
922fbb7b | 28612 | |
a2c02241 NR |
28613 | @subheading The @code{-var-info-type} Command |
28614 | @findex -var-info-type | |
922fbb7b | 28615 | |
a2c02241 NR |
28616 | @subsubheading Synopsis |
28617 | ||
28618 | @smallexample | |
28619 | -var-info-type @var{name} | |
28620 | @end smallexample | |
28621 | ||
28622 | Returns the type of the specified variable @var{name}. The type is | |
28623 | returned as a string in the same format as it is output by the | |
28624 | @value{GDBN} CLI: | |
28625 | ||
28626 | @smallexample | |
28627 | type=@var{typename} | |
28628 | @end smallexample | |
28629 | ||
28630 | ||
28631 | @subheading The @code{-var-info-expression} Command | |
28632 | @findex -var-info-expression | |
922fbb7b AC |
28633 | |
28634 | @subsubheading Synopsis | |
28635 | ||
28636 | @smallexample | |
a2c02241 | 28637 | -var-info-expression @var{name} |
922fbb7b AC |
28638 | @end smallexample |
28639 | ||
02142340 VP |
28640 | Returns a string that is suitable for presenting this |
28641 | variable object in user interface. The string is generally | |
28642 | not valid expression in the current language, and cannot be evaluated. | |
28643 | ||
28644 | For example, if @code{a} is an array, and variable object | |
28645 | @code{A} was created for @code{a}, then we'll get this output: | |
922fbb7b | 28646 | |
a2c02241 | 28647 | @smallexample |
02142340 VP |
28648 | (gdb) -var-info-expression A.1 |
28649 | ^done,lang="C",exp="1" | |
a2c02241 | 28650 | @end smallexample |
922fbb7b | 28651 | |
a2c02241 | 28652 | @noindent |
02142340 VP |
28653 | Here, the values of @code{lang} can be @code{@{"C" | "C++" | "Java"@}}. |
28654 | ||
28655 | Note that the output of the @code{-var-list-children} command also | |
28656 | includes those expressions, so the @code{-var-info-expression} command | |
28657 | is of limited use. | |
28658 | ||
28659 | @subheading The @code{-var-info-path-expression} Command | |
28660 | @findex -var-info-path-expression | |
28661 | ||
28662 | @subsubheading Synopsis | |
28663 | ||
28664 | @smallexample | |
28665 | -var-info-path-expression @var{name} | |
28666 | @end smallexample | |
28667 | ||
28668 | Returns an expression that can be evaluated in the current | |
28669 | context and will yield the same value that a variable object has. | |
28670 | Compare this with the @code{-var-info-expression} command, which | |
28671 | result can be used only for UI presentation. Typical use of | |
28672 | the @code{-var-info-path-expression} command is creating a | |
28673 | watchpoint from a variable object. | |
28674 | ||
0cc7d26f TT |
28675 | This command is currently not valid for children of a dynamic varobj, |
28676 | and will give an error when invoked on one. | |
28677 | ||
02142340 VP |
28678 | For example, suppose @code{C} is a C@t{++} class, derived from class |
28679 | @code{Base}, and that the @code{Base} class has a member called | |
28680 | @code{m_size}. Assume a variable @code{c} is has the type of | |
28681 | @code{C} and a variable object @code{C} was created for variable | |
28682 | @code{c}. Then, we'll get this output: | |
28683 | @smallexample | |
28684 | (gdb) -var-info-path-expression C.Base.public.m_size | |
28685 | ^done,path_expr=((Base)c).m_size) | |
28686 | @end smallexample | |
922fbb7b | 28687 | |
a2c02241 NR |
28688 | @subheading The @code{-var-show-attributes} Command |
28689 | @findex -var-show-attributes | |
922fbb7b | 28690 | |
a2c02241 | 28691 | @subsubheading Synopsis |
922fbb7b | 28692 | |
a2c02241 NR |
28693 | @smallexample |
28694 | -var-show-attributes @var{name} | |
28695 | @end smallexample | |
922fbb7b | 28696 | |
a2c02241 | 28697 | List attributes of the specified variable object @var{name}: |
922fbb7b AC |
28698 | |
28699 | @smallexample | |
a2c02241 | 28700 | status=@var{attr} [ ( ,@var{attr} )* ] |
922fbb7b AC |
28701 | @end smallexample |
28702 | ||
a2c02241 NR |
28703 | @noindent |
28704 | where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}. | |
28705 | ||
28706 | @subheading The @code{-var-evaluate-expression} Command | |
28707 | @findex -var-evaluate-expression | |
28708 | ||
28709 | @subsubheading Synopsis | |
28710 | ||
28711 | @smallexample | |
de051565 | 28712 | -var-evaluate-expression [-f @var{format-spec}] @var{name} |
a2c02241 NR |
28713 | @end smallexample |
28714 | ||
28715 | Evaluates the expression that is represented by the specified variable | |
de051565 MK |
28716 | object and returns its value as a string. The format of the string |
28717 | can be specified with the @samp{-f} option. The possible values of | |
28718 | this option are the same as for @code{-var-set-format} | |
28719 | (@pxref{-var-set-format}). If the @samp{-f} option is not specified, | |
28720 | the current display format will be used. The current display format | |
28721 | can be changed using the @code{-var-set-format} command. | |
a2c02241 NR |
28722 | |
28723 | @smallexample | |
28724 | value=@var{value} | |
28725 | @end smallexample | |
28726 | ||
28727 | Note that one must invoke @code{-var-list-children} for a variable | |
28728 | before the value of a child variable can be evaluated. | |
28729 | ||
28730 | @subheading The @code{-var-assign} Command | |
28731 | @findex -var-assign | |
28732 | ||
28733 | @subsubheading Synopsis | |
28734 | ||
28735 | @smallexample | |
28736 | -var-assign @var{name} @var{expression} | |
28737 | @end smallexample | |
28738 | ||
28739 | Assigns the value of @var{expression} to the variable object specified | |
28740 | by @var{name}. The object must be @samp{editable}. If the variable's | |
28741 | value is altered by the assign, the variable will show up in any | |
28742 | subsequent @code{-var-update} list. | |
28743 | ||
28744 | @subsubheading Example | |
922fbb7b AC |
28745 | |
28746 | @smallexample | |
594fe323 | 28747 | (gdb) |
a2c02241 NR |
28748 | -var-assign var1 3 |
28749 | ^done,value="3" | |
594fe323 | 28750 | (gdb) |
a2c02241 NR |
28751 | -var-update * |
28752 | ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}] | |
594fe323 | 28753 | (gdb) |
922fbb7b AC |
28754 | @end smallexample |
28755 | ||
a2c02241 NR |
28756 | @subheading The @code{-var-update} Command |
28757 | @findex -var-update | |
28758 | ||
28759 | @subsubheading Synopsis | |
28760 | ||
28761 | @smallexample | |
28762 | -var-update [@var{print-values}] @{@var{name} | "*"@} | |
28763 | @end smallexample | |
28764 | ||
c8b2f53c VP |
28765 | Reevaluate the expressions corresponding to the variable object |
28766 | @var{name} and all its direct and indirect children, and return the | |
36ece8b3 NR |
28767 | list of variable objects whose values have changed; @var{name} must |
28768 | be a root variable object. Here, ``changed'' means that the result of | |
28769 | @code{-var-evaluate-expression} before and after the | |
28770 | @code{-var-update} is different. If @samp{*} is used as the variable | |
9f708cb2 VP |
28771 | object names, all existing variable objects are updated, except |
28772 | for frozen ones (@pxref{-var-set-frozen}). The option | |
36ece8b3 | 28773 | @var{print-values} determines whether both names and values, or just |
de051565 | 28774 | names are printed. The possible values of this option are the same |
36ece8b3 NR |
28775 | as for @code{-var-list-children} (@pxref{-var-list-children}). It is |
28776 | recommended to use the @samp{--all-values} option, to reduce the | |
28777 | number of MI commands needed on each program stop. | |
c8b2f53c | 28778 | |
c3b108f7 VP |
28779 | With the @samp{*} parameter, if a variable object is bound to a |
28780 | currently running thread, it will not be updated, without any | |
28781 | diagnostic. | |
a2c02241 | 28782 | |
0cc7d26f TT |
28783 | If @code{-var-set-update-range} was previously used on a varobj, then |
28784 | only the selected range of children will be reported. | |
922fbb7b | 28785 | |
0cc7d26f TT |
28786 | @code{-var-update} reports all the changed varobjs in a tuple named |
28787 | @samp{changelist}. | |
28788 | ||
28789 | Each item in the change list is itself a tuple holding: | |
28790 | ||
28791 | @table @samp | |
28792 | @item name | |
28793 | The name of the varobj. | |
28794 | ||
28795 | @item value | |
28796 | If values were requested for this update, then this field will be | |
28797 | present and will hold the value of the varobj. | |
922fbb7b | 28798 | |
0cc7d26f | 28799 | @item in_scope |
9f708cb2 | 28800 | @anchor{-var-update} |
0cc7d26f | 28801 | This field is a string which may take one of three values: |
36ece8b3 NR |
28802 | |
28803 | @table @code | |
28804 | @item "true" | |
28805 | The variable object's current value is valid. | |
28806 | ||
28807 | @item "false" | |
28808 | The variable object does not currently hold a valid value but it may | |
28809 | hold one in the future if its associated expression comes back into | |
28810 | scope. | |
28811 | ||
28812 | @item "invalid" | |
28813 | The variable object no longer holds a valid value. | |
28814 | This can occur when the executable file being debugged has changed, | |
28815 | either through recompilation or by using the @value{GDBN} @code{file} | |
28816 | command. The front end should normally choose to delete these variable | |
28817 | objects. | |
28818 | @end table | |
28819 | ||
28820 | In the future new values may be added to this list so the front should | |
28821 | be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}. | |
28822 | ||
0cc7d26f TT |
28823 | @item type_changed |
28824 | This is only present if the varobj is still valid. If the type | |
28825 | changed, then this will be the string @samp{true}; otherwise it will | |
28826 | be @samp{false}. | |
28827 | ||
28828 | @item new_type | |
28829 | If the varobj's type changed, then this field will be present and will | |
28830 | hold the new type. | |
28831 | ||
28832 | @item new_num_children | |
28833 | For a dynamic varobj, if the number of children changed, or if the | |
28834 | type changed, this will be the new number of children. | |
28835 | ||
28836 | The @samp{numchild} field in other varobj responses is generally not | |
28837 | valid for a dynamic varobj -- it will show the number of children that | |
28838 | @value{GDBN} knows about, but because dynamic varobjs lazily | |
28839 | instantiate their children, this will not reflect the number of | |
28840 | children which may be available. | |
28841 | ||
28842 | The @samp{new_num_children} attribute only reports changes to the | |
28843 | number of children known by @value{GDBN}. This is the only way to | |
28844 | detect whether an update has removed children (which necessarily can | |
28845 | only happen at the end of the update range). | |
28846 | ||
28847 | @item displayhint | |
28848 | The display hint, if any. | |
28849 | ||
28850 | @item has_more | |
28851 | This is an integer value, which will be 1 if there are more children | |
28852 | available outside the varobj's update range. | |
28853 | ||
28854 | @item dynamic | |
28855 | This attribute will be present and have the value @samp{1} if the | |
28856 | varobj is a dynamic varobj. If the varobj is not a dynamic varobj, | |
28857 | then this attribute will not be present. | |
28858 | ||
28859 | @item new_children | |
28860 | If new children were added to a dynamic varobj within the selected | |
28861 | update range (as set by @code{-var-set-update-range}), then they will | |
28862 | be listed in this attribute. | |
28863 | @end table | |
28864 | ||
28865 | @subsubheading Example | |
28866 | ||
28867 | @smallexample | |
28868 | (gdb) | |
28869 | -var-assign var1 3 | |
28870 | ^done,value="3" | |
28871 | (gdb) | |
28872 | -var-update --all-values var1 | |
28873 | ^done,changelist=[@{name="var1",value="3",in_scope="true", | |
28874 | type_changed="false"@}] | |
28875 | (gdb) | |
28876 | @end smallexample | |
28877 | ||
25d5ea92 VP |
28878 | @subheading The @code{-var-set-frozen} Command |
28879 | @findex -var-set-frozen | |
9f708cb2 | 28880 | @anchor{-var-set-frozen} |
25d5ea92 VP |
28881 | |
28882 | @subsubheading Synopsis | |
28883 | ||
28884 | @smallexample | |
9f708cb2 | 28885 | -var-set-frozen @var{name} @var{flag} |
25d5ea92 VP |
28886 | @end smallexample |
28887 | ||
9f708cb2 | 28888 | Set the frozenness flag on the variable object @var{name}. The |
25d5ea92 | 28889 | @var{flag} parameter should be either @samp{1} to make the variable |
9f708cb2 | 28890 | frozen or @samp{0} to make it unfrozen. If a variable object is |
25d5ea92 | 28891 | frozen, then neither itself, nor any of its children, are |
9f708cb2 | 28892 | implicitly updated by @code{-var-update} of |
25d5ea92 VP |
28893 | a parent variable or by @code{-var-update *}. Only |
28894 | @code{-var-update} of the variable itself will update its value and | |
28895 | values of its children. After a variable object is unfrozen, it is | |
28896 | implicitly updated by all subsequent @code{-var-update} operations. | |
28897 | Unfreezing a variable does not update it, only subsequent | |
28898 | @code{-var-update} does. | |
28899 | ||
28900 | @subsubheading Example | |
28901 | ||
28902 | @smallexample | |
28903 | (gdb) | |
28904 | -var-set-frozen V 1 | |
28905 | ^done | |
28906 | (gdb) | |
28907 | @end smallexample | |
28908 | ||
0cc7d26f TT |
28909 | @subheading The @code{-var-set-update-range} command |
28910 | @findex -var-set-update-range | |
28911 | @anchor{-var-set-update-range} | |
28912 | ||
28913 | @subsubheading Synopsis | |
28914 | ||
28915 | @smallexample | |
28916 | -var-set-update-range @var{name} @var{from} @var{to} | |
28917 | @end smallexample | |
28918 | ||
28919 | Set the range of children to be returned by future invocations of | |
28920 | @code{-var-update}. | |
28921 | ||
28922 | @var{from} and @var{to} indicate the range of children to report. If | |
28923 | @var{from} or @var{to} is less than zero, the range is reset and all | |
28924 | children will be reported. Otherwise, children starting at @var{from} | |
28925 | (zero-based) and up to and excluding @var{to} will be reported. | |
28926 | ||
28927 | @subsubheading Example | |
28928 | ||
28929 | @smallexample | |
28930 | (gdb) | |
28931 | -var-set-update-range V 1 2 | |
28932 | ^done | |
28933 | @end smallexample | |
28934 | ||
b6313243 TT |
28935 | @subheading The @code{-var-set-visualizer} command |
28936 | @findex -var-set-visualizer | |
28937 | @anchor{-var-set-visualizer} | |
28938 | ||
28939 | @subsubheading Synopsis | |
28940 | ||
28941 | @smallexample | |
28942 | -var-set-visualizer @var{name} @var{visualizer} | |
28943 | @end smallexample | |
28944 | ||
28945 | Set a visualizer for the variable object @var{name}. | |
28946 | ||
28947 | @var{visualizer} is the visualizer to use. The special value | |
28948 | @samp{None} means to disable any visualizer in use. | |
28949 | ||
28950 | If not @samp{None}, @var{visualizer} must be a Python expression. | |
28951 | This expression must evaluate to a callable object which accepts a | |
28952 | single argument. @value{GDBN} will call this object with the value of | |
28953 | the varobj @var{name} as an argument (this is done so that the same | |
28954 | Python pretty-printing code can be used for both the CLI and MI). | |
28955 | When called, this object must return an object which conforms to the | |
4c374409 | 28956 | pretty-printing interface (@pxref{Pretty Printing API}). |
b6313243 TT |
28957 | |
28958 | The pre-defined function @code{gdb.default_visualizer} may be used to | |
28959 | select a visualizer by following the built-in process | |
28960 | (@pxref{Selecting Pretty-Printers}). This is done automatically when | |
28961 | a varobj is created, and so ordinarily is not needed. | |
28962 | ||
28963 | This feature is only available if Python support is enabled. The MI | |
28964 | command @code{-list-features} (@pxref{GDB/MI Miscellaneous Commands}) | |
28965 | can be used to check this. | |
28966 | ||
28967 | @subsubheading Example | |
28968 | ||
28969 | Resetting the visualizer: | |
28970 | ||
28971 | @smallexample | |
28972 | (gdb) | |
28973 | -var-set-visualizer V None | |
28974 | ^done | |
28975 | @end smallexample | |
28976 | ||
28977 | Reselecting the default (type-based) visualizer: | |
28978 | ||
28979 | @smallexample | |
28980 | (gdb) | |
28981 | -var-set-visualizer V gdb.default_visualizer | |
28982 | ^done | |
28983 | @end smallexample | |
28984 | ||
28985 | Suppose @code{SomeClass} is a visualizer class. A lambda expression | |
28986 | can be used to instantiate this class for a varobj: | |
28987 | ||
28988 | @smallexample | |
28989 | (gdb) | |
28990 | -var-set-visualizer V "lambda val: SomeClass()" | |
28991 | ^done | |
28992 | @end smallexample | |
25d5ea92 | 28993 | |
a2c02241 NR |
28994 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
28995 | @node GDB/MI Data Manipulation | |
28996 | @section @sc{gdb/mi} Data Manipulation | |
922fbb7b | 28997 | |
a2c02241 NR |
28998 | @cindex data manipulation, in @sc{gdb/mi} |
28999 | @cindex @sc{gdb/mi}, data manipulation | |
29000 | This section describes the @sc{gdb/mi} commands that manipulate data: | |
29001 | examine memory and registers, evaluate expressions, etc. | |
29002 | ||
29003 | @c REMOVED FROM THE INTERFACE. | |
29004 | @c @subheading -data-assign | |
29005 | @c Change the value of a program variable. Plenty of side effects. | |
79a6e687 | 29006 | @c @subsubheading GDB Command |
a2c02241 NR |
29007 | @c set variable |
29008 | @c @subsubheading Example | |
29009 | @c N.A. | |
29010 | ||
29011 | @subheading The @code{-data-disassemble} Command | |
29012 | @findex -data-disassemble | |
922fbb7b AC |
29013 | |
29014 | @subsubheading Synopsis | |
29015 | ||
29016 | @smallexample | |
a2c02241 NR |
29017 | -data-disassemble |
29018 | [ -s @var{start-addr} -e @var{end-addr} ] | |
29019 | | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ] | |
29020 | -- @var{mode} | |
922fbb7b AC |
29021 | @end smallexample |
29022 | ||
a2c02241 NR |
29023 | @noindent |
29024 | Where: | |
29025 | ||
29026 | @table @samp | |
29027 | @item @var{start-addr} | |
29028 | is the beginning address (or @code{$pc}) | |
29029 | @item @var{end-addr} | |
29030 | is the end address | |
29031 | @item @var{filename} | |
29032 | is the name of the file to disassemble | |
29033 | @item @var{linenum} | |
29034 | is the line number to disassemble around | |
29035 | @item @var{lines} | |
d3e8051b | 29036 | is the number of disassembly lines to be produced. If it is -1, |
a2c02241 NR |
29037 | the whole function will be disassembled, in case no @var{end-addr} is |
29038 | specified. If @var{end-addr} is specified as a non-zero value, and | |
29039 | @var{lines} is lower than the number of disassembly lines between | |
29040 | @var{start-addr} and @var{end-addr}, only @var{lines} lines are | |
29041 | displayed; if @var{lines} is higher than the number of lines between | |
29042 | @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr} | |
29043 | are displayed. | |
29044 | @item @var{mode} | |
b716877b AB |
29045 | is either 0 (meaning only disassembly), 1 (meaning mixed source and |
29046 | disassembly), 2 (meaning disassembly with raw opcodes), or 3 (meaning | |
29047 | mixed source and disassembly with raw opcodes). | |
a2c02241 NR |
29048 | @end table |
29049 | ||
29050 | @subsubheading Result | |
29051 | ||
29052 | The output for each instruction is composed of four fields: | |
29053 | ||
29054 | @itemize @bullet | |
29055 | @item Address | |
29056 | @item Func-name | |
29057 | @item Offset | |
29058 | @item Instruction | |
29059 | @end itemize | |
29060 | ||
29061 | Note that whatever included in the instruction field, is not manipulated | |
d3e8051b | 29062 | directly by @sc{gdb/mi}, i.e., it is not possible to adjust its format. |
922fbb7b AC |
29063 | |
29064 | @subsubheading @value{GDBN} Command | |
29065 | ||
a2c02241 | 29066 | There's no direct mapping from this command to the CLI. |
922fbb7b AC |
29067 | |
29068 | @subsubheading Example | |
29069 | ||
a2c02241 NR |
29070 | Disassemble from the current value of @code{$pc} to @code{$pc + 20}: |
29071 | ||
922fbb7b | 29072 | @smallexample |
594fe323 | 29073 | (gdb) |
a2c02241 NR |
29074 | -data-disassemble -s $pc -e "$pc + 20" -- 0 |
29075 | ^done, | |
29076 | asm_insns=[ | |
29077 | @{address="0x000107c0",func-name="main",offset="4", | |
29078 | inst="mov 2, %o0"@}, | |
29079 | @{address="0x000107c4",func-name="main",offset="8", | |
29080 | inst="sethi %hi(0x11800), %o2"@}, | |
29081 | @{address="0x000107c8",func-name="main",offset="12", | |
29082 | inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@}, | |
29083 | @{address="0x000107cc",func-name="main",offset="16", | |
29084 | inst="sethi %hi(0x11800), %o2"@}, | |
29085 | @{address="0x000107d0",func-name="main",offset="20", | |
29086 | inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}] | |
594fe323 | 29087 | (gdb) |
a2c02241 NR |
29088 | @end smallexample |
29089 | ||
29090 | Disassemble the whole @code{main} function. Line 32 is part of | |
29091 | @code{main}. | |
29092 | ||
29093 | @smallexample | |
29094 | -data-disassemble -f basics.c -l 32 -- 0 | |
29095 | ^done,asm_insns=[ | |
29096 | @{address="0x000107bc",func-name="main",offset="0", | |
29097 | inst="save %sp, -112, %sp"@}, | |
29098 | @{address="0x000107c0",func-name="main",offset="4", | |
29099 | inst="mov 2, %o0"@}, | |
29100 | @{address="0x000107c4",func-name="main",offset="8", | |
29101 | inst="sethi %hi(0x11800), %o2"@}, | |
29102 | [@dots{}] | |
29103 | @{address="0x0001081c",func-name="main",offset="96",inst="ret "@}, | |
29104 | @{address="0x00010820",func-name="main",offset="100",inst="restore "@}] | |
594fe323 | 29105 | (gdb) |
922fbb7b AC |
29106 | @end smallexample |
29107 | ||
a2c02241 | 29108 | Disassemble 3 instructions from the start of @code{main}: |
922fbb7b | 29109 | |
a2c02241 | 29110 | @smallexample |
594fe323 | 29111 | (gdb) |
a2c02241 NR |
29112 | -data-disassemble -f basics.c -l 32 -n 3 -- 0 |
29113 | ^done,asm_insns=[ | |
29114 | @{address="0x000107bc",func-name="main",offset="0", | |
29115 | inst="save %sp, -112, %sp"@}, | |
29116 | @{address="0x000107c0",func-name="main",offset="4", | |
29117 | inst="mov 2, %o0"@}, | |
29118 | @{address="0x000107c4",func-name="main",offset="8", | |
29119 | inst="sethi %hi(0x11800), %o2"@}] | |
594fe323 | 29120 | (gdb) |
a2c02241 NR |
29121 | @end smallexample |
29122 | ||
29123 | Disassemble 3 instructions from the start of @code{main} in mixed mode: | |
29124 | ||
29125 | @smallexample | |
594fe323 | 29126 | (gdb) |
a2c02241 NR |
29127 | -data-disassemble -f basics.c -l 32 -n 3 -- 1 |
29128 | ^done,asm_insns=[ | |
29129 | src_and_asm_line=@{line="31", | |
29130 | file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ | |
29131 | testsuite/gdb.mi/basics.c",line_asm_insn=[ | |
29132 | @{address="0x000107bc",func-name="main",offset="0", | |
29133 | inst="save %sp, -112, %sp"@}]@}, | |
29134 | src_and_asm_line=@{line="32", | |
29135 | file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ | |
29136 | testsuite/gdb.mi/basics.c",line_asm_insn=[ | |
29137 | @{address="0x000107c0",func-name="main",offset="4", | |
29138 | inst="mov 2, %o0"@}, | |
29139 | @{address="0x000107c4",func-name="main",offset="8", | |
29140 | inst="sethi %hi(0x11800), %o2"@}]@}] | |
594fe323 | 29141 | (gdb) |
a2c02241 NR |
29142 | @end smallexample |
29143 | ||
29144 | ||
29145 | @subheading The @code{-data-evaluate-expression} Command | |
29146 | @findex -data-evaluate-expression | |
922fbb7b AC |
29147 | |
29148 | @subsubheading Synopsis | |
29149 | ||
29150 | @smallexample | |
a2c02241 | 29151 | -data-evaluate-expression @var{expr} |
922fbb7b AC |
29152 | @end smallexample |
29153 | ||
a2c02241 NR |
29154 | Evaluate @var{expr} as an expression. The expression could contain an |
29155 | inferior function call. The function call will execute synchronously. | |
29156 | If the expression contains spaces, it must be enclosed in double quotes. | |
922fbb7b AC |
29157 | |
29158 | @subsubheading @value{GDBN} Command | |
29159 | ||
a2c02241 NR |
29160 | The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and |
29161 | @samp{call}. In @code{gdbtk} only, there's a corresponding | |
29162 | @samp{gdb_eval} command. | |
922fbb7b AC |
29163 | |
29164 | @subsubheading Example | |
29165 | ||
a2c02241 NR |
29166 | In the following example, the numbers that precede the commands are the |
29167 | @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi} | |
29168 | Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its | |
29169 | output. | |
29170 | ||
922fbb7b | 29171 | @smallexample |
a2c02241 NR |
29172 | 211-data-evaluate-expression A |
29173 | 211^done,value="1" | |
594fe323 | 29174 | (gdb) |
a2c02241 NR |
29175 | 311-data-evaluate-expression &A |
29176 | 311^done,value="0xefffeb7c" | |
594fe323 | 29177 | (gdb) |
a2c02241 NR |
29178 | 411-data-evaluate-expression A+3 |
29179 | 411^done,value="4" | |
594fe323 | 29180 | (gdb) |
a2c02241 NR |
29181 | 511-data-evaluate-expression "A + 3" |
29182 | 511^done,value="4" | |
594fe323 | 29183 | (gdb) |
a2c02241 | 29184 | @end smallexample |
922fbb7b AC |
29185 | |
29186 | ||
a2c02241 NR |
29187 | @subheading The @code{-data-list-changed-registers} Command |
29188 | @findex -data-list-changed-registers | |
922fbb7b AC |
29189 | |
29190 | @subsubheading Synopsis | |
29191 | ||
29192 | @smallexample | |
a2c02241 | 29193 | -data-list-changed-registers |
922fbb7b AC |
29194 | @end smallexample |
29195 | ||
a2c02241 | 29196 | Display a list of the registers that have changed. |
922fbb7b AC |
29197 | |
29198 | @subsubheading @value{GDBN} Command | |
29199 | ||
a2c02241 NR |
29200 | @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk} |
29201 | has the corresponding command @samp{gdb_changed_register_list}. | |
922fbb7b AC |
29202 | |
29203 | @subsubheading Example | |
922fbb7b | 29204 | |
a2c02241 | 29205 | On a PPC MBX board: |
922fbb7b AC |
29206 | |
29207 | @smallexample | |
594fe323 | 29208 | (gdb) |
a2c02241 NR |
29209 | -exec-continue |
29210 | ^running | |
922fbb7b | 29211 | |
594fe323 | 29212 | (gdb) |
a47ec5fe AR |
29213 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{ |
29214 | func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c", | |
29215 | line="5"@} | |
594fe323 | 29216 | (gdb) |
a2c02241 NR |
29217 | -data-list-changed-registers |
29218 | ^done,changed-registers=["0","1","2","4","5","6","7","8","9", | |
29219 | "10","11","13","14","15","16","17","18","19","20","21","22","23", | |
29220 | "24","25","26","27","28","30","31","64","65","66","67","69"] | |
594fe323 | 29221 | (gdb) |
a2c02241 | 29222 | @end smallexample |
922fbb7b AC |
29223 | |
29224 | ||
a2c02241 NR |
29225 | @subheading The @code{-data-list-register-names} Command |
29226 | @findex -data-list-register-names | |
922fbb7b AC |
29227 | |
29228 | @subsubheading Synopsis | |
29229 | ||
29230 | @smallexample | |
a2c02241 | 29231 | -data-list-register-names [ ( @var{regno} )+ ] |
922fbb7b AC |
29232 | @end smallexample |
29233 | ||
a2c02241 NR |
29234 | Show a list of register names for the current target. If no arguments |
29235 | are given, it shows a list of the names of all the registers. If | |
29236 | integer numbers are given as arguments, it will print a list of the | |
29237 | names of the registers corresponding to the arguments. To ensure | |
29238 | consistency between a register name and its number, the output list may | |
29239 | include empty register names. | |
922fbb7b AC |
29240 | |
29241 | @subsubheading @value{GDBN} Command | |
29242 | ||
a2c02241 NR |
29243 | @value{GDBN} does not have a command which corresponds to |
29244 | @samp{-data-list-register-names}. In @code{gdbtk} there is a | |
29245 | corresponding command @samp{gdb_regnames}. | |
922fbb7b AC |
29246 | |
29247 | @subsubheading Example | |
922fbb7b | 29248 | |
a2c02241 NR |
29249 | For the PPC MBX board: |
29250 | @smallexample | |
594fe323 | 29251 | (gdb) |
a2c02241 NR |
29252 | -data-list-register-names |
29253 | ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7", | |
29254 | "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18", | |
29255 | "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29", | |
29256 | "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9", | |
29257 | "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20", | |
29258 | "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31", | |
29259 | "", "pc","ps","cr","lr","ctr","xer"] | |
594fe323 | 29260 | (gdb) |
a2c02241 NR |
29261 | -data-list-register-names 1 2 3 |
29262 | ^done,register-names=["r1","r2","r3"] | |
594fe323 | 29263 | (gdb) |
a2c02241 | 29264 | @end smallexample |
922fbb7b | 29265 | |
a2c02241 NR |
29266 | @subheading The @code{-data-list-register-values} Command |
29267 | @findex -data-list-register-values | |
922fbb7b AC |
29268 | |
29269 | @subsubheading Synopsis | |
29270 | ||
29271 | @smallexample | |
a2c02241 | 29272 | -data-list-register-values @var{fmt} [ ( @var{regno} )*] |
922fbb7b AC |
29273 | @end smallexample |
29274 | ||
a2c02241 NR |
29275 | Display the registers' contents. @var{fmt} is the format according to |
29276 | which the registers' contents are to be returned, followed by an optional | |
29277 | list of numbers specifying the registers to display. A missing list of | |
29278 | numbers indicates that the contents of all the registers must be returned. | |
29279 | ||
29280 | Allowed formats for @var{fmt} are: | |
29281 | ||
29282 | @table @code | |
29283 | @item x | |
29284 | Hexadecimal | |
29285 | @item o | |
29286 | Octal | |
29287 | @item t | |
29288 | Binary | |
29289 | @item d | |
29290 | Decimal | |
29291 | @item r | |
29292 | Raw | |
29293 | @item N | |
29294 | Natural | |
29295 | @end table | |
922fbb7b AC |
29296 | |
29297 | @subsubheading @value{GDBN} Command | |
29298 | ||
a2c02241 NR |
29299 | The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info |
29300 | all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}. | |
922fbb7b AC |
29301 | |
29302 | @subsubheading Example | |
922fbb7b | 29303 | |
a2c02241 NR |
29304 | For a PPC MBX board (note: line breaks are for readability only, they |
29305 | don't appear in the actual output): | |
29306 | ||
29307 | @smallexample | |
594fe323 | 29308 | (gdb) |
a2c02241 NR |
29309 | -data-list-register-values r 64 65 |
29310 | ^done,register-values=[@{number="64",value="0xfe00a300"@}, | |
29311 | @{number="65",value="0x00029002"@}] | |
594fe323 | 29312 | (gdb) |
a2c02241 NR |
29313 | -data-list-register-values x |
29314 | ^done,register-values=[@{number="0",value="0xfe0043c8"@}, | |
29315 | @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@}, | |
29316 | @{number="3",value="0x0"@},@{number="4",value="0xa"@}, | |
29317 | @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@}, | |
29318 | @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@}, | |
29319 | @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@}, | |
29320 | @{number="11",value="0x1"@},@{number="12",value="0x0"@}, | |
29321 | @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@}, | |
29322 | @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@}, | |
29323 | @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@}, | |
29324 | @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@}, | |
29325 | @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@}, | |
29326 | @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@}, | |
29327 | @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@}, | |
29328 | @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@}, | |
29329 | @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@}, | |
29330 | @{number="31",value="0x0"@},@{number="32",value="0x0"@}, | |
29331 | @{number="33",value="0x0"@},@{number="34",value="0x0"@}, | |
29332 | @{number="35",value="0x0"@},@{number="36",value="0x0"@}, | |
29333 | @{number="37",value="0x0"@},@{number="38",value="0x0"@}, | |
29334 | @{number="39",value="0x0"@},@{number="40",value="0x0"@}, | |
29335 | @{number="41",value="0x0"@},@{number="42",value="0x0"@}, | |
29336 | @{number="43",value="0x0"@},@{number="44",value="0x0"@}, | |
29337 | @{number="45",value="0x0"@},@{number="46",value="0x0"@}, | |
29338 | @{number="47",value="0x0"@},@{number="48",value="0x0"@}, | |
29339 | @{number="49",value="0x0"@},@{number="50",value="0x0"@}, | |
29340 | @{number="51",value="0x0"@},@{number="52",value="0x0"@}, | |
29341 | @{number="53",value="0x0"@},@{number="54",value="0x0"@}, | |
29342 | @{number="55",value="0x0"@},@{number="56",value="0x0"@}, | |
29343 | @{number="57",value="0x0"@},@{number="58",value="0x0"@}, | |
29344 | @{number="59",value="0x0"@},@{number="60",value="0x0"@}, | |
29345 | @{number="61",value="0x0"@},@{number="62",value="0x0"@}, | |
29346 | @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@}, | |
29347 | @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@}, | |
29348 | @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@}, | |
29349 | @{number="69",value="0x20002b03"@}] | |
594fe323 | 29350 | (gdb) |
a2c02241 | 29351 | @end smallexample |
922fbb7b | 29352 | |
a2c02241 NR |
29353 | |
29354 | @subheading The @code{-data-read-memory} Command | |
29355 | @findex -data-read-memory | |
922fbb7b | 29356 | |
8dedea02 VP |
29357 | This command is deprecated, use @code{-data-read-memory-bytes} instead. |
29358 | ||
922fbb7b AC |
29359 | @subsubheading Synopsis |
29360 | ||
29361 | @smallexample | |
a2c02241 NR |
29362 | -data-read-memory [ -o @var{byte-offset} ] |
29363 | @var{address} @var{word-format} @var{word-size} | |
29364 | @var{nr-rows} @var{nr-cols} [ @var{aschar} ] | |
922fbb7b AC |
29365 | @end smallexample |
29366 | ||
a2c02241 NR |
29367 | @noindent |
29368 | where: | |
922fbb7b | 29369 | |
a2c02241 NR |
29370 | @table @samp |
29371 | @item @var{address} | |
29372 | An expression specifying the address of the first memory word to be | |
29373 | read. Complex expressions containing embedded white space should be | |
29374 | quoted using the C convention. | |
922fbb7b | 29375 | |
a2c02241 NR |
29376 | @item @var{word-format} |
29377 | The format to be used to print the memory words. The notation is the | |
29378 | same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats, | |
79a6e687 | 29379 | ,Output Formats}). |
922fbb7b | 29380 | |
a2c02241 NR |
29381 | @item @var{word-size} |
29382 | The size of each memory word in bytes. | |
922fbb7b | 29383 | |
a2c02241 NR |
29384 | @item @var{nr-rows} |
29385 | The number of rows in the output table. | |
922fbb7b | 29386 | |
a2c02241 NR |
29387 | @item @var{nr-cols} |
29388 | The number of columns in the output table. | |
922fbb7b | 29389 | |
a2c02241 NR |
29390 | @item @var{aschar} |
29391 | If present, indicates that each row should include an @sc{ascii} dump. The | |
29392 | value of @var{aschar} is used as a padding character when a byte is not a | |
29393 | member of the printable @sc{ascii} character set (printable @sc{ascii} | |
29394 | characters are those whose code is between 32 and 126, inclusively). | |
922fbb7b | 29395 | |
a2c02241 NR |
29396 | @item @var{byte-offset} |
29397 | An offset to add to the @var{address} before fetching memory. | |
29398 | @end table | |
922fbb7b | 29399 | |
a2c02241 NR |
29400 | This command displays memory contents as a table of @var{nr-rows} by |
29401 | @var{nr-cols} words, each word being @var{word-size} bytes. In total, | |
29402 | @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read | |
29403 | (returned as @samp{total-bytes}). Should less than the requested number | |
29404 | of bytes be returned by the target, the missing words are identified | |
29405 | using @samp{N/A}. The number of bytes read from the target is returned | |
29406 | in @samp{nr-bytes} and the starting address used to read memory in | |
29407 | @samp{addr}. | |
29408 | ||
29409 | The address of the next/previous row or page is available in | |
29410 | @samp{next-row} and @samp{prev-row}, @samp{next-page} and | |
29411 | @samp{prev-page}. | |
922fbb7b AC |
29412 | |
29413 | @subsubheading @value{GDBN} Command | |
29414 | ||
a2c02241 NR |
29415 | The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has |
29416 | @samp{gdb_get_mem} memory read command. | |
922fbb7b AC |
29417 | |
29418 | @subsubheading Example | |
32e7087d | 29419 | |
a2c02241 NR |
29420 | Read six bytes of memory starting at @code{bytes+6} but then offset by |
29421 | @code{-6} bytes. Format as three rows of two columns. One byte per | |
29422 | word. Display each word in hex. | |
32e7087d JB |
29423 | |
29424 | @smallexample | |
594fe323 | 29425 | (gdb) |
a2c02241 NR |
29426 | 9-data-read-memory -o -6 -- bytes+6 x 1 3 2 |
29427 | 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6", | |
29428 | next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396", | |
29429 | prev-page="0x0000138a",memory=[ | |
29430 | @{addr="0x00001390",data=["0x00","0x01"]@}, | |
29431 | @{addr="0x00001392",data=["0x02","0x03"]@}, | |
29432 | @{addr="0x00001394",data=["0x04","0x05"]@}] | |
594fe323 | 29433 | (gdb) |
32e7087d JB |
29434 | @end smallexample |
29435 | ||
a2c02241 NR |
29436 | Read two bytes of memory starting at address @code{shorts + 64} and |
29437 | display as a single word formatted in decimal. | |
32e7087d | 29438 | |
32e7087d | 29439 | @smallexample |
594fe323 | 29440 | (gdb) |
a2c02241 NR |
29441 | 5-data-read-memory shorts+64 d 2 1 1 |
29442 | 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2", | |
29443 | next-row="0x00001512",prev-row="0x0000150e", | |
29444 | next-page="0x00001512",prev-page="0x0000150e",memory=[ | |
29445 | @{addr="0x00001510",data=["128"]@}] | |
594fe323 | 29446 | (gdb) |
32e7087d JB |
29447 | @end smallexample |
29448 | ||
a2c02241 NR |
29449 | Read thirty two bytes of memory starting at @code{bytes+16} and format |
29450 | as eight rows of four columns. Include a string encoding with @samp{x} | |
29451 | used as the non-printable character. | |
922fbb7b AC |
29452 | |
29453 | @smallexample | |
594fe323 | 29454 | (gdb) |
a2c02241 NR |
29455 | 4-data-read-memory bytes+16 x 1 8 4 x |
29456 | 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32", | |
29457 | next-row="0x000013c0",prev-row="0x0000139c", | |
29458 | next-page="0x000013c0",prev-page="0x00001380",memory=[ | |
29459 | @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@}, | |
29460 | @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@}, | |
29461 | @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@}, | |
29462 | @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@}, | |
29463 | @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@}, | |
29464 | @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@}, | |
29465 | @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@}, | |
29466 | @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}] | |
594fe323 | 29467 | (gdb) |
922fbb7b AC |
29468 | @end smallexample |
29469 | ||
8dedea02 VP |
29470 | @subheading The @code{-data-read-memory-bytes} Command |
29471 | @findex -data-read-memory-bytes | |
29472 | ||
29473 | @subsubheading Synopsis | |
29474 | ||
29475 | @smallexample | |
29476 | -data-read-memory-bytes [ -o @var{byte-offset} ] | |
29477 | @var{address} @var{count} | |
29478 | @end smallexample | |
29479 | ||
29480 | @noindent | |
29481 | where: | |
29482 | ||
29483 | @table @samp | |
29484 | @item @var{address} | |
29485 | An expression specifying the address of the first memory word to be | |
29486 | read. Complex expressions containing embedded white space should be | |
29487 | quoted using the C convention. | |
29488 | ||
29489 | @item @var{count} | |
29490 | The number of bytes to read. This should be an integer literal. | |
29491 | ||
29492 | @item @var{byte-offset} | |
29493 | The offsets in bytes relative to @var{address} at which to start | |
29494 | reading. This should be an integer literal. This option is provided | |
29495 | so that a frontend is not required to first evaluate address and then | |
29496 | perform address arithmetics itself. | |
29497 | ||
29498 | @end table | |
29499 | ||
29500 | This command attempts to read all accessible memory regions in the | |
29501 | specified range. First, all regions marked as unreadable in the memory | |
29502 | map (if one is defined) will be skipped. @xref{Memory Region | |
29503 | Attributes}. Second, @value{GDBN} will attempt to read the remaining | |
29504 | regions. For each one, if reading full region results in an errors, | |
29505 | @value{GDBN} will try to read a subset of the region. | |
29506 | ||
29507 | In general, every single byte in the region may be readable or not, | |
29508 | and the only way to read every readable byte is to try a read at | |
29509 | every address, which is not practical. Therefore, @value{GDBN} will | |
29510 | attempt to read all accessible bytes at either beginning or the end | |
29511 | of the region, using a binary division scheme. This heuristic works | |
29512 | well for reading accross a memory map boundary. Note that if a region | |
29513 | has a readable range that is neither at the beginning or the end, | |
29514 | @value{GDBN} will not read it. | |
29515 | ||
29516 | The result record (@pxref{GDB/MI Result Records}) that is output of | |
29517 | the command includes a field named @samp{memory} whose content is a | |
29518 | list of tuples. Each tuple represent a successfully read memory block | |
29519 | and has the following fields: | |
29520 | ||
29521 | @table @code | |
29522 | @item begin | |
29523 | The start address of the memory block, as hexadecimal literal. | |
29524 | ||
29525 | @item end | |
29526 | The end address of the memory block, as hexadecimal literal. | |
29527 | ||
29528 | @item offset | |
29529 | The offset of the memory block, as hexadecimal literal, relative to | |
29530 | the start address passed to @code{-data-read-memory-bytes}. | |
29531 | ||
29532 | @item contents | |
29533 | The contents of the memory block, in hex. | |
29534 | ||
29535 | @end table | |
29536 | ||
29537 | ||
29538 | ||
29539 | @subsubheading @value{GDBN} Command | |
29540 | ||
29541 | The corresponding @value{GDBN} command is @samp{x}. | |
29542 | ||
29543 | @subsubheading Example | |
29544 | ||
29545 | @smallexample | |
29546 | (gdb) | |
29547 | -data-read-memory-bytes &a 10 | |
29548 | ^done,memory=[@{begin="0xbffff154",offset="0x00000000", | |
29549 | end="0xbffff15e", | |
29550 | contents="01000000020000000300"@}] | |
29551 | (gdb) | |
29552 | @end smallexample | |
29553 | ||
29554 | ||
29555 | @subheading The @code{-data-write-memory-bytes} Command | |
29556 | @findex -data-write-memory-bytes | |
29557 | ||
29558 | @subsubheading Synopsis | |
29559 | ||
29560 | @smallexample | |
29561 | -data-write-memory-bytes @var{address} @var{contents} | |
29562 | @end smallexample | |
29563 | ||
29564 | @noindent | |
29565 | where: | |
29566 | ||
29567 | @table @samp | |
29568 | @item @var{address} | |
29569 | An expression specifying the address of the first memory word to be | |
29570 | read. Complex expressions containing embedded white space should be | |
29571 | quoted using the C convention. | |
29572 | ||
29573 | @item @var{contents} | |
29574 | The hex-encoded bytes to write. | |
29575 | ||
29576 | @end table | |
29577 | ||
29578 | @subsubheading @value{GDBN} Command | |
29579 | ||
29580 | There's no corresponding @value{GDBN} command. | |
29581 | ||
29582 | @subsubheading Example | |
29583 | ||
29584 | @smallexample | |
29585 | (gdb) | |
29586 | -data-write-memory-bytes &a "aabbccdd" | |
29587 | ^done | |
29588 | (gdb) | |
29589 | @end smallexample | |
29590 | ||
29591 | ||
a2c02241 NR |
29592 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29593 | @node GDB/MI Tracepoint Commands | |
29594 | @section @sc{gdb/mi} Tracepoint Commands | |
922fbb7b | 29595 | |
18148017 VP |
29596 | The commands defined in this section implement MI support for |
29597 | tracepoints. For detailed introduction, see @ref{Tracepoints}. | |
29598 | ||
29599 | @subheading The @code{-trace-find} Command | |
29600 | @findex -trace-find | |
29601 | ||
29602 | @subsubheading Synopsis | |
29603 | ||
29604 | @smallexample | |
29605 | -trace-find @var{mode} [@var{parameters}@dots{}] | |
29606 | @end smallexample | |
29607 | ||
29608 | Find a trace frame using criteria defined by @var{mode} and | |
29609 | @var{parameters}. The following table lists permissible | |
29610 | modes and their parameters. For details of operation, see @ref{tfind}. | |
29611 | ||
29612 | @table @samp | |
29613 | ||
29614 | @item none | |
29615 | No parameters are required. Stops examining trace frames. | |
29616 | ||
29617 | @item frame-number | |
29618 | An integer is required as parameter. Selects tracepoint frame with | |
29619 | that index. | |
29620 | ||
29621 | @item tracepoint-number | |
29622 | An integer is required as parameter. Finds next | |
29623 | trace frame that corresponds to tracepoint with the specified number. | |
29624 | ||
29625 | @item pc | |
29626 | An address is required as parameter. Finds | |
29627 | next trace frame that corresponds to any tracepoint at the specified | |
29628 | address. | |
29629 | ||
29630 | @item pc-inside-range | |
29631 | Two addresses are required as parameters. Finds next trace | |
29632 | frame that corresponds to a tracepoint at an address inside the | |
29633 | specified range. Both bounds are considered to be inside the range. | |
29634 | ||
29635 | @item pc-outside-range | |
29636 | Two addresses are required as parameters. Finds | |
29637 | next trace frame that corresponds to a tracepoint at an address outside | |
29638 | the specified range. Both bounds are considered to be inside the range. | |
29639 | ||
29640 | @item line | |
29641 | Line specification is required as parameter. @xref{Specify Location}. | |
29642 | Finds next trace frame that corresponds to a tracepoint at | |
29643 | the specified location. | |
29644 | ||
29645 | @end table | |
29646 | ||
29647 | If @samp{none} was passed as @var{mode}, the response does not | |
29648 | have fields. Otherwise, the response may have the following fields: | |
29649 | ||
29650 | @table @samp | |
29651 | @item found | |
29652 | This field has either @samp{0} or @samp{1} as the value, depending | |
29653 | on whether a matching tracepoint was found. | |
29654 | ||
29655 | @item traceframe | |
29656 | The index of the found traceframe. This field is present iff | |
29657 | the @samp{found} field has value of @samp{1}. | |
29658 | ||
29659 | @item tracepoint | |
29660 | The index of the found tracepoint. This field is present iff | |
29661 | the @samp{found} field has value of @samp{1}. | |
29662 | ||
29663 | @item frame | |
29664 | The information about the frame corresponding to the found trace | |
29665 | frame. This field is present only if a trace frame was found. | |
cd64ee31 | 29666 | @xref{GDB/MI Frame Information}, for description of this field. |
18148017 VP |
29667 | |
29668 | @end table | |
29669 | ||
7d13fe92 SS |
29670 | @subsubheading @value{GDBN} Command |
29671 | ||
29672 | The corresponding @value{GDBN} command is @samp{tfind}. | |
29673 | ||
18148017 VP |
29674 | @subheading -trace-define-variable |
29675 | @findex -trace-define-variable | |
29676 | ||
29677 | @subsubheading Synopsis | |
29678 | ||
29679 | @smallexample | |
29680 | -trace-define-variable @var{name} [ @var{value} ] | |
29681 | @end smallexample | |
29682 | ||
29683 | Create trace variable @var{name} if it does not exist. If | |
29684 | @var{value} is specified, sets the initial value of the specified | |
29685 | trace variable to that value. Note that the @var{name} should start | |
29686 | with the @samp{$} character. | |
29687 | ||
7d13fe92 SS |
29688 | @subsubheading @value{GDBN} Command |
29689 | ||
29690 | The corresponding @value{GDBN} command is @samp{tvariable}. | |
29691 | ||
18148017 VP |
29692 | @subheading -trace-list-variables |
29693 | @findex -trace-list-variables | |
922fbb7b | 29694 | |
18148017 | 29695 | @subsubheading Synopsis |
922fbb7b | 29696 | |
18148017 VP |
29697 | @smallexample |
29698 | -trace-list-variables | |
29699 | @end smallexample | |
922fbb7b | 29700 | |
18148017 VP |
29701 | Return a table of all defined trace variables. Each element of the |
29702 | table has the following fields: | |
922fbb7b | 29703 | |
18148017 VP |
29704 | @table @samp |
29705 | @item name | |
29706 | The name of the trace variable. This field is always present. | |
922fbb7b | 29707 | |
18148017 VP |
29708 | @item initial |
29709 | The initial value. This is a 64-bit signed integer. This | |
29710 | field is always present. | |
922fbb7b | 29711 | |
18148017 VP |
29712 | @item current |
29713 | The value the trace variable has at the moment. This is a 64-bit | |
29714 | signed integer. This field is absent iff current value is | |
29715 | not defined, for example if the trace was never run, or is | |
29716 | presently running. | |
922fbb7b | 29717 | |
18148017 | 29718 | @end table |
922fbb7b | 29719 | |
7d13fe92 SS |
29720 | @subsubheading @value{GDBN} Command |
29721 | ||
29722 | The corresponding @value{GDBN} command is @samp{tvariables}. | |
29723 | ||
18148017 | 29724 | @subsubheading Example |
922fbb7b | 29725 | |
18148017 VP |
29726 | @smallexample |
29727 | (gdb) | |
29728 | -trace-list-variables | |
29729 | ^done,trace-variables=@{nr_rows="1",nr_cols="3", | |
29730 | hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@}, | |
29731 | @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@}, | |
29732 | @{width="11",alignment="-1",col_name="current",colhdr="Current"@}], | |
29733 | body=[variable=@{name="$trace_timestamp",initial="0"@} | |
29734 | variable=@{name="$foo",initial="10",current="15"@}]@} | |
29735 | (gdb) | |
29736 | @end smallexample | |
922fbb7b | 29737 | |
18148017 VP |
29738 | @subheading -trace-save |
29739 | @findex -trace-save | |
922fbb7b | 29740 | |
18148017 VP |
29741 | @subsubheading Synopsis |
29742 | ||
29743 | @smallexample | |
29744 | -trace-save [-r ] @var{filename} | |
29745 | @end smallexample | |
29746 | ||
29747 | Saves the collected trace data to @var{filename}. Without the | |
29748 | @samp{-r} option, the data is downloaded from the target and saved | |
29749 | in a local file. With the @samp{-r} option the target is asked | |
29750 | to perform the save. | |
29751 | ||
7d13fe92 SS |
29752 | @subsubheading @value{GDBN} Command |
29753 | ||
29754 | The corresponding @value{GDBN} command is @samp{tsave}. | |
29755 | ||
18148017 VP |
29756 | |
29757 | @subheading -trace-start | |
29758 | @findex -trace-start | |
29759 | ||
29760 | @subsubheading Synopsis | |
29761 | ||
29762 | @smallexample | |
29763 | -trace-start | |
29764 | @end smallexample | |
922fbb7b | 29765 | |
18148017 VP |
29766 | Starts a tracing experiments. The result of this command does not |
29767 | have any fields. | |
922fbb7b | 29768 | |
7d13fe92 SS |
29769 | @subsubheading @value{GDBN} Command |
29770 | ||
29771 | The corresponding @value{GDBN} command is @samp{tstart}. | |
29772 | ||
18148017 VP |
29773 | @subheading -trace-status |
29774 | @findex -trace-status | |
922fbb7b | 29775 | |
18148017 VP |
29776 | @subsubheading Synopsis |
29777 | ||
29778 | @smallexample | |
29779 | -trace-status | |
29780 | @end smallexample | |
29781 | ||
a97153c7 | 29782 | Obtains the status of a tracing experiment. The result may include |
18148017 VP |
29783 | the following fields: |
29784 | ||
29785 | @table @samp | |
29786 | ||
29787 | @item supported | |
29788 | May have a value of either @samp{0}, when no tracing operations are | |
29789 | supported, @samp{1}, when all tracing operations are supported, or | |
29790 | @samp{file} when examining trace file. In the latter case, examining | |
29791 | of trace frame is possible but new tracing experiement cannot be | |
29792 | started. This field is always present. | |
29793 | ||
29794 | @item running | |
29795 | May have a value of either @samp{0} or @samp{1} depending on whether | |
29796 | tracing experiement is in progress on target. This field is present | |
29797 | if @samp{supported} field is not @samp{0}. | |
29798 | ||
29799 | @item stop-reason | |
29800 | Report the reason why the tracing was stopped last time. This field | |
29801 | may be absent iff tracing was never stopped on target yet. The | |
29802 | value of @samp{request} means the tracing was stopped as result of | |
29803 | the @code{-trace-stop} command. The value of @samp{overflow} means | |
29804 | the tracing buffer is full. The value of @samp{disconnection} means | |
29805 | tracing was automatically stopped when @value{GDBN} has disconnected. | |
29806 | The value of @samp{passcount} means tracing was stopped when a | |
29807 | tracepoint was passed a maximal number of times for that tracepoint. | |
29808 | This field is present if @samp{supported} field is not @samp{0}. | |
29809 | ||
29810 | @item stopping-tracepoint | |
29811 | The number of tracepoint whose passcount as exceeded. This field is | |
29812 | present iff the @samp{stop-reason} field has the value of | |
29813 | @samp{passcount}. | |
29814 | ||
29815 | @item frames | |
87290684 SS |
29816 | @itemx frames-created |
29817 | The @samp{frames} field is a count of the total number of trace frames | |
29818 | in the trace buffer, while @samp{frames-created} is the total created | |
29819 | during the run, including ones that were discarded, such as when a | |
29820 | circular trace buffer filled up. Both fields are optional. | |
18148017 VP |
29821 | |
29822 | @item buffer-size | |
29823 | @itemx buffer-free | |
29824 | These fields tell the current size of the tracing buffer and the | |
87290684 | 29825 | remaining space. These fields are optional. |
18148017 | 29826 | |
a97153c7 PA |
29827 | @item circular |
29828 | The value of the circular trace buffer flag. @code{1} means that the | |
29829 | trace buffer is circular and old trace frames will be discarded if | |
29830 | necessary to make room, @code{0} means that the trace buffer is linear | |
29831 | and may fill up. | |
29832 | ||
29833 | @item disconnected | |
29834 | The value of the disconnected tracing flag. @code{1} means that | |
29835 | tracing will continue after @value{GDBN} disconnects, @code{0} means | |
29836 | that the trace run will stop. | |
29837 | ||
18148017 VP |
29838 | @end table |
29839 | ||
7d13fe92 SS |
29840 | @subsubheading @value{GDBN} Command |
29841 | ||
29842 | The corresponding @value{GDBN} command is @samp{tstatus}. | |
29843 | ||
18148017 VP |
29844 | @subheading -trace-stop |
29845 | @findex -trace-stop | |
29846 | ||
29847 | @subsubheading Synopsis | |
29848 | ||
29849 | @smallexample | |
29850 | -trace-stop | |
29851 | @end smallexample | |
922fbb7b | 29852 | |
18148017 VP |
29853 | Stops a tracing experiment. The result of this command has the same |
29854 | fields as @code{-trace-status}, except that the @samp{supported} and | |
29855 | @samp{running} fields are not output. | |
922fbb7b | 29856 | |
7d13fe92 SS |
29857 | @subsubheading @value{GDBN} Command |
29858 | ||
29859 | The corresponding @value{GDBN} command is @samp{tstop}. | |
29860 | ||
922fbb7b | 29861 | |
a2c02241 NR |
29862 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
29863 | @node GDB/MI Symbol Query | |
29864 | @section @sc{gdb/mi} Symbol Query Commands | |
922fbb7b AC |
29865 | |
29866 | ||
9901a55b | 29867 | @ignore |
a2c02241 NR |
29868 | @subheading The @code{-symbol-info-address} Command |
29869 | @findex -symbol-info-address | |
922fbb7b AC |
29870 | |
29871 | @subsubheading Synopsis | |
29872 | ||
29873 | @smallexample | |
a2c02241 | 29874 | -symbol-info-address @var{symbol} |
922fbb7b AC |
29875 | @end smallexample |
29876 | ||
a2c02241 | 29877 | Describe where @var{symbol} is stored. |
922fbb7b AC |
29878 | |
29879 | @subsubheading @value{GDBN} Command | |
29880 | ||
a2c02241 | 29881 | The corresponding @value{GDBN} command is @samp{info address}. |
922fbb7b AC |
29882 | |
29883 | @subsubheading Example | |
29884 | N.A. | |
29885 | ||
29886 | ||
a2c02241 NR |
29887 | @subheading The @code{-symbol-info-file} Command |
29888 | @findex -symbol-info-file | |
922fbb7b AC |
29889 | |
29890 | @subsubheading Synopsis | |
29891 | ||
29892 | @smallexample | |
a2c02241 | 29893 | -symbol-info-file |
922fbb7b AC |
29894 | @end smallexample |
29895 | ||
a2c02241 | 29896 | Show the file for the symbol. |
922fbb7b | 29897 | |
a2c02241 | 29898 | @subsubheading @value{GDBN} Command |
922fbb7b | 29899 | |
a2c02241 NR |
29900 | There's no equivalent @value{GDBN} command. @code{gdbtk} has |
29901 | @samp{gdb_find_file}. | |
922fbb7b AC |
29902 | |
29903 | @subsubheading Example | |
29904 | N.A. | |
29905 | ||
29906 | ||
a2c02241 NR |
29907 | @subheading The @code{-symbol-info-function} Command |
29908 | @findex -symbol-info-function | |
922fbb7b AC |
29909 | |
29910 | @subsubheading Synopsis | |
29911 | ||
29912 | @smallexample | |
a2c02241 | 29913 | -symbol-info-function |
922fbb7b AC |
29914 | @end smallexample |
29915 | ||
a2c02241 | 29916 | Show which function the symbol lives in. |
922fbb7b AC |
29917 | |
29918 | @subsubheading @value{GDBN} Command | |
29919 | ||
a2c02241 | 29920 | @samp{gdb_get_function} in @code{gdbtk}. |
922fbb7b AC |
29921 | |
29922 | @subsubheading Example | |
29923 | N.A. | |
29924 | ||
29925 | ||
a2c02241 NR |
29926 | @subheading The @code{-symbol-info-line} Command |
29927 | @findex -symbol-info-line | |
922fbb7b AC |
29928 | |
29929 | @subsubheading Synopsis | |
29930 | ||
29931 | @smallexample | |
a2c02241 | 29932 | -symbol-info-line |
922fbb7b AC |
29933 | @end smallexample |
29934 | ||
a2c02241 | 29935 | Show the core addresses of the code for a source line. |
922fbb7b | 29936 | |
a2c02241 | 29937 | @subsubheading @value{GDBN} Command |
922fbb7b | 29938 | |
a2c02241 NR |
29939 | The corresponding @value{GDBN} command is @samp{info line}. |
29940 | @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands. | |
922fbb7b AC |
29941 | |
29942 | @subsubheading Example | |
a2c02241 | 29943 | N.A. |
922fbb7b AC |
29944 | |
29945 | ||
a2c02241 NR |
29946 | @subheading The @code{-symbol-info-symbol} Command |
29947 | @findex -symbol-info-symbol | |
07f31aa6 DJ |
29948 | |
29949 | @subsubheading Synopsis | |
29950 | ||
a2c02241 NR |
29951 | @smallexample |
29952 | -symbol-info-symbol @var{addr} | |
29953 | @end smallexample | |
07f31aa6 | 29954 | |
a2c02241 | 29955 | Describe what symbol is at location @var{addr}. |
07f31aa6 | 29956 | |
a2c02241 | 29957 | @subsubheading @value{GDBN} Command |
07f31aa6 | 29958 | |
a2c02241 | 29959 | The corresponding @value{GDBN} command is @samp{info symbol}. |
07f31aa6 DJ |
29960 | |
29961 | @subsubheading Example | |
a2c02241 | 29962 | N.A. |
07f31aa6 DJ |
29963 | |
29964 | ||
a2c02241 NR |
29965 | @subheading The @code{-symbol-list-functions} Command |
29966 | @findex -symbol-list-functions | |
922fbb7b AC |
29967 | |
29968 | @subsubheading Synopsis | |
29969 | ||
29970 | @smallexample | |
a2c02241 | 29971 | -symbol-list-functions |
922fbb7b AC |
29972 | @end smallexample |
29973 | ||
a2c02241 | 29974 | List the functions in the executable. |
922fbb7b AC |
29975 | |
29976 | @subsubheading @value{GDBN} Command | |
29977 | ||
a2c02241 NR |
29978 | @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and |
29979 | @samp{gdb_search} in @code{gdbtk}. | |
922fbb7b AC |
29980 | |
29981 | @subsubheading Example | |
a2c02241 | 29982 | N.A. |
9901a55b | 29983 | @end ignore |
922fbb7b AC |
29984 | |
29985 | ||
a2c02241 NR |
29986 | @subheading The @code{-symbol-list-lines} Command |
29987 | @findex -symbol-list-lines | |
922fbb7b AC |
29988 | |
29989 | @subsubheading Synopsis | |
29990 | ||
29991 | @smallexample | |
a2c02241 | 29992 | -symbol-list-lines @var{filename} |
922fbb7b AC |
29993 | @end smallexample |
29994 | ||
a2c02241 NR |
29995 | Print the list of lines that contain code and their associated program |
29996 | addresses for the given source filename. The entries are sorted in | |
29997 | ascending PC order. | |
922fbb7b AC |
29998 | |
29999 | @subsubheading @value{GDBN} Command | |
30000 | ||
a2c02241 | 30001 | There is no corresponding @value{GDBN} command. |
922fbb7b AC |
30002 | |
30003 | @subsubheading Example | |
a2c02241 | 30004 | @smallexample |
594fe323 | 30005 | (gdb) |
a2c02241 NR |
30006 | -symbol-list-lines basics.c |
30007 | ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}] | |
594fe323 | 30008 | (gdb) |
a2c02241 | 30009 | @end smallexample |
922fbb7b AC |
30010 | |
30011 | ||
9901a55b | 30012 | @ignore |
a2c02241 NR |
30013 | @subheading The @code{-symbol-list-types} Command |
30014 | @findex -symbol-list-types | |
922fbb7b AC |
30015 | |
30016 | @subsubheading Synopsis | |
30017 | ||
30018 | @smallexample | |
a2c02241 | 30019 | -symbol-list-types |
922fbb7b AC |
30020 | @end smallexample |
30021 | ||
a2c02241 | 30022 | List all the type names. |
922fbb7b AC |
30023 | |
30024 | @subsubheading @value{GDBN} Command | |
30025 | ||
a2c02241 NR |
30026 | The corresponding commands are @samp{info types} in @value{GDBN}, |
30027 | @samp{gdb_search} in @code{gdbtk}. | |
922fbb7b AC |
30028 | |
30029 | @subsubheading Example | |
30030 | N.A. | |
30031 | ||
30032 | ||
a2c02241 NR |
30033 | @subheading The @code{-symbol-list-variables} Command |
30034 | @findex -symbol-list-variables | |
922fbb7b AC |
30035 | |
30036 | @subsubheading Synopsis | |
30037 | ||
30038 | @smallexample | |
a2c02241 | 30039 | -symbol-list-variables |
922fbb7b AC |
30040 | @end smallexample |
30041 | ||
a2c02241 | 30042 | List all the global and static variable names. |
922fbb7b AC |
30043 | |
30044 | @subsubheading @value{GDBN} Command | |
30045 | ||
a2c02241 | 30046 | @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}. |
922fbb7b AC |
30047 | |
30048 | @subsubheading Example | |
30049 | N.A. | |
30050 | ||
30051 | ||
a2c02241 NR |
30052 | @subheading The @code{-symbol-locate} Command |
30053 | @findex -symbol-locate | |
922fbb7b AC |
30054 | |
30055 | @subsubheading Synopsis | |
30056 | ||
30057 | @smallexample | |
a2c02241 | 30058 | -symbol-locate |
922fbb7b AC |
30059 | @end smallexample |
30060 | ||
922fbb7b AC |
30061 | @subsubheading @value{GDBN} Command |
30062 | ||
a2c02241 | 30063 | @samp{gdb_loc} in @code{gdbtk}. |
922fbb7b AC |
30064 | |
30065 | @subsubheading Example | |
30066 | N.A. | |
30067 | ||
30068 | ||
a2c02241 NR |
30069 | @subheading The @code{-symbol-type} Command |
30070 | @findex -symbol-type | |
922fbb7b AC |
30071 | |
30072 | @subsubheading Synopsis | |
30073 | ||
30074 | @smallexample | |
a2c02241 | 30075 | -symbol-type @var{variable} |
922fbb7b AC |
30076 | @end smallexample |
30077 | ||
a2c02241 | 30078 | Show type of @var{variable}. |
922fbb7b | 30079 | |
a2c02241 | 30080 | @subsubheading @value{GDBN} Command |
922fbb7b | 30081 | |
a2c02241 NR |
30082 | The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has |
30083 | @samp{gdb_obj_variable}. | |
30084 | ||
30085 | @subsubheading Example | |
30086 | N.A. | |
9901a55b | 30087 | @end ignore |
a2c02241 NR |
30088 | |
30089 | ||
30090 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | |
30091 | @node GDB/MI File Commands | |
30092 | @section @sc{gdb/mi} File Commands | |
30093 | ||
30094 | This section describes the GDB/MI commands to specify executable file names | |
30095 | and to read in and obtain symbol table information. | |
30096 | ||
30097 | @subheading The @code{-file-exec-and-symbols} Command | |
30098 | @findex -file-exec-and-symbols | |
30099 | ||
30100 | @subsubheading Synopsis | |
922fbb7b AC |
30101 | |
30102 | @smallexample | |
a2c02241 | 30103 | -file-exec-and-symbols @var{file} |
922fbb7b AC |
30104 | @end smallexample |
30105 | ||
a2c02241 NR |
30106 | Specify the executable file to be debugged. This file is the one from |
30107 | which the symbol table is also read. If no file is specified, the | |
30108 | command clears the executable and symbol information. If breakpoints | |
30109 | are set when using this command with no arguments, @value{GDBN} will produce | |
30110 | error messages. Otherwise, no output is produced, except a completion | |
30111 | notification. | |
30112 | ||
922fbb7b AC |
30113 | @subsubheading @value{GDBN} Command |
30114 | ||
a2c02241 | 30115 | The corresponding @value{GDBN} command is @samp{file}. |
922fbb7b AC |
30116 | |
30117 | @subsubheading Example | |
30118 | ||
30119 | @smallexample | |
594fe323 | 30120 | (gdb) |
a2c02241 NR |
30121 | -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
30122 | ^done | |
594fe323 | 30123 | (gdb) |
922fbb7b AC |
30124 | @end smallexample |
30125 | ||
922fbb7b | 30126 | |
a2c02241 NR |
30127 | @subheading The @code{-file-exec-file} Command |
30128 | @findex -file-exec-file | |
922fbb7b AC |
30129 | |
30130 | @subsubheading Synopsis | |
30131 | ||
30132 | @smallexample | |
a2c02241 | 30133 | -file-exec-file @var{file} |
922fbb7b AC |
30134 | @end smallexample |
30135 | ||
a2c02241 NR |
30136 | Specify the executable file to be debugged. Unlike |
30137 | @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read | |
30138 | from this file. If used without argument, @value{GDBN} clears the information | |
30139 | about the executable file. No output is produced, except a completion | |
30140 | notification. | |
922fbb7b | 30141 | |
a2c02241 NR |
30142 | @subsubheading @value{GDBN} Command |
30143 | ||
30144 | The corresponding @value{GDBN} command is @samp{exec-file}. | |
922fbb7b AC |
30145 | |
30146 | @subsubheading Example | |
a2c02241 NR |
30147 | |
30148 | @smallexample | |
594fe323 | 30149 | (gdb) |
a2c02241 NR |
30150 | -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
30151 | ^done | |
594fe323 | 30152 | (gdb) |
a2c02241 | 30153 | @end smallexample |
922fbb7b AC |
30154 | |
30155 | ||
9901a55b | 30156 | @ignore |
a2c02241 NR |
30157 | @subheading The @code{-file-list-exec-sections} Command |
30158 | @findex -file-list-exec-sections | |
922fbb7b AC |
30159 | |
30160 | @subsubheading Synopsis | |
30161 | ||
30162 | @smallexample | |
a2c02241 | 30163 | -file-list-exec-sections |
922fbb7b AC |
30164 | @end smallexample |
30165 | ||
a2c02241 NR |
30166 | List the sections of the current executable file. |
30167 | ||
922fbb7b AC |
30168 | @subsubheading @value{GDBN} Command |
30169 | ||
a2c02241 NR |
30170 | The @value{GDBN} command @samp{info file} shows, among the rest, the same |
30171 | information as this command. @code{gdbtk} has a corresponding command | |
30172 | @samp{gdb_load_info}. | |
922fbb7b AC |
30173 | |
30174 | @subsubheading Example | |
30175 | N.A. | |
9901a55b | 30176 | @end ignore |
922fbb7b AC |
30177 | |
30178 | ||
a2c02241 NR |
30179 | @subheading The @code{-file-list-exec-source-file} Command |
30180 | @findex -file-list-exec-source-file | |
922fbb7b AC |
30181 | |
30182 | @subsubheading Synopsis | |
30183 | ||
30184 | @smallexample | |
a2c02241 | 30185 | -file-list-exec-source-file |
922fbb7b AC |
30186 | @end smallexample |
30187 | ||
a2c02241 | 30188 | List the line number, the current source file, and the absolute path |
44288b44 NR |
30189 | to the current source file for the current executable. The macro |
30190 | information field has a value of @samp{1} or @samp{0} depending on | |
30191 | whether or not the file includes preprocessor macro information. | |
922fbb7b AC |
30192 | |
30193 | @subsubheading @value{GDBN} Command | |
30194 | ||
a2c02241 | 30195 | The @value{GDBN} equivalent is @samp{info source} |
922fbb7b AC |
30196 | |
30197 | @subsubheading Example | |
30198 | ||
922fbb7b | 30199 | @smallexample |
594fe323 | 30200 | (gdb) |
a2c02241 | 30201 | 123-file-list-exec-source-file |
44288b44 | 30202 | 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1" |
594fe323 | 30203 | (gdb) |
922fbb7b AC |
30204 | @end smallexample |
30205 | ||
30206 | ||
a2c02241 NR |
30207 | @subheading The @code{-file-list-exec-source-files} Command |
30208 | @findex -file-list-exec-source-files | |
922fbb7b AC |
30209 | |
30210 | @subsubheading Synopsis | |
30211 | ||
30212 | @smallexample | |
a2c02241 | 30213 | -file-list-exec-source-files |
922fbb7b AC |
30214 | @end smallexample |
30215 | ||
a2c02241 NR |
30216 | List the source files for the current executable. |
30217 | ||
3f94c067 BW |
30218 | It will always output the filename, but only when @value{GDBN} can find |
30219 | the absolute file name of a source file, will it output the fullname. | |
922fbb7b AC |
30220 | |
30221 | @subsubheading @value{GDBN} Command | |
30222 | ||
a2c02241 NR |
30223 | The @value{GDBN} equivalent is @samp{info sources}. |
30224 | @code{gdbtk} has an analogous command @samp{gdb_listfiles}. | |
922fbb7b AC |
30225 | |
30226 | @subsubheading Example | |
922fbb7b | 30227 | @smallexample |
594fe323 | 30228 | (gdb) |
a2c02241 NR |
30229 | -file-list-exec-source-files |
30230 | ^done,files=[ | |
30231 | @{file=foo.c,fullname=/home/foo.c@}, | |
30232 | @{file=/home/bar.c,fullname=/home/bar.c@}, | |
30233 | @{file=gdb_could_not_find_fullpath.c@}] | |
594fe323 | 30234 | (gdb) |
922fbb7b AC |
30235 | @end smallexample |
30236 | ||
9901a55b | 30237 | @ignore |
a2c02241 NR |
30238 | @subheading The @code{-file-list-shared-libraries} Command |
30239 | @findex -file-list-shared-libraries | |
922fbb7b | 30240 | |
a2c02241 | 30241 | @subsubheading Synopsis |
922fbb7b | 30242 | |
a2c02241 NR |
30243 | @smallexample |
30244 | -file-list-shared-libraries | |
30245 | @end smallexample | |
922fbb7b | 30246 | |
a2c02241 | 30247 | List the shared libraries in the program. |
922fbb7b | 30248 | |
a2c02241 | 30249 | @subsubheading @value{GDBN} Command |
922fbb7b | 30250 | |
a2c02241 | 30251 | The corresponding @value{GDBN} command is @samp{info shared}. |
922fbb7b | 30252 | |
a2c02241 NR |
30253 | @subsubheading Example |
30254 | N.A. | |
922fbb7b AC |
30255 | |
30256 | ||
a2c02241 NR |
30257 | @subheading The @code{-file-list-symbol-files} Command |
30258 | @findex -file-list-symbol-files | |
922fbb7b | 30259 | |
a2c02241 | 30260 | @subsubheading Synopsis |
922fbb7b | 30261 | |
a2c02241 NR |
30262 | @smallexample |
30263 | -file-list-symbol-files | |
30264 | @end smallexample | |
922fbb7b | 30265 | |
a2c02241 | 30266 | List symbol files. |
922fbb7b | 30267 | |
a2c02241 | 30268 | @subsubheading @value{GDBN} Command |
922fbb7b | 30269 | |
a2c02241 | 30270 | The corresponding @value{GDBN} command is @samp{info file} (part of it). |
922fbb7b | 30271 | |
a2c02241 NR |
30272 | @subsubheading Example |
30273 | N.A. | |
9901a55b | 30274 | @end ignore |
922fbb7b | 30275 | |
922fbb7b | 30276 | |
a2c02241 NR |
30277 | @subheading The @code{-file-symbol-file} Command |
30278 | @findex -file-symbol-file | |
922fbb7b | 30279 | |
a2c02241 | 30280 | @subsubheading Synopsis |
922fbb7b | 30281 | |
a2c02241 NR |
30282 | @smallexample |
30283 | -file-symbol-file @var{file} | |
30284 | @end smallexample | |
922fbb7b | 30285 | |
a2c02241 NR |
30286 | Read symbol table info from the specified @var{file} argument. When |
30287 | used without arguments, clears @value{GDBN}'s symbol table info. No output is | |
30288 | produced, except for a completion notification. | |
922fbb7b | 30289 | |
a2c02241 | 30290 | @subsubheading @value{GDBN} Command |
922fbb7b | 30291 | |
a2c02241 | 30292 | The corresponding @value{GDBN} command is @samp{symbol-file}. |
922fbb7b | 30293 | |
a2c02241 | 30294 | @subsubheading Example |
922fbb7b | 30295 | |
a2c02241 | 30296 | @smallexample |
594fe323 | 30297 | (gdb) |
a2c02241 NR |
30298 | -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
30299 | ^done | |
594fe323 | 30300 | (gdb) |
a2c02241 | 30301 | @end smallexample |
922fbb7b | 30302 | |
a2c02241 | 30303 | @ignore |
a2c02241 NR |
30304 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
30305 | @node GDB/MI Memory Overlay Commands | |
30306 | @section @sc{gdb/mi} Memory Overlay Commands | |
922fbb7b | 30307 | |
a2c02241 | 30308 | The memory overlay commands are not implemented. |
922fbb7b | 30309 | |
a2c02241 | 30310 | @c @subheading -overlay-auto |
922fbb7b | 30311 | |
a2c02241 | 30312 | @c @subheading -overlay-list-mapping-state |
922fbb7b | 30313 | |
a2c02241 | 30314 | @c @subheading -overlay-list-overlays |
922fbb7b | 30315 | |
a2c02241 | 30316 | @c @subheading -overlay-map |
922fbb7b | 30317 | |
a2c02241 | 30318 | @c @subheading -overlay-off |
922fbb7b | 30319 | |
a2c02241 | 30320 | @c @subheading -overlay-on |
922fbb7b | 30321 | |
a2c02241 | 30322 | @c @subheading -overlay-unmap |
922fbb7b | 30323 | |
a2c02241 NR |
30324 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
30325 | @node GDB/MI Signal Handling Commands | |
30326 | @section @sc{gdb/mi} Signal Handling Commands | |
922fbb7b | 30327 | |
a2c02241 | 30328 | Signal handling commands are not implemented. |
922fbb7b | 30329 | |
a2c02241 | 30330 | @c @subheading -signal-handle |
922fbb7b | 30331 | |
a2c02241 | 30332 | @c @subheading -signal-list-handle-actions |
922fbb7b | 30333 | |
a2c02241 NR |
30334 | @c @subheading -signal-list-signal-types |
30335 | @end ignore | |
922fbb7b | 30336 | |
922fbb7b | 30337 | |
a2c02241 NR |
30338 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
30339 | @node GDB/MI Target Manipulation | |
30340 | @section @sc{gdb/mi} Target Manipulation Commands | |
922fbb7b AC |
30341 | |
30342 | ||
a2c02241 NR |
30343 | @subheading The @code{-target-attach} Command |
30344 | @findex -target-attach | |
922fbb7b AC |
30345 | |
30346 | @subsubheading Synopsis | |
30347 | ||
30348 | @smallexample | |
c3b108f7 | 30349 | -target-attach @var{pid} | @var{gid} | @var{file} |
922fbb7b AC |
30350 | @end smallexample |
30351 | ||
c3b108f7 VP |
30352 | Attach to a process @var{pid} or a file @var{file} outside of |
30353 | @value{GDBN}, or a thread group @var{gid}. If attaching to a thread | |
30354 | group, the id previously returned by | |
30355 | @samp{-list-thread-groups --available} must be used. | |
922fbb7b | 30356 | |
79a6e687 | 30357 | @subsubheading @value{GDBN} Command |
922fbb7b | 30358 | |
a2c02241 | 30359 | The corresponding @value{GDBN} command is @samp{attach}. |
922fbb7b | 30360 | |
a2c02241 | 30361 | @subsubheading Example |
b56e7235 VP |
30362 | @smallexample |
30363 | (gdb) | |
30364 | -target-attach 34 | |
30365 | =thread-created,id="1" | |
5ae4183a | 30366 | *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@} |
b56e7235 VP |
30367 | ^done |
30368 | (gdb) | |
30369 | @end smallexample | |
a2c02241 | 30370 | |
9901a55b | 30371 | @ignore |
a2c02241 NR |
30372 | @subheading The @code{-target-compare-sections} Command |
30373 | @findex -target-compare-sections | |
922fbb7b AC |
30374 | |
30375 | @subsubheading Synopsis | |
30376 | ||
30377 | @smallexample | |
a2c02241 | 30378 | -target-compare-sections [ @var{section} ] |
922fbb7b AC |
30379 | @end smallexample |
30380 | ||
a2c02241 NR |
30381 | Compare data of section @var{section} on target to the exec file. |
30382 | Without the argument, all sections are compared. | |
922fbb7b | 30383 | |
a2c02241 | 30384 | @subsubheading @value{GDBN} Command |
922fbb7b | 30385 | |
a2c02241 | 30386 | The @value{GDBN} equivalent is @samp{compare-sections}. |
922fbb7b | 30387 | |
a2c02241 NR |
30388 | @subsubheading Example |
30389 | N.A. | |
9901a55b | 30390 | @end ignore |
a2c02241 NR |
30391 | |
30392 | ||
30393 | @subheading The @code{-target-detach} Command | |
30394 | @findex -target-detach | |
922fbb7b AC |
30395 | |
30396 | @subsubheading Synopsis | |
30397 | ||
30398 | @smallexample | |
c3b108f7 | 30399 | -target-detach [ @var{pid} | @var{gid} ] |
922fbb7b AC |
30400 | @end smallexample |
30401 | ||
a2c02241 | 30402 | Detach from the remote target which normally resumes its execution. |
c3b108f7 VP |
30403 | If either @var{pid} or @var{gid} is specified, detaches from either |
30404 | the specified process, or specified thread group. There's no output. | |
a2c02241 | 30405 | |
79a6e687 | 30406 | @subsubheading @value{GDBN} Command |
a2c02241 NR |
30407 | |
30408 | The corresponding @value{GDBN} command is @samp{detach}. | |
30409 | ||
30410 | @subsubheading Example | |
922fbb7b AC |
30411 | |
30412 | @smallexample | |
594fe323 | 30413 | (gdb) |
a2c02241 NR |
30414 | -target-detach |
30415 | ^done | |
594fe323 | 30416 | (gdb) |
922fbb7b AC |
30417 | @end smallexample |
30418 | ||
30419 | ||
a2c02241 NR |
30420 | @subheading The @code{-target-disconnect} Command |
30421 | @findex -target-disconnect | |
922fbb7b AC |
30422 | |
30423 | @subsubheading Synopsis | |
30424 | ||
123dc839 | 30425 | @smallexample |
a2c02241 | 30426 | -target-disconnect |
123dc839 | 30427 | @end smallexample |
922fbb7b | 30428 | |
a2c02241 NR |
30429 | Disconnect from the remote target. There's no output and the target is |
30430 | generally not resumed. | |
30431 | ||
79a6e687 | 30432 | @subsubheading @value{GDBN} Command |
a2c02241 NR |
30433 | |
30434 | The corresponding @value{GDBN} command is @samp{disconnect}. | |
bc8ced35 NR |
30435 | |
30436 | @subsubheading Example | |
922fbb7b AC |
30437 | |
30438 | @smallexample | |
594fe323 | 30439 | (gdb) |
a2c02241 NR |
30440 | -target-disconnect |
30441 | ^done | |
594fe323 | 30442 | (gdb) |
922fbb7b AC |
30443 | @end smallexample |
30444 | ||
30445 | ||
a2c02241 NR |
30446 | @subheading The @code{-target-download} Command |
30447 | @findex -target-download | |
922fbb7b AC |
30448 | |
30449 | @subsubheading Synopsis | |
30450 | ||
30451 | @smallexample | |
a2c02241 | 30452 | -target-download |
922fbb7b AC |
30453 | @end smallexample |
30454 | ||
a2c02241 NR |
30455 | Loads the executable onto the remote target. |
30456 | It prints out an update message every half second, which includes the fields: | |
30457 | ||
30458 | @table @samp | |
30459 | @item section | |
30460 | The name of the section. | |
30461 | @item section-sent | |
30462 | The size of what has been sent so far for that section. | |
30463 | @item section-size | |
30464 | The size of the section. | |
30465 | @item total-sent | |
30466 | The total size of what was sent so far (the current and the previous sections). | |
30467 | @item total-size | |
30468 | The size of the overall executable to download. | |
30469 | @end table | |
30470 | ||
30471 | @noindent | |
30472 | Each message is sent as status record (@pxref{GDB/MI Output Syntax, , | |
30473 | @sc{gdb/mi} Output Syntax}). | |
30474 | ||
30475 | In addition, it prints the name and size of the sections, as they are | |
30476 | downloaded. These messages include the following fields: | |
30477 | ||
30478 | @table @samp | |
30479 | @item section | |
30480 | The name of the section. | |
30481 | @item section-size | |
30482 | The size of the section. | |
30483 | @item total-size | |
30484 | The size of the overall executable to download. | |
30485 | @end table | |
30486 | ||
30487 | @noindent | |
30488 | At the end, a summary is printed. | |
30489 | ||
30490 | @subsubheading @value{GDBN} Command | |
30491 | ||
30492 | The corresponding @value{GDBN} command is @samp{load}. | |
30493 | ||
30494 | @subsubheading Example | |
30495 | ||
30496 | Note: each status message appears on a single line. Here the messages | |
30497 | have been broken down so that they can fit onto a page. | |
922fbb7b AC |
30498 | |
30499 | @smallexample | |
594fe323 | 30500 | (gdb) |
a2c02241 NR |
30501 | -target-download |
30502 | +download,@{section=".text",section-size="6668",total-size="9880"@} | |
30503 | +download,@{section=".text",section-sent="512",section-size="6668", | |
30504 | total-sent="512",total-size="9880"@} | |
30505 | +download,@{section=".text",section-sent="1024",section-size="6668", | |
30506 | total-sent="1024",total-size="9880"@} | |
30507 | +download,@{section=".text",section-sent="1536",section-size="6668", | |
30508 | total-sent="1536",total-size="9880"@} | |
30509 | +download,@{section=".text",section-sent="2048",section-size="6668", | |
30510 | total-sent="2048",total-size="9880"@} | |
30511 | +download,@{section=".text",section-sent="2560",section-size="6668", | |
30512 | total-sent="2560",total-size="9880"@} | |
30513 | +download,@{section=".text",section-sent="3072",section-size="6668", | |
30514 | total-sent="3072",total-size="9880"@} | |
30515 | +download,@{section=".text",section-sent="3584",section-size="6668", | |
30516 | total-sent="3584",total-size="9880"@} | |
30517 | +download,@{section=".text",section-sent="4096",section-size="6668", | |
30518 | total-sent="4096",total-size="9880"@} | |
30519 | +download,@{section=".text",section-sent="4608",section-size="6668", | |
30520 | total-sent="4608",total-size="9880"@} | |
30521 | +download,@{section=".text",section-sent="5120",section-size="6668", | |
30522 | total-sent="5120",total-size="9880"@} | |
30523 | +download,@{section=".text",section-sent="5632",section-size="6668", | |
30524 | total-sent="5632",total-size="9880"@} | |
30525 | +download,@{section=".text",section-sent="6144",section-size="6668", | |
30526 | total-sent="6144",total-size="9880"@} | |
30527 | +download,@{section=".text",section-sent="6656",section-size="6668", | |
30528 | total-sent="6656",total-size="9880"@} | |
30529 | +download,@{section=".init",section-size="28",total-size="9880"@} | |
30530 | +download,@{section=".fini",section-size="28",total-size="9880"@} | |
30531 | +download,@{section=".data",section-size="3156",total-size="9880"@} | |
30532 | +download,@{section=".data",section-sent="512",section-size="3156", | |
30533 | total-sent="7236",total-size="9880"@} | |
30534 | +download,@{section=".data",section-sent="1024",section-size="3156", | |
30535 | total-sent="7748",total-size="9880"@} | |
30536 | +download,@{section=".data",section-sent="1536",section-size="3156", | |
30537 | total-sent="8260",total-size="9880"@} | |
30538 | +download,@{section=".data",section-sent="2048",section-size="3156", | |
30539 | total-sent="8772",total-size="9880"@} | |
30540 | +download,@{section=".data",section-sent="2560",section-size="3156", | |
30541 | total-sent="9284",total-size="9880"@} | |
30542 | +download,@{section=".data",section-sent="3072",section-size="3156", | |
30543 | total-sent="9796",total-size="9880"@} | |
30544 | ^done,address="0x10004",load-size="9880",transfer-rate="6586", | |
30545 | write-rate="429" | |
594fe323 | 30546 | (gdb) |
922fbb7b AC |
30547 | @end smallexample |
30548 | ||
30549 | ||
9901a55b | 30550 | @ignore |
a2c02241 NR |
30551 | @subheading The @code{-target-exec-status} Command |
30552 | @findex -target-exec-status | |
922fbb7b AC |
30553 | |
30554 | @subsubheading Synopsis | |
30555 | ||
30556 | @smallexample | |
a2c02241 | 30557 | -target-exec-status |
922fbb7b AC |
30558 | @end smallexample |
30559 | ||
a2c02241 NR |
30560 | Provide information on the state of the target (whether it is running or |
30561 | not, for instance). | |
922fbb7b | 30562 | |
a2c02241 | 30563 | @subsubheading @value{GDBN} Command |
922fbb7b | 30564 | |
a2c02241 NR |
30565 | There's no equivalent @value{GDBN} command. |
30566 | ||
30567 | @subsubheading Example | |
30568 | N.A. | |
922fbb7b | 30569 | |
a2c02241 NR |
30570 | |
30571 | @subheading The @code{-target-list-available-targets} Command | |
30572 | @findex -target-list-available-targets | |
922fbb7b AC |
30573 | |
30574 | @subsubheading Synopsis | |
30575 | ||
30576 | @smallexample | |
a2c02241 | 30577 | -target-list-available-targets |
922fbb7b AC |
30578 | @end smallexample |
30579 | ||
a2c02241 | 30580 | List the possible targets to connect to. |
922fbb7b | 30581 | |
a2c02241 | 30582 | @subsubheading @value{GDBN} Command |
922fbb7b | 30583 | |
a2c02241 | 30584 | The corresponding @value{GDBN} command is @samp{help target}. |
922fbb7b | 30585 | |
a2c02241 NR |
30586 | @subsubheading Example |
30587 | N.A. | |
30588 | ||
30589 | ||
30590 | @subheading The @code{-target-list-current-targets} Command | |
30591 | @findex -target-list-current-targets | |
922fbb7b AC |
30592 | |
30593 | @subsubheading Synopsis | |
30594 | ||
30595 | @smallexample | |
a2c02241 | 30596 | -target-list-current-targets |
922fbb7b AC |
30597 | @end smallexample |
30598 | ||
a2c02241 | 30599 | Describe the current target. |
922fbb7b | 30600 | |
a2c02241 | 30601 | @subsubheading @value{GDBN} Command |
922fbb7b | 30602 | |
a2c02241 NR |
30603 | The corresponding information is printed by @samp{info file} (among |
30604 | other things). | |
922fbb7b | 30605 | |
a2c02241 NR |
30606 | @subsubheading Example |
30607 | N.A. | |
30608 | ||
30609 | ||
30610 | @subheading The @code{-target-list-parameters} Command | |
30611 | @findex -target-list-parameters | |
922fbb7b AC |
30612 | |
30613 | @subsubheading Synopsis | |
30614 | ||
30615 | @smallexample | |
a2c02241 | 30616 | -target-list-parameters |
922fbb7b AC |
30617 | @end smallexample |
30618 | ||
a2c02241 | 30619 | @c ???? |
9901a55b | 30620 | @end ignore |
a2c02241 NR |
30621 | |
30622 | @subsubheading @value{GDBN} Command | |
30623 | ||
30624 | No equivalent. | |
922fbb7b AC |
30625 | |
30626 | @subsubheading Example | |
a2c02241 NR |
30627 | N.A. |
30628 | ||
30629 | ||
30630 | @subheading The @code{-target-select} Command | |
30631 | @findex -target-select | |
30632 | ||
30633 | @subsubheading Synopsis | |
922fbb7b AC |
30634 | |
30635 | @smallexample | |
a2c02241 | 30636 | -target-select @var{type} @var{parameters @dots{}} |
922fbb7b AC |
30637 | @end smallexample |
30638 | ||
a2c02241 | 30639 | Connect @value{GDBN} to the remote target. This command takes two args: |
922fbb7b | 30640 | |
a2c02241 NR |
30641 | @table @samp |
30642 | @item @var{type} | |
75c99385 | 30643 | The type of target, for instance @samp{remote}, etc. |
a2c02241 NR |
30644 | @item @var{parameters} |
30645 | Device names, host names and the like. @xref{Target Commands, , | |
79a6e687 | 30646 | Commands for Managing Targets}, for more details. |
a2c02241 NR |
30647 | @end table |
30648 | ||
30649 | The output is a connection notification, followed by the address at | |
30650 | which the target program is, in the following form: | |
922fbb7b AC |
30651 | |
30652 | @smallexample | |
a2c02241 NR |
30653 | ^connected,addr="@var{address}",func="@var{function name}", |
30654 | args=[@var{arg list}] | |
922fbb7b AC |
30655 | @end smallexample |
30656 | ||
a2c02241 NR |
30657 | @subsubheading @value{GDBN} Command |
30658 | ||
30659 | The corresponding @value{GDBN} command is @samp{target}. | |
265eeb58 NR |
30660 | |
30661 | @subsubheading Example | |
922fbb7b | 30662 | |
265eeb58 | 30663 | @smallexample |
594fe323 | 30664 | (gdb) |
75c99385 | 30665 | -target-select remote /dev/ttya |
a2c02241 | 30666 | ^connected,addr="0xfe00a300",func="??",args=[] |
594fe323 | 30667 | (gdb) |
265eeb58 | 30668 | @end smallexample |
ef21caaf | 30669 | |
a6b151f1 DJ |
30670 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
30671 | @node GDB/MI File Transfer Commands | |
30672 | @section @sc{gdb/mi} File Transfer Commands | |
30673 | ||
30674 | ||
30675 | @subheading The @code{-target-file-put} Command | |
30676 | @findex -target-file-put | |
30677 | ||
30678 | @subsubheading Synopsis | |
30679 | ||
30680 | @smallexample | |
30681 | -target-file-put @var{hostfile} @var{targetfile} | |
30682 | @end smallexample | |
30683 | ||
30684 | Copy file @var{hostfile} from the host system (the machine running | |
30685 | @value{GDBN}) to @var{targetfile} on the target system. | |
30686 | ||
30687 | @subsubheading @value{GDBN} Command | |
30688 | ||
30689 | The corresponding @value{GDBN} command is @samp{remote put}. | |
30690 | ||
30691 | @subsubheading Example | |
30692 | ||
30693 | @smallexample | |
30694 | (gdb) | |
30695 | -target-file-put localfile remotefile | |
30696 | ^done | |
30697 | (gdb) | |
30698 | @end smallexample | |
30699 | ||
30700 | ||
1763a388 | 30701 | @subheading The @code{-target-file-get} Command |
a6b151f1 DJ |
30702 | @findex -target-file-get |
30703 | ||
30704 | @subsubheading Synopsis | |
30705 | ||
30706 | @smallexample | |
30707 | -target-file-get @var{targetfile} @var{hostfile} | |
30708 | @end smallexample | |
30709 | ||
30710 | Copy file @var{targetfile} from the target system to @var{hostfile} | |
30711 | on the host system. | |
30712 | ||
30713 | @subsubheading @value{GDBN} Command | |
30714 | ||
30715 | The corresponding @value{GDBN} command is @samp{remote get}. | |
30716 | ||
30717 | @subsubheading Example | |
30718 | ||
30719 | @smallexample | |
30720 | (gdb) | |
30721 | -target-file-get remotefile localfile | |
30722 | ^done | |
30723 | (gdb) | |
30724 | @end smallexample | |
30725 | ||
30726 | ||
30727 | @subheading The @code{-target-file-delete} Command | |
30728 | @findex -target-file-delete | |
30729 | ||
30730 | @subsubheading Synopsis | |
30731 | ||
30732 | @smallexample | |
30733 | -target-file-delete @var{targetfile} | |
30734 | @end smallexample | |
30735 | ||
30736 | Delete @var{targetfile} from the target system. | |
30737 | ||
30738 | @subsubheading @value{GDBN} Command | |
30739 | ||
30740 | The corresponding @value{GDBN} command is @samp{remote delete}. | |
30741 | ||
30742 | @subsubheading Example | |
30743 | ||
30744 | @smallexample | |
30745 | (gdb) | |
30746 | -target-file-delete remotefile | |
30747 | ^done | |
30748 | (gdb) | |
30749 | @end smallexample | |
30750 | ||
30751 | ||
ef21caaf NR |
30752 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
30753 | @node GDB/MI Miscellaneous Commands | |
30754 | @section Miscellaneous @sc{gdb/mi} Commands | |
30755 | ||
30756 | @c @subheading -gdb-complete | |
30757 | ||
30758 | @subheading The @code{-gdb-exit} Command | |
30759 | @findex -gdb-exit | |
30760 | ||
30761 | @subsubheading Synopsis | |
30762 | ||
30763 | @smallexample | |
30764 | -gdb-exit | |
30765 | @end smallexample | |
30766 | ||
30767 | Exit @value{GDBN} immediately. | |
30768 | ||
30769 | @subsubheading @value{GDBN} Command | |
30770 | ||
30771 | Approximately corresponds to @samp{quit}. | |
30772 | ||
30773 | @subsubheading Example | |
30774 | ||
30775 | @smallexample | |
594fe323 | 30776 | (gdb) |
ef21caaf NR |
30777 | -gdb-exit |
30778 | ^exit | |
30779 | @end smallexample | |
30780 | ||
a2c02241 | 30781 | |
9901a55b | 30782 | @ignore |
a2c02241 NR |
30783 | @subheading The @code{-exec-abort} Command |
30784 | @findex -exec-abort | |
30785 | ||
30786 | @subsubheading Synopsis | |
30787 | ||
30788 | @smallexample | |
30789 | -exec-abort | |
30790 | @end smallexample | |
30791 | ||
30792 | Kill the inferior running program. | |
30793 | ||
30794 | @subsubheading @value{GDBN} Command | |
30795 | ||
30796 | The corresponding @value{GDBN} command is @samp{kill}. | |
30797 | ||
30798 | @subsubheading Example | |
30799 | N.A. | |
9901a55b | 30800 | @end ignore |
a2c02241 NR |
30801 | |
30802 | ||
ef21caaf NR |
30803 | @subheading The @code{-gdb-set} Command |
30804 | @findex -gdb-set | |
30805 | ||
30806 | @subsubheading Synopsis | |
30807 | ||
30808 | @smallexample | |
30809 | -gdb-set | |
30810 | @end smallexample | |
30811 | ||
30812 | Set an internal @value{GDBN} variable. | |
30813 | @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ????? | |
30814 | ||
30815 | @subsubheading @value{GDBN} Command | |
30816 | ||
30817 | The corresponding @value{GDBN} command is @samp{set}. | |
30818 | ||
30819 | @subsubheading Example | |
30820 | ||
30821 | @smallexample | |
594fe323 | 30822 | (gdb) |
ef21caaf NR |
30823 | -gdb-set $foo=3 |
30824 | ^done | |
594fe323 | 30825 | (gdb) |
ef21caaf NR |
30826 | @end smallexample |
30827 | ||
30828 | ||
30829 | @subheading The @code{-gdb-show} Command | |
30830 | @findex -gdb-show | |
30831 | ||
30832 | @subsubheading Synopsis | |
30833 | ||
30834 | @smallexample | |
30835 | -gdb-show | |
30836 | @end smallexample | |
30837 | ||
30838 | Show the current value of a @value{GDBN} variable. | |
30839 | ||
79a6e687 | 30840 | @subsubheading @value{GDBN} Command |
ef21caaf NR |
30841 | |
30842 | The corresponding @value{GDBN} command is @samp{show}. | |
30843 | ||
30844 | @subsubheading Example | |
30845 | ||
30846 | @smallexample | |
594fe323 | 30847 | (gdb) |
ef21caaf NR |
30848 | -gdb-show annotate |
30849 | ^done,value="0" | |
594fe323 | 30850 | (gdb) |
ef21caaf NR |
30851 | @end smallexample |
30852 | ||
30853 | @c @subheading -gdb-source | |
30854 | ||
30855 | ||
30856 | @subheading The @code{-gdb-version} Command | |
30857 | @findex -gdb-version | |
30858 | ||
30859 | @subsubheading Synopsis | |
30860 | ||
30861 | @smallexample | |
30862 | -gdb-version | |
30863 | @end smallexample | |
30864 | ||
30865 | Show version information for @value{GDBN}. Used mostly in testing. | |
30866 | ||
30867 | @subsubheading @value{GDBN} Command | |
30868 | ||
30869 | The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by | |
30870 | default shows this information when you start an interactive session. | |
30871 | ||
30872 | @subsubheading Example | |
30873 | ||
30874 | @c This example modifies the actual output from GDB to avoid overfull | |
30875 | @c box in TeX. | |
30876 | @smallexample | |
594fe323 | 30877 | (gdb) |
ef21caaf NR |
30878 | -gdb-version |
30879 | ~GNU gdb 5.2.1 | |
30880 | ~Copyright 2000 Free Software Foundation, Inc. | |
30881 | ~GDB is free software, covered by the GNU General Public License, and | |
30882 | ~you are welcome to change it and/or distribute copies of it under | |
30883 | ~ certain conditions. | |
30884 | ~Type "show copying" to see the conditions. | |
30885 | ~There is absolutely no warranty for GDB. Type "show warranty" for | |
30886 | ~ details. | |
30887 | ~This GDB was configured as | |
30888 | "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi". | |
30889 | ^done | |
594fe323 | 30890 | (gdb) |
ef21caaf NR |
30891 | @end smallexample |
30892 | ||
084344da VP |
30893 | @subheading The @code{-list-features} Command |
30894 | @findex -list-features | |
30895 | ||
30896 | Returns a list of particular features of the MI protocol that | |
30897 | this version of gdb implements. A feature can be a command, | |
30898 | or a new field in an output of some command, or even an | |
30899 | important bugfix. While a frontend can sometimes detect presence | |
30900 | of a feature at runtime, it is easier to perform detection at debugger | |
30901 | startup. | |
30902 | ||
30903 | The command returns a list of strings, with each string naming an | |
30904 | available feature. Each returned string is just a name, it does not | |
30905 | have any internal structure. The list of possible feature names | |
30906 | is given below. | |
30907 | ||
30908 | Example output: | |
30909 | ||
30910 | @smallexample | |
30911 | (gdb) -list-features | |
30912 | ^done,result=["feature1","feature2"] | |
30913 | @end smallexample | |
30914 | ||
30915 | The current list of features is: | |
30916 | ||
30e026bb VP |
30917 | @table @samp |
30918 | @item frozen-varobjs | |
a05336a1 JB |
30919 | Indicates support for the @code{-var-set-frozen} command, as well |
30920 | as possible presense of the @code{frozen} field in the output | |
30e026bb VP |
30921 | of @code{-varobj-create}. |
30922 | @item pending-breakpoints | |
a05336a1 JB |
30923 | Indicates support for the @option{-f} option to the @code{-break-insert} |
30924 | command. | |
b6313243 | 30925 | @item python |
a05336a1 | 30926 | Indicates Python scripting support, Python-based |
b6313243 TT |
30927 | pretty-printing commands, and possible presence of the |
30928 | @samp{display_hint} field in the output of @code{-var-list-children} | |
30e026bb | 30929 | @item thread-info |
a05336a1 | 30930 | Indicates support for the @code{-thread-info} command. |
8dedea02 | 30931 | @item data-read-memory-bytes |
a05336a1 | 30932 | Indicates support for the @code{-data-read-memory-bytes} and the |
8dedea02 | 30933 | @code{-data-write-memory-bytes} commands. |
39c4d40a TT |
30934 | @item breakpoint-notifications |
30935 | Indicates that changes to breakpoints and breakpoints created via the | |
30936 | CLI will be announced via async records. | |
5d77fe44 JB |
30937 | @item ada-task-info |
30938 | Indicates support for the @code{-ada-task-info} command. | |
30e026bb | 30939 | @end table |
084344da | 30940 | |
c6ebd6cf VP |
30941 | @subheading The @code{-list-target-features} Command |
30942 | @findex -list-target-features | |
30943 | ||
30944 | Returns a list of particular features that are supported by the | |
30945 | target. Those features affect the permitted MI commands, but | |
30946 | unlike the features reported by the @code{-list-features} command, the | |
30947 | features depend on which target GDB is using at the moment. Whenever | |
30948 | a target can change, due to commands such as @code{-target-select}, | |
30949 | @code{-target-attach} or @code{-exec-run}, the list of target features | |
30950 | may change, and the frontend should obtain it again. | |
30951 | Example output: | |
30952 | ||
30953 | @smallexample | |
30954 | (gdb) -list-features | |
30955 | ^done,result=["async"] | |
30956 | @end smallexample | |
30957 | ||
30958 | The current list of features is: | |
30959 | ||
30960 | @table @samp | |
30961 | @item async | |
30962 | Indicates that the target is capable of asynchronous command | |
30963 | execution, which means that @value{GDBN} will accept further commands | |
30964 | while the target is running. | |
30965 | ||
f75d858b MK |
30966 | @item reverse |
30967 | Indicates that the target is capable of reverse execution. | |
30968 | @xref{Reverse Execution}, for more information. | |
30969 | ||
c6ebd6cf VP |
30970 | @end table |
30971 | ||
c3b108f7 VP |
30972 | @subheading The @code{-list-thread-groups} Command |
30973 | @findex -list-thread-groups | |
30974 | ||
30975 | @subheading Synopsis | |
30976 | ||
30977 | @smallexample | |
dc146f7c | 30978 | -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ] |
c3b108f7 VP |
30979 | @end smallexample |
30980 | ||
dc146f7c VP |
30981 | Lists thread groups (@pxref{Thread groups}). When a single thread |
30982 | group is passed as the argument, lists the children of that group. | |
30983 | When several thread group are passed, lists information about those | |
30984 | thread groups. Without any parameters, lists information about all | |
30985 | top-level thread groups. | |
30986 | ||
30987 | Normally, thread groups that are being debugged are reported. | |
30988 | With the @samp{--available} option, @value{GDBN} reports thread groups | |
30989 | available on the target. | |
30990 | ||
30991 | The output of this command may have either a @samp{threads} result or | |
30992 | a @samp{groups} result. The @samp{thread} result has a list of tuples | |
30993 | as value, with each tuple describing a thread (@pxref{GDB/MI Thread | |
30994 | Information}). The @samp{groups} result has a list of tuples as value, | |
30995 | each tuple describing a thread group. If top-level groups are | |
30996 | requested (that is, no parameter is passed), or when several groups | |
30997 | are passed, the output always has a @samp{groups} result. The format | |
30998 | of the @samp{group} result is described below. | |
30999 | ||
31000 | To reduce the number of roundtrips it's possible to list thread groups | |
31001 | together with their children, by passing the @samp{--recurse} option | |
31002 | and the recursion depth. Presently, only recursion depth of 1 is | |
31003 | permitted. If this option is present, then every reported thread group | |
31004 | will also include its children, either as @samp{group} or | |
31005 | @samp{threads} field. | |
31006 | ||
31007 | In general, any combination of option and parameters is permitted, with | |
31008 | the following caveats: | |
31009 | ||
31010 | @itemize @bullet | |
31011 | @item | |
31012 | When a single thread group is passed, the output will typically | |
31013 | be the @samp{threads} result. Because threads may not contain | |
31014 | anything, the @samp{recurse} option will be ignored. | |
31015 | ||
31016 | @item | |
31017 | When the @samp{--available} option is passed, limited information may | |
31018 | be available. In particular, the list of threads of a process might | |
31019 | be inaccessible. Further, specifying specific thread groups might | |
31020 | not give any performance advantage over listing all thread groups. | |
31021 | The frontend should assume that @samp{-list-thread-groups --available} | |
31022 | is always an expensive operation and cache the results. | |
31023 | ||
31024 | @end itemize | |
31025 | ||
31026 | The @samp{groups} result is a list of tuples, where each tuple may | |
31027 | have the following fields: | |
31028 | ||
31029 | @table @code | |
31030 | @item id | |
31031 | Identifier of the thread group. This field is always present. | |
a79b8f6e VP |
31032 | The identifier is an opaque string; frontends should not try to |
31033 | convert it to an integer, even though it might look like one. | |
dc146f7c VP |
31034 | |
31035 | @item type | |
31036 | The type of the thread group. At present, only @samp{process} is a | |
31037 | valid type. | |
31038 | ||
31039 | @item pid | |
31040 | The target-specific process identifier. This field is only present | |
a79b8f6e | 31041 | for thread groups of type @samp{process} and only if the process exists. |
c3b108f7 | 31042 | |
dc146f7c VP |
31043 | @item num_children |
31044 | The number of children this thread group has. This field may be | |
31045 | absent for an available thread group. | |
31046 | ||
31047 | @item threads | |
31048 | This field has a list of tuples as value, each tuple describing a | |
31049 | thread. It may be present if the @samp{--recurse} option is | |
31050 | specified, and it's actually possible to obtain the threads. | |
31051 | ||
31052 | @item cores | |
31053 | This field is a list of integers, each identifying a core that one | |
31054 | thread of the group is running on. This field may be absent if | |
31055 | such information is not available. | |
31056 | ||
a79b8f6e VP |
31057 | @item executable |
31058 | The name of the executable file that corresponds to this thread group. | |
31059 | The field is only present for thread groups of type @samp{process}, | |
31060 | and only if there is a corresponding executable file. | |
31061 | ||
dc146f7c | 31062 | @end table |
c3b108f7 VP |
31063 | |
31064 | @subheading Example | |
31065 | ||
31066 | @smallexample | |
31067 | @value{GDBP} | |
31068 | -list-thread-groups | |
31069 | ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}] | |
31070 | -list-thread-groups 17 | |
31071 | ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)", | |
31072 | frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@}, | |
31073 | @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)", | |
31074 | frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}], | |
31075 | file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},state="running"@}]] | |
dc146f7c VP |
31076 | -list-thread-groups --available |
31077 | ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}] | |
31078 | -list-thread-groups --available --recurse 1 | |
31079 | ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2], | |
31080 | threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@}, | |
31081 | @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..] | |
31082 | -list-thread-groups --available --recurse 1 17 18 | |
31083 | ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2], | |
31084 | threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@}, | |
31085 | @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...] | |
c3b108f7 | 31086 | @end smallexample |
c6ebd6cf | 31087 | |
a79b8f6e VP |
31088 | |
31089 | @subheading The @code{-add-inferior} Command | |
31090 | @findex -add-inferior | |
31091 | ||
31092 | @subheading Synopsis | |
31093 | ||
31094 | @smallexample | |
31095 | -add-inferior | |
31096 | @end smallexample | |
31097 | ||
31098 | Creates a new inferior (@pxref{Inferiors and Programs}). The created | |
31099 | inferior is not associated with any executable. Such association may | |
31100 | be established with the @samp{-file-exec-and-symbols} command | |
31101 | (@pxref{GDB/MI File Commands}). The command response has a single | |
31102 | field, @samp{thread-group}, whose value is the identifier of the | |
31103 | thread group corresponding to the new inferior. | |
31104 | ||
31105 | @subheading Example | |
31106 | ||
31107 | @smallexample | |
31108 | @value{GDBP} | |
31109 | -add-inferior | |
31110 | ^done,thread-group="i3" | |
31111 | @end smallexample | |
31112 | ||
ef21caaf NR |
31113 | @subheading The @code{-interpreter-exec} Command |
31114 | @findex -interpreter-exec | |
31115 | ||
31116 | @subheading Synopsis | |
31117 | ||
31118 | @smallexample | |
31119 | -interpreter-exec @var{interpreter} @var{command} | |
31120 | @end smallexample | |
a2c02241 | 31121 | @anchor{-interpreter-exec} |
ef21caaf NR |
31122 | |
31123 | Execute the specified @var{command} in the given @var{interpreter}. | |
31124 | ||
31125 | @subheading @value{GDBN} Command | |
31126 | ||
31127 | The corresponding @value{GDBN} command is @samp{interpreter-exec}. | |
31128 | ||
31129 | @subheading Example | |
31130 | ||
31131 | @smallexample | |
594fe323 | 31132 | (gdb) |
ef21caaf NR |
31133 | -interpreter-exec console "break main" |
31134 | &"During symbol reading, couldn't parse type; debugger out of date?.\n" | |
31135 | &"During symbol reading, bad structure-type format.\n" | |
31136 | ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n" | |
31137 | ^done | |
594fe323 | 31138 | (gdb) |
ef21caaf NR |
31139 | @end smallexample |
31140 | ||
31141 | @subheading The @code{-inferior-tty-set} Command | |
31142 | @findex -inferior-tty-set | |
31143 | ||
31144 | @subheading Synopsis | |
31145 | ||
31146 | @smallexample | |
31147 | -inferior-tty-set /dev/pts/1 | |
31148 | @end smallexample | |
31149 | ||
31150 | Set terminal for future runs of the program being debugged. | |
31151 | ||
31152 | @subheading @value{GDBN} Command | |
31153 | ||
31154 | The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1. | |
31155 | ||
31156 | @subheading Example | |
31157 | ||
31158 | @smallexample | |
594fe323 | 31159 | (gdb) |
ef21caaf NR |
31160 | -inferior-tty-set /dev/pts/1 |
31161 | ^done | |
594fe323 | 31162 | (gdb) |
ef21caaf NR |
31163 | @end smallexample |
31164 | ||
31165 | @subheading The @code{-inferior-tty-show} Command | |
31166 | @findex -inferior-tty-show | |
31167 | ||
31168 | @subheading Synopsis | |
31169 | ||
31170 | @smallexample | |
31171 | -inferior-tty-show | |
31172 | @end smallexample | |
31173 | ||
31174 | Show terminal for future runs of program being debugged. | |
31175 | ||
31176 | @subheading @value{GDBN} Command | |
31177 | ||
31178 | The corresponding @value{GDBN} command is @samp{show inferior-tty}. | |
31179 | ||
31180 | @subheading Example | |
31181 | ||
31182 | @smallexample | |
594fe323 | 31183 | (gdb) |
ef21caaf NR |
31184 | -inferior-tty-set /dev/pts/1 |
31185 | ^done | |
594fe323 | 31186 | (gdb) |
ef21caaf NR |
31187 | -inferior-tty-show |
31188 | ^done,inferior_tty_terminal="/dev/pts/1" | |
594fe323 | 31189 | (gdb) |
ef21caaf | 31190 | @end smallexample |
922fbb7b | 31191 | |
a4eefcd8 NR |
31192 | @subheading The @code{-enable-timings} Command |
31193 | @findex -enable-timings | |
31194 | ||
31195 | @subheading Synopsis | |
31196 | ||
31197 | @smallexample | |
31198 | -enable-timings [yes | no] | |
31199 | @end smallexample | |
31200 | ||
31201 | Toggle the printing of the wallclock, user and system times for an MI | |
31202 | command as a field in its output. This command is to help frontend | |
31203 | developers optimize the performance of their code. No argument is | |
31204 | equivalent to @samp{yes}. | |
31205 | ||
31206 | @subheading @value{GDBN} Command | |
31207 | ||
31208 | No equivalent. | |
31209 | ||
31210 | @subheading Example | |
31211 | ||
31212 | @smallexample | |
31213 | (gdb) | |
31214 | -enable-timings | |
31215 | ^done | |
31216 | (gdb) | |
31217 | -break-insert main | |
31218 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", | |
31219 | addr="0x080484ed",func="main",file="myprog.c", | |
31220 | fullname="/home/nickrob/myprog.c",line="73",times="0"@}, | |
31221 | time=@{wallclock="0.05185",user="0.00800",system="0.00000"@} | |
31222 | (gdb) | |
31223 | -enable-timings no | |
31224 | ^done | |
31225 | (gdb) | |
31226 | -exec-run | |
31227 | ^running | |
31228 | (gdb) | |
a47ec5fe | 31229 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0", |
a4eefcd8 NR |
31230 | frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@}, |
31231 | @{name="argv",value="0xbfb60364"@}],file="myprog.c", | |
31232 | fullname="/home/nickrob/myprog.c",line="73"@} | |
31233 | (gdb) | |
31234 | @end smallexample | |
31235 | ||
922fbb7b AC |
31236 | @node Annotations |
31237 | @chapter @value{GDBN} Annotations | |
31238 | ||
086432e2 AC |
31239 | This chapter describes annotations in @value{GDBN}. Annotations were |
31240 | designed to interface @value{GDBN} to graphical user interfaces or other | |
31241 | similar programs which want to interact with @value{GDBN} at a | |
922fbb7b AC |
31242 | relatively high level. |
31243 | ||
d3e8051b | 31244 | The annotation mechanism has largely been superseded by @sc{gdb/mi} |
086432e2 AC |
31245 | (@pxref{GDB/MI}). |
31246 | ||
922fbb7b AC |
31247 | @ignore |
31248 | This is Edition @value{EDITION}, @value{DATE}. | |
31249 | @end ignore | |
31250 | ||
31251 | @menu | |
31252 | * Annotations Overview:: What annotations are; the general syntax. | |
9e6c4bd5 | 31253 | * Server Prefix:: Issuing a command without affecting user state. |
922fbb7b AC |
31254 | * Prompting:: Annotations marking @value{GDBN}'s need for input. |
31255 | * Errors:: Annotations for error messages. | |
922fbb7b AC |
31256 | * Invalidation:: Some annotations describe things now invalid. |
31257 | * Annotations for Running:: | |
31258 | Whether the program is running, how it stopped, etc. | |
31259 | * Source Annotations:: Annotations describing source code. | |
922fbb7b AC |
31260 | @end menu |
31261 | ||
31262 | @node Annotations Overview | |
31263 | @section What is an Annotation? | |
31264 | @cindex annotations | |
31265 | ||
922fbb7b AC |
31266 | Annotations start with a newline character, two @samp{control-z} |
31267 | characters, and the name of the annotation. If there is no additional | |
31268 | information associated with this annotation, the name of the annotation | |
31269 | is followed immediately by a newline. If there is additional | |
31270 | information, the name of the annotation is followed by a space, the | |
31271 | additional information, and a newline. The additional information | |
31272 | cannot contain newline characters. | |
31273 | ||
31274 | Any output not beginning with a newline and two @samp{control-z} | |
31275 | characters denotes literal output from @value{GDBN}. Currently there is | |
31276 | no need for @value{GDBN} to output a newline followed by two | |
31277 | @samp{control-z} characters, but if there was such a need, the | |
31278 | annotations could be extended with an @samp{escape} annotation which | |
31279 | means those three characters as output. | |
31280 | ||
086432e2 AC |
31281 | The annotation @var{level}, which is specified using the |
31282 | @option{--annotate} command line option (@pxref{Mode Options}), controls | |
31283 | how much information @value{GDBN} prints together with its prompt, | |
31284 | values of expressions, source lines, and other types of output. Level 0 | |
d3e8051b | 31285 | is for no annotations, level 1 is for use when @value{GDBN} is run as a |
086432e2 AC |
31286 | subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable |
31287 | for programs that control @value{GDBN}, and level 2 annotations have | |
31288 | been made obsolete (@pxref{Limitations, , Limitations of the Annotation | |
09d4efe1 EZ |
31289 | Interface, annotate, GDB's Obsolete Annotations}). |
31290 | ||
31291 | @table @code | |
31292 | @kindex set annotate | |
31293 | @item set annotate @var{level} | |
e09f16f9 | 31294 | The @value{GDBN} command @code{set annotate} sets the level of |
09d4efe1 | 31295 | annotations to the specified @var{level}. |
9c16f35a EZ |
31296 | |
31297 | @item show annotate | |
31298 | @kindex show annotate | |
31299 | Show the current annotation level. | |
09d4efe1 EZ |
31300 | @end table |
31301 | ||
31302 | This chapter describes level 3 annotations. | |
086432e2 | 31303 | |
922fbb7b AC |
31304 | A simple example of starting up @value{GDBN} with annotations is: |
31305 | ||
31306 | @smallexample | |
086432e2 AC |
31307 | $ @kbd{gdb --annotate=3} |
31308 | GNU gdb 6.0 | |
31309 | Copyright 2003 Free Software Foundation, Inc. | |
922fbb7b AC |
31310 | GDB is free software, covered by the GNU General Public License, |
31311 | and you are welcome to change it and/or distribute copies of it | |
31312 | under certain conditions. | |
31313 | Type "show copying" to see the conditions. | |
31314 | There is absolutely no warranty for GDB. Type "show warranty" | |
31315 | for details. | |
086432e2 | 31316 | This GDB was configured as "i386-pc-linux-gnu" |
922fbb7b AC |
31317 | |
31318 | ^Z^Zpre-prompt | |
f7dc1244 | 31319 | (@value{GDBP}) |
922fbb7b | 31320 | ^Z^Zprompt |
086432e2 | 31321 | @kbd{quit} |
922fbb7b AC |
31322 | |
31323 | ^Z^Zpost-prompt | |
b383017d | 31324 | $ |
922fbb7b AC |
31325 | @end smallexample |
31326 | ||
31327 | Here @samp{quit} is input to @value{GDBN}; the rest is output from | |
31328 | @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z} | |
31329 | denotes a @samp{control-z} character) are annotations; the rest is | |
31330 | output from @value{GDBN}. | |
31331 | ||
9e6c4bd5 NR |
31332 | @node Server Prefix |
31333 | @section The Server Prefix | |
31334 | @cindex server prefix | |
31335 | ||
31336 | If you prefix a command with @samp{server } then it will not affect | |
31337 | the command history, nor will it affect @value{GDBN}'s notion of which | |
31338 | command to repeat if @key{RET} is pressed on a line by itself. This | |
31339 | means that commands can be run behind a user's back by a front-end in | |
31340 | a transparent manner. | |
31341 | ||
d837706a NR |
31342 | The @code{server } prefix does not affect the recording of values into |
31343 | the value history; to print a value without recording it into the | |
31344 | value history, use the @code{output} command instead of the | |
31345 | @code{print} command. | |
31346 | ||
31347 | Using this prefix also disables confirmation requests | |
31348 | (@pxref{confirmation requests}). | |
9e6c4bd5 | 31349 | |
922fbb7b AC |
31350 | @node Prompting |
31351 | @section Annotation for @value{GDBN} Input | |
31352 | ||
31353 | @cindex annotations for prompts | |
31354 | When @value{GDBN} prompts for input, it annotates this fact so it is possible | |
31355 | to know when to send output, when the output from a given command is | |
31356 | over, etc. | |
31357 | ||
31358 | Different kinds of input each have a different @dfn{input type}. Each | |
31359 | input type has three annotations: a @code{pre-} annotation, which | |
31360 | denotes the beginning of any prompt which is being output, a plain | |
31361 | annotation, which denotes the end of the prompt, and then a @code{post-} | |
31362 | annotation which denotes the end of any echo which may (or may not) be | |
31363 | associated with the input. For example, the @code{prompt} input type | |
31364 | features the following annotations: | |
31365 | ||
31366 | @smallexample | |
31367 | ^Z^Zpre-prompt | |
31368 | ^Z^Zprompt | |
31369 | ^Z^Zpost-prompt | |
31370 | @end smallexample | |
31371 | ||
31372 | The input types are | |
31373 | ||
31374 | @table @code | |
e5ac9b53 EZ |
31375 | @findex pre-prompt annotation |
31376 | @findex prompt annotation | |
31377 | @findex post-prompt annotation | |
922fbb7b AC |
31378 | @item prompt |
31379 | When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt). | |
31380 | ||
e5ac9b53 EZ |
31381 | @findex pre-commands annotation |
31382 | @findex commands annotation | |
31383 | @findex post-commands annotation | |
922fbb7b AC |
31384 | @item commands |
31385 | When @value{GDBN} prompts for a set of commands, like in the @code{commands} | |
31386 | command. The annotations are repeated for each command which is input. | |
31387 | ||
e5ac9b53 EZ |
31388 | @findex pre-overload-choice annotation |
31389 | @findex overload-choice annotation | |
31390 | @findex post-overload-choice annotation | |
922fbb7b AC |
31391 | @item overload-choice |
31392 | When @value{GDBN} wants the user to select between various overloaded functions. | |
31393 | ||
e5ac9b53 EZ |
31394 | @findex pre-query annotation |
31395 | @findex query annotation | |
31396 | @findex post-query annotation | |
922fbb7b AC |
31397 | @item query |
31398 | When @value{GDBN} wants the user to confirm a potentially dangerous operation. | |
31399 | ||
e5ac9b53 EZ |
31400 | @findex pre-prompt-for-continue annotation |
31401 | @findex prompt-for-continue annotation | |
31402 | @findex post-prompt-for-continue annotation | |
922fbb7b AC |
31403 | @item prompt-for-continue |
31404 | When @value{GDBN} is asking the user to press return to continue. Note: Don't | |
31405 | expect this to work well; instead use @code{set height 0} to disable | |
31406 | prompting. This is because the counting of lines is buggy in the | |
31407 | presence of annotations. | |
31408 | @end table | |
31409 | ||
31410 | @node Errors | |
31411 | @section Errors | |
31412 | @cindex annotations for errors, warnings and interrupts | |
31413 | ||
e5ac9b53 | 31414 | @findex quit annotation |
922fbb7b AC |
31415 | @smallexample |
31416 | ^Z^Zquit | |
31417 | @end smallexample | |
31418 | ||
31419 | This annotation occurs right before @value{GDBN} responds to an interrupt. | |
31420 | ||
e5ac9b53 | 31421 | @findex error annotation |
922fbb7b AC |
31422 | @smallexample |
31423 | ^Z^Zerror | |
31424 | @end smallexample | |
31425 | ||
31426 | This annotation occurs right before @value{GDBN} responds to an error. | |
31427 | ||
31428 | Quit and error annotations indicate that any annotations which @value{GDBN} was | |
31429 | in the middle of may end abruptly. For example, if a | |
31430 | @code{value-history-begin} annotation is followed by a @code{error}, one | |
31431 | cannot expect to receive the matching @code{value-history-end}. One | |
31432 | cannot expect not to receive it either, however; an error annotation | |
31433 | does not necessarily mean that @value{GDBN} is immediately returning all the way | |
31434 | to the top level. | |
31435 | ||
e5ac9b53 | 31436 | @findex error-begin annotation |
922fbb7b AC |
31437 | A quit or error annotation may be preceded by |
31438 | ||
31439 | @smallexample | |
31440 | ^Z^Zerror-begin | |
31441 | @end smallexample | |
31442 | ||
31443 | Any output between that and the quit or error annotation is the error | |
31444 | message. | |
31445 | ||
31446 | Warning messages are not yet annotated. | |
31447 | @c If we want to change that, need to fix warning(), type_error(), | |
31448 | @c range_error(), and possibly other places. | |
31449 | ||
922fbb7b AC |
31450 | @node Invalidation |
31451 | @section Invalidation Notices | |
31452 | ||
31453 | @cindex annotations for invalidation messages | |
31454 | The following annotations say that certain pieces of state may have | |
31455 | changed. | |
31456 | ||
31457 | @table @code | |
e5ac9b53 | 31458 | @findex frames-invalid annotation |
922fbb7b AC |
31459 | @item ^Z^Zframes-invalid |
31460 | ||
31461 | The frames (for example, output from the @code{backtrace} command) may | |
31462 | have changed. | |
31463 | ||
e5ac9b53 | 31464 | @findex breakpoints-invalid annotation |
922fbb7b AC |
31465 | @item ^Z^Zbreakpoints-invalid |
31466 | ||
31467 | The breakpoints may have changed. For example, the user just added or | |
31468 | deleted a breakpoint. | |
31469 | @end table | |
31470 | ||
31471 | @node Annotations for Running | |
31472 | @section Running the Program | |
31473 | @cindex annotations for running programs | |
31474 | ||
e5ac9b53 EZ |
31475 | @findex starting annotation |
31476 | @findex stopping annotation | |
922fbb7b | 31477 | When the program starts executing due to a @value{GDBN} command such as |
b383017d | 31478 | @code{step} or @code{continue}, |
922fbb7b AC |
31479 | |
31480 | @smallexample | |
31481 | ^Z^Zstarting | |
31482 | @end smallexample | |
31483 | ||
b383017d | 31484 | is output. When the program stops, |
922fbb7b AC |
31485 | |
31486 | @smallexample | |
31487 | ^Z^Zstopped | |
31488 | @end smallexample | |
31489 | ||
31490 | is output. Before the @code{stopped} annotation, a variety of | |
31491 | annotations describe how the program stopped. | |
31492 | ||
31493 | @table @code | |
e5ac9b53 | 31494 | @findex exited annotation |
922fbb7b AC |
31495 | @item ^Z^Zexited @var{exit-status} |
31496 | The program exited, and @var{exit-status} is the exit status (zero for | |
31497 | successful exit, otherwise nonzero). | |
31498 | ||
e5ac9b53 EZ |
31499 | @findex signalled annotation |
31500 | @findex signal-name annotation | |
31501 | @findex signal-name-end annotation | |
31502 | @findex signal-string annotation | |
31503 | @findex signal-string-end annotation | |
922fbb7b AC |
31504 | @item ^Z^Zsignalled |
31505 | The program exited with a signal. After the @code{^Z^Zsignalled}, the | |
31506 | annotation continues: | |
31507 | ||
31508 | @smallexample | |
31509 | @var{intro-text} | |
31510 | ^Z^Zsignal-name | |
31511 | @var{name} | |
31512 | ^Z^Zsignal-name-end | |
31513 | @var{middle-text} | |
31514 | ^Z^Zsignal-string | |
31515 | @var{string} | |
31516 | ^Z^Zsignal-string-end | |
31517 | @var{end-text} | |
31518 | @end smallexample | |
31519 | ||
31520 | @noindent | |
31521 | where @var{name} is the name of the signal, such as @code{SIGILL} or | |
31522 | @code{SIGSEGV}, and @var{string} is the explanation of the signal, such | |
31523 | as @code{Illegal Instruction} or @code{Segmentation fault}. | |
31524 | @var{intro-text}, @var{middle-text}, and @var{end-text} are for the | |
31525 | user's benefit and have no particular format. | |
31526 | ||
e5ac9b53 | 31527 | @findex signal annotation |
922fbb7b AC |
31528 | @item ^Z^Zsignal |
31529 | The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is | |
31530 | just saying that the program received the signal, not that it was | |
31531 | terminated with it. | |
31532 | ||
e5ac9b53 | 31533 | @findex breakpoint annotation |
922fbb7b AC |
31534 | @item ^Z^Zbreakpoint @var{number} |
31535 | The program hit breakpoint number @var{number}. | |
31536 | ||
e5ac9b53 | 31537 | @findex watchpoint annotation |
922fbb7b AC |
31538 | @item ^Z^Zwatchpoint @var{number} |
31539 | The program hit watchpoint number @var{number}. | |
31540 | @end table | |
31541 | ||
31542 | @node Source Annotations | |
31543 | @section Displaying Source | |
31544 | @cindex annotations for source display | |
31545 | ||
e5ac9b53 | 31546 | @findex source annotation |
922fbb7b AC |
31547 | The following annotation is used instead of displaying source code: |
31548 | ||
31549 | @smallexample | |
31550 | ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr} | |
31551 | @end smallexample | |
31552 | ||
31553 | where @var{filename} is an absolute file name indicating which source | |
31554 | file, @var{line} is the line number within that file (where 1 is the | |
31555 | first line in the file), @var{character} is the character position | |
31556 | within the file (where 0 is the first character in the file) (for most | |
31557 | debug formats this will necessarily point to the beginning of a line), | |
31558 | @var{middle} is @samp{middle} if @var{addr} is in the middle of the | |
31559 | line, or @samp{beg} if @var{addr} is at the beginning of the line, and | |
31560 | @var{addr} is the address in the target program associated with the | |
31561 | source which is being displayed. @var{addr} is in the form @samp{0x} | |
31562 | followed by one or more lowercase hex digits (note that this does not | |
31563 | depend on the language). | |
31564 | ||
4efc6507 DE |
31565 | @node JIT Interface |
31566 | @chapter JIT Compilation Interface | |
31567 | @cindex just-in-time compilation | |
31568 | @cindex JIT compilation interface | |
31569 | ||
31570 | This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation | |
31571 | interface. A JIT compiler is a program or library that generates native | |
31572 | executable code at runtime and executes it, usually in order to achieve good | |
31573 | performance while maintaining platform independence. | |
31574 | ||
31575 | Programs that use JIT compilation are normally difficult to debug because | |
31576 | portions of their code are generated at runtime, instead of being loaded from | |
31577 | object files, which is where @value{GDBN} normally finds the program's symbols | |
31578 | and debug information. In order to debug programs that use JIT compilation, | |
31579 | @value{GDBN} has an interface that allows the program to register in-memory | |
31580 | symbol files with @value{GDBN} at runtime. | |
31581 | ||
31582 | If you are using @value{GDBN} to debug a program that uses this interface, then | |
31583 | it should work transparently so long as you have not stripped the binary. If | |
31584 | you are developing a JIT compiler, then the interface is documented in the rest | |
31585 | of this chapter. At this time, the only known client of this interface is the | |
31586 | LLVM JIT. | |
31587 | ||
31588 | Broadly speaking, the JIT interface mirrors the dynamic loader interface. The | |
31589 | JIT compiler communicates with @value{GDBN} by writing data into a global | |
31590 | variable and calling a fuction at a well-known symbol. When @value{GDBN} | |
31591 | attaches, it reads a linked list of symbol files from the global variable to | |
31592 | find existing code, and puts a breakpoint in the function so that it can find | |
31593 | out about additional code. | |
31594 | ||
31595 | @menu | |
31596 | * Declarations:: Relevant C struct declarations | |
31597 | * Registering Code:: Steps to register code | |
31598 | * Unregistering Code:: Steps to unregister code | |
31599 | @end menu | |
31600 | ||
31601 | @node Declarations | |
31602 | @section JIT Declarations | |
31603 | ||
31604 | These are the relevant struct declarations that a C program should include to | |
31605 | implement the interface: | |
31606 | ||
31607 | @smallexample | |
31608 | typedef enum | |
31609 | @{ | |
31610 | JIT_NOACTION = 0, | |
31611 | JIT_REGISTER_FN, | |
31612 | JIT_UNREGISTER_FN | |
31613 | @} jit_actions_t; | |
31614 | ||
31615 | struct jit_code_entry | |
31616 | @{ | |
31617 | struct jit_code_entry *next_entry; | |
31618 | struct jit_code_entry *prev_entry; | |
31619 | const char *symfile_addr; | |
31620 | uint64_t symfile_size; | |
31621 | @}; | |
31622 | ||
31623 | struct jit_descriptor | |
31624 | @{ | |
31625 | uint32_t version; | |
31626 | /* This type should be jit_actions_t, but we use uint32_t | |
31627 | to be explicit about the bitwidth. */ | |
31628 | uint32_t action_flag; | |
31629 | struct jit_code_entry *relevant_entry; | |
31630 | struct jit_code_entry *first_entry; | |
31631 | @}; | |
31632 | ||
31633 | /* GDB puts a breakpoint in this function. */ | |
31634 | void __attribute__((noinline)) __jit_debug_register_code() @{ @}; | |
31635 | ||
31636 | /* Make sure to specify the version statically, because the | |
31637 | debugger may check the version before we can set it. */ | |
31638 | struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @}; | |
31639 | @end smallexample | |
31640 | ||
31641 | If the JIT is multi-threaded, then it is important that the JIT synchronize any | |
31642 | modifications to this global data properly, which can easily be done by putting | |
31643 | a global mutex around modifications to these structures. | |
31644 | ||
31645 | @node Registering Code | |
31646 | @section Registering Code | |
31647 | ||
31648 | To register code with @value{GDBN}, the JIT should follow this protocol: | |
31649 | ||
31650 | @itemize @bullet | |
31651 | @item | |
31652 | Generate an object file in memory with symbols and other desired debug | |
31653 | information. The file must include the virtual addresses of the sections. | |
31654 | ||
31655 | @item | |
31656 | Create a code entry for the file, which gives the start and size of the symbol | |
31657 | file. | |
31658 | ||
31659 | @item | |
31660 | Add it to the linked list in the JIT descriptor. | |
31661 | ||
31662 | @item | |
31663 | Point the relevant_entry field of the descriptor at the entry. | |
31664 | ||
31665 | @item | |
31666 | Set @code{action_flag} to @code{JIT_REGISTER} and call | |
31667 | @code{__jit_debug_register_code}. | |
31668 | @end itemize | |
31669 | ||
31670 | When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the | |
31671 | @code{relevant_entry} pointer so it doesn't have to walk the list looking for | |
31672 | new code. However, the linked list must still be maintained in order to allow | |
31673 | @value{GDBN} to attach to a running process and still find the symbol files. | |
31674 | ||
31675 | @node Unregistering Code | |
31676 | @section Unregistering Code | |
31677 | ||
31678 | If code is freed, then the JIT should use the following protocol: | |
31679 | ||
31680 | @itemize @bullet | |
31681 | @item | |
31682 | Remove the code entry corresponding to the code from the linked list. | |
31683 | ||
31684 | @item | |
31685 | Point the @code{relevant_entry} field of the descriptor at the code entry. | |
31686 | ||
31687 | @item | |
31688 | Set @code{action_flag} to @code{JIT_UNREGISTER} and call | |
31689 | @code{__jit_debug_register_code}. | |
31690 | @end itemize | |
31691 | ||
31692 | If the JIT frees or recompiles code without unregistering it, then @value{GDBN} | |
31693 | and the JIT will leak the memory used for the associated symbol files. | |
31694 | ||
8e04817f AC |
31695 | @node GDB Bugs |
31696 | @chapter Reporting Bugs in @value{GDBN} | |
31697 | @cindex bugs in @value{GDBN} | |
31698 | @cindex reporting bugs in @value{GDBN} | |
c906108c | 31699 | |
8e04817f | 31700 | Your bug reports play an essential role in making @value{GDBN} reliable. |
c906108c | 31701 | |
8e04817f AC |
31702 | Reporting a bug may help you by bringing a solution to your problem, or it |
31703 | may not. But in any case the principal function of a bug report is to help | |
31704 | the entire community by making the next version of @value{GDBN} work better. Bug | |
31705 | reports are your contribution to the maintenance of @value{GDBN}. | |
c906108c | 31706 | |
8e04817f AC |
31707 | In order for a bug report to serve its purpose, you must include the |
31708 | information that enables us to fix the bug. | |
c4555f82 SC |
31709 | |
31710 | @menu | |
8e04817f AC |
31711 | * Bug Criteria:: Have you found a bug? |
31712 | * Bug Reporting:: How to report bugs | |
c4555f82 SC |
31713 | @end menu |
31714 | ||
8e04817f | 31715 | @node Bug Criteria |
79a6e687 | 31716 | @section Have You Found a Bug? |
8e04817f | 31717 | @cindex bug criteria |
c4555f82 | 31718 | |
8e04817f | 31719 | If you are not sure whether you have found a bug, here are some guidelines: |
c4555f82 SC |
31720 | |
31721 | @itemize @bullet | |
8e04817f AC |
31722 | @cindex fatal signal |
31723 | @cindex debugger crash | |
31724 | @cindex crash of debugger | |
c4555f82 | 31725 | @item |
8e04817f AC |
31726 | If the debugger gets a fatal signal, for any input whatever, that is a |
31727 | @value{GDBN} bug. Reliable debuggers never crash. | |
31728 | ||
31729 | @cindex error on valid input | |
31730 | @item | |
31731 | If @value{GDBN} produces an error message for valid input, that is a | |
31732 | bug. (Note that if you're cross debugging, the problem may also be | |
31733 | somewhere in the connection to the target.) | |
c4555f82 | 31734 | |
8e04817f | 31735 | @cindex invalid input |
c4555f82 | 31736 | @item |
8e04817f AC |
31737 | If @value{GDBN} does not produce an error message for invalid input, |
31738 | that is a bug. However, you should note that your idea of | |
31739 | ``invalid input'' might be our idea of ``an extension'' or ``support | |
31740 | for traditional practice''. | |
31741 | ||
31742 | @item | |
31743 | If you are an experienced user of debugging tools, your suggestions | |
31744 | for improvement of @value{GDBN} are welcome in any case. | |
c4555f82 SC |
31745 | @end itemize |
31746 | ||
8e04817f | 31747 | @node Bug Reporting |
79a6e687 | 31748 | @section How to Report Bugs |
8e04817f AC |
31749 | @cindex bug reports |
31750 | @cindex @value{GDBN} bugs, reporting | |
31751 | ||
31752 | A number of companies and individuals offer support for @sc{gnu} products. | |
31753 | If you obtained @value{GDBN} from a support organization, we recommend you | |
31754 | contact that organization first. | |
31755 | ||
31756 | You can find contact information for many support companies and | |
31757 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs | |
31758 | distribution. | |
31759 | @c should add a web page ref... | |
31760 | ||
c16158bc JM |
31761 | @ifset BUGURL |
31762 | @ifset BUGURL_DEFAULT | |
129188f6 | 31763 | In any event, we also recommend that you submit bug reports for |
d3e8051b | 31764 | @value{GDBN}. The preferred method is to submit them directly using |
129188f6 AC |
31765 | @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web |
31766 | page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can | |
31767 | be used. | |
8e04817f AC |
31768 | |
31769 | @strong{Do not send bug reports to @samp{info-gdb}, or to | |
31770 | @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do | |
31771 | not want to receive bug reports. Those that do have arranged to receive | |
31772 | @samp{bug-gdb}. | |
31773 | ||
31774 | The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which | |
31775 | serves as a repeater. The mailing list and the newsgroup carry exactly | |
31776 | the same messages. Often people think of posting bug reports to the | |
31777 | newsgroup instead of mailing them. This appears to work, but it has one | |
31778 | problem which can be crucial: a newsgroup posting often lacks a mail | |
31779 | path back to the sender. Thus, if we need to ask for more information, | |
31780 | we may be unable to reach you. For this reason, it is better to send | |
31781 | bug reports to the mailing list. | |
c16158bc JM |
31782 | @end ifset |
31783 | @ifclear BUGURL_DEFAULT | |
31784 | In any event, we also recommend that you submit bug reports for | |
31785 | @value{GDBN} to @value{BUGURL}. | |
31786 | @end ifclear | |
31787 | @end ifset | |
c4555f82 | 31788 | |
8e04817f AC |
31789 | The fundamental principle of reporting bugs usefully is this: |
31790 | @strong{report all the facts}. If you are not sure whether to state a | |
31791 | fact or leave it out, state it! | |
c4555f82 | 31792 | |
8e04817f AC |
31793 | Often people omit facts because they think they know what causes the |
31794 | problem and assume that some details do not matter. Thus, you might | |
31795 | assume that the name of the variable you use in an example does not matter. | |
31796 | Well, probably it does not, but one cannot be sure. Perhaps the bug is a | |
31797 | stray memory reference which happens to fetch from the location where that | |
31798 | name is stored in memory; perhaps, if the name were different, the contents | |
31799 | of that location would fool the debugger into doing the right thing despite | |
31800 | the bug. Play it safe and give a specific, complete example. That is the | |
31801 | easiest thing for you to do, and the most helpful. | |
c4555f82 | 31802 | |
8e04817f AC |
31803 | Keep in mind that the purpose of a bug report is to enable us to fix the |
31804 | bug. It may be that the bug has been reported previously, but neither | |
31805 | you nor we can know that unless your bug report is complete and | |
31806 | self-contained. | |
c4555f82 | 31807 | |
8e04817f AC |
31808 | Sometimes people give a few sketchy facts and ask, ``Does this ring a |
31809 | bell?'' Those bug reports are useless, and we urge everyone to | |
31810 | @emph{refuse to respond to them} except to chide the sender to report | |
31811 | bugs properly. | |
31812 | ||
31813 | To enable us to fix the bug, you should include all these things: | |
c4555f82 SC |
31814 | |
31815 | @itemize @bullet | |
31816 | @item | |
8e04817f AC |
31817 | The version of @value{GDBN}. @value{GDBN} announces it if you start |
31818 | with no arguments; you can also print it at any time using @code{show | |
31819 | version}. | |
c4555f82 | 31820 | |
8e04817f AC |
31821 | Without this, we will not know whether there is any point in looking for |
31822 | the bug in the current version of @value{GDBN}. | |
c4555f82 SC |
31823 | |
31824 | @item | |
8e04817f AC |
31825 | The type of machine you are using, and the operating system name and |
31826 | version number. | |
c4555f82 SC |
31827 | |
31828 | @item | |
c1468174 | 31829 | What compiler (and its version) was used to compile @value{GDBN}---e.g.@: |
8e04817f | 31830 | ``@value{GCC}--2.8.1''. |
c4555f82 SC |
31831 | |
31832 | @item | |
8e04817f | 31833 | What compiler (and its version) was used to compile the program you are |
c1468174 | 31834 | debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP |
3f94c067 BW |
31835 | C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version} |
31836 | to get this information; for other compilers, see the documentation for | |
31837 | those compilers. | |
c4555f82 | 31838 | |
8e04817f AC |
31839 | @item |
31840 | The command arguments you gave the compiler to compile your example and | |
31841 | observe the bug. For example, did you use @samp{-O}? To guarantee | |
31842 | you will not omit something important, list them all. A copy of the | |
31843 | Makefile (or the output from make) is sufficient. | |
c4555f82 | 31844 | |
8e04817f AC |
31845 | If we were to try to guess the arguments, we would probably guess wrong |
31846 | and then we might not encounter the bug. | |
c4555f82 | 31847 | |
8e04817f AC |
31848 | @item |
31849 | A complete input script, and all necessary source files, that will | |
31850 | reproduce the bug. | |
c4555f82 | 31851 | |
8e04817f AC |
31852 | @item |
31853 | A description of what behavior you observe that you believe is | |
31854 | incorrect. For example, ``It gets a fatal signal.'' | |
c4555f82 | 31855 | |
8e04817f AC |
31856 | Of course, if the bug is that @value{GDBN} gets a fatal signal, then we |
31857 | will certainly notice it. But if the bug is incorrect output, we might | |
31858 | not notice unless it is glaringly wrong. You might as well not give us | |
31859 | a chance to make a mistake. | |
c4555f82 | 31860 | |
8e04817f AC |
31861 | Even if the problem you experience is a fatal signal, you should still |
31862 | say so explicitly. Suppose something strange is going on, such as, your | |
31863 | copy of @value{GDBN} is out of synch, or you have encountered a bug in | |
31864 | the C library on your system. (This has happened!) Your copy might | |
31865 | crash and ours would not. If you told us to expect a crash, then when | |
31866 | ours fails to crash, we would know that the bug was not happening for | |
31867 | us. If you had not told us to expect a crash, then we would not be able | |
31868 | to draw any conclusion from our observations. | |
c4555f82 | 31869 | |
e0c07bf0 MC |
31870 | @pindex script |
31871 | @cindex recording a session script | |
31872 | To collect all this information, you can use a session recording program | |
31873 | such as @command{script}, which is available on many Unix systems. | |
31874 | Just run your @value{GDBN} session inside @command{script} and then | |
31875 | include the @file{typescript} file with your bug report. | |
31876 | ||
31877 | Another way to record a @value{GDBN} session is to run @value{GDBN} | |
31878 | inside Emacs and then save the entire buffer to a file. | |
31879 | ||
8e04817f AC |
31880 | @item |
31881 | If you wish to suggest changes to the @value{GDBN} source, send us context | |
31882 | diffs. If you even discuss something in the @value{GDBN} source, refer to | |
31883 | it by context, not by line number. | |
c4555f82 | 31884 | |
8e04817f AC |
31885 | The line numbers in our development sources will not match those in your |
31886 | sources. Your line numbers would convey no useful information to us. | |
c4555f82 | 31887 | |
8e04817f | 31888 | @end itemize |
c4555f82 | 31889 | |
8e04817f | 31890 | Here are some things that are not necessary: |
c4555f82 | 31891 | |
8e04817f AC |
31892 | @itemize @bullet |
31893 | @item | |
31894 | A description of the envelope of the bug. | |
c4555f82 | 31895 | |
8e04817f AC |
31896 | Often people who encounter a bug spend a lot of time investigating |
31897 | which changes to the input file will make the bug go away and which | |
31898 | changes will not affect it. | |
c4555f82 | 31899 | |
8e04817f AC |
31900 | This is often time consuming and not very useful, because the way we |
31901 | will find the bug is by running a single example under the debugger | |
31902 | with breakpoints, not by pure deduction from a series of examples. | |
31903 | We recommend that you save your time for something else. | |
c4555f82 | 31904 | |
8e04817f AC |
31905 | Of course, if you can find a simpler example to report @emph{instead} |
31906 | of the original one, that is a convenience for us. Errors in the | |
31907 | output will be easier to spot, running under the debugger will take | |
31908 | less time, and so on. | |
c4555f82 | 31909 | |
8e04817f AC |
31910 | However, simplification is not vital; if you do not want to do this, |
31911 | report the bug anyway and send us the entire test case you used. | |
c4555f82 | 31912 | |
8e04817f AC |
31913 | @item |
31914 | A patch for the bug. | |
c4555f82 | 31915 | |
8e04817f AC |
31916 | A patch for the bug does help us if it is a good one. But do not omit |
31917 | the necessary information, such as the test case, on the assumption that | |
31918 | a patch is all we need. We might see problems with your patch and decide | |
31919 | to fix the problem another way, or we might not understand it at all. | |
c4555f82 | 31920 | |
8e04817f AC |
31921 | Sometimes with a program as complicated as @value{GDBN} it is very hard to |
31922 | construct an example that will make the program follow a certain path | |
31923 | through the code. If you do not send us the example, we will not be able | |
31924 | to construct one, so we will not be able to verify that the bug is fixed. | |
c4555f82 | 31925 | |
8e04817f AC |
31926 | And if we cannot understand what bug you are trying to fix, or why your |
31927 | patch should be an improvement, we will not install it. A test case will | |
31928 | help us to understand. | |
c4555f82 | 31929 | |
8e04817f AC |
31930 | @item |
31931 | A guess about what the bug is or what it depends on. | |
c4555f82 | 31932 | |
8e04817f AC |
31933 | Such guesses are usually wrong. Even we cannot guess right about such |
31934 | things without first using the debugger to find the facts. | |
31935 | @end itemize | |
c4555f82 | 31936 | |
8e04817f AC |
31937 | @c The readline documentation is distributed with the readline code |
31938 | @c and consists of the two following files: | |
cc88a640 JK |
31939 | @c rluser.texi |
31940 | @c hsuser.texi | |
8e04817f AC |
31941 | @c Use -I with makeinfo to point to the appropriate directory, |
31942 | @c environment var TEXINPUTS with TeX. | |
39037522 | 31943 | @ifclear SYSTEM_READLINE |
5bdf8622 | 31944 | @include rluser.texi |
cc88a640 | 31945 | @include hsuser.texi |
39037522 | 31946 | @end ifclear |
c4555f82 | 31947 | |
4ceed123 JB |
31948 | @node In Memoriam |
31949 | @appendix In Memoriam | |
31950 | ||
9ed350ad JB |
31951 | The @value{GDBN} project mourns the loss of the following long-time |
31952 | contributors: | |
4ceed123 JB |
31953 | |
31954 | @table @code | |
31955 | @item Fred Fish | |
9ed350ad JB |
31956 | Fred was a long-standing contributor to @value{GDBN} (1991-2006), and |
31957 | to Free Software in general. Outside of @value{GDBN}, he was known in | |
31958 | the Amiga world for his series of Fish Disks, and the GeekGadget project. | |
4ceed123 JB |
31959 | |
31960 | @item Michael Snyder | |
9ed350ad JB |
31961 | Michael was one of the Global Maintainers of the @value{GDBN} project, |
31962 | with contributions recorded as early as 1996, until 2011. In addition | |
31963 | to his day to day participation, he was a large driving force behind | |
31964 | adding Reverse Debugging to @value{GDBN}. | |
4ceed123 JB |
31965 | @end table |
31966 | ||
31967 | Beyond their technical contributions to the project, they were also | |
31968 | enjoyable members of the Free Software Community. We will miss them. | |
c4555f82 | 31969 | |
8e04817f AC |
31970 | @node Formatting Documentation |
31971 | @appendix Formatting Documentation | |
c4555f82 | 31972 | |
8e04817f AC |
31973 | @cindex @value{GDBN} reference card |
31974 | @cindex reference card | |
31975 | The @value{GDBN} 4 release includes an already-formatted reference card, ready | |
31976 | for printing with PostScript or Ghostscript, in the @file{gdb} | |
31977 | subdirectory of the main source directory@footnote{In | |
31978 | @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN} | |
31979 | release.}. If you can use PostScript or Ghostscript with your printer, | |
31980 | you can print the reference card immediately with @file{refcard.ps}. | |
c4555f82 | 31981 | |
8e04817f AC |
31982 | The release also includes the source for the reference card. You |
31983 | can format it, using @TeX{}, by typing: | |
c4555f82 | 31984 | |
474c8240 | 31985 | @smallexample |
8e04817f | 31986 | make refcard.dvi |
474c8240 | 31987 | @end smallexample |
c4555f82 | 31988 | |
8e04817f AC |
31989 | The @value{GDBN} reference card is designed to print in @dfn{landscape} |
31990 | mode on US ``letter'' size paper; | |
31991 | that is, on a sheet 11 inches wide by 8.5 inches | |
31992 | high. You will need to specify this form of printing as an option to | |
31993 | your @sc{dvi} output program. | |
c4555f82 | 31994 | |
8e04817f | 31995 | @cindex documentation |
c4555f82 | 31996 | |
8e04817f AC |
31997 | All the documentation for @value{GDBN} comes as part of the machine-readable |
31998 | distribution. The documentation is written in Texinfo format, which is | |
31999 | a documentation system that uses a single source file to produce both | |
32000 | on-line information and a printed manual. You can use one of the Info | |
32001 | formatting commands to create the on-line version of the documentation | |
32002 | and @TeX{} (or @code{texi2roff}) to typeset the printed version. | |
c4555f82 | 32003 | |
8e04817f AC |
32004 | @value{GDBN} includes an already formatted copy of the on-line Info |
32005 | version of this manual in the @file{gdb} subdirectory. The main Info | |
32006 | file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to | |
32007 | subordinate files matching @samp{gdb.info*} in the same directory. If | |
32008 | necessary, you can print out these files, or read them with any editor; | |
32009 | but they are easier to read using the @code{info} subsystem in @sc{gnu} | |
32010 | Emacs or the standalone @code{info} program, available as part of the | |
32011 | @sc{gnu} Texinfo distribution. | |
c4555f82 | 32012 | |
8e04817f AC |
32013 | If you want to format these Info files yourself, you need one of the |
32014 | Info formatting programs, such as @code{texinfo-format-buffer} or | |
32015 | @code{makeinfo}. | |
c4555f82 | 32016 | |
8e04817f AC |
32017 | If you have @code{makeinfo} installed, and are in the top level |
32018 | @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of | |
32019 | version @value{GDBVN}), you can make the Info file by typing: | |
c4555f82 | 32020 | |
474c8240 | 32021 | @smallexample |
8e04817f AC |
32022 | cd gdb |
32023 | make gdb.info | |
474c8240 | 32024 | @end smallexample |
c4555f82 | 32025 | |
8e04817f AC |
32026 | If you want to typeset and print copies of this manual, you need @TeX{}, |
32027 | a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the | |
32028 | Texinfo definitions file. | |
c4555f82 | 32029 | |
8e04817f AC |
32030 | @TeX{} is a typesetting program; it does not print files directly, but |
32031 | produces output files called @sc{dvi} files. To print a typeset | |
32032 | document, you need a program to print @sc{dvi} files. If your system | |
32033 | has @TeX{} installed, chances are it has such a program. The precise | |
32034 | command to use depends on your system; @kbd{lpr -d} is common; another | |
32035 | (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may | |
32036 | require a file name without any extension or a @samp{.dvi} extension. | |
c4555f82 | 32037 | |
8e04817f AC |
32038 | @TeX{} also requires a macro definitions file called |
32039 | @file{texinfo.tex}. This file tells @TeX{} how to typeset a document | |
32040 | written in Texinfo format. On its own, @TeX{} cannot either read or | |
32041 | typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB | |
32042 | and is located in the @file{gdb-@var{version-number}/texinfo} | |
32043 | directory. | |
c4555f82 | 32044 | |
8e04817f | 32045 | If you have @TeX{} and a @sc{dvi} printer program installed, you can |
d3e8051b | 32046 | typeset and print this manual. First switch to the @file{gdb} |
8e04817f AC |
32047 | subdirectory of the main source directory (for example, to |
32048 | @file{gdb-@value{GDBVN}/gdb}) and type: | |
c4555f82 | 32049 | |
474c8240 | 32050 | @smallexample |
8e04817f | 32051 | make gdb.dvi |
474c8240 | 32052 | @end smallexample |
c4555f82 | 32053 | |
8e04817f | 32054 | Then give @file{gdb.dvi} to your @sc{dvi} printing program. |
c4555f82 | 32055 | |
8e04817f AC |
32056 | @node Installing GDB |
32057 | @appendix Installing @value{GDBN} | |
8e04817f | 32058 | @cindex installation |
c4555f82 | 32059 | |
7fa2210b DJ |
32060 | @menu |
32061 | * Requirements:: Requirements for building @value{GDBN} | |
db2e3e2e | 32062 | * Running Configure:: Invoking the @value{GDBN} @file{configure} script |
7fa2210b DJ |
32063 | * Separate Objdir:: Compiling @value{GDBN} in another directory |
32064 | * Config Names:: Specifying names for hosts and targets | |
32065 | * Configure Options:: Summary of options for configure | |
098b41a6 | 32066 | * System-wide configuration:: Having a system-wide init file |
7fa2210b DJ |
32067 | @end menu |
32068 | ||
32069 | @node Requirements | |
79a6e687 | 32070 | @section Requirements for Building @value{GDBN} |
7fa2210b DJ |
32071 | @cindex building @value{GDBN}, requirements for |
32072 | ||
32073 | Building @value{GDBN} requires various tools and packages to be available. | |
32074 | Other packages will be used only if they are found. | |
32075 | ||
79a6e687 | 32076 | @heading Tools/Packages Necessary for Building @value{GDBN} |
7fa2210b DJ |
32077 | @table @asis |
32078 | @item ISO C90 compiler | |
32079 | @value{GDBN} is written in ISO C90. It should be buildable with any | |
32080 | working C90 compiler, e.g.@: GCC. | |
32081 | ||
32082 | @end table | |
32083 | ||
79a6e687 | 32084 | @heading Tools/Packages Optional for Building @value{GDBN} |
7fa2210b DJ |
32085 | @table @asis |
32086 | @item Expat | |
123dc839 | 32087 | @anchor{Expat} |
7fa2210b DJ |
32088 | @value{GDBN} can use the Expat XML parsing library. This library may be |
32089 | included with your operating system distribution; if it is not, you | |
32090 | can get the latest version from @url{http://expat.sourceforge.net}. | |
db2e3e2e | 32091 | The @file{configure} script will search for this library in several |
7fa2210b DJ |
32092 | standard locations; if it is installed in an unusual path, you can |
32093 | use the @option{--with-libexpat-prefix} option to specify its location. | |
32094 | ||
9cceb671 DJ |
32095 | Expat is used for: |
32096 | ||
32097 | @itemize @bullet | |
32098 | @item | |
32099 | Remote protocol memory maps (@pxref{Memory Map Format}) | |
32100 | @item | |
32101 | Target descriptions (@pxref{Target Descriptions}) | |
32102 | @item | |
32103 | Remote shared library lists (@pxref{Library List Format}) | |
32104 | @item | |
32105 | MS-Windows shared libraries (@pxref{Shared Libraries}) | |
b3b9301e PA |
32106 | @item |
32107 | Traceframe info (@pxref{Traceframe Info Format}) | |
9cceb671 | 32108 | @end itemize |
7fa2210b | 32109 | |
31fffb02 CS |
32110 | @item zlib |
32111 | @cindex compressed debug sections | |
32112 | @value{GDBN} will use the @samp{zlib} library, if available, to read | |
32113 | compressed debug sections. Some linkers, such as GNU gold, are capable | |
32114 | of producing binaries with compressed debug sections. If @value{GDBN} | |
32115 | is compiled with @samp{zlib}, it will be able to read the debug | |
32116 | information in such binaries. | |
32117 | ||
32118 | The @samp{zlib} library is likely included with your operating system | |
32119 | distribution; if it is not, you can get the latest version from | |
32120 | @url{http://zlib.net}. | |
32121 | ||
6c7a06a3 TT |
32122 | @item iconv |
32123 | @value{GDBN}'s features related to character sets (@pxref{Character | |
32124 | Sets}) require a functioning @code{iconv} implementation. If you are | |
32125 | on a GNU system, then this is provided by the GNU C Library. Some | |
32126 | other systems also provide a working @code{iconv}. | |
32127 | ||
478aac75 DE |
32128 | If @value{GDBN} is using the @code{iconv} program which is installed |
32129 | in a non-standard place, you will need to tell @value{GDBN} where to find it. | |
32130 | This is done with @option{--with-iconv-bin} which specifies the | |
32131 | directory that contains the @code{iconv} program. | |
32132 | ||
32133 | On systems without @code{iconv}, you can install GNU Libiconv. If you | |
6c7a06a3 TT |
32134 | have previously installed Libiconv, you can use the |
32135 | @option{--with-libiconv-prefix} option to configure. | |
32136 | ||
32137 | @value{GDBN}'s top-level @file{configure} and @file{Makefile} will | |
32138 | arrange to build Libiconv if a directory named @file{libiconv} appears | |
32139 | in the top-most source directory. If Libiconv is built this way, and | |
32140 | if the operating system does not provide a suitable @code{iconv} | |
32141 | implementation, then the just-built library will automatically be used | |
32142 | by @value{GDBN}. One easy way to set this up is to download GNU | |
32143 | Libiconv, unpack it, and then rename the directory holding the | |
32144 | Libiconv source code to @samp{libiconv}. | |
7fa2210b DJ |
32145 | @end table |
32146 | ||
32147 | @node Running Configure | |
db2e3e2e | 32148 | @section Invoking the @value{GDBN} @file{configure} Script |
7fa2210b | 32149 | @cindex configuring @value{GDBN} |
db2e3e2e | 32150 | @value{GDBN} comes with a @file{configure} script that automates the process |
8e04817f AC |
32151 | of preparing @value{GDBN} for installation; you can then use @code{make} to |
32152 | build the @code{gdb} program. | |
32153 | @iftex | |
32154 | @c irrelevant in info file; it's as current as the code it lives with. | |
32155 | @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN}, | |
32156 | look at the @file{README} file in the sources; we may have improved the | |
32157 | installation procedures since publishing this manual.} | |
32158 | @end iftex | |
c4555f82 | 32159 | |
8e04817f AC |
32160 | The @value{GDBN} distribution includes all the source code you need for |
32161 | @value{GDBN} in a single directory, whose name is usually composed by | |
32162 | appending the version number to @samp{gdb}. | |
c4555f82 | 32163 | |
8e04817f AC |
32164 | For example, the @value{GDBN} version @value{GDBVN} distribution is in the |
32165 | @file{gdb-@value{GDBVN}} directory. That directory contains: | |
c4555f82 | 32166 | |
8e04817f AC |
32167 | @table @code |
32168 | @item gdb-@value{GDBVN}/configure @r{(and supporting files)} | |
32169 | script for configuring @value{GDBN} and all its supporting libraries | |
c4555f82 | 32170 | |
8e04817f AC |
32171 | @item gdb-@value{GDBVN}/gdb |
32172 | the source specific to @value{GDBN} itself | |
c4555f82 | 32173 | |
8e04817f AC |
32174 | @item gdb-@value{GDBVN}/bfd |
32175 | source for the Binary File Descriptor library | |
c906108c | 32176 | |
8e04817f AC |
32177 | @item gdb-@value{GDBVN}/include |
32178 | @sc{gnu} include files | |
c906108c | 32179 | |
8e04817f AC |
32180 | @item gdb-@value{GDBVN}/libiberty |
32181 | source for the @samp{-liberty} free software library | |
c906108c | 32182 | |
8e04817f AC |
32183 | @item gdb-@value{GDBVN}/opcodes |
32184 | source for the library of opcode tables and disassemblers | |
c906108c | 32185 | |
8e04817f AC |
32186 | @item gdb-@value{GDBVN}/readline |
32187 | source for the @sc{gnu} command-line interface | |
c906108c | 32188 | |
8e04817f AC |
32189 | @item gdb-@value{GDBVN}/glob |
32190 | source for the @sc{gnu} filename pattern-matching subroutine | |
c906108c | 32191 | |
8e04817f AC |
32192 | @item gdb-@value{GDBVN}/mmalloc |
32193 | source for the @sc{gnu} memory-mapped malloc package | |
32194 | @end table | |
c906108c | 32195 | |
db2e3e2e | 32196 | The simplest way to configure and build @value{GDBN} is to run @file{configure} |
8e04817f AC |
32197 | from the @file{gdb-@var{version-number}} source directory, which in |
32198 | this example is the @file{gdb-@value{GDBVN}} directory. | |
c906108c | 32199 | |
8e04817f | 32200 | First switch to the @file{gdb-@var{version-number}} source directory |
db2e3e2e | 32201 | if you are not already in it; then run @file{configure}. Pass the |
8e04817f AC |
32202 | identifier for the platform on which @value{GDBN} will run as an |
32203 | argument. | |
c906108c | 32204 | |
8e04817f | 32205 | For example: |
c906108c | 32206 | |
474c8240 | 32207 | @smallexample |
8e04817f AC |
32208 | cd gdb-@value{GDBVN} |
32209 | ./configure @var{host} | |
32210 | make | |
474c8240 | 32211 | @end smallexample |
c906108c | 32212 | |
8e04817f AC |
32213 | @noindent |
32214 | where @var{host} is an identifier such as @samp{sun4} or | |
32215 | @samp{decstation}, that identifies the platform where @value{GDBN} will run. | |
db2e3e2e | 32216 | (You can often leave off @var{host}; @file{configure} tries to guess the |
8e04817f | 32217 | correct value by examining your system.) |
c906108c | 32218 | |
8e04817f AC |
32219 | Running @samp{configure @var{host}} and then running @code{make} builds the |
32220 | @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty} | |
32221 | libraries, then @code{gdb} itself. The configured source files, and the | |
32222 | binaries, are left in the corresponding source directories. | |
c906108c | 32223 | |
8e04817f | 32224 | @need 750 |
db2e3e2e | 32225 | @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your |
8e04817f AC |
32226 | system does not recognize this automatically when you run a different |
32227 | shell, you may need to run @code{sh} on it explicitly: | |
c906108c | 32228 | |
474c8240 | 32229 | @smallexample |
8e04817f | 32230 | sh configure @var{host} |
474c8240 | 32231 | @end smallexample |
c906108c | 32232 | |
db2e3e2e | 32233 | If you run @file{configure} from a directory that contains source |
8e04817f | 32234 | directories for multiple libraries or programs, such as the |
db2e3e2e BW |
32235 | @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN}, |
32236 | @file{configure} | |
8e04817f AC |
32237 | creates configuration files for every directory level underneath (unless |
32238 | you tell it not to, with the @samp{--norecursion} option). | |
32239 | ||
db2e3e2e | 32240 | You should run the @file{configure} script from the top directory in the |
94e91d6d | 32241 | source tree, the @file{gdb-@var{version-number}} directory. If you run |
db2e3e2e | 32242 | @file{configure} from one of the subdirectories, you will configure only |
94e91d6d | 32243 | that subdirectory. That is usually not what you want. In particular, |
db2e3e2e | 32244 | if you run the first @file{configure} from the @file{gdb} subdirectory |
94e91d6d MC |
32245 | of the @file{gdb-@var{version-number}} directory, you will omit the |
32246 | configuration of @file{bfd}, @file{readline}, and other sibling | |
32247 | directories of the @file{gdb} subdirectory. This leads to build errors | |
32248 | about missing include files such as @file{bfd/bfd.h}. | |
c906108c | 32249 | |
8e04817f AC |
32250 | You can install @code{@value{GDBP}} anywhere; it has no hardwired paths. |
32251 | However, you should make sure that the shell on your path (named by | |
32252 | the @samp{SHELL} environment variable) is publicly readable. Remember | |
32253 | that @value{GDBN} uses the shell to start your program---some systems refuse to | |
32254 | let @value{GDBN} debug child processes whose programs are not readable. | |
c906108c | 32255 | |
8e04817f | 32256 | @node Separate Objdir |
79a6e687 | 32257 | @section Compiling @value{GDBN} in Another Directory |
c906108c | 32258 | |
8e04817f AC |
32259 | If you want to run @value{GDBN} versions for several host or target machines, |
32260 | you need a different @code{gdb} compiled for each combination of | |
db2e3e2e | 32261 | host and target. @file{configure} is designed to make this easy by |
8e04817f AC |
32262 | allowing you to generate each configuration in a separate subdirectory, |
32263 | rather than in the source directory. If your @code{make} program | |
32264 | handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running | |
32265 | @code{make} in each of these directories builds the @code{gdb} | |
32266 | program specified there. | |
c906108c | 32267 | |
db2e3e2e | 32268 | To build @code{gdb} in a separate directory, run @file{configure} |
8e04817f | 32269 | with the @samp{--srcdir} option to specify where to find the source. |
db2e3e2e BW |
32270 | (You also need to specify a path to find @file{configure} |
32271 | itself from your working directory. If the path to @file{configure} | |
8e04817f AC |
32272 | would be the same as the argument to @samp{--srcdir}, you can leave out |
32273 | the @samp{--srcdir} option; it is assumed.) | |
c906108c | 32274 | |
8e04817f AC |
32275 | For example, with version @value{GDBVN}, you can build @value{GDBN} in a |
32276 | separate directory for a Sun 4 like this: | |
c906108c | 32277 | |
474c8240 | 32278 | @smallexample |
8e04817f AC |
32279 | @group |
32280 | cd gdb-@value{GDBVN} | |
32281 | mkdir ../gdb-sun4 | |
32282 | cd ../gdb-sun4 | |
32283 | ../gdb-@value{GDBVN}/configure sun4 | |
32284 | make | |
32285 | @end group | |
474c8240 | 32286 | @end smallexample |
c906108c | 32287 | |
db2e3e2e | 32288 | When @file{configure} builds a configuration using a remote source |
8e04817f AC |
32289 | directory, it creates a tree for the binaries with the same structure |
32290 | (and using the same names) as the tree under the source directory. In | |
32291 | the example, you'd find the Sun 4 library @file{libiberty.a} in the | |
32292 | directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in | |
32293 | @file{gdb-sun4/gdb}. | |
c906108c | 32294 | |
94e91d6d MC |
32295 | Make sure that your path to the @file{configure} script has just one |
32296 | instance of @file{gdb} in it. If your path to @file{configure} looks | |
32297 | like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only | |
32298 | one subdirectory of @value{GDBN}, not the whole package. This leads to | |
32299 | build errors about missing include files such as @file{bfd/bfd.h}. | |
32300 | ||
8e04817f AC |
32301 | One popular reason to build several @value{GDBN} configurations in separate |
32302 | directories is to configure @value{GDBN} for cross-compiling (where | |
32303 | @value{GDBN} runs on one machine---the @dfn{host}---while debugging | |
32304 | programs that run on another machine---the @dfn{target}). | |
32305 | You specify a cross-debugging target by | |
db2e3e2e | 32306 | giving the @samp{--target=@var{target}} option to @file{configure}. |
c906108c | 32307 | |
8e04817f AC |
32308 | When you run @code{make} to build a program or library, you must run |
32309 | it in a configured directory---whatever directory you were in when you | |
db2e3e2e | 32310 | called @file{configure} (or one of its subdirectories). |
c906108c | 32311 | |
db2e3e2e | 32312 | The @code{Makefile} that @file{configure} generates in each source |
8e04817f AC |
32313 | directory also runs recursively. If you type @code{make} in a source |
32314 | directory such as @file{gdb-@value{GDBVN}} (or in a separate configured | |
32315 | directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you | |
32316 | will build all the required libraries, and then build GDB. | |
c906108c | 32317 | |
8e04817f AC |
32318 | When you have multiple hosts or targets configured in separate |
32319 | directories, you can run @code{make} on them in parallel (for example, | |
32320 | if they are NFS-mounted on each of the hosts); they will not interfere | |
32321 | with each other. | |
c906108c | 32322 | |
8e04817f | 32323 | @node Config Names |
79a6e687 | 32324 | @section Specifying Names for Hosts and Targets |
c906108c | 32325 | |
db2e3e2e | 32326 | The specifications used for hosts and targets in the @file{configure} |
8e04817f AC |
32327 | script are based on a three-part naming scheme, but some short predefined |
32328 | aliases are also supported. The full naming scheme encodes three pieces | |
32329 | of information in the following pattern: | |
c906108c | 32330 | |
474c8240 | 32331 | @smallexample |
8e04817f | 32332 | @var{architecture}-@var{vendor}-@var{os} |
474c8240 | 32333 | @end smallexample |
c906108c | 32334 | |
8e04817f AC |
32335 | For example, you can use the alias @code{sun4} as a @var{host} argument, |
32336 | or as the value for @var{target} in a @code{--target=@var{target}} | |
32337 | option. The equivalent full name is @samp{sparc-sun-sunos4}. | |
c906108c | 32338 | |
db2e3e2e | 32339 | The @file{configure} script accompanying @value{GDBN} does not provide |
8e04817f | 32340 | any query facility to list all supported host and target names or |
db2e3e2e | 32341 | aliases. @file{configure} calls the Bourne shell script |
8e04817f AC |
32342 | @code{config.sub} to map abbreviations to full names; you can read the |
32343 | script, if you wish, or you can use it to test your guesses on | |
32344 | abbreviations---for example: | |
c906108c | 32345 | |
8e04817f AC |
32346 | @smallexample |
32347 | % sh config.sub i386-linux | |
32348 | i386-pc-linux-gnu | |
32349 | % sh config.sub alpha-linux | |
32350 | alpha-unknown-linux-gnu | |
32351 | % sh config.sub hp9k700 | |
32352 | hppa1.1-hp-hpux | |
32353 | % sh config.sub sun4 | |
32354 | sparc-sun-sunos4.1.1 | |
32355 | % sh config.sub sun3 | |
32356 | m68k-sun-sunos4.1.1 | |
32357 | % sh config.sub i986v | |
32358 | Invalid configuration `i986v': machine `i986v' not recognized | |
32359 | @end smallexample | |
c906108c | 32360 | |
8e04817f AC |
32361 | @noindent |
32362 | @code{config.sub} is also distributed in the @value{GDBN} source | |
32363 | directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}). | |
d700128c | 32364 | |
8e04817f | 32365 | @node Configure Options |
db2e3e2e | 32366 | @section @file{configure} Options |
c906108c | 32367 | |
db2e3e2e BW |
32368 | Here is a summary of the @file{configure} options and arguments that |
32369 | are most often useful for building @value{GDBN}. @file{configure} also has | |
8e04817f | 32370 | several other options not listed here. @inforef{What Configure |
db2e3e2e | 32371 | Does,,configure.info}, for a full explanation of @file{configure}. |
c906108c | 32372 | |
474c8240 | 32373 | @smallexample |
8e04817f AC |
32374 | configure @r{[}--help@r{]} |
32375 | @r{[}--prefix=@var{dir}@r{]} | |
32376 | @r{[}--exec-prefix=@var{dir}@r{]} | |
32377 | @r{[}--srcdir=@var{dirname}@r{]} | |
32378 | @r{[}--norecursion@r{]} @r{[}--rm@r{]} | |
32379 | @r{[}--target=@var{target}@r{]} | |
32380 | @var{host} | |
474c8240 | 32381 | @end smallexample |
c906108c | 32382 | |
8e04817f AC |
32383 | @noindent |
32384 | You may introduce options with a single @samp{-} rather than | |
32385 | @samp{--} if you prefer; but you may abbreviate option names if you use | |
32386 | @samp{--}. | |
c906108c | 32387 | |
8e04817f AC |
32388 | @table @code |
32389 | @item --help | |
db2e3e2e | 32390 | Display a quick summary of how to invoke @file{configure}. |
c906108c | 32391 | |
8e04817f AC |
32392 | @item --prefix=@var{dir} |
32393 | Configure the source to install programs and files under directory | |
32394 | @file{@var{dir}}. | |
c906108c | 32395 | |
8e04817f AC |
32396 | @item --exec-prefix=@var{dir} |
32397 | Configure the source to install programs under directory | |
32398 | @file{@var{dir}}. | |
c906108c | 32399 | |
8e04817f AC |
32400 | @c avoid splitting the warning from the explanation: |
32401 | @need 2000 | |
32402 | @item --srcdir=@var{dirname} | |
32403 | @strong{Warning: using this option requires @sc{gnu} @code{make}, or another | |
32404 | @code{make} that implements the @code{VPATH} feature.}@* | |
32405 | Use this option to make configurations in directories separate from the | |
32406 | @value{GDBN} source directories. Among other things, you can use this to | |
32407 | build (or maintain) several configurations simultaneously, in separate | |
db2e3e2e | 32408 | directories. @file{configure} writes configuration-specific files in |
8e04817f | 32409 | the current directory, but arranges for them to use the source in the |
db2e3e2e | 32410 | directory @var{dirname}. @file{configure} creates directories under |
8e04817f AC |
32411 | the working directory in parallel to the source directories below |
32412 | @var{dirname}. | |
c906108c | 32413 | |
8e04817f | 32414 | @item --norecursion |
db2e3e2e | 32415 | Configure only the directory level where @file{configure} is executed; do not |
8e04817f | 32416 | propagate configuration to subdirectories. |
c906108c | 32417 | |
8e04817f AC |
32418 | @item --target=@var{target} |
32419 | Configure @value{GDBN} for cross-debugging programs running on the specified | |
32420 | @var{target}. Without this option, @value{GDBN} is configured to debug | |
32421 | programs that run on the same machine (@var{host}) as @value{GDBN} itself. | |
c906108c | 32422 | |
8e04817f | 32423 | There is no convenient way to generate a list of all available targets. |
c906108c | 32424 | |
8e04817f AC |
32425 | @item @var{host} @dots{} |
32426 | Configure @value{GDBN} to run on the specified @var{host}. | |
c906108c | 32427 | |
8e04817f AC |
32428 | There is no convenient way to generate a list of all available hosts. |
32429 | @end table | |
c906108c | 32430 | |
8e04817f AC |
32431 | There are many other options available as well, but they are generally |
32432 | needed for special purposes only. | |
c906108c | 32433 | |
098b41a6 JG |
32434 | @node System-wide configuration |
32435 | @section System-wide configuration and settings | |
32436 | @cindex system-wide init file | |
32437 | ||
32438 | @value{GDBN} can be configured to have a system-wide init file; | |
32439 | this file will be read and executed at startup (@pxref{Startup, , What | |
32440 | @value{GDBN} does during startup}). | |
32441 | ||
32442 | Here is the corresponding configure option: | |
32443 | ||
32444 | @table @code | |
32445 | @item --with-system-gdbinit=@var{file} | |
32446 | Specify that the default location of the system-wide init file is | |
32447 | @var{file}. | |
32448 | @end table | |
32449 | ||
32450 | If @value{GDBN} has been configured with the option @option{--prefix=$prefix}, | |
32451 | it may be subject to relocation. Two possible cases: | |
32452 | ||
32453 | @itemize @bullet | |
32454 | @item | |
32455 | If the default location of this init file contains @file{$prefix}, | |
32456 | it will be subject to relocation. Suppose that the configure options | |
32457 | are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit}; | |
32458 | if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system | |
32459 | init file is looked for as @file{$install/etc/gdbinit} instead of | |
32460 | @file{$prefix/etc/gdbinit}. | |
32461 | ||
32462 | @item | |
32463 | By contrast, if the default location does not contain the prefix, | |
32464 | it will not be relocated. E.g.@: if @value{GDBN} has been configured with | |
32465 | @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit}, | |
32466 | then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit}, | |
32467 | wherever @value{GDBN} is installed. | |
32468 | @end itemize | |
32469 | ||
8e04817f AC |
32470 | @node Maintenance Commands |
32471 | @appendix Maintenance Commands | |
32472 | @cindex maintenance commands | |
32473 | @cindex internal commands | |
c906108c | 32474 | |
8e04817f | 32475 | In addition to commands intended for @value{GDBN} users, @value{GDBN} |
09d4efe1 EZ |
32476 | includes a number of commands intended for @value{GDBN} developers, |
32477 | that are not documented elsewhere in this manual. These commands are | |
da316a69 EZ |
32478 | provided here for reference. (For commands that turn on debugging |
32479 | messages, see @ref{Debugging Output}.) | |
c906108c | 32480 | |
8e04817f | 32481 | @table @code |
09d4efe1 | 32482 | @kindex maint agent |
782b2b07 | 32483 | @kindex maint agent-eval |
09d4efe1 | 32484 | @item maint agent @var{expression} |
782b2b07 | 32485 | @itemx maint agent-eval @var{expression} |
09d4efe1 EZ |
32486 | Translate the given @var{expression} into remote agent bytecodes. |
32487 | This command is useful for debugging the Agent Expression mechanism | |
782b2b07 SS |
32488 | (@pxref{Agent Expressions}). The @samp{agent} version produces an |
32489 | expression useful for data collection, such as by tracepoints, while | |
32490 | @samp{maint agent-eval} produces an expression that evaluates directly | |
32491 | to a result. For instance, a collection expression for @code{globa + | |
32492 | globb} will include bytecodes to record four bytes of memory at each | |
32493 | of the addresses of @code{globa} and @code{globb}, while discarding | |
32494 | the result of the addition, while an evaluation expression will do the | |
32495 | addition and return the sum. | |
09d4efe1 | 32496 | |
8e04817f AC |
32497 | @kindex maint info breakpoints |
32498 | @item @anchor{maint info breakpoints}maint info breakpoints | |
32499 | Using the same format as @samp{info breakpoints}, display both the | |
32500 | breakpoints you've set explicitly, and those @value{GDBN} is using for | |
32501 | internal purposes. Internal breakpoints are shown with negative | |
32502 | breakpoint numbers. The type column identifies what kind of breakpoint | |
32503 | is shown: | |
c906108c | 32504 | |
8e04817f AC |
32505 | @table @code |
32506 | @item breakpoint | |
32507 | Normal, explicitly set breakpoint. | |
c906108c | 32508 | |
8e04817f AC |
32509 | @item watchpoint |
32510 | Normal, explicitly set watchpoint. | |
c906108c | 32511 | |
8e04817f AC |
32512 | @item longjmp |
32513 | Internal breakpoint, used to handle correctly stepping through | |
32514 | @code{longjmp} calls. | |
c906108c | 32515 | |
8e04817f AC |
32516 | @item longjmp resume |
32517 | Internal breakpoint at the target of a @code{longjmp}. | |
c906108c | 32518 | |
8e04817f AC |
32519 | @item until |
32520 | Temporary internal breakpoint used by the @value{GDBN} @code{until} command. | |
c906108c | 32521 | |
8e04817f AC |
32522 | @item finish |
32523 | Temporary internal breakpoint used by the @value{GDBN} @code{finish} command. | |
c906108c | 32524 | |
8e04817f AC |
32525 | @item shlib events |
32526 | Shared library events. | |
c906108c | 32527 | |
8e04817f | 32528 | @end table |
c906108c | 32529 | |
fff08868 HZ |
32530 | @kindex set displaced-stepping |
32531 | @kindex show displaced-stepping | |
237fc4c9 PA |
32532 | @cindex displaced stepping support |
32533 | @cindex out-of-line single-stepping | |
fff08868 HZ |
32534 | @item set displaced-stepping |
32535 | @itemx show displaced-stepping | |
237fc4c9 | 32536 | Control whether or not @value{GDBN} will do @dfn{displaced stepping} |
fff08868 HZ |
32537 | if the target supports it. Displaced stepping is a way to single-step |
32538 | over breakpoints without removing them from the inferior, by executing | |
32539 | an out-of-line copy of the instruction that was originally at the | |
32540 | breakpoint location. It is also known as out-of-line single-stepping. | |
32541 | ||
32542 | @table @code | |
32543 | @item set displaced-stepping on | |
32544 | If the target architecture supports it, @value{GDBN} will use | |
32545 | displaced stepping to step over breakpoints. | |
32546 | ||
32547 | @item set displaced-stepping off | |
32548 | @value{GDBN} will not use displaced stepping to step over breakpoints, | |
32549 | even if such is supported by the target architecture. | |
32550 | ||
32551 | @cindex non-stop mode, and @samp{set displaced-stepping} | |
32552 | @item set displaced-stepping auto | |
32553 | This is the default mode. @value{GDBN} will use displaced stepping | |
32554 | only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target | |
32555 | architecture supports displaced stepping. | |
32556 | @end table | |
237fc4c9 | 32557 | |
09d4efe1 EZ |
32558 | @kindex maint check-symtabs |
32559 | @item maint check-symtabs | |
32560 | Check the consistency of psymtabs and symtabs. | |
32561 | ||
32562 | @kindex maint cplus first_component | |
32563 | @item maint cplus first_component @var{name} | |
32564 | Print the first C@t{++} class/namespace component of @var{name}. | |
32565 | ||
32566 | @kindex maint cplus namespace | |
32567 | @item maint cplus namespace | |
32568 | Print the list of possible C@t{++} namespaces. | |
32569 | ||
32570 | @kindex maint demangle | |
32571 | @item maint demangle @var{name} | |
d3e8051b | 32572 | Demangle a C@t{++} or Objective-C mangled @var{name}. |
09d4efe1 EZ |
32573 | |
32574 | @kindex maint deprecate | |
32575 | @kindex maint undeprecate | |
32576 | @cindex deprecated commands | |
32577 | @item maint deprecate @var{command} @r{[}@var{replacement}@r{]} | |
32578 | @itemx maint undeprecate @var{command} | |
32579 | Deprecate or undeprecate the named @var{command}. Deprecated commands | |
32580 | cause @value{GDBN} to issue a warning when you use them. The optional | |
32581 | argument @var{replacement} says which newer command should be used in | |
32582 | favor of the deprecated one; if it is given, @value{GDBN} will mention | |
32583 | the replacement as part of the warning. | |
32584 | ||
32585 | @kindex maint dump-me | |
32586 | @item maint dump-me | |
721c2651 | 32587 | @cindex @code{SIGQUIT} signal, dump core of @value{GDBN} |
09d4efe1 | 32588 | Cause a fatal signal in the debugger and force it to dump its core. |
721c2651 EZ |
32589 | This is supported only on systems which support aborting a program |
32590 | with the @code{SIGQUIT} signal. | |
09d4efe1 | 32591 | |
8d30a00d AC |
32592 | @kindex maint internal-error |
32593 | @kindex maint internal-warning | |
09d4efe1 EZ |
32594 | @item maint internal-error @r{[}@var{message-text}@r{]} |
32595 | @itemx maint internal-warning @r{[}@var{message-text}@r{]} | |
8d30a00d AC |
32596 | Cause @value{GDBN} to call the internal function @code{internal_error} |
32597 | or @code{internal_warning} and hence behave as though an internal error | |
32598 | or internal warning has been detected. In addition to reporting the | |
32599 | internal problem, these functions give the user the opportunity to | |
32600 | either quit @value{GDBN} or create a core file of the current | |
32601 | @value{GDBN} session. | |
32602 | ||
09d4efe1 EZ |
32603 | These commands take an optional parameter @var{message-text} that is |
32604 | used as the text of the error or warning message. | |
32605 | ||
d3e8051b | 32606 | Here's an example of using @code{internal-error}: |
09d4efe1 | 32607 | |
8d30a00d | 32608 | @smallexample |
f7dc1244 | 32609 | (@value{GDBP}) @kbd{maint internal-error testing, 1, 2} |
8d30a00d AC |
32610 | @dots{}/maint.c:121: internal-error: testing, 1, 2 |
32611 | A problem internal to GDB has been detected. Further | |
32612 | debugging may prove unreliable. | |
32613 | Quit this debugging session? (y or n) @kbd{n} | |
32614 | Create a core file? (y or n) @kbd{n} | |
f7dc1244 | 32615 | (@value{GDBP}) |
8d30a00d AC |
32616 | @end smallexample |
32617 | ||
3c16cced PA |
32618 | @cindex @value{GDBN} internal error |
32619 | @cindex internal errors, control of @value{GDBN} behavior | |
32620 | ||
32621 | @kindex maint set internal-error | |
32622 | @kindex maint show internal-error | |
32623 | @kindex maint set internal-warning | |
32624 | @kindex maint show internal-warning | |
32625 | @item maint set internal-error @var{action} [ask|yes|no] | |
32626 | @itemx maint show internal-error @var{action} | |
32627 | @itemx maint set internal-warning @var{action} [ask|yes|no] | |
32628 | @itemx maint show internal-warning @var{action} | |
32629 | When @value{GDBN} reports an internal problem (error or warning) it | |
32630 | gives the user the opportunity to both quit @value{GDBN} and create a | |
32631 | core file of the current @value{GDBN} session. These commands let you | |
32632 | override the default behaviour for each particular @var{action}, | |
32633 | described in the table below. | |
32634 | ||
32635 | @table @samp | |
32636 | @item quit | |
32637 | You can specify that @value{GDBN} should always (yes) or never (no) | |
32638 | quit. The default is to ask the user what to do. | |
32639 | ||
32640 | @item corefile | |
32641 | You can specify that @value{GDBN} should always (yes) or never (no) | |
32642 | create a core file. The default is to ask the user what to do. | |
32643 | @end table | |
32644 | ||
09d4efe1 EZ |
32645 | @kindex maint packet |
32646 | @item maint packet @var{text} | |
32647 | If @value{GDBN} is talking to an inferior via the serial protocol, | |
32648 | then this command sends the string @var{text} to the inferior, and | |
32649 | displays the response packet. @value{GDBN} supplies the initial | |
32650 | @samp{$} character, the terminating @samp{#} character, and the | |
32651 | checksum. | |
32652 | ||
32653 | @kindex maint print architecture | |
32654 | @item maint print architecture @r{[}@var{file}@r{]} | |
32655 | Print the entire architecture configuration. The optional argument | |
32656 | @var{file} names the file where the output goes. | |
8d30a00d | 32657 | |
81adfced DJ |
32658 | @kindex maint print c-tdesc |
32659 | @item maint print c-tdesc | |
32660 | Print the current target description (@pxref{Target Descriptions}) as | |
32661 | a C source file. The created source file can be used in @value{GDBN} | |
32662 | when an XML parser is not available to parse the description. | |
32663 | ||
00905d52 AC |
32664 | @kindex maint print dummy-frames |
32665 | @item maint print dummy-frames | |
00905d52 AC |
32666 | Prints the contents of @value{GDBN}'s internal dummy-frame stack. |
32667 | ||
32668 | @smallexample | |
f7dc1244 | 32669 | (@value{GDBP}) @kbd{b add} |
00905d52 | 32670 | @dots{} |
f7dc1244 | 32671 | (@value{GDBP}) @kbd{print add(2,3)} |
00905d52 AC |
32672 | Breakpoint 2, add (a=2, b=3) at @dots{} |
32673 | 58 return (a + b); | |
32674 | The program being debugged stopped while in a function called from GDB. | |
32675 | @dots{} | |
f7dc1244 | 32676 | (@value{GDBP}) @kbd{maint print dummy-frames} |
00905d52 AC |
32677 | 0x1a57c80: pc=0x01014068 fp=0x0200bddc sp=0x0200bdd6 |
32678 | top=0x0200bdd4 id=@{stack=0x200bddc,code=0x101405c@} | |
32679 | call_lo=0x01014000 call_hi=0x01014001 | |
f7dc1244 | 32680 | (@value{GDBP}) |
00905d52 AC |
32681 | @end smallexample |
32682 | ||
32683 | Takes an optional file parameter. | |
32684 | ||
0680b120 AC |
32685 | @kindex maint print registers |
32686 | @kindex maint print raw-registers | |
32687 | @kindex maint print cooked-registers | |
617073a9 | 32688 | @kindex maint print register-groups |
c21236dc | 32689 | @kindex maint print remote-registers |
09d4efe1 EZ |
32690 | @item maint print registers @r{[}@var{file}@r{]} |
32691 | @itemx maint print raw-registers @r{[}@var{file}@r{]} | |
32692 | @itemx maint print cooked-registers @r{[}@var{file}@r{]} | |
32693 | @itemx maint print register-groups @r{[}@var{file}@r{]} | |
c21236dc | 32694 | @itemx maint print remote-registers @r{[}@var{file}@r{]} |
0680b120 AC |
32695 | Print @value{GDBN}'s internal register data structures. |
32696 | ||
617073a9 | 32697 | The command @code{maint print raw-registers} includes the contents of |
c21236dc PA |
32698 | the raw register cache; the command @code{maint print |
32699 | cooked-registers} includes the (cooked) value of all registers, | |
32700 | including registers which aren't available on the target nor visible | |
32701 | to user; the command @code{maint print register-groups} includes the | |
32702 | groups that each register is a member of; and the command @code{maint | |
32703 | print remote-registers} includes the remote target's register numbers | |
32704 | and offsets in the `G' packets. @xref{Registers,, Registers, gdbint, | |
617073a9 | 32705 | @value{GDBN} Internals}. |
0680b120 | 32706 | |
09d4efe1 EZ |
32707 | These commands take an optional parameter, a file name to which to |
32708 | write the information. | |
0680b120 | 32709 | |
617073a9 | 32710 | @kindex maint print reggroups |
09d4efe1 EZ |
32711 | @item maint print reggroups @r{[}@var{file}@r{]} |
32712 | Print @value{GDBN}'s internal register group data structures. The | |
32713 | optional argument @var{file} tells to what file to write the | |
32714 | information. | |
617073a9 | 32715 | |
09d4efe1 | 32716 | The register groups info looks like this: |
617073a9 AC |
32717 | |
32718 | @smallexample | |
f7dc1244 | 32719 | (@value{GDBP}) @kbd{maint print reggroups} |
b383017d RM |
32720 | Group Type |
32721 | general user | |
32722 | float user | |
32723 | all user | |
32724 | vector user | |
32725 | system user | |
32726 | save internal | |
32727 | restore internal | |
617073a9 AC |
32728 | @end smallexample |
32729 | ||
09d4efe1 EZ |
32730 | @kindex flushregs |
32731 | @item flushregs | |
32732 | This command forces @value{GDBN} to flush its internal register cache. | |
32733 | ||
32734 | @kindex maint print objfiles | |
32735 | @cindex info for known object files | |
32736 | @item maint print objfiles | |
32737 | Print a dump of all known object files. For each object file, this | |
32738 | command prints its name, address in memory, and all of its psymtabs | |
32739 | and symtabs. | |
32740 | ||
8a1ea21f DE |
32741 | @kindex maint print section-scripts |
32742 | @cindex info for known .debug_gdb_scripts-loaded scripts | |
32743 | @item maint print section-scripts [@var{regexp}] | |
32744 | Print a dump of scripts specified in the @code{.debug_gdb_section} section. | |
32745 | If @var{regexp} is specified, only print scripts loaded by object files | |
32746 | matching @var{regexp}. | |
32747 | For each script, this command prints its name as specified in the objfile, | |
32748 | and the full path if known. | |
32749 | @xref{.debug_gdb_scripts section}. | |
32750 | ||
09d4efe1 EZ |
32751 | @kindex maint print statistics |
32752 | @cindex bcache statistics | |
32753 | @item maint print statistics | |
32754 | This command prints, for each object file in the program, various data | |
32755 | about that object file followed by the byte cache (@dfn{bcache}) | |
32756 | statistics for the object file. The objfile data includes the number | |
d3e8051b | 32757 | of minimal, partial, full, and stabs symbols, the number of types |
09d4efe1 EZ |
32758 | defined by the objfile, the number of as yet unexpanded psym tables, |
32759 | the number of line tables and string tables, and the amount of memory | |
32760 | used by the various tables. The bcache statistics include the counts, | |
32761 | sizes, and counts of duplicates of all and unique objects, max, | |
32762 | average, and median entry size, total memory used and its overhead and | |
32763 | savings, and various measures of the hash table size and chain | |
32764 | lengths. | |
32765 | ||
c7ba131e JB |
32766 | @kindex maint print target-stack |
32767 | @cindex target stack description | |
32768 | @item maint print target-stack | |
32769 | A @dfn{target} is an interface between the debugger and a particular | |
32770 | kind of file or process. Targets can be stacked in @dfn{strata}, | |
32771 | so that more than one target can potentially respond to a request. | |
32772 | In particular, memory accesses will walk down the stack of targets | |
32773 | until they find a target that is interested in handling that particular | |
32774 | address. | |
32775 | ||
32776 | This command prints a short description of each layer that was pushed on | |
32777 | the @dfn{target stack}, starting from the top layer down to the bottom one. | |
32778 | ||
09d4efe1 EZ |
32779 | @kindex maint print type |
32780 | @cindex type chain of a data type | |
32781 | @item maint print type @var{expr} | |
32782 | Print the type chain for a type specified by @var{expr}. The argument | |
32783 | can be either a type name or a symbol. If it is a symbol, the type of | |
32784 | that symbol is described. The type chain produced by this command is | |
32785 | a recursive definition of the data type as stored in @value{GDBN}'s | |
32786 | data structures, including its flags and contained types. | |
32787 | ||
9eae7c52 TT |
32788 | @kindex maint set dwarf2 always-disassemble |
32789 | @kindex maint show dwarf2 always-disassemble | |
32790 | @item maint set dwarf2 always-disassemble | |
32791 | @item maint show dwarf2 always-disassemble | |
32792 | Control the behavior of @code{info address} when using DWARF debugging | |
32793 | information. | |
32794 | ||
32795 | The default is @code{off}, which means that @value{GDBN} should try to | |
32796 | describe a variable's location in an easily readable format. When | |
32797 | @code{on}, @value{GDBN} will instead display the DWARF location | |
32798 | expression in an assembly-like format. Note that some locations are | |
32799 | too complex for @value{GDBN} to describe simply; in this case you will | |
32800 | always see the disassembly form. | |
32801 | ||
32802 | Here is an example of the resulting disassembly: | |
32803 | ||
32804 | @smallexample | |
32805 | (gdb) info addr argc | |
32806 | Symbol "argc" is a complex DWARF expression: | |
32807 | 1: DW_OP_fbreg 0 | |
32808 | @end smallexample | |
32809 | ||
32810 | For more information on these expressions, see | |
32811 | @uref{http://www.dwarfstd.org/, the DWARF standard}. | |
32812 | ||
09d4efe1 EZ |
32813 | @kindex maint set dwarf2 max-cache-age |
32814 | @kindex maint show dwarf2 max-cache-age | |
32815 | @item maint set dwarf2 max-cache-age | |
32816 | @itemx maint show dwarf2 max-cache-age | |
32817 | Control the DWARF 2 compilation unit cache. | |
32818 | ||
32819 | @cindex DWARF 2 compilation units cache | |
32820 | In object files with inter-compilation-unit references, such as those | |
32821 | produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF 2 | |
32822 | reader needs to frequently refer to previously read compilation units. | |
32823 | This setting controls how long a compilation unit will remain in the | |
32824 | cache if it is not referenced. A higher limit means that cached | |
32825 | compilation units will be stored in memory longer, and more total | |
32826 | memory will be used. Setting it to zero disables caching, which will | |
32827 | slow down @value{GDBN} startup, but reduce memory consumption. | |
32828 | ||
e7ba9c65 DJ |
32829 | @kindex maint set profile |
32830 | @kindex maint show profile | |
32831 | @cindex profiling GDB | |
32832 | @item maint set profile | |
32833 | @itemx maint show profile | |
32834 | Control profiling of @value{GDBN}. | |
32835 | ||
32836 | Profiling will be disabled until you use the @samp{maint set profile} | |
32837 | command to enable it. When you enable profiling, the system will begin | |
32838 | collecting timing and execution count data; when you disable profiling or | |
32839 | exit @value{GDBN}, the results will be written to a log file. Remember that | |
32840 | if you use profiling, @value{GDBN} will overwrite the profiling log file | |
32841 | (often called @file{gmon.out}). If you have a record of important profiling | |
32842 | data in a @file{gmon.out} file, be sure to move it to a safe location. | |
32843 | ||
32844 | Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be | |
b383017d | 32845 | compiled with the @samp{-pg} compiler option. |
e7ba9c65 | 32846 | |
cbe54154 PA |
32847 | @kindex maint set show-debug-regs |
32848 | @kindex maint show show-debug-regs | |
eac35c4e | 32849 | @cindex hardware debug registers |
cbe54154 PA |
32850 | @item maint set show-debug-regs |
32851 | @itemx maint show show-debug-regs | |
eac35c4e | 32852 | Control whether to show variables that mirror the hardware debug |
09d4efe1 | 32853 | registers. Use @code{ON} to enable, @code{OFF} to disable. If |
3f94c067 | 32854 | enabled, the debug registers values are shown when @value{GDBN} inserts or |
09d4efe1 EZ |
32855 | removes a hardware breakpoint or watchpoint, and when the inferior |
32856 | triggers a hardware-assisted breakpoint or watchpoint. | |
32857 | ||
711e434b PM |
32858 | @kindex maint set show-all-tib |
32859 | @kindex maint show show-all-tib | |
32860 | @item maint set show-all-tib | |
32861 | @itemx maint show show-all-tib | |
32862 | Control whether to show all non zero areas within a 1k block starting | |
32863 | at thread local base, when using the @samp{info w32 thread-information-block} | |
32864 | command. | |
32865 | ||
09d4efe1 EZ |
32866 | @kindex maint space |
32867 | @cindex memory used by commands | |
32868 | @item maint space | |
32869 | Control whether to display memory usage for each command. If set to a | |
32870 | nonzero value, @value{GDBN} will display how much memory each command | |
32871 | took, following the command's own output. This can also be requested | |
32872 | by invoking @value{GDBN} with the @option{--statistics} command-line | |
32873 | switch (@pxref{Mode Options}). | |
32874 | ||
32875 | @kindex maint time | |
32876 | @cindex time of command execution | |
32877 | @item maint time | |
32878 | Control whether to display the execution time for each command. If | |
32879 | set to a nonzero value, @value{GDBN} will display how much time it | |
32880 | took to execute each command, following the command's own output. | |
e2b7ddea VP |
32881 | The time is not printed for the commands that run the target, since |
32882 | there's no mechanism currently to compute how much time was spend | |
32883 | by @value{GDBN} and how much time was spend by the program been debugged. | |
32884 | it's not possibly currently | |
09d4efe1 EZ |
32885 | This can also be requested by invoking @value{GDBN} with the |
32886 | @option{--statistics} command-line switch (@pxref{Mode Options}). | |
32887 | ||
32888 | @kindex maint translate-address | |
32889 | @item maint translate-address @r{[}@var{section}@r{]} @var{addr} | |
32890 | Find the symbol stored at the location specified by the address | |
32891 | @var{addr} and an optional section name @var{section}. If found, | |
32892 | @value{GDBN} prints the name of the closest symbol and an offset from | |
32893 | the symbol's location to the specified address. This is similar to | |
32894 | the @code{info address} command (@pxref{Symbols}), except that this | |
32895 | command also allows to find symbols in other sections. | |
ae038cb0 | 32896 | |
c14c28ba PP |
32897 | If section was not specified, the section in which the symbol was found |
32898 | is also printed. For dynamically linked executables, the name of | |
32899 | executable or shared library containing the symbol is printed as well. | |
32900 | ||
8e04817f | 32901 | @end table |
c906108c | 32902 | |
9c16f35a EZ |
32903 | The following command is useful for non-interactive invocations of |
32904 | @value{GDBN}, such as in the test suite. | |
32905 | ||
32906 | @table @code | |
32907 | @item set watchdog @var{nsec} | |
32908 | @kindex set watchdog | |
32909 | @cindex watchdog timer | |
32910 | @cindex timeout for commands | |
32911 | Set the maximum number of seconds @value{GDBN} will wait for the | |
32912 | target operation to finish. If this time expires, @value{GDBN} | |
32913 | reports and error and the command is aborted. | |
32914 | ||
32915 | @item show watchdog | |
32916 | Show the current setting of the target wait timeout. | |
32917 | @end table | |
c906108c | 32918 | |
e0ce93ac | 32919 | @node Remote Protocol |
8e04817f | 32920 | @appendix @value{GDBN} Remote Serial Protocol |
c906108c | 32921 | |
ee2d5c50 AC |
32922 | @menu |
32923 | * Overview:: | |
32924 | * Packets:: | |
32925 | * Stop Reply Packets:: | |
32926 | * General Query Packets:: | |
a1dcb23a | 32927 | * Architecture-Specific Protocol Details:: |
9d29849a | 32928 | * Tracepoint Packets:: |
a6b151f1 | 32929 | * Host I/O Packets:: |
9a6253be | 32930 | * Interrupts:: |
8b23ecc4 SL |
32931 | * Notification Packets:: |
32932 | * Remote Non-Stop:: | |
a6f3e723 | 32933 | * Packet Acknowledgment:: |
ee2d5c50 | 32934 | * Examples:: |
79a6e687 | 32935 | * File-I/O Remote Protocol Extension:: |
cfa9d6d9 | 32936 | * Library List Format:: |
79a6e687 | 32937 | * Memory Map Format:: |
dc146f7c | 32938 | * Thread List Format:: |
b3b9301e | 32939 | * Traceframe Info Format:: |
ee2d5c50 AC |
32940 | @end menu |
32941 | ||
32942 | @node Overview | |
32943 | @section Overview | |
32944 | ||
8e04817f AC |
32945 | There may be occasions when you need to know something about the |
32946 | protocol---for example, if there is only one serial port to your target | |
32947 | machine, you might want your program to do something special if it | |
32948 | recognizes a packet meant for @value{GDBN}. | |
c906108c | 32949 | |
d2c6833e | 32950 | In the examples below, @samp{->} and @samp{<-} are used to indicate |
bf06d120 | 32951 | transmitted and received data, respectively. |
c906108c | 32952 | |
8e04817f AC |
32953 | @cindex protocol, @value{GDBN} remote serial |
32954 | @cindex serial protocol, @value{GDBN} remote | |
32955 | @cindex remote serial protocol | |
8b23ecc4 SL |
32956 | All @value{GDBN} commands and responses (other than acknowledgments |
32957 | and notifications, see @ref{Notification Packets}) are sent as a | |
32958 | @var{packet}. A @var{packet} is introduced with the character | |
8e04817f AC |
32959 | @samp{$}, the actual @var{packet-data}, and the terminating character |
32960 | @samp{#} followed by a two-digit @var{checksum}: | |
c906108c | 32961 | |
474c8240 | 32962 | @smallexample |
8e04817f | 32963 | @code{$}@var{packet-data}@code{#}@var{checksum} |
474c8240 | 32964 | @end smallexample |
8e04817f | 32965 | @noindent |
c906108c | 32966 | |
8e04817f AC |
32967 | @cindex checksum, for @value{GDBN} remote |
32968 | @noindent | |
32969 | The two-digit @var{checksum} is computed as the modulo 256 sum of all | |
32970 | characters between the leading @samp{$} and the trailing @samp{#} (an | |
32971 | eight bit unsigned checksum). | |
c906108c | 32972 | |
8e04817f AC |
32973 | Implementors should note that prior to @value{GDBN} 5.0 the protocol |
32974 | specification also included an optional two-digit @var{sequence-id}: | |
c906108c | 32975 | |
474c8240 | 32976 | @smallexample |
8e04817f | 32977 | @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum} |
474c8240 | 32978 | @end smallexample |
c906108c | 32979 | |
8e04817f AC |
32980 | @cindex sequence-id, for @value{GDBN} remote |
32981 | @noindent | |
32982 | That @var{sequence-id} was appended to the acknowledgment. @value{GDBN} | |
32983 | has never output @var{sequence-id}s. Stubs that handle packets added | |
32984 | since @value{GDBN} 5.0 must not accept @var{sequence-id}. | |
c906108c | 32985 | |
8e04817f AC |
32986 | When either the host or the target machine receives a packet, the first |
32987 | response expected is an acknowledgment: either @samp{+} (to indicate | |
32988 | the package was received correctly) or @samp{-} (to request | |
32989 | retransmission): | |
c906108c | 32990 | |
474c8240 | 32991 | @smallexample |
d2c6833e AC |
32992 | -> @code{$}@var{packet-data}@code{#}@var{checksum} |
32993 | <- @code{+} | |
474c8240 | 32994 | @end smallexample |
8e04817f | 32995 | @noindent |
53a5351d | 32996 | |
a6f3e723 SL |
32997 | The @samp{+}/@samp{-} acknowledgments can be disabled |
32998 | once a connection is established. | |
32999 | @xref{Packet Acknowledgment}, for details. | |
33000 | ||
8e04817f AC |
33001 | The host (@value{GDBN}) sends @var{command}s, and the target (the |
33002 | debugging stub incorporated in your program) sends a @var{response}. In | |
33003 | the case of step and continue @var{command}s, the response is only sent | |
8b23ecc4 SL |
33004 | when the operation has completed, and the target has again stopped all |
33005 | threads in all attached processes. This is the default all-stop mode | |
33006 | behavior, but the remote protocol also supports @value{GDBN}'s non-stop | |
33007 | execution mode; see @ref{Remote Non-Stop}, for details. | |
c906108c | 33008 | |
8e04817f AC |
33009 | @var{packet-data} consists of a sequence of characters with the |
33010 | exception of @samp{#} and @samp{$} (see @samp{X} packet for additional | |
33011 | exceptions). | |
c906108c | 33012 | |
ee2d5c50 | 33013 | @cindex remote protocol, field separator |
0876f84a | 33014 | Fields within the packet should be separated using @samp{,} @samp{;} or |
8e04817f | 33015 | @samp{:}. Except where otherwise noted all numbers are represented in |
ee2d5c50 | 33016 | @sc{hex} with leading zeros suppressed. |
c906108c | 33017 | |
8e04817f AC |
33018 | Implementors should note that prior to @value{GDBN} 5.0, the character |
33019 | @samp{:} could not appear as the third character in a packet (as it | |
33020 | would potentially conflict with the @var{sequence-id}). | |
c906108c | 33021 | |
0876f84a DJ |
33022 | @cindex remote protocol, binary data |
33023 | @anchor{Binary Data} | |
33024 | Binary data in most packets is encoded either as two hexadecimal | |
33025 | digits per byte of binary data. This allowed the traditional remote | |
33026 | protocol to work over connections which were only seven-bit clean. | |
33027 | Some packets designed more recently assume an eight-bit clean | |
33028 | connection, and use a more efficient encoding to send and receive | |
33029 | binary data. | |
33030 | ||
33031 | The binary data representation uses @code{7d} (@sc{ascii} @samp{@}}) | |
33032 | as an escape character. Any escaped byte is transmitted as the escape | |
33033 | character followed by the original character XORed with @code{0x20}. | |
33034 | For example, the byte @code{0x7d} would be transmitted as the two | |
33035 | bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}), | |
33036 | @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii} | |
33037 | @samp{@}}) must always be escaped. Responses sent by the stub | |
33038 | must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it | |
33039 | is not interpreted as the start of a run-length encoded sequence | |
33040 | (described next). | |
33041 | ||
1d3811f6 DJ |
33042 | Response @var{data} can be run-length encoded to save space. |
33043 | Run-length encoding replaces runs of identical characters with one | |
33044 | instance of the repeated character, followed by a @samp{*} and a | |
33045 | repeat count. The repeat count is itself sent encoded, to avoid | |
33046 | binary characters in @var{data}: a value of @var{n} is sent as | |
33047 | @code{@var{n}+29}. For a repeat count greater or equal to 3, this | |
33048 | produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii} | |
33049 | code 32) for a repeat count of 3. (This is because run-length | |
33050 | encoding starts to win for counts 3 or more.) Thus, for example, | |
33051 | @samp{0* } is a run-length encoding of ``0000'': the space character | |
33052 | after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 = | |
33053 | 3}} more times. | |
33054 | ||
33055 | The printable characters @samp{#} and @samp{$} or with a numeric value | |
33056 | greater than 126 must not be used. Runs of six repeats (@samp{#}) or | |
33057 | seven repeats (@samp{$}) can be expanded using a repeat count of only | |
33058 | five (@samp{"}). For example, @samp{00000000} can be encoded as | |
33059 | @samp{0*"00}. | |
c906108c | 33060 | |
8e04817f AC |
33061 | The error response returned for some packets includes a two character |
33062 | error number. That number is not well defined. | |
c906108c | 33063 | |
f8da2bff | 33064 | @cindex empty response, for unsupported packets |
8e04817f AC |
33065 | For any @var{command} not supported by the stub, an empty response |
33066 | (@samp{$#00}) should be returned. That way it is possible to extend the | |
33067 | protocol. A newer @value{GDBN} can tell if a packet is supported based | |
33068 | on that response. | |
c906108c | 33069 | |
393eab54 PA |
33070 | At a minimum, a stub is required to support the @samp{g} and @samp{G} |
33071 | commands for register access, and the @samp{m} and @samp{M} commands | |
33072 | for memory access. Stubs that only control single-threaded targets | |
33073 | can implement run control with the @samp{c} (continue), and @samp{s} | |
33074 | (step) commands. Stubs that support multi-threading targets should | |
33075 | support the @samp{vCont} command. All other commands are optional. | |
c906108c | 33076 | |
ee2d5c50 AC |
33077 | @node Packets |
33078 | @section Packets | |
33079 | ||
33080 | The following table provides a complete list of all currently defined | |
33081 | @var{command}s and their corresponding response @var{data}. | |
79a6e687 | 33082 | @xref{File-I/O Remote Protocol Extension}, for details about the File |
9c16f35a | 33083 | I/O extension of the remote protocol. |
ee2d5c50 | 33084 | |
b8ff78ce JB |
33085 | Each packet's description has a template showing the packet's overall |
33086 | syntax, followed by an explanation of the packet's meaning. We | |
33087 | include spaces in some of the templates for clarity; these are not | |
33088 | part of the packet's syntax. No @value{GDBN} packet uses spaces to | |
33089 | separate its components. For example, a template like @samp{foo | |
33090 | @var{bar} @var{baz}} describes a packet beginning with the three ASCII | |
33091 | bytes @samp{foo}, followed by a @var{bar}, followed directly by a | |
3f94c067 | 33092 | @var{baz}. @value{GDBN} does not transmit a space character between the |
b8ff78ce JB |
33093 | @samp{foo} and the @var{bar}, or between the @var{bar} and the |
33094 | @var{baz}. | |
33095 | ||
b90a069a SL |
33096 | @cindex @var{thread-id}, in remote protocol |
33097 | @anchor{thread-id syntax} | |
33098 | Several packets and replies include a @var{thread-id} field to identify | |
33099 | a thread. Normally these are positive numbers with a target-specific | |
33100 | interpretation, formatted as big-endian hex strings. A @var{thread-id} | |
33101 | can also be a literal @samp{-1} to indicate all threads, or @samp{0} to | |
33102 | pick any thread. | |
33103 | ||
33104 | In addition, the remote protocol supports a multiprocess feature in | |
33105 | which the @var{thread-id} syntax is extended to optionally include both | |
33106 | process and thread ID fields, as @samp{p@var{pid}.@var{tid}}. | |
33107 | The @var{pid} (process) and @var{tid} (thread) components each have the | |
33108 | format described above: a positive number with target-specific | |
33109 | interpretation formatted as a big-endian hex string, literal @samp{-1} | |
33110 | to indicate all processes or threads (respectively), or @samp{0} to | |
33111 | indicate an arbitrary process or thread. Specifying just a process, as | |
33112 | @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}. It is an | |
33113 | error to specify all processes but a specific thread, such as | |
33114 | @samp{p-1.@var{tid}}. Note that the @samp{p} prefix is @emph{not} used | |
33115 | for those packets and replies explicitly documented to include a process | |
33116 | ID, rather than a @var{thread-id}. | |
33117 | ||
33118 | The multiprocess @var{thread-id} syntax extensions are only used if both | |
33119 | @value{GDBN} and the stub report support for the @samp{multiprocess} | |
33120 | feature using @samp{qSupported}. @xref{multiprocess extensions}, for | |
33121 | more information. | |
33122 | ||
8ffe2530 JB |
33123 | Note that all packet forms beginning with an upper- or lower-case |
33124 | letter, other than those described here, are reserved for future use. | |
33125 | ||
b8ff78ce | 33126 | Here are the packet descriptions. |
ee2d5c50 | 33127 | |
b8ff78ce | 33128 | @table @samp |
ee2d5c50 | 33129 | |
b8ff78ce JB |
33130 | @item ! |
33131 | @cindex @samp{!} packet | |
2d717e4f | 33132 | @anchor{extended mode} |
8e04817f AC |
33133 | Enable extended mode. In extended mode, the remote server is made |
33134 | persistent. The @samp{R} packet is used to restart the program being | |
33135 | debugged. | |
ee2d5c50 AC |
33136 | |
33137 | Reply: | |
33138 | @table @samp | |
33139 | @item OK | |
8e04817f | 33140 | The remote target both supports and has enabled extended mode. |
ee2d5c50 | 33141 | @end table |
c906108c | 33142 | |
b8ff78ce JB |
33143 | @item ? |
33144 | @cindex @samp{?} packet | |
ee2d5c50 | 33145 | Indicate the reason the target halted. The reply is the same as for |
8b23ecc4 SL |
33146 | step and continue. This packet has a special interpretation when the |
33147 | target is in non-stop mode; see @ref{Remote Non-Stop}. | |
c906108c | 33148 | |
ee2d5c50 AC |
33149 | Reply: |
33150 | @xref{Stop Reply Packets}, for the reply specifications. | |
33151 | ||
b8ff78ce JB |
33152 | @item A @var{arglen},@var{argnum},@var{arg},@dots{} |
33153 | @cindex @samp{A} packet | |
33154 | Initialized @code{argv[]} array passed into program. @var{arglen} | |
33155 | specifies the number of bytes in the hex encoded byte stream | |
33156 | @var{arg}. See @code{gdbserver} for more details. | |
ee2d5c50 AC |
33157 | |
33158 | Reply: | |
33159 | @table @samp | |
33160 | @item OK | |
b8ff78ce JB |
33161 | The arguments were set. |
33162 | @item E @var{NN} | |
33163 | An error occurred. | |
ee2d5c50 AC |
33164 | @end table |
33165 | ||
b8ff78ce JB |
33166 | @item b @var{baud} |
33167 | @cindex @samp{b} packet | |
33168 | (Don't use this packet; its behavior is not well-defined.) | |
ee2d5c50 AC |
33169 | Change the serial line speed to @var{baud}. |
33170 | ||
33171 | JTC: @emph{When does the transport layer state change? When it's | |
33172 | received, or after the ACK is transmitted. In either case, there are | |
33173 | problems if the command or the acknowledgment packet is dropped.} | |
33174 | ||
33175 | Stan: @emph{If people really wanted to add something like this, and get | |
33176 | it working for the first time, they ought to modify ser-unix.c to send | |
33177 | some kind of out-of-band message to a specially-setup stub and have the | |
33178 | switch happen "in between" packets, so that from remote protocol's point | |
33179 | of view, nothing actually happened.} | |
33180 | ||
b8ff78ce JB |
33181 | @item B @var{addr},@var{mode} |
33182 | @cindex @samp{B} packet | |
8e04817f | 33183 | Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a |
2f870471 AC |
33184 | breakpoint at @var{addr}. |
33185 | ||
b8ff78ce | 33186 | Don't use this packet. Use the @samp{Z} and @samp{z} packets instead |
2f870471 | 33187 | (@pxref{insert breakpoint or watchpoint packet}). |
c906108c | 33188 | |
bacec72f | 33189 | @cindex @samp{bc} packet |
0d772ac9 MS |
33190 | @anchor{bc} |
33191 | @item bc | |
bacec72f MS |
33192 | Backward continue. Execute the target system in reverse. No parameter. |
33193 | @xref{Reverse Execution}, for more information. | |
33194 | ||
33195 | Reply: | |
33196 | @xref{Stop Reply Packets}, for the reply specifications. | |
33197 | ||
bacec72f | 33198 | @cindex @samp{bs} packet |
0d772ac9 MS |
33199 | @anchor{bs} |
33200 | @item bs | |
bacec72f MS |
33201 | Backward single step. Execute one instruction in reverse. No parameter. |
33202 | @xref{Reverse Execution}, for more information. | |
33203 | ||
33204 | Reply: | |
33205 | @xref{Stop Reply Packets}, for the reply specifications. | |
33206 | ||
4f553f88 | 33207 | @item c @r{[}@var{addr}@r{]} |
b8ff78ce JB |
33208 | @cindex @samp{c} packet |
33209 | Continue. @var{addr} is address to resume. If @var{addr} is omitted, | |
33210 | resume at current address. | |
c906108c | 33211 | |
393eab54 PA |
33212 | This packet is deprecated for multi-threading support. @xref{vCont |
33213 | packet}. | |
33214 | ||
ee2d5c50 AC |
33215 | Reply: |
33216 | @xref{Stop Reply Packets}, for the reply specifications. | |
33217 | ||
4f553f88 | 33218 | @item C @var{sig}@r{[};@var{addr}@r{]} |
b8ff78ce | 33219 | @cindex @samp{C} packet |
8e04817f | 33220 | Continue with signal @var{sig} (hex signal number). If |
b8ff78ce | 33221 | @samp{;@var{addr}} is omitted, resume at same address. |
c906108c | 33222 | |
393eab54 PA |
33223 | This packet is deprecated for multi-threading support. @xref{vCont |
33224 | packet}. | |
33225 | ||
ee2d5c50 AC |
33226 | Reply: |
33227 | @xref{Stop Reply Packets}, for the reply specifications. | |
c906108c | 33228 | |
b8ff78ce JB |
33229 | @item d |
33230 | @cindex @samp{d} packet | |
ee2d5c50 AC |
33231 | Toggle debug flag. |
33232 | ||
b8ff78ce JB |
33233 | Don't use this packet; instead, define a general set packet |
33234 | (@pxref{General Query Packets}). | |
ee2d5c50 | 33235 | |
b8ff78ce | 33236 | @item D |
b90a069a | 33237 | @itemx D;@var{pid} |
b8ff78ce | 33238 | @cindex @samp{D} packet |
b90a069a SL |
33239 | The first form of the packet is used to detach @value{GDBN} from the |
33240 | remote system. It is sent to the remote target | |
07f31aa6 | 33241 | before @value{GDBN} disconnects via the @code{detach} command. |
ee2d5c50 | 33242 | |
b90a069a SL |
33243 | The second form, including a process ID, is used when multiprocess |
33244 | protocol extensions are enabled (@pxref{multiprocess extensions}), to | |
33245 | detach only a specific process. The @var{pid} is specified as a | |
33246 | big-endian hex string. | |
33247 | ||
ee2d5c50 AC |
33248 | Reply: |
33249 | @table @samp | |
10fac096 NW |
33250 | @item OK |
33251 | for success | |
b8ff78ce | 33252 | @item E @var{NN} |
10fac096 | 33253 | for an error |
ee2d5c50 | 33254 | @end table |
c906108c | 33255 | |
b8ff78ce JB |
33256 | @item F @var{RC},@var{EE},@var{CF};@var{XX} |
33257 | @cindex @samp{F} packet | |
33258 | A reply from @value{GDBN} to an @samp{F} packet sent by the target. | |
33259 | This is part of the File-I/O protocol extension. @xref{File-I/O | |
79a6e687 | 33260 | Remote Protocol Extension}, for the specification. |
ee2d5c50 | 33261 | |
b8ff78ce | 33262 | @item g |
ee2d5c50 | 33263 | @anchor{read registers packet} |
b8ff78ce | 33264 | @cindex @samp{g} packet |
ee2d5c50 AC |
33265 | Read general registers. |
33266 | ||
33267 | Reply: | |
33268 | @table @samp | |
33269 | @item @var{XX@dots{}} | |
8e04817f AC |
33270 | Each byte of register data is described by two hex digits. The bytes |
33271 | with the register are transmitted in target byte order. The size of | |
b8ff78ce | 33272 | each register and their position within the @samp{g} packet are |
4a9bb1df UW |
33273 | determined by the @value{GDBN} internal gdbarch functions |
33274 | @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}. The | |
b8ff78ce | 33275 | specification of several standard @samp{g} packets is specified below. |
ad196637 PA |
33276 | |
33277 | When reading registers from a trace frame (@pxref{Analyze Collected | |
33278 | Data,,Using the Collected Data}), the stub may also return a string of | |
33279 | literal @samp{x}'s in place of the register data digits, to indicate | |
33280 | that the corresponding register has not been collected, thus its value | |
33281 | is unavailable. For example, for an architecture with 4 registers of | |
33282 | 4 bytes each, the following reply indicates to @value{GDBN} that | |
33283 | registers 0 and 2 have not been collected, while registers 1 and 3 | |
33284 | have been collected, and both have zero value: | |
33285 | ||
33286 | @smallexample | |
33287 | -> @code{g} | |
33288 | <- @code{xxxxxxxx00000000xxxxxxxx00000000} | |
33289 | @end smallexample | |
33290 | ||
b8ff78ce | 33291 | @item E @var{NN} |
ee2d5c50 AC |
33292 | for an error. |
33293 | @end table | |
c906108c | 33294 | |
b8ff78ce JB |
33295 | @item G @var{XX@dots{}} |
33296 | @cindex @samp{G} packet | |
33297 | Write general registers. @xref{read registers packet}, for a | |
33298 | description of the @var{XX@dots{}} data. | |
ee2d5c50 AC |
33299 | |
33300 | Reply: | |
33301 | @table @samp | |
33302 | @item OK | |
33303 | for success | |
b8ff78ce | 33304 | @item E @var{NN} |
ee2d5c50 AC |
33305 | for an error |
33306 | @end table | |
33307 | ||
393eab54 | 33308 | @item H @var{op} @var{thread-id} |
b8ff78ce | 33309 | @cindex @samp{H} packet |
8e04817f | 33310 | Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g}, |
393eab54 PA |
33311 | @samp{G}, et.al.). @var{op} depends on the operation to be performed: |
33312 | it should be @samp{c} for step and continue operations (note that this | |
33313 | is deprecated, supporting the @samp{vCont} command is a better | |
33314 | option), @samp{g} for other operations. The thread designator | |
33315 | @var{thread-id} has the format and interpretation described in | |
33316 | @ref{thread-id syntax}. | |
ee2d5c50 AC |
33317 | |
33318 | Reply: | |
33319 | @table @samp | |
33320 | @item OK | |
33321 | for success | |
b8ff78ce | 33322 | @item E @var{NN} |
ee2d5c50 AC |
33323 | for an error |
33324 | @end table | |
c906108c | 33325 | |
8e04817f AC |
33326 | @c FIXME: JTC: |
33327 | @c 'H': How restrictive (or permissive) is the thread model. If a | |
33328 | @c thread is selected and stopped, are other threads allowed | |
33329 | @c to continue to execute? As I mentioned above, I think the | |
33330 | @c semantics of each command when a thread is selected must be | |
33331 | @c described. For example: | |
33332 | @c | |
33333 | @c 'g': If the stub supports threads and a specific thread is | |
33334 | @c selected, returns the register block from that thread; | |
33335 | @c otherwise returns current registers. | |
33336 | @c | |
33337 | @c 'G' If the stub supports threads and a specific thread is | |
33338 | @c selected, sets the registers of the register block of | |
33339 | @c that thread; otherwise sets current registers. | |
c906108c | 33340 | |
b8ff78ce | 33341 | @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]} |
ee2d5c50 | 33342 | @anchor{cycle step packet} |
b8ff78ce JB |
33343 | @cindex @samp{i} packet |
33344 | Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is | |
8e04817f AC |
33345 | present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle |
33346 | step starting at that address. | |
c906108c | 33347 | |
b8ff78ce JB |
33348 | @item I |
33349 | @cindex @samp{I} packet | |
33350 | Signal, then cycle step. @xref{step with signal packet}. @xref{cycle | |
33351 | step packet}. | |
ee2d5c50 | 33352 | |
b8ff78ce JB |
33353 | @item k |
33354 | @cindex @samp{k} packet | |
33355 | Kill request. | |
c906108c | 33356 | |
ac282366 | 33357 | FIXME: @emph{There is no description of how to operate when a specific |
ee2d5c50 AC |
33358 | thread context has been selected (i.e.@: does 'k' kill only that |
33359 | thread?)}. | |
c906108c | 33360 | |
b8ff78ce JB |
33361 | @item m @var{addr},@var{length} |
33362 | @cindex @samp{m} packet | |
8e04817f | 33363 | Read @var{length} bytes of memory starting at address @var{addr}. |
fb031cdf JB |
33364 | Note that @var{addr} may not be aligned to any particular boundary. |
33365 | ||
33366 | The stub need not use any particular size or alignment when gathering | |
33367 | data from memory for the response; even if @var{addr} is word-aligned | |
33368 | and @var{length} is a multiple of the word size, the stub is free to | |
33369 | use byte accesses, or not. For this reason, this packet may not be | |
33370 | suitable for accessing memory-mapped I/O devices. | |
c43c5473 JB |
33371 | @cindex alignment of remote memory accesses |
33372 | @cindex size of remote memory accesses | |
33373 | @cindex memory, alignment and size of remote accesses | |
c906108c | 33374 | |
ee2d5c50 AC |
33375 | Reply: |
33376 | @table @samp | |
33377 | @item @var{XX@dots{}} | |
599b237a | 33378 | Memory contents; each byte is transmitted as a two-digit hexadecimal |
b8ff78ce JB |
33379 | number. The reply may contain fewer bytes than requested if the |
33380 | server was able to read only part of the region of memory. | |
33381 | @item E @var{NN} | |
ee2d5c50 AC |
33382 | @var{NN} is errno |
33383 | @end table | |
33384 | ||
b8ff78ce JB |
33385 | @item M @var{addr},@var{length}:@var{XX@dots{}} |
33386 | @cindex @samp{M} packet | |
8e04817f | 33387 | Write @var{length} bytes of memory starting at address @var{addr}. |
b8ff78ce | 33388 | @var{XX@dots{}} is the data; each byte is transmitted as a two-digit |
599b237a | 33389 | hexadecimal number. |
ee2d5c50 AC |
33390 | |
33391 | Reply: | |
33392 | @table @samp | |
33393 | @item OK | |
33394 | for success | |
b8ff78ce | 33395 | @item E @var{NN} |
8e04817f AC |
33396 | for an error (this includes the case where only part of the data was |
33397 | written). | |
ee2d5c50 | 33398 | @end table |
c906108c | 33399 | |
b8ff78ce JB |
33400 | @item p @var{n} |
33401 | @cindex @samp{p} packet | |
33402 | Read the value of register @var{n}; @var{n} is in hex. | |
2e868123 AC |
33403 | @xref{read registers packet}, for a description of how the returned |
33404 | register value is encoded. | |
ee2d5c50 AC |
33405 | |
33406 | Reply: | |
33407 | @table @samp | |
2e868123 AC |
33408 | @item @var{XX@dots{}} |
33409 | the register's value | |
b8ff78ce | 33410 | @item E @var{NN} |
2e868123 AC |
33411 | for an error |
33412 | @item | |
33413 | Indicating an unrecognized @var{query}. | |
ee2d5c50 AC |
33414 | @end table |
33415 | ||
b8ff78ce | 33416 | @item P @var{n@dots{}}=@var{r@dots{}} |
ee2d5c50 | 33417 | @anchor{write register packet} |
b8ff78ce JB |
33418 | @cindex @samp{P} packet |
33419 | Write register @var{n@dots{}} with value @var{r@dots{}}. The register | |
599b237a | 33420 | number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex |
8e04817f | 33421 | digits for each byte in the register (target byte order). |
c906108c | 33422 | |
ee2d5c50 AC |
33423 | Reply: |
33424 | @table @samp | |
33425 | @item OK | |
33426 | for success | |
b8ff78ce | 33427 | @item E @var{NN} |
ee2d5c50 AC |
33428 | for an error |
33429 | @end table | |
33430 | ||
5f3bebba JB |
33431 | @item q @var{name} @var{params}@dots{} |
33432 | @itemx Q @var{name} @var{params}@dots{} | |
b8ff78ce | 33433 | @cindex @samp{q} packet |
b8ff78ce | 33434 | @cindex @samp{Q} packet |
5f3bebba JB |
33435 | General query (@samp{q}) and set (@samp{Q}). These packets are |
33436 | described fully in @ref{General Query Packets}. | |
c906108c | 33437 | |
b8ff78ce JB |
33438 | @item r |
33439 | @cindex @samp{r} packet | |
8e04817f | 33440 | Reset the entire system. |
c906108c | 33441 | |
b8ff78ce | 33442 | Don't use this packet; use the @samp{R} packet instead. |
ee2d5c50 | 33443 | |
b8ff78ce JB |
33444 | @item R @var{XX} |
33445 | @cindex @samp{R} packet | |
8e04817f | 33446 | Restart the program being debugged. @var{XX}, while needed, is ignored. |
2d717e4f | 33447 | This packet is only available in extended mode (@pxref{extended mode}). |
ee2d5c50 | 33448 | |
8e04817f | 33449 | The @samp{R} packet has no reply. |
ee2d5c50 | 33450 | |
4f553f88 | 33451 | @item s @r{[}@var{addr}@r{]} |
b8ff78ce JB |
33452 | @cindex @samp{s} packet |
33453 | Single step. @var{addr} is the address at which to resume. If | |
33454 | @var{addr} is omitted, resume at same address. | |
c906108c | 33455 | |
393eab54 PA |
33456 | This packet is deprecated for multi-threading support. @xref{vCont |
33457 | packet}. | |
33458 | ||
ee2d5c50 AC |
33459 | Reply: |
33460 | @xref{Stop Reply Packets}, for the reply specifications. | |
33461 | ||
4f553f88 | 33462 | @item S @var{sig}@r{[};@var{addr}@r{]} |
ee2d5c50 | 33463 | @anchor{step with signal packet} |
b8ff78ce JB |
33464 | @cindex @samp{S} packet |
33465 | Step with signal. This is analogous to the @samp{C} packet, but | |
33466 | requests a single-step, rather than a normal resumption of execution. | |
c906108c | 33467 | |
393eab54 PA |
33468 | This packet is deprecated for multi-threading support. @xref{vCont |
33469 | packet}. | |
33470 | ||
ee2d5c50 AC |
33471 | Reply: |
33472 | @xref{Stop Reply Packets}, for the reply specifications. | |
33473 | ||
b8ff78ce JB |
33474 | @item t @var{addr}:@var{PP},@var{MM} |
33475 | @cindex @samp{t} packet | |
8e04817f | 33476 | Search backwards starting at address @var{addr} for a match with pattern |
ee2d5c50 AC |
33477 | @var{PP} and mask @var{MM}. @var{PP} and @var{MM} are 4 bytes. |
33478 | @var{addr} must be at least 3 digits. | |
c906108c | 33479 | |
b90a069a | 33480 | @item T @var{thread-id} |
b8ff78ce | 33481 | @cindex @samp{T} packet |
b90a069a | 33482 | Find out if the thread @var{thread-id} is alive. @xref{thread-id syntax}. |
c906108c | 33483 | |
ee2d5c50 AC |
33484 | Reply: |
33485 | @table @samp | |
33486 | @item OK | |
33487 | thread is still alive | |
b8ff78ce | 33488 | @item E @var{NN} |
ee2d5c50 AC |
33489 | thread is dead |
33490 | @end table | |
33491 | ||
b8ff78ce JB |
33492 | @item v |
33493 | Packets starting with @samp{v} are identified by a multi-letter name, | |
33494 | up to the first @samp{;} or @samp{?} (or the end of the packet). | |
86d30acc | 33495 | |
2d717e4f DJ |
33496 | @item vAttach;@var{pid} |
33497 | @cindex @samp{vAttach} packet | |
8b23ecc4 SL |
33498 | Attach to a new process with the specified process ID @var{pid}. |
33499 | The process ID is a | |
33500 | hexadecimal integer identifying the process. In all-stop mode, all | |
33501 | threads in the attached process are stopped; in non-stop mode, it may be | |
33502 | attached without being stopped if that is supported by the target. | |
33503 | ||
33504 | @c In non-stop mode, on a successful vAttach, the stub should set the | |
33505 | @c current thread to a thread of the newly-attached process. After | |
33506 | @c attaching, GDB queries for the attached process's thread ID with qC. | |
33507 | @c Also note that, from a user perspective, whether or not the | |
33508 | @c target is stopped on attach in non-stop mode depends on whether you | |
33509 | @c use the foreground or background version of the attach command, not | |
33510 | @c on what vAttach does; GDB does the right thing with respect to either | |
33511 | @c stopping or restarting threads. | |
2d717e4f DJ |
33512 | |
33513 | This packet is only available in extended mode (@pxref{extended mode}). | |
33514 | ||
33515 | Reply: | |
33516 | @table @samp | |
33517 | @item E @var{nn} | |
33518 | for an error | |
33519 | @item @r{Any stop packet} | |
8b23ecc4 SL |
33520 | for success in all-stop mode (@pxref{Stop Reply Packets}) |
33521 | @item OK | |
33522 | for success in non-stop mode (@pxref{Remote Non-Stop}) | |
2d717e4f DJ |
33523 | @end table |
33524 | ||
b90a069a | 33525 | @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{} |
b8ff78ce | 33526 | @cindex @samp{vCont} packet |
393eab54 | 33527 | @anchor{vCont packet} |
b8ff78ce | 33528 | Resume the inferior, specifying different actions for each thread. |
b90a069a | 33529 | If an action is specified with no @var{thread-id}, then it is applied to any |
86d30acc | 33530 | threads that don't have a specific action specified; if no default action is |
8b23ecc4 SL |
33531 | specified then other threads should remain stopped in all-stop mode and |
33532 | in their current state in non-stop mode. | |
33533 | Specifying multiple | |
86d30acc | 33534 | default actions is an error; specifying no actions is also an error. |
b90a069a SL |
33535 | Thread IDs are specified using the syntax described in @ref{thread-id syntax}. |
33536 | ||
33537 | Currently supported actions are: | |
86d30acc | 33538 | |
b8ff78ce | 33539 | @table @samp |
86d30acc DJ |
33540 | @item c |
33541 | Continue. | |
b8ff78ce | 33542 | @item C @var{sig} |
8b23ecc4 | 33543 | Continue with signal @var{sig}. The signal @var{sig} should be two hex digits. |
86d30acc DJ |
33544 | @item s |
33545 | Step. | |
b8ff78ce | 33546 | @item S @var{sig} |
8b23ecc4 SL |
33547 | Step with signal @var{sig}. The signal @var{sig} should be two hex digits. |
33548 | @item t | |
33549 | Stop. | |
86d30acc DJ |
33550 | @end table |
33551 | ||
8b23ecc4 SL |
33552 | The optional argument @var{addr} normally associated with the |
33553 | @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is | |
b8ff78ce | 33554 | not supported in @samp{vCont}. |
86d30acc | 33555 | |
08a0efd0 PA |
33556 | The @samp{t} action is only relevant in non-stop mode |
33557 | (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise. | |
8b23ecc4 SL |
33558 | A stop reply should be generated for any affected thread not already stopped. |
33559 | When a thread is stopped by means of a @samp{t} action, | |
33560 | the corresponding stop reply should indicate that the thread has stopped with | |
33561 | signal @samp{0}, regardless of whether the target uses some other signal | |
33562 | as an implementation detail. | |
33563 | ||
86d30acc DJ |
33564 | Reply: |
33565 | @xref{Stop Reply Packets}, for the reply specifications. | |
33566 | ||
b8ff78ce JB |
33567 | @item vCont? |
33568 | @cindex @samp{vCont?} packet | |
d3e8051b | 33569 | Request a list of actions supported by the @samp{vCont} packet. |
86d30acc DJ |
33570 | |
33571 | Reply: | |
33572 | @table @samp | |
b8ff78ce JB |
33573 | @item vCont@r{[};@var{action}@dots{}@r{]} |
33574 | The @samp{vCont} packet is supported. Each @var{action} is a supported | |
33575 | command in the @samp{vCont} packet. | |
86d30acc | 33576 | @item |
b8ff78ce | 33577 | The @samp{vCont} packet is not supported. |
86d30acc | 33578 | @end table |
ee2d5c50 | 33579 | |
a6b151f1 DJ |
33580 | @item vFile:@var{operation}:@var{parameter}@dots{} |
33581 | @cindex @samp{vFile} packet | |
33582 | Perform a file operation on the target system. For details, | |
33583 | see @ref{Host I/O Packets}. | |
33584 | ||
68437a39 DJ |
33585 | @item vFlashErase:@var{addr},@var{length} |
33586 | @cindex @samp{vFlashErase} packet | |
33587 | Direct the stub to erase @var{length} bytes of flash starting at | |
33588 | @var{addr}. The region may enclose any number of flash blocks, but | |
33589 | its start and end must fall on block boundaries, as indicated by the | |
79a6e687 BW |
33590 | flash block size appearing in the memory map (@pxref{Memory Map |
33591 | Format}). @value{GDBN} groups flash memory programming operations | |
68437a39 DJ |
33592 | together, and sends a @samp{vFlashDone} request after each group; the |
33593 | stub is allowed to delay erase operation until the @samp{vFlashDone} | |
33594 | packet is received. | |
33595 | ||
b90a069a SL |
33596 | The stub must support @samp{vCont} if it reports support for |
33597 | multiprocess extensions (@pxref{multiprocess extensions}). Note that in | |
33598 | this case @samp{vCont} actions can be specified to apply to all threads | |
33599 | in a process by using the @samp{p@var{pid}.-1} form of the | |
33600 | @var{thread-id}. | |
33601 | ||
68437a39 DJ |
33602 | Reply: |
33603 | @table @samp | |
33604 | @item OK | |
33605 | for success | |
33606 | @item E @var{NN} | |
33607 | for an error | |
33608 | @end table | |
33609 | ||
33610 | @item vFlashWrite:@var{addr}:@var{XX@dots{}} | |
33611 | @cindex @samp{vFlashWrite} packet | |
33612 | Direct the stub to write data to flash address @var{addr}. The data | |
33613 | is passed in binary form using the same encoding as for the @samp{X} | |
33614 | packet (@pxref{Binary Data}). The memory ranges specified by | |
33615 | @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must | |
33616 | not overlap, and must appear in order of increasing addresses | |
33617 | (although @samp{vFlashErase} packets for higher addresses may already | |
33618 | have been received; the ordering is guaranteed only between | |
33619 | @samp{vFlashWrite} packets). If a packet writes to an address that was | |
33620 | neither erased by a preceding @samp{vFlashErase} packet nor by some other | |
33621 | target-specific method, the results are unpredictable. | |
33622 | ||
33623 | ||
33624 | Reply: | |
33625 | @table @samp | |
33626 | @item OK | |
33627 | for success | |
33628 | @item E.memtype | |
33629 | for vFlashWrite addressing non-flash memory | |
33630 | @item E @var{NN} | |
33631 | for an error | |
33632 | @end table | |
33633 | ||
33634 | @item vFlashDone | |
33635 | @cindex @samp{vFlashDone} packet | |
33636 | Indicate to the stub that flash programming operation is finished. | |
33637 | The stub is permitted to delay or batch the effects of a group of | |
33638 | @samp{vFlashErase} and @samp{vFlashWrite} packets until a | |
33639 | @samp{vFlashDone} packet is received. The contents of the affected | |
33640 | regions of flash memory are unpredictable until the @samp{vFlashDone} | |
33641 | request is completed. | |
33642 | ||
b90a069a SL |
33643 | @item vKill;@var{pid} |
33644 | @cindex @samp{vKill} packet | |
33645 | Kill the process with the specified process ID. @var{pid} is a | |
33646 | hexadecimal integer identifying the process. This packet is used in | |
33647 | preference to @samp{k} when multiprocess protocol extensions are | |
33648 | supported; see @ref{multiprocess extensions}. | |
33649 | ||
33650 | Reply: | |
33651 | @table @samp | |
33652 | @item E @var{nn} | |
33653 | for an error | |
33654 | @item OK | |
33655 | for success | |
33656 | @end table | |
33657 | ||
2d717e4f DJ |
33658 | @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{} |
33659 | @cindex @samp{vRun} packet | |
33660 | Run the program @var{filename}, passing it each @var{argument} on its | |
33661 | command line. The file and arguments are hex-encoded strings. If | |
33662 | @var{filename} is an empty string, the stub may use a default program | |
33663 | (e.g.@: the last program run). The program is created in the stopped | |
9b562ab8 | 33664 | state. |
2d717e4f | 33665 | |
8b23ecc4 SL |
33666 | @c FIXME: What about non-stop mode? |
33667 | ||
2d717e4f DJ |
33668 | This packet is only available in extended mode (@pxref{extended mode}). |
33669 | ||
33670 | Reply: | |
33671 | @table @samp | |
33672 | @item E @var{nn} | |
33673 | for an error | |
33674 | @item @r{Any stop packet} | |
33675 | for success (@pxref{Stop Reply Packets}) | |
33676 | @end table | |
33677 | ||
8b23ecc4 SL |
33678 | @item vStopped |
33679 | @anchor{vStopped packet} | |
33680 | @cindex @samp{vStopped} packet | |
33681 | ||
33682 | In non-stop mode (@pxref{Remote Non-Stop}), acknowledge a previous stop | |
33683 | reply and prompt for the stub to report another one. | |
33684 | ||
33685 | Reply: | |
33686 | @table @samp | |
33687 | @item @r{Any stop packet} | |
33688 | if there is another unreported stop event (@pxref{Stop Reply Packets}) | |
33689 | @item OK | |
33690 | if there are no unreported stop events | |
33691 | @end table | |
33692 | ||
b8ff78ce | 33693 | @item X @var{addr},@var{length}:@var{XX@dots{}} |
9a6253be | 33694 | @anchor{X packet} |
b8ff78ce JB |
33695 | @cindex @samp{X} packet |
33696 | Write data to memory, where the data is transmitted in binary. | |
33697 | @var{addr} is address, @var{length} is number of bytes, | |
0876f84a | 33698 | @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}). |
c906108c | 33699 | |
ee2d5c50 AC |
33700 | Reply: |
33701 | @table @samp | |
33702 | @item OK | |
33703 | for success | |
b8ff78ce | 33704 | @item E @var{NN} |
ee2d5c50 AC |
33705 | for an error |
33706 | @end table | |
33707 | ||
a1dcb23a DJ |
33708 | @item z @var{type},@var{addr},@var{kind} |
33709 | @itemx Z @var{type},@var{addr},@var{kind} | |
2f870471 | 33710 | @anchor{insert breakpoint or watchpoint packet} |
b8ff78ce JB |
33711 | @cindex @samp{z} packet |
33712 | @cindex @samp{Z} packets | |
33713 | Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or | |
a1dcb23a | 33714 | watchpoint starting at address @var{address} of kind @var{kind}. |
ee2d5c50 | 33715 | |
2f870471 AC |
33716 | Each breakpoint and watchpoint packet @var{type} is documented |
33717 | separately. | |
33718 | ||
512217c7 AC |
33719 | @emph{Implementation notes: A remote target shall return an empty string |
33720 | for an unrecognized breakpoint or watchpoint packet @var{type}. A | |
33721 | remote target shall support either both or neither of a given | |
b8ff78ce | 33722 | @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To |
2f870471 AC |
33723 | avoid potential problems with duplicate packets, the operations should |
33724 | be implemented in an idempotent way.} | |
33725 | ||
a1dcb23a DJ |
33726 | @item z0,@var{addr},@var{kind} |
33727 | @itemx Z0,@var{addr},@var{kind} | |
b8ff78ce JB |
33728 | @cindex @samp{z0} packet |
33729 | @cindex @samp{Z0} packet | |
33730 | Insert (@samp{Z0}) or remove (@samp{z0}) a memory breakpoint at address | |
a1dcb23a | 33731 | @var{addr} of type @var{kind}. |
2f870471 AC |
33732 | |
33733 | A memory breakpoint is implemented by replacing the instruction at | |
33734 | @var{addr} with a software breakpoint or trap instruction. The | |
a1dcb23a DJ |
33735 | @var{kind} is target-specific and typically indicates the size of |
33736 | the breakpoint in bytes that should be inserted. E.g., the @sc{arm} | |
33737 | and @sc{mips} can insert either a 2 or 4 byte breakpoint. Some | |
33738 | architectures have additional meanings for @var{kind}; | |
33739 | see @ref{Architecture-Specific Protocol Details}. | |
c906108c | 33740 | |
2f870471 AC |
33741 | @emph{Implementation note: It is possible for a target to copy or move |
33742 | code that contains memory breakpoints (e.g., when implementing | |
33743 | overlays). The behavior of this packet, in the presence of such a | |
33744 | target, is not defined.} | |
c906108c | 33745 | |
ee2d5c50 AC |
33746 | Reply: |
33747 | @table @samp | |
2f870471 AC |
33748 | @item OK |
33749 | success | |
33750 | @item | |
33751 | not supported | |
b8ff78ce | 33752 | @item E @var{NN} |
ee2d5c50 | 33753 | for an error |
2f870471 AC |
33754 | @end table |
33755 | ||
a1dcb23a DJ |
33756 | @item z1,@var{addr},@var{kind} |
33757 | @itemx Z1,@var{addr},@var{kind} | |
b8ff78ce JB |
33758 | @cindex @samp{z1} packet |
33759 | @cindex @samp{Z1} packet | |
33760 | Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at | |
a1dcb23a | 33761 | address @var{addr}. |
2f870471 AC |
33762 | |
33763 | A hardware breakpoint is implemented using a mechanism that is not | |
a1dcb23a DJ |
33764 | dependant on being able to modify the target's memory. @var{kind} |
33765 | has the same meaning as in @samp{Z0} packets. | |
2f870471 AC |
33766 | |
33767 | @emph{Implementation note: A hardware breakpoint is not affected by code | |
33768 | movement.} | |
33769 | ||
33770 | Reply: | |
33771 | @table @samp | |
ee2d5c50 | 33772 | @item OK |
2f870471 AC |
33773 | success |
33774 | @item | |
33775 | not supported | |
b8ff78ce | 33776 | @item E @var{NN} |
2f870471 AC |
33777 | for an error |
33778 | @end table | |
33779 | ||
a1dcb23a DJ |
33780 | @item z2,@var{addr},@var{kind} |
33781 | @itemx Z2,@var{addr},@var{kind} | |
b8ff78ce JB |
33782 | @cindex @samp{z2} packet |
33783 | @cindex @samp{Z2} packet | |
a1dcb23a DJ |
33784 | Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}. |
33785 | @var{kind} is interpreted as the number of bytes to watch. | |
2f870471 AC |
33786 | |
33787 | Reply: | |
33788 | @table @samp | |
33789 | @item OK | |
33790 | success | |
33791 | @item | |
33792 | not supported | |
b8ff78ce | 33793 | @item E @var{NN} |
2f870471 AC |
33794 | for an error |
33795 | @end table | |
33796 | ||
a1dcb23a DJ |
33797 | @item z3,@var{addr},@var{kind} |
33798 | @itemx Z3,@var{addr},@var{kind} | |
b8ff78ce JB |
33799 | @cindex @samp{z3} packet |
33800 | @cindex @samp{Z3} packet | |
a1dcb23a DJ |
33801 | Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}. |
33802 | @var{kind} is interpreted as the number of bytes to watch. | |
2f870471 AC |
33803 | |
33804 | Reply: | |
33805 | @table @samp | |
33806 | @item OK | |
33807 | success | |
33808 | @item | |
33809 | not supported | |
b8ff78ce | 33810 | @item E @var{NN} |
2f870471 AC |
33811 | for an error |
33812 | @end table | |
33813 | ||
a1dcb23a DJ |
33814 | @item z4,@var{addr},@var{kind} |
33815 | @itemx Z4,@var{addr},@var{kind} | |
b8ff78ce JB |
33816 | @cindex @samp{z4} packet |
33817 | @cindex @samp{Z4} packet | |
a1dcb23a DJ |
33818 | Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}. |
33819 | @var{kind} is interpreted as the number of bytes to watch. | |
2f870471 AC |
33820 | |
33821 | Reply: | |
33822 | @table @samp | |
33823 | @item OK | |
33824 | success | |
33825 | @item | |
33826 | not supported | |
b8ff78ce | 33827 | @item E @var{NN} |
2f870471 | 33828 | for an error |
ee2d5c50 AC |
33829 | @end table |
33830 | ||
33831 | @end table | |
c906108c | 33832 | |
ee2d5c50 AC |
33833 | @node Stop Reply Packets |
33834 | @section Stop Reply Packets | |
33835 | @cindex stop reply packets | |
c906108c | 33836 | |
8b23ecc4 SL |
33837 | The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont}, |
33838 | @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can | |
33839 | receive any of the below as a reply. Except for @samp{?} | |
33840 | and @samp{vStopped}, that reply is only returned | |
b8ff78ce | 33841 | when the target halts. In the below the exact meaning of @dfn{signal |
89be2091 DJ |
33842 | number} is defined by the header @file{include/gdb/signals.h} in the |
33843 | @value{GDBN} source code. | |
c906108c | 33844 | |
b8ff78ce JB |
33845 | As in the description of request packets, we include spaces in the |
33846 | reply templates for clarity; these are not part of the reply packet's | |
33847 | syntax. No @value{GDBN} stop reply packet uses spaces to separate its | |
33848 | components. | |
c906108c | 33849 | |
b8ff78ce | 33850 | @table @samp |
ee2d5c50 | 33851 | |
b8ff78ce | 33852 | @item S @var{AA} |
599b237a | 33853 | The program received signal number @var{AA} (a two-digit hexadecimal |
940178d3 JB |
33854 | number). This is equivalent to a @samp{T} response with no |
33855 | @var{n}:@var{r} pairs. | |
c906108c | 33856 | |
b8ff78ce JB |
33857 | @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{} |
33858 | @cindex @samp{T} packet reply | |
599b237a | 33859 | The program received signal number @var{AA} (a two-digit hexadecimal |
940178d3 JB |
33860 | number). This is equivalent to an @samp{S} response, except that the |
33861 | @samp{@var{n}:@var{r}} pairs can carry values of important registers | |
33862 | and other information directly in the stop reply packet, reducing | |
33863 | round-trip latency. Single-step and breakpoint traps are reported | |
33864 | this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows: | |
cfa9d6d9 DJ |
33865 | |
33866 | @itemize @bullet | |
b8ff78ce | 33867 | @item |
599b237a | 33868 | If @var{n} is a hexadecimal number, it is a register number, and the |
b8ff78ce JB |
33869 | corresponding @var{r} gives that register's value. @var{r} is a |
33870 | series of bytes in target byte order, with each byte given by a | |
33871 | two-digit hex number. | |
cfa9d6d9 | 33872 | |
b8ff78ce | 33873 | @item |
b90a069a SL |
33874 | If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of |
33875 | the stopped thread, as specified in @ref{thread-id syntax}. | |
cfa9d6d9 | 33876 | |
dc146f7c VP |
33877 | @item |
33878 | If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of | |
33879 | the core on which the stop event was detected. | |
33880 | ||
b8ff78ce | 33881 | @item |
cfa9d6d9 DJ |
33882 | If @var{n} is a recognized @dfn{stop reason}, it describes a more |
33883 | specific event that stopped the target. The currently defined stop | |
33884 | reasons are listed below. @var{aa} should be @samp{05}, the trap | |
33885 | signal. At most one stop reason should be present. | |
33886 | ||
b8ff78ce JB |
33887 | @item |
33888 | Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair | |
33889 | and go on to the next; this allows us to extend the protocol in the | |
33890 | future. | |
cfa9d6d9 DJ |
33891 | @end itemize |
33892 | ||
33893 | The currently defined stop reasons are: | |
33894 | ||
33895 | @table @samp | |
33896 | @item watch | |
33897 | @itemx rwatch | |
33898 | @itemx awatch | |
33899 | The packet indicates a watchpoint hit, and @var{r} is the data address, in | |
33900 | hex. | |
33901 | ||
33902 | @cindex shared library events, remote reply | |
33903 | @item library | |
33904 | The packet indicates that the loaded libraries have changed. | |
33905 | @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new | |
33906 | list of loaded libraries. @var{r} is ignored. | |
bacec72f MS |
33907 | |
33908 | @cindex replay log events, remote reply | |
33909 | @item replaylog | |
33910 | The packet indicates that the target cannot continue replaying | |
33911 | logged execution events, because it has reached the end (or the | |
33912 | beginning when executing backward) of the log. The value of @var{r} | |
33913 | will be either @samp{begin} or @samp{end}. @xref{Reverse Execution}, | |
33914 | for more information. | |
cfa9d6d9 | 33915 | @end table |
ee2d5c50 | 33916 | |
b8ff78ce | 33917 | @item W @var{AA} |
b90a069a | 33918 | @itemx W @var{AA} ; process:@var{pid} |
8e04817f | 33919 | The process exited, and @var{AA} is the exit status. This is only |
ee2d5c50 AC |
33920 | applicable to certain targets. |
33921 | ||
b90a069a SL |
33922 | The second form of the response, including the process ID of the exited |
33923 | process, can be used only when @value{GDBN} has reported support for | |
33924 | multiprocess protocol extensions; see @ref{multiprocess extensions}. | |
33925 | The @var{pid} is formatted as a big-endian hex string. | |
33926 | ||
b8ff78ce | 33927 | @item X @var{AA} |
b90a069a | 33928 | @itemx X @var{AA} ; process:@var{pid} |
8e04817f | 33929 | The process terminated with signal @var{AA}. |
c906108c | 33930 | |
b90a069a SL |
33931 | The second form of the response, including the process ID of the |
33932 | terminated process, can be used only when @value{GDBN} has reported | |
33933 | support for multiprocess protocol extensions; see @ref{multiprocess | |
33934 | extensions}. The @var{pid} is formatted as a big-endian hex string. | |
33935 | ||
b8ff78ce JB |
33936 | @item O @var{XX}@dots{} |
33937 | @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be | |
33938 | written as the program's console output. This can happen at any time | |
33939 | while the program is running and the debugger should continue to wait | |
8b23ecc4 | 33940 | for @samp{W}, @samp{T}, etc. This reply is not permitted in non-stop mode. |
0ce1b118 | 33941 | |
b8ff78ce | 33942 | @item F @var{call-id},@var{parameter}@dots{} |
0ce1b118 CV |
33943 | @var{call-id} is the identifier which says which host system call should |
33944 | be called. This is just the name of the function. Translation into the | |
33945 | correct system call is only applicable as it's defined in @value{GDBN}. | |
79a6e687 | 33946 | @xref{File-I/O Remote Protocol Extension}, for a list of implemented |
0ce1b118 CV |
33947 | system calls. |
33948 | ||
b8ff78ce JB |
33949 | @samp{@var{parameter}@dots{}} is a list of parameters as defined for |
33950 | this very system call. | |
0ce1b118 | 33951 | |
b8ff78ce JB |
33952 | The target replies with this packet when it expects @value{GDBN} to |
33953 | call a host system call on behalf of the target. @value{GDBN} replies | |
33954 | with an appropriate @samp{F} packet and keeps up waiting for the next | |
33955 | reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S} | |
79a6e687 BW |
33956 | or @samp{s} action is expected to be continued. @xref{File-I/O Remote |
33957 | Protocol Extension}, for more details. | |
0ce1b118 | 33958 | |
ee2d5c50 AC |
33959 | @end table |
33960 | ||
33961 | @node General Query Packets | |
33962 | @section General Query Packets | |
9c16f35a | 33963 | @cindex remote query requests |
c906108c | 33964 | |
5f3bebba JB |
33965 | Packets starting with @samp{q} are @dfn{general query packets}; |
33966 | packets starting with @samp{Q} are @dfn{general set packets}. General | |
33967 | query and set packets are a semi-unified form for retrieving and | |
33968 | sending information to and from the stub. | |
33969 | ||
33970 | The initial letter of a query or set packet is followed by a name | |
33971 | indicating what sort of thing the packet applies to. For example, | |
33972 | @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol | |
33973 | definitions with the stub. These packet names follow some | |
33974 | conventions: | |
33975 | ||
33976 | @itemize @bullet | |
33977 | @item | |
33978 | The name must not contain commas, colons or semicolons. | |
33979 | @item | |
33980 | Most @value{GDBN} query and set packets have a leading upper case | |
33981 | letter. | |
33982 | @item | |
33983 | The names of custom vendor packets should use a company prefix, in | |
33984 | lower case, followed by a period. For example, packets designed at | |
33985 | the Acme Corporation might begin with @samp{qacme.foo} (for querying | |
33986 | foos) or @samp{Qacme.bar} (for setting bars). | |
33987 | @end itemize | |
33988 | ||
aa56d27a JB |
33989 | The name of a query or set packet should be separated from any |
33990 | parameters by a @samp{:}; the parameters themselves should be | |
33991 | separated by @samp{,} or @samp{;}. Stubs must be careful to match the | |
369af7bd DJ |
33992 | full packet name, and check for a separator or the end of the packet, |
33993 | in case two packet names share a common prefix. New packets should not begin | |
33994 | with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL} | |
33995 | packets predate these conventions, and have arguments without any terminator | |
33996 | for the packet name; we suspect they are in widespread use in places that | |
33997 | are difficult to upgrade. The @samp{qC} packet has no arguments, but some | |
33998 | existing stubs (e.g.@: RedBoot) are known to not check for the end of the | |
33999 | packet.}. | |
c906108c | 34000 | |
b8ff78ce JB |
34001 | Like the descriptions of the other packets, each description here |
34002 | has a template showing the packet's overall syntax, followed by an | |
34003 | explanation of the packet's meaning. We include spaces in some of the | |
34004 | templates for clarity; these are not part of the packet's syntax. No | |
34005 | @value{GDBN} packet uses spaces to separate its components. | |
34006 | ||
5f3bebba JB |
34007 | Here are the currently defined query and set packets: |
34008 | ||
b8ff78ce | 34009 | @table @samp |
c906108c | 34010 | |
d914c394 SS |
34011 | @item QAllow:@var{op}:@var{val}@dots{} |
34012 | @cindex @samp{QAllow} packet | |
34013 | Specify which operations @value{GDBN} expects to request of the | |
34014 | target, as a semicolon-separated list of operation name and value | |
34015 | pairs. Possible values for @var{op} include @samp{WriteReg}, | |
34016 | @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace}, | |
34017 | @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0, | |
34018 | indicating that @value{GDBN} will not request the operation, or 1, | |
34019 | indicating that it may. (The target can then use this to set up its | |
34020 | own internals optimally, for instance if the debugger never expects to | |
34021 | insert breakpoints, it may not need to install its own trap handler.) | |
34022 | ||
b8ff78ce | 34023 | @item qC |
9c16f35a | 34024 | @cindex current thread, remote request |
b8ff78ce | 34025 | @cindex @samp{qC} packet |
b90a069a | 34026 | Return the current thread ID. |
ee2d5c50 AC |
34027 | |
34028 | Reply: | |
34029 | @table @samp | |
b90a069a SL |
34030 | @item QC @var{thread-id} |
34031 | Where @var{thread-id} is a thread ID as documented in | |
34032 | @ref{thread-id syntax}. | |
b8ff78ce | 34033 | @item @r{(anything else)} |
b90a069a | 34034 | Any other reply implies the old thread ID. |
ee2d5c50 AC |
34035 | @end table |
34036 | ||
b8ff78ce | 34037 | @item qCRC:@var{addr},@var{length} |
ff2587ec | 34038 | @cindex CRC of memory block, remote request |
b8ff78ce | 34039 | @cindex @samp{qCRC} packet |
99e008fe EZ |
34040 | Compute the CRC checksum of a block of memory using CRC-32 defined in |
34041 | IEEE 802.3. The CRC is computed byte at a time, taking the most | |
34042 | significant bit of each byte first. The initial pattern code | |
34043 | @code{0xffffffff} is used to ensure leading zeros affect the CRC. | |
34044 | ||
34045 | @emph{Note:} This is the same CRC used in validating separate debug | |
34046 | files (@pxref{Separate Debug Files, , Debugging Information in Separate | |
34047 | Files}). However the algorithm is slightly different. When validating | |
34048 | separate debug files, the CRC is computed taking the @emph{least} | |
34049 | significant bit of each byte first, and the final result is inverted to | |
34050 | detect trailing zeros. | |
34051 | ||
ff2587ec WZ |
34052 | Reply: |
34053 | @table @samp | |
b8ff78ce | 34054 | @item E @var{NN} |
ff2587ec | 34055 | An error (such as memory fault) |
b8ff78ce JB |
34056 | @item C @var{crc32} |
34057 | The specified memory region's checksum is @var{crc32}. | |
ff2587ec WZ |
34058 | @end table |
34059 | ||
03583c20 UW |
34060 | @item QDisableRandomization:@var{value} |
34061 | @cindex disable address space randomization, remote request | |
34062 | @cindex @samp{QDisableRandomization} packet | |
34063 | Some target operating systems will randomize the virtual address space | |
34064 | of the inferior process as a security feature, but provide a feature | |
34065 | to disable such randomization, e.g.@: to allow for a more deterministic | |
34066 | debugging experience. On such systems, this packet with a @var{value} | |
34067 | of 1 directs the target to disable address space randomization for | |
34068 | processes subsequently started via @samp{vRun} packets, while a packet | |
34069 | with a @var{value} of 0 tells the target to enable address space | |
34070 | randomization. | |
34071 | ||
34072 | This packet is only available in extended mode (@pxref{extended mode}). | |
34073 | ||
34074 | Reply: | |
34075 | @table @samp | |
34076 | @item OK | |
34077 | The request succeeded. | |
34078 | ||
34079 | @item E @var{nn} | |
34080 | An error occurred. @var{nn} are hex digits. | |
34081 | ||
34082 | @item | |
34083 | An empty reply indicates that @samp{QDisableRandomization} is not supported | |
34084 | by the stub. | |
34085 | @end table | |
34086 | ||
34087 | This packet is not probed by default; the remote stub must request it, | |
34088 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34089 | This should only be done on targets that actually support disabling | |
34090 | address space randomization. | |
34091 | ||
b8ff78ce JB |
34092 | @item qfThreadInfo |
34093 | @itemx qsThreadInfo | |
9c16f35a | 34094 | @cindex list active threads, remote request |
b8ff78ce JB |
34095 | @cindex @samp{qfThreadInfo} packet |
34096 | @cindex @samp{qsThreadInfo} packet | |
b90a069a | 34097 | Obtain a list of all active thread IDs from the target (OS). Since there |
8e04817f AC |
34098 | may be too many active threads to fit into one reply packet, this query |
34099 | works iteratively: it may require more than one query/reply sequence to | |
34100 | obtain the entire list of threads. The first query of the sequence will | |
b8ff78ce JB |
34101 | be the @samp{qfThreadInfo} query; subsequent queries in the |
34102 | sequence will be the @samp{qsThreadInfo} query. | |
ee2d5c50 | 34103 | |
b8ff78ce | 34104 | NOTE: This packet replaces the @samp{qL} query (see below). |
ee2d5c50 AC |
34105 | |
34106 | Reply: | |
34107 | @table @samp | |
b90a069a SL |
34108 | @item m @var{thread-id} |
34109 | A single thread ID | |
34110 | @item m @var{thread-id},@var{thread-id}@dots{} | |
34111 | a comma-separated list of thread IDs | |
b8ff78ce JB |
34112 | @item l |
34113 | (lower case letter @samp{L}) denotes end of list. | |
ee2d5c50 AC |
34114 | @end table |
34115 | ||
34116 | In response to each query, the target will reply with a list of one or | |
b90a069a | 34117 | more thread IDs, separated by commas. |
e1aac25b | 34118 | @value{GDBN} will respond to each reply with a request for more thread |
b8ff78ce | 34119 | ids (using the @samp{qs} form of the query), until the target responds |
501994c0 | 34120 | with @samp{l} (lower-case ell, for @dfn{last}). |
b90a069a SL |
34121 | Refer to @ref{thread-id syntax}, for the format of the @var{thread-id} |
34122 | fields. | |
c906108c | 34123 | |
b8ff78ce | 34124 | @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm} |
ff2587ec | 34125 | @cindex get thread-local storage address, remote request |
b8ff78ce | 34126 | @cindex @samp{qGetTLSAddr} packet |
ff2587ec WZ |
34127 | Fetch the address associated with thread local storage specified |
34128 | by @var{thread-id}, @var{offset}, and @var{lm}. | |
34129 | ||
b90a069a SL |
34130 | @var{thread-id} is the thread ID associated with the |
34131 | thread for which to fetch the TLS address. @xref{thread-id syntax}. | |
ff2587ec WZ |
34132 | |
34133 | @var{offset} is the (big endian, hex encoded) offset associated with the | |
34134 | thread local variable. (This offset is obtained from the debug | |
34135 | information associated with the variable.) | |
34136 | ||
db2e3e2e | 34137 | @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the |
7a9dd1b2 | 34138 | load module associated with the thread local storage. For example, |
ff2587ec WZ |
34139 | a @sc{gnu}/Linux system will pass the link map address of the shared |
34140 | object associated with the thread local storage under consideration. | |
34141 | Other operating environments may choose to represent the load module | |
34142 | differently, so the precise meaning of this parameter will vary. | |
ee2d5c50 AC |
34143 | |
34144 | Reply: | |
b8ff78ce JB |
34145 | @table @samp |
34146 | @item @var{XX}@dots{} | |
ff2587ec WZ |
34147 | Hex encoded (big endian) bytes representing the address of the thread |
34148 | local storage requested. | |
34149 | ||
b8ff78ce JB |
34150 | @item E @var{nn} |
34151 | An error occurred. @var{nn} are hex digits. | |
ff2587ec | 34152 | |
b8ff78ce JB |
34153 | @item |
34154 | An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub. | |
ee2d5c50 AC |
34155 | @end table |
34156 | ||
711e434b PM |
34157 | @item qGetTIBAddr:@var{thread-id} |
34158 | @cindex get thread information block address | |
34159 | @cindex @samp{qGetTIBAddr} packet | |
34160 | Fetch address of the Windows OS specific Thread Information Block. | |
34161 | ||
34162 | @var{thread-id} is the thread ID associated with the thread. | |
34163 | ||
34164 | Reply: | |
34165 | @table @samp | |
34166 | @item @var{XX}@dots{} | |
34167 | Hex encoded (big endian) bytes representing the linear address of the | |
34168 | thread information block. | |
34169 | ||
34170 | @item E @var{nn} | |
34171 | An error occured. This means that either the thread was not found, or the | |
34172 | address could not be retrieved. | |
34173 | ||
34174 | @item | |
34175 | An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub. | |
34176 | @end table | |
34177 | ||
b8ff78ce | 34178 | @item qL @var{startflag} @var{threadcount} @var{nextthread} |
8e04817f AC |
34179 | Obtain thread information from RTOS. Where: @var{startflag} (one hex |
34180 | digit) is one to indicate the first query and zero to indicate a | |
34181 | subsequent query; @var{threadcount} (two hex digits) is the maximum | |
34182 | number of threads the response packet can contain; and @var{nextthread} | |
34183 | (eight hex digits), for subsequent queries (@var{startflag} is zero), is | |
34184 | returned in the response as @var{argthread}. | |
ee2d5c50 | 34185 | |
b8ff78ce | 34186 | Don't use this packet; use the @samp{qfThreadInfo} query instead (see above). |
ee2d5c50 AC |
34187 | |
34188 | Reply: | |
34189 | @table @samp | |
b8ff78ce | 34190 | @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{} |
8e04817f AC |
34191 | Where: @var{count} (two hex digits) is the number of threads being |
34192 | returned; @var{done} (one hex digit) is zero to indicate more threads | |
34193 | and one indicates no further threads; @var{argthreadid} (eight hex | |
b8ff78ce | 34194 | digits) is @var{nextthread} from the request packet; @var{thread}@dots{} |
ee2d5c50 | 34195 | is a sequence of thread IDs from the target. @var{threadid} (eight hex |
8e04817f | 34196 | digits). See @code{remote.c:parse_threadlist_response()}. |
ee2d5c50 | 34197 | @end table |
c906108c | 34198 | |
b8ff78ce | 34199 | @item qOffsets |
9c16f35a | 34200 | @cindex section offsets, remote request |
b8ff78ce | 34201 | @cindex @samp{qOffsets} packet |
31d99776 DJ |
34202 | Get section offsets that the target used when relocating the downloaded |
34203 | image. | |
c906108c | 34204 | |
ee2d5c50 AC |
34205 | Reply: |
34206 | @table @samp | |
31d99776 DJ |
34207 | @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]} |
34208 | Relocate the @code{Text} section by @var{xxx} from its original address. | |
34209 | Relocate the @code{Data} section by @var{yyy} from its original address. | |
34210 | If the object file format provides segment information (e.g.@: @sc{elf} | |
34211 | @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire | |
34212 | segments by the supplied offsets. | |
34213 | ||
34214 | @emph{Note: while a @code{Bss} offset may be included in the response, | |
34215 | @value{GDBN} ignores this and instead applies the @code{Data} offset | |
34216 | to the @code{Bss} section.} | |
34217 | ||
34218 | @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]} | |
34219 | Relocate the first segment of the object file, which conventionally | |
34220 | contains program code, to a starting address of @var{xxx}. If | |
34221 | @samp{DataSeg} is specified, relocate the second segment, which | |
34222 | conventionally contains modifiable data, to a starting address of | |
34223 | @var{yyy}. @value{GDBN} will report an error if the object file | |
34224 | does not contain segment information, or does not contain at least | |
34225 | as many segments as mentioned in the reply. Extra segments are | |
34226 | kept at fixed offsets relative to the last relocated segment. | |
ee2d5c50 AC |
34227 | @end table |
34228 | ||
b90a069a | 34229 | @item qP @var{mode} @var{thread-id} |
9c16f35a | 34230 | @cindex thread information, remote request |
b8ff78ce | 34231 | @cindex @samp{qP} packet |
b90a069a SL |
34232 | Returns information on @var{thread-id}. Where: @var{mode} is a hex |
34233 | encoded 32 bit mode; @var{thread-id} is a thread ID | |
34234 | (@pxref{thread-id syntax}). | |
ee2d5c50 | 34235 | |
aa56d27a JB |
34236 | Don't use this packet; use the @samp{qThreadExtraInfo} query instead |
34237 | (see below). | |
34238 | ||
b8ff78ce | 34239 | Reply: see @code{remote.c:remote_unpack_thread_info_response()}. |
c906108c | 34240 | |
8b23ecc4 SL |
34241 | @item QNonStop:1 |
34242 | @item QNonStop:0 | |
34243 | @cindex non-stop mode, remote request | |
34244 | @cindex @samp{QNonStop} packet | |
34245 | @anchor{QNonStop} | |
34246 | Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode. | |
34247 | @xref{Remote Non-Stop}, for more information. | |
34248 | ||
34249 | Reply: | |
34250 | @table @samp | |
34251 | @item OK | |
34252 | The request succeeded. | |
34253 | ||
34254 | @item E @var{nn} | |
34255 | An error occurred. @var{nn} are hex digits. | |
34256 | ||
34257 | @item | |
34258 | An empty reply indicates that @samp{QNonStop} is not supported by | |
34259 | the stub. | |
34260 | @end table | |
34261 | ||
34262 | This packet is not probed by default; the remote stub must request it, | |
34263 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34264 | Use of this packet is controlled by the @code{set non-stop} command; | |
34265 | @pxref{Non-Stop Mode}. | |
34266 | ||
89be2091 DJ |
34267 | @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{} |
34268 | @cindex pass signals to inferior, remote request | |
34269 | @cindex @samp{QPassSignals} packet | |
23181151 | 34270 | @anchor{QPassSignals} |
89be2091 DJ |
34271 | Each listed @var{signal} should be passed directly to the inferior process. |
34272 | Signals are numbered identically to continue packets and stop replies | |
34273 | (@pxref{Stop Reply Packets}). Each @var{signal} list item should be | |
34274 | strictly greater than the previous item. These signals do not need to stop | |
34275 | the inferior, or be reported to @value{GDBN}. All other signals should be | |
34276 | reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not | |
34277 | combine; any earlier @samp{QPassSignals} list is completely replaced by the | |
34278 | new list. This packet improves performance when using @samp{handle | |
34279 | @var{signal} nostop noprint pass}. | |
34280 | ||
34281 | Reply: | |
34282 | @table @samp | |
34283 | @item OK | |
34284 | The request succeeded. | |
34285 | ||
34286 | @item E @var{nn} | |
34287 | An error occurred. @var{nn} are hex digits. | |
34288 | ||
34289 | @item | |
34290 | An empty reply indicates that @samp{QPassSignals} is not supported by | |
34291 | the stub. | |
34292 | @end table | |
34293 | ||
34294 | Use of this packet is controlled by the @code{set remote pass-signals} | |
79a6e687 | 34295 | command (@pxref{Remote Configuration, set remote pass-signals}). |
89be2091 DJ |
34296 | This packet is not probed by default; the remote stub must request it, |
34297 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34298 | ||
b8ff78ce | 34299 | @item qRcmd,@var{command} |
ff2587ec | 34300 | @cindex execute remote command, remote request |
b8ff78ce | 34301 | @cindex @samp{qRcmd} packet |
ff2587ec | 34302 | @var{command} (hex encoded) is passed to the local interpreter for |
b8ff78ce JB |
34303 | execution. Invalid commands should be reported using the output |
34304 | string. Before the final result packet, the target may also respond | |
34305 | with a number of intermediate @samp{O@var{output}} console output | |
34306 | packets. @emph{Implementors should note that providing access to a | |
34307 | stubs's interpreter may have security implications}. | |
fa93a9d8 | 34308 | |
ff2587ec WZ |
34309 | Reply: |
34310 | @table @samp | |
34311 | @item OK | |
34312 | A command response with no output. | |
34313 | @item @var{OUTPUT} | |
34314 | A command response with the hex encoded output string @var{OUTPUT}. | |
b8ff78ce | 34315 | @item E @var{NN} |
ff2587ec | 34316 | Indicate a badly formed request. |
b8ff78ce JB |
34317 | @item |
34318 | An empty reply indicates that @samp{qRcmd} is not recognized. | |
ff2587ec | 34319 | @end table |
fa93a9d8 | 34320 | |
aa56d27a JB |
34321 | (Note that the @code{qRcmd} packet's name is separated from the |
34322 | command by a @samp{,}, not a @samp{:}, contrary to the naming | |
34323 | conventions above. Please don't use this packet as a model for new | |
34324 | packets.) | |
34325 | ||
08388c79 DE |
34326 | @item qSearch:memory:@var{address};@var{length};@var{search-pattern} |
34327 | @cindex searching memory, in remote debugging | |
34328 | @cindex @samp{qSearch:memory} packet | |
34329 | @anchor{qSearch memory} | |
34330 | Search @var{length} bytes at @var{address} for @var{search-pattern}. | |
34331 | @var{address} and @var{length} are encoded in hex. | |
34332 | @var{search-pattern} is a sequence of bytes, hex encoded. | |
34333 | ||
34334 | Reply: | |
34335 | @table @samp | |
34336 | @item 0 | |
34337 | The pattern was not found. | |
34338 | @item 1,address | |
34339 | The pattern was found at @var{address}. | |
34340 | @item E @var{NN} | |
34341 | A badly formed request or an error was encountered while searching memory. | |
34342 | @item | |
34343 | An empty reply indicates that @samp{qSearch:memory} is not recognized. | |
34344 | @end table | |
34345 | ||
a6f3e723 SL |
34346 | @item QStartNoAckMode |
34347 | @cindex @samp{QStartNoAckMode} packet | |
34348 | @anchor{QStartNoAckMode} | |
34349 | Request that the remote stub disable the normal @samp{+}/@samp{-} | |
34350 | protocol acknowledgments (@pxref{Packet Acknowledgment}). | |
34351 | ||
34352 | Reply: | |
34353 | @table @samp | |
34354 | @item OK | |
34355 | The stub has switched to no-acknowledgment mode. | |
34356 | @value{GDBN} acknowledges this reponse, | |
34357 | but neither the stub nor @value{GDBN} shall send or expect further | |
34358 | @samp{+}/@samp{-} acknowledgments in the current connection. | |
34359 | @item | |
34360 | An empty reply indicates that the stub does not support no-acknowledgment mode. | |
34361 | @end table | |
34362 | ||
be2a5f71 DJ |
34363 | @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]} |
34364 | @cindex supported packets, remote query | |
34365 | @cindex features of the remote protocol | |
34366 | @cindex @samp{qSupported} packet | |
0876f84a | 34367 | @anchor{qSupported} |
be2a5f71 DJ |
34368 | Tell the remote stub about features supported by @value{GDBN}, and |
34369 | query the stub for features it supports. This packet allows | |
34370 | @value{GDBN} and the remote stub to take advantage of each others' | |
34371 | features. @samp{qSupported} also consolidates multiple feature probes | |
34372 | at startup, to improve @value{GDBN} performance---a single larger | |
34373 | packet performs better than multiple smaller probe packets on | |
34374 | high-latency links. Some features may enable behavior which must not | |
34375 | be on by default, e.g.@: because it would confuse older clients or | |
34376 | stubs. Other features may describe packets which could be | |
34377 | automatically probed for, but are not. These features must be | |
34378 | reported before @value{GDBN} will use them. This ``default | |
34379 | unsupported'' behavior is not appropriate for all packets, but it | |
34380 | helps to keep the initial connection time under control with new | |
34381 | versions of @value{GDBN} which support increasing numbers of packets. | |
34382 | ||
34383 | Reply: | |
34384 | @table @samp | |
34385 | @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{} | |
34386 | The stub supports or does not support each returned @var{stubfeature}, | |
34387 | depending on the form of each @var{stubfeature} (see below for the | |
34388 | possible forms). | |
34389 | @item | |
34390 | An empty reply indicates that @samp{qSupported} is not recognized, | |
34391 | or that no features needed to be reported to @value{GDBN}. | |
34392 | @end table | |
34393 | ||
34394 | The allowed forms for each feature (either a @var{gdbfeature} in the | |
34395 | @samp{qSupported} packet, or a @var{stubfeature} in the response) | |
34396 | are: | |
34397 | ||
34398 | @table @samp | |
34399 | @item @var{name}=@var{value} | |
34400 | The remote protocol feature @var{name} is supported, and associated | |
34401 | with the specified @var{value}. The format of @var{value} depends | |
34402 | on the feature, but it must not include a semicolon. | |
34403 | @item @var{name}+ | |
34404 | The remote protocol feature @var{name} is supported, and does not | |
34405 | need an associated value. | |
34406 | @item @var{name}- | |
34407 | The remote protocol feature @var{name} is not supported. | |
34408 | @item @var{name}? | |
34409 | The remote protocol feature @var{name} may be supported, and | |
34410 | @value{GDBN} should auto-detect support in some other way when it is | |
34411 | needed. This form will not be used for @var{gdbfeature} notifications, | |
34412 | but may be used for @var{stubfeature} responses. | |
34413 | @end table | |
34414 | ||
34415 | Whenever the stub receives a @samp{qSupported} request, the | |
34416 | supplied set of @value{GDBN} features should override any previous | |
34417 | request. This allows @value{GDBN} to put the stub in a known | |
34418 | state, even if the stub had previously been communicating with | |
34419 | a different version of @value{GDBN}. | |
34420 | ||
b90a069a SL |
34421 | The following values of @var{gdbfeature} (for the packet sent by @value{GDBN}) |
34422 | are defined: | |
34423 | ||
34424 | @table @samp | |
34425 | @item multiprocess | |
34426 | This feature indicates whether @value{GDBN} supports multiprocess | |
34427 | extensions to the remote protocol. @value{GDBN} does not use such | |
34428 | extensions unless the stub also reports that it supports them by | |
34429 | including @samp{multiprocess+} in its @samp{qSupported} reply. | |
34430 | @xref{multiprocess extensions}, for details. | |
c8d5aac9 L |
34431 | |
34432 | @item xmlRegisters | |
34433 | This feature indicates that @value{GDBN} supports the XML target | |
34434 | description. If the stub sees @samp{xmlRegisters=} with target | |
34435 | specific strings separated by a comma, it will report register | |
34436 | description. | |
dde08ee1 PA |
34437 | |
34438 | @item qRelocInsn | |
34439 | This feature indicates whether @value{GDBN} supports the | |
34440 | @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate | |
34441 | instruction reply packet}). | |
b90a069a SL |
34442 | @end table |
34443 | ||
34444 | Stubs should ignore any unknown values for | |
be2a5f71 DJ |
34445 | @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported} |
34446 | packet supports receiving packets of unlimited length (earlier | |
b90a069a | 34447 | versions of @value{GDBN} may reject overly long responses). Additional values |
be2a5f71 DJ |
34448 | for @var{gdbfeature} may be defined in the future to let the stub take |
34449 | advantage of new features in @value{GDBN}, e.g.@: incompatible | |
b90a069a SL |
34450 | improvements in the remote protocol---the @samp{multiprocess} feature is |
34451 | an example of such a feature. The stub's reply should be independent | |
be2a5f71 DJ |
34452 | of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN} |
34453 | describes all the features it supports, and then the stub replies with | |
34454 | all the features it supports. | |
34455 | ||
34456 | Similarly, @value{GDBN} will silently ignore unrecognized stub feature | |
34457 | responses, as long as each response uses one of the standard forms. | |
34458 | ||
34459 | Some features are flags. A stub which supports a flag feature | |
34460 | should respond with a @samp{+} form response. Other features | |
34461 | require values, and the stub should respond with an @samp{=} | |
34462 | form response. | |
34463 | ||
34464 | Each feature has a default value, which @value{GDBN} will use if | |
34465 | @samp{qSupported} is not available or if the feature is not mentioned | |
34466 | in the @samp{qSupported} response. The default values are fixed; a | |
34467 | stub is free to omit any feature responses that match the defaults. | |
34468 | ||
34469 | Not all features can be probed, but for those which can, the probing | |
34470 | mechanism is useful: in some cases, a stub's internal | |
34471 | architecture may not allow the protocol layer to know some information | |
34472 | about the underlying target in advance. This is especially common in | |
34473 | stubs which may be configured for multiple targets. | |
34474 | ||
34475 | These are the currently defined stub features and their properties: | |
34476 | ||
cfa9d6d9 | 34477 | @multitable @columnfractions 0.35 0.2 0.12 0.2 |
be2a5f71 DJ |
34478 | @c NOTE: The first row should be @headitem, but we do not yet require |
34479 | @c a new enough version of Texinfo (4.7) to use @headitem. | |
0876f84a | 34480 | @item Feature Name |
be2a5f71 DJ |
34481 | @tab Value Required |
34482 | @tab Default | |
34483 | @tab Probe Allowed | |
34484 | ||
34485 | @item @samp{PacketSize} | |
34486 | @tab Yes | |
34487 | @tab @samp{-} | |
34488 | @tab No | |
34489 | ||
0876f84a DJ |
34490 | @item @samp{qXfer:auxv:read} |
34491 | @tab No | |
34492 | @tab @samp{-} | |
34493 | @tab Yes | |
34494 | ||
23181151 DJ |
34495 | @item @samp{qXfer:features:read} |
34496 | @tab No | |
34497 | @tab @samp{-} | |
34498 | @tab Yes | |
34499 | ||
cfa9d6d9 DJ |
34500 | @item @samp{qXfer:libraries:read} |
34501 | @tab No | |
34502 | @tab @samp{-} | |
34503 | @tab Yes | |
34504 | ||
68437a39 DJ |
34505 | @item @samp{qXfer:memory-map:read} |
34506 | @tab No | |
34507 | @tab @samp{-} | |
34508 | @tab Yes | |
34509 | ||
0fb4aa4b PA |
34510 | @item @samp{qXfer:sdata:read} |
34511 | @tab No | |
34512 | @tab @samp{-} | |
34513 | @tab Yes | |
34514 | ||
0e7f50da UW |
34515 | @item @samp{qXfer:spu:read} |
34516 | @tab No | |
34517 | @tab @samp{-} | |
34518 | @tab Yes | |
34519 | ||
34520 | @item @samp{qXfer:spu:write} | |
34521 | @tab No | |
34522 | @tab @samp{-} | |
34523 | @tab Yes | |
34524 | ||
4aa995e1 PA |
34525 | @item @samp{qXfer:siginfo:read} |
34526 | @tab No | |
34527 | @tab @samp{-} | |
34528 | @tab Yes | |
34529 | ||
34530 | @item @samp{qXfer:siginfo:write} | |
34531 | @tab No | |
34532 | @tab @samp{-} | |
34533 | @tab Yes | |
34534 | ||
dc146f7c VP |
34535 | @item @samp{qXfer:threads:read} |
34536 | @tab No | |
34537 | @tab @samp{-} | |
34538 | @tab Yes | |
34539 | ||
b3b9301e PA |
34540 | @item @samp{qXfer:traceframe-info:read} |
34541 | @tab No | |
34542 | @tab @samp{-} | |
34543 | @tab Yes | |
34544 | ||
78d85199 YQ |
34545 | @item @samp{qXfer:fdpic:read} |
34546 | @tab No | |
34547 | @tab @samp{-} | |
34548 | @tab Yes | |
dc146f7c | 34549 | |
8b23ecc4 SL |
34550 | @item @samp{QNonStop} |
34551 | @tab No | |
34552 | @tab @samp{-} | |
34553 | @tab Yes | |
34554 | ||
89be2091 DJ |
34555 | @item @samp{QPassSignals} |
34556 | @tab No | |
34557 | @tab @samp{-} | |
34558 | @tab Yes | |
34559 | ||
a6f3e723 SL |
34560 | @item @samp{QStartNoAckMode} |
34561 | @tab No | |
34562 | @tab @samp{-} | |
34563 | @tab Yes | |
34564 | ||
b90a069a SL |
34565 | @item @samp{multiprocess} |
34566 | @tab No | |
34567 | @tab @samp{-} | |
34568 | @tab No | |
34569 | ||
782b2b07 SS |
34570 | @item @samp{ConditionalTracepoints} |
34571 | @tab No | |
34572 | @tab @samp{-} | |
34573 | @tab No | |
34574 | ||
0d772ac9 MS |
34575 | @item @samp{ReverseContinue} |
34576 | @tab No | |
2f8132f3 | 34577 | @tab @samp{-} |
0d772ac9 MS |
34578 | @tab No |
34579 | ||
34580 | @item @samp{ReverseStep} | |
34581 | @tab No | |
2f8132f3 | 34582 | @tab @samp{-} |
0d772ac9 MS |
34583 | @tab No |
34584 | ||
409873ef SS |
34585 | @item @samp{TracepointSource} |
34586 | @tab No | |
34587 | @tab @samp{-} | |
34588 | @tab No | |
34589 | ||
d914c394 SS |
34590 | @item @samp{QAllow} |
34591 | @tab No | |
34592 | @tab @samp{-} | |
34593 | @tab No | |
34594 | ||
03583c20 UW |
34595 | @item @samp{QDisableRandomization} |
34596 | @tab No | |
34597 | @tab @samp{-} | |
34598 | @tab No | |
34599 | ||
d248b706 KY |
34600 | @item @samp{EnableDisableTracepoints} |
34601 | @tab No | |
34602 | @tab @samp{-} | |
34603 | @tab No | |
34604 | ||
be2a5f71 DJ |
34605 | @end multitable |
34606 | ||
34607 | These are the currently defined stub features, in more detail: | |
34608 | ||
34609 | @table @samp | |
34610 | @cindex packet size, remote protocol | |
34611 | @item PacketSize=@var{bytes} | |
34612 | The remote stub can accept packets up to at least @var{bytes} in | |
34613 | length. @value{GDBN} will send packets up to this size for bulk | |
34614 | transfers, and will never send larger packets. This is a limit on the | |
34615 | data characters in the packet, including the frame and checksum. | |
34616 | There is no trailing NUL byte in a remote protocol packet; if the stub | |
34617 | stores packets in a NUL-terminated format, it should allow an extra | |
34618 | byte in its buffer for the NUL. If this stub feature is not supported, | |
34619 | @value{GDBN} guesses based on the size of the @samp{g} packet response. | |
34620 | ||
0876f84a DJ |
34621 | @item qXfer:auxv:read |
34622 | The remote stub understands the @samp{qXfer:auxv:read} packet | |
34623 | (@pxref{qXfer auxiliary vector read}). | |
34624 | ||
23181151 DJ |
34625 | @item qXfer:features:read |
34626 | The remote stub understands the @samp{qXfer:features:read} packet | |
34627 | (@pxref{qXfer target description read}). | |
34628 | ||
cfa9d6d9 DJ |
34629 | @item qXfer:libraries:read |
34630 | The remote stub understands the @samp{qXfer:libraries:read} packet | |
34631 | (@pxref{qXfer library list read}). | |
34632 | ||
23181151 DJ |
34633 | @item qXfer:memory-map:read |
34634 | The remote stub understands the @samp{qXfer:memory-map:read} packet | |
34635 | (@pxref{qXfer memory map read}). | |
34636 | ||
0fb4aa4b PA |
34637 | @item qXfer:sdata:read |
34638 | The remote stub understands the @samp{qXfer:sdata:read} packet | |
34639 | (@pxref{qXfer sdata read}). | |
34640 | ||
0e7f50da UW |
34641 | @item qXfer:spu:read |
34642 | The remote stub understands the @samp{qXfer:spu:read} packet | |
34643 | (@pxref{qXfer spu read}). | |
34644 | ||
34645 | @item qXfer:spu:write | |
34646 | The remote stub understands the @samp{qXfer:spu:write} packet | |
34647 | (@pxref{qXfer spu write}). | |
34648 | ||
4aa995e1 PA |
34649 | @item qXfer:siginfo:read |
34650 | The remote stub understands the @samp{qXfer:siginfo:read} packet | |
34651 | (@pxref{qXfer siginfo read}). | |
34652 | ||
34653 | @item qXfer:siginfo:write | |
34654 | The remote stub understands the @samp{qXfer:siginfo:write} packet | |
34655 | (@pxref{qXfer siginfo write}). | |
34656 | ||
dc146f7c VP |
34657 | @item qXfer:threads:read |
34658 | The remote stub understands the @samp{qXfer:threads:read} packet | |
34659 | (@pxref{qXfer threads read}). | |
34660 | ||
b3b9301e PA |
34661 | @item qXfer:traceframe-info:read |
34662 | The remote stub understands the @samp{qXfer:traceframe-info:read} | |
34663 | packet (@pxref{qXfer traceframe info read}). | |
34664 | ||
78d85199 YQ |
34665 | @item qXfer:fdpic:read |
34666 | The remote stub understands the @samp{qXfer:fdpic:read} | |
34667 | packet (@pxref{qXfer fdpic loadmap read}). | |
34668 | ||
8b23ecc4 SL |
34669 | @item QNonStop |
34670 | The remote stub understands the @samp{QNonStop} packet | |
34671 | (@pxref{QNonStop}). | |
34672 | ||
23181151 DJ |
34673 | @item QPassSignals |
34674 | The remote stub understands the @samp{QPassSignals} packet | |
34675 | (@pxref{QPassSignals}). | |
34676 | ||
a6f3e723 SL |
34677 | @item QStartNoAckMode |
34678 | The remote stub understands the @samp{QStartNoAckMode} packet and | |
34679 | prefers to operate in no-acknowledgment mode. @xref{Packet Acknowledgment}. | |
34680 | ||
b90a069a SL |
34681 | @item multiprocess |
34682 | @anchor{multiprocess extensions} | |
34683 | @cindex multiprocess extensions, in remote protocol | |
34684 | The remote stub understands the multiprocess extensions to the remote | |
34685 | protocol syntax. The multiprocess extensions affect the syntax of | |
34686 | thread IDs in both packets and replies (@pxref{thread-id syntax}), and | |
34687 | add process IDs to the @samp{D} packet and @samp{W} and @samp{X} | |
34688 | replies. Note that reporting this feature indicates support for the | |
34689 | syntactic extensions only, not that the stub necessarily supports | |
34690 | debugging of more than one process at a time. The stub must not use | |
34691 | multiprocess extensions in packet replies unless @value{GDBN} has also | |
34692 | indicated it supports them in its @samp{qSupported} request. | |
34693 | ||
07e059b5 VP |
34694 | @item qXfer:osdata:read |
34695 | The remote stub understands the @samp{qXfer:osdata:read} packet | |
34696 | ((@pxref{qXfer osdata read}). | |
34697 | ||
782b2b07 SS |
34698 | @item ConditionalTracepoints |
34699 | The remote stub accepts and implements conditional expressions defined | |
34700 | for tracepoints (@pxref{Tracepoint Conditions}). | |
34701 | ||
0d772ac9 MS |
34702 | @item ReverseContinue |
34703 | The remote stub accepts and implements the reverse continue packet | |
34704 | (@pxref{bc}). | |
34705 | ||
34706 | @item ReverseStep | |
34707 | The remote stub accepts and implements the reverse step packet | |
34708 | (@pxref{bs}). | |
34709 | ||
409873ef SS |
34710 | @item TracepointSource |
34711 | The remote stub understands the @samp{QTDPsrc} packet that supplies | |
34712 | the source form of tracepoint definitions. | |
34713 | ||
d914c394 SS |
34714 | @item QAllow |
34715 | The remote stub understands the @samp{QAllow} packet. | |
34716 | ||
03583c20 UW |
34717 | @item QDisableRandomization |
34718 | The remote stub understands the @samp{QDisableRandomization} packet. | |
34719 | ||
0fb4aa4b PA |
34720 | @item StaticTracepoint |
34721 | @cindex static tracepoints, in remote protocol | |
34722 | The remote stub supports static tracepoints. | |
34723 | ||
d248b706 KY |
34724 | @item EnableDisableTracepoints |
34725 | The remote stub supports the @samp{QTEnable} (@pxref{QTEnable}) and | |
34726 | @samp{QTDisable} (@pxref{QTDisable}) packets that allow tracepoints | |
34727 | to be enabled and disabled while a trace experiment is running. | |
34728 | ||
be2a5f71 DJ |
34729 | @end table |
34730 | ||
b8ff78ce | 34731 | @item qSymbol:: |
ff2587ec | 34732 | @cindex symbol lookup, remote request |
b8ff78ce | 34733 | @cindex @samp{qSymbol} packet |
ff2587ec WZ |
34734 | Notify the target that @value{GDBN} is prepared to serve symbol lookup |
34735 | requests. Accept requests from the target for the values of symbols. | |
fa93a9d8 JB |
34736 | |
34737 | Reply: | |
ff2587ec | 34738 | @table @samp |
b8ff78ce | 34739 | @item OK |
ff2587ec | 34740 | The target does not need to look up any (more) symbols. |
b8ff78ce | 34741 | @item qSymbol:@var{sym_name} |
ff2587ec WZ |
34742 | The target requests the value of symbol @var{sym_name} (hex encoded). |
34743 | @value{GDBN} may provide the value by using the | |
b8ff78ce JB |
34744 | @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described |
34745 | below. | |
ff2587ec | 34746 | @end table |
83761cbd | 34747 | |
b8ff78ce | 34748 | @item qSymbol:@var{sym_value}:@var{sym_name} |
ff2587ec WZ |
34749 | Set the value of @var{sym_name} to @var{sym_value}. |
34750 | ||
34751 | @var{sym_name} (hex encoded) is the name of a symbol whose value the | |
34752 | target has previously requested. | |
34753 | ||
34754 | @var{sym_value} (hex) is the value for symbol @var{sym_name}. If | |
34755 | @value{GDBN} cannot supply a value for @var{sym_name}, then this field | |
34756 | will be empty. | |
34757 | ||
34758 | Reply: | |
34759 | @table @samp | |
b8ff78ce | 34760 | @item OK |
ff2587ec | 34761 | The target does not need to look up any (more) symbols. |
b8ff78ce | 34762 | @item qSymbol:@var{sym_name} |
ff2587ec WZ |
34763 | The target requests the value of a new symbol @var{sym_name} (hex |
34764 | encoded). @value{GDBN} will continue to supply the values of symbols | |
34765 | (if available), until the target ceases to request them. | |
fa93a9d8 | 34766 | @end table |
0abb7bc7 | 34767 | |
00bf0b85 | 34768 | @item qTBuffer |
4daf5ac0 | 34769 | @item QTBuffer |
d5551862 SS |
34770 | @item QTDisconnected |
34771 | @itemx QTDP | |
409873ef | 34772 | @itemx QTDPsrc |
d5551862 | 34773 | @itemx QTDV |
00bf0b85 SS |
34774 | @itemx qTfP |
34775 | @itemx qTfV | |
9d29849a JB |
34776 | @itemx QTFrame |
34777 | @xref{Tracepoint Packets}. | |
34778 | ||
b90a069a | 34779 | @item qThreadExtraInfo,@var{thread-id} |
ff2587ec | 34780 | @cindex thread attributes info, remote request |
b8ff78ce JB |
34781 | @cindex @samp{qThreadExtraInfo} packet |
34782 | Obtain a printable string description of a thread's attributes from | |
b90a069a SL |
34783 | the target OS. @var{thread-id} is a thread ID; |
34784 | see @ref{thread-id syntax}. This | |
b8ff78ce JB |
34785 | string may contain anything that the target OS thinks is interesting |
34786 | for @value{GDBN} to tell the user about the thread. The string is | |
34787 | displayed in @value{GDBN}'s @code{info threads} display. Some | |
34788 | examples of possible thread extra info strings are @samp{Runnable}, or | |
34789 | @samp{Blocked on Mutex}. | |
ff2587ec WZ |
34790 | |
34791 | Reply: | |
34792 | @table @samp | |
b8ff78ce JB |
34793 | @item @var{XX}@dots{} |
34794 | Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data, | |
34795 | comprising the printable string containing the extra information about | |
34796 | the thread's attributes. | |
ff2587ec | 34797 | @end table |
814e32d7 | 34798 | |
aa56d27a JB |
34799 | (Note that the @code{qThreadExtraInfo} packet's name is separated from |
34800 | the command by a @samp{,}, not a @samp{:}, contrary to the naming | |
34801 | conventions above. Please don't use this packet as a model for new | |
34802 | packets.) | |
34803 | ||
00bf0b85 SS |
34804 | @item QTSave |
34805 | @item qTsP | |
34806 | @item qTsV | |
d5551862 | 34807 | @itemx QTStart |
9d29849a | 34808 | @itemx QTStop |
d248b706 KY |
34809 | @itemx QTEnable |
34810 | @itemx QTDisable | |
9d29849a JB |
34811 | @itemx QTinit |
34812 | @itemx QTro | |
34813 | @itemx qTStatus | |
d5551862 | 34814 | @itemx qTV |
0fb4aa4b PA |
34815 | @itemx qTfSTM |
34816 | @itemx qTsSTM | |
34817 | @itemx qTSTMat | |
9d29849a JB |
34818 | @xref{Tracepoint Packets}. |
34819 | ||
0876f84a DJ |
34820 | @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length} |
34821 | @cindex read special object, remote request | |
34822 | @cindex @samp{qXfer} packet | |
68437a39 | 34823 | @anchor{qXfer read} |
0876f84a DJ |
34824 | Read uninterpreted bytes from the target's special data area |
34825 | identified by the keyword @var{object}. Request @var{length} bytes | |
34826 | starting at @var{offset} bytes into the data. The content and | |
0e7f50da | 34827 | encoding of @var{annex} is specific to @var{object}; it can supply |
0876f84a DJ |
34828 | additional details about what data to access. |
34829 | ||
34830 | Here are the specific requests of this form defined so far. All | |
34831 | @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply | |
34832 | formats, listed below. | |
34833 | ||
34834 | @table @samp | |
34835 | @item qXfer:auxv:read::@var{offset},@var{length} | |
34836 | @anchor{qXfer auxiliary vector read} | |
34837 | Access the target's @dfn{auxiliary vector}. @xref{OS Information, | |
427c3a89 | 34838 | auxiliary vector}. Note @var{annex} must be empty. |
0876f84a DJ |
34839 | |
34840 | This packet is not probed by default; the remote stub must request it, | |
89be2091 | 34841 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
0876f84a | 34842 | |
23181151 DJ |
34843 | @item qXfer:features:read:@var{annex}:@var{offset},@var{length} |
34844 | @anchor{qXfer target description read} | |
34845 | Access the @dfn{target description}. @xref{Target Descriptions}. The | |
34846 | annex specifies which XML document to access. The main description is | |
34847 | always loaded from the @samp{target.xml} annex. | |
34848 | ||
34849 | This packet is not probed by default; the remote stub must request it, | |
34850 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34851 | ||
cfa9d6d9 DJ |
34852 | @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length} |
34853 | @anchor{qXfer library list read} | |
34854 | Access the target's list of loaded libraries. @xref{Library List Format}. | |
34855 | The annex part of the generic @samp{qXfer} packet must be empty | |
34856 | (@pxref{qXfer read}). | |
34857 | ||
34858 | Targets which maintain a list of libraries in the program's memory do | |
34859 | not need to implement this packet; it is designed for platforms where | |
34860 | the operating system manages the list of loaded libraries. | |
34861 | ||
34862 | This packet is not probed by default; the remote stub must request it, | |
34863 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34864 | ||
68437a39 DJ |
34865 | @item qXfer:memory-map:read::@var{offset},@var{length} |
34866 | @anchor{qXfer memory map read} | |
79a6e687 | 34867 | Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The |
68437a39 DJ |
34868 | annex part of the generic @samp{qXfer} packet must be empty |
34869 | (@pxref{qXfer read}). | |
34870 | ||
0e7f50da UW |
34871 | This packet is not probed by default; the remote stub must request it, |
34872 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34873 | ||
0fb4aa4b PA |
34874 | @item qXfer:sdata:read::@var{offset},@var{length} |
34875 | @anchor{qXfer sdata read} | |
34876 | ||
34877 | Read contents of the extra collected static tracepoint marker | |
34878 | information. The annex part of the generic @samp{qXfer} packet must | |
34879 | be empty (@pxref{qXfer read}). @xref{Tracepoint Actions,,Tracepoint | |
34880 | Action Lists}. | |
34881 | ||
34882 | This packet is not probed by default; the remote stub must request it, | |
34883 | by supplying an appropriate @samp{qSupported} response | |
34884 | (@pxref{qSupported}). | |
34885 | ||
4aa995e1 PA |
34886 | @item qXfer:siginfo:read::@var{offset},@var{length} |
34887 | @anchor{qXfer siginfo read} | |
34888 | Read contents of the extra signal information on the target | |
34889 | system. The annex part of the generic @samp{qXfer} packet must be | |
34890 | empty (@pxref{qXfer read}). | |
34891 | ||
34892 | This packet is not probed by default; the remote stub must request it, | |
34893 | by supplying an appropriate @samp{qSupported} response | |
34894 | (@pxref{qSupported}). | |
34895 | ||
0e7f50da UW |
34896 | @item qXfer:spu:read:@var{annex}:@var{offset},@var{length} |
34897 | @anchor{qXfer spu read} | |
34898 | Read contents of an @code{spufs} file on the target system. The | |
34899 | annex specifies which file to read; it must be of the form | |
34900 | @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID | |
34901 | in the target process, and @var{name} identifes the @code{spufs} file | |
34902 | in that context to be accessed. | |
34903 | ||
68437a39 | 34904 | This packet is not probed by default; the remote stub must request it, |
07e059b5 VP |
34905 | by supplying an appropriate @samp{qSupported} response |
34906 | (@pxref{qSupported}). | |
34907 | ||
dc146f7c VP |
34908 | @item qXfer:threads:read::@var{offset},@var{length} |
34909 | @anchor{qXfer threads read} | |
34910 | Access the list of threads on target. @xref{Thread List Format}. The | |
34911 | annex part of the generic @samp{qXfer} packet must be empty | |
34912 | (@pxref{qXfer read}). | |
34913 | ||
34914 | This packet is not probed by default; the remote stub must request it, | |
34915 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34916 | ||
b3b9301e PA |
34917 | @item qXfer:traceframe-info:read::@var{offset},@var{length} |
34918 | @anchor{qXfer traceframe info read} | |
34919 | ||
34920 | Return a description of the current traceframe's contents. | |
34921 | @xref{Traceframe Info Format}. The annex part of the generic | |
34922 | @samp{qXfer} packet must be empty (@pxref{qXfer read}). | |
34923 | ||
34924 | This packet is not probed by default; the remote stub must request it, | |
34925 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34926 | ||
78d85199 YQ |
34927 | @item qXfer:fdpic:read:@var{annex}:@var{offset},@var{length} |
34928 | @anchor{qXfer fdpic loadmap read} | |
34929 | Read contents of @code{loadmap}s on the target system. The | |
34930 | annex, either @samp{exec} or @samp{interp}, specifies which @code{loadmap}, | |
34931 | executable @code{loadmap} or interpreter @code{loadmap} to read. | |
34932 | ||
34933 | This packet is not probed by default; the remote stub must request it, | |
34934 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
34935 | ||
07e059b5 VP |
34936 | @item qXfer:osdata:read::@var{offset},@var{length} |
34937 | @anchor{qXfer osdata read} | |
34938 | Access the target's @dfn{operating system information}. | |
34939 | @xref{Operating System Information}. | |
34940 | ||
68437a39 DJ |
34941 | @end table |
34942 | ||
0876f84a DJ |
34943 | Reply: |
34944 | @table @samp | |
34945 | @item m @var{data} | |
34946 | Data @var{data} (@pxref{Binary Data}) has been read from the | |
34947 | target. There may be more data at a higher address (although | |
34948 | it is permitted to return @samp{m} even for the last valid | |
34949 | block of data, as long as at least one byte of data was read). | |
34950 | @var{data} may have fewer bytes than the @var{length} in the | |
34951 | request. | |
34952 | ||
34953 | @item l @var{data} | |
34954 | Data @var{data} (@pxref{Binary Data}) has been read from the target. | |
34955 | There is no more data to be read. @var{data} may have fewer bytes | |
34956 | than the @var{length} in the request. | |
34957 | ||
34958 | @item l | |
34959 | The @var{offset} in the request is at the end of the data. | |
34960 | There is no more data to be read. | |
34961 | ||
34962 | @item E00 | |
34963 | The request was malformed, or @var{annex} was invalid. | |
34964 | ||
34965 | @item E @var{nn} | |
34966 | The offset was invalid, or there was an error encountered reading the data. | |
34967 | @var{nn} is a hex-encoded @code{errno} value. | |
34968 | ||
34969 | @item | |
34970 | An empty reply indicates the @var{object} string was not recognized by | |
34971 | the stub, or that the object does not support reading. | |
34972 | @end table | |
34973 | ||
34974 | @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{} | |
34975 | @cindex write data into object, remote request | |
4aa995e1 | 34976 | @anchor{qXfer write} |
0876f84a DJ |
34977 | Write uninterpreted bytes into the target's special data area |
34978 | identified by the keyword @var{object}, starting at @var{offset} bytes | |
0e7f50da | 34979 | into the data. @var{data}@dots{} is the binary-encoded data |
0876f84a | 34980 | (@pxref{Binary Data}) to be written. The content and encoding of @var{annex} |
0e7f50da | 34981 | is specific to @var{object}; it can supply additional details about what data |
0876f84a DJ |
34982 | to access. |
34983 | ||
0e7f50da UW |
34984 | Here are the specific requests of this form defined so far. All |
34985 | @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply | |
34986 | formats, listed below. | |
34987 | ||
34988 | @table @samp | |
4aa995e1 PA |
34989 | @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{} |
34990 | @anchor{qXfer siginfo write} | |
34991 | Write @var{data} to the extra signal information on the target system. | |
34992 | The annex part of the generic @samp{qXfer} packet must be | |
34993 | empty (@pxref{qXfer write}). | |
34994 | ||
34995 | This packet is not probed by default; the remote stub must request it, | |
34996 | by supplying an appropriate @samp{qSupported} response | |
34997 | (@pxref{qSupported}). | |
34998 | ||
84fcdf95 | 34999 | @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{} |
0e7f50da UW |
35000 | @anchor{qXfer spu write} |
35001 | Write @var{data} to an @code{spufs} file on the target system. The | |
35002 | annex specifies which file to write; it must be of the form | |
35003 | @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID | |
35004 | in the target process, and @var{name} identifes the @code{spufs} file | |
35005 | in that context to be accessed. | |
35006 | ||
35007 | This packet is not probed by default; the remote stub must request it, | |
35008 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). | |
35009 | @end table | |
0876f84a DJ |
35010 | |
35011 | Reply: | |
35012 | @table @samp | |
35013 | @item @var{nn} | |
35014 | @var{nn} (hex encoded) is the number of bytes written. | |
35015 | This may be fewer bytes than supplied in the request. | |
35016 | ||
35017 | @item E00 | |
35018 | The request was malformed, or @var{annex} was invalid. | |
35019 | ||
35020 | @item E @var{nn} | |
35021 | The offset was invalid, or there was an error encountered writing the data. | |
35022 | @var{nn} is a hex-encoded @code{errno} value. | |
35023 | ||
35024 | @item | |
35025 | An empty reply indicates the @var{object} string was not | |
35026 | recognized by the stub, or that the object does not support writing. | |
35027 | @end table | |
35028 | ||
35029 | @item qXfer:@var{object}:@var{operation}:@dots{} | |
35030 | Requests of this form may be added in the future. When a stub does | |
35031 | not recognize the @var{object} keyword, or its support for | |
35032 | @var{object} does not recognize the @var{operation} keyword, the stub | |
35033 | must respond with an empty packet. | |
35034 | ||
0b16c5cf PA |
35035 | @item qAttached:@var{pid} |
35036 | @cindex query attached, remote request | |
35037 | @cindex @samp{qAttached} packet | |
35038 | Return an indication of whether the remote server attached to an | |
35039 | existing process or created a new process. When the multiprocess | |
35040 | protocol extensions are supported (@pxref{multiprocess extensions}), | |
35041 | @var{pid} is an integer in hexadecimal format identifying the target | |
35042 | process. Otherwise, @value{GDBN} will omit the @var{pid} field and | |
35043 | the query packet will be simplified as @samp{qAttached}. | |
35044 | ||
35045 | This query is used, for example, to know whether the remote process | |
35046 | should be detached or killed when a @value{GDBN} session is ended with | |
35047 | the @code{quit} command. | |
35048 | ||
35049 | Reply: | |
35050 | @table @samp | |
35051 | @item 1 | |
35052 | The remote server attached to an existing process. | |
35053 | @item 0 | |
35054 | The remote server created a new process. | |
35055 | @item E @var{NN} | |
35056 | A badly formed request or an error was encountered. | |
35057 | @end table | |
35058 | ||
ee2d5c50 AC |
35059 | @end table |
35060 | ||
a1dcb23a DJ |
35061 | @node Architecture-Specific Protocol Details |
35062 | @section Architecture-Specific Protocol Details | |
35063 | ||
35064 | This section describes how the remote protocol is applied to specific | |
35065 | target architectures. Also see @ref{Standard Target Features}, for | |
35066 | details of XML target descriptions for each architecture. | |
35067 | ||
35068 | @subsection ARM | |
35069 | ||
35070 | @subsubsection Breakpoint Kinds | |
35071 | ||
35072 | These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets. | |
35073 | ||
35074 | @table @r | |
35075 | ||
35076 | @item 2 | |
35077 | 16-bit Thumb mode breakpoint. | |
35078 | ||
35079 | @item 3 | |
35080 | 32-bit Thumb mode (Thumb-2) breakpoint. | |
35081 | ||
35082 | @item 4 | |
35083 | 32-bit ARM mode breakpoint. | |
35084 | ||
35085 | @end table | |
35086 | ||
35087 | @subsection MIPS | |
35088 | ||
35089 | @subsubsection Register Packet Format | |
eb12ee30 | 35090 | |
b8ff78ce | 35091 | The following @code{g}/@code{G} packets have previously been defined. |
ee2d5c50 AC |
35092 | In the below, some thirty-two bit registers are transferred as |
35093 | sixty-four bits. Those registers should be zero/sign extended (which?) | |
599b237a BW |
35094 | to fill the space allocated. Register bytes are transferred in target |
35095 | byte order. The two nibbles within a register byte are transferred | |
ee2d5c50 | 35096 | most-significant - least-significant. |
eb12ee30 | 35097 | |
ee2d5c50 | 35098 | @table @r |
eb12ee30 | 35099 | |
8e04817f | 35100 | @item MIPS32 |
ee2d5c50 | 35101 | |
599b237a | 35102 | All registers are transferred as thirty-two bit quantities in the order: |
8e04817f AC |
35103 | 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point |
35104 | registers; fsr; fir; fp. | |
eb12ee30 | 35105 | |
8e04817f | 35106 | @item MIPS64 |
ee2d5c50 | 35107 | |
599b237a | 35108 | All registers are transferred as sixty-four bit quantities (including |
8e04817f AC |
35109 | thirty-two bit registers such as @code{sr}). The ordering is the same |
35110 | as @code{MIPS32}. | |
eb12ee30 | 35111 | |
ee2d5c50 AC |
35112 | @end table |
35113 | ||
9d29849a JB |
35114 | @node Tracepoint Packets |
35115 | @section Tracepoint Packets | |
35116 | @cindex tracepoint packets | |
35117 | @cindex packets, tracepoint | |
35118 | ||
35119 | Here we describe the packets @value{GDBN} uses to implement | |
35120 | tracepoints (@pxref{Tracepoints}). | |
35121 | ||
35122 | @table @samp | |
35123 | ||
7a697b8d | 35124 | @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]} |
9d29849a JB |
35125 | Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena} |
35126 | is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then | |
35127 | the tracepoint is disabled. @var{step} is the tracepoint's step | |
7a697b8d SS |
35128 | count, and @var{pass} is its pass count. If an @samp{F} is present, |
35129 | then the tracepoint is to be a fast tracepoint, and the @var{flen} is | |
35130 | the number of bytes that the target should copy elsewhere to make room | |
35131 | for the tracepoint. If an @samp{X} is present, it introduces a | |
35132 | tracepoint condition, which consists of a hexadecimal length, followed | |
35133 | by a comma and hex-encoded bytes, in a manner similar to action | |
35134 | encodings as described below. If the trailing @samp{-} is present, | |
35135 | further @samp{QTDP} packets will follow to specify this tracepoint's | |
35136 | actions. | |
9d29849a JB |
35137 | |
35138 | Replies: | |
35139 | @table @samp | |
35140 | @item OK | |
35141 | The packet was understood and carried out. | |
dde08ee1 PA |
35142 | @item qRelocInsn |
35143 | @xref{Tracepoint Packets,,Relocate instruction reply packet}. | |
9d29849a JB |
35144 | @item |
35145 | The packet was not recognized. | |
35146 | @end table | |
35147 | ||
35148 | @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]} | |
35149 | Define actions to be taken when a tracepoint is hit. @var{n} and | |
35150 | @var{addr} must be the same as in the initial @samp{QTDP} packet for | |
35151 | this tracepoint. This packet may only be sent immediately after | |
35152 | another @samp{QTDP} packet that ended with a @samp{-}. If the | |
35153 | trailing @samp{-} is present, further @samp{QTDP} packets will follow, | |
35154 | specifying more actions for this tracepoint. | |
35155 | ||
35156 | In the series of action packets for a given tracepoint, at most one | |
35157 | can have an @samp{S} before its first @var{action}. If such a packet | |
35158 | is sent, it and the following packets define ``while-stepping'' | |
35159 | actions. Any prior packets define ordinary actions --- that is, those | |
35160 | taken when the tracepoint is first hit. If no action packet has an | |
35161 | @samp{S}, then all the packets in the series specify ordinary | |
35162 | tracepoint actions. | |
35163 | ||
35164 | The @samp{@var{action}@dots{}} portion of the packet is a series of | |
35165 | actions, concatenated without separators. Each action has one of the | |
35166 | following forms: | |
35167 | ||
35168 | @table @samp | |
35169 | ||
35170 | @item R @var{mask} | |
35171 | Collect the registers whose bits are set in @var{mask}. @var{mask} is | |
599b237a | 35172 | a hexadecimal number whose @var{i}'th bit is set if register number |
9d29849a JB |
35173 | @var{i} should be collected. (The least significant bit is numbered |
35174 | zero.) Note that @var{mask} may be any number of digits long; it may | |
35175 | not fit in a 32-bit word. | |
35176 | ||
35177 | @item M @var{basereg},@var{offset},@var{len} | |
35178 | Collect @var{len} bytes of memory starting at the address in register | |
35179 | number @var{basereg}, plus @var{offset}. If @var{basereg} is | |
35180 | @samp{-1}, then the range has a fixed address: @var{offset} is the | |
35181 | address of the lowest byte to collect. The @var{basereg}, | |
599b237a | 35182 | @var{offset}, and @var{len} parameters are all unsigned hexadecimal |
9d29849a JB |
35183 | values (the @samp{-1} value for @var{basereg} is a special case). |
35184 | ||
35185 | @item X @var{len},@var{expr} | |
35186 | Evaluate @var{expr}, whose length is @var{len}, and collect memory as | |
35187 | it directs. @var{expr} is an agent expression, as described in | |
35188 | @ref{Agent Expressions}. Each byte of the expression is encoded as a | |
35189 | two-digit hex number in the packet; @var{len} is the number of bytes | |
35190 | in the expression (and thus one-half the number of hex digits in the | |
35191 | packet). | |
35192 | ||
35193 | @end table | |
35194 | ||
35195 | Any number of actions may be packed together in a single @samp{QTDP} | |
35196 | packet, as long as the packet does not exceed the maximum packet | |
c1947b85 JB |
35197 | length (400 bytes, for many stubs). There may be only one @samp{R} |
35198 | action per tracepoint, and it must precede any @samp{M} or @samp{X} | |
35199 | actions. Any registers referred to by @samp{M} and @samp{X} actions | |
35200 | must be collected by a preceding @samp{R} action. (The | |
35201 | ``while-stepping'' actions are treated as if they were attached to a | |
35202 | separate tracepoint, as far as these restrictions are concerned.) | |
9d29849a JB |
35203 | |
35204 | Replies: | |
35205 | @table @samp | |
35206 | @item OK | |
35207 | The packet was understood and carried out. | |
dde08ee1 PA |
35208 | @item qRelocInsn |
35209 | @xref{Tracepoint Packets,,Relocate instruction reply packet}. | |
9d29849a JB |
35210 | @item |
35211 | The packet was not recognized. | |
35212 | @end table | |
35213 | ||
409873ef SS |
35214 | @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes} |
35215 | @cindex @samp{QTDPsrc} packet | |
35216 | Specify a source string of tracepoint @var{n} at address @var{addr}. | |
35217 | This is useful to get accurate reproduction of the tracepoints | |
35218 | originally downloaded at the beginning of the trace run. @var{type} | |
35219 | is the name of the tracepoint part, such as @samp{cond} for the | |
35220 | tracepoint's conditional expression (see below for a list of types), while | |
35221 | @var{bytes} is the string, encoded in hexadecimal. | |
35222 | ||
35223 | @var{start} is the offset of the @var{bytes} within the overall source | |
35224 | string, while @var{slen} is the total length of the source string. | |
35225 | This is intended for handling source strings that are longer than will | |
35226 | fit in a single packet. | |
35227 | @c Add detailed example when this info is moved into a dedicated | |
35228 | @c tracepoint descriptions section. | |
35229 | ||
35230 | The available string types are @samp{at} for the location, | |
35231 | @samp{cond} for the conditional, and @samp{cmd} for an action command. | |
35232 | @value{GDBN} sends a separate packet for each command in the action | |
35233 | list, in the same order in which the commands are stored in the list. | |
35234 | ||
35235 | The target does not need to do anything with source strings except | |
35236 | report them back as part of the replies to the @samp{qTfP}/@samp{qTsP} | |
35237 | query packets. | |
35238 | ||
35239 | Although this packet is optional, and @value{GDBN} will only send it | |
35240 | if the target replies with @samp{TracepointSource} @xref{General | |
35241 | Query Packets}, it makes both disconnected tracing and trace files | |
35242 | much easier to use. Otherwise the user must be careful that the | |
35243 | tracepoints in effect while looking at trace frames are identical to | |
35244 | the ones in effect during the trace run; even a small discrepancy | |
35245 | could cause @samp{tdump} not to work, or a particular trace frame not | |
35246 | be found. | |
35247 | ||
f61e138d SS |
35248 | @item QTDV:@var{n}:@var{value} |
35249 | @cindex define trace state variable, remote request | |
35250 | @cindex @samp{QTDV} packet | |
35251 | Create a new trace state variable, number @var{n}, with an initial | |
35252 | value of @var{value}, which is a 64-bit signed integer. Both @var{n} | |
35253 | and @var{value} are encoded as hexadecimal values. @value{GDBN} has | |
35254 | the option of not using this packet for initial values of zero; the | |
35255 | target should simply create the trace state variables as they are | |
35256 | mentioned in expressions. | |
35257 | ||
9d29849a JB |
35258 | @item QTFrame:@var{n} |
35259 | Select the @var{n}'th tracepoint frame from the buffer, and use the | |
35260 | register and memory contents recorded there to answer subsequent | |
35261 | request packets from @value{GDBN}. | |
35262 | ||
35263 | A successful reply from the stub indicates that the stub has found the | |
35264 | requested frame. The response is a series of parts, concatenated | |
35265 | without separators, describing the frame we selected. Each part has | |
35266 | one of the following forms: | |
35267 | ||
35268 | @table @samp | |
35269 | @item F @var{f} | |
35270 | The selected frame is number @var{n} in the trace frame buffer; | |
599b237a | 35271 | @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there |
9d29849a JB |
35272 | was no frame matching the criteria in the request packet. |
35273 | ||
35274 | @item T @var{t} | |
35275 | The selected trace frame records a hit of tracepoint number @var{t}; | |
599b237a | 35276 | @var{t} is a hexadecimal number. |
9d29849a JB |
35277 | |
35278 | @end table | |
35279 | ||
35280 | @item QTFrame:pc:@var{addr} | |
35281 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the | |
35282 | currently selected frame whose PC is @var{addr}; | |
599b237a | 35283 | @var{addr} is a hexadecimal number. |
9d29849a JB |
35284 | |
35285 | @item QTFrame:tdp:@var{t} | |
35286 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the | |
35287 | currently selected frame that is a hit of tracepoint @var{t}; @var{t} | |
599b237a | 35288 | is a hexadecimal number. |
9d29849a JB |
35289 | |
35290 | @item QTFrame:range:@var{start}:@var{end} | |
35291 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the | |
35292 | currently selected frame whose PC is between @var{start} (inclusive) | |
081dfbf7 | 35293 | and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal |
9d29849a JB |
35294 | numbers. |
35295 | ||
35296 | @item QTFrame:outside:@var{start}:@var{end} | |
35297 | Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first | |
081dfbf7 | 35298 | frame @emph{outside} the given range of addresses (exclusive). |
9d29849a JB |
35299 | |
35300 | @item QTStart | |
dde08ee1 PA |
35301 | Begin the tracepoint experiment. Begin collecting data from |
35302 | tracepoint hits in the trace frame buffer. This packet supports the | |
35303 | @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate | |
35304 | instruction reply packet}). | |
9d29849a JB |
35305 | |
35306 | @item QTStop | |
35307 | End the tracepoint experiment. Stop collecting trace frames. | |
35308 | ||
d248b706 KY |
35309 | @item QTEnable:@var{n}:@var{addr} |
35310 | @anchor{QTEnable} | |
35311 | Enable tracepoint @var{n} at address @var{addr} in a started tracepoint | |
35312 | experiment. If the tracepoint was previously disabled, then collection | |
35313 | of data from it will resume. | |
35314 | ||
35315 | @item QTDisable:@var{n}:@var{addr} | |
35316 | @anchor{QTDisable} | |
35317 | Disable tracepoint @var{n} at address @var{addr} in a started tracepoint | |
35318 | experiment. No more data will be collected from the tracepoint unless | |
35319 | @samp{QTEnable:@var{n}:@var{addr}} is subsequently issued. | |
35320 | ||
9d29849a JB |
35321 | @item QTinit |
35322 | Clear the table of tracepoints, and empty the trace frame buffer. | |
35323 | ||
35324 | @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{} | |
35325 | Establish the given ranges of memory as ``transparent''. The stub | |
35326 | will answer requests for these ranges from memory's current contents, | |
35327 | if they were not collected as part of the tracepoint hit. | |
35328 | ||
35329 | @value{GDBN} uses this to mark read-only regions of memory, like those | |
35330 | containing program code. Since these areas never change, they should | |
35331 | still have the same contents they did when the tracepoint was hit, so | |
35332 | there's no reason for the stub to refuse to provide their contents. | |
35333 | ||
d5551862 SS |
35334 | @item QTDisconnected:@var{value} |
35335 | Set the choice to what to do with the tracing run when @value{GDBN} | |
35336 | disconnects from the target. A @var{value} of 1 directs the target to | |
35337 | continue the tracing run, while 0 tells the target to stop tracing if | |
35338 | @value{GDBN} is no longer in the picture. | |
35339 | ||
9d29849a JB |
35340 | @item qTStatus |
35341 | Ask the stub if there is a trace experiment running right now. | |
35342 | ||
4daf5ac0 SS |
35343 | The reply has the form: |
35344 | ||
35345 | @table @samp | |
35346 | ||
35347 | @item T@var{running}@r{[};@var{field}@r{]}@dots{} | |
35348 | @var{running} is a single digit @code{1} if the trace is presently | |
35349 | running, or @code{0} if not. It is followed by semicolon-separated | |
35350 | optional fields that an agent may use to report additional status. | |
35351 | ||
35352 | @end table | |
35353 | ||
35354 | If the trace is not running, the agent may report any of several | |
35355 | explanations as one of the optional fields: | |
35356 | ||
35357 | @table @samp | |
35358 | ||
35359 | @item tnotrun:0 | |
35360 | No trace has been run yet. | |
35361 | ||
35362 | @item tstop:0 | |
35363 | The trace was stopped by a user-originated stop command. | |
35364 | ||
35365 | @item tfull:0 | |
35366 | The trace stopped because the trace buffer filled up. | |
35367 | ||
35368 | @item tdisconnected:0 | |
35369 | The trace stopped because @value{GDBN} disconnected from the target. | |
35370 | ||
35371 | @item tpasscount:@var{tpnum} | |
35372 | The trace stopped because tracepoint @var{tpnum} exceeded its pass count. | |
35373 | ||
6c28cbf2 SS |
35374 | @item terror:@var{text}:@var{tpnum} |
35375 | The trace stopped because tracepoint @var{tpnum} had an error. The | |
35376 | string @var{text} is available to describe the nature of the error | |
35377 | (for instance, a divide by zero in the condition expression). | |
99b5e152 | 35378 | @var{text} is hex encoded. |
6c28cbf2 | 35379 | |
4daf5ac0 SS |
35380 | @item tunknown:0 |
35381 | The trace stopped for some other reason. | |
35382 | ||
35383 | @end table | |
35384 | ||
33da3f1c SS |
35385 | Additional optional fields supply statistical and other information. |
35386 | Although not required, they are extremely useful for users monitoring | |
35387 | the progress of a trace run. If a trace has stopped, and these | |
35388 | numbers are reported, they must reflect the state of the just-stopped | |
35389 | trace. | |
4daf5ac0 | 35390 | |
9d29849a | 35391 | @table @samp |
4daf5ac0 SS |
35392 | |
35393 | @item tframes:@var{n} | |
35394 | The number of trace frames in the buffer. | |
35395 | ||
35396 | @item tcreated:@var{n} | |
35397 | The total number of trace frames created during the run. This may | |
35398 | be larger than the trace frame count, if the buffer is circular. | |
35399 | ||
35400 | @item tsize:@var{n} | |
35401 | The total size of the trace buffer, in bytes. | |
35402 | ||
35403 | @item tfree:@var{n} | |
35404 | The number of bytes still unused in the buffer. | |
35405 | ||
33da3f1c SS |
35406 | @item circular:@var{n} |
35407 | The value of the circular trace buffer flag. @code{1} means that the | |
35408 | trace buffer is circular and old trace frames will be discarded if | |
35409 | necessary to make room, @code{0} means that the trace buffer is linear | |
35410 | and may fill up. | |
35411 | ||
35412 | @item disconn:@var{n} | |
35413 | The value of the disconnected tracing flag. @code{1} means that | |
35414 | tracing will continue after @value{GDBN} disconnects, @code{0} means | |
35415 | that the trace run will stop. | |
35416 | ||
9d29849a JB |
35417 | @end table |
35418 | ||
f61e138d SS |
35419 | @item qTV:@var{var} |
35420 | @cindex trace state variable value, remote request | |
35421 | @cindex @samp{qTV} packet | |
35422 | Ask the stub for the value of the trace state variable number @var{var}. | |
35423 | ||
35424 | Replies: | |
35425 | @table @samp | |
35426 | @item V@var{value} | |
35427 | The value of the variable is @var{value}. This will be the current | |
35428 | value of the variable if the user is examining a running target, or a | |
35429 | saved value if the variable was collected in the trace frame that the | |
35430 | user is looking at. Note that multiple requests may result in | |
35431 | different reply values, such as when requesting values while the | |
35432 | program is running. | |
35433 | ||
35434 | @item U | |
35435 | The value of the variable is unknown. This would occur, for example, | |
35436 | if the user is examining a trace frame in which the requested variable | |
35437 | was not collected. | |
9d29849a JB |
35438 | @end table |
35439 | ||
d5551862 SS |
35440 | @item qTfP |
35441 | @itemx qTsP | |
35442 | These packets request data about tracepoints that are being used by | |
35443 | the target. @value{GDBN} sends @code{qTfP} to get the first piece | |
35444 | of data, and multiple @code{qTsP} to get additional pieces. Replies | |
35445 | to these packets generally take the form of the @code{QTDP} packets | |
35446 | that define tracepoints. (FIXME add detailed syntax) | |
35447 | ||
00bf0b85 SS |
35448 | @item qTfV |
35449 | @itemx qTsV | |
35450 | These packets request data about trace state variables that are on the | |
35451 | target. @value{GDBN} sends @code{qTfV} to get the first vari of data, | |
35452 | and multiple @code{qTsV} to get additional variables. Replies to | |
35453 | these packets follow the syntax of the @code{QTDV} packets that define | |
35454 | trace state variables. | |
35455 | ||
0fb4aa4b PA |
35456 | @item qTfSTM |
35457 | @itemx qTsSTM | |
35458 | These packets request data about static tracepoint markers that exist | |
35459 | in the target program. @value{GDBN} sends @code{qTfSTM} to get the | |
35460 | first piece of data, and multiple @code{qTsSTM} to get additional | |
35461 | pieces. Replies to these packets take the following form: | |
35462 | ||
35463 | Reply: | |
35464 | @table @samp | |
35465 | @item m @var{address}:@var{id}:@var{extra} | |
35466 | A single marker | |
35467 | @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{} | |
35468 | a comma-separated list of markers | |
35469 | @item l | |
35470 | (lower case letter @samp{L}) denotes end of list. | |
35471 | @item E @var{nn} | |
35472 | An error occurred. @var{nn} are hex digits. | |
35473 | @item | |
35474 | An empty reply indicates that the request is not supported by the | |
35475 | stub. | |
35476 | @end table | |
35477 | ||
35478 | @var{address} is encoded in hex. | |
35479 | @var{id} and @var{extra} are strings encoded in hex. | |
35480 | ||
35481 | In response to each query, the target will reply with a list of one or | |
35482 | more markers, separated by commas. @value{GDBN} will respond to each | |
35483 | reply with a request for more markers (using the @samp{qs} form of the | |
35484 | query), until the target responds with @samp{l} (lower-case ell, for | |
35485 | @dfn{last}). | |
35486 | ||
35487 | @item qTSTMat:@var{address} | |
35488 | This packets requests data about static tracepoint markers in the | |
35489 | target program at @var{address}. Replies to this packet follow the | |
35490 | syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static | |
35491 | tracepoint markers. | |
35492 | ||
00bf0b85 SS |
35493 | @item QTSave:@var{filename} |
35494 | This packet directs the target to save trace data to the file name | |
35495 | @var{filename} in the target's filesystem. @var{filename} is encoded | |
35496 | as a hex string; the interpretation of the file name (relative vs | |
35497 | absolute, wild cards, etc) is up to the target. | |
35498 | ||
35499 | @item qTBuffer:@var{offset},@var{len} | |
35500 | Return up to @var{len} bytes of the current contents of trace buffer, | |
35501 | starting at @var{offset}. The trace buffer is treated as if it were | |
35502 | a contiguous collection of traceframes, as per the trace file format. | |
35503 | The reply consists as many hex-encoded bytes as the target can deliver | |
35504 | in a packet; it is not an error to return fewer than were asked for. | |
35505 | A reply consisting of just @code{l} indicates that no bytes are | |
35506 | available. | |
35507 | ||
4daf5ac0 SS |
35508 | @item QTBuffer:circular:@var{value} |
35509 | This packet directs the target to use a circular trace buffer if | |
35510 | @var{value} is 1, or a linear buffer if the value is 0. | |
35511 | ||
f61e138d | 35512 | @end table |
9d29849a | 35513 | |
dde08ee1 PA |
35514 | @subsection Relocate instruction reply packet |
35515 | When installing fast tracepoints in memory, the target may need to | |
35516 | relocate the instruction currently at the tracepoint address to a | |
35517 | different address in memory. For most instructions, a simple copy is | |
35518 | enough, but, for example, call instructions that implicitly push the | |
35519 | return address on the stack, and relative branches or other | |
35520 | PC-relative instructions require offset adjustment, so that the effect | |
35521 | of executing the instruction at a different address is the same as if | |
35522 | it had executed in the original location. | |
35523 | ||
35524 | In response to several of the tracepoint packets, the target may also | |
35525 | respond with a number of intermediate @samp{qRelocInsn} request | |
35526 | packets before the final result packet, to have @value{GDBN} handle | |
35527 | this relocation operation. If a packet supports this mechanism, its | |
35528 | documentation will explicitly say so. See for example the above | |
35529 | descriptions for the @samp{QTStart} and @samp{QTDP} packets. The | |
35530 | format of the request is: | |
35531 | ||
35532 | @table @samp | |
35533 | @item qRelocInsn:@var{from};@var{to} | |
35534 | ||
35535 | This requests @value{GDBN} to copy instruction at address @var{from} | |
35536 | to address @var{to}, possibly adjusted so that executing the | |
35537 | instruction at @var{to} has the same effect as executing it at | |
35538 | @var{from}. @value{GDBN} writes the adjusted instruction to target | |
35539 | memory starting at @var{to}. | |
35540 | @end table | |
35541 | ||
35542 | Replies: | |
35543 | @table @samp | |
35544 | @item qRelocInsn:@var{adjusted_size} | |
35545 | Informs the stub the relocation is complete. @var{adjusted_size} is | |
35546 | the length in bytes of resulting relocated instruction sequence. | |
35547 | @item E @var{NN} | |
35548 | A badly formed request was detected, or an error was encountered while | |
35549 | relocating the instruction. | |
35550 | @end table | |
35551 | ||
a6b151f1 DJ |
35552 | @node Host I/O Packets |
35553 | @section Host I/O Packets | |
35554 | @cindex Host I/O, remote protocol | |
35555 | @cindex file transfer, remote protocol | |
35556 | ||
35557 | The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O | |
35558 | operations on the far side of a remote link. For example, Host I/O is | |
35559 | used to upload and download files to a remote target with its own | |
35560 | filesystem. Host I/O uses the same constant values and data structure | |
35561 | layout as the target-initiated File-I/O protocol. However, the | |
35562 | Host I/O packets are structured differently. The target-initiated | |
35563 | protocol relies on target memory to store parameters and buffers. | |
35564 | Host I/O requests are initiated by @value{GDBN}, and the | |
35565 | target's memory is not involved. @xref{File-I/O Remote Protocol | |
35566 | Extension}, for more details on the target-initiated protocol. | |
35567 | ||
35568 | The Host I/O request packets all encode a single operation along with | |
35569 | its arguments. They have this format: | |
35570 | ||
35571 | @table @samp | |
35572 | ||
35573 | @item vFile:@var{operation}: @var{parameter}@dots{} | |
35574 | @var{operation} is the name of the particular request; the target | |
35575 | should compare the entire packet name up to the second colon when checking | |
35576 | for a supported operation. The format of @var{parameter} depends on | |
35577 | the operation. Numbers are always passed in hexadecimal. Negative | |
35578 | numbers have an explicit minus sign (i.e.@: two's complement is not | |
35579 | used). Strings (e.g.@: filenames) are encoded as a series of | |
35580 | hexadecimal bytes. The last argument to a system call may be a | |
35581 | buffer of escaped binary data (@pxref{Binary Data}). | |
35582 | ||
35583 | @end table | |
35584 | ||
35585 | The valid responses to Host I/O packets are: | |
35586 | ||
35587 | @table @samp | |
35588 | ||
35589 | @item F @var{result} [, @var{errno}] [; @var{attachment}] | |
35590 | @var{result} is the integer value returned by this operation, usually | |
35591 | non-negative for success and -1 for errors. If an error has occured, | |
35592 | @var{errno} will be included in the result. @var{errno} will have a | |
35593 | value defined by the File-I/O protocol (@pxref{Errno Values}). For | |
35594 | operations which return data, @var{attachment} supplies the data as a | |
35595 | binary buffer. Binary buffers in response packets are escaped in the | |
35596 | normal way (@pxref{Binary Data}). See the individual packet | |
35597 | documentation for the interpretation of @var{result} and | |
35598 | @var{attachment}. | |
35599 | ||
35600 | @item | |
35601 | An empty response indicates that this operation is not recognized. | |
35602 | ||
35603 | @end table | |
35604 | ||
35605 | These are the supported Host I/O operations: | |
35606 | ||
35607 | @table @samp | |
35608 | @item vFile:open: @var{pathname}, @var{flags}, @var{mode} | |
35609 | Open a file at @var{pathname} and return a file descriptor for it, or | |
35610 | return -1 if an error occurs. @var{pathname} is a string, | |
35611 | @var{flags} is an integer indicating a mask of open flags | |
35612 | (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask | |
35613 | of mode bits to use if the file is created (@pxref{mode_t Values}). | |
c1c25a1a | 35614 | @xref{open}, for details of the open flags and mode values. |
a6b151f1 DJ |
35615 | |
35616 | @item vFile:close: @var{fd} | |
35617 | Close the open file corresponding to @var{fd} and return 0, or | |
35618 | -1 if an error occurs. | |
35619 | ||
35620 | @item vFile:pread: @var{fd}, @var{count}, @var{offset} | |
35621 | Read data from the open file corresponding to @var{fd}. Up to | |
35622 | @var{count} bytes will be read from the file, starting at @var{offset} | |
35623 | relative to the start of the file. The target may read fewer bytes; | |
35624 | common reasons include packet size limits and an end-of-file | |
35625 | condition. The number of bytes read is returned. Zero should only be | |
35626 | returned for a successful read at the end of the file, or if | |
35627 | @var{count} was zero. | |
35628 | ||
35629 | The data read should be returned as a binary attachment on success. | |
35630 | If zero bytes were read, the response should include an empty binary | |
35631 | attachment (i.e.@: a trailing semicolon). The return value is the | |
35632 | number of target bytes read; the binary attachment may be longer if | |
35633 | some characters were escaped. | |
35634 | ||
35635 | @item vFile:pwrite: @var{fd}, @var{offset}, @var{data} | |
35636 | Write @var{data} (a binary buffer) to the open file corresponding | |
35637 | to @var{fd}. Start the write at @var{offset} from the start of the | |
35638 | file. Unlike many @code{write} system calls, there is no | |
35639 | separate @var{count} argument; the length of @var{data} in the | |
35640 | packet is used. @samp{vFile:write} returns the number of bytes written, | |
35641 | which may be shorter than the length of @var{data}, or -1 if an | |
35642 | error occurred. | |
35643 | ||
35644 | @item vFile:unlink: @var{pathname} | |
35645 | Delete the file at @var{pathname} on the target. Return 0, | |
35646 | or -1 if an error occurs. @var{pathname} is a string. | |
35647 | ||
35648 | @end table | |
35649 | ||
9a6253be KB |
35650 | @node Interrupts |
35651 | @section Interrupts | |
35652 | @cindex interrupts (remote protocol) | |
35653 | ||
35654 | When a program on the remote target is running, @value{GDBN} may | |
9a7071a8 JB |
35655 | attempt to interrupt it by sending a @samp{Ctrl-C}, @code{BREAK} or |
35656 | a @code{BREAK} followed by @code{g}, | |
35657 | control of which is specified via @value{GDBN}'s @samp{interrupt-sequence}. | |
9a6253be KB |
35658 | |
35659 | The precise meaning of @code{BREAK} is defined by the transport | |
8775bb90 MS |
35660 | mechanism and may, in fact, be undefined. @value{GDBN} does not |
35661 | currently define a @code{BREAK} mechanism for any of the network | |
35662 | interfaces except for TCP, in which case @value{GDBN} sends the | |
35663 | @code{telnet} BREAK sequence. | |
9a6253be KB |
35664 | |
35665 | @samp{Ctrl-C}, on the other hand, is defined and implemented for all | |
35666 | transport mechanisms. It is represented by sending the single byte | |
35667 | @code{0x03} without any of the usual packet overhead described in | |
35668 | the Overview section (@pxref{Overview}). When a @code{0x03} byte is | |
35669 | transmitted as part of a packet, it is considered to be packet data | |
35670 | and does @emph{not} represent an interrupt. E.g., an @samp{X} packet | |
0876f84a | 35671 | (@pxref{X packet}), used for binary downloads, may include an unescaped |
9a6253be KB |
35672 | @code{0x03} as part of its packet. |
35673 | ||
9a7071a8 JB |
35674 | @code{BREAK} followed by @code{g} is also known as Magic SysRq g. |
35675 | When Linux kernel receives this sequence from serial port, | |
35676 | it stops execution and connects to gdb. | |
35677 | ||
9a6253be KB |
35678 | Stubs are not required to recognize these interrupt mechanisms and the |
35679 | precise meaning associated with receipt of the interrupt is | |
8b23ecc4 SL |
35680 | implementation defined. If the target supports debugging of multiple |
35681 | threads and/or processes, it should attempt to interrupt all | |
35682 | currently-executing threads and processes. | |
35683 | If the stub is successful at interrupting the | |
35684 | running program, it should send one of the stop | |
35685 | reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result | |
35686 | of successfully stopping the program in all-stop mode, and a stop reply | |
35687 | for each stopped thread in non-stop mode. | |
35688 | Interrupts received while the | |
35689 | program is stopped are discarded. | |
35690 | ||
35691 | @node Notification Packets | |
35692 | @section Notification Packets | |
35693 | @cindex notification packets | |
35694 | @cindex packets, notification | |
35695 | ||
35696 | The @value{GDBN} remote serial protocol includes @dfn{notifications}, | |
35697 | packets that require no acknowledgment. Both the GDB and the stub | |
35698 | may send notifications (although the only notifications defined at | |
35699 | present are sent by the stub). Notifications carry information | |
35700 | without incurring the round-trip latency of an acknowledgment, and so | |
35701 | are useful for low-impact communications where occasional packet loss | |
35702 | is not a problem. | |
35703 | ||
35704 | A notification packet has the form @samp{% @var{data} # | |
35705 | @var{checksum}}, where @var{data} is the content of the notification, | |
35706 | and @var{checksum} is a checksum of @var{data}, computed and formatted | |
35707 | as for ordinary @value{GDBN} packets. A notification's @var{data} | |
35708 | never contains @samp{$}, @samp{%} or @samp{#} characters. Upon | |
35709 | receiving a notification, the recipient sends no @samp{+} or @samp{-} | |
35710 | to acknowledge the notification's receipt or to report its corruption. | |
35711 | ||
35712 | Every notification's @var{data} begins with a name, which contains no | |
35713 | colon characters, followed by a colon character. | |
35714 | ||
35715 | Recipients should silently ignore corrupted notifications and | |
35716 | notifications they do not understand. Recipients should restart | |
35717 | timeout periods on receipt of a well-formed notification, whether or | |
35718 | not they understand it. | |
35719 | ||
35720 | Senders should only send the notifications described here when this | |
35721 | protocol description specifies that they are permitted. In the | |
35722 | future, we may extend the protocol to permit existing notifications in | |
35723 | new contexts; this rule helps older senders avoid confusing newer | |
35724 | recipients. | |
35725 | ||
35726 | (Older versions of @value{GDBN} ignore bytes received until they see | |
35727 | the @samp{$} byte that begins an ordinary packet, so new stubs may | |
35728 | transmit notifications without fear of confusing older clients. There | |
35729 | are no notifications defined for @value{GDBN} to send at the moment, but we | |
35730 | assume that most older stubs would ignore them, as well.) | |
35731 | ||
35732 | The following notification packets from the stub to @value{GDBN} are | |
35733 | defined: | |
35734 | ||
35735 | @table @samp | |
35736 | @item Stop: @var{reply} | |
35737 | Report an asynchronous stop event in non-stop mode. | |
35738 | The @var{reply} has the form of a stop reply, as | |
35739 | described in @ref{Stop Reply Packets}. Refer to @ref{Remote Non-Stop}, | |
35740 | for information on how these notifications are acknowledged by | |
35741 | @value{GDBN}. | |
35742 | @end table | |
35743 | ||
35744 | @node Remote Non-Stop | |
35745 | @section Remote Protocol Support for Non-Stop Mode | |
35746 | ||
35747 | @value{GDBN}'s remote protocol supports non-stop debugging of | |
35748 | multi-threaded programs, as described in @ref{Non-Stop Mode}. If the stub | |
35749 | supports non-stop mode, it should report that to @value{GDBN} by including | |
35750 | @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}). | |
35751 | ||
35752 | @value{GDBN} typically sends a @samp{QNonStop} packet only when | |
35753 | establishing a new connection with the stub. Entering non-stop mode | |
35754 | does not alter the state of any currently-running threads, but targets | |
35755 | must stop all threads in any already-attached processes when entering | |
35756 | all-stop mode. @value{GDBN} uses the @samp{?} packet as necessary to | |
35757 | probe the target state after a mode change. | |
35758 | ||
35759 | In non-stop mode, when an attached process encounters an event that | |
35760 | would otherwise be reported with a stop reply, it uses the | |
35761 | asynchronous notification mechanism (@pxref{Notification Packets}) to | |
35762 | inform @value{GDBN}. In contrast to all-stop mode, where all threads | |
35763 | in all processes are stopped when a stop reply is sent, in non-stop | |
35764 | mode only the thread reporting the stop event is stopped. That is, | |
35765 | when reporting a @samp{S} or @samp{T} response to indicate completion | |
35766 | of a step operation, hitting a breakpoint, or a fault, only the | |
35767 | affected thread is stopped; any other still-running threads continue | |
35768 | to run. When reporting a @samp{W} or @samp{X} response, all running | |
35769 | threads belonging to other attached processes continue to run. | |
35770 | ||
35771 | Only one stop reply notification at a time may be pending; if | |
35772 | additional stop events occur before @value{GDBN} has acknowledged the | |
35773 | previous notification, they must be queued by the stub for later | |
35774 | synchronous transmission in response to @samp{vStopped} packets from | |
35775 | @value{GDBN}. Because the notification mechanism is unreliable, | |
35776 | the stub is permitted to resend a stop reply notification | |
35777 | if it believes @value{GDBN} may not have received it. @value{GDBN} | |
35778 | ignores additional stop reply notifications received before it has | |
35779 | finished processing a previous notification and the stub has completed | |
35780 | sending any queued stop events. | |
35781 | ||
35782 | Otherwise, @value{GDBN} must be prepared to receive a stop reply | |
35783 | notification at any time. Specifically, they may appear when | |
35784 | @value{GDBN} is not otherwise reading input from the stub, or when | |
35785 | @value{GDBN} is expecting to read a normal synchronous response or a | |
35786 | @samp{+}/@samp{-} acknowledgment to a packet it has sent. | |
35787 | Notification packets are distinct from any other communication from | |
35788 | the stub so there is no ambiguity. | |
35789 | ||
35790 | After receiving a stop reply notification, @value{GDBN} shall | |
35791 | acknowledge it by sending a @samp{vStopped} packet (@pxref{vStopped packet}) | |
35792 | as a regular, synchronous request to the stub. Such acknowledgment | |
35793 | is not required to happen immediately, as @value{GDBN} is permitted to | |
35794 | send other, unrelated packets to the stub first, which the stub should | |
35795 | process normally. | |
35796 | ||
35797 | Upon receiving a @samp{vStopped} packet, if the stub has other queued | |
35798 | stop events to report to @value{GDBN}, it shall respond by sending a | |
35799 | normal stop reply response. @value{GDBN} shall then send another | |
35800 | @samp{vStopped} packet to solicit further responses; again, it is | |
35801 | permitted to send other, unrelated packets as well which the stub | |
35802 | should process normally. | |
35803 | ||
35804 | If the stub receives a @samp{vStopped} packet and there are no | |
35805 | additional stop events to report, the stub shall return an @samp{OK} | |
35806 | response. At this point, if further stop events occur, the stub shall | |
35807 | send a new stop reply notification, @value{GDBN} shall accept the | |
35808 | notification, and the process shall be repeated. | |
35809 | ||
35810 | In non-stop mode, the target shall respond to the @samp{?} packet as | |
35811 | follows. First, any incomplete stop reply notification/@samp{vStopped} | |
35812 | sequence in progress is abandoned. The target must begin a new | |
35813 | sequence reporting stop events for all stopped threads, whether or not | |
35814 | it has previously reported those events to @value{GDBN}. The first | |
35815 | stop reply is sent as a synchronous reply to the @samp{?} packet, and | |
35816 | subsequent stop replies are sent as responses to @samp{vStopped} packets | |
35817 | using the mechanism described above. The target must not send | |
35818 | asynchronous stop reply notifications until the sequence is complete. | |
35819 | If all threads are running when the target receives the @samp{?} packet, | |
35820 | or if the target is not attached to any process, it shall respond | |
35821 | @samp{OK}. | |
9a6253be | 35822 | |
a6f3e723 SL |
35823 | @node Packet Acknowledgment |
35824 | @section Packet Acknowledgment | |
35825 | ||
35826 | @cindex acknowledgment, for @value{GDBN} remote | |
35827 | @cindex packet acknowledgment, for @value{GDBN} remote | |
35828 | By default, when either the host or the target machine receives a packet, | |
35829 | the first response expected is an acknowledgment: either @samp{+} (to indicate | |
35830 | the package was received correctly) or @samp{-} (to request retransmission). | |
35831 | This mechanism allows the @value{GDBN} remote protocol to operate over | |
35832 | unreliable transport mechanisms, such as a serial line. | |
35833 | ||
35834 | In cases where the transport mechanism is itself reliable (such as a pipe or | |
35835 | TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant. | |
35836 | It may be desirable to disable them in that case to reduce communication | |
35837 | overhead, or for other reasons. This can be accomplished by means of the | |
35838 | @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}. | |
35839 | ||
35840 | When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or | |
35841 | expect @samp{+}/@samp{-} protocol acknowledgments. The packet | |
35842 | and response format still includes the normal checksum, as described in | |
35843 | @ref{Overview}, but the checksum may be ignored by the receiver. | |
35844 | ||
35845 | If the stub supports @samp{QStartNoAckMode} and prefers to operate in | |
35846 | no-acknowledgment mode, it should report that to @value{GDBN} | |
35847 | by including @samp{QStartNoAckMode+} in its response to @samp{qSupported}; | |
35848 | @pxref{qSupported}. | |
35849 | If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been | |
35850 | disabled via the @code{set remote noack-packet off} command | |
35851 | (@pxref{Remote Configuration}), | |
35852 | @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub. | |
35853 | Only then may the stub actually turn off packet acknowledgments. | |
35854 | @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK} | |
35855 | response, which can be safely ignored by the stub. | |
35856 | ||
35857 | Note that @code{set remote noack-packet} command only affects negotiation | |
35858 | between @value{GDBN} and the stub when subsequent connections are made; | |
35859 | it does not affect the protocol acknowledgment state for any current | |
35860 | connection. | |
35861 | Since @samp{+}/@samp{-} acknowledgments are enabled by default when a | |
35862 | new connection is established, | |
35863 | there is also no protocol request to re-enable the acknowledgments | |
35864 | for the current connection, once disabled. | |
35865 | ||
ee2d5c50 AC |
35866 | @node Examples |
35867 | @section Examples | |
eb12ee30 | 35868 | |
8e04817f AC |
35869 | Example sequence of a target being re-started. Notice how the restart |
35870 | does not get any direct output: | |
eb12ee30 | 35871 | |
474c8240 | 35872 | @smallexample |
d2c6833e AC |
35873 | -> @code{R00} |
35874 | <- @code{+} | |
8e04817f | 35875 | @emph{target restarts} |
d2c6833e | 35876 | -> @code{?} |
8e04817f | 35877 | <- @code{+} |
d2c6833e AC |
35878 | <- @code{T001:1234123412341234} |
35879 | -> @code{+} | |
474c8240 | 35880 | @end smallexample |
eb12ee30 | 35881 | |
8e04817f | 35882 | Example sequence of a target being stepped by a single instruction: |
eb12ee30 | 35883 | |
474c8240 | 35884 | @smallexample |
d2c6833e | 35885 | -> @code{G1445@dots{}} |
8e04817f | 35886 | <- @code{+} |
d2c6833e AC |
35887 | -> @code{s} |
35888 | <- @code{+} | |
35889 | @emph{time passes} | |
35890 | <- @code{T001:1234123412341234} | |
8e04817f | 35891 | -> @code{+} |
d2c6833e | 35892 | -> @code{g} |
8e04817f | 35893 | <- @code{+} |
d2c6833e AC |
35894 | <- @code{1455@dots{}} |
35895 | -> @code{+} | |
474c8240 | 35896 | @end smallexample |
eb12ee30 | 35897 | |
79a6e687 BW |
35898 | @node File-I/O Remote Protocol Extension |
35899 | @section File-I/O Remote Protocol Extension | |
0ce1b118 CV |
35900 | @cindex File-I/O remote protocol extension |
35901 | ||
35902 | @menu | |
35903 | * File-I/O Overview:: | |
79a6e687 BW |
35904 | * Protocol Basics:: |
35905 | * The F Request Packet:: | |
35906 | * The F Reply Packet:: | |
35907 | * The Ctrl-C Message:: | |
0ce1b118 | 35908 | * Console I/O:: |
79a6e687 | 35909 | * List of Supported Calls:: |
db2e3e2e | 35910 | * Protocol-specific Representation of Datatypes:: |
0ce1b118 CV |
35911 | * Constants:: |
35912 | * File-I/O Examples:: | |
35913 | @end menu | |
35914 | ||
35915 | @node File-I/O Overview | |
35916 | @subsection File-I/O Overview | |
35917 | @cindex file-i/o overview | |
35918 | ||
9c16f35a | 35919 | The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the |
fc320d37 | 35920 | target to use the host's file system and console I/O to perform various |
0ce1b118 | 35921 | system calls. System calls on the target system are translated into a |
fc320d37 SL |
35922 | remote protocol packet to the host system, which then performs the needed |
35923 | actions and returns a response packet to the target system. | |
0ce1b118 CV |
35924 | This simulates file system operations even on targets that lack file systems. |
35925 | ||
fc320d37 SL |
35926 | The protocol is defined to be independent of both the host and target systems. |
35927 | It uses its own internal representation of datatypes and values. Both | |
0ce1b118 | 35928 | @value{GDBN} and the target's @value{GDBN} stub are responsible for |
fc320d37 SL |
35929 | translating the system-dependent value representations into the internal |
35930 | protocol representations when data is transmitted. | |
0ce1b118 | 35931 | |
fc320d37 SL |
35932 | The communication is synchronous. A system call is possible only when |
35933 | @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S} | |
35934 | or @samp{s} packets. While @value{GDBN} handles the request for a system call, | |
0ce1b118 | 35935 | the target is stopped to allow deterministic access to the target's |
fc320d37 SL |
35936 | memory. Therefore File-I/O is not interruptible by target signals. On |
35937 | the other hand, it is possible to interrupt File-I/O by a user interrupt | |
c8aa23ab | 35938 | (@samp{Ctrl-C}) within @value{GDBN}. |
0ce1b118 CV |
35939 | |
35940 | The target's request to perform a host system call does not finish | |
35941 | the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means, | |
35942 | after finishing the system call, the target returns to continuing the | |
35943 | previous activity (continue, step). No additional continue or step | |
35944 | request from @value{GDBN} is required. | |
35945 | ||
35946 | @smallexample | |
f7dc1244 | 35947 | (@value{GDBP}) continue |
0ce1b118 CV |
35948 | <- target requests 'system call X' |
35949 | target is stopped, @value{GDBN} executes system call | |
3f94c067 BW |
35950 | -> @value{GDBN} returns result |
35951 | ... target continues, @value{GDBN} returns to wait for the target | |
0ce1b118 CV |
35952 | <- target hits breakpoint and sends a Txx packet |
35953 | @end smallexample | |
35954 | ||
fc320d37 SL |
35955 | The protocol only supports I/O on the console and to regular files on |
35956 | the host file system. Character or block special devices, pipes, | |
35957 | named pipes, sockets or any other communication method on the host | |
0ce1b118 CV |
35958 | system are not supported by this protocol. |
35959 | ||
8b23ecc4 SL |
35960 | File I/O is not supported in non-stop mode. |
35961 | ||
79a6e687 BW |
35962 | @node Protocol Basics |
35963 | @subsection Protocol Basics | |
0ce1b118 CV |
35964 | @cindex protocol basics, file-i/o |
35965 | ||
fc320d37 SL |
35966 | The File-I/O protocol uses the @code{F} packet as the request as well |
35967 | as reply packet. Since a File-I/O system call can only occur when | |
35968 | @value{GDBN} is waiting for a response from the continuing or stepping target, | |
35969 | the File-I/O request is a reply that @value{GDBN} has to expect as a result | |
35970 | of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet. | |
0ce1b118 CV |
35971 | This @code{F} packet contains all information needed to allow @value{GDBN} |
35972 | to call the appropriate host system call: | |
35973 | ||
35974 | @itemize @bullet | |
b383017d | 35975 | @item |
0ce1b118 CV |
35976 | A unique identifier for the requested system call. |
35977 | ||
35978 | @item | |
35979 | All parameters to the system call. Pointers are given as addresses | |
35980 | in the target memory address space. Pointers to strings are given as | |
b383017d | 35981 | pointer/length pair. Numerical values are given as they are. |
db2e3e2e | 35982 | Numerical control flags are given in a protocol-specific representation. |
0ce1b118 CV |
35983 | |
35984 | @end itemize | |
35985 | ||
fc320d37 | 35986 | At this point, @value{GDBN} has to perform the following actions. |
0ce1b118 CV |
35987 | |
35988 | @itemize @bullet | |
b383017d | 35989 | @item |
fc320d37 SL |
35990 | If the parameters include pointer values to data needed as input to a |
35991 | system call, @value{GDBN} requests this data from the target with a | |
0ce1b118 CV |
35992 | standard @code{m} packet request. This additional communication has to be |
35993 | expected by the target implementation and is handled as any other @code{m} | |
35994 | packet. | |
35995 | ||
35996 | @item | |
35997 | @value{GDBN} translates all value from protocol representation to host | |
35998 | representation as needed. Datatypes are coerced into the host types. | |
35999 | ||
36000 | @item | |
fc320d37 | 36001 | @value{GDBN} calls the system call. |
0ce1b118 CV |
36002 | |
36003 | @item | |
36004 | It then coerces datatypes back to protocol representation. | |
36005 | ||
36006 | @item | |
fc320d37 SL |
36007 | If the system call is expected to return data in buffer space specified |
36008 | by pointer parameters to the call, the data is transmitted to the | |
0ce1b118 CV |
36009 | target using a @code{M} or @code{X} packet. This packet has to be expected |
36010 | by the target implementation and is handled as any other @code{M} or @code{X} | |
36011 | packet. | |
36012 | ||
36013 | @end itemize | |
36014 | ||
36015 | Eventually @value{GDBN} replies with another @code{F} packet which contains all | |
36016 | necessary information for the target to continue. This at least contains | |
36017 | ||
36018 | @itemize @bullet | |
36019 | @item | |
36020 | Return value. | |
36021 | ||
36022 | @item | |
36023 | @code{errno}, if has been changed by the system call. | |
36024 | ||
36025 | @item | |
36026 | ``Ctrl-C'' flag. | |
36027 | ||
36028 | @end itemize | |
36029 | ||
36030 | After having done the needed type and value coercion, the target continues | |
36031 | the latest continue or step action. | |
36032 | ||
79a6e687 BW |
36033 | @node The F Request Packet |
36034 | @subsection The @code{F} Request Packet | |
0ce1b118 CV |
36035 | @cindex file-i/o request packet |
36036 | @cindex @code{F} request packet | |
36037 | ||
36038 | The @code{F} request packet has the following format: | |
36039 | ||
36040 | @table @samp | |
fc320d37 | 36041 | @item F@var{call-id},@var{parameter@dots{}} |
0ce1b118 CV |
36042 | |
36043 | @var{call-id} is the identifier to indicate the host system call to be called. | |
36044 | This is just the name of the function. | |
36045 | ||
fc320d37 SL |
36046 | @var{parameter@dots{}} are the parameters to the system call. |
36047 | Parameters are hexadecimal integer values, either the actual values in case | |
36048 | of scalar datatypes, pointers to target buffer space in case of compound | |
36049 | datatypes and unspecified memory areas, or pointer/length pairs in case | |
36050 | of string parameters. These are appended to the @var{call-id} as a | |
36051 | comma-delimited list. All values are transmitted in ASCII | |
36052 | string representation, pointer/length pairs separated by a slash. | |
0ce1b118 | 36053 | |
b383017d | 36054 | @end table |
0ce1b118 | 36055 | |
fc320d37 | 36056 | |
0ce1b118 | 36057 | |
79a6e687 BW |
36058 | @node The F Reply Packet |
36059 | @subsection The @code{F} Reply Packet | |
0ce1b118 CV |
36060 | @cindex file-i/o reply packet |
36061 | @cindex @code{F} reply packet | |
36062 | ||
36063 | The @code{F} reply packet has the following format: | |
36064 | ||
36065 | @table @samp | |
36066 | ||
d3bdde98 | 36067 | @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment} |
0ce1b118 CV |
36068 | |
36069 | @var{retcode} is the return code of the system call as hexadecimal value. | |
36070 | ||
db2e3e2e BW |
36071 | @var{errno} is the @code{errno} set by the call, in protocol-specific |
36072 | representation. | |
0ce1b118 CV |
36073 | This parameter can be omitted if the call was successful. |
36074 | ||
fc320d37 SL |
36075 | @var{Ctrl-C flag} is only sent if the user requested a break. In this |
36076 | case, @var{errno} must be sent as well, even if the call was successful. | |
36077 | The @var{Ctrl-C flag} itself consists of the character @samp{C}: | |
0ce1b118 CV |
36078 | |
36079 | @smallexample | |
36080 | F0,0,C | |
36081 | @end smallexample | |
36082 | ||
36083 | @noindent | |
fc320d37 | 36084 | or, if the call was interrupted before the host call has been performed: |
0ce1b118 CV |
36085 | |
36086 | @smallexample | |
36087 | F-1,4,C | |
36088 | @end smallexample | |
36089 | ||
36090 | @noindent | |
db2e3e2e | 36091 | assuming 4 is the protocol-specific representation of @code{EINTR}. |
0ce1b118 CV |
36092 | |
36093 | @end table | |
36094 | ||
0ce1b118 | 36095 | |
79a6e687 BW |
36096 | @node The Ctrl-C Message |
36097 | @subsection The @samp{Ctrl-C} Message | |
0ce1b118 CV |
36098 | @cindex ctrl-c message, in file-i/o protocol |
36099 | ||
c8aa23ab | 36100 | If the @samp{Ctrl-C} flag is set in the @value{GDBN} |
79a6e687 | 36101 | reply packet (@pxref{The F Reply Packet}), |
fc320d37 | 36102 | the target should behave as if it had |
0ce1b118 | 36103 | gotten a break message. The meaning for the target is ``system call |
fc320d37 | 36104 | interrupted by @code{SIGINT}''. Consequentially, the target should actually stop |
0ce1b118 | 36105 | (as with a break message) and return to @value{GDBN} with a @code{T02} |
c8aa23ab | 36106 | packet. |
fc320d37 SL |
36107 | |
36108 | It's important for the target to know in which | |
36109 | state the system call was interrupted. There are two possible cases: | |
0ce1b118 CV |
36110 | |
36111 | @itemize @bullet | |
36112 | @item | |
36113 | The system call hasn't been performed on the host yet. | |
36114 | ||
36115 | @item | |
36116 | The system call on the host has been finished. | |
36117 | ||
36118 | @end itemize | |
36119 | ||
36120 | These two states can be distinguished by the target by the value of the | |
36121 | returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system | |
36122 | call hasn't been performed. This is equivalent to the @code{EINTR} handling | |
36123 | on POSIX systems. In any other case, the target may presume that the | |
fc320d37 | 36124 | system call has been finished --- successfully or not --- and should behave |
0ce1b118 CV |
36125 | as if the break message arrived right after the system call. |
36126 | ||
fc320d37 | 36127 | @value{GDBN} must behave reliably. If the system call has not been called |
0ce1b118 CV |
36128 | yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as |
36129 | @code{errno} in the packet. If the system call on the host has been finished | |
fc320d37 SL |
36130 | before the user requests a break, the full action must be finished by |
36131 | @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary. | |
36132 | The @code{F} packet may only be sent when either nothing has happened | |
0ce1b118 CV |
36133 | or the full action has been completed. |
36134 | ||
36135 | @node Console I/O | |
36136 | @subsection Console I/O | |
36137 | @cindex console i/o as part of file-i/o | |
36138 | ||
d3e8051b | 36139 | By default and if not explicitly closed by the target system, the file |
0ce1b118 CV |
36140 | descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output |
36141 | on the @value{GDBN} console is handled as any other file output operation | |
36142 | (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled | |
36143 | by @value{GDBN} so that after the target read request from file descriptor | |
36144 | 0 all following typing is buffered until either one of the following | |
36145 | conditions is met: | |
36146 | ||
36147 | @itemize @bullet | |
36148 | @item | |
c8aa23ab | 36149 | The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the |
0ce1b118 CV |
36150 | @code{read} |
36151 | system call is treated as finished. | |
36152 | ||
36153 | @item | |
7f9087cb | 36154 | The user presses @key{RET}. This is treated as end of input with a trailing |
fc320d37 | 36155 | newline. |
0ce1b118 CV |
36156 | |
36157 | @item | |
c8aa23ab EZ |
36158 | The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing |
36159 | character (neither newline nor @samp{Ctrl-D}) is appended to the input. | |
0ce1b118 CV |
36160 | |
36161 | @end itemize | |
36162 | ||
fc320d37 SL |
36163 | If the user has typed more characters than fit in the buffer given to |
36164 | the @code{read} call, the trailing characters are buffered in @value{GDBN} until | |
36165 | either another @code{read(0, @dots{})} is requested by the target, or debugging | |
36166 | is stopped at the user's request. | |
0ce1b118 | 36167 | |
0ce1b118 | 36168 | |
79a6e687 BW |
36169 | @node List of Supported Calls |
36170 | @subsection List of Supported Calls | |
0ce1b118 CV |
36171 | @cindex list of supported file-i/o calls |
36172 | ||
36173 | @menu | |
36174 | * open:: | |
36175 | * close:: | |
36176 | * read:: | |
36177 | * write:: | |
36178 | * lseek:: | |
36179 | * rename:: | |
36180 | * unlink:: | |
36181 | * stat/fstat:: | |
36182 | * gettimeofday:: | |
36183 | * isatty:: | |
36184 | * system:: | |
36185 | @end menu | |
36186 | ||
36187 | @node open | |
36188 | @unnumberedsubsubsec open | |
36189 | @cindex open, file-i/o system call | |
36190 | ||
fc320d37 SL |
36191 | @table @asis |
36192 | @item Synopsis: | |
0ce1b118 | 36193 | @smallexample |
0ce1b118 CV |
36194 | int open(const char *pathname, int flags); |
36195 | int open(const char *pathname, int flags, mode_t mode); | |
0ce1b118 CV |
36196 | @end smallexample |
36197 | ||
fc320d37 SL |
36198 | @item Request: |
36199 | @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}} | |
36200 | ||
0ce1b118 | 36201 | @noindent |
fc320d37 | 36202 | @var{flags} is the bitwise @code{OR} of the following values: |
0ce1b118 CV |
36203 | |
36204 | @table @code | |
b383017d | 36205 | @item O_CREAT |
0ce1b118 CV |
36206 | If the file does not exist it will be created. The host |
36207 | rules apply as far as file ownership and time stamps | |
36208 | are concerned. | |
36209 | ||
b383017d | 36210 | @item O_EXCL |
fc320d37 | 36211 | When used with @code{O_CREAT}, if the file already exists it is |
0ce1b118 CV |
36212 | an error and open() fails. |
36213 | ||
b383017d | 36214 | @item O_TRUNC |
0ce1b118 | 36215 | If the file already exists and the open mode allows |
fc320d37 SL |
36216 | writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be |
36217 | truncated to zero length. | |
0ce1b118 | 36218 | |
b383017d | 36219 | @item O_APPEND |
0ce1b118 CV |
36220 | The file is opened in append mode. |
36221 | ||
b383017d | 36222 | @item O_RDONLY |
0ce1b118 CV |
36223 | The file is opened for reading only. |
36224 | ||
b383017d | 36225 | @item O_WRONLY |
0ce1b118 CV |
36226 | The file is opened for writing only. |
36227 | ||
b383017d | 36228 | @item O_RDWR |
0ce1b118 | 36229 | The file is opened for reading and writing. |
fc320d37 | 36230 | @end table |
0ce1b118 CV |
36231 | |
36232 | @noindent | |
fc320d37 | 36233 | Other bits are silently ignored. |
0ce1b118 | 36234 | |
0ce1b118 CV |
36235 | |
36236 | @noindent | |
fc320d37 | 36237 | @var{mode} is the bitwise @code{OR} of the following values: |
0ce1b118 CV |
36238 | |
36239 | @table @code | |
b383017d | 36240 | @item S_IRUSR |
0ce1b118 CV |
36241 | User has read permission. |
36242 | ||
b383017d | 36243 | @item S_IWUSR |
0ce1b118 CV |
36244 | User has write permission. |
36245 | ||
b383017d | 36246 | @item S_IRGRP |
0ce1b118 CV |
36247 | Group has read permission. |
36248 | ||
b383017d | 36249 | @item S_IWGRP |
0ce1b118 CV |
36250 | Group has write permission. |
36251 | ||
b383017d | 36252 | @item S_IROTH |
0ce1b118 CV |
36253 | Others have read permission. |
36254 | ||
b383017d | 36255 | @item S_IWOTH |
0ce1b118 | 36256 | Others have write permission. |
fc320d37 | 36257 | @end table |
0ce1b118 CV |
36258 | |
36259 | @noindent | |
fc320d37 | 36260 | Other bits are silently ignored. |
0ce1b118 | 36261 | |
0ce1b118 | 36262 | |
fc320d37 SL |
36263 | @item Return value: |
36264 | @code{open} returns the new file descriptor or -1 if an error | |
36265 | occurred. | |
0ce1b118 | 36266 | |
fc320d37 | 36267 | @item Errors: |
0ce1b118 CV |
36268 | |
36269 | @table @code | |
b383017d | 36270 | @item EEXIST |
fc320d37 | 36271 | @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used. |
0ce1b118 | 36272 | |
b383017d | 36273 | @item EISDIR |
fc320d37 | 36274 | @var{pathname} refers to a directory. |
0ce1b118 | 36275 | |
b383017d | 36276 | @item EACCES |
0ce1b118 CV |
36277 | The requested access is not allowed. |
36278 | ||
36279 | @item ENAMETOOLONG | |
fc320d37 | 36280 | @var{pathname} was too long. |
0ce1b118 | 36281 | |
b383017d | 36282 | @item ENOENT |
fc320d37 | 36283 | A directory component in @var{pathname} does not exist. |
0ce1b118 | 36284 | |
b383017d | 36285 | @item ENODEV |
fc320d37 | 36286 | @var{pathname} refers to a device, pipe, named pipe or socket. |
0ce1b118 | 36287 | |
b383017d | 36288 | @item EROFS |
fc320d37 | 36289 | @var{pathname} refers to a file on a read-only filesystem and |
0ce1b118 CV |
36290 | write access was requested. |
36291 | ||
b383017d | 36292 | @item EFAULT |
fc320d37 | 36293 | @var{pathname} is an invalid pointer value. |
0ce1b118 | 36294 | |
b383017d | 36295 | @item ENOSPC |
0ce1b118 CV |
36296 | No space on device to create the file. |
36297 | ||
b383017d | 36298 | @item EMFILE |
0ce1b118 CV |
36299 | The process already has the maximum number of files open. |
36300 | ||
b383017d | 36301 | @item ENFILE |
0ce1b118 CV |
36302 | The limit on the total number of files open on the system |
36303 | has been reached. | |
36304 | ||
b383017d | 36305 | @item EINTR |
0ce1b118 CV |
36306 | The call was interrupted by the user. |
36307 | @end table | |
36308 | ||
fc320d37 SL |
36309 | @end table |
36310 | ||
0ce1b118 CV |
36311 | @node close |
36312 | @unnumberedsubsubsec close | |
36313 | @cindex close, file-i/o system call | |
36314 | ||
fc320d37 SL |
36315 | @table @asis |
36316 | @item Synopsis: | |
0ce1b118 | 36317 | @smallexample |
0ce1b118 | 36318 | int close(int fd); |
fc320d37 | 36319 | @end smallexample |
0ce1b118 | 36320 | |
fc320d37 SL |
36321 | @item Request: |
36322 | @samp{Fclose,@var{fd}} | |
0ce1b118 | 36323 | |
fc320d37 SL |
36324 | @item Return value: |
36325 | @code{close} returns zero on success, or -1 if an error occurred. | |
0ce1b118 | 36326 | |
fc320d37 | 36327 | @item Errors: |
0ce1b118 CV |
36328 | |
36329 | @table @code | |
b383017d | 36330 | @item EBADF |
fc320d37 | 36331 | @var{fd} isn't a valid open file descriptor. |
0ce1b118 | 36332 | |
b383017d | 36333 | @item EINTR |
0ce1b118 CV |
36334 | The call was interrupted by the user. |
36335 | @end table | |
36336 | ||
fc320d37 SL |
36337 | @end table |
36338 | ||
0ce1b118 CV |
36339 | @node read |
36340 | @unnumberedsubsubsec read | |
36341 | @cindex read, file-i/o system call | |
36342 | ||
fc320d37 SL |
36343 | @table @asis |
36344 | @item Synopsis: | |
0ce1b118 | 36345 | @smallexample |
0ce1b118 | 36346 | int read(int fd, void *buf, unsigned int count); |
fc320d37 | 36347 | @end smallexample |
0ce1b118 | 36348 | |
fc320d37 SL |
36349 | @item Request: |
36350 | @samp{Fread,@var{fd},@var{bufptr},@var{count}} | |
0ce1b118 | 36351 | |
fc320d37 | 36352 | @item Return value: |
0ce1b118 CV |
36353 | On success, the number of bytes read is returned. |
36354 | Zero indicates end of file. If count is zero, read | |
b383017d | 36355 | returns zero as well. On error, -1 is returned. |
0ce1b118 | 36356 | |
fc320d37 | 36357 | @item Errors: |
0ce1b118 CV |
36358 | |
36359 | @table @code | |
b383017d | 36360 | @item EBADF |
fc320d37 | 36361 | @var{fd} is not a valid file descriptor or is not open for |
0ce1b118 CV |
36362 | reading. |
36363 | ||
b383017d | 36364 | @item EFAULT |
fc320d37 | 36365 | @var{bufptr} is an invalid pointer value. |
0ce1b118 | 36366 | |
b383017d | 36367 | @item EINTR |
0ce1b118 CV |
36368 | The call was interrupted by the user. |
36369 | @end table | |
36370 | ||
fc320d37 SL |
36371 | @end table |
36372 | ||
0ce1b118 CV |
36373 | @node write |
36374 | @unnumberedsubsubsec write | |
36375 | @cindex write, file-i/o system call | |
36376 | ||
fc320d37 SL |
36377 | @table @asis |
36378 | @item Synopsis: | |
0ce1b118 | 36379 | @smallexample |
0ce1b118 | 36380 | int write(int fd, const void *buf, unsigned int count); |
fc320d37 | 36381 | @end smallexample |
0ce1b118 | 36382 | |
fc320d37 SL |
36383 | @item Request: |
36384 | @samp{Fwrite,@var{fd},@var{bufptr},@var{count}} | |
0ce1b118 | 36385 | |
fc320d37 | 36386 | @item Return value: |
0ce1b118 CV |
36387 | On success, the number of bytes written are returned. |
36388 | Zero indicates nothing was written. On error, -1 | |
36389 | is returned. | |
36390 | ||
fc320d37 | 36391 | @item Errors: |
0ce1b118 CV |
36392 | |
36393 | @table @code | |
b383017d | 36394 | @item EBADF |
fc320d37 | 36395 | @var{fd} is not a valid file descriptor or is not open for |
0ce1b118 CV |
36396 | writing. |
36397 | ||
b383017d | 36398 | @item EFAULT |
fc320d37 | 36399 | @var{bufptr} is an invalid pointer value. |
0ce1b118 | 36400 | |
b383017d | 36401 | @item EFBIG |
0ce1b118 | 36402 | An attempt was made to write a file that exceeds the |
db2e3e2e | 36403 | host-specific maximum file size allowed. |
0ce1b118 | 36404 | |
b383017d | 36405 | @item ENOSPC |
0ce1b118 CV |
36406 | No space on device to write the data. |
36407 | ||
b383017d | 36408 | @item EINTR |
0ce1b118 CV |
36409 | The call was interrupted by the user. |
36410 | @end table | |
36411 | ||
fc320d37 SL |
36412 | @end table |
36413 | ||
0ce1b118 CV |
36414 | @node lseek |
36415 | @unnumberedsubsubsec lseek | |
36416 | @cindex lseek, file-i/o system call | |
36417 | ||
fc320d37 SL |
36418 | @table @asis |
36419 | @item Synopsis: | |
0ce1b118 | 36420 | @smallexample |
0ce1b118 | 36421 | long lseek (int fd, long offset, int flag); |
0ce1b118 CV |
36422 | @end smallexample |
36423 | ||
fc320d37 SL |
36424 | @item Request: |
36425 | @samp{Flseek,@var{fd},@var{offset},@var{flag}} | |
36426 | ||
36427 | @var{flag} is one of: | |
0ce1b118 CV |
36428 | |
36429 | @table @code | |
b383017d | 36430 | @item SEEK_SET |
fc320d37 | 36431 | The offset is set to @var{offset} bytes. |
0ce1b118 | 36432 | |
b383017d | 36433 | @item SEEK_CUR |
fc320d37 | 36434 | The offset is set to its current location plus @var{offset} |
0ce1b118 CV |
36435 | bytes. |
36436 | ||
b383017d | 36437 | @item SEEK_END |
fc320d37 | 36438 | The offset is set to the size of the file plus @var{offset} |
0ce1b118 CV |
36439 | bytes. |
36440 | @end table | |
36441 | ||
fc320d37 | 36442 | @item Return value: |
0ce1b118 CV |
36443 | On success, the resulting unsigned offset in bytes from |
36444 | the beginning of the file is returned. Otherwise, a | |
36445 | value of -1 is returned. | |
36446 | ||
fc320d37 | 36447 | @item Errors: |
0ce1b118 CV |
36448 | |
36449 | @table @code | |
b383017d | 36450 | @item EBADF |
fc320d37 | 36451 | @var{fd} is not a valid open file descriptor. |
0ce1b118 | 36452 | |
b383017d | 36453 | @item ESPIPE |
fc320d37 | 36454 | @var{fd} is associated with the @value{GDBN} console. |
0ce1b118 | 36455 | |
b383017d | 36456 | @item EINVAL |
fc320d37 | 36457 | @var{flag} is not a proper value. |
0ce1b118 | 36458 | |
b383017d | 36459 | @item EINTR |
0ce1b118 CV |
36460 | The call was interrupted by the user. |
36461 | @end table | |
36462 | ||
fc320d37 SL |
36463 | @end table |
36464 | ||
0ce1b118 CV |
36465 | @node rename |
36466 | @unnumberedsubsubsec rename | |
36467 | @cindex rename, file-i/o system call | |
36468 | ||
fc320d37 SL |
36469 | @table @asis |
36470 | @item Synopsis: | |
0ce1b118 | 36471 | @smallexample |
0ce1b118 | 36472 | int rename(const char *oldpath, const char *newpath); |
fc320d37 | 36473 | @end smallexample |
0ce1b118 | 36474 | |
fc320d37 SL |
36475 | @item Request: |
36476 | @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}} | |
0ce1b118 | 36477 | |
fc320d37 | 36478 | @item Return value: |
0ce1b118 CV |
36479 | On success, zero is returned. On error, -1 is returned. |
36480 | ||
fc320d37 | 36481 | @item Errors: |
0ce1b118 CV |
36482 | |
36483 | @table @code | |
b383017d | 36484 | @item EISDIR |
fc320d37 | 36485 | @var{newpath} is an existing directory, but @var{oldpath} is not a |
0ce1b118 CV |
36486 | directory. |
36487 | ||
b383017d | 36488 | @item EEXIST |
fc320d37 | 36489 | @var{newpath} is a non-empty directory. |
0ce1b118 | 36490 | |
b383017d | 36491 | @item EBUSY |
fc320d37 | 36492 | @var{oldpath} or @var{newpath} is a directory that is in use by some |
0ce1b118 CV |
36493 | process. |
36494 | ||
b383017d | 36495 | @item EINVAL |
0ce1b118 CV |
36496 | An attempt was made to make a directory a subdirectory |
36497 | of itself. | |
36498 | ||
b383017d | 36499 | @item ENOTDIR |
fc320d37 SL |
36500 | A component used as a directory in @var{oldpath} or new |
36501 | path is not a directory. Or @var{oldpath} is a directory | |
36502 | and @var{newpath} exists but is not a directory. | |
0ce1b118 | 36503 | |
b383017d | 36504 | @item EFAULT |
fc320d37 | 36505 | @var{oldpathptr} or @var{newpathptr} are invalid pointer values. |
0ce1b118 | 36506 | |
b383017d | 36507 | @item EACCES |
0ce1b118 CV |
36508 | No access to the file or the path of the file. |
36509 | ||
36510 | @item ENAMETOOLONG | |
b383017d | 36511 | |
fc320d37 | 36512 | @var{oldpath} or @var{newpath} was too long. |
0ce1b118 | 36513 | |
b383017d | 36514 | @item ENOENT |
fc320d37 | 36515 | A directory component in @var{oldpath} or @var{newpath} does not exist. |
0ce1b118 | 36516 | |
b383017d | 36517 | @item EROFS |
0ce1b118 CV |
36518 | The file is on a read-only filesystem. |
36519 | ||
b383017d | 36520 | @item ENOSPC |
0ce1b118 CV |
36521 | The device containing the file has no room for the new |
36522 | directory entry. | |
36523 | ||
b383017d | 36524 | @item EINTR |
0ce1b118 CV |
36525 | The call was interrupted by the user. |
36526 | @end table | |
36527 | ||
fc320d37 SL |
36528 | @end table |
36529 | ||
0ce1b118 CV |
36530 | @node unlink |
36531 | @unnumberedsubsubsec unlink | |
36532 | @cindex unlink, file-i/o system call | |
36533 | ||
fc320d37 SL |
36534 | @table @asis |
36535 | @item Synopsis: | |
0ce1b118 | 36536 | @smallexample |
0ce1b118 | 36537 | int unlink(const char *pathname); |
fc320d37 | 36538 | @end smallexample |
0ce1b118 | 36539 | |
fc320d37 SL |
36540 | @item Request: |
36541 | @samp{Funlink,@var{pathnameptr}/@var{len}} | |
0ce1b118 | 36542 | |
fc320d37 | 36543 | @item Return value: |
0ce1b118 CV |
36544 | On success, zero is returned. On error, -1 is returned. |
36545 | ||
fc320d37 | 36546 | @item Errors: |
0ce1b118 CV |
36547 | |
36548 | @table @code | |
b383017d | 36549 | @item EACCES |
0ce1b118 CV |
36550 | No access to the file or the path of the file. |
36551 | ||
b383017d | 36552 | @item EPERM |
0ce1b118 CV |
36553 | The system does not allow unlinking of directories. |
36554 | ||
b383017d | 36555 | @item EBUSY |
fc320d37 | 36556 | The file @var{pathname} cannot be unlinked because it's |
0ce1b118 CV |
36557 | being used by another process. |
36558 | ||
b383017d | 36559 | @item EFAULT |
fc320d37 | 36560 | @var{pathnameptr} is an invalid pointer value. |
0ce1b118 CV |
36561 | |
36562 | @item ENAMETOOLONG | |
fc320d37 | 36563 | @var{pathname} was too long. |
0ce1b118 | 36564 | |
b383017d | 36565 | @item ENOENT |
fc320d37 | 36566 | A directory component in @var{pathname} does not exist. |
0ce1b118 | 36567 | |
b383017d | 36568 | @item ENOTDIR |
0ce1b118 CV |
36569 | A component of the path is not a directory. |
36570 | ||
b383017d | 36571 | @item EROFS |
0ce1b118 CV |
36572 | The file is on a read-only filesystem. |
36573 | ||
b383017d | 36574 | @item EINTR |
0ce1b118 CV |
36575 | The call was interrupted by the user. |
36576 | @end table | |
36577 | ||
fc320d37 SL |
36578 | @end table |
36579 | ||
0ce1b118 CV |
36580 | @node stat/fstat |
36581 | @unnumberedsubsubsec stat/fstat | |
36582 | @cindex fstat, file-i/o system call | |
36583 | @cindex stat, file-i/o system call | |
36584 | ||
fc320d37 SL |
36585 | @table @asis |
36586 | @item Synopsis: | |
0ce1b118 | 36587 | @smallexample |
0ce1b118 CV |
36588 | int stat(const char *pathname, struct stat *buf); |
36589 | int fstat(int fd, struct stat *buf); | |
fc320d37 | 36590 | @end smallexample |
0ce1b118 | 36591 | |
fc320d37 SL |
36592 | @item Request: |
36593 | @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@* | |
36594 | @samp{Ffstat,@var{fd},@var{bufptr}} | |
0ce1b118 | 36595 | |
fc320d37 | 36596 | @item Return value: |
0ce1b118 CV |
36597 | On success, zero is returned. On error, -1 is returned. |
36598 | ||
fc320d37 | 36599 | @item Errors: |
0ce1b118 CV |
36600 | |
36601 | @table @code | |
b383017d | 36602 | @item EBADF |
fc320d37 | 36603 | @var{fd} is not a valid open file. |
0ce1b118 | 36604 | |
b383017d | 36605 | @item ENOENT |
fc320d37 | 36606 | A directory component in @var{pathname} does not exist or the |
0ce1b118 CV |
36607 | path is an empty string. |
36608 | ||
b383017d | 36609 | @item ENOTDIR |
0ce1b118 CV |
36610 | A component of the path is not a directory. |
36611 | ||
b383017d | 36612 | @item EFAULT |
fc320d37 | 36613 | @var{pathnameptr} is an invalid pointer value. |
0ce1b118 | 36614 | |
b383017d | 36615 | @item EACCES |
0ce1b118 CV |
36616 | No access to the file or the path of the file. |
36617 | ||
36618 | @item ENAMETOOLONG | |
fc320d37 | 36619 | @var{pathname} was too long. |
0ce1b118 | 36620 | |
b383017d | 36621 | @item EINTR |
0ce1b118 CV |
36622 | The call was interrupted by the user. |
36623 | @end table | |
36624 | ||
fc320d37 SL |
36625 | @end table |
36626 | ||
0ce1b118 CV |
36627 | @node gettimeofday |
36628 | @unnumberedsubsubsec gettimeofday | |
36629 | @cindex gettimeofday, file-i/o system call | |
36630 | ||
fc320d37 SL |
36631 | @table @asis |
36632 | @item Synopsis: | |
0ce1b118 | 36633 | @smallexample |
0ce1b118 | 36634 | int gettimeofday(struct timeval *tv, void *tz); |
fc320d37 | 36635 | @end smallexample |
0ce1b118 | 36636 | |
fc320d37 SL |
36637 | @item Request: |
36638 | @samp{Fgettimeofday,@var{tvptr},@var{tzptr}} | |
0ce1b118 | 36639 | |
fc320d37 | 36640 | @item Return value: |
0ce1b118 CV |
36641 | On success, 0 is returned, -1 otherwise. |
36642 | ||
fc320d37 | 36643 | @item Errors: |
0ce1b118 CV |
36644 | |
36645 | @table @code | |
b383017d | 36646 | @item EINVAL |
fc320d37 | 36647 | @var{tz} is a non-NULL pointer. |
0ce1b118 | 36648 | |
b383017d | 36649 | @item EFAULT |
fc320d37 SL |
36650 | @var{tvptr} and/or @var{tzptr} is an invalid pointer value. |
36651 | @end table | |
36652 | ||
0ce1b118 CV |
36653 | @end table |
36654 | ||
36655 | @node isatty | |
36656 | @unnumberedsubsubsec isatty | |
36657 | @cindex isatty, file-i/o system call | |
36658 | ||
fc320d37 SL |
36659 | @table @asis |
36660 | @item Synopsis: | |
0ce1b118 | 36661 | @smallexample |
0ce1b118 | 36662 | int isatty(int fd); |
fc320d37 | 36663 | @end smallexample |
0ce1b118 | 36664 | |
fc320d37 SL |
36665 | @item Request: |
36666 | @samp{Fisatty,@var{fd}} | |
0ce1b118 | 36667 | |
fc320d37 SL |
36668 | @item Return value: |
36669 | Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise. | |
0ce1b118 | 36670 | |
fc320d37 | 36671 | @item Errors: |
0ce1b118 CV |
36672 | |
36673 | @table @code | |
b383017d | 36674 | @item EINTR |
0ce1b118 CV |
36675 | The call was interrupted by the user. |
36676 | @end table | |
36677 | ||
fc320d37 SL |
36678 | @end table |
36679 | ||
36680 | Note that the @code{isatty} call is treated as a special case: it returns | |
36681 | 1 to the target if the file descriptor is attached | |
36682 | to the @value{GDBN} console, 0 otherwise. Implementing through system calls | |
36683 | would require implementing @code{ioctl} and would be more complex than | |
36684 | needed. | |
36685 | ||
36686 | ||
0ce1b118 CV |
36687 | @node system |
36688 | @unnumberedsubsubsec system | |
36689 | @cindex system, file-i/o system call | |
36690 | ||
fc320d37 SL |
36691 | @table @asis |
36692 | @item Synopsis: | |
0ce1b118 | 36693 | @smallexample |
0ce1b118 | 36694 | int system(const char *command); |
fc320d37 | 36695 | @end smallexample |
0ce1b118 | 36696 | |
fc320d37 SL |
36697 | @item Request: |
36698 | @samp{Fsystem,@var{commandptr}/@var{len}} | |
0ce1b118 | 36699 | |
fc320d37 | 36700 | @item Return value: |
5600ea19 NS |
36701 | If @var{len} is zero, the return value indicates whether a shell is |
36702 | available. A zero return value indicates a shell is not available. | |
36703 | For non-zero @var{len}, the value returned is -1 on error and the | |
36704 | return status of the command otherwise. Only the exit status of the | |
36705 | command is returned, which is extracted from the host's @code{system} | |
36706 | return value by calling @code{WEXITSTATUS(retval)}. In case | |
36707 | @file{/bin/sh} could not be executed, 127 is returned. | |
0ce1b118 | 36708 | |
fc320d37 | 36709 | @item Errors: |
0ce1b118 CV |
36710 | |
36711 | @table @code | |
b383017d | 36712 | @item EINTR |
0ce1b118 CV |
36713 | The call was interrupted by the user. |
36714 | @end table | |
36715 | ||
fc320d37 SL |
36716 | @end table |
36717 | ||
36718 | @value{GDBN} takes over the full task of calling the necessary host calls | |
36719 | to perform the @code{system} call. The return value of @code{system} on | |
36720 | the host is simplified before it's returned | |
36721 | to the target. Any termination signal information from the child process | |
36722 | is discarded, and the return value consists | |
36723 | entirely of the exit status of the called command. | |
36724 | ||
36725 | Due to security concerns, the @code{system} call is by default refused | |
36726 | by @value{GDBN}. The user has to allow this call explicitly with the | |
36727 | @code{set remote system-call-allowed 1} command. | |
36728 | ||
36729 | @table @code | |
36730 | @item set remote system-call-allowed | |
36731 | @kindex set remote system-call-allowed | |
36732 | Control whether to allow the @code{system} calls in the File I/O | |
36733 | protocol for the remote target. The default is zero (disabled). | |
36734 | ||
36735 | @item show remote system-call-allowed | |
36736 | @kindex show remote system-call-allowed | |
36737 | Show whether the @code{system} calls are allowed in the File I/O | |
36738 | protocol. | |
36739 | @end table | |
36740 | ||
db2e3e2e BW |
36741 | @node Protocol-specific Representation of Datatypes |
36742 | @subsection Protocol-specific Representation of Datatypes | |
36743 | @cindex protocol-specific representation of datatypes, in file-i/o protocol | |
0ce1b118 CV |
36744 | |
36745 | @menu | |
79a6e687 BW |
36746 | * Integral Datatypes:: |
36747 | * Pointer Values:: | |
36748 | * Memory Transfer:: | |
0ce1b118 CV |
36749 | * struct stat:: |
36750 | * struct timeval:: | |
36751 | @end menu | |
36752 | ||
79a6e687 BW |
36753 | @node Integral Datatypes |
36754 | @unnumberedsubsubsec Integral Datatypes | |
0ce1b118 CV |
36755 | @cindex integral datatypes, in file-i/o protocol |
36756 | ||
fc320d37 SL |
36757 | The integral datatypes used in the system calls are @code{int}, |
36758 | @code{unsigned int}, @code{long}, @code{unsigned long}, | |
36759 | @code{mode_t}, and @code{time_t}. | |
0ce1b118 | 36760 | |
fc320d37 | 36761 | @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are |
0ce1b118 CV |
36762 | implemented as 32 bit values in this protocol. |
36763 | ||
fc320d37 | 36764 | @code{long} and @code{unsigned long} are implemented as 64 bit types. |
b383017d | 36765 | |
0ce1b118 CV |
36766 | @xref{Limits}, for corresponding MIN and MAX values (similar to those |
36767 | in @file{limits.h}) to allow range checking on host and target. | |
36768 | ||
36769 | @code{time_t} datatypes are defined as seconds since the Epoch. | |
36770 | ||
36771 | All integral datatypes transferred as part of a memory read or write of a | |
36772 | structured datatype e.g.@: a @code{struct stat} have to be given in big endian | |
36773 | byte order. | |
36774 | ||
79a6e687 BW |
36775 | @node Pointer Values |
36776 | @unnumberedsubsubsec Pointer Values | |
0ce1b118 CV |
36777 | @cindex pointer values, in file-i/o protocol |
36778 | ||
36779 | Pointers to target data are transmitted as they are. An exception | |
36780 | is made for pointers to buffers for which the length isn't | |
36781 | transmitted as part of the function call, namely strings. Strings | |
36782 | are transmitted as a pointer/length pair, both as hex values, e.g.@: | |
36783 | ||
36784 | @smallexample | |
36785 | @code{1aaf/12} | |
36786 | @end smallexample | |
36787 | ||
36788 | @noindent | |
36789 | which is a pointer to data of length 18 bytes at position 0x1aaf. | |
36790 | The length is defined as the full string length in bytes, including | |
fc320d37 SL |
36791 | the trailing null byte. For example, the string @code{"hello world"} |
36792 | at address 0x123456 is transmitted as | |
0ce1b118 CV |
36793 | |
36794 | @smallexample | |
fc320d37 | 36795 | @code{123456/d} |
0ce1b118 CV |
36796 | @end smallexample |
36797 | ||
79a6e687 BW |
36798 | @node Memory Transfer |
36799 | @unnumberedsubsubsec Memory Transfer | |
fc320d37 SL |
36800 | @cindex memory transfer, in file-i/o protocol |
36801 | ||
36802 | Structured data which is transferred using a memory read or write (for | |
db2e3e2e | 36803 | example, a @code{struct stat}) is expected to be in a protocol-specific format |
fc320d37 SL |
36804 | with all scalar multibyte datatypes being big endian. Translation to |
36805 | this representation needs to be done both by the target before the @code{F} | |
36806 | packet is sent, and by @value{GDBN} before | |
36807 | it transfers memory to the target. Transferred pointers to structured | |
36808 | data should point to the already-coerced data at any time. | |
0ce1b118 | 36809 | |
0ce1b118 CV |
36810 | |
36811 | @node struct stat | |
36812 | @unnumberedsubsubsec struct stat | |
36813 | @cindex struct stat, in file-i/o protocol | |
36814 | ||
fc320d37 SL |
36815 | The buffer of type @code{struct stat} used by the target and @value{GDBN} |
36816 | is defined as follows: | |
0ce1b118 CV |
36817 | |
36818 | @smallexample | |
36819 | struct stat @{ | |
36820 | unsigned int st_dev; /* device */ | |
36821 | unsigned int st_ino; /* inode */ | |
36822 | mode_t st_mode; /* protection */ | |
36823 | unsigned int st_nlink; /* number of hard links */ | |
36824 | unsigned int st_uid; /* user ID of owner */ | |
36825 | unsigned int st_gid; /* group ID of owner */ | |
36826 | unsigned int st_rdev; /* device type (if inode device) */ | |
36827 | unsigned long st_size; /* total size, in bytes */ | |
36828 | unsigned long st_blksize; /* blocksize for filesystem I/O */ | |
36829 | unsigned long st_blocks; /* number of blocks allocated */ | |
36830 | time_t st_atime; /* time of last access */ | |
36831 | time_t st_mtime; /* time of last modification */ | |
36832 | time_t st_ctime; /* time of last change */ | |
36833 | @}; | |
36834 | @end smallexample | |
36835 | ||
fc320d37 | 36836 | The integral datatypes conform to the definitions given in the |
79a6e687 | 36837 | appropriate section (see @ref{Integral Datatypes}, for details) so this |
0ce1b118 CV |
36838 | structure is of size 64 bytes. |
36839 | ||
36840 | The values of several fields have a restricted meaning and/or | |
36841 | range of values. | |
36842 | ||
fc320d37 | 36843 | @table @code |
0ce1b118 | 36844 | |
fc320d37 SL |
36845 | @item st_dev |
36846 | A value of 0 represents a file, 1 the console. | |
0ce1b118 | 36847 | |
fc320d37 SL |
36848 | @item st_ino |
36849 | No valid meaning for the target. Transmitted unchanged. | |
0ce1b118 | 36850 | |
fc320d37 SL |
36851 | @item st_mode |
36852 | Valid mode bits are described in @ref{Constants}. Any other | |
36853 | bits have currently no meaning for the target. | |
0ce1b118 | 36854 | |
fc320d37 SL |
36855 | @item st_uid |
36856 | @itemx st_gid | |
36857 | @itemx st_rdev | |
36858 | No valid meaning for the target. Transmitted unchanged. | |
0ce1b118 | 36859 | |
fc320d37 SL |
36860 | @item st_atime |
36861 | @itemx st_mtime | |
36862 | @itemx st_ctime | |
36863 | These values have a host and file system dependent | |
36864 | accuracy. Especially on Windows hosts, the file system may not | |
36865 | support exact timing values. | |
36866 | @end table | |
0ce1b118 | 36867 | |
fc320d37 SL |
36868 | The target gets a @code{struct stat} of the above representation and is |
36869 | responsible for coercing it to the target representation before | |
0ce1b118 CV |
36870 | continuing. |
36871 | ||
fc320d37 SL |
36872 | Note that due to size differences between the host, target, and protocol |
36873 | representations of @code{struct stat} members, these members could eventually | |
0ce1b118 CV |
36874 | get truncated on the target. |
36875 | ||
36876 | @node struct timeval | |
36877 | @unnumberedsubsubsec struct timeval | |
36878 | @cindex struct timeval, in file-i/o protocol | |
36879 | ||
fc320d37 | 36880 | The buffer of type @code{struct timeval} used by the File-I/O protocol |
0ce1b118 CV |
36881 | is defined as follows: |
36882 | ||
36883 | @smallexample | |
b383017d | 36884 | struct timeval @{ |
0ce1b118 CV |
36885 | time_t tv_sec; /* second */ |
36886 | long tv_usec; /* microsecond */ | |
36887 | @}; | |
36888 | @end smallexample | |
36889 | ||
fc320d37 | 36890 | The integral datatypes conform to the definitions given in the |
79a6e687 | 36891 | appropriate section (see @ref{Integral Datatypes}, for details) so this |
0ce1b118 CV |
36892 | structure is of size 8 bytes. |
36893 | ||
36894 | @node Constants | |
36895 | @subsection Constants | |
36896 | @cindex constants, in file-i/o protocol | |
36897 | ||
36898 | The following values are used for the constants inside of the | |
fc320d37 | 36899 | protocol. @value{GDBN} and target are responsible for translating these |
0ce1b118 CV |
36900 | values before and after the call as needed. |
36901 | ||
36902 | @menu | |
79a6e687 BW |
36903 | * Open Flags:: |
36904 | * mode_t Values:: | |
36905 | * Errno Values:: | |
36906 | * Lseek Flags:: | |
0ce1b118 CV |
36907 | * Limits:: |
36908 | @end menu | |
36909 | ||
79a6e687 BW |
36910 | @node Open Flags |
36911 | @unnumberedsubsubsec Open Flags | |
0ce1b118 CV |
36912 | @cindex open flags, in file-i/o protocol |
36913 | ||
36914 | All values are given in hexadecimal representation. | |
36915 | ||
36916 | @smallexample | |
36917 | O_RDONLY 0x0 | |
36918 | O_WRONLY 0x1 | |
36919 | O_RDWR 0x2 | |
36920 | O_APPEND 0x8 | |
36921 | O_CREAT 0x200 | |
36922 | O_TRUNC 0x400 | |
36923 | O_EXCL 0x800 | |
36924 | @end smallexample | |
36925 | ||
79a6e687 BW |
36926 | @node mode_t Values |
36927 | @unnumberedsubsubsec mode_t Values | |
0ce1b118 CV |
36928 | @cindex mode_t values, in file-i/o protocol |
36929 | ||
36930 | All values are given in octal representation. | |
36931 | ||
36932 | @smallexample | |
36933 | S_IFREG 0100000 | |
36934 | S_IFDIR 040000 | |
36935 | S_IRUSR 0400 | |
36936 | S_IWUSR 0200 | |
36937 | S_IXUSR 0100 | |
36938 | S_IRGRP 040 | |
36939 | S_IWGRP 020 | |
36940 | S_IXGRP 010 | |
36941 | S_IROTH 04 | |
36942 | S_IWOTH 02 | |
36943 | S_IXOTH 01 | |
36944 | @end smallexample | |
36945 | ||
79a6e687 BW |
36946 | @node Errno Values |
36947 | @unnumberedsubsubsec Errno Values | |
0ce1b118 CV |
36948 | @cindex errno values, in file-i/o protocol |
36949 | ||
36950 | All values are given in decimal representation. | |
36951 | ||
36952 | @smallexample | |
36953 | EPERM 1 | |
36954 | ENOENT 2 | |
36955 | EINTR 4 | |
36956 | EBADF 9 | |
36957 | EACCES 13 | |
36958 | EFAULT 14 | |
36959 | EBUSY 16 | |
36960 | EEXIST 17 | |
36961 | ENODEV 19 | |
36962 | ENOTDIR 20 | |
36963 | EISDIR 21 | |
36964 | EINVAL 22 | |
36965 | ENFILE 23 | |
36966 | EMFILE 24 | |
36967 | EFBIG 27 | |
36968 | ENOSPC 28 | |
36969 | ESPIPE 29 | |
36970 | EROFS 30 | |
36971 | ENAMETOOLONG 91 | |
36972 | EUNKNOWN 9999 | |
36973 | @end smallexample | |
36974 | ||
fc320d37 | 36975 | @code{EUNKNOWN} is used as a fallback error value if a host system returns |
0ce1b118 CV |
36976 | any error value not in the list of supported error numbers. |
36977 | ||
79a6e687 BW |
36978 | @node Lseek Flags |
36979 | @unnumberedsubsubsec Lseek Flags | |
0ce1b118 CV |
36980 | @cindex lseek flags, in file-i/o protocol |
36981 | ||
36982 | @smallexample | |
36983 | SEEK_SET 0 | |
36984 | SEEK_CUR 1 | |
36985 | SEEK_END 2 | |
36986 | @end smallexample | |
36987 | ||
36988 | @node Limits | |
36989 | @unnumberedsubsubsec Limits | |
36990 | @cindex limits, in file-i/o protocol | |
36991 | ||
36992 | All values are given in decimal representation. | |
36993 | ||
36994 | @smallexample | |
36995 | INT_MIN -2147483648 | |
36996 | INT_MAX 2147483647 | |
36997 | UINT_MAX 4294967295 | |
36998 | LONG_MIN -9223372036854775808 | |
36999 | LONG_MAX 9223372036854775807 | |
37000 | ULONG_MAX 18446744073709551615 | |
37001 | @end smallexample | |
37002 | ||
37003 | @node File-I/O Examples | |
37004 | @subsection File-I/O Examples | |
37005 | @cindex file-i/o examples | |
37006 | ||
37007 | Example sequence of a write call, file descriptor 3, buffer is at target | |
37008 | address 0x1234, 6 bytes should be written: | |
37009 | ||
37010 | @smallexample | |
37011 | <- @code{Fwrite,3,1234,6} | |
37012 | @emph{request memory read from target} | |
37013 | -> @code{m1234,6} | |
37014 | <- XXXXXX | |
37015 | @emph{return "6 bytes written"} | |
37016 | -> @code{F6} | |
37017 | @end smallexample | |
37018 | ||
37019 | Example sequence of a read call, file descriptor 3, buffer is at target | |
37020 | address 0x1234, 6 bytes should be read: | |
37021 | ||
37022 | @smallexample | |
37023 | <- @code{Fread,3,1234,6} | |
37024 | @emph{request memory write to target} | |
37025 | -> @code{X1234,6:XXXXXX} | |
37026 | @emph{return "6 bytes read"} | |
37027 | -> @code{F6} | |
37028 | @end smallexample | |
37029 | ||
37030 | Example sequence of a read call, call fails on the host due to invalid | |
fc320d37 | 37031 | file descriptor (@code{EBADF}): |
0ce1b118 CV |
37032 | |
37033 | @smallexample | |
37034 | <- @code{Fread,3,1234,6} | |
37035 | -> @code{F-1,9} | |
37036 | @end smallexample | |
37037 | ||
c8aa23ab | 37038 | Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on |
0ce1b118 CV |
37039 | host is called: |
37040 | ||
37041 | @smallexample | |
37042 | <- @code{Fread,3,1234,6} | |
37043 | -> @code{F-1,4,C} | |
37044 | <- @code{T02} | |
37045 | @end smallexample | |
37046 | ||
c8aa23ab | 37047 | Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on |
0ce1b118 CV |
37048 | host is called: |
37049 | ||
37050 | @smallexample | |
37051 | <- @code{Fread,3,1234,6} | |
37052 | -> @code{X1234,6:XXXXXX} | |
37053 | <- @code{T02} | |
37054 | @end smallexample | |
37055 | ||
cfa9d6d9 DJ |
37056 | @node Library List Format |
37057 | @section Library List Format | |
37058 | @cindex library list format, remote protocol | |
37059 | ||
37060 | On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the | |
37061 | same process as your application to manage libraries. In this case, | |
37062 | @value{GDBN} can use the loader's symbol table and normal memory | |
37063 | operations to maintain a list of shared libraries. On other | |
37064 | platforms, the operating system manages loaded libraries. | |
37065 | @value{GDBN} can not retrieve the list of currently loaded libraries | |
37066 | through memory operations, so it uses the @samp{qXfer:libraries:read} | |
37067 | packet (@pxref{qXfer library list read}) instead. The remote stub | |
37068 | queries the target's operating system and reports which libraries | |
37069 | are loaded. | |
37070 | ||
37071 | The @samp{qXfer:libraries:read} packet returns an XML document which | |
37072 | lists loaded libraries and their offsets. Each library has an | |
1fddbabb PA |
37073 | associated name and one or more segment or section base addresses, |
37074 | which report where the library was loaded in memory. | |
37075 | ||
37076 | For the common case of libraries that are fully linked binaries, the | |
37077 | library should have a list of segments. If the target supports | |
37078 | dynamic linking of a relocatable object file, its library XML element | |
37079 | should instead include a list of allocated sections. The segment or | |
37080 | section bases are start addresses, not relocation offsets; they do not | |
37081 | depend on the library's link-time base addresses. | |
cfa9d6d9 | 37082 | |
9cceb671 DJ |
37083 | @value{GDBN} must be linked with the Expat library to support XML |
37084 | library lists. @xref{Expat}. | |
37085 | ||
cfa9d6d9 DJ |
37086 | A simple memory map, with one loaded library relocated by a single |
37087 | offset, looks like this: | |
37088 | ||
37089 | @smallexample | |
37090 | <library-list> | |
37091 | <library name="/lib/libc.so.6"> | |
37092 | <segment address="0x10000000"/> | |
37093 | </library> | |
37094 | </library-list> | |
37095 | @end smallexample | |
37096 | ||
1fddbabb PA |
37097 | Another simple memory map, with one loaded library with three |
37098 | allocated sections (.text, .data, .bss), looks like this: | |
37099 | ||
37100 | @smallexample | |
37101 | <library-list> | |
37102 | <library name="sharedlib.o"> | |
37103 | <section address="0x10000000"/> | |
37104 | <section address="0x20000000"/> | |
37105 | <section address="0x30000000"/> | |
37106 | </library> | |
37107 | </library-list> | |
37108 | @end smallexample | |
37109 | ||
cfa9d6d9 DJ |
37110 | The format of a library list is described by this DTD: |
37111 | ||
37112 | @smallexample | |
37113 | <!-- library-list: Root element with versioning --> | |
37114 | <!ELEMENT library-list (library)*> | |
37115 | <!ATTLIST library-list version CDATA #FIXED "1.0"> | |
1fddbabb | 37116 | <!ELEMENT library (segment*, section*)> |
cfa9d6d9 DJ |
37117 | <!ATTLIST library name CDATA #REQUIRED> |
37118 | <!ELEMENT segment EMPTY> | |
37119 | <!ATTLIST segment address CDATA #REQUIRED> | |
1fddbabb PA |
37120 | <!ELEMENT section EMPTY> |
37121 | <!ATTLIST section address CDATA #REQUIRED> | |
cfa9d6d9 DJ |
37122 | @end smallexample |
37123 | ||
1fddbabb PA |
37124 | In addition, segments and section descriptors cannot be mixed within a |
37125 | single library element, and you must supply at least one segment or | |
37126 | section for each library. | |
37127 | ||
79a6e687 BW |
37128 | @node Memory Map Format |
37129 | @section Memory Map Format | |
68437a39 DJ |
37130 | @cindex memory map format |
37131 | ||
37132 | To be able to write into flash memory, @value{GDBN} needs to obtain a | |
37133 | memory map from the target. This section describes the format of the | |
37134 | memory map. | |
37135 | ||
37136 | The memory map is obtained using the @samp{qXfer:memory-map:read} | |
37137 | (@pxref{qXfer memory map read}) packet and is an XML document that | |
9cceb671 DJ |
37138 | lists memory regions. |
37139 | ||
37140 | @value{GDBN} must be linked with the Expat library to support XML | |
37141 | memory maps. @xref{Expat}. | |
37142 | ||
37143 | The top-level structure of the document is shown below: | |
68437a39 DJ |
37144 | |
37145 | @smallexample | |
37146 | <?xml version="1.0"?> | |
37147 | <!DOCTYPE memory-map | |
37148 | PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN" | |
37149 | "http://sourceware.org/gdb/gdb-memory-map.dtd"> | |
37150 | <memory-map> | |
37151 | region... | |
37152 | </memory-map> | |
37153 | @end smallexample | |
37154 | ||
37155 | Each region can be either: | |
37156 | ||
37157 | @itemize | |
37158 | ||
37159 | @item | |
37160 | A region of RAM starting at @var{addr} and extending for @var{length} | |
37161 | bytes from there: | |
37162 | ||
37163 | @smallexample | |
37164 | <memory type="ram" start="@var{addr}" length="@var{length}"/> | |
37165 | @end smallexample | |
37166 | ||
37167 | ||
37168 | @item | |
37169 | A region of read-only memory: | |
37170 | ||
37171 | @smallexample | |
37172 | <memory type="rom" start="@var{addr}" length="@var{length}"/> | |
37173 | @end smallexample | |
37174 | ||
37175 | ||
37176 | @item | |
37177 | A region of flash memory, with erasure blocks @var{blocksize} | |
37178 | bytes in length: | |
37179 | ||
37180 | @smallexample | |
37181 | <memory type="flash" start="@var{addr}" length="@var{length}"> | |
37182 | <property name="blocksize">@var{blocksize}</property> | |
37183 | </memory> | |
37184 | @end smallexample | |
37185 | ||
37186 | @end itemize | |
37187 | ||
37188 | Regions must not overlap. @value{GDBN} assumes that areas of memory not covered | |
37189 | by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X} | |
37190 | packets to write to addresses in such ranges. | |
37191 | ||
37192 | The formal DTD for memory map format is given below: | |
37193 | ||
37194 | @smallexample | |
37195 | <!-- ................................................... --> | |
37196 | <!-- Memory Map XML DTD ................................ --> | |
37197 | <!-- File: memory-map.dtd .............................. --> | |
37198 | <!-- .................................... .............. --> | |
37199 | <!-- memory-map.dtd --> | |
37200 | <!-- memory-map: Root element with versioning --> | |
37201 | <!ELEMENT memory-map (memory | property)> | |
37202 | <!ATTLIST memory-map version CDATA #FIXED "1.0.0"> | |
37203 | <!ELEMENT memory (property)> | |
37204 | <!-- memory: Specifies a memory region, | |
37205 | and its type, or device. --> | |
37206 | <!ATTLIST memory type CDATA #REQUIRED | |
37207 | start CDATA #REQUIRED | |
37208 | length CDATA #REQUIRED | |
37209 | device CDATA #IMPLIED> | |
37210 | <!-- property: Generic attribute tag --> | |
37211 | <!ELEMENT property (#PCDATA | property)*> | |
37212 | <!ATTLIST property name CDATA #REQUIRED> | |
37213 | @end smallexample | |
37214 | ||
dc146f7c VP |
37215 | @node Thread List Format |
37216 | @section Thread List Format | |
37217 | @cindex thread list format | |
37218 | ||
37219 | To efficiently update the list of threads and their attributes, | |
37220 | @value{GDBN} issues the @samp{qXfer:threads:read} packet | |
37221 | (@pxref{qXfer threads read}) and obtains the XML document with | |
37222 | the following structure: | |
37223 | ||
37224 | @smallexample | |
37225 | <?xml version="1.0"?> | |
37226 | <threads> | |
37227 | <thread id="id" core="0"> | |
37228 | ... description ... | |
37229 | </thread> | |
37230 | </threads> | |
37231 | @end smallexample | |
37232 | ||
37233 | Each @samp{thread} element must have the @samp{id} attribute that | |
37234 | identifies the thread (@pxref{thread-id syntax}). The | |
37235 | @samp{core} attribute, if present, specifies which processor core | |
37236 | the thread was last executing on. The content of the of @samp{thread} | |
37237 | element is interpreted as human-readable auxilliary information. | |
37238 | ||
b3b9301e PA |
37239 | @node Traceframe Info Format |
37240 | @section Traceframe Info Format | |
37241 | @cindex traceframe info format | |
37242 | ||
37243 | To be able to know which objects in the inferior can be examined when | |
37244 | inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of | |
37245 | memory ranges, registers and trace state variables that have been | |
37246 | collected in a traceframe. | |
37247 | ||
37248 | This list is obtained using the @samp{qXfer:traceframe-info:read} | |
37249 | (@pxref{qXfer traceframe info read}) packet and is an XML document. | |
37250 | ||
37251 | @value{GDBN} must be linked with the Expat library to support XML | |
37252 | traceframe info discovery. @xref{Expat}. | |
37253 | ||
37254 | The top-level structure of the document is shown below: | |
37255 | ||
37256 | @smallexample | |
37257 | <?xml version="1.0"?> | |
37258 | <!DOCTYPE traceframe-info | |
37259 | PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN" | |
37260 | "http://sourceware.org/gdb/gdb-traceframe-info.dtd"> | |
37261 | <traceframe-info> | |
37262 | block... | |
37263 | </traceframe-info> | |
37264 | @end smallexample | |
37265 | ||
37266 | Each traceframe block can be either: | |
37267 | ||
37268 | @itemize | |
37269 | ||
37270 | @item | |
37271 | A region of collected memory starting at @var{addr} and extending for | |
37272 | @var{length} bytes from there: | |
37273 | ||
37274 | @smallexample | |
37275 | <memory start="@var{addr}" length="@var{length}"/> | |
37276 | @end smallexample | |
37277 | ||
37278 | @end itemize | |
37279 | ||
37280 | The formal DTD for the traceframe info format is given below: | |
37281 | ||
37282 | @smallexample | |
37283 | <!ELEMENT traceframe-info (memory)* > | |
37284 | <!ATTLIST traceframe-info version CDATA #FIXED "1.0"> | |
37285 | ||
37286 | <!ELEMENT memory EMPTY> | |
37287 | <!ATTLIST memory start CDATA #REQUIRED | |
37288 | length CDATA #REQUIRED> | |
37289 | @end smallexample | |
37290 | ||
f418dd93 DJ |
37291 | @include agentexpr.texi |
37292 | ||
23181151 DJ |
37293 | @node Target Descriptions |
37294 | @appendix Target Descriptions | |
37295 | @cindex target descriptions | |
37296 | ||
23181151 DJ |
37297 | One of the challenges of using @value{GDBN} to debug embedded systems |
37298 | is that there are so many minor variants of each processor | |
37299 | architecture in use. It is common practice for vendors to start with | |
37300 | a standard processor core --- ARM, PowerPC, or MIPS, for example --- | |
37301 | and then make changes to adapt it to a particular market niche. Some | |
37302 | architectures have hundreds of variants, available from dozens of | |
37303 | vendors. This leads to a number of problems: | |
37304 | ||
37305 | @itemize @bullet | |
37306 | @item | |
37307 | With so many different customized processors, it is difficult for | |
37308 | the @value{GDBN} maintainers to keep up with the changes. | |
37309 | @item | |
37310 | Since individual variants may have short lifetimes or limited | |
37311 | audiences, it may not be worthwhile to carry information about every | |
37312 | variant in the @value{GDBN} source tree. | |
37313 | @item | |
37314 | When @value{GDBN} does support the architecture of the embedded system | |
37315 | at hand, the task of finding the correct architecture name to give the | |
37316 | @command{set architecture} command can be error-prone. | |
37317 | @end itemize | |
37318 | ||
37319 | To address these problems, the @value{GDBN} remote protocol allows a | |
37320 | target system to not only identify itself to @value{GDBN}, but to | |
37321 | actually describe its own features. This lets @value{GDBN} support | |
37322 | processor variants it has never seen before --- to the extent that the | |
37323 | descriptions are accurate, and that @value{GDBN} understands them. | |
37324 | ||
9cceb671 DJ |
37325 | @value{GDBN} must be linked with the Expat library to support XML |
37326 | target descriptions. @xref{Expat}. | |
123dc839 | 37327 | |
23181151 DJ |
37328 | @menu |
37329 | * Retrieving Descriptions:: How descriptions are fetched from a target. | |
37330 | * Target Description Format:: The contents of a target description. | |
123dc839 DJ |
37331 | * Predefined Target Types:: Standard types available for target |
37332 | descriptions. | |
37333 | * Standard Target Features:: Features @value{GDBN} knows about. | |
23181151 DJ |
37334 | @end menu |
37335 | ||
37336 | @node Retrieving Descriptions | |
37337 | @section Retrieving Descriptions | |
37338 | ||
37339 | Target descriptions can be read from the target automatically, or | |
37340 | specified by the user manually. The default behavior is to read the | |
37341 | description from the target. @value{GDBN} retrieves it via the remote | |
37342 | protocol using @samp{qXfer} requests (@pxref{General Query Packets, | |
37343 | qXfer}). The @var{annex} in the @samp{qXfer} packet will be | |
37344 | @samp{target.xml}. The contents of the @samp{target.xml} annex are an | |
37345 | XML document, of the form described in @ref{Target Description | |
37346 | Format}. | |
37347 | ||
37348 | Alternatively, you can specify a file to read for the target description. | |
37349 | If a file is set, the target will not be queried. The commands to | |
37350 | specify a file are: | |
37351 | ||
37352 | @table @code | |
37353 | @cindex set tdesc filename | |
37354 | @item set tdesc filename @var{path} | |
37355 | Read the target description from @var{path}. | |
37356 | ||
37357 | @cindex unset tdesc filename | |
37358 | @item unset tdesc filename | |
37359 | Do not read the XML target description from a file. @value{GDBN} | |
37360 | will use the description supplied by the current target. | |
37361 | ||
37362 | @cindex show tdesc filename | |
37363 | @item show tdesc filename | |
37364 | Show the filename to read for a target description, if any. | |
37365 | @end table | |
37366 | ||
37367 | ||
37368 | @node Target Description Format | |
37369 | @section Target Description Format | |
37370 | @cindex target descriptions, XML format | |
37371 | ||
37372 | A target description annex is an @uref{http://www.w3.org/XML/, XML} | |
37373 | document which complies with the Document Type Definition provided in | |
37374 | the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This | |
37375 | means you can use generally available tools like @command{xmllint} to | |
37376 | check that your feature descriptions are well-formed and valid. | |
37377 | However, to help people unfamiliar with XML write descriptions for | |
37378 | their targets, we also describe the grammar here. | |
37379 | ||
123dc839 DJ |
37380 | Target descriptions can identify the architecture of the remote target |
37381 | and (for some architectures) provide information about custom register | |
08d16641 PA |
37382 | sets. They can also identify the OS ABI of the remote target. |
37383 | @value{GDBN} can use this information to autoconfigure for your | |
123dc839 | 37384 | target, or to warn you if you connect to an unsupported target. |
23181151 DJ |
37385 | |
37386 | Here is a simple target description: | |
37387 | ||
123dc839 | 37388 | @smallexample |
1780a0ed | 37389 | <target version="1.0"> |
23181151 DJ |
37390 | <architecture>i386:x86-64</architecture> |
37391 | </target> | |
123dc839 | 37392 | @end smallexample |
23181151 DJ |
37393 | |
37394 | @noindent | |
37395 | This minimal description only says that the target uses | |
37396 | the x86-64 architecture. | |
37397 | ||
123dc839 DJ |
37398 | A target description has the following overall form, with [ ] marking |
37399 | optional elements and @dots{} marking repeatable elements. The elements | |
37400 | are explained further below. | |
23181151 | 37401 | |
123dc839 | 37402 | @smallexample |
23181151 DJ |
37403 | <?xml version="1.0"?> |
37404 | <!DOCTYPE target SYSTEM "gdb-target.dtd"> | |
1780a0ed | 37405 | <target version="1.0"> |
123dc839 | 37406 | @r{[}@var{architecture}@r{]} |
08d16641 | 37407 | @r{[}@var{osabi}@r{]} |
e35359c5 | 37408 | @r{[}@var{compatible}@r{]} |
123dc839 | 37409 | @r{[}@var{feature}@dots{}@r{]} |
23181151 | 37410 | </target> |
123dc839 | 37411 | @end smallexample |
23181151 DJ |
37412 | |
37413 | @noindent | |
37414 | The description is generally insensitive to whitespace and line | |
37415 | breaks, under the usual common-sense rules. The XML version | |
37416 | declaration and document type declaration can generally be omitted | |
37417 | (@value{GDBN} does not require them), but specifying them may be | |
1780a0ed DJ |
37418 | useful for XML validation tools. The @samp{version} attribute for |
37419 | @samp{<target>} may also be omitted, but we recommend | |
37420 | including it; if future versions of @value{GDBN} use an incompatible | |
37421 | revision of @file{gdb-target.dtd}, they will detect and report | |
37422 | the version mismatch. | |
23181151 | 37423 | |
108546a0 DJ |
37424 | @subsection Inclusion |
37425 | @cindex target descriptions, inclusion | |
37426 | @cindex XInclude | |
37427 | @ifnotinfo | |
37428 | @cindex <xi:include> | |
37429 | @end ifnotinfo | |
37430 | ||
37431 | It can sometimes be valuable to split a target description up into | |
37432 | several different annexes, either for organizational purposes, or to | |
37433 | share files between different possible target descriptions. You can | |
37434 | divide a description into multiple files by replacing any element of | |
37435 | the target description with an inclusion directive of the form: | |
37436 | ||
123dc839 | 37437 | @smallexample |
108546a0 | 37438 | <xi:include href="@var{document}"/> |
123dc839 | 37439 | @end smallexample |
108546a0 DJ |
37440 | |
37441 | @noindent | |
37442 | When @value{GDBN} encounters an element of this form, it will retrieve | |
37443 | the named XML @var{document}, and replace the inclusion directive with | |
37444 | the contents of that document. If the current description was read | |
37445 | using @samp{qXfer}, then so will be the included document; | |
37446 | @var{document} will be interpreted as the name of an annex. If the | |
37447 | current description was read from a file, @value{GDBN} will look for | |
37448 | @var{document} as a file in the same directory where it found the | |
37449 | original description. | |
37450 | ||
123dc839 DJ |
37451 | @subsection Architecture |
37452 | @cindex <architecture> | |
37453 | ||
37454 | An @samp{<architecture>} element has this form: | |
37455 | ||
37456 | @smallexample | |
37457 | <architecture>@var{arch}</architecture> | |
37458 | @end smallexample | |
37459 | ||
e35359c5 UW |
37460 | @var{arch} is one of the architectures from the set accepted by |
37461 | @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}). | |
123dc839 | 37462 | |
08d16641 PA |
37463 | @subsection OS ABI |
37464 | @cindex @code{<osabi>} | |
37465 | ||
37466 | This optional field was introduced in @value{GDBN} version 7.0. | |
37467 | Previous versions of @value{GDBN} ignore it. | |
37468 | ||
37469 | An @samp{<osabi>} element has this form: | |
37470 | ||
37471 | @smallexample | |
37472 | <osabi>@var{abi-name}</osabi> | |
37473 | @end smallexample | |
37474 | ||
37475 | @var{abi-name} is an OS ABI name from the same selection accepted by | |
37476 | @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}). | |
37477 | ||
e35359c5 UW |
37478 | @subsection Compatible Architecture |
37479 | @cindex @code{<compatible>} | |
37480 | ||
37481 | This optional field was introduced in @value{GDBN} version 7.0. | |
37482 | Previous versions of @value{GDBN} ignore it. | |
37483 | ||
37484 | A @samp{<compatible>} element has this form: | |
37485 | ||
37486 | @smallexample | |
37487 | <compatible>@var{arch}</compatible> | |
37488 | @end smallexample | |
37489 | ||
37490 | @var{arch} is one of the architectures from the set accepted by | |
37491 | @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}). | |
37492 | ||
37493 | A @samp{<compatible>} element is used to specify that the target | |
37494 | is able to run binaries in some other than the main target architecture | |
37495 | given by the @samp{<architecture>} element. For example, on the | |
37496 | Cell Broadband Engine, the main architecture is @code{powerpc:common} | |
37497 | or @code{powerpc:common64}, but the system is able to run binaries | |
37498 | in the @code{spu} architecture as well. The way to describe this | |
37499 | capability with @samp{<compatible>} is as follows: | |
37500 | ||
37501 | @smallexample | |
37502 | <architecture>powerpc:common</architecture> | |
37503 | <compatible>spu</compatible> | |
37504 | @end smallexample | |
37505 | ||
123dc839 DJ |
37506 | @subsection Features |
37507 | @cindex <feature> | |
37508 | ||
37509 | Each @samp{<feature>} describes some logical portion of the target | |
37510 | system. Features are currently used to describe available CPU | |
37511 | registers and the types of their contents. A @samp{<feature>} element | |
37512 | has this form: | |
37513 | ||
37514 | @smallexample | |
37515 | <feature name="@var{name}"> | |
37516 | @r{[}@var{type}@dots{}@r{]} | |
37517 | @var{reg}@dots{} | |
37518 | </feature> | |
37519 | @end smallexample | |
37520 | ||
37521 | @noindent | |
37522 | Each feature's name should be unique within the description. The name | |
37523 | of a feature does not matter unless @value{GDBN} has some special | |
37524 | knowledge of the contents of that feature; if it does, the feature | |
37525 | should have its standard name. @xref{Standard Target Features}. | |
37526 | ||
37527 | @subsection Types | |
37528 | ||
37529 | Any register's value is a collection of bits which @value{GDBN} must | |
37530 | interpret. The default interpretation is a two's complement integer, | |
37531 | but other types can be requested by name in the register description. | |
37532 | Some predefined types are provided by @value{GDBN} (@pxref{Predefined | |
37533 | Target Types}), and the description can define additional composite types. | |
37534 | ||
37535 | Each type element must have an @samp{id} attribute, which gives | |
37536 | a unique (within the containing @samp{<feature>}) name to the type. | |
37537 | Types must be defined before they are used. | |
37538 | ||
37539 | @cindex <vector> | |
37540 | Some targets offer vector registers, which can be treated as arrays | |
37541 | of scalar elements. These types are written as @samp{<vector>} elements, | |
37542 | specifying the array element type, @var{type}, and the number of elements, | |
37543 | @var{count}: | |
37544 | ||
37545 | @smallexample | |
37546 | <vector id="@var{id}" type="@var{type}" count="@var{count}"/> | |
37547 | @end smallexample | |
37548 | ||
37549 | @cindex <union> | |
37550 | If a register's value is usefully viewed in multiple ways, define it | |
37551 | with a union type containing the useful representations. The | |
37552 | @samp{<union>} element contains one or more @samp{<field>} elements, | |
37553 | each of which has a @var{name} and a @var{type}: | |
37554 | ||
37555 | @smallexample | |
37556 | <union id="@var{id}"> | |
37557 | <field name="@var{name}" type="@var{type}"/> | |
37558 | @dots{} | |
37559 | </union> | |
37560 | @end smallexample | |
37561 | ||
f5dff777 DJ |
37562 | @cindex <struct> |
37563 | If a register's value is composed from several separate values, define | |
37564 | it with a structure type. There are two forms of the @samp{<struct>} | |
37565 | element; a @samp{<struct>} element must either contain only bitfields | |
37566 | or contain no bitfields. If the structure contains only bitfields, | |
37567 | its total size in bytes must be specified, each bitfield must have an | |
37568 | explicit start and end, and bitfields are automatically assigned an | |
37569 | integer type. The field's @var{start} should be less than or | |
37570 | equal to its @var{end}, and zero represents the least significant bit. | |
37571 | ||
37572 | @smallexample | |
37573 | <struct id="@var{id}" size="@var{size}"> | |
37574 | <field name="@var{name}" start="@var{start}" end="@var{end}"/> | |
37575 | @dots{} | |
37576 | </struct> | |
37577 | @end smallexample | |
37578 | ||
37579 | If the structure contains no bitfields, then each field has an | |
37580 | explicit type, and no implicit padding is added. | |
37581 | ||
37582 | @smallexample | |
37583 | <struct id="@var{id}"> | |
37584 | <field name="@var{name}" type="@var{type}"/> | |
37585 | @dots{} | |
37586 | </struct> | |
37587 | @end smallexample | |
37588 | ||
37589 | @cindex <flags> | |
37590 | If a register's value is a series of single-bit flags, define it with | |
37591 | a flags type. The @samp{<flags>} element has an explicit @var{size} | |
37592 | and contains one or more @samp{<field>} elements. Each field has a | |
37593 | @var{name}, a @var{start}, and an @var{end}. Only single-bit flags | |
37594 | are supported. | |
37595 | ||
37596 | @smallexample | |
37597 | <flags id="@var{id}" size="@var{size}"> | |
37598 | <field name="@var{name}" start="@var{start}" end="@var{end}"/> | |
37599 | @dots{} | |
37600 | </flags> | |
37601 | @end smallexample | |
37602 | ||
123dc839 DJ |
37603 | @subsection Registers |
37604 | @cindex <reg> | |
37605 | ||
37606 | Each register is represented as an element with this form: | |
37607 | ||
37608 | @smallexample | |
37609 | <reg name="@var{name}" | |
37610 | bitsize="@var{size}" | |
37611 | @r{[}regnum="@var{num}"@r{]} | |
37612 | @r{[}save-restore="@var{save-restore}"@r{]} | |
37613 | @r{[}type="@var{type}"@r{]} | |
37614 | @r{[}group="@var{group}"@r{]}/> | |
37615 | @end smallexample | |
37616 | ||
37617 | @noindent | |
37618 | The components are as follows: | |
37619 | ||
37620 | @table @var | |
37621 | ||
37622 | @item name | |
37623 | The register's name; it must be unique within the target description. | |
37624 | ||
37625 | @item bitsize | |
37626 | The register's size, in bits. | |
37627 | ||
37628 | @item regnum | |
37629 | The register's number. If omitted, a register's number is one greater | |
37630 | than that of the previous register (either in the current feature or in | |
177b42fe | 37631 | a preceding feature); the first register in the target description |
123dc839 DJ |
37632 | defaults to zero. This register number is used to read or write |
37633 | the register; e.g.@: it is used in the remote @code{p} and @code{P} | |
37634 | packets, and registers appear in the @code{g} and @code{G} packets | |
37635 | in order of increasing register number. | |
37636 | ||
37637 | @item save-restore | |
37638 | Whether the register should be preserved across inferior function | |
37639 | calls; this must be either @code{yes} or @code{no}. The default is | |
37640 | @code{yes}, which is appropriate for most registers except for | |
37641 | some system control registers; this is not related to the target's | |
37642 | ABI. | |
37643 | ||
37644 | @item type | |
37645 | The type of the register. @var{type} may be a predefined type, a type | |
37646 | defined in the current feature, or one of the special types @code{int} | |
37647 | and @code{float}. @code{int} is an integer type of the correct size | |
37648 | for @var{bitsize}, and @code{float} is a floating point type (in the | |
37649 | architecture's normal floating point format) of the correct size for | |
37650 | @var{bitsize}. The default is @code{int}. | |
37651 | ||
37652 | @item group | |
37653 | The register group to which this register belongs. @var{group} must | |
37654 | be either @code{general}, @code{float}, or @code{vector}. If no | |
37655 | @var{group} is specified, @value{GDBN} will not display the register | |
37656 | in @code{info registers}. | |
37657 | ||
37658 | @end table | |
37659 | ||
37660 | @node Predefined Target Types | |
37661 | @section Predefined Target Types | |
37662 | @cindex target descriptions, predefined types | |
37663 | ||
37664 | Type definitions in the self-description can build up composite types | |
37665 | from basic building blocks, but can not define fundamental types. Instead, | |
37666 | standard identifiers are provided by @value{GDBN} for the fundamental | |
37667 | types. The currently supported types are: | |
37668 | ||
37669 | @table @code | |
37670 | ||
37671 | @item int8 | |
37672 | @itemx int16 | |
37673 | @itemx int32 | |
37674 | @itemx int64 | |
7cc46491 | 37675 | @itemx int128 |
123dc839 DJ |
37676 | Signed integer types holding the specified number of bits. |
37677 | ||
37678 | @item uint8 | |
37679 | @itemx uint16 | |
37680 | @itemx uint32 | |
37681 | @itemx uint64 | |
7cc46491 | 37682 | @itemx uint128 |
123dc839 DJ |
37683 | Unsigned integer types holding the specified number of bits. |
37684 | ||
37685 | @item code_ptr | |
37686 | @itemx data_ptr | |
37687 | Pointers to unspecified code and data. The program counter and | |
37688 | any dedicated return address register may be marked as code | |
37689 | pointers; printing a code pointer converts it into a symbolic | |
37690 | address. The stack pointer and any dedicated address registers | |
37691 | may be marked as data pointers. | |
37692 | ||
6e3bbd1a PB |
37693 | @item ieee_single |
37694 | Single precision IEEE floating point. | |
37695 | ||
37696 | @item ieee_double | |
37697 | Double precision IEEE floating point. | |
37698 | ||
123dc839 DJ |
37699 | @item arm_fpa_ext |
37700 | The 12-byte extended precision format used by ARM FPA registers. | |
37701 | ||
075b51b7 L |
37702 | @item i387_ext |
37703 | The 10-byte extended precision format used by x87 registers. | |
37704 | ||
37705 | @item i386_eflags | |
37706 | 32bit @sc{eflags} register used by x86. | |
37707 | ||
37708 | @item i386_mxcsr | |
37709 | 32bit @sc{mxcsr} register used by x86. | |
37710 | ||
123dc839 DJ |
37711 | @end table |
37712 | ||
37713 | @node Standard Target Features | |
37714 | @section Standard Target Features | |
37715 | @cindex target descriptions, standard features | |
37716 | ||
37717 | A target description must contain either no registers or all the | |
37718 | target's registers. If the description contains no registers, then | |
37719 | @value{GDBN} will assume a default register layout, selected based on | |
37720 | the architecture. If the description contains any registers, the | |
37721 | default layout will not be used; the standard registers must be | |
37722 | described in the target description, in such a way that @value{GDBN} | |
37723 | can recognize them. | |
37724 | ||
37725 | This is accomplished by giving specific names to feature elements | |
37726 | which contain standard registers. @value{GDBN} will look for features | |
37727 | with those names and verify that they contain the expected registers; | |
37728 | if any known feature is missing required registers, or if any required | |
37729 | feature is missing, @value{GDBN} will reject the target | |
37730 | description. You can add additional registers to any of the | |
37731 | standard features --- @value{GDBN} will display them just as if | |
37732 | they were added to an unrecognized feature. | |
37733 | ||
37734 | This section lists the known features and their expected contents. | |
37735 | Sample XML documents for these features are included in the | |
37736 | @value{GDBN} source tree, in the directory @file{gdb/features}. | |
37737 | ||
37738 | Names recognized by @value{GDBN} should include the name of the | |
37739 | company or organization which selected the name, and the overall | |
37740 | architecture to which the feature applies; so e.g.@: the feature | |
37741 | containing ARM core registers is named @samp{org.gnu.gdb.arm.core}. | |
37742 | ||
ff6f572f DJ |
37743 | The names of registers are not case sensitive for the purpose |
37744 | of recognizing standard features, but @value{GDBN} will only display | |
37745 | registers using the capitalization used in the description. | |
37746 | ||
e9c17194 VP |
37747 | @menu |
37748 | * ARM Features:: | |
3bb8d5c3 | 37749 | * i386 Features:: |
1e26b4f8 | 37750 | * MIPS Features:: |
e9c17194 | 37751 | * M68K Features:: |
1e26b4f8 | 37752 | * PowerPC Features:: |
224bbe49 | 37753 | * TIC6x Features:: |
e9c17194 VP |
37754 | @end menu |
37755 | ||
37756 | ||
37757 | @node ARM Features | |
123dc839 DJ |
37758 | @subsection ARM Features |
37759 | @cindex target descriptions, ARM features | |
37760 | ||
9779414d DJ |
37761 | The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile |
37762 | ARM targets. | |
123dc839 DJ |
37763 | It should contain registers @samp{r0} through @samp{r13}, @samp{sp}, |
37764 | @samp{lr}, @samp{pc}, and @samp{cpsr}. | |
37765 | ||
9779414d DJ |
37766 | For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core} |
37767 | feature is replaced by @samp{org.gnu.gdb.arm.m-profile}. It should contain | |
37768 | registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc}, | |
37769 | and @samp{xpsr}. | |
37770 | ||
123dc839 DJ |
37771 | The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it |
37772 | should contain registers @samp{f0} through @samp{f7} and @samp{fps}. | |
37773 | ||
ff6f572f DJ |
37774 | The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present, |
37775 | it should contain at least registers @samp{wR0} through @samp{wR15} and | |
37776 | @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon}, | |
37777 | @samp{wCSSF}, and @samp{wCASF} registers are optional. | |
23181151 | 37778 | |
58d6951d DJ |
37779 | The @samp{org.gnu.gdb.arm.vfp} feature is optional. If present, it |
37780 | should contain at least registers @samp{d0} through @samp{d15}. If | |
37781 | they are present, @samp{d16} through @samp{d31} should also be included. | |
37782 | @value{GDBN} will synthesize the single-precision registers from | |
37783 | halves of the double-precision registers. | |
37784 | ||
37785 | The @samp{org.gnu.gdb.arm.neon} feature is optional. It does not | |
37786 | need to contain registers; it instructs @value{GDBN} to display the | |
37787 | VFP double-precision registers as vectors and to synthesize the | |
37788 | quad-precision registers from pairs of double-precision registers. | |
37789 | If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also | |
37790 | be present and include 32 double-precision registers. | |
37791 | ||
3bb8d5c3 L |
37792 | @node i386 Features |
37793 | @subsection i386 Features | |
37794 | @cindex target descriptions, i386 features | |
37795 | ||
37796 | The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64 | |
37797 | targets. It should describe the following registers: | |
37798 | ||
37799 | @itemize @minus | |
37800 | @item | |
37801 | @samp{eax} through @samp{edi} plus @samp{eip} for i386 | |
37802 | @item | |
37803 | @samp{rax} through @samp{r15} plus @samp{rip} for amd64 | |
37804 | @item | |
37805 | @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es}, | |
37806 | @samp{fs}, @samp{gs} | |
37807 | @item | |
37808 | @samp{st0} through @samp{st7} | |
37809 | @item | |
37810 | @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff}, | |
37811 | @samp{foseg}, @samp{fooff} and @samp{fop} | |
37812 | @end itemize | |
37813 | ||
37814 | The register sets may be different, depending on the target. | |
37815 | ||
3a13a53b | 37816 | The @samp{org.gnu.gdb.i386.sse} feature is optional. It should |
3bb8d5c3 L |
37817 | describe registers: |
37818 | ||
37819 | @itemize @minus | |
37820 | @item | |
37821 | @samp{xmm0} through @samp{xmm7} for i386 | |
37822 | @item | |
37823 | @samp{xmm0} through @samp{xmm15} for amd64 | |
37824 | @item | |
37825 | @samp{mxcsr} | |
37826 | @end itemize | |
37827 | ||
3a13a53b L |
37828 | The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the |
37829 | @samp{org.gnu.gdb.i386.sse} feature. It should | |
f68eb612 L |
37830 | describe the upper 128 bits of @sc{ymm} registers: |
37831 | ||
37832 | @itemize @minus | |
37833 | @item | |
37834 | @samp{ymm0h} through @samp{ymm7h} for i386 | |
37835 | @item | |
37836 | @samp{ymm0h} through @samp{ymm15h} for amd64 | |
f68eb612 L |
37837 | @end itemize |
37838 | ||
3bb8d5c3 L |
37839 | The @samp{org.gnu.gdb.i386.linux} feature is optional. It should |
37840 | describe a single register, @samp{orig_eax}. | |
37841 | ||
1e26b4f8 | 37842 | @node MIPS Features |
f8b73d13 DJ |
37843 | @subsection MIPS Features |
37844 | @cindex target descriptions, MIPS features | |
37845 | ||
37846 | The @samp{org.gnu.gdb.mips.cpu} feature is required for MIPS targets. | |
37847 | It should contain registers @samp{r0} through @samp{r31}, @samp{lo}, | |
37848 | @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending | |
37849 | on the target. | |
37850 | ||
37851 | The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should | |
37852 | contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause} | |
37853 | registers. They may be 32-bit or 64-bit depending on the target. | |
37854 | ||
37855 | The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though | |
37856 | it may be optional in a future version of @value{GDBN}. It should | |
37857 | contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and | |
37858 | @samp{fir}. They may be 32-bit or 64-bit depending on the target. | |
37859 | ||
822b6570 DJ |
37860 | The @samp{org.gnu.gdb.mips.linux} feature is optional. It should |
37861 | contain a single register, @samp{restart}, which is used by the | |
37862 | Linux kernel to control restartable syscalls. | |
37863 | ||
e9c17194 VP |
37864 | @node M68K Features |
37865 | @subsection M68K Features | |
37866 | @cindex target descriptions, M68K features | |
37867 | ||
37868 | @table @code | |
37869 | @item @samp{org.gnu.gdb.m68k.core} | |
37870 | @itemx @samp{org.gnu.gdb.coldfire.core} | |
37871 | @itemx @samp{org.gnu.gdb.fido.core} | |
37872 | One of those features must be always present. | |
249e1128 | 37873 | The feature that is present determines which flavor of m68k is |
e9c17194 VP |
37874 | used. The feature that is present should contain registers |
37875 | @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp}, | |
37876 | @samp{sp}, @samp{ps} and @samp{pc}. | |
37877 | ||
37878 | @item @samp{org.gnu.gdb.coldfire.fp} | |
37879 | This feature is optional. If present, it should contain registers | |
37880 | @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and | |
37881 | @samp{fpiaddr}. | |
37882 | @end table | |
37883 | ||
1e26b4f8 | 37884 | @node PowerPC Features |
7cc46491 DJ |
37885 | @subsection PowerPC Features |
37886 | @cindex target descriptions, PowerPC features | |
37887 | ||
37888 | The @samp{org.gnu.gdb.power.core} feature is required for PowerPC | |
37889 | targets. It should contain registers @samp{r0} through @samp{r31}, | |
37890 | @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and | |
37891 | @samp{xer}. They may be 32-bit or 64-bit depending on the target. | |
37892 | ||
37893 | The @samp{org.gnu.gdb.power.fpu} feature is optional. It should | |
37894 | contain registers @samp{f0} through @samp{f31} and @samp{fpscr}. | |
37895 | ||
37896 | The @samp{org.gnu.gdb.power.altivec} feature is optional. It should | |
37897 | contain registers @samp{vr0} through @samp{vr31}, @samp{vscr}, | |
37898 | and @samp{vrsave}. | |
37899 | ||
677c5bb1 LM |
37900 | The @samp{org.gnu.gdb.power.vsx} feature is optional. It should |
37901 | contain registers @samp{vs0h} through @samp{vs31h}. @value{GDBN} | |
37902 | will combine these registers with the floating point registers | |
37903 | (@samp{f0} through @samp{f31}) and the altivec registers (@samp{vr0} | |
aeac0ff9 | 37904 | through @samp{vr31}) to present the 128-bit wide registers @samp{vs0} |
677c5bb1 LM |
37905 | through @samp{vs63}, the set of vector registers for POWER7. |
37906 | ||
7cc46491 DJ |
37907 | The @samp{org.gnu.gdb.power.spe} feature is optional. It should |
37908 | contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and | |
37909 | @samp{spefscr}. SPE targets should provide 32-bit registers in | |
37910 | @samp{org.gnu.gdb.power.core} and provide the upper halves in | |
37911 | @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine | |
37912 | these to present registers @samp{ev0} through @samp{ev31} to the | |
37913 | user. | |
37914 | ||
224bbe49 YQ |
37915 | @node TIC6x Features |
37916 | @subsection TMS320C6x Features | |
37917 | @cindex target descriptions, TIC6x features | |
37918 | @cindex target descriptions, TMS320C6x features | |
37919 | The @samp{org.gnu.gdb.tic6x.core} feature is required for TMS320C6x | |
37920 | targets. It should contain registers @samp{A0} through @samp{A15}, | |
37921 | registers @samp{B0} through @samp{B15}, @samp{CSR} and @samp{PC}. | |
37922 | ||
37923 | The @samp{org.gnu.gdb.tic6x.gp} feature is optional. It should | |
37924 | contain registers @samp{A16} through @samp{A31} and @samp{B16} | |
37925 | through @samp{B31}. | |
37926 | ||
37927 | The @samp{org.gnu.gdb.tic6x.c6xp} feature is optional. It should | |
37928 | contain registers @samp{TSR}, @samp{ILC} and @samp{RILC}. | |
37929 | ||
07e059b5 VP |
37930 | @node Operating System Information |
37931 | @appendix Operating System Information | |
37932 | @cindex operating system information | |
37933 | ||
37934 | @menu | |
37935 | * Process list:: | |
37936 | @end menu | |
37937 | ||
37938 | Users of @value{GDBN} often wish to obtain information about the state of | |
37939 | the operating system running on the target---for example the list of | |
37940 | processes, or the list of open files. This section describes the | |
37941 | mechanism that makes it possible. This mechanism is similar to the | |
37942 | target features mechanism (@pxref{Target Descriptions}), but focuses | |
37943 | on a different aspect of target. | |
37944 | ||
37945 | Operating system information is retrived from the target via the | |
37946 | remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata | |
37947 | read}). The object name in the request should be @samp{osdata}, and | |
37948 | the @var{annex} identifies the data to be fetched. | |
37949 | ||
37950 | @node Process list | |
37951 | @appendixsection Process list | |
37952 | @cindex operating system information, process list | |
37953 | ||
37954 | When requesting the process list, the @var{annex} field in the | |
37955 | @samp{qXfer} request should be @samp{processes}. The returned data is | |
37956 | an XML document. The formal syntax of this document is defined in | |
37957 | @file{gdb/features/osdata.dtd}. | |
37958 | ||
37959 | An example document is: | |
37960 | ||
37961 | @smallexample | |
37962 | <?xml version="1.0"?> | |
37963 | <!DOCTYPE target SYSTEM "osdata.dtd"> | |
37964 | <osdata type="processes"> | |
37965 | <item> | |
37966 | <column name="pid">1</column> | |
37967 | <column name="user">root</column> | |
37968 | <column name="command">/sbin/init</column> | |
dc146f7c | 37969 | <column name="cores">1,2,3</column> |
07e059b5 VP |
37970 | </item> |
37971 | </osdata> | |
37972 | @end smallexample | |
37973 | ||
37974 | Each item should include a column whose name is @samp{pid}. The value | |
37975 | of that column should identify the process on the target. The | |
37976 | @samp{user} and @samp{command} columns are optional, and will be | |
dc146f7c VP |
37977 | displayed by @value{GDBN}. The @samp{cores} column, if present, |
37978 | should contain a comma-separated list of cores that this process | |
37979 | is running on. Target may provide additional columns, | |
07e059b5 VP |
37980 | which @value{GDBN} currently ignores. |
37981 | ||
05c8c3f5 TT |
37982 | @node Trace File Format |
37983 | @appendix Trace File Format | |
37984 | @cindex trace file format | |
37985 | ||
37986 | The trace file comes in three parts: a header, a textual description | |
37987 | section, and a trace frame section with binary data. | |
37988 | ||
37989 | The header has the form @code{\x7fTRACE0\n}. The first byte is | |
37990 | @code{0x7f} so as to indicate that the file contains binary data, | |
37991 | while the @code{0} is a version number that may have different values | |
37992 | in the future. | |
37993 | ||
37994 | The description section consists of multiple lines of @sc{ascii} text | |
37995 | separated by newline characters (@code{0xa}). The lines may include a | |
37996 | variety of optional descriptive or context-setting information, such | |
37997 | as tracepoint definitions or register set size. @value{GDBN} will | |
37998 | ignore any line that it does not recognize. An empty line marks the end | |
37999 | of this section. | |
38000 | ||
38001 | @c FIXME add some specific types of data | |
38002 | ||
38003 | The trace frame section consists of a number of consecutive frames. | |
38004 | Each frame begins with a two-byte tracepoint number, followed by a | |
38005 | four-byte size giving the amount of data in the frame. The data in | |
38006 | the frame consists of a number of blocks, each introduced by a | |
38007 | character indicating its type (at least register, memory, and trace | |
38008 | state variable). The data in this section is raw binary, not a | |
38009 | hexadecimal or other encoding; its endianness matches the target's | |
38010 | endianness. | |
38011 | ||
38012 | @c FIXME bi-arch may require endianness/arch info in description section | |
38013 | ||
38014 | @table @code | |
38015 | @item R @var{bytes} | |
38016 | Register block. The number and ordering of bytes matches that of a | |
38017 | @code{g} packet in the remote protocol. Note that these are the | |
38018 | actual bytes, in target order and @value{GDBN} register order, not a | |
38019 | hexadecimal encoding. | |
38020 | ||
38021 | @item M @var{address} @var{length} @var{bytes}... | |
38022 | Memory block. This is a contiguous block of memory, at the 8-byte | |
38023 | address @var{address}, with a 2-byte length @var{length}, followed by | |
38024 | @var{length} bytes. | |
38025 | ||
38026 | @item V @var{number} @var{value} | |
38027 | Trace state variable block. This records the 8-byte signed value | |
38028 | @var{value} of trace state variable numbered @var{number}. | |
38029 | ||
38030 | @end table | |
38031 | ||
38032 | Future enhancements of the trace file format may include additional types | |
38033 | of blocks. | |
38034 | ||
90476074 TT |
38035 | @node Index Section Format |
38036 | @appendix @code{.gdb_index} section format | |
38037 | @cindex .gdb_index section format | |
38038 | @cindex index section format | |
38039 | ||
38040 | This section documents the index section that is created by @code{save | |
38041 | gdb-index} (@pxref{Index Files}). The index section is | |
38042 | DWARF-specific; some knowledge of DWARF is assumed in this | |
38043 | description. | |
38044 | ||
38045 | The mapped index file format is designed to be directly | |
38046 | @code{mmap}able on any architecture. In most cases, a datum is | |
38047 | represented using a little-endian 32-bit integer value, called an | |
38048 | @code{offset_type}. Big endian machines must byte-swap the values | |
38049 | before using them. Exceptions to this rule are noted. The data is | |
38050 | laid out such that alignment is always respected. | |
38051 | ||
38052 | A mapped index consists of several areas, laid out in order. | |
38053 | ||
38054 | @enumerate | |
38055 | @item | |
38056 | The file header. This is a sequence of values, of @code{offset_type} | |
38057 | unless otherwise noted: | |
38058 | ||
38059 | @enumerate | |
38060 | @item | |
559a7a62 JK |
38061 | The version number, currently 5. Versions 1, 2 and 3 are obsolete. |
38062 | Version 4 differs by its hashing function. | |
90476074 TT |
38063 | |
38064 | @item | |
38065 | The offset, from the start of the file, of the CU list. | |
38066 | ||
38067 | @item | |
38068 | The offset, from the start of the file, of the types CU list. Note | |
38069 | that this area can be empty, in which case this offset will be equal | |
38070 | to the next offset. | |
38071 | ||
38072 | @item | |
38073 | The offset, from the start of the file, of the address area. | |
38074 | ||
38075 | @item | |
38076 | The offset, from the start of the file, of the symbol table. | |
38077 | ||
38078 | @item | |
38079 | The offset, from the start of the file, of the constant pool. | |
38080 | @end enumerate | |
38081 | ||
38082 | @item | |
38083 | The CU list. This is a sequence of pairs of 64-bit little-endian | |
38084 | values, sorted by the CU offset. The first element in each pair is | |
38085 | the offset of a CU in the @code{.debug_info} section. The second | |
38086 | element in each pair is the length of that CU. References to a CU | |
38087 | elsewhere in the map are done using a CU index, which is just the | |
38088 | 0-based index into this table. Note that if there are type CUs, then | |
38089 | conceptually CUs and type CUs form a single list for the purposes of | |
38090 | CU indices. | |
38091 | ||
38092 | @item | |
38093 | The types CU list. This is a sequence of triplets of 64-bit | |
38094 | little-endian values. In a triplet, the first value is the CU offset, | |
38095 | the second value is the type offset in the CU, and the third value is | |
38096 | the type signature. The types CU list is not sorted. | |
38097 | ||
38098 | @item | |
38099 | The address area. The address area consists of a sequence of address | |
38100 | entries. Each address entry has three elements: | |
38101 | ||
38102 | @enumerate | |
38103 | @item | |
38104 | The low address. This is a 64-bit little-endian value. | |
38105 | ||
38106 | @item | |
38107 | The high address. This is a 64-bit little-endian value. Like | |
38108 | @code{DW_AT_high_pc}, the value is one byte beyond the end. | |
38109 | ||
38110 | @item | |
38111 | The CU index. This is an @code{offset_type} value. | |
38112 | @end enumerate | |
38113 | ||
38114 | @item | |
38115 | The symbol table. This is an open-addressed hash table. The size of | |
38116 | the hash table is always a power of 2. | |
38117 | ||
38118 | Each slot in the hash table consists of a pair of @code{offset_type} | |
38119 | values. The first value is the offset of the symbol's name in the | |
38120 | constant pool. The second value is the offset of the CU vector in the | |
38121 | constant pool. | |
38122 | ||
38123 | If both values are 0, then this slot in the hash table is empty. This | |
38124 | is ok because while 0 is a valid constant pool index, it cannot be a | |
38125 | valid index for both a string and a CU vector. | |
38126 | ||
38127 | The hash value for a table entry is computed by applying an | |
38128 | iterative hash function to the symbol's name. Starting with an | |
38129 | initial value of @code{r = 0}, each (unsigned) character @samp{c} in | |
559a7a62 JK |
38130 | the string is incorporated into the hash using the formula depending on the |
38131 | index version: | |
38132 | ||
38133 | @table @asis | |
38134 | @item Version 4 | |
38135 | The formula is @code{r = r * 67 + c - 113}. | |
38136 | ||
38137 | @item Version 5 | |
38138 | The formula is @code{r = r * 67 + tolower (c) - 113}. | |
38139 | @end table | |
38140 | ||
38141 | The terminating @samp{\0} is not incorporated into the hash. | |
90476074 TT |
38142 | |
38143 | The step size used in the hash table is computed via | |
38144 | @code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash | |
38145 | value, and @samp{size} is the size of the hash table. The step size | |
38146 | is used to find the next candidate slot when handling a hash | |
38147 | collision. | |
38148 | ||
38149 | The names of C@t{++} symbols in the hash table are canonicalized. We | |
38150 | don't currently have a simple description of the canonicalization | |
38151 | algorithm; if you intend to create new index sections, you must read | |
38152 | the code. | |
38153 | ||
38154 | @item | |
38155 | The constant pool. This is simply a bunch of bytes. It is organized | |
38156 | so that alignment is correct: CU vectors are stored first, followed by | |
38157 | strings. | |
38158 | ||
38159 | A CU vector in the constant pool is a sequence of @code{offset_type} | |
38160 | values. The first value is the number of CU indices in the vector. | |
38161 | Each subsequent value is the index of a CU in the CU list. This | |
38162 | element in the hash table is used to indicate which CUs define the | |
38163 | symbol. | |
38164 | ||
38165 | A string in the constant pool is zero-terminated. | |
38166 | @end enumerate | |
38167 | ||
aab4e0ec | 38168 | @include gpl.texi |
eb12ee30 | 38169 | |
e4c0cfae SS |
38170 | @node GNU Free Documentation License |
38171 | @appendix GNU Free Documentation License | |
6826cf00 EZ |
38172 | @include fdl.texi |
38173 | ||
6d2ebf8b | 38174 | @node Index |
c906108c SS |
38175 | @unnumbered Index |
38176 | ||
38177 | @printindex cp | |
38178 | ||
38179 | @tex | |
38180 | % I think something like @colophon should be in texinfo. In the | |
38181 | % meantime: | |
38182 | \long\def\colophon{\hbox to0pt{}\vfill | |
38183 | \centerline{The body of this manual is set in} | |
38184 | \centerline{\fontname\tenrm,} | |
38185 | \centerline{with headings in {\bf\fontname\tenbf}} | |
38186 | \centerline{and examples in {\tt\fontname\tentt}.} | |
38187 | \centerline{{\it\fontname\tenit\/},} | |
38188 | \centerline{{\bf\fontname\tenbf}, and} | |
38189 | \centerline{{\sl\fontname\tensl\/}} | |
38190 | \centerline{are used for emphasis.}\vfill} | |
38191 | \page\colophon | |
38192 | % Blame: doc@cygnus.com, 1991. | |
38193 | @end tex | |
38194 | ||
c906108c | 38195 | @bye |