| 1 | \input texinfo @c -*-texinfo-*- |
| 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. |
| 5 | @c |
| 6 | @c %**start of header |
| 7 | @c makeinfo ignores cmds prev to setfilename, so its arg cannot make use |
| 8 | @c of @set vars. However, you can override filename with makeinfo -o. |
| 9 | @setfilename gdb.info |
| 10 | @c |
| 11 | @include gdb-cfg.texi |
| 12 | @c |
| 13 | @settitle Debugging with @value{GDBN} |
| 14 | @setchapternewpage odd |
| 15 | @c %**end of header |
| 16 | |
| 17 | @iftex |
| 18 | @c @smallbook |
| 19 | @c @cropmarks |
| 20 | @end iftex |
| 21 | |
| 22 | @finalout |
| 23 | @syncodeindex ky cp |
| 24 | @syncodeindex tp cp |
| 25 | |
| 26 | @c readline appendices use @vindex, @findex and @ftable, |
| 27 | @c annotate.texi and gdbmi use @findex. |
| 28 | @syncodeindex vr cp |
| 29 | @syncodeindex fn cp |
| 30 | |
| 31 | @c !!set GDB manual's edition---not the same as GDB version! |
| 32 | @c This is updated by GNU Press. |
| 33 | @set EDITION Ninth |
| 34 | |
| 35 | @c !!set GDB edit command default editor |
| 36 | @set EDITOR /bin/ex |
| 37 | |
| 38 | @c THIS MANUAL REQUIRES TEXINFO 4.0 OR LATER. |
| 39 | |
| 40 | @c This is a dir.info fragment to support semi-automated addition of |
| 41 | @c manuals to an info tree. |
| 42 | @dircategory Software development |
| 43 | @direntry |
| 44 | * Gdb: (gdb). The GNU debugger. |
| 45 | @end direntry |
| 46 | |
| 47 | @copying |
| 48 | Copyright @copyright{} 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, |
| 49 | 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
| 50 | Free Software Foundation, Inc. |
| 51 | |
| 52 | Permission is granted to copy, distribute and/or modify this document |
| 53 | under the terms of the GNU Free Documentation License, Version 1.3 or |
| 54 | any later version published by the Free Software Foundation; with the |
| 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. |
| 58 | |
| 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.'' |
| 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 |
| 76 | |
| 77 | @titlepage |
| 78 | @title Debugging with @value{GDBN} |
| 79 | @subtitle The @sc{gnu} Source-Level Debugger |
| 80 | @sp 1 |
| 81 | @subtitle @value{EDITION} Edition, for @value{GDBN} version @value{GDBVN} |
| 82 | @ifset VERSION_PACKAGE |
| 83 | @sp 1 |
| 84 | @subtitle @value{VERSION_PACKAGE} |
| 85 | @end ifset |
| 86 | @author Richard Stallman, Roland Pesch, Stan Shebs, et al. |
| 87 | @page |
| 88 | @tex |
| 89 | {\parskip=0pt |
| 90 | \hfill (Send bugs and comments on @value{GDBN} to @value{BUGURL}.)\par |
| 91 | \hfill {\it Debugging with @value{GDBN}}\par |
| 92 | \hfill \TeX{}info \texinfoversion\par |
| 93 | } |
| 94 | @end tex |
| 95 | |
| 96 | @vskip 0pt plus 1filll |
| 97 | Published by the Free Software Foundation @* |
| 98 | 51 Franklin Street, Fifth Floor, |
| 99 | Boston, MA 02110-1301, USA@* |
| 100 | ISBN 1-882114-77-9 @* |
| 101 | |
| 102 | @insertcopying |
| 103 | @page |
| 104 | This edition of the GDB manual is dedicated to the memory of Fred |
| 105 | Fish. Fred was a long-standing contributor to GDB and to Free |
| 106 | software in general. We will miss him. |
| 107 | @end titlepage |
| 108 | @page |
| 109 | |
| 110 | @ifnottex |
| 111 | @node Top, Summary, (dir), (dir) |
| 112 | |
| 113 | @top Debugging with @value{GDBN} |
| 114 | |
| 115 | This file describes @value{GDBN}, the @sc{gnu} symbolic debugger. |
| 116 | |
| 117 | This is the @value{EDITION} Edition, for @value{GDBN} |
| 118 | @ifset VERSION_PACKAGE |
| 119 | @value{VERSION_PACKAGE} |
| 120 | @end ifset |
| 121 | Version @value{GDBVN}. |
| 122 | |
| 123 | Copyright (C) 1988-2010 Free Software Foundation, Inc. |
| 124 | |
| 125 | This edition of the GDB manual is dedicated to the memory of Fred |
| 126 | Fish. Fred was a long-standing contributor to GDB and to Free |
| 127 | software in general. We will miss him. |
| 128 | |
| 129 | @menu |
| 130 | * Summary:: Summary of @value{GDBN} |
| 131 | * Sample Session:: A sample @value{GDBN} session |
| 132 | |
| 133 | * Invocation:: Getting in and out of @value{GDBN} |
| 134 | * Commands:: @value{GDBN} commands |
| 135 | * Running:: Running programs under @value{GDBN} |
| 136 | * Stopping:: Stopping and continuing |
| 137 | * Reverse Execution:: Running programs backward |
| 138 | * Process Record and Replay:: Recording inferior's execution and replaying it |
| 139 | * Stack:: Examining the stack |
| 140 | * Source:: Examining source files |
| 141 | * Data:: Examining data |
| 142 | * Optimized Code:: Debugging optimized code |
| 143 | * Macros:: Preprocessor Macros |
| 144 | * Tracepoints:: Debugging remote targets non-intrusively |
| 145 | * Overlays:: Debugging programs that use overlays |
| 146 | |
| 147 | * Languages:: Using @value{GDBN} with different languages |
| 148 | |
| 149 | * Symbols:: Examining the symbol table |
| 150 | * Altering:: Altering execution |
| 151 | * GDB Files:: @value{GDBN} files |
| 152 | * Targets:: Specifying a debugging target |
| 153 | * Remote Debugging:: Debugging remote programs |
| 154 | * Configurations:: Configuration-specific information |
| 155 | * Controlling GDB:: Controlling @value{GDBN} |
| 156 | * Extending GDB:: Extending @value{GDBN} |
| 157 | * Interpreters:: Command Interpreters |
| 158 | * TUI:: @value{GDBN} Text User Interface |
| 159 | * Emacs:: Using @value{GDBN} under @sc{gnu} Emacs |
| 160 | * GDB/MI:: @value{GDBN}'s Machine Interface. |
| 161 | * Annotations:: @value{GDBN}'s annotation interface. |
| 162 | * JIT Interface:: Using the JIT debugging interface. |
| 163 | |
| 164 | * GDB Bugs:: Reporting bugs in @value{GDBN} |
| 165 | |
| 166 | @ifset SYSTEM_READLINE |
| 167 | * Command Line Editing: (rluserman). Command Line Editing |
| 168 | * Using History Interactively: (history). Using History Interactively |
| 169 | @end ifset |
| 170 | @ifclear SYSTEM_READLINE |
| 171 | * Command Line Editing:: Command Line Editing |
| 172 | * Using History Interactively:: Using History Interactively |
| 173 | @end ifclear |
| 174 | * Formatting Documentation:: How to format and print @value{GDBN} documentation |
| 175 | * Installing GDB:: Installing GDB |
| 176 | * Maintenance Commands:: Maintenance Commands |
| 177 | * Remote Protocol:: GDB Remote Serial Protocol |
| 178 | * Agent Expressions:: The GDB Agent Expression Mechanism |
| 179 | * Target Descriptions:: How targets can describe themselves to |
| 180 | @value{GDBN} |
| 181 | * Operating System Information:: Getting additional information from |
| 182 | the operating system |
| 183 | * Trace File Format:: GDB trace file format |
| 184 | * Copying:: GNU General Public License says |
| 185 | how you can copy and share GDB |
| 186 | * GNU Free Documentation License:: The license for this documentation |
| 187 | * Index:: Index |
| 188 | @end menu |
| 189 | |
| 190 | @end ifnottex |
| 191 | |
| 192 | @contents |
| 193 | |
| 194 | @node Summary |
| 195 | @unnumbered Summary of @value{GDBN} |
| 196 | |
| 197 | The purpose of a debugger such as @value{GDBN} is to allow you to see what is |
| 198 | going on ``inside'' another program while it executes---or what another |
| 199 | program was doing at the moment it crashed. |
| 200 | |
| 201 | @value{GDBN} can do four main kinds of things (plus other things in support of |
| 202 | these) to help you catch bugs in the act: |
| 203 | |
| 204 | @itemize @bullet |
| 205 | @item |
| 206 | Start your program, specifying anything that might affect its behavior. |
| 207 | |
| 208 | @item |
| 209 | Make your program stop on specified conditions. |
| 210 | |
| 211 | @item |
| 212 | Examine what has happened, when your program has stopped. |
| 213 | |
| 214 | @item |
| 215 | Change things in your program, so you can experiment with correcting the |
| 216 | effects of one bug and go on to learn about another. |
| 217 | @end itemize |
| 218 | |
| 219 | You can use @value{GDBN} to debug programs written in C and C@t{++}. |
| 220 | For more information, see @ref{Supported Languages,,Supported Languages}. |
| 221 | For more information, see @ref{C,,C and C++}. |
| 222 | |
| 223 | Support for D is partial. For information on D, see |
| 224 | @ref{D,,D}. |
| 225 | |
| 226 | @cindex Modula-2 |
| 227 | Support for Modula-2 is partial. For information on Modula-2, see |
| 228 | @ref{Modula-2,,Modula-2}. |
| 229 | |
| 230 | Support for OpenCL C is partial. For information on OpenCL C, see |
| 231 | @ref{OpenCL C,,OpenCL C}. |
| 232 | |
| 233 | @cindex Pascal |
| 234 | Debugging Pascal programs which use sets, subranges, file variables, or |
| 235 | nested functions does not currently work. @value{GDBN} does not support |
| 236 | entering expressions, printing values, or similar features using Pascal |
| 237 | syntax. |
| 238 | |
| 239 | @cindex Fortran |
| 240 | @value{GDBN} can be used to debug programs written in Fortran, although |
| 241 | it may be necessary to refer to some variables with a trailing |
| 242 | underscore. |
| 243 | |
| 244 | @value{GDBN} can be used to debug programs written in Objective-C, |
| 245 | using either the Apple/NeXT or the GNU Objective-C runtime. |
| 246 | |
| 247 | @menu |
| 248 | * Free Software:: Freely redistributable software |
| 249 | * Contributors:: Contributors to GDB |
| 250 | @end menu |
| 251 | |
| 252 | @node Free Software |
| 253 | @unnumberedsec Free Software |
| 254 | |
| 255 | @value{GDBN} is @dfn{free software}, protected by the @sc{gnu} |
| 256 | General Public License |
| 257 | (GPL). The GPL gives you the freedom to copy or adapt a licensed |
| 258 | program---but every person getting a copy also gets with it the |
| 259 | freedom to modify that copy (which means that they must get access to |
| 260 | the source code), and the freedom to distribute further copies. |
| 261 | Typical software companies use copyrights to limit your freedoms; the |
| 262 | Free Software Foundation uses the GPL to preserve these freedoms. |
| 263 | |
| 264 | Fundamentally, the General Public License is a license which says that |
| 265 | you have these freedoms and that you cannot take these freedoms away |
| 266 | from anyone else. |
| 267 | |
| 268 | @unnumberedsec Free Software Needs Free Documentation |
| 269 | |
| 270 | The biggest deficiency in the free software community today is not in |
| 271 | the software---it is the lack of good free documentation that we can |
| 272 | include with the free software. Many of our most important |
| 273 | programs do not come with free reference manuals and free introductory |
| 274 | texts. Documentation is an essential part of any software package; |
| 275 | when an important free software package does not come with a free |
| 276 | manual and a free tutorial, that is a major gap. We have many such |
| 277 | gaps today. |
| 278 | |
| 279 | Consider Perl, for instance. The tutorial manuals that people |
| 280 | normally use are non-free. How did this come about? Because the |
| 281 | authors of those manuals published them with restrictive terms---no |
| 282 | copying, no modification, source files not available---which exclude |
| 283 | them from the free software world. |
| 284 | |
| 285 | That wasn't the first time this sort of thing happened, and it was far |
| 286 | from the last. Many times we have heard a GNU user eagerly describe a |
| 287 | manual that he is writing, his intended contribution to the community, |
| 288 | only to learn that he had ruined everything by signing a publication |
| 289 | contract to make it non-free. |
| 290 | |
| 291 | Free documentation, like free software, is a matter of freedom, not |
| 292 | price. The problem with the non-free manual is not that publishers |
| 293 | charge a price for printed copies---that in itself is fine. (The Free |
| 294 | Software Foundation sells printed copies of manuals, too.) The |
| 295 | problem is the restrictions on the use of the manual. Free manuals |
| 296 | are available in source code form, and give you permission to copy and |
| 297 | modify. Non-free manuals do not allow this. |
| 298 | |
| 299 | The criteria of freedom for a free manual are roughly the same as for |
| 300 | free software. Redistribution (including the normal kinds of |
| 301 | commercial redistribution) must be permitted, so that the manual can |
| 302 | accompany every copy of the program, both on-line and on paper. |
| 303 | |
| 304 | Permission for modification of the technical content is crucial too. |
| 305 | When people modify the software, adding or changing features, if they |
| 306 | are conscientious they will change the manual too---so they can |
| 307 | provide accurate and clear documentation for the modified program. A |
| 308 | manual that leaves you no choice but to write a new manual to document |
| 309 | a changed version of the program is not really available to our |
| 310 | community. |
| 311 | |
| 312 | Some kinds of limits on the way modification is handled are |
| 313 | acceptable. For example, requirements to preserve the original |
| 314 | author's copyright notice, the distribution terms, or the list of |
| 315 | authors, are ok. It is also no problem to require modified versions |
| 316 | to include notice that they were modified. Even entire sections that |
| 317 | may not be deleted or changed are acceptable, as long as they deal |
| 318 | with nontechnical topics (like this one). These kinds of restrictions |
| 319 | are acceptable because they don't obstruct the community's normal use |
| 320 | of the manual. |
| 321 | |
| 322 | However, it must be possible to modify all the @emph{technical} |
| 323 | content of the manual, and then distribute the result in all the usual |
| 324 | media, through all the usual channels. Otherwise, the restrictions |
| 325 | obstruct the use of the manual, it is not free, and we need another |
| 326 | manual to replace it. |
| 327 | |
| 328 | Please spread the word about this issue. Our community continues to |
| 329 | lose manuals to proprietary publishing. If we spread the word that |
| 330 | free software needs free reference manuals and free tutorials, perhaps |
| 331 | the next person who wants to contribute by writing documentation will |
| 332 | realize, before it is too late, that only free manuals contribute to |
| 333 | the free software community. |
| 334 | |
| 335 | If you are writing documentation, please insist on publishing it under |
| 336 | the GNU Free Documentation License or another free documentation |
| 337 | license. Remember that this decision requires your approval---you |
| 338 | don't have to let the publisher decide. Some commercial publishers |
| 339 | will use a free license if you insist, but they will not propose the |
| 340 | option; it is up to you to raise the issue and say firmly that this is |
| 341 | what you want. If the publisher you are dealing with refuses, please |
| 342 | try other publishers. If you're not sure whether a proposed license |
| 343 | is free, write to @email{licensing@@gnu.org}. |
| 344 | |
| 345 | You can encourage commercial publishers to sell more free, copylefted |
| 346 | manuals and tutorials by buying them, and particularly by buying |
| 347 | copies from the publishers that paid for their writing or for major |
| 348 | improvements. Meanwhile, try to avoid buying non-free documentation |
| 349 | at all. Check the distribution terms of a manual before you buy it, |
| 350 | and insist that whoever seeks your business must respect your freedom. |
| 351 | Check the history of the book, and try to reward the publishers that |
| 352 | have paid or pay the authors to work on it. |
| 353 | |
| 354 | The Free Software Foundation maintains a list of free documentation |
| 355 | published by other publishers, at |
| 356 | @url{http://www.fsf.org/doc/other-free-books.html}. |
| 357 | |
| 358 | @node Contributors |
| 359 | @unnumberedsec Contributors to @value{GDBN} |
| 360 | |
| 361 | Richard Stallman was the original author of @value{GDBN}, and of many |
| 362 | other @sc{gnu} programs. Many others have contributed to its |
| 363 | development. This section attempts to credit major contributors. One |
| 364 | of the virtues of free software is that everyone is free to contribute |
| 365 | to it; with regret, we cannot actually acknowledge everyone here. The |
| 366 | file @file{ChangeLog} in the @value{GDBN} distribution approximates a |
| 367 | blow-by-blow account. |
| 368 | |
| 369 | Changes much prior to version 2.0 are lost in the mists of time. |
| 370 | |
| 371 | @quotation |
| 372 | @emph{Plea:} Additions to this section are particularly welcome. If you |
| 373 | or your friends (or enemies, to be evenhanded) have been unfairly |
| 374 | omitted from this list, we would like to add your names! |
| 375 | @end quotation |
| 376 | |
| 377 | So that they may not regard their many labors as thankless, we |
| 378 | particularly thank those who shepherded @value{GDBN} through major |
| 379 | releases: |
| 380 | Andrew Cagney (releases 6.3, 6.2, 6.1, 6.0, 5.3, 5.2, 5.1 and 5.0); |
| 381 | Jim Blandy (release 4.18); |
| 382 | Jason Molenda (release 4.17); |
| 383 | Stan Shebs (release 4.14); |
| 384 | Fred Fish (releases 4.16, 4.15, 4.13, 4.12, 4.11, 4.10, and 4.9); |
| 385 | Stu Grossman and John Gilmore (releases 4.8, 4.7, 4.6, 4.5, and 4.4); |
| 386 | John Gilmore (releases 4.3, 4.2, 4.1, 4.0, and 3.9); |
| 387 | Jim Kingdon (releases 3.5, 3.4, and 3.3); |
| 388 | and Randy Smith (releases 3.2, 3.1, and 3.0). |
| 389 | |
| 390 | Richard Stallman, assisted at various times by Peter TerMaat, Chris |
| 391 | Hanson, and Richard Mlynarik, handled releases through 2.8. |
| 392 | |
| 393 | Michael Tiemann is the author of most of the @sc{gnu} C@t{++} support |
| 394 | in @value{GDBN}, with significant additional contributions from Per |
| 395 | Bothner and Daniel Berlin. James Clark wrote the @sc{gnu} C@t{++} |
| 396 | demangler. Early work on C@t{++} was by Peter TerMaat (who also did |
| 397 | much general update work leading to release 3.0). |
| 398 | |
| 399 | @value{GDBN} uses the BFD subroutine library to examine multiple |
| 400 | object-file formats; BFD was a joint project of David V. |
| 401 | Henkel-Wallace, Rich Pixley, Steve Chamberlain, and John Gilmore. |
| 402 | |
| 403 | David Johnson wrote the original COFF support; Pace Willison did |
| 404 | the original support for encapsulated COFF. |
| 405 | |
| 406 | Brent Benson of Harris Computer Systems contributed DWARF 2 support. |
| 407 | |
| 408 | Adam de Boor and Bradley Davis contributed the ISI Optimum V support. |
| 409 | Per Bothner, Noboyuki Hikichi, and Alessandro Forin contributed MIPS |
| 410 | support. |
| 411 | Jean-Daniel Fekete contributed Sun 386i support. |
| 412 | Chris Hanson improved the HP9000 support. |
| 413 | Noboyuki Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support. |
| 414 | David Johnson contributed Encore Umax support. |
| 415 | Jyrki Kuoppala contributed Altos 3068 support. |
| 416 | Jeff Law contributed HP PA and SOM support. |
| 417 | Keith Packard contributed NS32K support. |
| 418 | Doug Rabson contributed Acorn Risc Machine support. |
| 419 | Bob Rusk contributed Harris Nighthawk CX-UX support. |
| 420 | Chris Smith contributed Convex support (and Fortran debugging). |
| 421 | Jonathan Stone contributed Pyramid support. |
| 422 | Michael Tiemann contributed SPARC support. |
| 423 | Tim Tucker contributed support for the Gould NP1 and Gould Powernode. |
| 424 | Pace Willison contributed Intel 386 support. |
| 425 | Jay Vosburgh contributed Symmetry support. |
| 426 | Marko Mlinar contributed OpenRISC 1000 support. |
| 427 | |
| 428 | Andreas Schwab contributed M68K @sc{gnu}/Linux support. |
| 429 | |
| 430 | Rich Schaefer and Peter Schauer helped with support of SunOS shared |
| 431 | libraries. |
| 432 | |
| 433 | Jay Fenlason and Roland McGrath ensured that @value{GDBN} and GAS agree |
| 434 | about several machine instruction sets. |
| 435 | |
| 436 | Patrick Duval, Ted Goldstein, Vikram Koka and Glenn Engel helped develop |
| 437 | remote debugging. Intel Corporation, Wind River Systems, AMD, and ARM |
| 438 | contributed remote debugging modules for the i960, VxWorks, A29K UDI, |
| 439 | and RDI targets, respectively. |
| 440 | |
| 441 | Brian Fox is the author of the readline libraries providing |
| 442 | command-line editing and command history. |
| 443 | |
| 444 | Andrew Beers of SUNY Buffalo wrote the language-switching code, the |
| 445 | Modula-2 support, and contributed the Languages chapter of this manual. |
| 446 | |
| 447 | Fred Fish wrote most of the support for Unix System Vr4. |
| 448 | He also enhanced the command-completion support to cover C@t{++} overloaded |
| 449 | symbols. |
| 450 | |
| 451 | Hitachi America (now Renesas America), Ltd. sponsored the support for |
| 452 | H8/300, H8/500, and Super-H processors. |
| 453 | |
| 454 | NEC sponsored the support for the v850, Vr4xxx, and Vr5xxx processors. |
| 455 | |
| 456 | Mitsubishi (now Renesas) sponsored the support for D10V, D30V, and M32R/D |
| 457 | processors. |
| 458 | |
| 459 | Toshiba sponsored the support for the TX39 Mips processor. |
| 460 | |
| 461 | Matsushita sponsored the support for the MN10200 and MN10300 processors. |
| 462 | |
| 463 | Fujitsu sponsored the support for SPARClite and FR30 processors. |
| 464 | |
| 465 | Kung Hsu, Jeff Law, and Rick Sladkey added support for hardware |
| 466 | watchpoints. |
| 467 | |
| 468 | Michael Snyder added support for tracepoints. |
| 469 | |
| 470 | Stu Grossman wrote gdbserver. |
| 471 | |
| 472 | Jim Kingdon, Peter Schauer, Ian Taylor, and Stu Grossman made |
| 473 | nearly innumerable bug fixes and cleanups throughout @value{GDBN}. |
| 474 | |
| 475 | The following people at the Hewlett-Packard Company contributed |
| 476 | support for the PA-RISC 2.0 architecture, HP-UX 10.20, 10.30, and 11.0 |
| 477 | (narrow mode), HP's implementation of kernel threads, HP's aC@t{++} |
| 478 | compiler, and the Text User Interface (nee Terminal User Interface): |
| 479 | Ben Krepp, Richard Title, John Bishop, Susan Macchia, Kathy Mann, |
| 480 | Satish Pai, India Paul, Steve Rehrauer, and Elena Zannoni. Kim Haase |
| 481 | provided HP-specific information in this manual. |
| 482 | |
| 483 | DJ Delorie ported @value{GDBN} to MS-DOS, for the DJGPP project. |
| 484 | Robert Hoehne made significant contributions to the DJGPP port. |
| 485 | |
| 486 | Cygnus Solutions has sponsored @value{GDBN} maintenance and much of its |
| 487 | development since 1991. Cygnus engineers who have worked on @value{GDBN} |
| 488 | fulltime include Mark Alexander, Jim Blandy, Per Bothner, Kevin |
| 489 | Buettner, Edith Epstein, Chris Faylor, Fred Fish, Martin Hunt, Jim |
| 490 | Ingham, John Gilmore, Stu Grossman, Kung Hsu, Jim Kingdon, John Metzler, |
| 491 | Fernando Nasser, Geoffrey Noer, Dawn Perchik, Rich Pixley, Zdenek |
| 492 | Radouch, Keith Seitz, Stan Shebs, David Taylor, and Elena Zannoni. In |
| 493 | addition, Dave Brolley, Ian Carmichael, Steve Chamberlain, Nick Clifton, |
| 494 | JT Conklin, Stan Cox, DJ Delorie, Ulrich Drepper, Frank Eigler, Doug |
| 495 | Evans, Sean Fagan, David Henkel-Wallace, Richard Henderson, Jeff |
| 496 | Holcomb, Jeff Law, Jim Lemke, Tom Lord, Bob Manson, Michael Meissner, |
| 497 | Jason Merrill, Catherine Moore, Drew Moseley, Ken Raeburn, Gavin |
| 498 | Romig-Koch, Rob Savoye, Jamie Smith, Mike Stump, Ian Taylor, Angela |
| 499 | Thomas, Michael Tiemann, Tom Tromey, Ron Unrau, Jim Wilson, and David |
| 500 | Zuhn have made contributions both large and small. |
| 501 | |
| 502 | Andrew Cagney, Fernando Nasser, and Elena Zannoni, while working for |
| 503 | Cygnus Solutions, implemented the original @sc{gdb/mi} interface. |
| 504 | |
| 505 | Jim Blandy added support for preprocessor macros, while working for Red |
| 506 | Hat. |
| 507 | |
| 508 | Andrew Cagney designed @value{GDBN}'s architecture vector. Many |
| 509 | people including Andrew Cagney, Stephane Carrez, Randolph Chung, Nick |
| 510 | Duffek, Richard Henderson, Mark Kettenis, Grace Sainsbury, Kei |
| 511 | Sakamoto, Yoshinori Sato, Michael Snyder, Andreas Schwab, Jason |
| 512 | Thorpe, Corinna Vinschen, Ulrich Weigand, and Elena Zannoni, helped |
| 513 | with the migration of old architectures to this new framework. |
| 514 | |
| 515 | Andrew Cagney completely re-designed and re-implemented @value{GDBN}'s |
| 516 | unwinder framework, this consisting of a fresh new design featuring |
| 517 | frame IDs, independent frame sniffers, and the sentinel frame. Mark |
| 518 | Kettenis implemented the @sc{dwarf 2} unwinder, Jeff Johnston the |
| 519 | libunwind unwinder, and Andrew Cagney the dummy, sentinel, tramp, and |
| 520 | trad unwinders. The architecture-specific changes, each involving a |
| 521 | complete rewrite of the architecture's frame code, were carried out by |
| 522 | Jim Blandy, Joel Brobecker, Kevin Buettner, Andrew Cagney, Stephane |
| 523 | Carrez, Randolph Chung, Orjan Friberg, Richard Henderson, Daniel |
| 524 | Jacobowitz, Jeff Johnston, Mark Kettenis, Theodore A. Roth, Kei |
| 525 | Sakamoto, Yoshinori Sato, Michael Snyder, Corinna Vinschen, and Ulrich |
| 526 | Weigand. |
| 527 | |
| 528 | Christian Zankel, Ross Morley, Bob Wilson, and Maxim Grigoriev from |
| 529 | Tensilica, Inc.@: contributed support for Xtensa processors. Others |
| 530 | who have worked on the Xtensa port of @value{GDBN} in the past include |
| 531 | Steve Tjiang, John Newlin, and Scott Foehner. |
| 532 | |
| 533 | Michael Eager and staff of Xilinx, Inc., contributed support for the |
| 534 | Xilinx MicroBlaze architecture. |
| 535 | |
| 536 | @node Sample Session |
| 537 | @chapter A Sample @value{GDBN} Session |
| 538 | |
| 539 | You can use this manual at your leisure to read all about @value{GDBN}. |
| 540 | However, a handful of commands are enough to get started using the |
| 541 | debugger. This chapter illustrates those commands. |
| 542 | |
| 543 | @iftex |
| 544 | In this sample session, we emphasize user input like this: @b{input}, |
| 545 | to make it easier to pick out from the surrounding output. |
| 546 | @end iftex |
| 547 | |
| 548 | @c FIXME: this example may not be appropriate for some configs, where |
| 549 | @c FIXME...primary interest is in remote use. |
| 550 | |
| 551 | One of the preliminary versions of @sc{gnu} @code{m4} (a generic macro |
| 552 | processor) exhibits the following bug: sometimes, when we change its |
| 553 | quote strings from the default, the commands used to capture one macro |
| 554 | definition within another stop working. In the following short @code{m4} |
| 555 | session, we define a macro @code{foo} which expands to @code{0000}; we |
| 556 | then use the @code{m4} built-in @code{defn} to define @code{bar} as the |
| 557 | same thing. However, when we change the open quote string to |
| 558 | @code{<QUOTE>} and the close quote string to @code{<UNQUOTE>}, the same |
| 559 | procedure fails to define a new synonym @code{baz}: |
| 560 | |
| 561 | @smallexample |
| 562 | $ @b{cd gnu/m4} |
| 563 | $ @b{./m4} |
| 564 | @b{define(foo,0000)} |
| 565 | |
| 566 | @b{foo} |
| 567 | 0000 |
| 568 | @b{define(bar,defn(`foo'))} |
| 569 | |
| 570 | @b{bar} |
| 571 | 0000 |
| 572 | @b{changequote(<QUOTE>,<UNQUOTE>)} |
| 573 | |
| 574 | @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))} |
| 575 | @b{baz} |
| 576 | @b{Ctrl-d} |
| 577 | m4: End of input: 0: fatal error: EOF in string |
| 578 | @end smallexample |
| 579 | |
| 580 | @noindent |
| 581 | Let us use @value{GDBN} to try to see what is going on. |
| 582 | |
| 583 | @smallexample |
| 584 | $ @b{@value{GDBP} m4} |
| 585 | @c FIXME: this falsifies the exact text played out, to permit smallbook |
| 586 | @c FIXME... format to come out better. |
| 587 | @value{GDBN} is free software and you are welcome to distribute copies |
| 588 | of it under certain conditions; type "show copying" to see |
| 589 | the conditions. |
| 590 | There is absolutely no warranty for @value{GDBN}; type "show warranty" |
| 591 | for details. |
| 592 | |
| 593 | @value{GDBN} @value{GDBVN}, Copyright 1999 Free Software Foundation, Inc... |
| 594 | (@value{GDBP}) |
| 595 | @end smallexample |
| 596 | |
| 597 | @noindent |
| 598 | @value{GDBN} reads only enough symbol data to know where to find the |
| 599 | rest when needed; as a result, the first prompt comes up very quickly. |
| 600 | We now tell @value{GDBN} to use a narrower display width than usual, so |
| 601 | that examples fit in this manual. |
| 602 | |
| 603 | @smallexample |
| 604 | (@value{GDBP}) @b{set width 70} |
| 605 | @end smallexample |
| 606 | |
| 607 | @noindent |
| 608 | We need to see how the @code{m4} built-in @code{changequote} works. |
| 609 | Having looked at the source, we know the relevant subroutine is |
| 610 | @code{m4_changequote}, so we set a breakpoint there with the @value{GDBN} |
| 611 | @code{break} command. |
| 612 | |
| 613 | @smallexample |
| 614 | (@value{GDBP}) @b{break m4_changequote} |
| 615 | Breakpoint 1 at 0x62f4: file builtin.c, line 879. |
| 616 | @end smallexample |
| 617 | |
| 618 | @noindent |
| 619 | Using the @code{run} command, we start @code{m4} running under @value{GDBN} |
| 620 | control; as long as control does not reach the @code{m4_changequote} |
| 621 | subroutine, the program runs as usual: |
| 622 | |
| 623 | @smallexample |
| 624 | (@value{GDBP}) @b{run} |
| 625 | Starting program: /work/Editorial/gdb/gnu/m4/m4 |
| 626 | @b{define(foo,0000)} |
| 627 | |
| 628 | @b{foo} |
| 629 | 0000 |
| 630 | @end smallexample |
| 631 | |
| 632 | @noindent |
| 633 | To trigger the breakpoint, we call @code{changequote}. @value{GDBN} |
| 634 | suspends execution of @code{m4}, displaying information about the |
| 635 | context where it stops. |
| 636 | |
| 637 | @smallexample |
| 638 | @b{changequote(<QUOTE>,<UNQUOTE>)} |
| 639 | |
| 640 | Breakpoint 1, m4_changequote (argc=3, argv=0x33c70) |
| 641 | at builtin.c:879 |
| 642 | 879 if (bad_argc(TOKEN_DATA_TEXT(argv[0]),argc,1,3)) |
| 643 | @end smallexample |
| 644 | |
| 645 | @noindent |
| 646 | Now we use the command @code{n} (@code{next}) to advance execution to |
| 647 | the next line of the current function. |
| 648 | |
| 649 | @smallexample |
| 650 | (@value{GDBP}) @b{n} |
| 651 | 882 set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\ |
| 652 | : nil, |
| 653 | @end smallexample |
| 654 | |
| 655 | @noindent |
| 656 | @code{set_quotes} looks like a promising subroutine. We can go into it |
| 657 | by using the command @code{s} (@code{step}) instead of @code{next}. |
| 658 | @code{step} goes to the next line to be executed in @emph{any} |
| 659 | subroutine, so it steps into @code{set_quotes}. |
| 660 | |
| 661 | @smallexample |
| 662 | (@value{GDBP}) @b{s} |
| 663 | set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>") |
| 664 | at input.c:530 |
| 665 | 530 if (lquote != def_lquote) |
| 666 | @end smallexample |
| 667 | |
| 668 | @noindent |
| 669 | The display that shows the subroutine where @code{m4} is now |
| 670 | suspended (and its arguments) is called a stack frame display. It |
| 671 | shows a summary of the stack. We can use the @code{backtrace} |
| 672 | command (which can also be spelled @code{bt}), to see where we are |
| 673 | in the stack as a whole: the @code{backtrace} command displays a |
| 674 | stack frame for each active subroutine. |
| 675 | |
| 676 | @smallexample |
| 677 | (@value{GDBP}) @b{bt} |
| 678 | #0 set_quotes (lq=0x34c78 "<QUOTE>", rq=0x34c88 "<UNQUOTE>") |
| 679 | at input.c:530 |
| 680 | #1 0x6344 in m4_changequote (argc=3, argv=0x33c70) |
| 681 | at builtin.c:882 |
| 682 | #2 0x8174 in expand_macro (sym=0x33320) at macro.c:242 |
| 683 | #3 0x7a88 in expand_token (obs=0x0, t=209696, td=0xf7fffa30) |
| 684 | at macro.c:71 |
| 685 | #4 0x79dc in expand_input () at macro.c:40 |
| 686 | #5 0x2930 in main (argc=0, argv=0xf7fffb20) at m4.c:195 |
| 687 | @end smallexample |
| 688 | |
| 689 | @noindent |
| 690 | We step through a few more lines to see what happens. The first two |
| 691 | times, we can use @samp{s}; the next two times we use @code{n} to avoid |
| 692 | falling into the @code{xstrdup} subroutine. |
| 693 | |
| 694 | @smallexample |
| 695 | (@value{GDBP}) @b{s} |
| 696 | 0x3b5c 532 if (rquote != def_rquote) |
| 697 | (@value{GDBP}) @b{s} |
| 698 | 0x3b80 535 lquote = (lq == nil || *lq == '\0') ? \ |
| 699 | def_lquote : xstrdup(lq); |
| 700 | (@value{GDBP}) @b{n} |
| 701 | 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\ |
| 702 | : xstrdup(rq); |
| 703 | (@value{GDBP}) @b{n} |
| 704 | 538 len_lquote = strlen(rquote); |
| 705 | @end smallexample |
| 706 | |
| 707 | @noindent |
| 708 | The last line displayed looks a little odd; we can examine the variables |
| 709 | @code{lquote} and @code{rquote} to see if they are in fact the new left |
| 710 | and right quotes we specified. We use the command @code{p} |
| 711 | (@code{print}) to see their values. |
| 712 | |
| 713 | @smallexample |
| 714 | (@value{GDBP}) @b{p lquote} |
| 715 | $1 = 0x35d40 "<QUOTE>" |
| 716 | (@value{GDBP}) @b{p rquote} |
| 717 | $2 = 0x35d50 "<UNQUOTE>" |
| 718 | @end smallexample |
| 719 | |
| 720 | @noindent |
| 721 | @code{lquote} and @code{rquote} are indeed the new left and right quotes. |
| 722 | To look at some context, we can display ten lines of source |
| 723 | surrounding the current line with the @code{l} (@code{list}) command. |
| 724 | |
| 725 | @smallexample |
| 726 | (@value{GDBP}) @b{l} |
| 727 | 533 xfree(rquote); |
| 728 | 534 |
| 729 | 535 lquote = (lq == nil || *lq == '\0') ? def_lquote\ |
| 730 | : xstrdup (lq); |
| 731 | 536 rquote = (rq == nil || *rq == '\0') ? def_rquote\ |
| 732 | : xstrdup (rq); |
| 733 | 537 |
| 734 | 538 len_lquote = strlen(rquote); |
| 735 | 539 len_rquote = strlen(lquote); |
| 736 | 540 @} |
| 737 | 541 |
| 738 | 542 void |
| 739 | @end smallexample |
| 740 | |
| 741 | @noindent |
| 742 | Let us step past the two lines that set @code{len_lquote} and |
| 743 | @code{len_rquote}, and then examine the values of those variables. |
| 744 | |
| 745 | @smallexample |
| 746 | (@value{GDBP}) @b{n} |
| 747 | 539 len_rquote = strlen(lquote); |
| 748 | (@value{GDBP}) @b{n} |
| 749 | 540 @} |
| 750 | (@value{GDBP}) @b{p len_lquote} |
| 751 | $3 = 9 |
| 752 | (@value{GDBP}) @b{p len_rquote} |
| 753 | $4 = 7 |
| 754 | @end smallexample |
| 755 | |
| 756 | @noindent |
| 757 | That certainly looks wrong, assuming @code{len_lquote} and |
| 758 | @code{len_rquote} are meant to be the lengths of @code{lquote} and |
| 759 | @code{rquote} respectively. We can set them to better values using |
| 760 | the @code{p} command, since it can print the value of |
| 761 | any expression---and that expression can include subroutine calls and |
| 762 | assignments. |
| 763 | |
| 764 | @smallexample |
| 765 | (@value{GDBP}) @b{p len_lquote=strlen(lquote)} |
| 766 | $5 = 7 |
| 767 | (@value{GDBP}) @b{p len_rquote=strlen(rquote)} |
| 768 | $6 = 9 |
| 769 | @end smallexample |
| 770 | |
| 771 | @noindent |
| 772 | Is that enough to fix the problem of using the new quotes with the |
| 773 | @code{m4} built-in @code{defn}? We can allow @code{m4} to continue |
| 774 | executing with the @code{c} (@code{continue}) command, and then try the |
| 775 | example that caused trouble initially: |
| 776 | |
| 777 | @smallexample |
| 778 | (@value{GDBP}) @b{c} |
| 779 | Continuing. |
| 780 | |
| 781 | @b{define(baz,defn(<QUOTE>foo<UNQUOTE>))} |
| 782 | |
| 783 | baz |
| 784 | 0000 |
| 785 | @end smallexample |
| 786 | |
| 787 | @noindent |
| 788 | Success! The new quotes now work just as well as the default ones. The |
| 789 | problem seems to have been just the two typos defining the wrong |
| 790 | lengths. We allow @code{m4} exit by giving it an EOF as input: |
| 791 | |
| 792 | @smallexample |
| 793 | @b{Ctrl-d} |
| 794 | Program exited normally. |
| 795 | @end smallexample |
| 796 | |
| 797 | @noindent |
| 798 | The message @samp{Program exited normally.} is from @value{GDBN}; it |
| 799 | indicates @code{m4} has finished executing. We can end our @value{GDBN} |
| 800 | session with the @value{GDBN} @code{quit} command. |
| 801 | |
| 802 | @smallexample |
| 803 | (@value{GDBP}) @b{quit} |
| 804 | @end smallexample |
| 805 | |
| 806 | @node Invocation |
| 807 | @chapter Getting In and Out of @value{GDBN} |
| 808 | |
| 809 | This chapter discusses how to start @value{GDBN}, and how to get out of it. |
| 810 | The essentials are: |
| 811 | @itemize @bullet |
| 812 | @item |
| 813 | type @samp{@value{GDBP}} to start @value{GDBN}. |
| 814 | @item |
| 815 | type @kbd{quit} or @kbd{Ctrl-d} to exit. |
| 816 | @end itemize |
| 817 | |
| 818 | @menu |
| 819 | * Invoking GDB:: How to start @value{GDBN} |
| 820 | * Quitting GDB:: How to quit @value{GDBN} |
| 821 | * Shell Commands:: How to use shell commands inside @value{GDBN} |
| 822 | * Logging Output:: How to log @value{GDBN}'s output to a file |
| 823 | @end menu |
| 824 | |
| 825 | @node Invoking GDB |
| 826 | @section Invoking @value{GDBN} |
| 827 | |
| 828 | Invoke @value{GDBN} by running the program @code{@value{GDBP}}. Once started, |
| 829 | @value{GDBN} reads commands from the terminal until you tell it to exit. |
| 830 | |
| 831 | You can also run @code{@value{GDBP}} with a variety of arguments and options, |
| 832 | to specify more of your debugging environment at the outset. |
| 833 | |
| 834 | The command-line options described here are designed |
| 835 | to cover a variety of situations; in some environments, some of these |
| 836 | options may effectively be unavailable. |
| 837 | |
| 838 | The most usual way to start @value{GDBN} is with one argument, |
| 839 | specifying an executable program: |
| 840 | |
| 841 | @smallexample |
| 842 | @value{GDBP} @var{program} |
| 843 | @end smallexample |
| 844 | |
| 845 | @noindent |
| 846 | You can also start with both an executable program and a core file |
| 847 | specified: |
| 848 | |
| 849 | @smallexample |
| 850 | @value{GDBP} @var{program} @var{core} |
| 851 | @end smallexample |
| 852 | |
| 853 | You can, instead, specify a process ID as a second argument, if you want |
| 854 | to debug a running process: |
| 855 | |
| 856 | @smallexample |
| 857 | @value{GDBP} @var{program} 1234 |
| 858 | @end smallexample |
| 859 | |
| 860 | @noindent |
| 861 | would attach @value{GDBN} to process @code{1234} (unless you also have a file |
| 862 | named @file{1234}; @value{GDBN} does check for a core file first). |
| 863 | |
| 864 | Taking advantage of the second command-line argument requires a fairly |
| 865 | complete operating system; when you use @value{GDBN} as a remote |
| 866 | debugger attached to a bare board, there may not be any notion of |
| 867 | ``process'', and there is often no way to get a core dump. @value{GDBN} |
| 868 | will warn you if it is unable to attach or to read core dumps. |
| 869 | |
| 870 | You can optionally have @code{@value{GDBP}} pass any arguments after the |
| 871 | executable file to the inferior using @code{--args}. This option stops |
| 872 | option processing. |
| 873 | @smallexample |
| 874 | @value{GDBP} --args gcc -O2 -c foo.c |
| 875 | @end smallexample |
| 876 | This will cause @code{@value{GDBP}} to debug @code{gcc}, and to set |
| 877 | @code{gcc}'s command-line arguments (@pxref{Arguments}) to @samp{-O2 -c foo.c}. |
| 878 | |
| 879 | You can run @code{@value{GDBP}} without printing the front material, which describes |
| 880 | @value{GDBN}'s non-warranty, by specifying @code{-silent}: |
| 881 | |
| 882 | @smallexample |
| 883 | @value{GDBP} -silent |
| 884 | @end smallexample |
| 885 | |
| 886 | @noindent |
| 887 | You can further control how @value{GDBN} starts up by using command-line |
| 888 | options. @value{GDBN} itself can remind you of the options available. |
| 889 | |
| 890 | @noindent |
| 891 | Type |
| 892 | |
| 893 | @smallexample |
| 894 | @value{GDBP} -help |
| 895 | @end smallexample |
| 896 | |
| 897 | @noindent |
| 898 | to display all available options and briefly describe their use |
| 899 | (@samp{@value{GDBP} -h} is a shorter equivalent). |
| 900 | |
| 901 | All options and command line arguments you give are processed |
| 902 | in sequential order. The order makes a difference when the |
| 903 | @samp{-x} option is used. |
| 904 | |
| 905 | |
| 906 | @menu |
| 907 | * File Options:: Choosing files |
| 908 | * Mode Options:: Choosing modes |
| 909 | * Startup:: What @value{GDBN} does during startup |
| 910 | @end menu |
| 911 | |
| 912 | @node File Options |
| 913 | @subsection Choosing Files |
| 914 | |
| 915 | When @value{GDBN} starts, it reads any arguments other than options as |
| 916 | specifying an executable file and core file (or process ID). This is |
| 917 | the same as if the arguments were specified by the @samp{-se} and |
| 918 | @samp{-c} (or @samp{-p}) options respectively. (@value{GDBN} reads the |
| 919 | first argument that does not have an associated option flag as |
| 920 | equivalent to the @samp{-se} option followed by that argument; and the |
| 921 | second argument that does not have an associated option flag, if any, as |
| 922 | equivalent to the @samp{-c}/@samp{-p} option followed by that argument.) |
| 923 | If the second argument begins with a decimal digit, @value{GDBN} will |
| 924 | first attempt to attach to it as a process, and if that fails, attempt |
| 925 | to open it as a corefile. If you have a corefile whose name begins with |
| 926 | a digit, you can prevent @value{GDBN} from treating it as a pid by |
| 927 | prefixing it with @file{./}, e.g.@: @file{./12345}. |
| 928 | |
| 929 | If @value{GDBN} has not been configured to included core file support, |
| 930 | such as for most embedded targets, then it will complain about a second |
| 931 | argument and ignore it. |
| 932 | |
| 933 | Many options have both long and short forms; both are shown in the |
| 934 | following list. @value{GDBN} also recognizes the long forms if you truncate |
| 935 | them, so long as enough of the option is present to be unambiguous. |
| 936 | (If you prefer, you can flag option arguments with @samp{--} rather |
| 937 | than @samp{-}, though we illustrate the more usual convention.) |
| 938 | |
| 939 | @c NOTE: the @cindex entries here use double dashes ON PURPOSE. This |
| 940 | @c way, both those who look for -foo and --foo in the index, will find |
| 941 | @c it. |
| 942 | |
| 943 | @table @code |
| 944 | @item -symbols @var{file} |
| 945 | @itemx -s @var{file} |
| 946 | @cindex @code{--symbols} |
| 947 | @cindex @code{-s} |
| 948 | Read symbol table from file @var{file}. |
| 949 | |
| 950 | @item -exec @var{file} |
| 951 | @itemx -e @var{file} |
| 952 | @cindex @code{--exec} |
| 953 | @cindex @code{-e} |
| 954 | Use file @var{file} as the executable file to execute when appropriate, |
| 955 | and for examining pure data in conjunction with a core dump. |
| 956 | |
| 957 | @item -se @var{file} |
| 958 | @cindex @code{--se} |
| 959 | Read symbol table from file @var{file} and use it as the executable |
| 960 | file. |
| 961 | |
| 962 | @item -core @var{file} |
| 963 | @itemx -c @var{file} |
| 964 | @cindex @code{--core} |
| 965 | @cindex @code{-c} |
| 966 | Use file @var{file} as a core dump to examine. |
| 967 | |
| 968 | @item -pid @var{number} |
| 969 | @itemx -p @var{number} |
| 970 | @cindex @code{--pid} |
| 971 | @cindex @code{-p} |
| 972 | Connect to process ID @var{number}, as with the @code{attach} command. |
| 973 | |
| 974 | @item -command @var{file} |
| 975 | @itemx -x @var{file} |
| 976 | @cindex @code{--command} |
| 977 | @cindex @code{-x} |
| 978 | Execute commands from file @var{file}. The contents of this file is |
| 979 | evaluated exactly as the @code{source} command would. |
| 980 | @xref{Command Files,, Command files}. |
| 981 | |
| 982 | @item -eval-command @var{command} |
| 983 | @itemx -ex @var{command} |
| 984 | @cindex @code{--eval-command} |
| 985 | @cindex @code{-ex} |
| 986 | Execute a single @value{GDBN} command. |
| 987 | |
| 988 | This option may be used multiple times to call multiple commands. It may |
| 989 | also be interleaved with @samp{-command} as required. |
| 990 | |
| 991 | @smallexample |
| 992 | @value{GDBP} -ex 'target sim' -ex 'load' \ |
| 993 | -x setbreakpoints -ex 'run' a.out |
| 994 | @end smallexample |
| 995 | |
| 996 | @item -directory @var{directory} |
| 997 | @itemx -d @var{directory} |
| 998 | @cindex @code{--directory} |
| 999 | @cindex @code{-d} |
| 1000 | Add @var{directory} to the path to search for source and script files. |
| 1001 | |
| 1002 | @item -r |
| 1003 | @itemx -readnow |
| 1004 | @cindex @code{--readnow} |
| 1005 | @cindex @code{-r} |
| 1006 | Read each symbol file's entire symbol table immediately, rather than |
| 1007 | the default, which is to read it incrementally as it is needed. |
| 1008 | This makes startup slower, but makes future operations faster. |
| 1009 | |
| 1010 | @end table |
| 1011 | |
| 1012 | @node Mode Options |
| 1013 | @subsection Choosing Modes |
| 1014 | |
| 1015 | You can run @value{GDBN} in various alternative modes---for example, in |
| 1016 | batch mode or quiet mode. |
| 1017 | |
| 1018 | @table @code |
| 1019 | @item -nx |
| 1020 | @itemx -n |
| 1021 | @cindex @code{--nx} |
| 1022 | @cindex @code{-n} |
| 1023 | Do not execute commands found in any initialization files. Normally, |
| 1024 | @value{GDBN} executes the commands in these files after all the command |
| 1025 | options and arguments have been processed. @xref{Command Files,,Command |
| 1026 | Files}. |
| 1027 | |
| 1028 | @item -quiet |
| 1029 | @itemx -silent |
| 1030 | @itemx -q |
| 1031 | @cindex @code{--quiet} |
| 1032 | @cindex @code{--silent} |
| 1033 | @cindex @code{-q} |
| 1034 | ``Quiet''. Do not print the introductory and copyright messages. These |
| 1035 | messages are also suppressed in batch mode. |
| 1036 | |
| 1037 | @item -batch |
| 1038 | @cindex @code{--batch} |
| 1039 | Run in batch mode. Exit with status @code{0} after processing all the |
| 1040 | command files specified with @samp{-x} (and all commands from |
| 1041 | initialization files, if not inhibited with @samp{-n}). Exit with |
| 1042 | nonzero status if an error occurs in executing the @value{GDBN} commands |
| 1043 | in the command files. Batch mode also disables pagination, sets unlimited |
| 1044 | terminal width and height @pxref{Screen Size}, and acts as if @kbd{set confirm |
| 1045 | off} were in effect (@pxref{Messages/Warnings}). |
| 1046 | |
| 1047 | Batch mode may be useful for running @value{GDBN} as a filter, for |
| 1048 | example to download and run a program on another computer; in order to |
| 1049 | make this more useful, the message |
| 1050 | |
| 1051 | @smallexample |
| 1052 | Program exited normally. |
| 1053 | @end smallexample |
| 1054 | |
| 1055 | @noindent |
| 1056 | (which is ordinarily issued whenever a program running under |
| 1057 | @value{GDBN} control terminates) is not issued when running in batch |
| 1058 | mode. |
| 1059 | |
| 1060 | @item -batch-silent |
| 1061 | @cindex @code{--batch-silent} |
| 1062 | Run in batch mode exactly like @samp{-batch}, but totally silently. All |
| 1063 | @value{GDBN} output to @code{stdout} is prevented (@code{stderr} is |
| 1064 | unaffected). This is much quieter than @samp{-silent} and would be useless |
| 1065 | for an interactive session. |
| 1066 | |
| 1067 | This is particularly useful when using targets that give @samp{Loading section} |
| 1068 | messages, for example. |
| 1069 | |
| 1070 | Note that targets that give their output via @value{GDBN}, as opposed to |
| 1071 | writing directly to @code{stdout}, will also be made silent. |
| 1072 | |
| 1073 | @item -return-child-result |
| 1074 | @cindex @code{--return-child-result} |
| 1075 | The return code from @value{GDBN} will be the return code from the child |
| 1076 | process (the process being debugged), with the following exceptions: |
| 1077 | |
| 1078 | @itemize @bullet |
| 1079 | @item |
| 1080 | @value{GDBN} exits abnormally. E.g., due to an incorrect argument or an |
| 1081 | internal error. In this case the exit code is the same as it would have been |
| 1082 | without @samp{-return-child-result}. |
| 1083 | @item |
| 1084 | The user quits with an explicit value. E.g., @samp{quit 1}. |
| 1085 | @item |
| 1086 | The child process never runs, or is not allowed to terminate, in which case |
| 1087 | the exit code will be -1. |
| 1088 | @end itemize |
| 1089 | |
| 1090 | This option is useful in conjunction with @samp{-batch} or @samp{-batch-silent}, |
| 1091 | when @value{GDBN} is being used as a remote program loader or simulator |
| 1092 | interface. |
| 1093 | |
| 1094 | @item -nowindows |
| 1095 | @itemx -nw |
| 1096 | @cindex @code{--nowindows} |
| 1097 | @cindex @code{-nw} |
| 1098 | ``No windows''. If @value{GDBN} comes with a graphical user interface |
| 1099 | (GUI) built in, then this option tells @value{GDBN} to only use the command-line |
| 1100 | interface. If no GUI is available, this option has no effect. |
| 1101 | |
| 1102 | @item -windows |
| 1103 | @itemx -w |
| 1104 | @cindex @code{--windows} |
| 1105 | @cindex @code{-w} |
| 1106 | If @value{GDBN} includes a GUI, then this option requires it to be |
| 1107 | used if possible. |
| 1108 | |
| 1109 | @item -cd @var{directory} |
| 1110 | @cindex @code{--cd} |
| 1111 | Run @value{GDBN} using @var{directory} as its working directory, |
| 1112 | instead of the current directory. |
| 1113 | |
| 1114 | @item -data-directory @var{directory} |
| 1115 | @cindex @code{--data-directory} |
| 1116 | Run @value{GDBN} using @var{directory} as its data directory. |
| 1117 | The data directory is where @value{GDBN} searches for its |
| 1118 | auxiliary files. @xref{Data Files}. |
| 1119 | |
| 1120 | @item -fullname |
| 1121 | @itemx -f |
| 1122 | @cindex @code{--fullname} |
| 1123 | @cindex @code{-f} |
| 1124 | @sc{gnu} Emacs sets this option when it runs @value{GDBN} as a |
| 1125 | subprocess. It tells @value{GDBN} to output the full file name and line |
| 1126 | number in a standard, recognizable fashion each time a stack frame is |
| 1127 | displayed (which includes each time your program stops). This |
| 1128 | recognizable format looks like two @samp{\032} characters, followed by |
| 1129 | the file name, line number and character position separated by colons, |
| 1130 | and a newline. The Emacs-to-@value{GDBN} interface program uses the two |
| 1131 | @samp{\032} characters as a signal to display the source code for the |
| 1132 | frame. |
| 1133 | |
| 1134 | @item -epoch |
| 1135 | @cindex @code{--epoch} |
| 1136 | The Epoch Emacs-@value{GDBN} interface sets this option when it runs |
| 1137 | @value{GDBN} as a subprocess. It tells @value{GDBN} to modify its print |
| 1138 | routines so as to allow Epoch to display values of expressions in a |
| 1139 | separate window. |
| 1140 | |
| 1141 | @item -annotate @var{level} |
| 1142 | @cindex @code{--annotate} |
| 1143 | This option sets the @dfn{annotation level} inside @value{GDBN}. Its |
| 1144 | effect is identical to using @samp{set annotate @var{level}} |
| 1145 | (@pxref{Annotations}). The annotation @var{level} controls how much |
| 1146 | information @value{GDBN} prints together with its prompt, values of |
| 1147 | expressions, source lines, and other types of output. Level 0 is the |
| 1148 | normal, level 1 is for use when @value{GDBN} is run as a subprocess of |
| 1149 | @sc{gnu} Emacs, level 3 is the maximum annotation suitable for programs |
| 1150 | that control @value{GDBN}, and level 2 has been deprecated. |
| 1151 | |
| 1152 | The annotation mechanism has largely been superseded by @sc{gdb/mi} |
| 1153 | (@pxref{GDB/MI}). |
| 1154 | |
| 1155 | @item --args |
| 1156 | @cindex @code{--args} |
| 1157 | Change interpretation of command line so that arguments following the |
| 1158 | executable file are passed as command line arguments to the inferior. |
| 1159 | This option stops option processing. |
| 1160 | |
| 1161 | @item -baud @var{bps} |
| 1162 | @itemx -b @var{bps} |
| 1163 | @cindex @code{--baud} |
| 1164 | @cindex @code{-b} |
| 1165 | Set the line speed (baud rate or bits per second) of any serial |
| 1166 | interface used by @value{GDBN} for remote debugging. |
| 1167 | |
| 1168 | @item -l @var{timeout} |
| 1169 | @cindex @code{-l} |
| 1170 | Set the timeout (in seconds) of any communication used by @value{GDBN} |
| 1171 | for remote debugging. |
| 1172 | |
| 1173 | @item -tty @var{device} |
| 1174 | @itemx -t @var{device} |
| 1175 | @cindex @code{--tty} |
| 1176 | @cindex @code{-t} |
| 1177 | Run using @var{device} for your program's standard input and output. |
| 1178 | @c FIXME: kingdon thinks there is more to -tty. Investigate. |
| 1179 | |
| 1180 | @c resolve the situation of these eventually |
| 1181 | @item -tui |
| 1182 | @cindex @code{--tui} |
| 1183 | Activate the @dfn{Text User Interface} when starting. The Text User |
| 1184 | Interface manages several text windows on the terminal, showing |
| 1185 | source, assembly, registers and @value{GDBN} command outputs |
| 1186 | (@pxref{TUI, ,@value{GDBN} Text User Interface}). Alternatively, the |
| 1187 | Text User Interface can be enabled by invoking the program |
| 1188 | @samp{@value{GDBTUI}}. Do not use this option if you run @value{GDBN} from |
| 1189 | Emacs (@pxref{Emacs, ,Using @value{GDBN} under @sc{gnu} Emacs}). |
| 1190 | |
| 1191 | @c @item -xdb |
| 1192 | @c @cindex @code{--xdb} |
| 1193 | @c Run in XDB compatibility mode, allowing the use of certain XDB commands. |
| 1194 | @c For information, see the file @file{xdb_trans.html}, which is usually |
| 1195 | @c installed in the directory @code{/opt/langtools/wdb/doc} on HP-UX |
| 1196 | @c systems. |
| 1197 | |
| 1198 | @item -interpreter @var{interp} |
| 1199 | @cindex @code{--interpreter} |
| 1200 | Use the interpreter @var{interp} for interface with the controlling |
| 1201 | program or device. This option is meant to be set by programs which |
| 1202 | communicate with @value{GDBN} using it as a back end. |
| 1203 | @xref{Interpreters, , Command Interpreters}. |
| 1204 | |
| 1205 | @samp{--interpreter=mi} (or @samp{--interpreter=mi2}) causes |
| 1206 | @value{GDBN} to use the @dfn{@sc{gdb/mi} interface} (@pxref{GDB/MI, , |
| 1207 | The @sc{gdb/mi} Interface}) included since @value{GDBN} version 6.0. The |
| 1208 | previous @sc{gdb/mi} interface, included in @value{GDBN} version 5.3 and |
| 1209 | selected with @samp{--interpreter=mi1}, is deprecated. Earlier |
| 1210 | @sc{gdb/mi} interfaces are no longer supported. |
| 1211 | |
| 1212 | @item -write |
| 1213 | @cindex @code{--write} |
| 1214 | Open the executable and core files for both reading and writing. This |
| 1215 | is equivalent to the @samp{set write on} command inside @value{GDBN} |
| 1216 | (@pxref{Patching}). |
| 1217 | |
| 1218 | @item -statistics |
| 1219 | @cindex @code{--statistics} |
| 1220 | This option causes @value{GDBN} to print statistics about time and |
| 1221 | memory usage after it completes each command and returns to the prompt. |
| 1222 | |
| 1223 | @item -version |
| 1224 | @cindex @code{--version} |
| 1225 | This option causes @value{GDBN} to print its version number and |
| 1226 | no-warranty blurb, and exit. |
| 1227 | |
| 1228 | @end table |
| 1229 | |
| 1230 | @node Startup |
| 1231 | @subsection What @value{GDBN} Does During Startup |
| 1232 | @cindex @value{GDBN} startup |
| 1233 | |
| 1234 | Here's the description of what @value{GDBN} does during session startup: |
| 1235 | |
| 1236 | @enumerate |
| 1237 | @item |
| 1238 | Sets up the command interpreter as specified by the command line |
| 1239 | (@pxref{Mode Options, interpreter}). |
| 1240 | |
| 1241 | @item |
| 1242 | @cindex init file |
| 1243 | Reads the system-wide @dfn{init file} (if @option{--with-system-gdbinit} was |
| 1244 | used when building @value{GDBN}; @pxref{System-wide configuration, |
| 1245 | ,System-wide configuration and settings}) and executes all the commands in |
| 1246 | that file. |
| 1247 | |
| 1248 | @item |
| 1249 | Reads the init file (if any) in your home directory@footnote{On |
| 1250 | DOS/Windows systems, the home directory is the one pointed to by the |
| 1251 | @code{HOME} environment variable.} and executes all the commands in |
| 1252 | that file. |
| 1253 | |
| 1254 | @item |
| 1255 | Processes command line options and operands. |
| 1256 | |
| 1257 | @item |
| 1258 | Reads and executes the commands from init file (if any) in the current |
| 1259 | working directory. This is only done if the current directory is |
| 1260 | different from your home directory. Thus, you can have more than one |
| 1261 | init file, one generic in your home directory, and another, specific |
| 1262 | to the program you are debugging, in the directory where you invoke |
| 1263 | @value{GDBN}. |
| 1264 | |
| 1265 | @item |
| 1266 | If the command line specified a program to debug, or a process to |
| 1267 | attach to, or a core file, @value{GDBN} loads any auto-loaded |
| 1268 | scripts provided for the program or for its loaded shared libraries. |
| 1269 | @xref{Auto-loading}. |
| 1270 | |
| 1271 | If you wish to disable the auto-loading during startup, |
| 1272 | you must do something like the following: |
| 1273 | |
| 1274 | @smallexample |
| 1275 | $ gdb -ex "set auto-load-scripts off" -ex "file myprogram" |
| 1276 | @end smallexample |
| 1277 | |
| 1278 | The following does not work because the auto-loading is turned off too late: |
| 1279 | |
| 1280 | @smallexample |
| 1281 | $ gdb -ex "set auto-load-scripts off" myprogram |
| 1282 | @end smallexample |
| 1283 | |
| 1284 | @item |
| 1285 | Reads command files specified by the @samp{-x} option. @xref{Command |
| 1286 | Files}, for more details about @value{GDBN} command files. |
| 1287 | |
| 1288 | @item |
| 1289 | Reads the command history recorded in the @dfn{history file}. |
| 1290 | @xref{Command History}, for more details about the command history and the |
| 1291 | files where @value{GDBN} records it. |
| 1292 | @end enumerate |
| 1293 | |
| 1294 | Init files use the same syntax as @dfn{command files} (@pxref{Command |
| 1295 | Files}) and are processed by @value{GDBN} in the same way. The init |
| 1296 | file in your home directory can set options (such as @samp{set |
| 1297 | complaints}) that affect subsequent processing of command line options |
| 1298 | and operands. Init files are not executed if you use the @samp{-nx} |
| 1299 | option (@pxref{Mode Options, ,Choosing Modes}). |
| 1300 | |
| 1301 | To display the list of init files loaded by gdb at startup, you |
| 1302 | can use @kbd{gdb --help}. |
| 1303 | |
| 1304 | @cindex init file name |
| 1305 | @cindex @file{.gdbinit} |
| 1306 | @cindex @file{gdb.ini} |
| 1307 | The @value{GDBN} init files are normally called @file{.gdbinit}. |
| 1308 | The DJGPP port of @value{GDBN} uses the name @file{gdb.ini}, due to |
| 1309 | the limitations of file names imposed by DOS filesystems. The Windows |
| 1310 | ports of @value{GDBN} use the standard name, but if they find a |
| 1311 | @file{gdb.ini} file, they warn you about that and suggest to rename |
| 1312 | the file to the standard name. |
| 1313 | |
| 1314 | |
| 1315 | @node Quitting GDB |
| 1316 | @section Quitting @value{GDBN} |
| 1317 | @cindex exiting @value{GDBN} |
| 1318 | @cindex leaving @value{GDBN} |
| 1319 | |
| 1320 | @table @code |
| 1321 | @kindex quit @r{[}@var{expression}@r{]} |
| 1322 | @kindex q @r{(@code{quit})} |
| 1323 | @item quit @r{[}@var{expression}@r{]} |
| 1324 | @itemx q |
| 1325 | To exit @value{GDBN}, use the @code{quit} command (abbreviated |
| 1326 | @code{q}), or type an end-of-file character (usually @kbd{Ctrl-d}). If you |
| 1327 | do not supply @var{expression}, @value{GDBN} will terminate normally; |
| 1328 | otherwise it will terminate using the result of @var{expression} as the |
| 1329 | error code. |
| 1330 | @end table |
| 1331 | |
| 1332 | @cindex interrupt |
| 1333 | An interrupt (often @kbd{Ctrl-c}) does not exit from @value{GDBN}, but rather |
| 1334 | terminates the action of any @value{GDBN} command that is in progress and |
| 1335 | returns to @value{GDBN} command level. It is safe to type the interrupt |
| 1336 | character at any time because @value{GDBN} does not allow it to take effect |
| 1337 | until a time when it is safe. |
| 1338 | |
| 1339 | If you have been using @value{GDBN} to control an attached process or |
| 1340 | device, you can release it with the @code{detach} command |
| 1341 | (@pxref{Attach, ,Debugging an Already-running Process}). |
| 1342 | |
| 1343 | @node Shell Commands |
| 1344 | @section Shell Commands |
| 1345 | |
| 1346 | If you need to execute occasional shell commands during your |
| 1347 | debugging session, there is no need to leave or suspend @value{GDBN}; you can |
| 1348 | just use the @code{shell} command. |
| 1349 | |
| 1350 | @table @code |
| 1351 | @kindex shell |
| 1352 | @cindex shell escape |
| 1353 | @item shell @var{command string} |
| 1354 | Invoke a standard shell to execute @var{command string}. |
| 1355 | If it exists, the environment variable @code{SHELL} determines which |
| 1356 | shell to run. Otherwise @value{GDBN} uses the default shell |
| 1357 | (@file{/bin/sh} on Unix systems, @file{COMMAND.COM} on MS-DOS, etc.). |
| 1358 | @end table |
| 1359 | |
| 1360 | The utility @code{make} is often needed in development environments. |
| 1361 | You do not have to use the @code{shell} command for this purpose in |
| 1362 | @value{GDBN}: |
| 1363 | |
| 1364 | @table @code |
| 1365 | @kindex make |
| 1366 | @cindex calling make |
| 1367 | @item make @var{make-args} |
| 1368 | Execute the @code{make} program with the specified |
| 1369 | arguments. This is equivalent to @samp{shell make @var{make-args}}. |
| 1370 | @end table |
| 1371 | |
| 1372 | @node Logging Output |
| 1373 | @section Logging Output |
| 1374 | @cindex logging @value{GDBN} output |
| 1375 | @cindex save @value{GDBN} output to a file |
| 1376 | |
| 1377 | You may want to save the output of @value{GDBN} commands to a file. |
| 1378 | There are several commands to control @value{GDBN}'s logging. |
| 1379 | |
| 1380 | @table @code |
| 1381 | @kindex set logging |
| 1382 | @item set logging on |
| 1383 | Enable logging. |
| 1384 | @item set logging off |
| 1385 | Disable logging. |
| 1386 | @cindex logging file name |
| 1387 | @item set logging file @var{file} |
| 1388 | Change the name of the current logfile. The default logfile is @file{gdb.txt}. |
| 1389 | @item set logging overwrite [on|off] |
| 1390 | By default, @value{GDBN} will append to the logfile. Set @code{overwrite} if |
| 1391 | you want @code{set logging on} to overwrite the logfile instead. |
| 1392 | @item set logging redirect [on|off] |
| 1393 | By default, @value{GDBN} output will go to both the terminal and the logfile. |
| 1394 | Set @code{redirect} if you want output to go only to the log file. |
| 1395 | @kindex show logging |
| 1396 | @item show logging |
| 1397 | Show the current values of the logging settings. |
| 1398 | @end table |
| 1399 | |
| 1400 | @node Commands |
| 1401 | @chapter @value{GDBN} Commands |
| 1402 | |
| 1403 | You can abbreviate a @value{GDBN} command to the first few letters of the command |
| 1404 | name, if that abbreviation is unambiguous; and you can repeat certain |
| 1405 | @value{GDBN} commands by typing just @key{RET}. You can also use the @key{TAB} |
| 1406 | key to get @value{GDBN} to fill out the rest of a word in a command (or to |
| 1407 | show you the alternatives available, if there is more than one possibility). |
| 1408 | |
| 1409 | @menu |
| 1410 | * Command Syntax:: How to give commands to @value{GDBN} |
| 1411 | * Completion:: Command completion |
| 1412 | * Help:: How to ask @value{GDBN} for help |
| 1413 | @end menu |
| 1414 | |
| 1415 | @node Command Syntax |
| 1416 | @section Command Syntax |
| 1417 | |
| 1418 | A @value{GDBN} command is a single line of input. There is no limit on |
| 1419 | how long it can be. It starts with a command name, which is followed by |
| 1420 | arguments whose meaning depends on the command name. For example, the |
| 1421 | command @code{step} accepts an argument which is the number of times to |
| 1422 | step, as in @samp{step 5}. You can also use the @code{step} command |
| 1423 | with no arguments. Some commands do not allow any arguments. |
| 1424 | |
| 1425 | @cindex abbreviation |
| 1426 | @value{GDBN} command names may always be truncated if that abbreviation is |
| 1427 | unambiguous. Other possible command abbreviations are listed in the |
| 1428 | documentation for individual commands. In some cases, even ambiguous |
| 1429 | abbreviations are allowed; for example, @code{s} is specially defined as |
| 1430 | equivalent to @code{step} even though there are other commands whose |
| 1431 | names start with @code{s}. You can test abbreviations by using them as |
| 1432 | arguments to the @code{help} command. |
| 1433 | |
| 1434 | @cindex repeating commands |
| 1435 | @kindex RET @r{(repeat last command)} |
| 1436 | A blank line as input to @value{GDBN} (typing just @key{RET}) means to |
| 1437 | repeat the previous command. Certain commands (for example, @code{run}) |
| 1438 | will not repeat this way; these are commands whose unintentional |
| 1439 | repetition might cause trouble and which you are unlikely to want to |
| 1440 | repeat. User-defined commands can disable this feature; see |
| 1441 | @ref{Define, dont-repeat}. |
| 1442 | |
| 1443 | The @code{list} and @code{x} commands, when you repeat them with |
| 1444 | @key{RET}, construct new arguments rather than repeating |
| 1445 | exactly as typed. This permits easy scanning of source or memory. |
| 1446 | |
| 1447 | @value{GDBN} can also use @key{RET} in another way: to partition lengthy |
| 1448 | output, in a way similar to the common utility @code{more} |
| 1449 | (@pxref{Screen Size,,Screen Size}). Since it is easy to press one |
| 1450 | @key{RET} too many in this situation, @value{GDBN} disables command |
| 1451 | repetition after any command that generates this sort of display. |
| 1452 | |
| 1453 | @kindex # @r{(a comment)} |
| 1454 | @cindex comment |
| 1455 | Any text from a @kbd{#} to the end of the line is a comment; it does |
| 1456 | nothing. This is useful mainly in command files (@pxref{Command |
| 1457 | Files,,Command Files}). |
| 1458 | |
| 1459 | @cindex repeating command sequences |
| 1460 | @kindex Ctrl-o @r{(operate-and-get-next)} |
| 1461 | The @kbd{Ctrl-o} binding is useful for repeating a complex sequence of |
| 1462 | commands. This command accepts the current line, like @key{RET}, and |
| 1463 | then fetches the next line relative to the current line from the history |
| 1464 | for editing. |
| 1465 | |
| 1466 | @node Completion |
| 1467 | @section Command Completion |
| 1468 | |
| 1469 | @cindex completion |
| 1470 | @cindex word completion |
| 1471 | @value{GDBN} can fill in the rest of a word in a command for you, if there is |
| 1472 | only one possibility; it can also show you what the valid possibilities |
| 1473 | are for the next word in a command, at any time. This works for @value{GDBN} |
| 1474 | commands, @value{GDBN} subcommands, and the names of symbols in your program. |
| 1475 | |
| 1476 | Press the @key{TAB} key whenever you want @value{GDBN} to fill out the rest |
| 1477 | of a word. If there is only one possibility, @value{GDBN} fills in the |
| 1478 | word, and waits for you to finish the command (or press @key{RET} to |
| 1479 | enter it). For example, if you type |
| 1480 | |
| 1481 | @c FIXME "@key" does not distinguish its argument sufficiently to permit |
| 1482 | @c complete accuracy in these examples; space introduced for clarity. |
| 1483 | @c If texinfo enhancements make it unnecessary, it would be nice to |
| 1484 | @c replace " @key" by "@key" in the following... |
| 1485 | @smallexample |
| 1486 | (@value{GDBP}) info bre @key{TAB} |
| 1487 | @end smallexample |
| 1488 | |
| 1489 | @noindent |
| 1490 | @value{GDBN} fills in the rest of the word @samp{breakpoints}, since that is |
| 1491 | the only @code{info} subcommand beginning with @samp{bre}: |
| 1492 | |
| 1493 | @smallexample |
| 1494 | (@value{GDBP}) info breakpoints |
| 1495 | @end smallexample |
| 1496 | |
| 1497 | @noindent |
| 1498 | You can either press @key{RET} at this point, to run the @code{info |
| 1499 | breakpoints} command, or backspace and enter something else, if |
| 1500 | @samp{breakpoints} does not look like the command you expected. (If you |
| 1501 | were sure you wanted @code{info breakpoints} in the first place, you |
| 1502 | might as well just type @key{RET} immediately after @samp{info bre}, |
| 1503 | to exploit command abbreviations rather than command completion). |
| 1504 | |
| 1505 | If there is more than one possibility for the next word when you press |
| 1506 | @key{TAB}, @value{GDBN} sounds a bell. You can either supply more |
| 1507 | characters and try again, or just press @key{TAB} a second time; |
| 1508 | @value{GDBN} displays all the possible completions for that word. For |
| 1509 | example, you might want to set a breakpoint on a subroutine whose name |
| 1510 | begins with @samp{make_}, but when you type @kbd{b make_@key{TAB}} @value{GDBN} |
| 1511 | just sounds the bell. Typing @key{TAB} again displays all the |
| 1512 | function names in your program that begin with those characters, for |
| 1513 | example: |
| 1514 | |
| 1515 | @smallexample |
| 1516 | (@value{GDBP}) b make_ @key{TAB} |
| 1517 | @exdent @value{GDBN} sounds bell; press @key{TAB} again, to see: |
| 1518 | make_a_section_from_file make_environ |
| 1519 | make_abs_section make_function_type |
| 1520 | make_blockvector make_pointer_type |
| 1521 | make_cleanup make_reference_type |
| 1522 | make_command make_symbol_completion_list |
| 1523 | (@value{GDBP}) b make_ |
| 1524 | @end smallexample |
| 1525 | |
| 1526 | @noindent |
| 1527 | After displaying the available possibilities, @value{GDBN} copies your |
| 1528 | partial input (@samp{b make_} in the example) so you can finish the |
| 1529 | command. |
| 1530 | |
| 1531 | If you just want to see the list of alternatives in the first place, you |
| 1532 | can press @kbd{M-?} rather than pressing @key{TAB} twice. @kbd{M-?} |
| 1533 | means @kbd{@key{META} ?}. You can type this either by holding down a |
| 1534 | key designated as the @key{META} shift on your keyboard (if there is |
| 1535 | one) while typing @kbd{?}, or as @key{ESC} followed by @kbd{?}. |
| 1536 | |
| 1537 | @cindex quotes in commands |
| 1538 | @cindex completion of quoted strings |
| 1539 | Sometimes the string you need, while logically a ``word'', may contain |
| 1540 | parentheses or other characters that @value{GDBN} normally excludes from |
| 1541 | its notion of a word. To permit word completion to work in this |
| 1542 | situation, you may enclose words in @code{'} (single quote marks) in |
| 1543 | @value{GDBN} commands. |
| 1544 | |
| 1545 | The most likely situation where you might need this is in typing the |
| 1546 | name of a C@t{++} function. This is because C@t{++} allows function |
| 1547 | overloading (multiple definitions of the same function, distinguished |
| 1548 | by argument type). For example, when you want to set a breakpoint you |
| 1549 | may need to distinguish whether you mean the version of @code{name} |
| 1550 | that takes an @code{int} parameter, @code{name(int)}, or the version |
| 1551 | that takes a @code{float} parameter, @code{name(float)}. To use the |
| 1552 | word-completion facilities in this situation, type a single quote |
| 1553 | @code{'} at the beginning of the function name. This alerts |
| 1554 | @value{GDBN} that it may need to consider more information than usual |
| 1555 | when you press @key{TAB} or @kbd{M-?} to request word completion: |
| 1556 | |
| 1557 | @smallexample |
| 1558 | (@value{GDBP}) b 'bubble( @kbd{M-?} |
| 1559 | bubble(double,double) bubble(int,int) |
| 1560 | (@value{GDBP}) b 'bubble( |
| 1561 | @end smallexample |
| 1562 | |
| 1563 | In some cases, @value{GDBN} can tell that completing a name requires using |
| 1564 | quotes. When this happens, @value{GDBN} inserts the quote for you (while |
| 1565 | completing as much as it can) if you do not type the quote in the first |
| 1566 | place: |
| 1567 | |
| 1568 | @smallexample |
| 1569 | (@value{GDBP}) b bub @key{TAB} |
| 1570 | @exdent @value{GDBN} alters your input line to the following, and rings a bell: |
| 1571 | (@value{GDBP}) b 'bubble( |
| 1572 | @end smallexample |
| 1573 | |
| 1574 | @noindent |
| 1575 | In general, @value{GDBN} can tell that a quote is needed (and inserts it) if |
| 1576 | you have not yet started typing the argument list when you ask for |
| 1577 | completion on an overloaded symbol. |
| 1578 | |
| 1579 | For more information about overloaded functions, see @ref{C Plus Plus |
| 1580 | Expressions, ,C@t{++} Expressions}. You can use the command @code{set |
| 1581 | overload-resolution off} to disable overload resolution; |
| 1582 | see @ref{Debugging C Plus Plus, ,@value{GDBN} Features for C@t{++}}. |
| 1583 | |
| 1584 | @cindex completion of structure field names |
| 1585 | @cindex structure field name completion |
| 1586 | @cindex completion of union field names |
| 1587 | @cindex union field name completion |
| 1588 | When completing in an expression which looks up a field in a |
| 1589 | structure, @value{GDBN} also tries@footnote{The completer can be |
| 1590 | confused by certain kinds of invalid expressions. Also, it only |
| 1591 | examines the static type of the expression, not the dynamic type.} to |
| 1592 | limit completions to the field names available in the type of the |
| 1593 | left-hand-side: |
| 1594 | |
| 1595 | @smallexample |
| 1596 | (@value{GDBP}) p gdb_stdout.@kbd{M-?} |
| 1597 | magic to_delete to_fputs to_put to_rewind |
| 1598 | to_data to_flush to_isatty to_read to_write |
| 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; |
| 1612 | ui_file_fputs_ftype *to_fputs; |
| 1613 | ui_file_read_ftype *to_read; |
| 1614 | ui_file_delete_ftype *to_delete; |
| 1615 | ui_file_isatty_ftype *to_isatty; |
| 1616 | ui_file_rewind_ftype *to_rewind; |
| 1617 | ui_file_put_ftype *to_put; |
| 1618 | void *to_data; |
| 1619 | @} |
| 1620 | @end smallexample |
| 1621 | |
| 1622 | |
| 1623 | @node Help |
| 1624 | @section Getting Help |
| 1625 | @cindex online documentation |
| 1626 | @kindex help |
| 1627 | |
| 1628 | You can always ask @value{GDBN} itself for information on its commands, |
| 1629 | using the command @code{help}. |
| 1630 | |
| 1631 | @table @code |
| 1632 | @kindex h @r{(@code{help})} |
| 1633 | @item help |
| 1634 | @itemx h |
| 1635 | You can use @code{help} (abbreviated @code{h}) with no arguments to |
| 1636 | display a short list of named classes of commands: |
| 1637 | |
| 1638 | @smallexample |
| 1639 | (@value{GDBP}) help |
| 1640 | List of classes of commands: |
| 1641 | |
| 1642 | aliases -- Aliases of other commands |
| 1643 | breakpoints -- Making program stop at certain points |
| 1644 | data -- Examining data |
| 1645 | files -- Specifying and examining files |
| 1646 | internals -- Maintenance commands |
| 1647 | obscure -- Obscure features |
| 1648 | running -- Running the program |
| 1649 | stack -- Examining the stack |
| 1650 | status -- Status inquiries |
| 1651 | support -- Support facilities |
| 1652 | tracepoints -- Tracing of program execution without |
| 1653 | stopping the program |
| 1654 | user-defined -- User-defined commands |
| 1655 | |
| 1656 | Type "help" followed by a class name for a list of |
| 1657 | commands in that class. |
| 1658 | Type "help" followed by command name for full |
| 1659 | documentation. |
| 1660 | Command name abbreviations are allowed if unambiguous. |
| 1661 | (@value{GDBP}) |
| 1662 | @end smallexample |
| 1663 | @c the above line break eliminates huge line overfull... |
| 1664 | |
| 1665 | @item help @var{class} |
| 1666 | Using one of the general help classes as an argument, you can get a |
| 1667 | list of the individual commands in that class. For example, here is the |
| 1668 | help display for the class @code{status}: |
| 1669 | |
| 1670 | @smallexample |
| 1671 | (@value{GDBP}) help status |
| 1672 | Status inquiries. |
| 1673 | |
| 1674 | List of commands: |
| 1675 | |
| 1676 | @c Line break in "show" line falsifies real output, but needed |
| 1677 | @c to fit in smallbook page size. |
| 1678 | info -- Generic command for showing things |
| 1679 | about the program being debugged |
| 1680 | show -- Generic command for showing things |
| 1681 | about the debugger |
| 1682 | |
| 1683 | Type "help" followed by command name for full |
| 1684 | documentation. |
| 1685 | Command name abbreviations are allowed if unambiguous. |
| 1686 | (@value{GDBP}) |
| 1687 | @end smallexample |
| 1688 | |
| 1689 | @item help @var{command} |
| 1690 | With a command name as @code{help} argument, @value{GDBN} displays a |
| 1691 | short paragraph on how to use that command. |
| 1692 | |
| 1693 | @kindex apropos |
| 1694 | @item apropos @var{args} |
| 1695 | The @code{apropos} command searches through all of the @value{GDBN} |
| 1696 | commands, and their documentation, for the regular expression specified in |
| 1697 | @var{args}. It prints out all matches found. For example: |
| 1698 | |
| 1699 | @smallexample |
| 1700 | apropos reload |
| 1701 | @end smallexample |
| 1702 | |
| 1703 | @noindent |
| 1704 | results in: |
| 1705 | |
| 1706 | @smallexample |
| 1707 | @c @group |
| 1708 | set symbol-reloading -- Set dynamic symbol table reloading |
| 1709 | multiple times in one run |
| 1710 | show symbol-reloading -- Show dynamic symbol table reloading |
| 1711 | multiple times in one run |
| 1712 | @c @end group |
| 1713 | @end smallexample |
| 1714 | |
| 1715 | @kindex complete |
| 1716 | @item complete @var{args} |
| 1717 | The @code{complete @var{args}} command lists all the possible completions |
| 1718 | for the beginning of a command. Use @var{args} to specify the beginning of the |
| 1719 | command you want completed. For example: |
| 1720 | |
| 1721 | @smallexample |
| 1722 | complete i |
| 1723 | @end smallexample |
| 1724 | |
| 1725 | @noindent results in: |
| 1726 | |
| 1727 | @smallexample |
| 1728 | @group |
| 1729 | if |
| 1730 | ignore |
| 1731 | info |
| 1732 | inspect |
| 1733 | @end group |
| 1734 | @end smallexample |
| 1735 | |
| 1736 | @noindent This is intended for use by @sc{gnu} Emacs. |
| 1737 | @end table |
| 1738 | |
| 1739 | In addition to @code{help}, you can use the @value{GDBN} commands @code{info} |
| 1740 | and @code{show} to inquire about the state of your program, or the state |
| 1741 | of @value{GDBN} itself. Each command supports many topics of inquiry; this |
| 1742 | manual introduces each of them in the appropriate context. The listings |
| 1743 | under @code{info} and under @code{show} in the Index point to |
| 1744 | all the sub-commands. @xref{Index}. |
| 1745 | |
| 1746 | @c @group |
| 1747 | @table @code |
| 1748 | @kindex info |
| 1749 | @kindex i @r{(@code{info})} |
| 1750 | @item info |
| 1751 | This command (abbreviated @code{i}) is for describing the state of your |
| 1752 | program. For example, you can show the arguments passed to a function |
| 1753 | with @code{info args}, list the registers currently in use with @code{info |
| 1754 | registers}, or list the breakpoints you have set with @code{info breakpoints}. |
| 1755 | You can get a complete list of the @code{info} sub-commands with |
| 1756 | @w{@code{help info}}. |
| 1757 | |
| 1758 | @kindex set |
| 1759 | @item set |
| 1760 | You can assign the result of an expression to an environment variable with |
| 1761 | @code{set}. For example, you can set the @value{GDBN} prompt to a $-sign with |
| 1762 | @code{set prompt $}. |
| 1763 | |
| 1764 | @kindex show |
| 1765 | @item show |
| 1766 | In contrast to @code{info}, @code{show} is for describing the state of |
| 1767 | @value{GDBN} itself. |
| 1768 | You can change most of the things you can @code{show}, by using the |
| 1769 | related command @code{set}; for example, you can control what number |
| 1770 | system is used for displays with @code{set radix}, or simply inquire |
| 1771 | which is currently in use with @code{show radix}. |
| 1772 | |
| 1773 | @kindex info set |
| 1774 | To display all the settable parameters and their current |
| 1775 | values, you can use @code{show} with no arguments; you may also use |
| 1776 | @code{info set}. Both commands produce the same display. |
| 1777 | @c FIXME: "info set" violates the rule that "info" is for state of |
| 1778 | @c FIXME...program. Ck w/ GNU: "info set" to be called something else, |
| 1779 | @c FIXME...or change desc of rule---eg "state of prog and debugging session"? |
| 1780 | @end table |
| 1781 | @c @end group |
| 1782 | |
| 1783 | Here are three miscellaneous @code{show} subcommands, all of which are |
| 1784 | exceptional in lacking corresponding @code{set} commands: |
| 1785 | |
| 1786 | @table @code |
| 1787 | @kindex show version |
| 1788 | @cindex @value{GDBN} version number |
| 1789 | @item show version |
| 1790 | Show what version of @value{GDBN} is running. You should include this |
| 1791 | information in @value{GDBN} bug-reports. If multiple versions of |
| 1792 | @value{GDBN} are in use at your site, you may need to determine which |
| 1793 | version of @value{GDBN} you are running; as @value{GDBN} evolves, new |
| 1794 | commands are introduced, and old ones may wither away. Also, many |
| 1795 | system vendors ship variant versions of @value{GDBN}, and there are |
| 1796 | variant versions of @value{GDBN} in @sc{gnu}/Linux distributions as well. |
| 1797 | The version number is the same as the one announced when you start |
| 1798 | @value{GDBN}. |
| 1799 | |
| 1800 | @kindex show copying |
| 1801 | @kindex info copying |
| 1802 | @cindex display @value{GDBN} copyright |
| 1803 | @item show copying |
| 1804 | @itemx info copying |
| 1805 | Display information about permission for copying @value{GDBN}. |
| 1806 | |
| 1807 | @kindex show warranty |
| 1808 | @kindex info warranty |
| 1809 | @item show warranty |
| 1810 | @itemx info warranty |
| 1811 | Display the @sc{gnu} ``NO WARRANTY'' statement, or a warranty, |
| 1812 | if your version of @value{GDBN} comes with one. |
| 1813 | |
| 1814 | @end table |
| 1815 | |
| 1816 | @node Running |
| 1817 | @chapter Running Programs Under @value{GDBN} |
| 1818 | |
| 1819 | When you run a program under @value{GDBN}, you must first generate |
| 1820 | debugging information when you compile it. |
| 1821 | |
| 1822 | You may start @value{GDBN} with its arguments, if any, in an environment |
| 1823 | of your choice. If you are doing native debugging, you may redirect |
| 1824 | your program's input and output, debug an already running process, or |
| 1825 | kill a child process. |
| 1826 | |
| 1827 | @menu |
| 1828 | * Compilation:: Compiling for debugging |
| 1829 | * Starting:: Starting your program |
| 1830 | * Arguments:: Your program's arguments |
| 1831 | * Environment:: Your program's environment |
| 1832 | |
| 1833 | * Working Directory:: Your program's working directory |
| 1834 | * Input/Output:: Your program's input and output |
| 1835 | * Attach:: Debugging an already-running process |
| 1836 | * Kill Process:: Killing the child process |
| 1837 | |
| 1838 | * Inferiors and Programs:: Debugging multiple inferiors and programs |
| 1839 | * Threads:: Debugging programs with multiple threads |
| 1840 | * Forks:: Debugging forks |
| 1841 | * Checkpoint/Restart:: Setting a @emph{bookmark} to return to later |
| 1842 | @end menu |
| 1843 | |
| 1844 | @node Compilation |
| 1845 | @section Compiling for Debugging |
| 1846 | |
| 1847 | In order to debug a program effectively, you need to generate |
| 1848 | debugging information when you compile it. This debugging information |
| 1849 | is stored in the object file; it describes the data type of each |
| 1850 | variable or function and the correspondence between source line numbers |
| 1851 | and addresses in the executable code. |
| 1852 | |
| 1853 | To request debugging information, specify the @samp{-g} option when you run |
| 1854 | the compiler. |
| 1855 | |
| 1856 | Programs that are to be shipped to your customers are compiled with |
| 1857 | optimizations, using the @samp{-O} compiler option. However, some |
| 1858 | compilers are unable to handle the @samp{-g} and @samp{-O} options |
| 1859 | together. Using those compilers, you cannot generate optimized |
| 1860 | executables containing debugging information. |
| 1861 | |
| 1862 | @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, supports @samp{-g} with or |
| 1863 | without @samp{-O}, making it possible to debug optimized code. We |
| 1864 | recommend that you @emph{always} use @samp{-g} whenever you compile a |
| 1865 | program. You may think your program is correct, but there is no sense |
| 1866 | in pushing your luck. For more information, see @ref{Optimized Code}. |
| 1867 | |
| 1868 | Older versions of the @sc{gnu} C compiler permitted a variant option |
| 1869 | @w{@samp{-gg}} for debugging information. @value{GDBN} no longer supports this |
| 1870 | format; if your @sc{gnu} C compiler has this option, do not use it. |
| 1871 | |
| 1872 | @value{GDBN} knows about preprocessor macros and can show you their |
| 1873 | expansion (@pxref{Macros}). Most compilers do not include information |
| 1874 | about preprocessor macros in the debugging information if you specify |
| 1875 | the @option{-g} flag alone, because this information is rather large. |
| 1876 | Version 3.1 and later of @value{NGCC}, the @sc{gnu} C compiler, |
| 1877 | provides macro information if you specify the options |
| 1878 | @option{-gdwarf-2} and @option{-g3}; the former option requests |
| 1879 | debugging information in the Dwarf 2 format, and the latter requests |
| 1880 | ``extra information''. In the future, we hope to find more compact |
| 1881 | ways to represent macro information, so that it can be included with |
| 1882 | @option{-g} alone. |
| 1883 | |
| 1884 | @need 2000 |
| 1885 | @node Starting |
| 1886 | @section Starting your Program |
| 1887 | @cindex starting |
| 1888 | @cindex running |
| 1889 | |
| 1890 | @table @code |
| 1891 | @kindex run |
| 1892 | @kindex r @r{(@code{run})} |
| 1893 | @item run |
| 1894 | @itemx r |
| 1895 | Use the @code{run} command to start your program under @value{GDBN}. |
| 1896 | You must first specify the program name (except on VxWorks) with an |
| 1897 | argument to @value{GDBN} (@pxref{Invocation, ,Getting In and Out of |
| 1898 | @value{GDBN}}), or by using the @code{file} or @code{exec-file} command |
| 1899 | (@pxref{Files, ,Commands to Specify Files}). |
| 1900 | |
| 1901 | @end table |
| 1902 | |
| 1903 | If you are running your program in an execution environment that |
| 1904 | supports processes, @code{run} creates an inferior process and makes |
| 1905 | that process run your program. In some environments without processes, |
| 1906 | @code{run} jumps to the start of your program. Other targets, |
| 1907 | like @samp{remote}, are always running. If you get an error |
| 1908 | message like this one: |
| 1909 | |
| 1910 | @smallexample |
| 1911 | The "remote" target does not support "run". |
| 1912 | Try "help target" or "continue". |
| 1913 | @end smallexample |
| 1914 | |
| 1915 | @noindent |
| 1916 | then use @code{continue} to run your program. You may need @code{load} |
| 1917 | first (@pxref{load}). |
| 1918 | |
| 1919 | The execution of a program is affected by certain information it |
| 1920 | receives from its superior. @value{GDBN} provides ways to specify this |
| 1921 | information, which you must do @emph{before} starting your program. (You |
| 1922 | can change it after starting your program, but such changes only affect |
| 1923 | your program the next time you start it.) This information may be |
| 1924 | divided into four categories: |
| 1925 | |
| 1926 | @table @asis |
| 1927 | @item The @emph{arguments.} |
| 1928 | Specify the arguments to give your program as the arguments of the |
| 1929 | @code{run} command. If a shell is available on your target, the shell |
| 1930 | is used to pass the arguments, so that you may use normal conventions |
| 1931 | (such as wildcard expansion or variable substitution) in describing |
| 1932 | the arguments. |
| 1933 | In Unix systems, you can control which shell is used with the |
| 1934 | @code{SHELL} environment variable. |
| 1935 | @xref{Arguments, ,Your Program's Arguments}. |
| 1936 | |
| 1937 | @item The @emph{environment.} |
| 1938 | Your program normally inherits its environment from @value{GDBN}, but you can |
| 1939 | use the @value{GDBN} commands @code{set environment} and @code{unset |
| 1940 | environment} to change parts of the environment that affect |
| 1941 | your program. @xref{Environment, ,Your Program's Environment}. |
| 1942 | |
| 1943 | @item The @emph{working directory.} |
| 1944 | Your program inherits its working directory from @value{GDBN}. You can set |
| 1945 | the @value{GDBN} working directory with the @code{cd} command in @value{GDBN}. |
| 1946 | @xref{Working Directory, ,Your Program's Working Directory}. |
| 1947 | |
| 1948 | @item The @emph{standard input and output.} |
| 1949 | Your program normally uses the same device for standard input and |
| 1950 | standard output as @value{GDBN} is using. You can redirect input and output |
| 1951 | in the @code{run} command line, or you can use the @code{tty} command to |
| 1952 | set a different device for your program. |
| 1953 | @xref{Input/Output, ,Your Program's Input and Output}. |
| 1954 | |
| 1955 | @cindex pipes |
| 1956 | @emph{Warning:} While input and output redirection work, you cannot use |
| 1957 | pipes to pass the output of the program you are debugging to another |
| 1958 | program; if you attempt this, @value{GDBN} is likely to wind up debugging the |
| 1959 | wrong program. |
| 1960 | @end table |
| 1961 | |
| 1962 | When you issue the @code{run} command, your program begins to execute |
| 1963 | immediately. @xref{Stopping, ,Stopping and Continuing}, for discussion |
| 1964 | of how to arrange for your program to stop. Once your program has |
| 1965 | stopped, you may call functions in your program, using the @code{print} |
| 1966 | or @code{call} commands. @xref{Data, ,Examining Data}. |
| 1967 | |
| 1968 | If the modification time of your symbol file has changed since the last |
| 1969 | time @value{GDBN} read its symbols, @value{GDBN} discards its symbol |
| 1970 | table, and reads it again. When it does this, @value{GDBN} tries to retain |
| 1971 | your current breakpoints. |
| 1972 | |
| 1973 | @table @code |
| 1974 | @kindex start |
| 1975 | @item start |
| 1976 | @cindex run to main procedure |
| 1977 | The name of the main procedure can vary from language to language. |
| 1978 | With C or C@t{++}, the main procedure name is always @code{main}, but |
| 1979 | other languages such as Ada do not require a specific name for their |
| 1980 | main procedure. The debugger provides a convenient way to start the |
| 1981 | execution of the program and to stop at the beginning of the main |
| 1982 | procedure, depending on the language used. |
| 1983 | |
| 1984 | The @samp{start} command does the equivalent of setting a temporary |
| 1985 | breakpoint at the beginning of the main procedure and then invoking |
| 1986 | the @samp{run} command. |
| 1987 | |
| 1988 | @cindex elaboration phase |
| 1989 | Some programs contain an @dfn{elaboration} phase where some startup code is |
| 1990 | executed before the main procedure is called. This depends on the |
| 1991 | languages used to write your program. In C@t{++}, for instance, |
| 1992 | constructors for static and global objects are executed before |
| 1993 | @code{main} is called. It is therefore possible that the debugger stops |
| 1994 | before reaching the main procedure. However, the temporary breakpoint |
| 1995 | will remain to halt execution. |
| 1996 | |
| 1997 | Specify the arguments to give to your program as arguments to the |
| 1998 | @samp{start} command. These arguments will be given verbatim to the |
| 1999 | underlying @samp{run} command. Note that the same arguments will be |
| 2000 | reused if no argument is provided during subsequent calls to |
| 2001 | @samp{start} or @samp{run}. |
| 2002 | |
| 2003 | It is sometimes necessary to debug the program during elaboration. In |
| 2004 | these cases, using the @code{start} command would stop the execution of |
| 2005 | your program too late, as the program would have already completed the |
| 2006 | elaboration phase. Under these circumstances, insert breakpoints in your |
| 2007 | elaboration code before running your program. |
| 2008 | |
| 2009 | @kindex set exec-wrapper |
| 2010 | @item set exec-wrapper @var{wrapper} |
| 2011 | @itemx show exec-wrapper |
| 2012 | @itemx unset exec-wrapper |
| 2013 | When @samp{exec-wrapper} is set, the specified wrapper is used to |
| 2014 | launch programs for debugging. @value{GDBN} starts your program |
| 2015 | with a shell command of the form @kbd{exec @var{wrapper} |
| 2016 | @var{program}}. Quoting is added to @var{program} and its |
| 2017 | arguments, but not to @var{wrapper}, so you should add quotes if |
| 2018 | appropriate for your shell. The wrapper runs until it executes |
| 2019 | your program, and then @value{GDBN} takes control. |
| 2020 | |
| 2021 | You can use any program that eventually calls @code{execve} with |
| 2022 | its arguments as a wrapper. Several standard Unix utilities do |
| 2023 | this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending |
| 2024 | with @code{exec "$@@"} will also work. |
| 2025 | |
| 2026 | For example, you can use @code{env} to pass an environment variable to |
| 2027 | the debugged program, without setting the variable in your shell's |
| 2028 | environment: |
| 2029 | |
| 2030 | @smallexample |
| 2031 | (@value{GDBP}) set exec-wrapper env 'LD_PRELOAD=libtest.so' |
| 2032 | (@value{GDBP}) run |
| 2033 | @end smallexample |
| 2034 | |
| 2035 | This command is available when debugging locally on most targets, excluding |
| 2036 | @sc{djgpp}, Cygwin, MS Windows, and QNX Neutrino. |
| 2037 | |
| 2038 | @kindex set disable-randomization |
| 2039 | @item set disable-randomization |
| 2040 | @itemx set disable-randomization on |
| 2041 | This option (enabled by default in @value{GDBN}) will turn off the native |
| 2042 | randomization of the virtual address space of the started program. This option |
| 2043 | is useful for multiple debugging sessions to make the execution better |
| 2044 | reproducible and memory addresses reusable across debugging sessions. |
| 2045 | |
| 2046 | This feature is implemented only on @sc{gnu}/Linux. You can get the same |
| 2047 | behavior using |
| 2048 | |
| 2049 | @smallexample |
| 2050 | (@value{GDBP}) set exec-wrapper setarch `uname -m` -R |
| 2051 | @end smallexample |
| 2052 | |
| 2053 | @item set disable-randomization off |
| 2054 | Leave the behavior of the started executable unchanged. Some bugs rear their |
| 2055 | ugly heads only when the program is loaded at certain addresses. If your bug |
| 2056 | disappears when you run the program under @value{GDBN}, that might be because |
| 2057 | @value{GDBN} by default disables the address randomization on platforms, such |
| 2058 | as @sc{gnu}/Linux, which do that for stand-alone programs. Use @kbd{set |
| 2059 | disable-randomization off} to try to reproduce such elusive bugs. |
| 2060 | |
| 2061 | The virtual address space randomization is implemented only on @sc{gnu}/Linux. |
| 2062 | It protects the programs against some kinds of security attacks. In these |
| 2063 | cases the attacker needs to know the exact location of a concrete executable |
| 2064 | code. Randomizing its location makes it impossible to inject jumps misusing |
| 2065 | a code at its expected addresses. |
| 2066 | |
| 2067 | Prelinking shared libraries provides a startup performance advantage but it |
| 2068 | makes addresses in these libraries predictable for privileged processes by |
| 2069 | having just unprivileged access at the target system. Reading the shared |
| 2070 | library binary gives enough information for assembling the malicious code |
| 2071 | misusing it. Still even a prelinked shared library can get loaded at a new |
| 2072 | random address just requiring the regular relocation process during the |
| 2073 | startup. Shared libraries not already prelinked are always loaded at |
| 2074 | a randomly chosen address. |
| 2075 | |
| 2076 | Position independent executables (PIE) contain position independent code |
| 2077 | similar to the shared libraries and therefore such executables get loaded at |
| 2078 | a randomly chosen address upon startup. PIE executables always load even |
| 2079 | already prelinked shared libraries at a random address. You can build such |
| 2080 | executable using @command{gcc -fPIE -pie}. |
| 2081 | |
| 2082 | Heap (malloc storage), stack and custom mmap areas are always placed randomly |
| 2083 | (as long as the randomization is enabled). |
| 2084 | |
| 2085 | @item show disable-randomization |
| 2086 | Show the current setting of the explicit disable of the native randomization of |
| 2087 | the virtual address space of the started program. |
| 2088 | |
| 2089 | @end table |
| 2090 | |
| 2091 | @node Arguments |
| 2092 | @section Your Program's Arguments |
| 2093 | |
| 2094 | @cindex arguments (to your program) |
| 2095 | The arguments to your program can be specified by the arguments of the |
| 2096 | @code{run} command. |
| 2097 | They are passed to a shell, which expands wildcard characters and |
| 2098 | performs redirection of I/O, and thence to your program. Your |
| 2099 | @code{SHELL} environment variable (if it exists) specifies what shell |
| 2100 | @value{GDBN} uses. If you do not define @code{SHELL}, @value{GDBN} uses |
| 2101 | the default shell (@file{/bin/sh} on Unix). |
| 2102 | |
| 2103 | On non-Unix systems, the program is usually invoked directly by |
| 2104 | @value{GDBN}, which emulates I/O redirection via the appropriate system |
| 2105 | calls, and the wildcard characters are expanded by the startup code of |
| 2106 | the program, not by the shell. |
| 2107 | |
| 2108 | @code{run} with no arguments uses the same arguments used by the previous |
| 2109 | @code{run}, or those set by the @code{set args} command. |
| 2110 | |
| 2111 | @table @code |
| 2112 | @kindex set args |
| 2113 | @item set args |
| 2114 | Specify the arguments to be used the next time your program is run. If |
| 2115 | @code{set args} has no arguments, @code{run} executes your program |
| 2116 | with no arguments. Once you have run your program with arguments, |
| 2117 | using @code{set args} before the next @code{run} is the only way to run |
| 2118 | it again without arguments. |
| 2119 | |
| 2120 | @kindex show args |
| 2121 | @item show args |
| 2122 | Show the arguments to give your program when it is started. |
| 2123 | @end table |
| 2124 | |
| 2125 | @node Environment |
| 2126 | @section Your Program's Environment |
| 2127 | |
| 2128 | @cindex environment (of your program) |
| 2129 | The @dfn{environment} consists of a set of environment variables and |
| 2130 | their values. Environment variables conventionally record such things as |
| 2131 | your user name, your home directory, your terminal type, and your search |
| 2132 | path for programs to run. Usually you set up environment variables with |
| 2133 | the shell and they are inherited by all the other programs you run. When |
| 2134 | debugging, it can be useful to try running your program with a modified |
| 2135 | environment without having to start @value{GDBN} over again. |
| 2136 | |
| 2137 | @table @code |
| 2138 | @kindex path |
| 2139 | @item path @var{directory} |
| 2140 | Add @var{directory} to the front of the @code{PATH} environment variable |
| 2141 | (the search path for executables) that will be passed to your program. |
| 2142 | The value of @code{PATH} used by @value{GDBN} does not change. |
| 2143 | You may specify several directory names, separated by whitespace or by a |
| 2144 | system-dependent separator character (@samp{:} on Unix, @samp{;} on |
| 2145 | MS-DOS and MS-Windows). If @var{directory} is already in the path, it |
| 2146 | is moved to the front, so it is searched sooner. |
| 2147 | |
| 2148 | You can use the string @samp{$cwd} to refer to whatever is the current |
| 2149 | working directory at the time @value{GDBN} searches the path. If you |
| 2150 | use @samp{.} instead, it refers to the directory where you executed the |
| 2151 | @code{path} command. @value{GDBN} replaces @samp{.} in the |
| 2152 | @var{directory} argument (with the current path) before adding |
| 2153 | @var{directory} to the search path. |
| 2154 | @c 'path' is explicitly nonrepeatable, but RMS points out it is silly to |
| 2155 | @c document that, since repeating it would be a no-op. |
| 2156 | |
| 2157 | @kindex show paths |
| 2158 | @item show paths |
| 2159 | Display the list of search paths for executables (the @code{PATH} |
| 2160 | environment variable). |
| 2161 | |
| 2162 | @kindex show environment |
| 2163 | @item show environment @r{[}@var{varname}@r{]} |
| 2164 | Print the value of environment variable @var{varname} to be given to |
| 2165 | your program when it starts. If you do not supply @var{varname}, |
| 2166 | print the names and values of all environment variables to be given to |
| 2167 | your program. You can abbreviate @code{environment} as @code{env}. |
| 2168 | |
| 2169 | @kindex set environment |
| 2170 | @item set environment @var{varname} @r{[}=@var{value}@r{]} |
| 2171 | Set environment variable @var{varname} to @var{value}. The value |
| 2172 | changes for your program only, not for @value{GDBN} itself. @var{value} may |
| 2173 | be any string; the values of environment variables are just strings, and |
| 2174 | any interpretation is supplied by your program itself. The @var{value} |
| 2175 | parameter is optional; if it is eliminated, the variable is set to a |
| 2176 | null value. |
| 2177 | @c "any string" here does not include leading, trailing |
| 2178 | @c blanks. Gnu asks: does anyone care? |
| 2179 | |
| 2180 | For example, this command: |
| 2181 | |
| 2182 | @smallexample |
| 2183 | set env USER = foo |
| 2184 | @end smallexample |
| 2185 | |
| 2186 | @noindent |
| 2187 | tells the debugged program, when subsequently run, that its user is named |
| 2188 | @samp{foo}. (The spaces around @samp{=} are used for clarity here; they |
| 2189 | are not actually required.) |
| 2190 | |
| 2191 | @kindex unset environment |
| 2192 | @item unset environment @var{varname} |
| 2193 | Remove variable @var{varname} from the environment to be passed to your |
| 2194 | program. This is different from @samp{set env @var{varname} =}; |
| 2195 | @code{unset environment} removes the variable from the environment, |
| 2196 | rather than assigning it an empty value. |
| 2197 | @end table |
| 2198 | |
| 2199 | @emph{Warning:} On Unix systems, @value{GDBN} runs your program using |
| 2200 | the shell indicated |
| 2201 | by your @code{SHELL} environment variable if it exists (or |
| 2202 | @code{/bin/sh} if not). If your @code{SHELL} variable names a shell |
| 2203 | that runs an initialization file---such as @file{.cshrc} for C-shell, or |
| 2204 | @file{.bashrc} for BASH---any variables you set in that file affect |
| 2205 | your program. You may wish to move setting of environment variables to |
| 2206 | files that are only run when you sign on, such as @file{.login} or |
| 2207 | @file{.profile}. |
| 2208 | |
| 2209 | @node Working Directory |
| 2210 | @section Your Program's Working Directory |
| 2211 | |
| 2212 | @cindex working directory (of your program) |
| 2213 | Each time you start your program with @code{run}, it inherits its |
| 2214 | working directory from the current working directory of @value{GDBN}. |
| 2215 | The @value{GDBN} working directory is initially whatever it inherited |
| 2216 | from its parent process (typically the shell), but you can specify a new |
| 2217 | working directory in @value{GDBN} with the @code{cd} command. |
| 2218 | |
| 2219 | The @value{GDBN} working directory also serves as a default for the commands |
| 2220 | that specify files for @value{GDBN} to operate on. @xref{Files, ,Commands to |
| 2221 | Specify Files}. |
| 2222 | |
| 2223 | @table @code |
| 2224 | @kindex cd |
| 2225 | @cindex change working directory |
| 2226 | @item cd @var{directory} |
| 2227 | Set the @value{GDBN} working directory to @var{directory}. |
| 2228 | |
| 2229 | @kindex pwd |
| 2230 | @item pwd |
| 2231 | Print the @value{GDBN} working directory. |
| 2232 | @end table |
| 2233 | |
| 2234 | It is generally impossible to find the current working directory of |
| 2235 | the process being debugged (since a program can change its directory |
| 2236 | during its run). If you work on a system where @value{GDBN} is |
| 2237 | configured with the @file{/proc} support, you can use the @code{info |
| 2238 | proc} command (@pxref{SVR4 Process Information}) to find out the |
| 2239 | current working directory of the debuggee. |
| 2240 | |
| 2241 | @node Input/Output |
| 2242 | @section Your Program's Input and Output |
| 2243 | |
| 2244 | @cindex redirection |
| 2245 | @cindex i/o |
| 2246 | @cindex terminal |
| 2247 | By default, the program you run under @value{GDBN} does input and output to |
| 2248 | the same terminal that @value{GDBN} uses. @value{GDBN} switches the terminal |
| 2249 | to its own terminal modes to interact with you, but it records the terminal |
| 2250 | modes your program was using and switches back to them when you continue |
| 2251 | running your program. |
| 2252 | |
| 2253 | @table @code |
| 2254 | @kindex info terminal |
| 2255 | @item info terminal |
| 2256 | Displays information recorded by @value{GDBN} about the terminal modes your |
| 2257 | program is using. |
| 2258 | @end table |
| 2259 | |
| 2260 | You can redirect your program's input and/or output using shell |
| 2261 | redirection with the @code{run} command. For example, |
| 2262 | |
| 2263 | @smallexample |
| 2264 | run > outfile |
| 2265 | @end smallexample |
| 2266 | |
| 2267 | @noindent |
| 2268 | starts your program, diverting its output to the file @file{outfile}. |
| 2269 | |
| 2270 | @kindex tty |
| 2271 | @cindex controlling terminal |
| 2272 | Another way to specify where your program should do input and output is |
| 2273 | with the @code{tty} command. This command accepts a file name as |
| 2274 | argument, and causes this file to be the default for future @code{run} |
| 2275 | commands. It also resets the controlling terminal for the child |
| 2276 | process, for future @code{run} commands. For example, |
| 2277 | |
| 2278 | @smallexample |
| 2279 | tty /dev/ttyb |
| 2280 | @end smallexample |
| 2281 | |
| 2282 | @noindent |
| 2283 | directs that processes started with subsequent @code{run} commands |
| 2284 | default to do input and output on the terminal @file{/dev/ttyb} and have |
| 2285 | that as their controlling terminal. |
| 2286 | |
| 2287 | An explicit redirection in @code{run} overrides the @code{tty} command's |
| 2288 | effect on the input/output device, but not its effect on the controlling |
| 2289 | terminal. |
| 2290 | |
| 2291 | When you use the @code{tty} command or redirect input in the @code{run} |
| 2292 | command, only the input @emph{for your program} is affected. The input |
| 2293 | for @value{GDBN} still comes from your terminal. @code{tty} is an alias |
| 2294 | for @code{set inferior-tty}. |
| 2295 | |
| 2296 | @cindex inferior tty |
| 2297 | @cindex set inferior controlling terminal |
| 2298 | You can use the @code{show inferior-tty} command to tell @value{GDBN} to |
| 2299 | display the name of the terminal that will be used for future runs of your |
| 2300 | program. |
| 2301 | |
| 2302 | @table @code |
| 2303 | @item set inferior-tty /dev/ttyb |
| 2304 | @kindex set inferior-tty |
| 2305 | Set the tty for the program being debugged to /dev/ttyb. |
| 2306 | |
| 2307 | @item show inferior-tty |
| 2308 | @kindex show inferior-tty |
| 2309 | Show the current tty for the program being debugged. |
| 2310 | @end table |
| 2311 | |
| 2312 | @node Attach |
| 2313 | @section Debugging an Already-running Process |
| 2314 | @kindex attach |
| 2315 | @cindex attach |
| 2316 | |
| 2317 | @table @code |
| 2318 | @item attach @var{process-id} |
| 2319 | This command attaches to a running process---one that was started |
| 2320 | outside @value{GDBN}. (@code{info files} shows your active |
| 2321 | targets.) The command takes as argument a process ID. The usual way to |
| 2322 | find out the @var{process-id} of a Unix process is with the @code{ps} utility, |
| 2323 | or with the @samp{jobs -l} shell command. |
| 2324 | |
| 2325 | @code{attach} does not repeat if you press @key{RET} a second time after |
| 2326 | executing the command. |
| 2327 | @end table |
| 2328 | |
| 2329 | To use @code{attach}, your program must be running in an environment |
| 2330 | which supports processes; for example, @code{attach} does not work for |
| 2331 | programs on bare-board targets that lack an operating system. You must |
| 2332 | also have permission to send the process a signal. |
| 2333 | |
| 2334 | When you use @code{attach}, the debugger finds the program running in |
| 2335 | the process first by looking in the current working directory, then (if |
| 2336 | the program is not found) by using the source file search path |
| 2337 | (@pxref{Source Path, ,Specifying Source Directories}). You can also use |
| 2338 | the @code{file} command to load the program. @xref{Files, ,Commands to |
| 2339 | Specify Files}. |
| 2340 | |
| 2341 | The first thing @value{GDBN} does after arranging to debug the specified |
| 2342 | process is to stop it. You can examine and modify an attached process |
| 2343 | with all the @value{GDBN} commands that are ordinarily available when |
| 2344 | you start processes with @code{run}. You can insert breakpoints; you |
| 2345 | can step and continue; you can modify storage. If you would rather the |
| 2346 | process continue running, you may use the @code{continue} command after |
| 2347 | attaching @value{GDBN} to the process. |
| 2348 | |
| 2349 | @table @code |
| 2350 | @kindex detach |
| 2351 | @item detach |
| 2352 | When you have finished debugging the attached process, you can use the |
| 2353 | @code{detach} command to release it from @value{GDBN} control. Detaching |
| 2354 | the process continues its execution. After the @code{detach} command, |
| 2355 | that process and @value{GDBN} become completely independent once more, and you |
| 2356 | are ready to @code{attach} another process or start one with @code{run}. |
| 2357 | @code{detach} does not repeat if you press @key{RET} again after |
| 2358 | executing the command. |
| 2359 | @end table |
| 2360 | |
| 2361 | If you exit @value{GDBN} while you have an attached process, you detach |
| 2362 | that process. If you use the @code{run} command, you kill that process. |
| 2363 | By default, @value{GDBN} asks for confirmation if you try to do either of these |
| 2364 | things; you can control whether or not you need to confirm by using the |
| 2365 | @code{set confirm} command (@pxref{Messages/Warnings, ,Optional Warnings and |
| 2366 | Messages}). |
| 2367 | |
| 2368 | @node Kill Process |
| 2369 | @section Killing the Child Process |
| 2370 | |
| 2371 | @table @code |
| 2372 | @kindex kill |
| 2373 | @item kill |
| 2374 | Kill the child process in which your program is running under @value{GDBN}. |
| 2375 | @end table |
| 2376 | |
| 2377 | This command is useful if you wish to debug a core dump instead of a |
| 2378 | running process. @value{GDBN} ignores any core dump file while your program |
| 2379 | is running. |
| 2380 | |
| 2381 | On some operating systems, a program cannot be executed outside @value{GDBN} |
| 2382 | while you have breakpoints set on it inside @value{GDBN}. You can use the |
| 2383 | @code{kill} command in this situation to permit running your program |
| 2384 | outside the debugger. |
| 2385 | |
| 2386 | The @code{kill} command is also useful if you wish to recompile and |
| 2387 | relink your program, since on many systems it is impossible to modify an |
| 2388 | executable file while it is running in a process. In this case, when you |
| 2389 | next type @code{run}, @value{GDBN} notices that the file has changed, and |
| 2390 | reads the symbol table again (while trying to preserve your current |
| 2391 | breakpoint settings). |
| 2392 | |
| 2393 | @node Inferiors and Programs |
| 2394 | @section Debugging Multiple Inferiors and Programs |
| 2395 | |
| 2396 | @value{GDBN} lets you run and debug multiple programs in a single |
| 2397 | session. In addition, @value{GDBN} on some systems may let you run |
| 2398 | several programs simultaneously (otherwise you have to exit from one |
| 2399 | before starting another). In the most general case, you can have |
| 2400 | multiple threads of execution in each of multiple processes, launched |
| 2401 | from multiple executables. |
| 2402 | |
| 2403 | @cindex inferior |
| 2404 | @value{GDBN} represents the state of each program execution with an |
| 2405 | object called an @dfn{inferior}. An inferior typically corresponds to |
| 2406 | a process, but is more general and applies also to targets that do not |
| 2407 | have processes. Inferiors may be created before a process runs, and |
| 2408 | may be retained after a process exits. Inferiors have unique |
| 2409 | identifiers that are different from process ids. Usually each |
| 2410 | inferior will also have its own distinct address space, although some |
| 2411 | embedded targets may have several inferiors running in different parts |
| 2412 | of a single address space. Each inferior may in turn have multiple |
| 2413 | threads running in it. |
| 2414 | |
| 2415 | To find out what inferiors exist at any moment, use @w{@code{info |
| 2416 | inferiors}}: |
| 2417 | |
| 2418 | @table @code |
| 2419 | @kindex info inferiors |
| 2420 | @item info inferiors |
| 2421 | Print a list of all inferiors currently being managed by @value{GDBN}. |
| 2422 | |
| 2423 | @value{GDBN} displays for each inferior (in this order): |
| 2424 | |
| 2425 | @enumerate |
| 2426 | @item |
| 2427 | the inferior number assigned by @value{GDBN} |
| 2428 | |
| 2429 | @item |
| 2430 | the target system's inferior identifier |
| 2431 | |
| 2432 | @item |
| 2433 | the name of the executable the inferior is running. |
| 2434 | |
| 2435 | @end enumerate |
| 2436 | |
| 2437 | @noindent |
| 2438 | An asterisk @samp{*} preceding the @value{GDBN} inferior number |
| 2439 | indicates the current inferior. |
| 2440 | |
| 2441 | For example, |
| 2442 | @end table |
| 2443 | @c end table here to get a little more width for example |
| 2444 | |
| 2445 | @smallexample |
| 2446 | (@value{GDBP}) info inferiors |
| 2447 | Num Description Executable |
| 2448 | 2 process 2307 hello |
| 2449 | * 1 process 3401 goodbye |
| 2450 | @end smallexample |
| 2451 | |
| 2452 | To switch focus between inferiors, use the @code{inferior} command: |
| 2453 | |
| 2454 | @table @code |
| 2455 | @kindex inferior @var{infno} |
| 2456 | @item inferior @var{infno} |
| 2457 | Make inferior number @var{infno} the current inferior. The argument |
| 2458 | @var{infno} is the inferior number assigned by @value{GDBN}, as shown |
| 2459 | in the first field of the @samp{info inferiors} display. |
| 2460 | @end table |
| 2461 | |
| 2462 | |
| 2463 | You can get multiple executables into a debugging session via the |
| 2464 | @code{add-inferior} and @w{@code{clone-inferior}} commands. On some |
| 2465 | systems @value{GDBN} can add inferiors to the debug session |
| 2466 | automatically by following calls to @code{fork} and @code{exec}. To |
| 2467 | remove inferiors from the debugging session use the |
| 2468 | @w{@code{remove-inferiors}} command. |
| 2469 | |
| 2470 | @table @code |
| 2471 | @kindex add-inferior |
| 2472 | @item add-inferior [ -copies @var{n} ] [ -exec @var{executable} ] |
| 2473 | Adds @var{n} inferiors to be run using @var{executable} as the |
| 2474 | executable. @var{n} defaults to 1. If no executable is specified, |
| 2475 | the inferiors begins empty, with no program. You can still assign or |
| 2476 | change the program assigned to the inferior at any time by using the |
| 2477 | @code{file} command with the executable name as its argument. |
| 2478 | |
| 2479 | @kindex clone-inferior |
| 2480 | @item clone-inferior [ -copies @var{n} ] [ @var{infno} ] |
| 2481 | Adds @var{n} inferiors ready to execute the same program as inferior |
| 2482 | @var{infno}. @var{n} defaults to 1. @var{infno} defaults to the |
| 2483 | number of the current inferior. This is a convenient command when you |
| 2484 | want to run another instance of the inferior you are debugging. |
| 2485 | |
| 2486 | @smallexample |
| 2487 | (@value{GDBP}) info inferiors |
| 2488 | Num Description Executable |
| 2489 | * 1 process 29964 helloworld |
| 2490 | (@value{GDBP}) clone-inferior |
| 2491 | Added inferior 2. |
| 2492 | 1 inferiors added. |
| 2493 | (@value{GDBP}) info inferiors |
| 2494 | Num Description Executable |
| 2495 | 2 <null> helloworld |
| 2496 | * 1 process 29964 helloworld |
| 2497 | @end smallexample |
| 2498 | |
| 2499 | You can now simply switch focus to inferior 2 and run it. |
| 2500 | |
| 2501 | @kindex remove-inferiors |
| 2502 | @item remove-inferiors @var{infno}@dots{} |
| 2503 | Removes the inferior or inferiors @var{infno}@dots{}. It is not |
| 2504 | possible to remove an inferior that is running with this command. For |
| 2505 | those, use the @code{kill} or @code{detach} command first. |
| 2506 | |
| 2507 | @end table |
| 2508 | |
| 2509 | To quit debugging one of the running inferiors that is not the current |
| 2510 | inferior, you can either detach from it by using the @w{@code{detach |
| 2511 | inferior}} command (allowing it to run independently), or kill it |
| 2512 | using the @w{@code{kill inferiors}} command: |
| 2513 | |
| 2514 | @table @code |
| 2515 | @kindex detach inferiors @var{infno}@dots{} |
| 2516 | @item detach inferior @var{infno}@dots{} |
| 2517 | Detach from the inferior or inferiors identified by @value{GDBN} |
| 2518 | inferior number(s) @var{infno}@dots{}. Note that the inferior's entry |
| 2519 | still stays on the list of inferiors shown by @code{info inferiors}, |
| 2520 | but its Description will show @samp{<null>}. |
| 2521 | |
| 2522 | @kindex kill inferiors @var{infno}@dots{} |
| 2523 | @item kill inferiors @var{infno}@dots{} |
| 2524 | Kill the inferior or inferiors identified by @value{GDBN} inferior |
| 2525 | number(s) @var{infno}@dots{}. Note that the inferior's entry still |
| 2526 | stays on the list of inferiors shown by @code{info inferiors}, but its |
| 2527 | Description will show @samp{<null>}. |
| 2528 | @end table |
| 2529 | |
| 2530 | After the successful completion of a command such as @code{detach}, |
| 2531 | @code{detach inferiors}, @code{kill} or @code{kill inferiors}, or after |
| 2532 | a normal process exit, the inferior is still valid and listed with |
| 2533 | @code{info inferiors}, ready to be restarted. |
| 2534 | |
| 2535 | |
| 2536 | To be notified when inferiors are started or exit under @value{GDBN}'s |
| 2537 | control use @w{@code{set print inferior-events}}: |
| 2538 | |
| 2539 | @table @code |
| 2540 | @kindex set print inferior-events |
| 2541 | @cindex print messages on inferior start and exit |
| 2542 | @item set print inferior-events |
| 2543 | @itemx set print inferior-events on |
| 2544 | @itemx set print inferior-events off |
| 2545 | The @code{set print inferior-events} command allows you to enable or |
| 2546 | disable printing of messages when @value{GDBN} notices that new |
| 2547 | inferiors have started or that inferiors have exited or have been |
| 2548 | detached. By default, these messages will not be printed. |
| 2549 | |
| 2550 | @kindex show print inferior-events |
| 2551 | @item show print inferior-events |
| 2552 | Show whether messages will be printed when @value{GDBN} detects that |
| 2553 | inferiors have started, exited or have been detached. |
| 2554 | @end table |
| 2555 | |
| 2556 | Many commands will work the same with multiple programs as with a |
| 2557 | single program: e.g., @code{print myglobal} will simply display the |
| 2558 | value of @code{myglobal} in the current inferior. |
| 2559 | |
| 2560 | |
| 2561 | Occasionaly, when debugging @value{GDBN} itself, it may be useful to |
| 2562 | get more info about the relationship of inferiors, programs, address |
| 2563 | spaces in a debug session. You can do that with the @w{@code{maint |
| 2564 | info program-spaces}} command. |
| 2565 | |
| 2566 | @table @code |
| 2567 | @kindex maint info program-spaces |
| 2568 | @item maint info program-spaces |
| 2569 | Print a list of all program spaces currently being managed by |
| 2570 | @value{GDBN}. |
| 2571 | |
| 2572 | @value{GDBN} displays for each program space (in this order): |
| 2573 | |
| 2574 | @enumerate |
| 2575 | @item |
| 2576 | the program space number assigned by @value{GDBN} |
| 2577 | |
| 2578 | @item |
| 2579 | the name of the executable loaded into the program space, with e.g., |
| 2580 | the @code{file} command. |
| 2581 | |
| 2582 | @end enumerate |
| 2583 | |
| 2584 | @noindent |
| 2585 | An asterisk @samp{*} preceding the @value{GDBN} program space number |
| 2586 | indicates the current program space. |
| 2587 | |
| 2588 | In addition, below each program space line, @value{GDBN} prints extra |
| 2589 | information that isn't suitable to display in tabular form. For |
| 2590 | example, the list of inferiors bound to the program space. |
| 2591 | |
| 2592 | @smallexample |
| 2593 | (@value{GDBP}) maint info program-spaces |
| 2594 | Id Executable |
| 2595 | 2 goodbye |
| 2596 | Bound inferiors: ID 1 (process 21561) |
| 2597 | * 1 hello |
| 2598 | @end smallexample |
| 2599 | |
| 2600 | Here we can see that no inferior is running the program @code{hello}, |
| 2601 | while @code{process 21561} is running the program @code{goodbye}. On |
| 2602 | some targets, it is possible that multiple inferiors are bound to the |
| 2603 | same program space. The most common example is that of debugging both |
| 2604 | the parent and child processes of a @code{vfork} call. For example, |
| 2605 | |
| 2606 | @smallexample |
| 2607 | (@value{GDBP}) maint info program-spaces |
| 2608 | Id Executable |
| 2609 | * 1 vfork-test |
| 2610 | Bound inferiors: ID 2 (process 18050), ID 1 (process 18045) |
| 2611 | @end smallexample |
| 2612 | |
| 2613 | Here, both inferior 2 and inferior 1 are running in the same program |
| 2614 | space as a result of inferior 1 having executed a @code{vfork} call. |
| 2615 | @end table |
| 2616 | |
| 2617 | @node Threads |
| 2618 | @section Debugging Programs with Multiple Threads |
| 2619 | |
| 2620 | @cindex threads of execution |
| 2621 | @cindex multiple threads |
| 2622 | @cindex switching threads |
| 2623 | In some operating systems, such as HP-UX and Solaris, a single program |
| 2624 | may have more than one @dfn{thread} of execution. The precise semantics |
| 2625 | of threads differ from one operating system to another, but in general |
| 2626 | the threads of a single program are akin to multiple processes---except |
| 2627 | that they share one address space (that is, they can all examine and |
| 2628 | modify the same variables). On the other hand, each thread has its own |
| 2629 | registers and execution stack, and perhaps private memory. |
| 2630 | |
| 2631 | @value{GDBN} provides these facilities for debugging multi-thread |
| 2632 | programs: |
| 2633 | |
| 2634 | @itemize @bullet |
| 2635 | @item automatic notification of new threads |
| 2636 | @item @samp{thread @var{threadno}}, a command to switch among threads |
| 2637 | @item @samp{info threads}, a command to inquire about existing threads |
| 2638 | @item @samp{thread apply [@var{threadno}] [@var{all}] @var{args}}, |
| 2639 | a command to apply a command to a list of threads |
| 2640 | @item thread-specific breakpoints |
| 2641 | @item @samp{set print thread-events}, which controls printing of |
| 2642 | messages on thread start and exit. |
| 2643 | @item @samp{set libthread-db-search-path @var{path}}, which lets |
| 2644 | the user specify which @code{libthread_db} to use if the default choice |
| 2645 | isn't compatible with the program. |
| 2646 | @end itemize |
| 2647 | |
| 2648 | @quotation |
| 2649 | @emph{Warning:} These facilities are not yet available on every |
| 2650 | @value{GDBN} configuration where the operating system supports threads. |
| 2651 | If your @value{GDBN} does not support threads, these commands have no |
| 2652 | effect. For example, a system without thread support shows no output |
| 2653 | from @samp{info threads}, and always rejects the @code{thread} command, |
| 2654 | like this: |
| 2655 | |
| 2656 | @smallexample |
| 2657 | (@value{GDBP}) info threads |
| 2658 | (@value{GDBP}) thread 1 |
| 2659 | Thread ID 1 not known. Use the "info threads" command to |
| 2660 | see the IDs of currently known threads. |
| 2661 | @end smallexample |
| 2662 | @c FIXME to implementors: how hard would it be to say "sorry, this GDB |
| 2663 | @c doesn't support threads"? |
| 2664 | @end quotation |
| 2665 | |
| 2666 | @cindex focus of debugging |
| 2667 | @cindex current thread |
| 2668 | The @value{GDBN} thread debugging facility allows you to observe all |
| 2669 | threads while your program runs---but whenever @value{GDBN} takes |
| 2670 | control, one thread in particular is always the focus of debugging. |
| 2671 | This thread is called the @dfn{current thread}. Debugging commands show |
| 2672 | program information from the perspective of the current thread. |
| 2673 | |
| 2674 | @cindex @code{New} @var{systag} message |
| 2675 | @cindex thread identifier (system) |
| 2676 | @c FIXME-implementors!! It would be more helpful if the [New...] message |
| 2677 | @c included GDB's numeric thread handle, so you could just go to that |
| 2678 | @c thread without first checking `info threads'. |
| 2679 | Whenever @value{GDBN} detects a new thread in your program, it displays |
| 2680 | the target system's identification for the thread with a message in the |
| 2681 | form @samp{[New @var{systag}]}. @var{systag} is a thread identifier |
| 2682 | whose form varies depending on the particular system. For example, on |
| 2683 | @sc{gnu}/Linux, you might see |
| 2684 | |
| 2685 | @smallexample |
| 2686 | [New Thread 0x41e02940 (LWP 25582)] |
| 2687 | @end smallexample |
| 2688 | |
| 2689 | @noindent |
| 2690 | when @value{GDBN} notices a new thread. In contrast, on an SGI system, |
| 2691 | the @var{systag} is simply something like @samp{process 368}, with no |
| 2692 | further qualifier. |
| 2693 | |
| 2694 | @c FIXME!! (1) Does the [New...] message appear even for the very first |
| 2695 | @c thread of a program, or does it only appear for the |
| 2696 | @c second---i.e.@: when it becomes obvious we have a multithread |
| 2697 | @c program? |
| 2698 | @c (2) *Is* there necessarily a first thread always? Or do some |
| 2699 | @c multithread systems permit starting a program with multiple |
| 2700 | @c threads ab initio? |
| 2701 | |
| 2702 | @cindex thread number |
| 2703 | @cindex thread identifier (GDB) |
| 2704 | For debugging purposes, @value{GDBN} associates its own thread |
| 2705 | number---always a single integer---with each thread in your program. |
| 2706 | |
| 2707 | @table @code |
| 2708 | @kindex info threads |
| 2709 | @item info threads @r{[}@var{id}@dots{}@r{]} |
| 2710 | Display a summary of all threads currently in your program. Optional |
| 2711 | argument @var{id}@dots{} is one or more thread ids separated by spaces, and |
| 2712 | means to print information only about the specified thread or threads. |
| 2713 | @value{GDBN} displays for each thread (in this order): |
| 2714 | |
| 2715 | @enumerate |
| 2716 | @item |
| 2717 | the thread number assigned by @value{GDBN} |
| 2718 | |
| 2719 | @item |
| 2720 | the target system's thread identifier (@var{systag}) |
| 2721 | |
| 2722 | @item |
| 2723 | the thread's name, if one is known. A thread can either be named by |
| 2724 | the user (see @code{thread name}, below), or, in some cases, by the |
| 2725 | program itself. |
| 2726 | |
| 2727 | @item |
| 2728 | the current stack frame summary for that thread |
| 2729 | @end enumerate |
| 2730 | |
| 2731 | @noindent |
| 2732 | An asterisk @samp{*} to the left of the @value{GDBN} thread number |
| 2733 | indicates the current thread. |
| 2734 | |
| 2735 | For example, |
| 2736 | @end table |
| 2737 | @c end table here to get a little more width for example |
| 2738 | |
| 2739 | @smallexample |
| 2740 | (@value{GDBP}) info threads |
| 2741 | Id Target Id Frame |
| 2742 | 3 process 35 thread 27 0x34e5 in sigpause () |
| 2743 | 2 process 35 thread 23 0x34e5 in sigpause () |
| 2744 | * 1 process 35 thread 13 main (argc=1, argv=0x7ffffff8) |
| 2745 | at threadtest.c:68 |
| 2746 | @end smallexample |
| 2747 | |
| 2748 | On Solaris, you can display more information about user threads with a |
| 2749 | Solaris-specific command: |
| 2750 | |
| 2751 | @table @code |
| 2752 | @item maint info sol-threads |
| 2753 | @kindex maint info sol-threads |
| 2754 | @cindex thread info (Solaris) |
| 2755 | Display info on Solaris user threads. |
| 2756 | @end table |
| 2757 | |
| 2758 | @table @code |
| 2759 | @kindex thread @var{threadno} |
| 2760 | @item thread @var{threadno} |
| 2761 | Make thread number @var{threadno} the current thread. The command |
| 2762 | argument @var{threadno} is the internal @value{GDBN} thread number, as |
| 2763 | shown in the first field of the @samp{info threads} display. |
| 2764 | @value{GDBN} responds by displaying the system identifier of the thread |
| 2765 | you selected, and its current stack frame summary: |
| 2766 | |
| 2767 | @smallexample |
| 2768 | (@value{GDBP}) thread 2 |
| 2769 | [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))] |
| 2770 | #0 some_function (ignore=0x0) at example.c:8 |
| 2771 | 8 printf ("hello\n"); |
| 2772 | @end smallexample |
| 2773 | |
| 2774 | @noindent |
| 2775 | As with the @samp{[New @dots{}]} message, the form of the text after |
| 2776 | @samp{Switching to} depends on your system's conventions for identifying |
| 2777 | threads. |
| 2778 | |
| 2779 | @vindex $_thread@r{, convenience variable} |
| 2780 | The debugger convenience variable @samp{$_thread} contains the number |
| 2781 | of the current thread. You may find this useful in writing breakpoint |
| 2782 | conditional expressions, command scripts, and so forth. See |
| 2783 | @xref{Convenience Vars,, Convenience Variables}, for general |
| 2784 | information on convenience variables. |
| 2785 | |
| 2786 | @kindex thread apply |
| 2787 | @cindex apply command to several threads |
| 2788 | @item thread apply [@var{threadno} | all] @var{command} |
| 2789 | The @code{thread apply} command allows you to apply the named |
| 2790 | @var{command} to one or more threads. Specify the numbers of the |
| 2791 | threads that you want affected with the command argument |
| 2792 | @var{threadno}. It can be a single thread number, one of the numbers |
| 2793 | shown in the first field of the @samp{info threads} display; or it |
| 2794 | could be a range of thread numbers, as in @code{2-4}. To apply a |
| 2795 | command to all threads, type @kbd{thread apply all @var{command}}. |
| 2796 | |
| 2797 | @kindex thread name |
| 2798 | @cindex name a thread |
| 2799 | @item thread name [@var{name}] |
| 2800 | This command assigns a name to the current thread. If no argument is |
| 2801 | given, any existing user-specified name is removed. The thread name |
| 2802 | appears in the @samp{info threads} display. |
| 2803 | |
| 2804 | On some systems, such as @sc{gnu}/Linux, @value{GDBN} is able to |
| 2805 | determine the name of the thread as given by the OS. On these |
| 2806 | systems, a name specified with @samp{thread name} will override the |
| 2807 | system-give name, and removing the user-specified name will cause |
| 2808 | @value{GDBN} to once again display the system-specified name. |
| 2809 | |
| 2810 | @kindex thread find |
| 2811 | @cindex search for a thread |
| 2812 | @item thread find [@var{regexp}] |
| 2813 | Search for and display thread ids whose name or @var{systag} |
| 2814 | matches the supplied regular expression. |
| 2815 | |
| 2816 | As well as being the complement to the @samp{thread name} command, |
| 2817 | this command also allows you to identify a thread by its target |
| 2818 | @var{systag}. For instance, on @sc{gnu}/Linux, the target @var{systag} |
| 2819 | is the LWP id. |
| 2820 | |
| 2821 | @smallexample |
| 2822 | (@value{GDBN}) thread find 26688 |
| 2823 | Thread 4 has target id 'Thread 0x41e02940 (LWP 26688)' |
| 2824 | (@value{GDBN}) info thread 4 |
| 2825 | Id Target Id Frame |
| 2826 | 4 Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select () |
| 2827 | @end smallexample |
| 2828 | |
| 2829 | @kindex set print thread-events |
| 2830 | @cindex print messages on thread start and exit |
| 2831 | @item set print thread-events |
| 2832 | @itemx set print thread-events on |
| 2833 | @itemx set print thread-events off |
| 2834 | The @code{set print thread-events} command allows you to enable or |
| 2835 | disable printing of messages when @value{GDBN} notices that new threads have |
| 2836 | started or that threads have exited. By default, these messages will |
| 2837 | be printed if detection of these events is supported by the target. |
| 2838 | Note that these messages cannot be disabled on all targets. |
| 2839 | |
| 2840 | @kindex show print thread-events |
| 2841 | @item show print thread-events |
| 2842 | Show whether messages will be printed when @value{GDBN} detects that threads |
| 2843 | have started and exited. |
| 2844 | @end table |
| 2845 | |
| 2846 | @xref{Thread Stops,,Stopping and Starting Multi-thread Programs}, for |
| 2847 | more information about how @value{GDBN} behaves when you stop and start |
| 2848 | programs with multiple threads. |
| 2849 | |
| 2850 | @xref{Set Watchpoints,,Setting Watchpoints}, for information about |
| 2851 | watchpoints in programs with multiple threads. |
| 2852 | |
| 2853 | @table @code |
| 2854 | @kindex set libthread-db-search-path |
| 2855 | @cindex search path for @code{libthread_db} |
| 2856 | @item set libthread-db-search-path @r{[}@var{path}@r{]} |
| 2857 | If this variable is set, @var{path} is a colon-separated list of |
| 2858 | directories @value{GDBN} will use to search for @code{libthread_db}. |
| 2859 | If you omit @var{path}, @samp{libthread-db-search-path} will be reset to |
| 2860 | an empty list. |
| 2861 | |
| 2862 | On @sc{gnu}/Linux and Solaris systems, @value{GDBN} uses a ``helper'' |
| 2863 | @code{libthread_db} library to obtain information about threads in the |
| 2864 | inferior process. @value{GDBN} will use @samp{libthread-db-search-path} |
| 2865 | to find @code{libthread_db}. If that fails, @value{GDBN} will continue |
| 2866 | with default system shared library directories, and finally the directory |
| 2867 | from which @code{libpthread} was loaded in the inferior process. |
| 2868 | |
| 2869 | For any @code{libthread_db} library @value{GDBN} finds in above directories, |
| 2870 | @value{GDBN} attempts to initialize it with the current inferior process. |
| 2871 | If this initialization fails (which could happen because of a version |
| 2872 | mismatch between @code{libthread_db} and @code{libpthread}), @value{GDBN} |
| 2873 | will unload @code{libthread_db}, and continue with the next directory. |
| 2874 | If none of @code{libthread_db} libraries initialize successfully, |
| 2875 | @value{GDBN} will issue a warning and thread debugging will be disabled. |
| 2876 | |
| 2877 | Setting @code{libthread-db-search-path} is currently implemented |
| 2878 | only on some platforms. |
| 2879 | |
| 2880 | @kindex show libthread-db-search-path |
| 2881 | @item show libthread-db-search-path |
| 2882 | Display current libthread_db search path. |
| 2883 | |
| 2884 | @kindex set debug libthread-db |
| 2885 | @kindex show debug libthread-db |
| 2886 | @cindex debugging @code{libthread_db} |
| 2887 | @item set debug libthread-db |
| 2888 | @itemx show debug libthread-db |
| 2889 | Turns on or off display of @code{libthread_db}-related events. |
| 2890 | Use @code{1} to enable, @code{0} to disable. |
| 2891 | @end table |
| 2892 | |
| 2893 | @node Forks |
| 2894 | @section Debugging Forks |
| 2895 | |
| 2896 | @cindex fork, debugging programs which call |
| 2897 | @cindex multiple processes |
| 2898 | @cindex processes, multiple |
| 2899 | On most systems, @value{GDBN} has no special support for debugging |
| 2900 | programs which create additional processes using the @code{fork} |
| 2901 | function. When a program forks, @value{GDBN} will continue to debug the |
| 2902 | parent process and the child process will run unimpeded. If you have |
| 2903 | set a breakpoint in any code which the child then executes, the child |
| 2904 | will get a @code{SIGTRAP} signal which (unless it catches the signal) |
| 2905 | will cause it to terminate. |
| 2906 | |
| 2907 | However, if you want to debug the child process there is a workaround |
| 2908 | which isn't too painful. Put a call to @code{sleep} in the code which |
| 2909 | the child process executes after the fork. It may be useful to sleep |
| 2910 | only if a certain environment variable is set, or a certain file exists, |
| 2911 | so that the delay need not occur when you don't want to run @value{GDBN} |
| 2912 | on the child. While the child is sleeping, use the @code{ps} program to |
| 2913 | get its process ID. Then tell @value{GDBN} (a new invocation of |
| 2914 | @value{GDBN} if you are also debugging the parent process) to attach to |
| 2915 | the child process (@pxref{Attach}). From that point on you can debug |
| 2916 | the child process just like any other process which you attached to. |
| 2917 | |
| 2918 | On some systems, @value{GDBN} provides support for debugging programs that |
| 2919 | create additional processes using the @code{fork} or @code{vfork} functions. |
| 2920 | Currently, the only platforms with this feature are HP-UX (11.x and later |
| 2921 | only?) and @sc{gnu}/Linux (kernel version 2.5.60 and later). |
| 2922 | |
| 2923 | By default, when a program forks, @value{GDBN} will continue to debug |
| 2924 | the parent process and the child process will run unimpeded. |
| 2925 | |
| 2926 | If you want to follow the child process instead of the parent process, |
| 2927 | use the command @w{@code{set follow-fork-mode}}. |
| 2928 | |
| 2929 | @table @code |
| 2930 | @kindex set follow-fork-mode |
| 2931 | @item set follow-fork-mode @var{mode} |
| 2932 | Set the debugger response to a program call of @code{fork} or |
| 2933 | @code{vfork}. A call to @code{fork} or @code{vfork} creates a new |
| 2934 | process. The @var{mode} argument can be: |
| 2935 | |
| 2936 | @table @code |
| 2937 | @item parent |
| 2938 | The original process is debugged after a fork. The child process runs |
| 2939 | unimpeded. This is the default. |
| 2940 | |
| 2941 | @item child |
| 2942 | The new process is debugged after a fork. The parent process runs |
| 2943 | unimpeded. |
| 2944 | |
| 2945 | @end table |
| 2946 | |
| 2947 | @kindex show follow-fork-mode |
| 2948 | @item show follow-fork-mode |
| 2949 | Display the current debugger response to a @code{fork} or @code{vfork} call. |
| 2950 | @end table |
| 2951 | |
| 2952 | @cindex debugging multiple processes |
| 2953 | On Linux, if you want to debug both the parent and child processes, use the |
| 2954 | command @w{@code{set detach-on-fork}}. |
| 2955 | |
| 2956 | @table @code |
| 2957 | @kindex set detach-on-fork |
| 2958 | @item set detach-on-fork @var{mode} |
| 2959 | Tells gdb whether to detach one of the processes after a fork, or |
| 2960 | retain debugger control over them both. |
| 2961 | |
| 2962 | @table @code |
| 2963 | @item on |
| 2964 | The child process (or parent process, depending on the value of |
| 2965 | @code{follow-fork-mode}) will be detached and allowed to run |
| 2966 | independently. This is the default. |
| 2967 | |
| 2968 | @item off |
| 2969 | Both processes will be held under the control of @value{GDBN}. |
| 2970 | One process (child or parent, depending on the value of |
| 2971 | @code{follow-fork-mode}) is debugged as usual, while the other |
| 2972 | is held suspended. |
| 2973 | |
| 2974 | @end table |
| 2975 | |
| 2976 | @kindex show detach-on-fork |
| 2977 | @item show detach-on-fork |
| 2978 | Show whether detach-on-fork mode is on/off. |
| 2979 | @end table |
| 2980 | |
| 2981 | If you choose to set @samp{detach-on-fork} mode off, then @value{GDBN} |
| 2982 | will retain control of all forked processes (including nested forks). |
| 2983 | You can list the forked processes under the control of @value{GDBN} by |
| 2984 | using the @w{@code{info inferiors}} command, and switch from one fork |
| 2985 | to another by using the @code{inferior} command (@pxref{Inferiors and |
| 2986 | Programs, ,Debugging Multiple Inferiors and Programs}). |
| 2987 | |
| 2988 | To quit debugging one of the forked processes, you can either detach |
| 2989 | from it by using the @w{@code{detach inferiors}} command (allowing it |
| 2990 | to run independently), or kill it using the @w{@code{kill inferiors}} |
| 2991 | command. @xref{Inferiors and Programs, ,Debugging Multiple Inferiors |
| 2992 | and Programs}. |
| 2993 | |
| 2994 | If you ask to debug a child process and a @code{vfork} is followed by an |
| 2995 | @code{exec}, @value{GDBN} executes the new target up to the first |
| 2996 | breakpoint in the new target. If you have a breakpoint set on |
| 2997 | @code{main} in your original program, the breakpoint will also be set on |
| 2998 | the child process's @code{main}. |
| 2999 | |
| 3000 | On some systems, when a child process is spawned by @code{vfork}, you |
| 3001 | cannot debug the child or parent until an @code{exec} call completes. |
| 3002 | |
| 3003 | If you issue a @code{run} command to @value{GDBN} after an @code{exec} |
| 3004 | call executes, the new target restarts. To restart the parent |
| 3005 | process, use the @code{file} command with the parent executable name |
| 3006 | as its argument. By default, after an @code{exec} call executes, |
| 3007 | @value{GDBN} discards the symbols of the previous executable image. |
| 3008 | You can change this behaviour with the @w{@code{set follow-exec-mode}} |
| 3009 | command. |
| 3010 | |
| 3011 | @table @code |
| 3012 | @kindex set follow-exec-mode |
| 3013 | @item set follow-exec-mode @var{mode} |
| 3014 | |
| 3015 | Set debugger response to a program call of @code{exec}. An |
| 3016 | @code{exec} call replaces the program image of a process. |
| 3017 | |
| 3018 | @code{follow-exec-mode} can be: |
| 3019 | |
| 3020 | @table @code |
| 3021 | @item new |
| 3022 | @value{GDBN} creates a new inferior and rebinds the process to this |
| 3023 | new inferior. The program the process was running before the |
| 3024 | @code{exec} call can be restarted afterwards by restarting the |
| 3025 | original inferior. |
| 3026 | |
| 3027 | For example: |
| 3028 | |
| 3029 | @smallexample |
| 3030 | (@value{GDBP}) info inferiors |
| 3031 | (gdb) info inferior |
| 3032 | Id Description Executable |
| 3033 | * 1 <null> prog1 |
| 3034 | (@value{GDBP}) run |
| 3035 | process 12020 is executing new program: prog2 |
| 3036 | Program exited normally. |
| 3037 | (@value{GDBP}) info inferiors |
| 3038 | Id Description Executable |
| 3039 | * 2 <null> prog2 |
| 3040 | 1 <null> prog1 |
| 3041 | @end smallexample |
| 3042 | |
| 3043 | @item same |
| 3044 | @value{GDBN} keeps the process bound to the same inferior. The new |
| 3045 | executable image replaces the previous executable loaded in the |
| 3046 | inferior. Restarting the inferior after the @code{exec} call, with |
| 3047 | e.g., the @code{run} command, restarts the executable the process was |
| 3048 | running after the @code{exec} call. This is the default mode. |
| 3049 | |
| 3050 | For example: |
| 3051 | |
| 3052 | @smallexample |
| 3053 | (@value{GDBP}) info inferiors |
| 3054 | Id Description Executable |
| 3055 | * 1 <null> prog1 |
| 3056 | (@value{GDBP}) run |
| 3057 | process 12020 is executing new program: prog2 |
| 3058 | Program exited normally. |
| 3059 | (@value{GDBP}) info inferiors |
| 3060 | Id Description Executable |
| 3061 | * 1 <null> prog2 |
| 3062 | @end smallexample |
| 3063 | |
| 3064 | @end table |
| 3065 | @end table |
| 3066 | |
| 3067 | You can use the @code{catch} command to make @value{GDBN} stop whenever |
| 3068 | a @code{fork}, @code{vfork}, or @code{exec} call is made. @xref{Set |
| 3069 | Catchpoints, ,Setting Catchpoints}. |
| 3070 | |
| 3071 | @node Checkpoint/Restart |
| 3072 | @section Setting a @emph{Bookmark} to Return to Later |
| 3073 | |
| 3074 | @cindex checkpoint |
| 3075 | @cindex restart |
| 3076 | @cindex bookmark |
| 3077 | @cindex snapshot of a process |
| 3078 | @cindex rewind program state |
| 3079 | |
| 3080 | On certain operating systems@footnote{Currently, only |
| 3081 | @sc{gnu}/Linux.}, @value{GDBN} is able to save a @dfn{snapshot} of a |
| 3082 | program's state, called a @dfn{checkpoint}, and come back to it |
| 3083 | later. |
| 3084 | |
| 3085 | Returning to a checkpoint effectively undoes everything that has |
| 3086 | happened in the program since the @code{checkpoint} was saved. This |
| 3087 | includes changes in memory, registers, and even (within some limits) |
| 3088 | system state. Effectively, it is like going back in time to the |
| 3089 | moment when the checkpoint was saved. |
| 3090 | |
| 3091 | Thus, if you're stepping thru a program and you think you're |
| 3092 | getting close to the point where things go wrong, you can save |
| 3093 | a checkpoint. Then, if you accidentally go too far and miss |
| 3094 | the critical statement, instead of having to restart your program |
| 3095 | from the beginning, you can just go back to the checkpoint and |
| 3096 | start again from there. |
| 3097 | |
| 3098 | This can be especially useful if it takes a lot of time or |
| 3099 | steps to reach the point where you think the bug occurs. |
| 3100 | |
| 3101 | To use the @code{checkpoint}/@code{restart} method of debugging: |
| 3102 | |
| 3103 | @table @code |
| 3104 | @kindex checkpoint |
| 3105 | @item checkpoint |
| 3106 | Save a snapshot of the debugged program's current execution state. |
| 3107 | The @code{checkpoint} command takes no arguments, but each checkpoint |
| 3108 | is assigned a small integer id, similar to a breakpoint id. |
| 3109 | |
| 3110 | @kindex info checkpoints |
| 3111 | @item info checkpoints |
| 3112 | List the checkpoints that have been saved in the current debugging |
| 3113 | session. For each checkpoint, the following information will be |
| 3114 | listed: |
| 3115 | |
| 3116 | @table @code |
| 3117 | @item Checkpoint ID |
| 3118 | @item Process ID |
| 3119 | @item Code Address |
| 3120 | @item Source line, or label |
| 3121 | @end table |
| 3122 | |
| 3123 | @kindex restart @var{checkpoint-id} |
| 3124 | @item restart @var{checkpoint-id} |
| 3125 | Restore the program state that was saved as checkpoint number |
| 3126 | @var{checkpoint-id}. All program variables, registers, stack frames |
| 3127 | etc.@: will be returned to the values that they had when the checkpoint |
| 3128 | was saved. In essence, gdb will ``wind back the clock'' to the point |
| 3129 | in time when the checkpoint was saved. |
| 3130 | |
| 3131 | Note that breakpoints, @value{GDBN} variables, command history etc. |
| 3132 | are not affected by restoring a checkpoint. In general, a checkpoint |
| 3133 | only restores things that reside in the program being debugged, not in |
| 3134 | the debugger. |
| 3135 | |
| 3136 | @kindex delete checkpoint @var{checkpoint-id} |
| 3137 | @item delete checkpoint @var{checkpoint-id} |
| 3138 | Delete the previously-saved checkpoint identified by @var{checkpoint-id}. |
| 3139 | |
| 3140 | @end table |
| 3141 | |
| 3142 | Returning to a previously saved checkpoint will restore the user state |
| 3143 | of the program being debugged, plus a significant subset of the system |
| 3144 | (OS) state, including file pointers. It won't ``un-write'' data from |
| 3145 | a file, but it will rewind the file pointer to the previous location, |
| 3146 | so that the previously written data can be overwritten. For files |
| 3147 | opened in read mode, the pointer will also be restored so that the |
| 3148 | previously read data can be read again. |
| 3149 | |
| 3150 | Of course, characters that have been sent to a printer (or other |
| 3151 | external device) cannot be ``snatched back'', and characters received |
| 3152 | from eg.@: a serial device can be removed from internal program buffers, |
| 3153 | but they cannot be ``pushed back'' into the serial pipeline, ready to |
| 3154 | be received again. Similarly, the actual contents of files that have |
| 3155 | been changed cannot be restored (at this time). |
| 3156 | |
| 3157 | However, within those constraints, you actually can ``rewind'' your |
| 3158 | program to a previously saved point in time, and begin debugging it |
| 3159 | again --- and you can change the course of events so as to debug a |
| 3160 | different execution path this time. |
| 3161 | |
| 3162 | @cindex checkpoints and process id |
| 3163 | Finally, there is one bit of internal program state that will be |
| 3164 | different when you return to a checkpoint --- the program's process |
| 3165 | id. Each checkpoint will have a unique process id (or @var{pid}), |
| 3166 | and each will be different from the program's original @var{pid}. |
| 3167 | If your program has saved a local copy of its process id, this could |
| 3168 | potentially pose a problem. |
| 3169 | |
| 3170 | @subsection A Non-obvious Benefit of Using Checkpoints |
| 3171 | |
| 3172 | On some systems such as @sc{gnu}/Linux, address space randomization |
| 3173 | is performed on new processes for security reasons. This makes it |
| 3174 | difficult or impossible to set a breakpoint, or watchpoint, on an |
| 3175 | absolute address if you have to restart the program, since the |
| 3176 | absolute location of a symbol will change from one execution to the |
| 3177 | next. |
| 3178 | |
| 3179 | A checkpoint, however, is an @emph{identical} copy of a process. |
| 3180 | Therefore if you create a checkpoint at (eg.@:) the start of main, |
| 3181 | and simply return to that checkpoint instead of restarting the |
| 3182 | process, you can avoid the effects of address randomization and |
| 3183 | your symbols will all stay in the same place. |
| 3184 | |
| 3185 | @node Stopping |
| 3186 | @chapter Stopping and Continuing |
| 3187 | |
| 3188 | The principal purposes of using a debugger are so that you can stop your |
| 3189 | program before it terminates; or so that, if your program runs into |
| 3190 | trouble, you can investigate and find out why. |
| 3191 | |
| 3192 | Inside @value{GDBN}, your program may stop for any of several reasons, |
| 3193 | such as a signal, a breakpoint, or reaching a new line after a |
| 3194 | @value{GDBN} command such as @code{step}. You may then examine and |
| 3195 | change variables, set new breakpoints or remove old ones, and then |
| 3196 | continue execution. Usually, the messages shown by @value{GDBN} provide |
| 3197 | ample explanation of the status of your program---but you can also |
| 3198 | explicitly request this information at any time. |
| 3199 | |
| 3200 | @table @code |
| 3201 | @kindex info program |
| 3202 | @item info program |
| 3203 | Display information about the status of your program: whether it is |
| 3204 | running or not, what process it is, and why it stopped. |
| 3205 | @end table |
| 3206 | |
| 3207 | @menu |
| 3208 | * Breakpoints:: Breakpoints, watchpoints, and catchpoints |
| 3209 | * Continuing and Stepping:: Resuming execution |
| 3210 | * Signals:: Signals |
| 3211 | * Thread Stops:: Stopping and starting multi-thread programs |
| 3212 | @end menu |
| 3213 | |
| 3214 | @node Breakpoints |
| 3215 | @section Breakpoints, Watchpoints, and Catchpoints |
| 3216 | |
| 3217 | @cindex breakpoints |
| 3218 | A @dfn{breakpoint} makes your program stop whenever a certain point in |
| 3219 | the program is reached. For each breakpoint, you can add conditions to |
| 3220 | control in finer detail whether your program stops. You can set |
| 3221 | breakpoints with the @code{break} command and its variants (@pxref{Set |
| 3222 | Breaks, ,Setting Breakpoints}), to specify the place where your program |
| 3223 | should stop by line number, function name or exact address in the |
| 3224 | program. |
| 3225 | |
| 3226 | On some systems, you can set breakpoints in shared libraries before |
| 3227 | the executable is run. There is a minor limitation on HP-UX systems: |
| 3228 | you must wait until the executable is run in order to set breakpoints |
| 3229 | in shared library routines that are not called directly by the program |
| 3230 | (for example, routines that are arguments in a @code{pthread_create} |
| 3231 | call). |
| 3232 | |
| 3233 | @cindex watchpoints |
| 3234 | @cindex data breakpoints |
| 3235 | @cindex memory tracing |
| 3236 | @cindex breakpoint on memory address |
| 3237 | @cindex breakpoint on variable modification |
| 3238 | A @dfn{watchpoint} is a special breakpoint that stops your program |
| 3239 | when the value of an expression changes. The expression may be a value |
| 3240 | of a variable, or it could involve values of one or more variables |
| 3241 | combined by operators, such as @samp{a + b}. This is sometimes called |
| 3242 | @dfn{data breakpoints}. You must use a different command to set |
| 3243 | watchpoints (@pxref{Set Watchpoints, ,Setting Watchpoints}), but aside |
| 3244 | from that, you can manage a watchpoint like any other breakpoint: you |
| 3245 | enable, disable, and delete both breakpoints and watchpoints using the |
| 3246 | same commands. |
| 3247 | |
| 3248 | You can arrange to have values from your program displayed automatically |
| 3249 | whenever @value{GDBN} stops at a breakpoint. @xref{Auto Display,, |
| 3250 | Automatic Display}. |
| 3251 | |
| 3252 | @cindex catchpoints |
| 3253 | @cindex breakpoint on events |
| 3254 | A @dfn{catchpoint} is another special breakpoint that stops your program |
| 3255 | when a certain kind of event occurs, such as the throwing of a C@t{++} |
| 3256 | exception or the loading of a library. As with watchpoints, you use a |
| 3257 | different command to set a catchpoint (@pxref{Set Catchpoints, ,Setting |
| 3258 | Catchpoints}), but aside from that, you can manage a catchpoint like any |
| 3259 | other breakpoint. (To stop when your program receives a signal, use the |
| 3260 | @code{handle} command; see @ref{Signals, ,Signals}.) |
| 3261 | |
| 3262 | @cindex breakpoint numbers |
| 3263 | @cindex numbers for breakpoints |
| 3264 | @value{GDBN} assigns a number to each breakpoint, watchpoint, or |
| 3265 | catchpoint when you create it; these numbers are successive integers |
| 3266 | starting with one. In many of the commands for controlling various |
| 3267 | features of breakpoints you use the breakpoint number to say which |
| 3268 | breakpoint you want to change. Each breakpoint may be @dfn{enabled} or |
| 3269 | @dfn{disabled}; if disabled, it has no effect on your program until you |
| 3270 | enable it again. |
| 3271 | |
| 3272 | @cindex breakpoint ranges |
| 3273 | @cindex ranges of breakpoints |
| 3274 | Some @value{GDBN} commands accept a range of breakpoints on which to |
| 3275 | operate. A breakpoint range is either a single breakpoint number, like |
| 3276 | @samp{5}, or two such numbers, in increasing order, separated by a |
| 3277 | hyphen, like @samp{5-7}. When a breakpoint range is given to a command, |
| 3278 | all breakpoints in that range are operated on. |
| 3279 | |
| 3280 | @menu |
| 3281 | * Set Breaks:: Setting breakpoints |
| 3282 | * Set Watchpoints:: Setting watchpoints |
| 3283 | * Set Catchpoints:: Setting catchpoints |
| 3284 | * Delete Breaks:: Deleting breakpoints |
| 3285 | * Disabling:: Disabling breakpoints |
| 3286 | * Conditions:: Break conditions |
| 3287 | * Break Commands:: Breakpoint command lists |
| 3288 | * Save Breakpoints:: How to save breakpoints in a file |
| 3289 | * Error in Breakpoints:: ``Cannot insert breakpoints'' |
| 3290 | * Breakpoint-related Warnings:: ``Breakpoint address adjusted...'' |
| 3291 | @end menu |
| 3292 | |
| 3293 | @node Set Breaks |
| 3294 | @subsection Setting Breakpoints |
| 3295 | |
| 3296 | @c FIXME LMB what does GDB do if no code on line of breakpt? |
| 3297 | @c consider in particular declaration with/without initialization. |
| 3298 | @c |
| 3299 | @c FIXME 2 is there stuff on this already? break at fun start, already init? |
| 3300 | |
| 3301 | @kindex break |
| 3302 | @kindex b @r{(@code{break})} |
| 3303 | @vindex $bpnum@r{, convenience variable} |
| 3304 | @cindex latest breakpoint |
| 3305 | Breakpoints are set with the @code{break} command (abbreviated |
| 3306 | @code{b}). The debugger convenience variable @samp{$bpnum} records the |
| 3307 | number of the breakpoint you've set most recently; see @ref{Convenience |
| 3308 | Vars,, Convenience Variables}, for a discussion of what you can do with |
| 3309 | convenience variables. |
| 3310 | |
| 3311 | @table @code |
| 3312 | @item break @var{location} |
| 3313 | Set a breakpoint at the given @var{location}, which can specify a |
| 3314 | function name, a line number, or an address of an instruction. |
| 3315 | (@xref{Specify Location}, for a list of all the possible ways to |
| 3316 | specify a @var{location}.) The breakpoint will stop your program just |
| 3317 | before it executes any of the code in the specified @var{location}. |
| 3318 | |
| 3319 | When using source languages that permit overloading of symbols, such as |
| 3320 | C@t{++}, a function name may refer to more than one possible place to break. |
| 3321 | @xref{Ambiguous Expressions,,Ambiguous Expressions}, for a discussion of |
| 3322 | that situation. |
| 3323 | |
| 3324 | It is also possible to insert a breakpoint that will stop the program |
| 3325 | only if a specific thread (@pxref{Thread-Specific Breakpoints}) |
| 3326 | or a specific task (@pxref{Ada Tasks}) hits that breakpoint. |
| 3327 | |
| 3328 | @item break |
| 3329 | When called without any arguments, @code{break} sets a breakpoint at |
| 3330 | the next instruction to be executed in the selected stack frame |
| 3331 | (@pxref{Stack, ,Examining the Stack}). In any selected frame but the |
| 3332 | innermost, this makes your program stop as soon as control |
| 3333 | returns to that frame. This is similar to the effect of a |
| 3334 | @code{finish} command in the frame inside the selected frame---except |
| 3335 | that @code{finish} does not leave an active breakpoint. If you use |
| 3336 | @code{break} without an argument in the innermost frame, @value{GDBN} stops |
| 3337 | the next time it reaches the current location; this may be useful |
| 3338 | inside loops. |
| 3339 | |
| 3340 | @value{GDBN} normally ignores breakpoints when it resumes execution, until at |
| 3341 | least one instruction has been executed. If it did not do this, you |
| 3342 | would be unable to proceed past a breakpoint without first disabling the |
| 3343 | breakpoint. This rule applies whether or not the breakpoint already |
| 3344 | existed when your program stopped. |
| 3345 | |
| 3346 | @item break @dots{} if @var{cond} |
| 3347 | Set a breakpoint with condition @var{cond}; evaluate the expression |
| 3348 | @var{cond} each time the breakpoint is reached, and stop only if the |
| 3349 | value is nonzero---that is, if @var{cond} evaluates as true. |
| 3350 | @samp{@dots{}} stands for one of the possible arguments described |
| 3351 | above (or no argument) specifying where to break. @xref{Conditions, |
| 3352 | ,Break Conditions}, for more information on breakpoint conditions. |
| 3353 | |
| 3354 | @kindex tbreak |
| 3355 | @item tbreak @var{args} |
| 3356 | Set a breakpoint enabled only for one stop. @var{args} are the |
| 3357 | same as for the @code{break} command, and the breakpoint is set in the same |
| 3358 | way, but the breakpoint is automatically deleted after the first time your |
| 3359 | program stops there. @xref{Disabling, ,Disabling Breakpoints}. |
| 3360 | |
| 3361 | @kindex hbreak |
| 3362 | @cindex hardware breakpoints |
| 3363 | @item hbreak @var{args} |
| 3364 | Set a hardware-assisted breakpoint. @var{args} are the same as for the |
| 3365 | @code{break} command and the breakpoint is set in the same way, but the |
| 3366 | breakpoint requires hardware support and some target hardware may not |
| 3367 | have this support. The main purpose of this is EPROM/ROM code |
| 3368 | debugging, so you can set a breakpoint at an instruction without |
| 3369 | changing the instruction. This can be used with the new trap-generation |
| 3370 | provided by SPARClite DSU and most x86-based targets. These targets |
| 3371 | will generate traps when a program accesses some data or instruction |
| 3372 | address that is assigned to the debug registers. However the hardware |
| 3373 | breakpoint registers can take a limited number of breakpoints. For |
| 3374 | example, on the DSU, only two data breakpoints can be set at a time, and |
| 3375 | @value{GDBN} will reject this command if more than two are used. Delete |
| 3376 | or disable unused hardware breakpoints before setting new ones |
| 3377 | (@pxref{Disabling, ,Disabling Breakpoints}). |
| 3378 | @xref{Conditions, ,Break Conditions}. |
| 3379 | For remote targets, you can restrict the number of hardware |
| 3380 | breakpoints @value{GDBN} will use, see @ref{set remote |
| 3381 | hardware-breakpoint-limit}. |
| 3382 | |
| 3383 | @kindex thbreak |
| 3384 | @item thbreak @var{args} |
| 3385 | Set a hardware-assisted breakpoint enabled only for one stop. @var{args} |
| 3386 | are the same as for the @code{hbreak} command and the breakpoint is set in |
| 3387 | the same way. However, like the @code{tbreak} command, |
| 3388 | the breakpoint is automatically deleted after the |
| 3389 | first time your program stops there. Also, like the @code{hbreak} |
| 3390 | command, the breakpoint requires hardware support and some target hardware |
| 3391 | may not have this support. @xref{Disabling, ,Disabling Breakpoints}. |
| 3392 | See also @ref{Conditions, ,Break Conditions}. |
| 3393 | |
| 3394 | @kindex rbreak |
| 3395 | @cindex regular expression |
| 3396 | @cindex breakpoints at functions matching a regexp |
| 3397 | @cindex set breakpoints in many functions |
| 3398 | @item rbreak @var{regex} |
| 3399 | Set breakpoints on all functions matching the regular expression |
| 3400 | @var{regex}. This command sets an unconditional breakpoint on all |
| 3401 | matches, printing a list of all breakpoints it set. Once these |
| 3402 | breakpoints are set, they are treated just like the breakpoints set with |
| 3403 | the @code{break} command. You can delete them, disable them, or make |
| 3404 | them conditional the same way as any other breakpoint. |
| 3405 | |
| 3406 | The syntax of the regular expression is the standard one used with tools |
| 3407 | like @file{grep}. Note that this is different from the syntax used by |
| 3408 | shells, so for instance @code{foo*} matches all functions that include |
| 3409 | an @code{fo} followed by zero or more @code{o}s. There is an implicit |
| 3410 | @code{.*} leading and trailing the regular expression you supply, so to |
| 3411 | match only functions that begin with @code{foo}, use @code{^foo}. |
| 3412 | |
| 3413 | @cindex non-member C@t{++} functions, set breakpoint in |
| 3414 | When debugging C@t{++} programs, @code{rbreak} is useful for setting |
| 3415 | breakpoints on overloaded functions that are not members of any special |
| 3416 | classes. |
| 3417 | |
| 3418 | @cindex set breakpoints on all functions |
| 3419 | The @code{rbreak} command can be used to set breakpoints in |
| 3420 | @strong{all} the functions in a program, like this: |
| 3421 | |
| 3422 | @smallexample |
| 3423 | (@value{GDBP}) rbreak . |
| 3424 | @end smallexample |
| 3425 | |
| 3426 | @item rbreak @var{file}:@var{regex} |
| 3427 | If @code{rbreak} is called with a filename qualification, it limits |
| 3428 | the search for functions matching the given regular expression to the |
| 3429 | specified @var{file}. This can be used, for example, to set breakpoints on |
| 3430 | every function in a given file: |
| 3431 | |
| 3432 | @smallexample |
| 3433 | (@value{GDBP}) rbreak file.c:. |
| 3434 | @end smallexample |
| 3435 | |
| 3436 | The colon separating the filename qualifier from the regex may |
| 3437 | optionally be surrounded by spaces. |
| 3438 | |
| 3439 | @kindex info breakpoints |
| 3440 | @cindex @code{$_} and @code{info breakpoints} |
| 3441 | @item info breakpoints @r{[}@var{n}@dots{}@r{]} |
| 3442 | @itemx info break @r{[}@var{n}@dots{}@r{]} |
| 3443 | Print a table of all breakpoints, watchpoints, and catchpoints set and |
| 3444 | not deleted. Optional argument @var{n} means print information only |
| 3445 | about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)). |
| 3446 | For each breakpoint, following columns are printed: |
| 3447 | |
| 3448 | @table @emph |
| 3449 | @item Breakpoint Numbers |
| 3450 | @item Type |
| 3451 | Breakpoint, watchpoint, or catchpoint. |
| 3452 | @item Disposition |
| 3453 | Whether the breakpoint is marked to be disabled or deleted when hit. |
| 3454 | @item Enabled or Disabled |
| 3455 | Enabled breakpoints are marked with @samp{y}. @samp{n} marks breakpoints |
| 3456 | that are not enabled. |
| 3457 | @item Address |
| 3458 | Where the breakpoint is in your program, as a memory address. For a |
| 3459 | pending breakpoint whose address is not yet known, this field will |
| 3460 | contain @samp{<PENDING>}. Such breakpoint won't fire until a shared |
| 3461 | library that has the symbol or line referred by breakpoint is loaded. |
| 3462 | See below for details. A breakpoint with several locations will |
| 3463 | have @samp{<MULTIPLE>} in this field---see below for details. |
| 3464 | @item What |
| 3465 | Where the breakpoint is in the source for your program, as a file and |
| 3466 | line number. For a pending breakpoint, the original string passed to |
| 3467 | the breakpoint command will be listed as it cannot be resolved until |
| 3468 | the appropriate shared library is loaded in the future. |
| 3469 | @end table |
| 3470 | |
| 3471 | @noindent |
| 3472 | If a breakpoint is conditional, @code{info break} shows the condition on |
| 3473 | the line following the affected breakpoint; breakpoint commands, if any, |
| 3474 | are listed after that. A pending breakpoint is allowed to have a condition |
| 3475 | specified for it. The condition is not parsed for validity until a shared |
| 3476 | library is loaded that allows the pending breakpoint to resolve to a |
| 3477 | valid location. |
| 3478 | |
| 3479 | @noindent |
| 3480 | @code{info break} with a breakpoint |
| 3481 | number @var{n} as argument lists only that breakpoint. The |
| 3482 | convenience variable @code{$_} and the default examining-address for |
| 3483 | the @code{x} command are set to the address of the last breakpoint |
| 3484 | listed (@pxref{Memory, ,Examining Memory}). |
| 3485 | |
| 3486 | @noindent |
| 3487 | @code{info break} displays a count of the number of times the breakpoint |
| 3488 | has been hit. This is especially useful in conjunction with the |
| 3489 | @code{ignore} command. You can ignore a large number of breakpoint |
| 3490 | hits, look at the breakpoint info to see how many times the breakpoint |
| 3491 | was hit, and then run again, ignoring one less than that number. This |
| 3492 | will get you quickly to the last hit of that breakpoint. |
| 3493 | @end table |
| 3494 | |
| 3495 | @value{GDBN} allows you to set any number of breakpoints at the same place in |
| 3496 | your program. There is nothing silly or meaningless about this. When |
| 3497 | the breakpoints are conditional, this is even useful |
| 3498 | (@pxref{Conditions, ,Break Conditions}). |
| 3499 | |
| 3500 | @cindex multiple locations, breakpoints |
| 3501 | @cindex breakpoints, multiple locations |
| 3502 | It is possible that a breakpoint corresponds to several locations |
| 3503 | in your program. Examples of this situation are: |
| 3504 | |
| 3505 | @itemize @bullet |
| 3506 | @item |
| 3507 | For a C@t{++} constructor, the @value{NGCC} compiler generates several |
| 3508 | instances of the function body, used in different cases. |
| 3509 | |
| 3510 | @item |
| 3511 | For a C@t{++} template function, a given line in the function can |
| 3512 | correspond to any number of instantiations. |
| 3513 | |
| 3514 | @item |
| 3515 | For an inlined function, a given source line can correspond to |
| 3516 | several places where that function is inlined. |
| 3517 | @end itemize |
| 3518 | |
| 3519 | In all those cases, @value{GDBN} will insert a breakpoint at all |
| 3520 | the relevant locations@footnote{ |
| 3521 | As of this writing, multiple-location breakpoints work only if there's |
| 3522 | line number information for all the locations. This means that they |
| 3523 | will generally not work in system libraries, unless you have debug |
| 3524 | info with line numbers for them.}. |
| 3525 | |
| 3526 | A breakpoint with multiple locations is displayed in the breakpoint |
| 3527 | table using several rows---one header row, followed by one row for |
| 3528 | each breakpoint location. The header row has @samp{<MULTIPLE>} in the |
| 3529 | address column. The rows for individual locations contain the actual |
| 3530 | addresses for locations, and show the functions to which those |
| 3531 | locations belong. The number column for a location is of the form |
| 3532 | @var{breakpoint-number}.@var{location-number}. |
| 3533 | |
| 3534 | For example: |
| 3535 | |
| 3536 | @smallexample |
| 3537 | Num Type Disp Enb Address What |
| 3538 | 1 breakpoint keep y <MULTIPLE> |
| 3539 | stop only if i==1 |
| 3540 | breakpoint already hit 1 time |
| 3541 | 1.1 y 0x080486a2 in void foo<int>() at t.cc:8 |
| 3542 | 1.2 y 0x080486ca in void foo<double>() at t.cc:8 |
| 3543 | @end smallexample |
| 3544 | |
| 3545 | Each location can be individually enabled or disabled by passing |
| 3546 | @var{breakpoint-number}.@var{location-number} as argument to the |
| 3547 | @code{enable} and @code{disable} commands. Note that you cannot |
| 3548 | delete the individual locations from the list, you can only delete the |
| 3549 | entire list of locations that belong to their parent breakpoint (with |
| 3550 | the @kbd{delete @var{num}} command, where @var{num} is the number of |
| 3551 | the parent breakpoint, 1 in the above example). Disabling or enabling |
| 3552 | the parent breakpoint (@pxref{Disabling}) affects all of the locations |
| 3553 | that belong to that breakpoint. |
| 3554 | |
| 3555 | @cindex pending breakpoints |
| 3556 | It's quite common to have a breakpoint inside a shared library. |
| 3557 | Shared libraries can be loaded and unloaded explicitly, |
| 3558 | and possibly repeatedly, as the program is executed. To support |
| 3559 | this use case, @value{GDBN} updates breakpoint locations whenever |
| 3560 | any shared library is loaded or unloaded. Typically, you would |
| 3561 | set a breakpoint in a shared library at the beginning of your |
| 3562 | debugging session, when the library is not loaded, and when the |
| 3563 | symbols from the library are not available. When you try to set |
| 3564 | breakpoint, @value{GDBN} will ask you if you want to set |
| 3565 | a so called @dfn{pending breakpoint}---breakpoint whose address |
| 3566 | is not yet resolved. |
| 3567 | |
| 3568 | After the program is run, whenever a new shared library is loaded, |
| 3569 | @value{GDBN} reevaluates all the breakpoints. When a newly loaded |
| 3570 | shared library contains the symbol or line referred to by some |
| 3571 | pending breakpoint, that breakpoint is resolved and becomes an |
| 3572 | ordinary breakpoint. When a library is unloaded, all breakpoints |
| 3573 | that refer to its symbols or source lines become pending again. |
| 3574 | |
| 3575 | This logic works for breakpoints with multiple locations, too. For |
| 3576 | example, if you have a breakpoint in a C@t{++} template function, and |
| 3577 | a newly loaded shared library has an instantiation of that template, |
| 3578 | a new location is added to the list of locations for the breakpoint. |
| 3579 | |
| 3580 | Except for having unresolved address, pending breakpoints do not |
| 3581 | differ from regular breakpoints. You can set conditions or commands, |
| 3582 | enable and disable them and perform other breakpoint operations. |
| 3583 | |
| 3584 | @value{GDBN} provides some additional commands for controlling what |
| 3585 | happens when the @samp{break} command cannot resolve breakpoint |
| 3586 | address specification to an address: |
| 3587 | |
| 3588 | @kindex set breakpoint pending |
| 3589 | @kindex show breakpoint pending |
| 3590 | @table @code |
| 3591 | @item set breakpoint pending auto |
| 3592 | This is the default behavior. When @value{GDBN} cannot find the breakpoint |
| 3593 | location, it queries you whether a pending breakpoint should be created. |
| 3594 | |
| 3595 | @item set breakpoint pending on |
| 3596 | This indicates that an unrecognized breakpoint location should automatically |
| 3597 | result in a pending breakpoint being created. |
| 3598 | |
| 3599 | @item set breakpoint pending off |
| 3600 | This indicates that pending breakpoints are not to be created. Any |
| 3601 | unrecognized breakpoint location results in an error. This setting does |
| 3602 | not affect any pending breakpoints previously created. |
| 3603 | |
| 3604 | @item show breakpoint pending |
| 3605 | Show the current behavior setting for creating pending breakpoints. |
| 3606 | @end table |
| 3607 | |
| 3608 | The settings above only affect the @code{break} command and its |
| 3609 | variants. Once breakpoint is set, it will be automatically updated |
| 3610 | as shared libraries are loaded and unloaded. |
| 3611 | |
| 3612 | @cindex automatic hardware breakpoints |
| 3613 | For some targets, @value{GDBN} can automatically decide if hardware or |
| 3614 | software breakpoints should be used, depending on whether the |
| 3615 | breakpoint address is read-only or read-write. This applies to |
| 3616 | breakpoints set with the @code{break} command as well as to internal |
| 3617 | breakpoints set by commands like @code{next} and @code{finish}. For |
| 3618 | breakpoints set with @code{hbreak}, @value{GDBN} will always use hardware |
| 3619 | breakpoints. |
| 3620 | |
| 3621 | You can control this automatic behaviour with the following commands:: |
| 3622 | |
| 3623 | @kindex set breakpoint auto-hw |
| 3624 | @kindex show breakpoint auto-hw |
| 3625 | @table @code |
| 3626 | @item set breakpoint auto-hw on |
| 3627 | This is the default behavior. When @value{GDBN} sets a breakpoint, it |
| 3628 | will try to use the target memory map to decide if software or hardware |
| 3629 | breakpoint must be used. |
| 3630 | |
| 3631 | @item set breakpoint auto-hw off |
| 3632 | This indicates @value{GDBN} should not automatically select breakpoint |
| 3633 | type. If the target provides a memory map, @value{GDBN} will warn when |
| 3634 | trying to set software breakpoint at a read-only address. |
| 3635 | @end table |
| 3636 | |
| 3637 | @value{GDBN} normally implements breakpoints by replacing the program code |
| 3638 | at the breakpoint address with a special instruction, which, when |
| 3639 | executed, given control to the debugger. By default, the program |
| 3640 | code is so modified only when the program is resumed. As soon as |
| 3641 | the program stops, @value{GDBN} restores the original instructions. This |
| 3642 | behaviour guards against leaving breakpoints inserted in the |
| 3643 | target should gdb abrubptly disconnect. However, with slow remote |
| 3644 | targets, inserting and removing breakpoint can reduce the performance. |
| 3645 | This behavior can be controlled with the following commands:: |
| 3646 | |
| 3647 | @kindex set breakpoint always-inserted |
| 3648 | @kindex show breakpoint always-inserted |
| 3649 | @table @code |
| 3650 | @item set breakpoint always-inserted off |
| 3651 | All breakpoints, including newly added by the user, are inserted in |
| 3652 | the target only when the target is resumed. All breakpoints are |
| 3653 | removed from the target when it stops. |
| 3654 | |
| 3655 | @item set breakpoint always-inserted on |
| 3656 | Causes all breakpoints to be inserted in the target at all times. If |
| 3657 | the user adds a new breakpoint, or changes an existing breakpoint, the |
| 3658 | breakpoints in the target are updated immediately. A breakpoint is |
| 3659 | removed from the target only when breakpoint itself is removed. |
| 3660 | |
| 3661 | @cindex non-stop mode, and @code{breakpoint always-inserted} |
| 3662 | @item set breakpoint always-inserted auto |
| 3663 | This is the default mode. If @value{GDBN} is controlling the inferior |
| 3664 | in non-stop mode (@pxref{Non-Stop Mode}), gdb behaves as if |
| 3665 | @code{breakpoint always-inserted} mode is on. If @value{GDBN} is |
| 3666 | controlling the inferior in all-stop mode, @value{GDBN} behaves as if |
| 3667 | @code{breakpoint always-inserted} mode is off. |
| 3668 | @end table |
| 3669 | |
| 3670 | @cindex negative breakpoint numbers |
| 3671 | @cindex internal @value{GDBN} breakpoints |
| 3672 | @value{GDBN} itself sometimes sets breakpoints in your program for |
| 3673 | special purposes, such as proper handling of @code{longjmp} (in C |
| 3674 | programs). These internal breakpoints are assigned negative numbers, |
| 3675 | starting with @code{-1}; @samp{info breakpoints} does not display them. |
| 3676 | You can see these breakpoints with the @value{GDBN} maintenance command |
| 3677 | @samp{maint info breakpoints} (@pxref{maint info breakpoints}). |
| 3678 | |
| 3679 | |
| 3680 | @node Set Watchpoints |
| 3681 | @subsection Setting Watchpoints |
| 3682 | |
| 3683 | @cindex setting watchpoints |
| 3684 | You can use a watchpoint to stop execution whenever the value of an |
| 3685 | expression changes, without having to predict a particular place where |
| 3686 | this may happen. (This is sometimes called a @dfn{data breakpoint}.) |
| 3687 | The expression may be as simple as the value of a single variable, or |
| 3688 | as complex as many variables combined by operators. Examples include: |
| 3689 | |
| 3690 | @itemize @bullet |
| 3691 | @item |
| 3692 | A reference to the value of a single variable. |
| 3693 | |
| 3694 | @item |
| 3695 | An address cast to an appropriate data type. For example, |
| 3696 | @samp{*(int *)0x12345678} will watch a 4-byte region at the specified |
| 3697 | address (assuming an @code{int} occupies 4 bytes). |
| 3698 | |
| 3699 | @item |
| 3700 | An arbitrarily complex expression, such as @samp{a*b + c/d}. The |
| 3701 | expression can use any operators valid in the program's native |
| 3702 | language (@pxref{Languages}). |
| 3703 | @end itemize |
| 3704 | |
| 3705 | You can set a watchpoint on an expression even if the expression can |
| 3706 | not be evaluated yet. For instance, you can set a watchpoint on |
| 3707 | @samp{*global_ptr} before @samp{global_ptr} is initialized. |
| 3708 | @value{GDBN} will stop when your program sets @samp{global_ptr} and |
| 3709 | the expression produces a valid value. If the expression becomes |
| 3710 | valid in some other way than changing a variable (e.g.@: if the memory |
| 3711 | pointed to by @samp{*global_ptr} becomes readable as the result of a |
| 3712 | @code{malloc} call), @value{GDBN} may not stop until the next time |
| 3713 | the expression changes. |
| 3714 | |
| 3715 | @cindex software watchpoints |
| 3716 | @cindex hardware watchpoints |
| 3717 | Depending on your system, watchpoints may be implemented in software or |
| 3718 | hardware. @value{GDBN} does software watchpointing by single-stepping your |
| 3719 | program and testing the variable's value each time, which is hundreds of |
| 3720 | times slower than normal execution. (But this may still be worth it, to |
| 3721 | catch errors where you have no clue what part of your program is the |
| 3722 | culprit.) |
| 3723 | |
| 3724 | On some systems, such as HP-UX, PowerPC, @sc{gnu}/Linux and most other |
| 3725 | x86-based targets, @value{GDBN} includes support for hardware |
| 3726 | watchpoints, which do not slow down the running of your program. |
| 3727 | |
| 3728 | @table @code |
| 3729 | @kindex watch |
| 3730 | @item watch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} |
| 3731 | Set a watchpoint for an expression. @value{GDBN} will break when the |
| 3732 | expression @var{expr} is written into by the program and its value |
| 3733 | changes. The simplest (and the most popular) use of this command is |
| 3734 | to watch the value of a single variable: |
| 3735 | |
| 3736 | @smallexample |
| 3737 | (@value{GDBP}) watch foo |
| 3738 | @end smallexample |
| 3739 | |
| 3740 | If the command includes a @code{@r{[}thread @var{threadnum}@r{]}} |
| 3741 | clause, @value{GDBN} breaks only when the thread identified by |
| 3742 | @var{threadnum} changes the value of @var{expr}. If any other threads |
| 3743 | change the value of @var{expr}, @value{GDBN} will not break. Note |
| 3744 | that watchpoints restricted to a single thread in this way only work |
| 3745 | with Hardware Watchpoints. |
| 3746 | |
| 3747 | Ordinarily a watchpoint respects the scope of variables in @var{expr} |
| 3748 | (see below). The @code{-location} argument tells @value{GDBN} to |
| 3749 | instead watch the memory referred to by @var{expr}. In this case, |
| 3750 | @value{GDBN} will evaluate @var{expr}, take the address of the result, |
| 3751 | and watch the memory at that address. The type of the result is used |
| 3752 | to determine the size of the watched memory. If the expression's |
| 3753 | result does not have an address, then @value{GDBN} will print an |
| 3754 | error. |
| 3755 | |
| 3756 | @kindex rwatch |
| 3757 | @item rwatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} |
| 3758 | Set a watchpoint that will break when the value of @var{expr} is read |
| 3759 | by the program. |
| 3760 | |
| 3761 | @kindex awatch |
| 3762 | @item awatch @r{[}-l@r{|}-location@r{]} @var{expr} @r{[}thread @var{threadnum}@r{]} |
| 3763 | Set a watchpoint that will break when @var{expr} is either read from |
| 3764 | or written into by the program. |
| 3765 | |
| 3766 | @kindex info watchpoints @r{[}@var{n}@dots{}@r{]} |
| 3767 | @item info watchpoints @r{[}@var{n}@dots{}@r{]} |
| 3768 | This command prints a list of watchpoints, using the same format as |
| 3769 | @code{info break} (@pxref{Set Breaks}). |
| 3770 | @end table |
| 3771 | |
| 3772 | If you watch for a change in a numerically entered address you need to |
| 3773 | dereference it, as the address itself is just a constant number which will |
| 3774 | never change. @value{GDBN} refuses to create a watchpoint that watches |
| 3775 | a never-changing value: |
| 3776 | |
| 3777 | @smallexample |
| 3778 | (@value{GDBP}) watch 0x600850 |
| 3779 | Cannot watch constant value 0x600850. |
| 3780 | (@value{GDBP}) watch *(int *) 0x600850 |
| 3781 | Watchpoint 1: *(int *) 6293584 |
| 3782 | @end smallexample |
| 3783 | |
| 3784 | @value{GDBN} sets a @dfn{hardware watchpoint} if possible. Hardware |
| 3785 | watchpoints execute very quickly, and the debugger reports a change in |
| 3786 | value at the exact instruction where the change occurs. If @value{GDBN} |
| 3787 | cannot set a hardware watchpoint, it sets a software watchpoint, which |
| 3788 | executes more slowly and reports the change in value at the next |
| 3789 | @emph{statement}, not the instruction, after the change occurs. |
| 3790 | |
| 3791 | @cindex use only software watchpoints |
| 3792 | You can force @value{GDBN} to use only software watchpoints with the |
| 3793 | @kbd{set can-use-hw-watchpoints 0} command. With this variable set to |
| 3794 | zero, @value{GDBN} will never try to use hardware watchpoints, even if |
| 3795 | the underlying system supports them. (Note that hardware-assisted |
| 3796 | watchpoints that were set @emph{before} setting |
| 3797 | @code{can-use-hw-watchpoints} to zero will still use the hardware |
| 3798 | mechanism of watching expression values.) |
| 3799 | |
| 3800 | @table @code |
| 3801 | @item set can-use-hw-watchpoints |
| 3802 | @kindex set can-use-hw-watchpoints |
| 3803 | Set whether or not to use hardware watchpoints. |
| 3804 | |
| 3805 | @item show can-use-hw-watchpoints |
| 3806 | @kindex show can-use-hw-watchpoints |
| 3807 | Show the current mode of using hardware watchpoints. |
| 3808 | @end table |
| 3809 | |
| 3810 | For remote targets, you can restrict the number of hardware |
| 3811 | watchpoints @value{GDBN} will use, see @ref{set remote |
| 3812 | hardware-breakpoint-limit}. |
| 3813 | |
| 3814 | When you issue the @code{watch} command, @value{GDBN} reports |
| 3815 | |
| 3816 | @smallexample |
| 3817 | Hardware watchpoint @var{num}: @var{expr} |
| 3818 | @end smallexample |
| 3819 | |
| 3820 | @noindent |
| 3821 | if it was able to set a hardware watchpoint. |
| 3822 | |
| 3823 | Currently, the @code{awatch} and @code{rwatch} commands can only set |
| 3824 | hardware watchpoints, because accesses to data that don't change the |
| 3825 | value of the watched expression cannot be detected without examining |
| 3826 | every instruction as it is being executed, and @value{GDBN} does not do |
| 3827 | that currently. If @value{GDBN} finds that it is unable to set a |
| 3828 | hardware breakpoint with the @code{awatch} or @code{rwatch} command, it |
| 3829 | will print a message like this: |
| 3830 | |
| 3831 | @smallexample |
| 3832 | Expression cannot be implemented with read/access watchpoint. |
| 3833 | @end smallexample |
| 3834 | |
| 3835 | Sometimes, @value{GDBN} cannot set a hardware watchpoint because the |
| 3836 | data type of the watched expression is wider than what a hardware |
| 3837 | watchpoint on the target machine can handle. For example, some systems |
| 3838 | can only watch regions that are up to 4 bytes wide; on such systems you |
| 3839 | cannot set hardware watchpoints for an expression that yields a |
| 3840 | double-precision floating-point number (which is typically 8 bytes |
| 3841 | wide). As a work-around, it might be possible to break the large region |
| 3842 | into a series of smaller ones and watch them with separate watchpoints. |
| 3843 | |
| 3844 | If you set too many hardware watchpoints, @value{GDBN} might be unable |
| 3845 | to insert all of them when you resume the execution of your program. |
| 3846 | Since the precise number of active watchpoints is unknown until such |
| 3847 | time as the program is about to be resumed, @value{GDBN} might not be |
| 3848 | able to warn you about this when you set the watchpoints, and the |
| 3849 | warning will be printed only when the program is resumed: |
| 3850 | |
| 3851 | @smallexample |
| 3852 | Hardware watchpoint @var{num}: Could not insert watchpoint |
| 3853 | @end smallexample |
| 3854 | |
| 3855 | @noindent |
| 3856 | If this happens, delete or disable some of the watchpoints. |
| 3857 | |
| 3858 | Watching complex expressions that reference many variables can also |
| 3859 | exhaust the resources available for hardware-assisted watchpoints. |
| 3860 | That's because @value{GDBN} needs to watch every variable in the |
| 3861 | expression with separately allocated resources. |
| 3862 | |
| 3863 | If you call a function interactively using @code{print} or @code{call}, |
| 3864 | any watchpoints you have set will be inactive until @value{GDBN} reaches another |
| 3865 | kind of breakpoint or the call completes. |
| 3866 | |
| 3867 | @value{GDBN} automatically deletes watchpoints that watch local |
| 3868 | (automatic) variables, or expressions that involve such variables, when |
| 3869 | they go out of scope, that is, when the execution leaves the block in |
| 3870 | which these variables were defined. In particular, when the program |
| 3871 | being debugged terminates, @emph{all} local variables go out of scope, |
| 3872 | and so only watchpoints that watch global variables remain set. If you |
| 3873 | rerun the program, you will need to set all such watchpoints again. One |
| 3874 | way of doing that would be to set a code breakpoint at the entry to the |
| 3875 | @code{main} function and when it breaks, set all the watchpoints. |
| 3876 | |
| 3877 | @cindex watchpoints and threads |
| 3878 | @cindex threads and watchpoints |
| 3879 | In multi-threaded programs, watchpoints will detect changes to the |
| 3880 | watched expression from every thread. |
| 3881 | |
| 3882 | @quotation |
| 3883 | @emph{Warning:} In multi-threaded programs, software watchpoints |
| 3884 | have only limited usefulness. If @value{GDBN} creates a software |
| 3885 | watchpoint, it can only watch the value of an expression @emph{in a |
| 3886 | single thread}. If you are confident that the expression can only |
| 3887 | change due to the current thread's activity (and if you are also |
| 3888 | confident that no other thread can become current), then you can use |
| 3889 | software watchpoints as usual. However, @value{GDBN} may not notice |
| 3890 | when a non-current thread's activity changes the expression. (Hardware |
| 3891 | watchpoints, in contrast, watch an expression in all threads.) |
| 3892 | @end quotation |
| 3893 | |
| 3894 | @xref{set remote hardware-watchpoint-limit}. |
| 3895 | |
| 3896 | @node Set Catchpoints |
| 3897 | @subsection Setting Catchpoints |
| 3898 | @cindex catchpoints, setting |
| 3899 | @cindex exception handlers |
| 3900 | @cindex event handling |
| 3901 | |
| 3902 | You can use @dfn{catchpoints} to cause the debugger to stop for certain |
| 3903 | kinds of program events, such as C@t{++} exceptions or the loading of a |
| 3904 | shared library. Use the @code{catch} command to set a catchpoint. |
| 3905 | |
| 3906 | @table @code |
| 3907 | @kindex catch |
| 3908 | @item catch @var{event} |
| 3909 | Stop when @var{event} occurs. @var{event} can be any of the following: |
| 3910 | @table @code |
| 3911 | @item throw |
| 3912 | @cindex stop on C@t{++} exceptions |
| 3913 | The throwing of a C@t{++} exception. |
| 3914 | |
| 3915 | @item catch |
| 3916 | The catching of a C@t{++} exception. |
| 3917 | |
| 3918 | @item exception |
| 3919 | @cindex Ada exception catching |
| 3920 | @cindex catch Ada exceptions |
| 3921 | An Ada exception being raised. If an exception name is specified |
| 3922 | at the end of the command (eg @code{catch exception Program_Error}), |
| 3923 | the debugger will stop only when this specific exception is raised. |
| 3924 | Otherwise, the debugger stops execution when any Ada exception is raised. |
| 3925 | |
| 3926 | When inserting an exception catchpoint on a user-defined exception whose |
| 3927 | name is identical to one of the exceptions defined by the language, the |
| 3928 | fully qualified name must be used as the exception name. Otherwise, |
| 3929 | @value{GDBN} will assume that it should stop on the pre-defined exception |
| 3930 | rather than the user-defined one. For instance, assuming an exception |
| 3931 | called @code{Constraint_Error} is defined in package @code{Pck}, then |
| 3932 | the command to use to catch such exceptions is @kbd{catch exception |
| 3933 | Pck.Constraint_Error}. |
| 3934 | |
| 3935 | @item exception unhandled |
| 3936 | An exception that was raised but is not handled by the program. |
| 3937 | |
| 3938 | @item assert |
| 3939 | A failed Ada assertion. |
| 3940 | |
| 3941 | @item exec |
| 3942 | @cindex break on fork/exec |
| 3943 | A call to @code{exec}. This is currently only available for HP-UX |
| 3944 | and @sc{gnu}/Linux. |
| 3945 | |
| 3946 | @item syscall |
| 3947 | @itemx syscall @r{[}@var{name} @r{|} @var{number}@r{]} @dots{} |
| 3948 | @cindex break on a system call. |
| 3949 | A call to or return from a system call, a.k.a.@: @dfn{syscall}. A |
| 3950 | syscall is a mechanism for application programs to request a service |
| 3951 | from the operating system (OS) or one of the OS system services. |
| 3952 | @value{GDBN} can catch some or all of the syscalls issued by the |
| 3953 | debuggee, and show the related information for each syscall. If no |
| 3954 | argument is specified, calls to and returns from all system calls |
| 3955 | will be caught. |
| 3956 | |
| 3957 | @var{name} can be any system call name that is valid for the |
| 3958 | underlying OS. Just what syscalls are valid depends on the OS. On |
| 3959 | GNU and Unix systems, you can find the full list of valid syscall |
| 3960 | names on @file{/usr/include/asm/unistd.h}. |
| 3961 | |
| 3962 | @c For MS-Windows, the syscall names and the corresponding numbers |
| 3963 | @c can be found, e.g., on this URL: |
| 3964 | @c http://www.metasploit.com/users/opcode/syscalls.html |
| 3965 | @c but we don't support Windows syscalls yet. |
| 3966 | |
| 3967 | Normally, @value{GDBN} knows in advance which syscalls are valid for |
| 3968 | each OS, so you can use the @value{GDBN} command-line completion |
| 3969 | facilities (@pxref{Completion,, command completion}) to list the |
| 3970 | available choices. |
| 3971 | |
| 3972 | You may also specify the system call numerically. A syscall's |
| 3973 | number is the value passed to the OS's syscall dispatcher to |
| 3974 | identify the requested service. When you specify the syscall by its |
| 3975 | name, @value{GDBN} uses its database of syscalls to convert the name |
| 3976 | into the corresponding numeric code, but using the number directly |
| 3977 | may be useful if @value{GDBN}'s database does not have the complete |
| 3978 | list of syscalls on your system (e.g., because @value{GDBN} lags |
| 3979 | behind the OS upgrades). |
| 3980 | |
| 3981 | The example below illustrates how this command works if you don't provide |
| 3982 | arguments to it: |
| 3983 | |
| 3984 | @smallexample |
| 3985 | (@value{GDBP}) catch syscall |
| 3986 | Catchpoint 1 (syscall) |
| 3987 | (@value{GDBP}) r |
| 3988 | Starting program: /tmp/catch-syscall |
| 3989 | |
| 3990 | Catchpoint 1 (call to syscall 'close'), \ |
| 3991 | 0xffffe424 in __kernel_vsyscall () |
| 3992 | (@value{GDBP}) c |
| 3993 | Continuing. |
| 3994 | |
| 3995 | Catchpoint 1 (returned from syscall 'close'), \ |
| 3996 | 0xffffe424 in __kernel_vsyscall () |
| 3997 | (@value{GDBP}) |
| 3998 | @end smallexample |
| 3999 | |
| 4000 | Here is an example of catching a system call by name: |
| 4001 | |
| 4002 | @smallexample |
| 4003 | (@value{GDBP}) catch syscall chroot |
| 4004 | Catchpoint 1 (syscall 'chroot' [61]) |
| 4005 | (@value{GDBP}) r |
| 4006 | Starting program: /tmp/catch-syscall |
| 4007 | |
| 4008 | Catchpoint 1 (call to syscall 'chroot'), \ |
| 4009 | 0xffffe424 in __kernel_vsyscall () |
| 4010 | (@value{GDBP}) c |
| 4011 | Continuing. |
| 4012 | |
| 4013 | Catchpoint 1 (returned from syscall 'chroot'), \ |
| 4014 | 0xffffe424 in __kernel_vsyscall () |
| 4015 | (@value{GDBP}) |
| 4016 | @end smallexample |
| 4017 | |
| 4018 | An example of specifying a system call numerically. In the case |
| 4019 | below, the syscall number has a corresponding entry in the XML |
| 4020 | file, so @value{GDBN} finds its name and prints it: |
| 4021 | |
| 4022 | @smallexample |
| 4023 | (@value{GDBP}) catch syscall 252 |
| 4024 | Catchpoint 1 (syscall(s) 'exit_group') |
| 4025 | (@value{GDBP}) r |
| 4026 | Starting program: /tmp/catch-syscall |
| 4027 | |
| 4028 | Catchpoint 1 (call to syscall 'exit_group'), \ |
| 4029 | 0xffffe424 in __kernel_vsyscall () |
| 4030 | (@value{GDBP}) c |
| 4031 | Continuing. |
| 4032 | |
| 4033 | Program exited normally. |
| 4034 | (@value{GDBP}) |
| 4035 | @end smallexample |
| 4036 | |
| 4037 | However, there can be situations when there is no corresponding name |
| 4038 | in XML file for that syscall number. In this case, @value{GDBN} prints |
| 4039 | a warning message saying that it was not able to find the syscall name, |
| 4040 | but the catchpoint will be set anyway. See the example below: |
| 4041 | |
| 4042 | @smallexample |
| 4043 | (@value{GDBP}) catch syscall 764 |
| 4044 | warning: The number '764' does not represent a known syscall. |
| 4045 | Catchpoint 2 (syscall 764) |
| 4046 | (@value{GDBP}) |
| 4047 | @end smallexample |
| 4048 | |
| 4049 | If you configure @value{GDBN} using the @samp{--without-expat} option, |
| 4050 | it will not be able to display syscall names. Also, if your |
| 4051 | architecture does not have an XML file describing its system calls, |
| 4052 | you will not be able to see the syscall names. It is important to |
| 4053 | notice that these two features are used for accessing the syscall |
| 4054 | name database. In either case, you will see a warning like this: |
| 4055 | |
| 4056 | @smallexample |
| 4057 | (@value{GDBP}) catch syscall |
| 4058 | warning: Could not open "syscalls/i386-linux.xml" |
| 4059 | warning: Could not load the syscall XML file 'syscalls/i386-linux.xml'. |
| 4060 | GDB will not be able to display syscall names. |
| 4061 | Catchpoint 1 (syscall) |
| 4062 | (@value{GDBP}) |
| 4063 | @end smallexample |
| 4064 | |
| 4065 | Of course, the file name will change depending on your architecture and system. |
| 4066 | |
| 4067 | Still using the example above, you can also try to catch a syscall by its |
| 4068 | number. In this case, you would see something like: |
| 4069 | |
| 4070 | @smallexample |
| 4071 | (@value{GDBP}) catch syscall 252 |
| 4072 | Catchpoint 1 (syscall(s) 252) |
| 4073 | @end smallexample |
| 4074 | |
| 4075 | Again, in this case @value{GDBN} would not be able to display syscall's names. |
| 4076 | |
| 4077 | @item fork |
| 4078 | A call to @code{fork}. This is currently only available for HP-UX |
| 4079 | and @sc{gnu}/Linux. |
| 4080 | |
| 4081 | @item vfork |
| 4082 | A call to @code{vfork}. This is currently only available for HP-UX |
| 4083 | and @sc{gnu}/Linux. |
| 4084 | |
| 4085 | @end table |
| 4086 | |
| 4087 | @item tcatch @var{event} |
| 4088 | Set a catchpoint that is enabled only for one stop. The catchpoint is |
| 4089 | automatically deleted after the first time the event is caught. |
| 4090 | |
| 4091 | @end table |
| 4092 | |
| 4093 | Use the @code{info break} command to list the current catchpoints. |
| 4094 | |
| 4095 | There are currently some limitations to C@t{++} exception handling |
| 4096 | (@code{catch throw} and @code{catch catch}) in @value{GDBN}: |
| 4097 | |
| 4098 | @itemize @bullet |
| 4099 | @item |
| 4100 | If you call a function interactively, @value{GDBN} normally returns |
| 4101 | control to you when the function has finished executing. If the call |
| 4102 | raises an exception, however, the call may bypass the mechanism that |
| 4103 | returns control to you and cause your program either to abort or to |
| 4104 | simply continue running until it hits a breakpoint, catches a signal |
| 4105 | that @value{GDBN} is listening for, or exits. This is the case even if |
| 4106 | you set a catchpoint for the exception; catchpoints on exceptions are |
| 4107 | disabled within interactive calls. |
| 4108 | |
| 4109 | @item |
| 4110 | You cannot raise an exception interactively. |
| 4111 | |
| 4112 | @item |
| 4113 | You cannot install an exception handler interactively. |
| 4114 | @end itemize |
| 4115 | |
| 4116 | @cindex raise exceptions |
| 4117 | Sometimes @code{catch} is not the best way to debug exception handling: |
| 4118 | if you need to know exactly where an exception is raised, it is better to |
| 4119 | stop @emph{before} the exception handler is called, since that way you |
| 4120 | can see the stack before any unwinding takes place. If you set a |
| 4121 | breakpoint in an exception handler instead, it may not be easy to find |
| 4122 | out where the exception was raised. |
| 4123 | |
| 4124 | To stop just before an exception handler is called, you need some |
| 4125 | knowledge of the implementation. In the case of @sc{gnu} C@t{++}, exceptions are |
| 4126 | raised by calling a library function named @code{__raise_exception} |
| 4127 | which has the following ANSI C interface: |
| 4128 | |
| 4129 | @smallexample |
| 4130 | /* @var{addr} is where the exception identifier is stored. |
| 4131 | @var{id} is the exception identifier. */ |
| 4132 | void __raise_exception (void **addr, void *id); |
| 4133 | @end smallexample |
| 4134 | |
| 4135 | @noindent |
| 4136 | To make the debugger catch all exceptions before any stack |
| 4137 | unwinding takes place, set a breakpoint on @code{__raise_exception} |
| 4138 | (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Exceptions}). |
| 4139 | |
| 4140 | With a conditional breakpoint (@pxref{Conditions, ,Break Conditions}) |
| 4141 | that depends on the value of @var{id}, you can stop your program when |
| 4142 | a specific exception is raised. You can use multiple conditional |
| 4143 | breakpoints to stop your program when any of a number of exceptions are |
| 4144 | raised. |
| 4145 | |
| 4146 | |
| 4147 | @node Delete Breaks |
| 4148 | @subsection Deleting Breakpoints |
| 4149 | |
| 4150 | @cindex clearing breakpoints, watchpoints, catchpoints |
| 4151 | @cindex deleting breakpoints, watchpoints, catchpoints |
| 4152 | It is often necessary to eliminate a breakpoint, watchpoint, or |
| 4153 | catchpoint once it has done its job and you no longer want your program |
| 4154 | to stop there. This is called @dfn{deleting} the breakpoint. A |
| 4155 | breakpoint that has been deleted no longer exists; it is forgotten. |
| 4156 | |
| 4157 | With the @code{clear} command you can delete breakpoints according to |
| 4158 | where they are in your program. With the @code{delete} command you can |
| 4159 | delete individual breakpoints, watchpoints, or catchpoints by specifying |
| 4160 | their breakpoint numbers. |
| 4161 | |
| 4162 | It is not necessary to delete a breakpoint to proceed past it. @value{GDBN} |
| 4163 | automatically ignores breakpoints on the first instruction to be executed |
| 4164 | when you continue execution without changing the execution address. |
| 4165 | |
| 4166 | @table @code |
| 4167 | @kindex clear |
| 4168 | @item clear |
| 4169 | Delete any breakpoints at the next instruction to be executed in the |
| 4170 | selected stack frame (@pxref{Selection, ,Selecting a Frame}). When |
| 4171 | the innermost frame is selected, this is a good way to delete a |
| 4172 | breakpoint where your program just stopped. |
| 4173 | |
| 4174 | @item clear @var{location} |
| 4175 | Delete any breakpoints set at the specified @var{location}. |
| 4176 | @xref{Specify Location}, for the various forms of @var{location}; the |
| 4177 | most useful ones are listed below: |
| 4178 | |
| 4179 | @table @code |
| 4180 | @item clear @var{function} |
| 4181 | @itemx clear @var{filename}:@var{function} |
| 4182 | Delete any breakpoints set at entry to the named @var{function}. |
| 4183 | |
| 4184 | @item clear @var{linenum} |
| 4185 | @itemx clear @var{filename}:@var{linenum} |
| 4186 | Delete any breakpoints set at or within the code of the specified |
| 4187 | @var{linenum} of the specified @var{filename}. |
| 4188 | @end table |
| 4189 | |
| 4190 | @cindex delete breakpoints |
| 4191 | @kindex delete |
| 4192 | @kindex d @r{(@code{delete})} |
| 4193 | @item delete @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]} |
| 4194 | Delete the breakpoints, watchpoints, or catchpoints of the breakpoint |
| 4195 | ranges specified as arguments. If no argument is specified, delete all |
| 4196 | breakpoints (@value{GDBN} asks confirmation, unless you have @code{set |
| 4197 | confirm off}). You can abbreviate this command as @code{d}. |
| 4198 | @end table |
| 4199 | |
| 4200 | @node Disabling |
| 4201 | @subsection Disabling Breakpoints |
| 4202 | |
| 4203 | @cindex enable/disable a breakpoint |
| 4204 | Rather than deleting a breakpoint, watchpoint, or catchpoint, you might |
| 4205 | prefer to @dfn{disable} it. This makes the breakpoint inoperative as if |
| 4206 | it had been deleted, but remembers the information on the breakpoint so |
| 4207 | that you can @dfn{enable} it again later. |
| 4208 | |
| 4209 | You disable and enable breakpoints, watchpoints, and catchpoints with |
| 4210 | the @code{enable} and @code{disable} commands, optionally specifying |
| 4211 | one or more breakpoint numbers as arguments. Use @code{info break} to |
| 4212 | print a list of all breakpoints, watchpoints, and catchpoints if you |
| 4213 | do not know which numbers to use. |
| 4214 | |
| 4215 | Disabling and enabling a breakpoint that has multiple locations |
| 4216 | affects all of its locations. |
| 4217 | |
| 4218 | A breakpoint, watchpoint, or catchpoint can have any of four different |
| 4219 | states of enablement: |
| 4220 | |
| 4221 | @itemize @bullet |
| 4222 | @item |
| 4223 | Enabled. The breakpoint stops your program. A breakpoint set |
| 4224 | with the @code{break} command starts out in this state. |
| 4225 | @item |
| 4226 | Disabled. The breakpoint has no effect on your program. |
| 4227 | @item |
| 4228 | Enabled once. The breakpoint stops your program, but then becomes |
| 4229 | disabled. |
| 4230 | @item |
| 4231 | Enabled for deletion. The breakpoint stops your program, but |
| 4232 | immediately after it does so it is deleted permanently. A breakpoint |
| 4233 | set with the @code{tbreak} command starts out in this state. |
| 4234 | @end itemize |
| 4235 | |
| 4236 | You can use the following commands to enable or disable breakpoints, |
| 4237 | watchpoints, and catchpoints: |
| 4238 | |
| 4239 | @table @code |
| 4240 | @kindex disable |
| 4241 | @kindex dis @r{(@code{disable})} |
| 4242 | @item disable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]} |
| 4243 | Disable the specified breakpoints---or all breakpoints, if none are |
| 4244 | listed. A disabled breakpoint has no effect but is not forgotten. All |
| 4245 | options such as ignore-counts, conditions and commands are remembered in |
| 4246 | case the breakpoint is enabled again later. You may abbreviate |
| 4247 | @code{disable} as @code{dis}. |
| 4248 | |
| 4249 | @kindex enable |
| 4250 | @item enable @r{[}breakpoints@r{]} @r{[}@var{range}@dots{}@r{]} |
| 4251 | Enable the specified breakpoints (or all defined breakpoints). They |
| 4252 | become effective once again in stopping your program. |
| 4253 | |
| 4254 | @item enable @r{[}breakpoints@r{]} once @var{range}@dots{} |
| 4255 | Enable the specified breakpoints temporarily. @value{GDBN} disables any |
| 4256 | of these breakpoints immediately after stopping your program. |
| 4257 | |
| 4258 | @item enable @r{[}breakpoints@r{]} delete @var{range}@dots{} |
| 4259 | Enable the specified breakpoints to work once, then die. @value{GDBN} |
| 4260 | deletes any of these breakpoints as soon as your program stops there. |
| 4261 | Breakpoints set by the @code{tbreak} command start out in this state. |
| 4262 | @end table |
| 4263 | |
| 4264 | @c FIXME: I think the following ``Except for [...] @code{tbreak}'' is |
| 4265 | @c confusing: tbreak is also initially enabled. |
| 4266 | Except for a breakpoint set with @code{tbreak} (@pxref{Set Breaks, |
| 4267 | ,Setting Breakpoints}), breakpoints that you set are initially enabled; |
| 4268 | subsequently, they become disabled or enabled only when you use one of |
| 4269 | the commands above. (The command @code{until} can set and delete a |
| 4270 | breakpoint of its own, but it does not change the state of your other |
| 4271 | breakpoints; see @ref{Continuing and Stepping, ,Continuing and |
| 4272 | Stepping}.) |
| 4273 | |
| 4274 | @node Conditions |
| 4275 | @subsection Break Conditions |
| 4276 | @cindex conditional breakpoints |
| 4277 | @cindex breakpoint conditions |
| 4278 | |
| 4279 | @c FIXME what is scope of break condition expr? Context where wanted? |
| 4280 | @c in particular for a watchpoint? |
| 4281 | The simplest sort of breakpoint breaks every time your program reaches a |
| 4282 | specified place. You can also specify a @dfn{condition} for a |
| 4283 | breakpoint. A condition is just a Boolean expression in your |
| 4284 | programming language (@pxref{Expressions, ,Expressions}). A breakpoint with |
| 4285 | a condition evaluates the expression each time your program reaches it, |
| 4286 | and your program stops only if the condition is @emph{true}. |
| 4287 | |
| 4288 | This is the converse of using assertions for program validation; in that |
| 4289 | situation, you want to stop when the assertion is violated---that is, |
| 4290 | when the condition is false. In C, if you want to test an assertion expressed |
| 4291 | by the condition @var{assert}, you should set the condition |
| 4292 | @samp{! @var{assert}} on the appropriate breakpoint. |
| 4293 | |
| 4294 | Conditions are also accepted for watchpoints; you may not need them, |
| 4295 | since a watchpoint is inspecting the value of an expression anyhow---but |
| 4296 | it might be simpler, say, to just set a watchpoint on a variable name, |
| 4297 | and specify a condition that tests whether the new value is an interesting |
| 4298 | one. |
| 4299 | |
| 4300 | Break conditions can have side effects, and may even call functions in |
| 4301 | your program. This can be useful, for example, to activate functions |
| 4302 | that log program progress, or to use your own print functions to |
| 4303 | format special data structures. The effects are completely predictable |
| 4304 | unless there is another enabled breakpoint at the same address. (In |
| 4305 | that case, @value{GDBN} might see the other breakpoint first and stop your |
| 4306 | program without checking the condition of this one.) Note that |
| 4307 | breakpoint commands are usually more convenient and flexible than break |
| 4308 | conditions for the |
| 4309 | purpose of performing side effects when a breakpoint is reached |
| 4310 | (@pxref{Break Commands, ,Breakpoint Command Lists}). |
| 4311 | |
| 4312 | Break conditions can be specified when a breakpoint is set, by using |
| 4313 | @samp{if} in the arguments to the @code{break} command. @xref{Set |
| 4314 | Breaks, ,Setting Breakpoints}. They can also be changed at any time |
| 4315 | with the @code{condition} command. |
| 4316 | |
| 4317 | You can also use the @code{if} keyword with the @code{watch} command. |
| 4318 | The @code{catch} command does not recognize the @code{if} keyword; |
| 4319 | @code{condition} is the only way to impose a further condition on a |
| 4320 | catchpoint. |
| 4321 | |
| 4322 | @table @code |
| 4323 | @kindex condition |
| 4324 | @item condition @var{bnum} @var{expression} |
| 4325 | Specify @var{expression} as the break condition for breakpoint, |
| 4326 | watchpoint, or catchpoint number @var{bnum}. After you set a condition, |
| 4327 | breakpoint @var{bnum} stops your program only if the value of |
| 4328 | @var{expression} is true (nonzero, in C). When you use |
| 4329 | @code{condition}, @value{GDBN} checks @var{expression} immediately for |
| 4330 | syntactic correctness, and to determine whether symbols in it have |
| 4331 | referents in the context of your breakpoint. If @var{expression} uses |
| 4332 | symbols not referenced in the context of the breakpoint, @value{GDBN} |
| 4333 | prints an error message: |
| 4334 | |
| 4335 | @smallexample |
| 4336 | No symbol "foo" in current context. |
| 4337 | @end smallexample |
| 4338 | |
| 4339 | @noindent |
| 4340 | @value{GDBN} does |
| 4341 | not actually evaluate @var{expression} at the time the @code{condition} |
| 4342 | command (or a command that sets a breakpoint with a condition, like |
| 4343 | @code{break if @dots{}}) is given, however. @xref{Expressions, ,Expressions}. |
| 4344 | |
| 4345 | @item condition @var{bnum} |
| 4346 | Remove the condition from breakpoint number @var{bnum}. It becomes |
| 4347 | an ordinary unconditional breakpoint. |
| 4348 | @end table |
| 4349 | |
| 4350 | @cindex ignore count (of breakpoint) |
| 4351 | A special case of a breakpoint condition is to stop only when the |
| 4352 | breakpoint has been reached a certain number of times. This is so |
| 4353 | useful that there is a special way to do it, using the @dfn{ignore |
| 4354 | count} of the breakpoint. Every breakpoint has an ignore count, which |
| 4355 | is an integer. Most of the time, the ignore count is zero, and |
| 4356 | therefore has no effect. But if your program reaches a breakpoint whose |
| 4357 | ignore count is positive, then instead of stopping, it just decrements |
| 4358 | the ignore count by one and continues. As a result, if the ignore count |
| 4359 | value is @var{n}, the breakpoint does not stop the next @var{n} times |
| 4360 | your program reaches it. |
| 4361 | |
| 4362 | @table @code |
| 4363 | @kindex ignore |
| 4364 | @item ignore @var{bnum} @var{count} |
| 4365 | Set the ignore count of breakpoint number @var{bnum} to @var{count}. |
| 4366 | The next @var{count} times the breakpoint is reached, your program's |
| 4367 | execution does not stop; other than to decrement the ignore count, @value{GDBN} |
| 4368 | takes no action. |
| 4369 | |
| 4370 | To make the breakpoint stop the next time it is reached, specify |
| 4371 | a count of zero. |
| 4372 | |
| 4373 | When you use @code{continue} to resume execution of your program from a |
| 4374 | breakpoint, you can specify an ignore count directly as an argument to |
| 4375 | @code{continue}, rather than using @code{ignore}. @xref{Continuing and |
| 4376 | Stepping,,Continuing and Stepping}. |
| 4377 | |
| 4378 | If a breakpoint has a positive ignore count and a condition, the |
| 4379 | condition is not checked. Once the ignore count reaches zero, |
| 4380 | @value{GDBN} resumes checking the condition. |
| 4381 | |
| 4382 | You could achieve the effect of the ignore count with a condition such |
| 4383 | as @w{@samp{$foo-- <= 0}} using a debugger convenience variable that |
| 4384 | is decremented each time. @xref{Convenience Vars, ,Convenience |
| 4385 | Variables}. |
| 4386 | @end table |
| 4387 | |
| 4388 | Ignore counts apply to breakpoints, watchpoints, and catchpoints. |
| 4389 | |
| 4390 | |
| 4391 | @node Break Commands |
| 4392 | @subsection Breakpoint Command Lists |
| 4393 | |
| 4394 | @cindex breakpoint commands |
| 4395 | You can give any breakpoint (or watchpoint or catchpoint) a series of |
| 4396 | commands to execute when your program stops due to that breakpoint. For |
| 4397 | example, you might want to print the values of certain expressions, or |
| 4398 | enable other breakpoints. |
| 4399 | |
| 4400 | @table @code |
| 4401 | @kindex commands |
| 4402 | @kindex end@r{ (breakpoint commands)} |
| 4403 | @item commands @r{[}@var{range}@dots{}@r{]} |
| 4404 | @itemx @dots{} @var{command-list} @dots{} |
| 4405 | @itemx end |
| 4406 | Specify a list of commands for the given breakpoints. The commands |
| 4407 | themselves appear on the following lines. Type a line containing just |
| 4408 | @code{end} to terminate the commands. |
| 4409 | |
| 4410 | To remove all commands from a breakpoint, type @code{commands} and |
| 4411 | follow it immediately with @code{end}; that is, give no commands. |
| 4412 | |
| 4413 | With no argument, @code{commands} refers to the last breakpoint, |
| 4414 | watchpoint, or catchpoint set (not to the breakpoint most recently |
| 4415 | encountered). If the most recent breakpoints were set with a single |
| 4416 | command, then the @code{commands} will apply to all the breakpoints |
| 4417 | set by that command. This applies to breakpoints set by |
| 4418 | @code{rbreak}, and also applies when a single @code{break} command |
| 4419 | creates multiple breakpoints (@pxref{Ambiguous Expressions,,Ambiguous |
| 4420 | Expressions}). |
| 4421 | @end table |
| 4422 | |
| 4423 | Pressing @key{RET} as a means of repeating the last @value{GDBN} command is |
| 4424 | disabled within a @var{command-list}. |
| 4425 | |
| 4426 | You can use breakpoint commands to start your program up again. Simply |
| 4427 | use the @code{continue} command, or @code{step}, or any other command |
| 4428 | that resumes execution. |
| 4429 | |
| 4430 | Any other commands in the command list, after a command that resumes |
| 4431 | execution, are ignored. This is because any time you resume execution |
| 4432 | (even with a simple @code{next} or @code{step}), you may encounter |
| 4433 | another breakpoint---which could have its own command list, leading to |
| 4434 | ambiguities about which list to execute. |
| 4435 | |
| 4436 | @kindex silent |
| 4437 | If the first command you specify in a command list is @code{silent}, the |
| 4438 | usual message about stopping at a breakpoint is not printed. This may |
| 4439 | be desirable for breakpoints that are to print a specific message and |
| 4440 | then continue. If none of the remaining commands print anything, you |
| 4441 | see no sign that the breakpoint was reached. @code{silent} is |
| 4442 | meaningful only at the beginning of a breakpoint command list. |
| 4443 | |
| 4444 | The commands @code{echo}, @code{output}, and @code{printf} allow you to |
| 4445 | print precisely controlled output, and are often useful in silent |
| 4446 | breakpoints. @xref{Output, ,Commands for Controlled Output}. |
| 4447 | |
| 4448 | For example, here is how you could use breakpoint commands to print the |
| 4449 | value of @code{x} at entry to @code{foo} whenever @code{x} is positive. |
| 4450 | |
| 4451 | @smallexample |
| 4452 | break foo if x>0 |
| 4453 | commands |
| 4454 | silent |
| 4455 | printf "x is %d\n",x |
| 4456 | cont |
| 4457 | end |
| 4458 | @end smallexample |
| 4459 | |
| 4460 | One application for breakpoint commands is to compensate for one bug so |
| 4461 | you can test for another. Put a breakpoint just after the erroneous line |
| 4462 | of code, give it a condition to detect the case in which something |
| 4463 | erroneous has been done, and give it commands to assign correct values |
| 4464 | to any variables that need them. End with the @code{continue} command |
| 4465 | so that your program does not stop, and start with the @code{silent} |
| 4466 | command so that no output is produced. Here is an example: |
| 4467 | |
| 4468 | @smallexample |
| 4469 | break 403 |
| 4470 | commands |
| 4471 | silent |
| 4472 | set x = y + 4 |
| 4473 | cont |
| 4474 | end |
| 4475 | @end smallexample |
| 4476 | |
| 4477 | @node Save Breakpoints |
| 4478 | @subsection How to save breakpoints to a file |
| 4479 | |
| 4480 | To save breakpoint definitions to a file use the @w{@code{save |
| 4481 | breakpoints}} command. |
| 4482 | |
| 4483 | @table @code |
| 4484 | @kindex save breakpoints |
| 4485 | @cindex save breakpoints to a file for future sessions |
| 4486 | @item save breakpoints [@var{filename}] |
| 4487 | This command saves all current breakpoint definitions together with |
| 4488 | their commands and ignore counts, into a file @file{@var{filename}} |
| 4489 | suitable for use in a later debugging session. This includes all |
| 4490 | types of breakpoints (breakpoints, watchpoints, catchpoints, |
| 4491 | tracepoints). To read the saved breakpoint definitions, use the |
| 4492 | @code{source} command (@pxref{Command Files}). Note that watchpoints |
| 4493 | with expressions involving local variables may fail to be recreated |
| 4494 | because it may not be possible to access the context where the |
| 4495 | watchpoint is valid anymore. Because the saved breakpoint definitions |
| 4496 | are simply a sequence of @value{GDBN} commands that recreate the |
| 4497 | breakpoints, you can edit the file in your favorite editing program, |
| 4498 | and remove the breakpoint definitions you're not interested in, or |
| 4499 | that can no longer be recreated. |
| 4500 | @end table |
| 4501 | |
| 4502 | @c @ifclear BARETARGET |
| 4503 | @node Error in Breakpoints |
| 4504 | @subsection ``Cannot insert breakpoints'' |
| 4505 | |
| 4506 | If you request too many active hardware-assisted breakpoints and |
| 4507 | watchpoints, you will see this error message: |
| 4508 | |
| 4509 | @c FIXME: the precise wording of this message may change; the relevant |
| 4510 | @c source change is not committed yet (Sep 3, 1999). |
| 4511 | @smallexample |
| 4512 | Stopped; cannot insert breakpoints. |
| 4513 | You may have requested too many hardware breakpoints and watchpoints. |
| 4514 | @end smallexample |
| 4515 | |
| 4516 | @noindent |
| 4517 | This message is printed when you attempt to resume the program, since |
| 4518 | only then @value{GDBN} knows exactly how many hardware breakpoints and |
| 4519 | watchpoints it needs to insert. |
| 4520 | |
| 4521 | When this message is printed, you need to disable or remove some of the |
| 4522 | hardware-assisted breakpoints and watchpoints, and then continue. |
| 4523 | |
| 4524 | @node Breakpoint-related Warnings |
| 4525 | @subsection ``Breakpoint address adjusted...'' |
| 4526 | @cindex breakpoint address adjusted |
| 4527 | |
| 4528 | Some processor architectures place constraints on the addresses at |
| 4529 | which breakpoints may be placed. For architectures thus constrained, |
| 4530 | @value{GDBN} will attempt to adjust the breakpoint's address to comply |
| 4531 | with the constraints dictated by the architecture. |
| 4532 | |
| 4533 | One example of such an architecture is the Fujitsu FR-V. The FR-V is |
| 4534 | a VLIW architecture in which a number of RISC-like instructions may be |
| 4535 | bundled together for parallel execution. The FR-V architecture |
| 4536 | constrains the location of a breakpoint instruction within such a |
| 4537 | bundle to the instruction with the lowest address. @value{GDBN} |
| 4538 | honors this constraint by adjusting a breakpoint's address to the |
| 4539 | first in the bundle. |
| 4540 | |
| 4541 | It is not uncommon for optimized code to have bundles which contain |
| 4542 | instructions from different source statements, thus it may happen that |
| 4543 | a breakpoint's address will be adjusted from one source statement to |
| 4544 | another. Since this adjustment may significantly alter @value{GDBN}'s |
| 4545 | breakpoint related behavior from what the user expects, a warning is |
| 4546 | printed when the breakpoint is first set and also when the breakpoint |
| 4547 | is hit. |
| 4548 | |
| 4549 | A warning like the one below is printed when setting a breakpoint |
| 4550 | that's been subject to address adjustment: |
| 4551 | |
| 4552 | @smallexample |
| 4553 | warning: Breakpoint address adjusted from 0x00010414 to 0x00010410. |
| 4554 | @end smallexample |
| 4555 | |
| 4556 | Such warnings are printed both for user settable and @value{GDBN}'s |
| 4557 | internal breakpoints. If you see one of these warnings, you should |
| 4558 | verify that a breakpoint set at the adjusted address will have the |
| 4559 | desired affect. If not, the breakpoint in question may be removed and |
| 4560 | other breakpoints may be set which will have the desired behavior. |
| 4561 | E.g., it may be sufficient to place the breakpoint at a later |
| 4562 | instruction. A conditional breakpoint may also be useful in some |
| 4563 | cases to prevent the breakpoint from triggering too often. |
| 4564 | |
| 4565 | @value{GDBN} will also issue a warning when stopping at one of these |
| 4566 | adjusted breakpoints: |
| 4567 | |
| 4568 | @smallexample |
| 4569 | warning: Breakpoint 1 address previously adjusted from 0x00010414 |
| 4570 | to 0x00010410. |
| 4571 | @end smallexample |
| 4572 | |
| 4573 | When this warning is encountered, it may be too late to take remedial |
| 4574 | action except in cases where the breakpoint is hit earlier or more |
| 4575 | frequently than expected. |
| 4576 | |
| 4577 | @node Continuing and Stepping |
| 4578 | @section Continuing and Stepping |
| 4579 | |
| 4580 | @cindex stepping |
| 4581 | @cindex continuing |
| 4582 | @cindex resuming execution |
| 4583 | @dfn{Continuing} means resuming program execution until your program |
| 4584 | completes normally. In contrast, @dfn{stepping} means executing just |
| 4585 | one more ``step'' of your program, where ``step'' may mean either one |
| 4586 | line of source code, or one machine instruction (depending on what |
| 4587 | particular command you use). Either when continuing or when stepping, |
| 4588 | your program may stop even sooner, due to a breakpoint or a signal. (If |
| 4589 | it stops due to a signal, you may want to use @code{handle}, or use |
| 4590 | @samp{signal 0} to resume execution. @xref{Signals, ,Signals}.) |
| 4591 | |
| 4592 | @table @code |
| 4593 | @kindex continue |
| 4594 | @kindex c @r{(@code{continue})} |
| 4595 | @kindex fg @r{(resume foreground execution)} |
| 4596 | @item continue @r{[}@var{ignore-count}@r{]} |
| 4597 | @itemx c @r{[}@var{ignore-count}@r{]} |
| 4598 | @itemx fg @r{[}@var{ignore-count}@r{]} |
| 4599 | Resume program execution, at the address where your program last stopped; |
| 4600 | any breakpoints set at that address are bypassed. The optional argument |
| 4601 | @var{ignore-count} allows you to specify a further number of times to |
| 4602 | ignore a breakpoint at this location; its effect is like that of |
| 4603 | @code{ignore} (@pxref{Conditions, ,Break Conditions}). |
| 4604 | |
| 4605 | The argument @var{ignore-count} is meaningful only when your program |
| 4606 | stopped due to a breakpoint. At other times, the argument to |
| 4607 | @code{continue} is ignored. |
| 4608 | |
| 4609 | The synonyms @code{c} and @code{fg} (for @dfn{foreground}, as the |
| 4610 | debugged program is deemed to be the foreground program) are provided |
| 4611 | purely for convenience, and have exactly the same behavior as |
| 4612 | @code{continue}. |
| 4613 | @end table |
| 4614 | |
| 4615 | To resume execution at a different place, you can use @code{return} |
| 4616 | (@pxref{Returning, ,Returning from a Function}) to go back to the |
| 4617 | calling function; or @code{jump} (@pxref{Jumping, ,Continuing at a |
| 4618 | Different Address}) to go to an arbitrary location in your program. |
| 4619 | |
| 4620 | A typical technique for using stepping is to set a breakpoint |
| 4621 | (@pxref{Breakpoints, ,Breakpoints; Watchpoints; and Catchpoints}) at the |
| 4622 | beginning of the function or the section of your program where a problem |
| 4623 | is believed to lie, run your program until it stops at that breakpoint, |
| 4624 | and then step through the suspect area, examining the variables that are |
| 4625 | interesting, until you see the problem happen. |
| 4626 | |
| 4627 | @table @code |
| 4628 | @kindex step |
| 4629 | @kindex s @r{(@code{step})} |
| 4630 | @item step |
| 4631 | Continue running your program until control reaches a different source |
| 4632 | line, then stop it and return control to @value{GDBN}. This command is |
| 4633 | abbreviated @code{s}. |
| 4634 | |
| 4635 | @quotation |
| 4636 | @c "without debugging information" is imprecise; actually "without line |
| 4637 | @c numbers in the debugging information". (gcc -g1 has debugging info but |
| 4638 | @c not line numbers). But it seems complex to try to make that |
| 4639 | @c distinction here. |
| 4640 | @emph{Warning:} If you use the @code{step} command while control is |
| 4641 | within a function that was compiled without debugging information, |
| 4642 | execution proceeds until control reaches a function that does have |
| 4643 | debugging information. Likewise, it will not step into a function which |
| 4644 | is compiled without debugging information. To step through functions |
| 4645 | without debugging information, use the @code{stepi} command, described |
| 4646 | below. |
| 4647 | @end quotation |
| 4648 | |
| 4649 | The @code{step} command only stops at the first instruction of a source |
| 4650 | line. This prevents the multiple stops that could otherwise occur in |
| 4651 | @code{switch} statements, @code{for} loops, etc. @code{step} continues |
| 4652 | to stop if a function that has debugging information is called within |
| 4653 | the line. In other words, @code{step} @emph{steps inside} any functions |
| 4654 | called within the line. |
| 4655 | |
| 4656 | Also, the @code{step} command only enters a function if there is line |
| 4657 | number information for the function. Otherwise it acts like the |
| 4658 | @code{next} command. This avoids problems when using @code{cc -gl} |
| 4659 | on MIPS machines. Previously, @code{step} entered subroutines if there |
| 4660 | was any debugging information about the routine. |
| 4661 | |
| 4662 | @item step @var{count} |
| 4663 | Continue running as in @code{step}, but do so @var{count} times. If a |
| 4664 | breakpoint is reached, or a signal not related to stepping occurs before |
| 4665 | @var{count} steps, stepping stops right away. |
| 4666 | |
| 4667 | @kindex next |
| 4668 | @kindex n @r{(@code{next})} |
| 4669 | @item next @r{[}@var{count}@r{]} |
| 4670 | Continue to the next source line in the current (innermost) stack frame. |
| 4671 | This is similar to @code{step}, but function calls that appear within |
| 4672 | the line of code are executed without stopping. Execution stops when |
| 4673 | control reaches a different line of code at the original stack level |
| 4674 | that was executing when you gave the @code{next} command. This command |
| 4675 | is abbreviated @code{n}. |
| 4676 | |
| 4677 | An argument @var{count} is a repeat count, as for @code{step}. |
| 4678 | |
| 4679 | |
| 4680 | @c FIX ME!! Do we delete this, or is there a way it fits in with |
| 4681 | @c the following paragraph? --- Vctoria |
| 4682 | @c |
| 4683 | @c @code{next} within a function that lacks debugging information acts like |
| 4684 | @c @code{step}, but any function calls appearing within the code of the |
| 4685 | @c function are executed without stopping. |
| 4686 | |
| 4687 | The @code{next} command only stops at the first instruction of a |
| 4688 | source line. This prevents multiple stops that could otherwise occur in |
| 4689 | @code{switch} statements, @code{for} loops, etc. |
| 4690 | |
| 4691 | @kindex set step-mode |
| 4692 | @item set step-mode |
| 4693 | @cindex functions without line info, and stepping |
| 4694 | @cindex stepping into functions with no line info |
| 4695 | @itemx set step-mode on |
| 4696 | The @code{set step-mode on} command causes the @code{step} command to |
| 4697 | stop at the first instruction of a function which contains no debug line |
| 4698 | information rather than stepping over it. |
| 4699 | |
| 4700 | This is useful in cases where you may be interested in inspecting the |
| 4701 | machine instructions of a function which has no symbolic info and do not |
| 4702 | want @value{GDBN} to automatically skip over this function. |
| 4703 | |
| 4704 | @item set step-mode off |
| 4705 | Causes the @code{step} command to step over any functions which contains no |
| 4706 | debug information. This is the default. |
| 4707 | |
| 4708 | @item show step-mode |
| 4709 | Show whether @value{GDBN} will stop in or step over functions without |
| 4710 | source line debug information. |
| 4711 | |
| 4712 | @kindex finish |
| 4713 | @kindex fin @r{(@code{finish})} |
| 4714 | @item finish |
| 4715 | Continue running until just after function in the selected stack frame |
| 4716 | returns. Print the returned value (if any). This command can be |
| 4717 | abbreviated as @code{fin}. |
| 4718 | |
| 4719 | Contrast this with the @code{return} command (@pxref{Returning, |
| 4720 | ,Returning from a Function}). |
| 4721 | |
| 4722 | @kindex until |
| 4723 | @kindex u @r{(@code{until})} |
| 4724 | @cindex run until specified location |
| 4725 | @item until |
| 4726 | @itemx u |
| 4727 | Continue running until a source line past the current line, in the |
| 4728 | current stack frame, is reached. This command is used to avoid single |
| 4729 | stepping through a loop more than once. It is like the @code{next} |
| 4730 | command, except that when @code{until} encounters a jump, it |
| 4731 | automatically continues execution until the program counter is greater |
| 4732 | than the address of the jump. |
| 4733 | |
| 4734 | This means that when you reach the end of a loop after single stepping |
| 4735 | though it, @code{until} makes your program continue execution until it |
| 4736 | exits the loop. In contrast, a @code{next} command at the end of a loop |
| 4737 | simply steps back to the beginning of the loop, which forces you to step |
| 4738 | through the next iteration. |
| 4739 | |
| 4740 | @code{until} always stops your program if it attempts to exit the current |
| 4741 | stack frame. |
| 4742 | |
| 4743 | @code{until} may produce somewhat counterintuitive results if the order |
| 4744 | of machine code does not match the order of the source lines. For |
| 4745 | example, in the following excerpt from a debugging session, the @code{f} |
| 4746 | (@code{frame}) command shows that execution is stopped at line |
| 4747 | @code{206}; yet when we use @code{until}, we get to line @code{195}: |
| 4748 | |
| 4749 | @smallexample |
| 4750 | (@value{GDBP}) f |
| 4751 | #0 main (argc=4, argv=0xf7fffae8) at m4.c:206 |
| 4752 | 206 expand_input(); |
| 4753 | (@value{GDBP}) until |
| 4754 | 195 for ( ; argc > 0; NEXTARG) @{ |
| 4755 | @end smallexample |
| 4756 | |
| 4757 | This happened because, for execution efficiency, the compiler had |
| 4758 | generated code for the loop closure test at the end, rather than the |
| 4759 | start, of the loop---even though the test in a C @code{for}-loop is |
| 4760 | written before the body of the loop. The @code{until} command appeared |
| 4761 | to step back to the beginning of the loop when it advanced to this |
| 4762 | expression; however, it has not really gone to an earlier |
| 4763 | statement---not in terms of the actual machine code. |
| 4764 | |
| 4765 | @code{until} with no argument works by means of single |
| 4766 | instruction stepping, and hence is slower than @code{until} with an |
| 4767 | argument. |
| 4768 | |
| 4769 | @item until @var{location} |
| 4770 | @itemx u @var{location} |
| 4771 | Continue running your program until either the specified location is |
| 4772 | reached, or the current stack frame returns. @var{location} is any of |
| 4773 | the forms described in @ref{Specify Location}. |
| 4774 | This form of the command uses temporary breakpoints, and |
| 4775 | hence is quicker than @code{until} without an argument. The specified |
| 4776 | location is actually reached only if it is in the current frame. This |
| 4777 | implies that @code{until} can be used to skip over recursive function |
| 4778 | invocations. For instance in the code below, if the current location is |
| 4779 | line @code{96}, issuing @code{until 99} will execute the program up to |
| 4780 | line @code{99} in the same invocation of factorial, i.e., after the inner |
| 4781 | invocations have returned. |
| 4782 | |
| 4783 | @smallexample |
| 4784 | 94 int factorial (int value) |
| 4785 | 95 @{ |
| 4786 | 96 if (value > 1) @{ |
| 4787 | 97 value *= factorial (value - 1); |
| 4788 | 98 @} |
| 4789 | 99 return (value); |
| 4790 | 100 @} |
| 4791 | @end smallexample |
| 4792 | |
| 4793 | |
| 4794 | @kindex advance @var{location} |
| 4795 | @itemx advance @var{location} |
| 4796 | Continue running the program up to the given @var{location}. An argument is |
| 4797 | required, which should be of one of the forms described in |
| 4798 | @ref{Specify Location}. |
| 4799 | Execution will also stop upon exit from the current stack |
| 4800 | frame. This command is similar to @code{until}, but @code{advance} will |
| 4801 | not skip over recursive function calls, and the target location doesn't |
| 4802 | have to be in the same frame as the current one. |
| 4803 | |
| 4804 | |
| 4805 | @kindex stepi |
| 4806 | @kindex si @r{(@code{stepi})} |
| 4807 | @item stepi |
| 4808 | @itemx stepi @var{arg} |
| 4809 | @itemx si |
| 4810 | Execute one machine instruction, then stop and return to the debugger. |
| 4811 | |
| 4812 | It is often useful to do @samp{display/i $pc} when stepping by machine |
| 4813 | instructions. This makes @value{GDBN} automatically display the next |
| 4814 | instruction to be executed, each time your program stops. @xref{Auto |
| 4815 | Display,, Automatic Display}. |
| 4816 | |
| 4817 | An argument is a repeat count, as in @code{step}. |
| 4818 | |
| 4819 | @need 750 |
| 4820 | @kindex nexti |
| 4821 | @kindex ni @r{(@code{nexti})} |
| 4822 | @item nexti |
| 4823 | @itemx nexti @var{arg} |
| 4824 | @itemx ni |
| 4825 | Execute one machine instruction, but if it is a function call, |
| 4826 | proceed until the function returns. |
| 4827 | |
| 4828 | An argument is a repeat count, as in @code{next}. |
| 4829 | @end table |
| 4830 | |
| 4831 | @node Signals |
| 4832 | @section Signals |
| 4833 | @cindex signals |
| 4834 | |
| 4835 | A signal is an asynchronous event that can happen in a program. The |
| 4836 | operating system defines the possible kinds of signals, and gives each |
| 4837 | kind a name and a number. For example, in Unix @code{SIGINT} is the |
| 4838 | signal a program gets when you type an interrupt character (often @kbd{Ctrl-c}); |
| 4839 | @code{SIGSEGV} is the signal a program gets from referencing a place in |
| 4840 | memory far away from all the areas in use; @code{SIGALRM} occurs when |
| 4841 | the alarm clock timer goes off (which happens only if your program has |
| 4842 | requested an alarm). |
| 4843 | |
| 4844 | @cindex fatal signals |
| 4845 | Some signals, including @code{SIGALRM}, are a normal part of the |
| 4846 | functioning of your program. Others, such as @code{SIGSEGV}, indicate |
| 4847 | errors; these signals are @dfn{fatal} (they kill your program immediately) if the |
| 4848 | program has not specified in advance some other way to handle the signal. |
| 4849 | @code{SIGINT} does not indicate an error in your program, but it is normally |
| 4850 | fatal so it can carry out the purpose of the interrupt: to kill the program. |
| 4851 | |
| 4852 | @value{GDBN} has the ability to detect any occurrence of a signal in your |
| 4853 | program. You can tell @value{GDBN} in advance what to do for each kind of |
| 4854 | signal. |
| 4855 | |
| 4856 | @cindex handling signals |
| 4857 | Normally, @value{GDBN} is set up to let the non-erroneous signals like |
| 4858 | @code{SIGALRM} be silently passed to your program |
| 4859 | (so as not to interfere with their role in the program's functioning) |
| 4860 | but to stop your program immediately whenever an error signal happens. |
| 4861 | You can change these settings with the @code{handle} command. |
| 4862 | |
| 4863 | @table @code |
| 4864 | @kindex info signals |
| 4865 | @kindex info handle |
| 4866 | @item info signals |
| 4867 | @itemx info handle |
| 4868 | Print a table of all the kinds of signals and how @value{GDBN} has been told to |
| 4869 | handle each one. You can use this to see the signal numbers of all |
| 4870 | the defined types of signals. |
| 4871 | |
| 4872 | @item info signals @var{sig} |
| 4873 | Similar, but print information only about the specified signal number. |
| 4874 | |
| 4875 | @code{info handle} is an alias for @code{info signals}. |
| 4876 | |
| 4877 | @kindex handle |
| 4878 | @item handle @var{signal} @r{[}@var{keywords}@dots{}@r{]} |
| 4879 | Change the way @value{GDBN} handles signal @var{signal}. @var{signal} |
| 4880 | can be the number of a signal or its name (with or without the |
| 4881 | @samp{SIG} at the beginning); a list of signal numbers of the form |
| 4882 | @samp{@var{low}-@var{high}}; or the word @samp{all}, meaning all the |
| 4883 | known signals. Optional arguments @var{keywords}, described below, |
| 4884 | say what change to make. |
| 4885 | @end table |
| 4886 | |
| 4887 | @c @group |
| 4888 | The keywords allowed by the @code{handle} command can be abbreviated. |
| 4889 | Their full names are: |
| 4890 | |
| 4891 | @table @code |
| 4892 | @item nostop |
| 4893 | @value{GDBN} should not stop your program when this signal happens. It may |
| 4894 | still print a message telling you that the signal has come in. |
| 4895 | |
| 4896 | @item stop |
| 4897 | @value{GDBN} should stop your program when this signal happens. This implies |
| 4898 | the @code{print} keyword as well. |
| 4899 | |
| 4900 | @item print |
| 4901 | @value{GDBN} should print a message when this signal happens. |
| 4902 | |
| 4903 | @item noprint |
| 4904 | @value{GDBN} should not mention the occurrence of the signal at all. This |
| 4905 | implies the @code{nostop} keyword as well. |
| 4906 | |
| 4907 | @item pass |
| 4908 | @itemx noignore |
| 4909 | @value{GDBN} should allow your program to see this signal; your program |
| 4910 | can handle the signal, or else it may terminate if the signal is fatal |
| 4911 | and not handled. @code{pass} and @code{noignore} are synonyms. |
| 4912 | |
| 4913 | @item nopass |
| 4914 | @itemx ignore |
| 4915 | @value{GDBN} should not allow your program to see this signal. |
| 4916 | @code{nopass} and @code{ignore} are synonyms. |
| 4917 | @end table |
| 4918 | @c @end group |
| 4919 | |
| 4920 | When a signal stops your program, the signal is not visible to the |
| 4921 | program until you |
| 4922 | continue. Your program sees the signal then, if @code{pass} is in |
| 4923 | effect for the signal in question @emph{at that time}. In other words, |
| 4924 | after @value{GDBN} reports a signal, you can use the @code{handle} |
| 4925 | command with @code{pass} or @code{nopass} to control whether your |
| 4926 | program sees that signal when you continue. |
| 4927 | |
| 4928 | The default is set to @code{nostop}, @code{noprint}, @code{pass} for |
| 4929 | non-erroneous signals such as @code{SIGALRM}, @code{SIGWINCH} and |
| 4930 | @code{SIGCHLD}, and to @code{stop}, @code{print}, @code{pass} for the |
| 4931 | erroneous signals. |
| 4932 | |
| 4933 | You can also use the @code{signal} command to prevent your program from |
| 4934 | seeing a signal, or cause it to see a signal it normally would not see, |
| 4935 | or to give it any signal at any time. For example, if your program stopped |
| 4936 | due to some sort of memory reference error, you might store correct |
| 4937 | values into the erroneous variables and continue, hoping to see more |
| 4938 | execution; but your program would probably terminate immediately as |
| 4939 | a result of the fatal signal once it saw the signal. To prevent this, |
| 4940 | you can continue with @samp{signal 0}. @xref{Signaling, ,Giving your |
| 4941 | Program a Signal}. |
| 4942 | |
| 4943 | @cindex extra signal information |
| 4944 | @anchor{extra signal information} |
| 4945 | |
| 4946 | On some targets, @value{GDBN} can inspect extra signal information |
| 4947 | associated with the intercepted signal, before it is actually |
| 4948 | delivered to the program being debugged. This information is exported |
| 4949 | by the convenience variable @code{$_siginfo}, and consists of data |
| 4950 | that is passed by the kernel to the signal handler at the time of the |
| 4951 | receipt of a signal. The data type of the information itself is |
| 4952 | target dependent. You can see the data type using the @code{ptype |
| 4953 | $_siginfo} command. On Unix systems, it typically corresponds to the |
| 4954 | standard @code{siginfo_t} type, as defined in the @file{signal.h} |
| 4955 | system header. |
| 4956 | |
| 4957 | Here's an example, on a @sc{gnu}/Linux system, printing the stray |
| 4958 | referenced address that raised a segmentation fault. |
| 4959 | |
| 4960 | @smallexample |
| 4961 | @group |
| 4962 | (@value{GDBP}) continue |
| 4963 | Program received signal SIGSEGV, Segmentation fault. |
| 4964 | 0x0000000000400766 in main () |
| 4965 | 69 *(int *)p = 0; |
| 4966 | (@value{GDBP}) ptype $_siginfo |
| 4967 | type = struct @{ |
| 4968 | int si_signo; |
| 4969 | int si_errno; |
| 4970 | int si_code; |
| 4971 | union @{ |
| 4972 | int _pad[28]; |
| 4973 | struct @{...@} _kill; |
| 4974 | struct @{...@} _timer; |
| 4975 | struct @{...@} _rt; |
| 4976 | struct @{...@} _sigchld; |
| 4977 | struct @{...@} _sigfault; |
| 4978 | struct @{...@} _sigpoll; |
| 4979 | @} _sifields; |
| 4980 | @} |
| 4981 | (@value{GDBP}) ptype $_siginfo._sifields._sigfault |
| 4982 | type = struct @{ |
| 4983 | void *si_addr; |
| 4984 | @} |
| 4985 | (@value{GDBP}) p $_siginfo._sifields._sigfault.si_addr |
| 4986 | $1 = (void *) 0x7ffff7ff7000 |
| 4987 | @end group |
| 4988 | @end smallexample |
| 4989 | |
| 4990 | Depending on target support, @code{$_siginfo} may also be writable. |
| 4991 | |
| 4992 | @node Thread Stops |
| 4993 | @section Stopping and Starting Multi-thread Programs |
| 4994 | |
| 4995 | @cindex stopped threads |
| 4996 | @cindex threads, stopped |
| 4997 | |
| 4998 | @cindex continuing threads |
| 4999 | @cindex threads, continuing |
| 5000 | |
| 5001 | @value{GDBN} supports debugging programs with multiple threads |
| 5002 | (@pxref{Threads,, Debugging Programs with Multiple Threads}). There |
| 5003 | are two modes of controlling execution of your program within the |
| 5004 | debugger. In the default mode, referred to as @dfn{all-stop mode}, |
| 5005 | when any thread in your program stops (for example, at a breakpoint |
| 5006 | or while being stepped), all other threads in the program are also stopped by |
| 5007 | @value{GDBN}. On some targets, @value{GDBN} also supports |
| 5008 | @dfn{non-stop mode}, in which other threads can continue to run freely while |
| 5009 | you examine the stopped thread in the debugger. |
| 5010 | |
| 5011 | @menu |
| 5012 | * All-Stop Mode:: All threads stop when GDB takes control |
| 5013 | * Non-Stop Mode:: Other threads continue to execute |
| 5014 | * Background Execution:: Running your program asynchronously |
| 5015 | * Thread-Specific Breakpoints:: Controlling breakpoints |
| 5016 | * Interrupted System Calls:: GDB may interfere with system calls |
| 5017 | * Observer Mode:: GDB does not alter program behavior |
| 5018 | @end menu |
| 5019 | |
| 5020 | @node All-Stop Mode |
| 5021 | @subsection All-Stop Mode |
| 5022 | |
| 5023 | @cindex all-stop mode |
| 5024 | |
| 5025 | In all-stop mode, whenever your program stops under @value{GDBN} for any reason, |
| 5026 | @emph{all} threads of execution stop, not just the current thread. This |
| 5027 | allows you to examine the overall state of the program, including |
| 5028 | switching between threads, without worrying that things may change |
| 5029 | underfoot. |
| 5030 | |
| 5031 | Conversely, whenever you restart the program, @emph{all} threads start |
| 5032 | executing. @emph{This is true even when single-stepping} with commands |
| 5033 | like @code{step} or @code{next}. |
| 5034 | |
| 5035 | In particular, @value{GDBN} cannot single-step all threads in lockstep. |
| 5036 | Since thread scheduling is up to your debugging target's operating |
| 5037 | system (not controlled by @value{GDBN}), other threads may |
| 5038 | execute more than one statement while the current thread completes a |
| 5039 | single step. Moreover, in general other threads stop in the middle of a |
| 5040 | statement, rather than at a clean statement boundary, when the program |
| 5041 | stops. |
| 5042 | |
| 5043 | You might even find your program stopped in another thread after |
| 5044 | continuing or even single-stepping. This happens whenever some other |
| 5045 | thread runs into a breakpoint, a signal, or an exception before the |
| 5046 | first thread completes whatever you requested. |
| 5047 | |
| 5048 | @cindex automatic thread selection |
| 5049 | @cindex switching threads automatically |
| 5050 | @cindex threads, automatic switching |
| 5051 | Whenever @value{GDBN} stops your program, due to a breakpoint or a |
| 5052 | signal, it automatically selects the thread where that breakpoint or |
| 5053 | signal happened. @value{GDBN} alerts you to the context switch with a |
| 5054 | message such as @samp{[Switching to Thread @var{n}]} to identify the |
| 5055 | thread. |
| 5056 | |
| 5057 | On some OSes, you can modify @value{GDBN}'s default behavior by |
| 5058 | locking the OS scheduler to allow only a single thread to run. |
| 5059 | |
| 5060 | @table @code |
| 5061 | @item set scheduler-locking @var{mode} |
| 5062 | @cindex scheduler locking mode |
| 5063 | @cindex lock scheduler |
| 5064 | Set the scheduler locking mode. If it is @code{off}, then there is no |
| 5065 | locking and any thread may run at any time. If @code{on}, then only the |
| 5066 | current thread may run when the inferior is resumed. The @code{step} |
| 5067 | mode optimizes for single-stepping; it prevents other threads |
| 5068 | from preempting the current thread while you are stepping, so that |
| 5069 | the focus of debugging does not change unexpectedly. |
| 5070 | Other threads only rarely (or never) get a chance to run |
| 5071 | when you step. They are more likely to run when you @samp{next} over a |
| 5072 | function call, and they are completely free to run when you use commands |
| 5073 | like @samp{continue}, @samp{until}, or @samp{finish}. However, unless another |
| 5074 | thread hits a breakpoint during its timeslice, @value{GDBN} does not change |
| 5075 | the current thread away from the thread that you are debugging. |
| 5076 | |
| 5077 | @item show scheduler-locking |
| 5078 | Display the current scheduler locking mode. |
| 5079 | @end table |
| 5080 | |
| 5081 | @cindex resume threads of multiple processes simultaneously |
| 5082 | By default, when you issue one of the execution commands such as |
| 5083 | @code{continue}, @code{next} or @code{step}, @value{GDBN} allows only |
| 5084 | threads of the current inferior to run. For example, if @value{GDBN} |
| 5085 | is attached to two inferiors, each with two threads, the |
| 5086 | @code{continue} command resumes only the two threads of the current |
| 5087 | inferior. This is useful, for example, when you debug a program that |
| 5088 | forks and you want to hold the parent stopped (so that, for instance, |
| 5089 | it doesn't run to exit), while you debug the child. In other |
| 5090 | situations, you may not be interested in inspecting the current state |
| 5091 | of any of the processes @value{GDBN} is attached to, and you may want |
| 5092 | to resume them all until some breakpoint is hit. In the latter case, |
| 5093 | you can instruct @value{GDBN} to allow all threads of all the |
| 5094 | inferiors to run with the @w{@code{set schedule-multiple}} command. |
| 5095 | |
| 5096 | @table @code |
| 5097 | @kindex set schedule-multiple |
| 5098 | @item set schedule-multiple |
| 5099 | Set the mode for allowing threads of multiple processes to be resumed |
| 5100 | when an execution command is issued. When @code{on}, all threads of |
| 5101 | all processes are allowed to run. When @code{off}, only the threads |
| 5102 | of the current process are resumed. The default is @code{off}. The |
| 5103 | @code{scheduler-locking} mode takes precedence when set to @code{on}, |
| 5104 | or while you are stepping and set to @code{step}. |
| 5105 | |
| 5106 | @item show schedule-multiple |
| 5107 | Display the current mode for resuming the execution of threads of |
| 5108 | multiple processes. |
| 5109 | @end table |
| 5110 | |
| 5111 | @node Non-Stop Mode |
| 5112 | @subsection Non-Stop Mode |
| 5113 | |
| 5114 | @cindex non-stop mode |
| 5115 | |
| 5116 | @c This section is really only a place-holder, and needs to be expanded |
| 5117 | @c with more details. |
| 5118 | |
| 5119 | For some multi-threaded targets, @value{GDBN} supports an optional |
| 5120 | mode of operation in which you can examine stopped program threads in |
| 5121 | the debugger while other threads continue to execute freely. This |
| 5122 | minimizes intrusion when debugging live systems, such as programs |
| 5123 | where some threads have real-time constraints or must continue to |
| 5124 | respond to external events. This is referred to as @dfn{non-stop} mode. |
| 5125 | |
| 5126 | In non-stop mode, when a thread stops to report a debugging event, |
| 5127 | @emph{only} that thread is stopped; @value{GDBN} does not stop other |
| 5128 | threads as well, in contrast to the all-stop mode behavior. Additionally, |
| 5129 | execution commands such as @code{continue} and @code{step} apply by default |
| 5130 | only to the current thread in non-stop mode, rather than all threads as |
| 5131 | in all-stop mode. This allows you to control threads explicitly in |
| 5132 | ways that are not possible in all-stop mode --- for example, stepping |
| 5133 | one thread while allowing others to run freely, stepping |
| 5134 | one thread while holding all others stopped, or stepping several threads |
| 5135 | independently and simultaneously. |
| 5136 | |
| 5137 | To enter non-stop mode, use this sequence of commands before you run |
| 5138 | or attach to your program: |
| 5139 | |
| 5140 | @smallexample |
| 5141 | # Enable the async interface. |
| 5142 | set target-async 1 |
| 5143 | |
| 5144 | # If using the CLI, pagination breaks non-stop. |
| 5145 | set pagination off |
| 5146 | |
| 5147 | # Finally, turn it on! |
| 5148 | set non-stop on |
| 5149 | @end smallexample |
| 5150 | |
| 5151 | You can use these commands to manipulate the non-stop mode setting: |
| 5152 | |
| 5153 | @table @code |
| 5154 | @kindex set non-stop |
| 5155 | @item set non-stop on |
| 5156 | Enable selection of non-stop mode. |
| 5157 | @item set non-stop off |
| 5158 | Disable selection of non-stop mode. |
| 5159 | @kindex show non-stop |
| 5160 | @item show non-stop |
| 5161 | Show the current non-stop enablement setting. |
| 5162 | @end table |
| 5163 | |
| 5164 | Note these commands only reflect whether non-stop mode is enabled, |
| 5165 | not whether the currently-executing program is being run in non-stop mode. |
| 5166 | In particular, the @code{set non-stop} preference is only consulted when |
| 5167 | @value{GDBN} starts or connects to the target program, and it is generally |
| 5168 | not possible to switch modes once debugging has started. Furthermore, |
| 5169 | since not all targets support non-stop mode, even when you have enabled |
| 5170 | non-stop mode, @value{GDBN} may still fall back to all-stop operation by |
| 5171 | default. |
| 5172 | |
| 5173 | In non-stop mode, all execution commands apply only to the current thread |
| 5174 | by default. That is, @code{continue} only continues one thread. |
| 5175 | To continue all threads, issue @code{continue -a} or @code{c -a}. |
| 5176 | |
| 5177 | You can use @value{GDBN}'s background execution commands |
| 5178 | (@pxref{Background Execution}) to run some threads in the background |
| 5179 | while you continue to examine or step others from @value{GDBN}. |
| 5180 | The MI execution commands (@pxref{GDB/MI Program Execution}) are |
| 5181 | always executed asynchronously in non-stop mode. |
| 5182 | |
| 5183 | Suspending execution is done with the @code{interrupt} command when |
| 5184 | running in the background, or @kbd{Ctrl-c} during foreground execution. |
| 5185 | In all-stop mode, this stops the whole process; |
| 5186 | but in non-stop mode the interrupt applies only to the current thread. |
| 5187 | To stop the whole program, use @code{interrupt -a}. |
| 5188 | |
| 5189 | Other execution commands do not currently support the @code{-a} option. |
| 5190 | |
| 5191 | In non-stop mode, when a thread stops, @value{GDBN} doesn't automatically make |
| 5192 | that thread current, as it does in all-stop mode. This is because the |
| 5193 | thread stop notifications are asynchronous with respect to @value{GDBN}'s |
| 5194 | command interpreter, and it would be confusing if @value{GDBN} unexpectedly |
| 5195 | changed to a different thread just as you entered a command to operate on the |
| 5196 | previously current thread. |
| 5197 | |
| 5198 | @node Background Execution |
| 5199 | @subsection Background Execution |
| 5200 | |
| 5201 | @cindex foreground execution |
| 5202 | @cindex background execution |
| 5203 | @cindex asynchronous execution |
| 5204 | @cindex execution, foreground, background and asynchronous |
| 5205 | |
| 5206 | @value{GDBN}'s execution commands have two variants: the normal |
| 5207 | foreground (synchronous) behavior, and a background |
| 5208 | (asynchronous) behavior. In foreground execution, @value{GDBN} waits for |
| 5209 | the program to report that some thread has stopped before prompting for |
| 5210 | another command. In background execution, @value{GDBN} immediately gives |
| 5211 | a command prompt so that you can issue other commands while your program runs. |
| 5212 | |
| 5213 | You need to explicitly enable asynchronous mode before you can use |
| 5214 | background execution commands. You can use these commands to |
| 5215 | manipulate the asynchronous mode setting: |
| 5216 | |
| 5217 | @table @code |
| 5218 | @kindex set target-async |
| 5219 | @item set target-async on |
| 5220 | Enable asynchronous mode. |
| 5221 | @item set target-async off |
| 5222 | Disable asynchronous mode. |
| 5223 | @kindex show target-async |
| 5224 | @item show target-async |
| 5225 | Show the current target-async setting. |
| 5226 | @end table |
| 5227 | |
| 5228 | If the target doesn't support async mode, @value{GDBN} issues an error |
| 5229 | message if you attempt to use the background execution commands. |
| 5230 | |
| 5231 | To specify background execution, add a @code{&} to the command. For example, |
| 5232 | the background form of the @code{continue} command is @code{continue&}, or |
| 5233 | just @code{c&}. The execution commands that accept background execution |
| 5234 | are: |
| 5235 | |
| 5236 | @table @code |
| 5237 | @kindex run& |
| 5238 | @item run |
| 5239 | @xref{Starting, , Starting your Program}. |
| 5240 | |
| 5241 | @item attach |
| 5242 | @kindex attach& |
| 5243 | @xref{Attach, , Debugging an Already-running Process}. |
| 5244 | |
| 5245 | @item step |
| 5246 | @kindex step& |
| 5247 | @xref{Continuing and Stepping, step}. |
| 5248 | |
| 5249 | @item stepi |
| 5250 | @kindex stepi& |
| 5251 | @xref{Continuing and Stepping, stepi}. |
| 5252 | |
| 5253 | @item next |
| 5254 | @kindex next& |
| 5255 | @xref{Continuing and Stepping, next}. |
| 5256 | |
| 5257 | @item nexti |
| 5258 | @kindex nexti& |
| 5259 | @xref{Continuing and Stepping, nexti}. |
| 5260 | |
| 5261 | @item continue |
| 5262 | @kindex continue& |
| 5263 | @xref{Continuing and Stepping, continue}. |
| 5264 | |
| 5265 | @item finish |
| 5266 | @kindex finish& |
| 5267 | @xref{Continuing and Stepping, finish}. |
| 5268 | |
| 5269 | @item until |
| 5270 | @kindex until& |
| 5271 | @xref{Continuing and Stepping, until}. |
| 5272 | |
| 5273 | @end table |
| 5274 | |
| 5275 | Background execution is especially useful in conjunction with non-stop |
| 5276 | mode for debugging programs with multiple threads; see @ref{Non-Stop Mode}. |
| 5277 | However, you can also use these commands in the normal all-stop mode with |
| 5278 | the restriction that you cannot issue another execution command until the |
| 5279 | previous one finishes. Examples of commands that are valid in all-stop |
| 5280 | mode while the program is running include @code{help} and @code{info break}. |
| 5281 | |
| 5282 | You can interrupt your program while it is running in the background by |
| 5283 | using the @code{interrupt} command. |
| 5284 | |
| 5285 | @table @code |
| 5286 | @kindex interrupt |
| 5287 | @item interrupt |
| 5288 | @itemx interrupt -a |
| 5289 | |
| 5290 | Suspend execution of the running program. In all-stop mode, |
| 5291 | @code{interrupt} stops the whole process, but in non-stop mode, it stops |
| 5292 | only the current thread. To stop the whole program in non-stop mode, |
| 5293 | use @code{interrupt -a}. |
| 5294 | @end table |
| 5295 | |
| 5296 | @node Thread-Specific Breakpoints |
| 5297 | @subsection Thread-Specific Breakpoints |
| 5298 | |
| 5299 | When your program has multiple threads (@pxref{Threads,, Debugging |
| 5300 | Programs with Multiple Threads}), you can choose whether to set |
| 5301 | breakpoints on all threads, or on a particular thread. |
| 5302 | |
| 5303 | @table @code |
| 5304 | @cindex breakpoints and threads |
| 5305 | @cindex thread breakpoints |
| 5306 | @kindex break @dots{} thread @var{threadno} |
| 5307 | @item break @var{linespec} thread @var{threadno} |
| 5308 | @itemx break @var{linespec} thread @var{threadno} if @dots{} |
| 5309 | @var{linespec} specifies source lines; there are several ways of |
| 5310 | writing them (@pxref{Specify Location}), but the effect is always to |
| 5311 | specify some source line. |
| 5312 | |
| 5313 | Use the qualifier @samp{thread @var{threadno}} with a breakpoint command |
| 5314 | to specify that you only want @value{GDBN} to stop the program when a |
| 5315 | particular thread reaches this breakpoint. @var{threadno} is one of the |
| 5316 | numeric thread identifiers assigned by @value{GDBN}, shown in the first |
| 5317 | column of the @samp{info threads} display. |
| 5318 | |
| 5319 | If you do not specify @samp{thread @var{threadno}} when you set a |
| 5320 | breakpoint, the breakpoint applies to @emph{all} threads of your |
| 5321 | program. |
| 5322 | |
| 5323 | You can use the @code{thread} qualifier on conditional breakpoints as |
| 5324 | well; in this case, place @samp{thread @var{threadno}} before or |
| 5325 | after the breakpoint condition, like this: |
| 5326 | |
| 5327 | @smallexample |
| 5328 | (@value{GDBP}) break frik.c:13 thread 28 if bartab > lim |
| 5329 | @end smallexample |
| 5330 | |
| 5331 | @end table |
| 5332 | |
| 5333 | @node Interrupted System Calls |
| 5334 | @subsection Interrupted System Calls |
| 5335 | |
| 5336 | @cindex thread breakpoints and system calls |
| 5337 | @cindex system calls and thread breakpoints |
| 5338 | @cindex premature return from system calls |
| 5339 | There is an unfortunate side effect when using @value{GDBN} to debug |
| 5340 | multi-threaded programs. If one thread stops for a |
| 5341 | breakpoint, or for some other reason, and another thread is blocked in a |
| 5342 | system call, then the system call may return prematurely. This is a |
| 5343 | consequence of the interaction between multiple threads and the signals |
| 5344 | that @value{GDBN} uses to implement breakpoints and other events that |
| 5345 | stop execution. |
| 5346 | |
| 5347 | To handle this problem, your program should check the return value of |
| 5348 | each system call and react appropriately. This is good programming |
| 5349 | style anyways. |
| 5350 | |
| 5351 | For example, do not write code like this: |
| 5352 | |
| 5353 | @smallexample |
| 5354 | sleep (10); |
| 5355 | @end smallexample |
| 5356 | |
| 5357 | The call to @code{sleep} will return early if a different thread stops |
| 5358 | at a breakpoint or for some other reason. |
| 5359 | |
| 5360 | Instead, write this: |
| 5361 | |
| 5362 | @smallexample |
| 5363 | int unslept = 10; |
| 5364 | while (unslept > 0) |
| 5365 | unslept = sleep (unslept); |
| 5366 | @end smallexample |
| 5367 | |
| 5368 | A system call is allowed to return early, so the system is still |
| 5369 | conforming to its specification. But @value{GDBN} does cause your |
| 5370 | multi-threaded program to behave differently than it would without |
| 5371 | @value{GDBN}. |
| 5372 | |
| 5373 | Also, @value{GDBN} uses internal breakpoints in the thread library to |
| 5374 | monitor certain events such as thread creation and thread destruction. |
| 5375 | When such an event happens, a system call in another thread may return |
| 5376 | prematurely, even though your program does not appear to stop. |
| 5377 | |
| 5378 | @node Observer Mode |
| 5379 | @subsection Observer Mode |
| 5380 | |
| 5381 | If you want to build on non-stop mode and observe program behavior |
| 5382 | without any chance of disruption by @value{GDBN}, you can set |
| 5383 | variables to disable all of the debugger's attempts to modify state, |
| 5384 | whether by writing memory, inserting breakpoints, etc. These operate |
| 5385 | at a low level, intercepting operations from all commands. |
| 5386 | |
| 5387 | When all of these are set to @code{off}, then @value{GDBN} is said to |
| 5388 | be @dfn{observer mode}. As a convenience, the variable |
| 5389 | @code{observer} can be set to disable these, plus enable non-stop |
| 5390 | mode. |
| 5391 | |
| 5392 | Note that @value{GDBN} will not prevent you from making nonsensical |
| 5393 | combinations of these settings. For instance, if you have enabled |
| 5394 | @code{may-insert-breakpoints} but disabled @code{may-write-memory}, |
| 5395 | then breakpoints that work by writing trap instructions into the code |
| 5396 | stream will still not be able to be placed. |
| 5397 | |
| 5398 | @table @code |
| 5399 | |
| 5400 | @kindex observer |
| 5401 | @item set observer on |
| 5402 | @itemx set observer off |
| 5403 | When set to @code{on}, this disables all the permission variables |
| 5404 | below (except for @code{insert-fast-tracepoints}), plus enables |
| 5405 | non-stop debugging. Setting this to @code{off} switches back to |
| 5406 | normal debugging, though remaining in non-stop mode. |
| 5407 | |
| 5408 | @item show observer |
| 5409 | Show whether observer mode is on or off. |
| 5410 | |
| 5411 | @kindex may-write-registers |
| 5412 | @item set may-write-registers on |
| 5413 | @itemx set may-write-registers off |
| 5414 | This controls whether @value{GDBN} will attempt to alter the values of |
| 5415 | registers, such as with assignment expressions in @code{print}, or the |
| 5416 | @code{jump} command. It defaults to @code{on}. |
| 5417 | |
| 5418 | @item show may-write-registers |
| 5419 | Show the current permission to write registers. |
| 5420 | |
| 5421 | @kindex may-write-memory |
| 5422 | @item set may-write-memory on |
| 5423 | @itemx set may-write-memory off |
| 5424 | This controls whether @value{GDBN} will attempt to alter the contents |
| 5425 | of memory, such as with assignment expressions in @code{print}. It |
| 5426 | defaults to @code{on}. |
| 5427 | |
| 5428 | @item show may-write-memory |
| 5429 | Show the current permission to write memory. |
| 5430 | |
| 5431 | @kindex may-insert-breakpoints |
| 5432 | @item set may-insert-breakpoints on |
| 5433 | @itemx set may-insert-breakpoints off |
| 5434 | This controls whether @value{GDBN} will attempt to insert breakpoints. |
| 5435 | This affects all breakpoints, including internal breakpoints defined |
| 5436 | by @value{GDBN}. It defaults to @code{on}. |
| 5437 | |
| 5438 | @item show may-insert-breakpoints |
| 5439 | Show the current permission to insert breakpoints. |
| 5440 | |
| 5441 | @kindex may-insert-tracepoints |
| 5442 | @item set may-insert-tracepoints on |
| 5443 | @itemx set may-insert-tracepoints off |
| 5444 | This controls whether @value{GDBN} will attempt to insert (regular) |
| 5445 | tracepoints at the beginning of a tracing experiment. It affects only |
| 5446 | non-fast tracepoints, fast tracepoints being under the control of |
| 5447 | @code{may-insert-fast-tracepoints}. It defaults to @code{on}. |
| 5448 | |
| 5449 | @item show may-insert-tracepoints |
| 5450 | Show the current permission to insert tracepoints. |
| 5451 | |
| 5452 | @kindex may-insert-fast-tracepoints |
| 5453 | @item set may-insert-fast-tracepoints on |
| 5454 | @itemx set may-insert-fast-tracepoints off |
| 5455 | This controls whether @value{GDBN} will attempt to insert fast |
| 5456 | tracepoints at the beginning of a tracing experiment. It affects only |
| 5457 | fast tracepoints, regular (non-fast) tracepoints being under the |
| 5458 | control of @code{may-insert-tracepoints}. It defaults to @code{on}. |
| 5459 | |
| 5460 | @item show may-insert-fast-tracepoints |
| 5461 | Show the current permission to insert fast tracepoints. |
| 5462 | |
| 5463 | @kindex may-interrupt |
| 5464 | @item set may-interrupt on |
| 5465 | @itemx set may-interrupt off |
| 5466 | This controls whether @value{GDBN} will attempt to interrupt or stop |
| 5467 | program execution. When this variable is @code{off}, the |
| 5468 | @code{interrupt} command will have no effect, nor will |
| 5469 | @kbd{Ctrl-c}. It defaults to @code{on}. |
| 5470 | |
| 5471 | @item show may-interrupt |
| 5472 | Show the current permission to interrupt or stop the program. |
| 5473 | |
| 5474 | @end table |
| 5475 | |
| 5476 | @node Reverse Execution |
| 5477 | @chapter Running programs backward |
| 5478 | @cindex reverse execution |
| 5479 | @cindex running programs backward |
| 5480 | |
| 5481 | When you are debugging a program, it is not unusual to realize that |
| 5482 | you have gone too far, and some event of interest has already happened. |
| 5483 | If the target environment supports it, @value{GDBN} can allow you to |
| 5484 | ``rewind'' the program by running it backward. |
| 5485 | |
| 5486 | A target environment that supports reverse execution should be able |
| 5487 | to ``undo'' the changes in machine state that have taken place as the |
| 5488 | program was executing normally. Variables, registers etc.@: should |
| 5489 | revert to their previous values. Obviously this requires a great |
| 5490 | deal of sophistication on the part of the target environment; not |
| 5491 | all target environments can support reverse execution. |
| 5492 | |
| 5493 | When a program is executed in reverse, the instructions that |
| 5494 | have most recently been executed are ``un-executed'', in reverse |
| 5495 | order. The program counter runs backward, following the previous |
| 5496 | thread of execution in reverse. As each instruction is ``un-executed'', |
| 5497 | the values of memory and/or registers that were changed by that |
| 5498 | instruction are reverted to their previous states. After executing |
| 5499 | a piece of source code in reverse, all side effects of that code |
| 5500 | should be ``undone'', and all variables should be returned to their |
| 5501 | prior values@footnote{ |
| 5502 | Note that some side effects are easier to undo than others. For instance, |
| 5503 | memory and registers are relatively easy, but device I/O is hard. Some |
| 5504 | targets may be able undo things like device I/O, and some may not. |
| 5505 | |
| 5506 | The contract between @value{GDBN} and the reverse executing target |
| 5507 | requires only that the target do something reasonable when |
| 5508 | @value{GDBN} tells it to execute backwards, and then report the |
| 5509 | results back to @value{GDBN}. Whatever the target reports back to |
| 5510 | @value{GDBN}, @value{GDBN} will report back to the user. @value{GDBN} |
| 5511 | assumes that the memory and registers that the target reports are in a |
| 5512 | consistant state, but @value{GDBN} accepts whatever it is given. |
| 5513 | }. |
| 5514 | |
| 5515 | If you are debugging in a target environment that supports |
| 5516 | reverse execution, @value{GDBN} provides the following commands. |
| 5517 | |
| 5518 | @table @code |
| 5519 | @kindex reverse-continue |
| 5520 | @kindex rc @r{(@code{reverse-continue})} |
| 5521 | @item reverse-continue @r{[}@var{ignore-count}@r{]} |
| 5522 | @itemx rc @r{[}@var{ignore-count}@r{]} |
| 5523 | Beginning at the point where your program last stopped, start executing |
| 5524 | in reverse. Reverse execution will stop for breakpoints and synchronous |
| 5525 | exceptions (signals), just like normal execution. Behavior of |
| 5526 | asynchronous signals depends on the target environment. |
| 5527 | |
| 5528 | @kindex reverse-step |
| 5529 | @kindex rs @r{(@code{step})} |
| 5530 | @item reverse-step @r{[}@var{count}@r{]} |
| 5531 | Run the program backward until control reaches the start of a |
| 5532 | different source line; then stop it, and return control to @value{GDBN}. |
| 5533 | |
| 5534 | Like the @code{step} command, @code{reverse-step} will only stop |
| 5535 | at the beginning of a source line. It ``un-executes'' the previously |
| 5536 | executed source line. If the previous source line included calls to |
| 5537 | debuggable functions, @code{reverse-step} will step (backward) into |
| 5538 | the called function, stopping at the beginning of the @emph{last} |
| 5539 | statement in the called function (typically a return statement). |
| 5540 | |
| 5541 | Also, as with the @code{step} command, if non-debuggable functions are |
| 5542 | called, @code{reverse-step} will run thru them backward without stopping. |
| 5543 | |
| 5544 | @kindex reverse-stepi |
| 5545 | @kindex rsi @r{(@code{reverse-stepi})} |
| 5546 | @item reverse-stepi @r{[}@var{count}@r{]} |
| 5547 | Reverse-execute one machine instruction. Note that the instruction |
| 5548 | to be reverse-executed is @emph{not} the one pointed to by the program |
| 5549 | counter, but the instruction executed prior to that one. For instance, |
| 5550 | if the last instruction was a jump, @code{reverse-stepi} will take you |
| 5551 | back from the destination of the jump to the jump instruction itself. |
| 5552 | |
| 5553 | @kindex reverse-next |
| 5554 | @kindex rn @r{(@code{reverse-next})} |
| 5555 | @item reverse-next @r{[}@var{count}@r{]} |
| 5556 | Run backward to the beginning of the previous line executed in |
| 5557 | the current (innermost) stack frame. If the line contains function |
| 5558 | calls, they will be ``un-executed'' without stopping. Starting from |
| 5559 | the first line of a function, @code{reverse-next} will take you back |
| 5560 | to the caller of that function, @emph{before} the function was called, |
| 5561 | just as the normal @code{next} command would take you from the last |
| 5562 | line of a function back to its return to its caller |
| 5563 | @footnote{Unless the code is too heavily optimized.}. |
| 5564 | |
| 5565 | @kindex reverse-nexti |
| 5566 | @kindex rni @r{(@code{reverse-nexti})} |
| 5567 | @item reverse-nexti @r{[}@var{count}@r{]} |
| 5568 | Like @code{nexti}, @code{reverse-nexti} executes a single instruction |
| 5569 | in reverse, except that called functions are ``un-executed'' atomically. |
| 5570 | That is, if the previously executed instruction was a return from |
| 5571 | another function, @code{reverse-nexti} will continue to execute |
| 5572 | in reverse until the call to that function (from the current stack |
| 5573 | frame) is reached. |
| 5574 | |
| 5575 | @kindex reverse-finish |
| 5576 | @item reverse-finish |
| 5577 | Just as the @code{finish} command takes you to the point where the |
| 5578 | current function returns, @code{reverse-finish} takes you to the point |
| 5579 | where it was called. Instead of ending up at the end of the current |
| 5580 | function invocation, you end up at the beginning. |
| 5581 | |
| 5582 | @kindex set exec-direction |
| 5583 | @item set exec-direction |
| 5584 | Set the direction of target execution. |
| 5585 | @itemx set exec-direction reverse |
| 5586 | @cindex execute forward or backward in time |
| 5587 | @value{GDBN} will perform all execution commands in reverse, until the |
| 5588 | exec-direction mode is changed to ``forward''. Affected commands include |
| 5589 | @code{step, stepi, next, nexti, continue, and finish}. The @code{return} |
| 5590 | command cannot be used in reverse mode. |
| 5591 | @item set exec-direction forward |
| 5592 | @value{GDBN} will perform all execution commands in the normal fashion. |
| 5593 | This is the default. |
| 5594 | @end table |
| 5595 | |
| 5596 | |
| 5597 | @node Process Record and Replay |
| 5598 | @chapter Recording Inferior's Execution and Replaying It |
| 5599 | @cindex process record and replay |
| 5600 | @cindex recording inferior's execution and replaying it |
| 5601 | |
| 5602 | On some platforms, @value{GDBN} provides a special @dfn{process record |
| 5603 | and replay} target that can record a log of the process execution, and |
| 5604 | replay it later with both forward and reverse execution commands. |
| 5605 | |
| 5606 | @cindex replay mode |
| 5607 | When this target is in use, if the execution log includes the record |
| 5608 | for the next instruction, @value{GDBN} will debug in @dfn{replay |
| 5609 | mode}. In the replay mode, the inferior does not really execute code |
| 5610 | instructions. Instead, all the events that normally happen during |
| 5611 | code execution are taken from the execution log. While code is not |
| 5612 | really executed in replay mode, the values of registers (including the |
| 5613 | program counter register) and the memory of the inferior are still |
| 5614 | changed as they normally would. Their contents are taken from the |
| 5615 | execution log. |
| 5616 | |
| 5617 | @cindex record mode |
| 5618 | If the record for the next instruction is not in the execution log, |
| 5619 | @value{GDBN} will debug in @dfn{record mode}. In this mode, the |
| 5620 | inferior executes normally, and @value{GDBN} records the execution log |
| 5621 | for future replay. |
| 5622 | |
| 5623 | The process record and replay target supports reverse execution |
| 5624 | (@pxref{Reverse Execution}), even if the platform on which the |
| 5625 | inferior runs does not. However, the reverse execution is limited in |
| 5626 | this case by the range of the instructions recorded in the execution |
| 5627 | log. In other words, reverse execution on platforms that don't |
| 5628 | support it directly can only be done in the replay mode. |
| 5629 | |
| 5630 | When debugging in the reverse direction, @value{GDBN} will work in |
| 5631 | replay mode as long as the execution log includes the record for the |
| 5632 | previous instruction; otherwise, it will work in record mode, if the |
| 5633 | platform supports reverse execution, or stop if not. |
| 5634 | |
| 5635 | For architecture environments that support process record and replay, |
| 5636 | @value{GDBN} provides the following commands: |
| 5637 | |
| 5638 | @table @code |
| 5639 | @kindex target record |
| 5640 | @kindex record |
| 5641 | @kindex rec |
| 5642 | @item target record |
| 5643 | This command starts the process record and replay target. The process |
| 5644 | record and replay target can only debug a process that is already |
| 5645 | running. Therefore, you need first to start the process with the |
| 5646 | @kbd{run} or @kbd{start} commands, and then start the recording with |
| 5647 | the @kbd{target record} command. |
| 5648 | |
| 5649 | Both @code{record} and @code{rec} are aliases of @code{target record}. |
| 5650 | |
| 5651 | @cindex displaced stepping, and process record and replay |
| 5652 | Displaced stepping (@pxref{Maintenance Commands,, displaced stepping}) |
| 5653 | will be automatically disabled when process record and replay target |
| 5654 | is started. That's because the process record and replay target |
| 5655 | doesn't support displaced stepping. |
| 5656 | |
| 5657 | @cindex non-stop mode, and process record and replay |
| 5658 | @cindex asynchronous execution, and process record and replay |
| 5659 | If the inferior is in the non-stop mode (@pxref{Non-Stop Mode}) or in |
| 5660 | the asynchronous execution mode (@pxref{Background Execution}), the |
| 5661 | process record and replay target cannot be started because it doesn't |
| 5662 | support these two modes. |
| 5663 | |
| 5664 | @kindex record stop |
| 5665 | @kindex rec s |
| 5666 | @item record stop |
| 5667 | Stop the process record and replay target. When process record and |
| 5668 | replay target stops, the entire execution log will be deleted and the |
| 5669 | inferior will either be terminated, or will remain in its final state. |
| 5670 | |
| 5671 | When you stop the process record and replay target in record mode (at |
| 5672 | the end of the execution log), the inferior will be stopped at the |
| 5673 | next instruction that would have been recorded. In other words, if |
| 5674 | you record for a while and then stop recording, the inferior process |
| 5675 | will be left in the same state as if the recording never happened. |
| 5676 | |
| 5677 | On the other hand, if the process record and replay target is stopped |
| 5678 | while in replay mode (that is, not at the end of the execution log, |
| 5679 | but at some earlier point), the inferior process will become ``live'' |
| 5680 | at that earlier state, and it will then be possible to continue the |
| 5681 | usual ``live'' debugging of the process from that state. |
| 5682 | |
| 5683 | When the inferior process exits, or @value{GDBN} detaches from it, |
| 5684 | process record and replay target will automatically stop itself. |
| 5685 | |
| 5686 | @kindex record save |
| 5687 | @item record save @var{filename} |
| 5688 | Save the execution log to a file @file{@var{filename}}. |
| 5689 | Default filename is @file{gdb_record.@var{process_id}}, where |
| 5690 | @var{process_id} is the process ID of the inferior. |
| 5691 | |
| 5692 | @kindex record restore |
| 5693 | @item record restore @var{filename} |
| 5694 | Restore the execution log from a file @file{@var{filename}}. |
| 5695 | File must have been created with @code{record save}. |
| 5696 | |
| 5697 | @kindex set record insn-number-max |
| 5698 | @item set record insn-number-max @var{limit} |
| 5699 | Set the limit of instructions to be recorded. Default value is 200000. |
| 5700 | |
| 5701 | If @var{limit} is a positive number, then @value{GDBN} will start |
| 5702 | deleting instructions from the log once the number of the record |
| 5703 | instructions becomes greater than @var{limit}. For every new recorded |
| 5704 | instruction, @value{GDBN} will delete the earliest recorded |
| 5705 | instruction to keep the number of recorded instructions at the limit. |
| 5706 | (Since deleting recorded instructions loses information, @value{GDBN} |
| 5707 | lets you control what happens when the limit is reached, by means of |
| 5708 | the @code{stop-at-limit} option, described below.) |
| 5709 | |
| 5710 | If @var{limit} is zero, @value{GDBN} will never delete recorded |
| 5711 | instructions from the execution log. The number of recorded |
| 5712 | instructions is unlimited in this case. |
| 5713 | |
| 5714 | @kindex show record insn-number-max |
| 5715 | @item show record insn-number-max |
| 5716 | Show the limit of instructions to be recorded. |
| 5717 | |
| 5718 | @kindex set record stop-at-limit |
| 5719 | @item set record stop-at-limit |
| 5720 | Control the behavior when the number of recorded instructions reaches |
| 5721 | the limit. If ON (the default), @value{GDBN} will stop when the limit |
| 5722 | is reached for the first time and ask you whether you want to stop the |
| 5723 | inferior or continue running it and recording the execution log. If |
| 5724 | you decide to continue recording, each new recorded instruction will |
| 5725 | cause the oldest one to be deleted. |
| 5726 | |
| 5727 | If this option is OFF, @value{GDBN} will automatically delete the |
| 5728 | oldest record to make room for each new one, without asking. |
| 5729 | |
| 5730 | @kindex show record stop-at-limit |
| 5731 | @item show record stop-at-limit |
| 5732 | Show the current setting of @code{stop-at-limit}. |
| 5733 | |
| 5734 | @kindex set record memory-query |
| 5735 | @item set record memory-query |
| 5736 | Control the behavior when @value{GDBN} is unable to record memory |
| 5737 | changes caused by an instruction. If ON, @value{GDBN} will query |
| 5738 | whether to stop the inferior in that case. |
| 5739 | |
| 5740 | If this option is OFF (the default), @value{GDBN} will automatically |
| 5741 | ignore the effect of such instructions on memory. Later, when |
| 5742 | @value{GDBN} replays this execution log, it will mark the log of this |
| 5743 | instruction as not accessible, and it will not affect the replay |
| 5744 | results. |
| 5745 | |
| 5746 | @kindex show record memory-query |
| 5747 | @item show record memory-query |
| 5748 | Show the current setting of @code{memory-query}. |
| 5749 | |
| 5750 | @kindex info record |
| 5751 | @item info record |
| 5752 | Show various statistics about the state of process record and its |
| 5753 | in-memory execution log buffer, including: |
| 5754 | |
| 5755 | @itemize @bullet |
| 5756 | @item |
| 5757 | Whether in record mode or replay mode. |
| 5758 | @item |
| 5759 | Lowest recorded instruction number (counting from when the current execution log started recording instructions). |
| 5760 | @item |
| 5761 | Highest recorded instruction number. |
| 5762 | @item |
| 5763 | Current instruction about to be replayed (if in replay mode). |
| 5764 | @item |
| 5765 | Number of instructions contained in the execution log. |
| 5766 | @item |
| 5767 | Maximum number of instructions that may be contained in the execution log. |
| 5768 | @end itemize |
| 5769 | |
| 5770 | @kindex record delete |
| 5771 | @kindex rec del |
| 5772 | @item record delete |
| 5773 | When record target runs in replay mode (``in the past''), delete the |
| 5774 | subsequent execution log and begin to record a new execution log starting |
| 5775 | from the current address. This means you will abandon the previously |
| 5776 | recorded ``future'' and begin recording a new ``future''. |
| 5777 | @end table |
| 5778 | |
| 5779 | |
| 5780 | @node Stack |
| 5781 | @chapter Examining the Stack |
| 5782 | |
| 5783 | When your program has stopped, the first thing you need to know is where it |
| 5784 | stopped and how it got there. |
| 5785 | |
| 5786 | @cindex call stack |
| 5787 | Each time your program performs a function call, information about the call |
| 5788 | is generated. |
| 5789 | That information includes the location of the call in your program, |
| 5790 | the arguments of the call, |
| 5791 | and the local variables of the function being called. |
| 5792 | The information is saved in a block of data called a @dfn{stack frame}. |
| 5793 | The stack frames are allocated in a region of memory called the @dfn{call |
| 5794 | stack}. |
| 5795 | |
| 5796 | When your program stops, the @value{GDBN} commands for examining the |
| 5797 | stack allow you to see all of this information. |
| 5798 | |
| 5799 | @cindex selected frame |
| 5800 | One of the stack frames is @dfn{selected} by @value{GDBN} and many |
| 5801 | @value{GDBN} commands refer implicitly to the selected frame. In |
| 5802 | particular, whenever you ask @value{GDBN} for the value of a variable in |
| 5803 | your program, the value is found in the selected frame. There are |
| 5804 | special @value{GDBN} commands to select whichever frame you are |
| 5805 | interested in. @xref{Selection, ,Selecting a Frame}. |
| 5806 | |
| 5807 | When your program stops, @value{GDBN} automatically selects the |
| 5808 | currently executing frame and describes it briefly, similar to the |
| 5809 | @code{frame} command (@pxref{Frame Info, ,Information about a Frame}). |
| 5810 | |
| 5811 | @menu |
| 5812 | * Frames:: Stack frames |
| 5813 | * Backtrace:: Backtraces |
| 5814 | * Selection:: Selecting a frame |
| 5815 | * Frame Info:: Information on a frame |
| 5816 | |
| 5817 | @end menu |
| 5818 | |
| 5819 | @node Frames |
| 5820 | @section Stack Frames |
| 5821 | |
| 5822 | @cindex frame, definition |
| 5823 | @cindex stack frame |
| 5824 | The call stack is divided up into contiguous pieces called @dfn{stack |
| 5825 | frames}, or @dfn{frames} for short; each frame is the data associated |
| 5826 | with one call to one function. The frame contains the arguments given |
| 5827 | to the function, the function's local variables, and the address at |
| 5828 | which the function is executing. |
| 5829 | |
| 5830 | @cindex initial frame |
| 5831 | @cindex outermost frame |
| 5832 | @cindex innermost frame |
| 5833 | When your program is started, the stack has only one frame, that of the |
| 5834 | function @code{main}. This is called the @dfn{initial} frame or the |
| 5835 | @dfn{outermost} frame. Each time a function is called, a new frame is |
| 5836 | made. Each time a function returns, the frame for that function invocation |
| 5837 | is eliminated. If a function is recursive, there can be many frames for |
| 5838 | the same function. The frame for the function in which execution is |
| 5839 | actually occurring is called the @dfn{innermost} frame. This is the most |
| 5840 | recently created of all the stack frames that still exist. |
| 5841 | |
| 5842 | @cindex frame pointer |
| 5843 | Inside your program, stack frames are identified by their addresses. A |
| 5844 | stack frame consists of many bytes, each of which has its own address; each |
| 5845 | kind of computer has a convention for choosing one byte whose |
| 5846 | address serves as the address of the frame. Usually this address is kept |
| 5847 | in a register called the @dfn{frame pointer register} |
| 5848 | (@pxref{Registers, $fp}) while execution is going on in that frame. |
| 5849 | |
| 5850 | @cindex frame number |
| 5851 | @value{GDBN} assigns numbers to all existing stack frames, starting with |
| 5852 | zero for the innermost frame, one for the frame that called it, |
| 5853 | and so on upward. These numbers do not really exist in your program; |
| 5854 | they are assigned by @value{GDBN} to give you a way of designating stack |
| 5855 | frames in @value{GDBN} commands. |
| 5856 | |
| 5857 | @c The -fomit-frame-pointer below perennially causes hbox overflow |
| 5858 | @c underflow problems. |
| 5859 | @cindex frameless execution |
| 5860 | Some compilers provide a way to compile functions so that they operate |
| 5861 | without stack frames. (For example, the @value{NGCC} option |
| 5862 | @smallexample |
| 5863 | @samp{-fomit-frame-pointer} |
| 5864 | @end smallexample |
| 5865 | generates functions without a frame.) |
| 5866 | This is occasionally done with heavily used library functions to save |
| 5867 | the frame setup time. @value{GDBN} has limited facilities for dealing |
| 5868 | with these function invocations. If the innermost function invocation |
| 5869 | has no stack frame, @value{GDBN} nevertheless regards it as though |
| 5870 | it had a separate frame, which is numbered zero as usual, allowing |
| 5871 | correct tracing of the function call chain. However, @value{GDBN} has |
| 5872 | no provision for frameless functions elsewhere in the stack. |
| 5873 | |
| 5874 | @table @code |
| 5875 | @kindex frame@r{, command} |
| 5876 | @cindex current stack frame |
| 5877 | @item frame @var{args} |
| 5878 | The @code{frame} command allows you to move from one stack frame to another, |
| 5879 | and to print the stack frame you select. @var{args} may be either the |
| 5880 | address of the frame or the stack frame number. Without an argument, |
| 5881 | @code{frame} prints the current stack frame. |
| 5882 | |
| 5883 | @kindex select-frame |
| 5884 | @cindex selecting frame silently |
| 5885 | @item select-frame |
| 5886 | The @code{select-frame} command allows you to move from one stack frame |
| 5887 | to another without printing the frame. This is the silent version of |
| 5888 | @code{frame}. |
| 5889 | @end table |
| 5890 | |
| 5891 | @node Backtrace |
| 5892 | @section Backtraces |
| 5893 | |
| 5894 | @cindex traceback |
| 5895 | @cindex call stack traces |
| 5896 | A backtrace is a summary of how your program got where it is. It shows one |
| 5897 | line per frame, for many frames, starting with the currently executing |
| 5898 | frame (frame zero), followed by its caller (frame one), and on up the |
| 5899 | stack. |
| 5900 | |
| 5901 | @table @code |
| 5902 | @kindex backtrace |
| 5903 | @kindex bt @r{(@code{backtrace})} |
| 5904 | @item backtrace |
| 5905 | @itemx bt |
| 5906 | Print a backtrace of the entire stack: one line per frame for all |
| 5907 | frames in the stack. |
| 5908 | |
| 5909 | You can stop the backtrace at any time by typing the system interrupt |
| 5910 | character, normally @kbd{Ctrl-c}. |
| 5911 | |
| 5912 | @item backtrace @var{n} |
| 5913 | @itemx bt @var{n} |
| 5914 | Similar, but print only the innermost @var{n} frames. |
| 5915 | |
| 5916 | @item backtrace -@var{n} |
| 5917 | @itemx bt -@var{n} |
| 5918 | Similar, but print only the outermost @var{n} frames. |
| 5919 | |
| 5920 | @item backtrace full |
| 5921 | @itemx bt full |
| 5922 | @itemx bt full @var{n} |
| 5923 | @itemx bt full -@var{n} |
| 5924 | Print the values of the local variables also. @var{n} specifies the |
| 5925 | number of frames to print, as described above. |
| 5926 | @end table |
| 5927 | |
| 5928 | @kindex where |
| 5929 | @kindex info stack |
| 5930 | The names @code{where} and @code{info stack} (abbreviated @code{info s}) |
| 5931 | are additional aliases for @code{backtrace}. |
| 5932 | |
| 5933 | @cindex multiple threads, backtrace |
| 5934 | In a multi-threaded program, @value{GDBN} by default shows the |
| 5935 | backtrace only for the current thread. To display the backtrace for |
| 5936 | several or all of the threads, use the command @code{thread apply} |
| 5937 | (@pxref{Threads, thread apply}). For example, if you type @kbd{thread |
| 5938 | apply all backtrace}, @value{GDBN} will display the backtrace for all |
| 5939 | the threads; this is handy when you debug a core dump of a |
| 5940 | multi-threaded program. |
| 5941 | |
| 5942 | Each line in the backtrace shows the frame number and the function name. |
| 5943 | The program counter value is also shown---unless you use @code{set |
| 5944 | print address off}. The backtrace also shows the source file name and |
| 5945 | line number, as well as the arguments to the function. The program |
| 5946 | counter value is omitted if it is at the beginning of the code for that |
| 5947 | line number. |
| 5948 | |
| 5949 | Here is an example of a backtrace. It was made with the command |
| 5950 | @samp{bt 3}, so it shows the innermost three frames. |
| 5951 | |
| 5952 | @smallexample |
| 5953 | @group |
| 5954 | #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8) |
| 5955 | at builtin.c:993 |
| 5956 | #1 0x6e38 in expand_macro (sym=0x2b600, data=...) at macro.c:242 |
| 5957 | #2 0x6840 in expand_token (obs=0x0, t=177664, td=0xf7fffb08) |
| 5958 | at macro.c:71 |
| 5959 | (More stack frames follow...) |
| 5960 | @end group |
| 5961 | @end smallexample |
| 5962 | |
| 5963 | @noindent |
| 5964 | The display for frame zero does not begin with a program counter |
| 5965 | value, indicating that your program has stopped at the beginning of the |
| 5966 | code for line @code{993} of @code{builtin.c}. |
| 5967 | |
| 5968 | @noindent |
| 5969 | The value of parameter @code{data} in frame 1 has been replaced by |
| 5970 | @code{@dots{}}. By default, @value{GDBN} prints the value of a parameter |
| 5971 | only if it is a scalar (integer, pointer, enumeration, etc). See command |
| 5972 | @kbd{set print frame-arguments} in @ref{Print Settings} for more details |
| 5973 | on how to configure the way function parameter values are printed. |
| 5974 | |
| 5975 | @cindex optimized out, in backtrace |
| 5976 | @cindex function call arguments, optimized out |
| 5977 | If your program was compiled with optimizations, some compilers will |
| 5978 | optimize away arguments passed to functions if those arguments are |
| 5979 | never used after the call. Such optimizations generate code that |
| 5980 | passes arguments through registers, but doesn't store those arguments |
| 5981 | in the stack frame. @value{GDBN} has no way of displaying such |
| 5982 | arguments in stack frames other than the innermost one. Here's what |
| 5983 | such a backtrace might look like: |
| 5984 | |
| 5985 | @smallexample |
| 5986 | @group |
| 5987 | #0 m4_traceon (obs=0x24eb0, argc=1, argv=0x2b8c8) |
| 5988 | at builtin.c:993 |
| 5989 | #1 0x6e38 in expand_macro (sym=<optimized out>) at macro.c:242 |
| 5990 | #2 0x6840 in expand_token (obs=0x0, t=<optimized out>, td=0xf7fffb08) |
| 5991 | at macro.c:71 |
| 5992 | (More stack frames follow...) |
| 5993 | @end group |
| 5994 | @end smallexample |
| 5995 | |
| 5996 | @noindent |
| 5997 | The values of arguments that were not saved in their stack frames are |
| 5998 | shown as @samp{<optimized out>}. |
| 5999 | |
| 6000 | If you need to display the values of such optimized-out arguments, |
| 6001 | either deduce that from other variables whose values depend on the one |
| 6002 | you are interested in, or recompile without optimizations. |
| 6003 | |
| 6004 | @cindex backtrace beyond @code{main} function |
| 6005 | @cindex program entry point |
| 6006 | @cindex startup code, and backtrace |
| 6007 | Most programs have a standard user entry point---a place where system |
| 6008 | libraries and startup code transition into user code. For C this is |
| 6009 | @code{main}@footnote{ |
| 6010 | Note that embedded programs (the so-called ``free-standing'' |
| 6011 | environment) are not required to have a @code{main} function as the |
| 6012 | entry point. They could even have multiple entry points.}. |
| 6013 | When @value{GDBN} finds the entry function in a backtrace |
| 6014 | it will terminate the backtrace, to avoid tracing into highly |
| 6015 | system-specific (and generally uninteresting) code. |
| 6016 | |
| 6017 | If you need to examine the startup code, or limit the number of levels |
| 6018 | in a backtrace, you can change this behavior: |
| 6019 | |
| 6020 | @table @code |
| 6021 | @item set backtrace past-main |
| 6022 | @itemx set backtrace past-main on |
| 6023 | @kindex set backtrace |
| 6024 | Backtraces will continue past the user entry point. |
| 6025 | |
| 6026 | @item set backtrace past-main off |
| 6027 | Backtraces will stop when they encounter the user entry point. This is the |
| 6028 | default. |
| 6029 | |
| 6030 | @item show backtrace past-main |
| 6031 | @kindex show backtrace |
| 6032 | Display the current user entry point backtrace policy. |
| 6033 | |
| 6034 | @item set backtrace past-entry |
| 6035 | @itemx set backtrace past-entry on |
| 6036 | Backtraces will continue past the internal entry point of an application. |
| 6037 | This entry point is encoded by the linker when the application is built, |
| 6038 | and is likely before the user entry point @code{main} (or equivalent) is called. |
| 6039 | |
| 6040 | @item set backtrace past-entry off |
| 6041 | Backtraces will stop when they encounter the internal entry point of an |
| 6042 | application. This is the default. |
| 6043 | |
| 6044 | @item show backtrace past-entry |
| 6045 | Display the current internal entry point backtrace policy. |
| 6046 | |
| 6047 | @item set backtrace limit @var{n} |
| 6048 | @itemx set backtrace limit 0 |
| 6049 | @cindex backtrace limit |
| 6050 | Limit the backtrace to @var{n} levels. A value of zero means |
| 6051 | unlimited. |
| 6052 | |
| 6053 | @item show backtrace limit |
| 6054 | Display the current limit on backtrace levels. |
| 6055 | @end table |
| 6056 | |
| 6057 | @node Selection |
| 6058 | @section Selecting a Frame |
| 6059 | |
| 6060 | Most commands for examining the stack and other data in your program work on |
| 6061 | whichever stack frame is selected at the moment. Here are the commands for |
| 6062 | selecting a stack frame; all of them finish by printing a brief description |
| 6063 | of the stack frame just selected. |
| 6064 | |
| 6065 | @table @code |
| 6066 | @kindex frame@r{, selecting} |
| 6067 | @kindex f @r{(@code{frame})} |
| 6068 | @item frame @var{n} |
| 6069 | @itemx f @var{n} |
| 6070 | Select frame number @var{n}. Recall that frame zero is the innermost |
| 6071 | (currently executing) frame, frame one is the frame that called the |
| 6072 | innermost one, and so on. The highest-numbered frame is the one for |
| 6073 | @code{main}. |
| 6074 | |
| 6075 | @item frame @var{addr} |
| 6076 | @itemx f @var{addr} |
| 6077 | Select the frame at address @var{addr}. This is useful mainly if the |
| 6078 | chaining of stack frames has been damaged by a bug, making it |
| 6079 | impossible for @value{GDBN} to assign numbers properly to all frames. In |
| 6080 | addition, this can be useful when your program has multiple stacks and |
| 6081 | switches between them. |
| 6082 | |
| 6083 | On the SPARC architecture, @code{frame} needs two addresses to |
| 6084 | select an arbitrary frame: a frame pointer and a stack pointer. |
| 6085 | |
| 6086 | On the MIPS and Alpha architecture, it needs two addresses: a stack |
| 6087 | pointer and a program counter. |
| 6088 | |
| 6089 | On the 29k architecture, it needs three addresses: a register stack |
| 6090 | pointer, a program counter, and a memory stack pointer. |
| 6091 | |
| 6092 | @kindex up |
| 6093 | @item up @var{n} |
| 6094 | Move @var{n} frames up the stack. For positive numbers @var{n}, this |
| 6095 | advances toward the outermost frame, to higher frame numbers, to frames |
| 6096 | that have existed longer. @var{n} defaults to one. |
| 6097 | |
| 6098 | @kindex down |
| 6099 | @kindex do @r{(@code{down})} |
| 6100 | @item down @var{n} |
| 6101 | Move @var{n} frames down the stack. For positive numbers @var{n}, this |
| 6102 | advances toward the innermost frame, to lower frame numbers, to frames |
| 6103 | that were created more recently. @var{n} defaults to one. You may |
| 6104 | abbreviate @code{down} as @code{do}. |
| 6105 | @end table |
| 6106 | |
| 6107 | All of these commands end by printing two lines of output describing the |
| 6108 | frame. The first line shows the frame number, the function name, the |
| 6109 | arguments, and the source file and line number of execution in that |
| 6110 | frame. The second line shows the text of that source line. |
| 6111 | |
| 6112 | @need 1000 |
| 6113 | For example: |
| 6114 | |
| 6115 | @smallexample |
| 6116 | @group |
| 6117 | (@value{GDBP}) up |
| 6118 | #1 0x22f0 in main (argc=1, argv=0xf7fffbf4, env=0xf7fffbfc) |
| 6119 | at env.c:10 |
| 6120 | 10 read_input_file (argv[i]); |
| 6121 | @end group |
| 6122 | @end smallexample |
| 6123 | |
| 6124 | After such a printout, the @code{list} command with no arguments |
| 6125 | prints ten lines centered on the point of execution in the frame. |
| 6126 | You can also edit the program at the point of execution with your favorite |
| 6127 | editing program by typing @code{edit}. |
| 6128 | @xref{List, ,Printing Source Lines}, |
| 6129 | for details. |
| 6130 | |
| 6131 | @table @code |
| 6132 | @kindex down-silently |
| 6133 | @kindex up-silently |
| 6134 | @item up-silently @var{n} |
| 6135 | @itemx down-silently @var{n} |
| 6136 | These two commands are variants of @code{up} and @code{down}, |
| 6137 | respectively; they differ in that they do their work silently, without |
| 6138 | causing display of the new frame. They are intended primarily for use |
| 6139 | in @value{GDBN} command scripts, where the output might be unnecessary and |
| 6140 | distracting. |
| 6141 | @end table |
| 6142 | |
| 6143 | @node Frame Info |
| 6144 | @section Information About a Frame |
| 6145 | |
| 6146 | There are several other commands to print information about the selected |
| 6147 | stack frame. |
| 6148 | |
| 6149 | @table @code |
| 6150 | @item frame |
| 6151 | @itemx f |
| 6152 | When used without any argument, this command does not change which |
| 6153 | frame is selected, but prints a brief description of the currently |
| 6154 | selected stack frame. It can be abbreviated @code{f}. With an |
| 6155 | argument, this command is used to select a stack frame. |
| 6156 | @xref{Selection, ,Selecting a Frame}. |
| 6157 | |
| 6158 | @kindex info frame |
| 6159 | @kindex info f @r{(@code{info frame})} |
| 6160 | @item info frame |
| 6161 | @itemx info f |
| 6162 | This command prints a verbose description of the selected stack frame, |
| 6163 | including: |
| 6164 | |
| 6165 | @itemize @bullet |
| 6166 | @item |
| 6167 | the address of the frame |
| 6168 | @item |
| 6169 | the address of the next frame down (called by this frame) |
| 6170 | @item |
| 6171 | the address of the next frame up (caller of this frame) |
| 6172 | @item |
| 6173 | the language in which the source code corresponding to this frame is written |
| 6174 | @item |
| 6175 | the address of the frame's arguments |
| 6176 | @item |
| 6177 | the address of the frame's local variables |
| 6178 | @item |
| 6179 | the program counter saved in it (the address of execution in the caller frame) |
| 6180 | @item |
| 6181 | which registers were saved in the frame |
| 6182 | @end itemize |
| 6183 | |
| 6184 | @noindent The verbose description is useful when |
| 6185 | something has gone wrong that has made the stack format fail to fit |
| 6186 | the usual conventions. |
| 6187 | |
| 6188 | @item info frame @var{addr} |
| 6189 | @itemx info f @var{addr} |
| 6190 | Print a verbose description of the frame at address @var{addr}, without |
| 6191 | selecting that frame. The selected frame remains unchanged by this |
| 6192 | command. This requires the same kind of address (more than one for some |
| 6193 | architectures) that you specify in the @code{frame} command. |
| 6194 | @xref{Selection, ,Selecting a Frame}. |
| 6195 | |
| 6196 | @kindex info args |
| 6197 | @item info args |
| 6198 | Print the arguments of the selected frame, each on a separate line. |
| 6199 | |
| 6200 | @item info locals |
| 6201 | @kindex info locals |
| 6202 | Print the local variables of the selected frame, each on a separate |
| 6203 | line. These are all variables (declared either static or automatic) |
| 6204 | accessible at the point of execution of the selected frame. |
| 6205 | |
| 6206 | @kindex info catch |
| 6207 | @cindex catch exceptions, list active handlers |
| 6208 | @cindex exception handlers, how to list |
| 6209 | @item info catch |
| 6210 | Print a list of all the exception handlers that are active in the |
| 6211 | current stack frame at the current point of execution. To see other |
| 6212 | exception handlers, visit the associated frame (using the @code{up}, |
| 6213 | @code{down}, or @code{frame} commands); then type @code{info catch}. |
| 6214 | @xref{Set Catchpoints, , Setting Catchpoints}. |
| 6215 | |
| 6216 | @end table |
| 6217 | |
| 6218 | |
| 6219 | @node Source |
| 6220 | @chapter Examining Source Files |
| 6221 | |
| 6222 | @value{GDBN} can print parts of your program's source, since the debugging |
| 6223 | information recorded in the program tells @value{GDBN} what source files were |
| 6224 | used to build it. When your program stops, @value{GDBN} spontaneously prints |
| 6225 | the line where it stopped. Likewise, when you select a stack frame |
| 6226 | (@pxref{Selection, ,Selecting a Frame}), @value{GDBN} prints the line where |
| 6227 | execution in that frame has stopped. You can print other portions of |
| 6228 | source files by explicit command. |
| 6229 | |
| 6230 | If you use @value{GDBN} through its @sc{gnu} Emacs interface, you may |
| 6231 | prefer to use Emacs facilities to view source; see @ref{Emacs, ,Using |
| 6232 | @value{GDBN} under @sc{gnu} Emacs}. |
| 6233 | |
| 6234 | @menu |
| 6235 | * List:: Printing source lines |
| 6236 | * Specify Location:: How to specify code locations |
| 6237 | * Edit:: Editing source files |
| 6238 | * Search:: Searching source files |
| 6239 | * Source Path:: Specifying source directories |
| 6240 | * Machine Code:: Source and machine code |
| 6241 | @end menu |
| 6242 | |
| 6243 | @node List |
| 6244 | @section Printing Source Lines |
| 6245 | |
| 6246 | @kindex list |
| 6247 | @kindex l @r{(@code{list})} |
| 6248 | To print lines from a source file, use the @code{list} command |
| 6249 | (abbreviated @code{l}). By default, ten lines are printed. |
| 6250 | There are several ways to specify what part of the file you want to |
| 6251 | print; see @ref{Specify Location}, for the full list. |
| 6252 | |
| 6253 | Here are the forms of the @code{list} command most commonly used: |
| 6254 | |
| 6255 | @table @code |
| 6256 | @item list @var{linenum} |
| 6257 | Print lines centered around line number @var{linenum} in the |
| 6258 | current source file. |
| 6259 | |
| 6260 | @item list @var{function} |
| 6261 | Print lines centered around the beginning of function |
| 6262 | @var{function}. |
| 6263 | |
| 6264 | @item list |
| 6265 | Print more lines. If the last lines printed were printed with a |
| 6266 | @code{list} command, this prints lines following the last lines |
| 6267 | printed; however, if the last line printed was a solitary line printed |
| 6268 | as part of displaying a stack frame (@pxref{Stack, ,Examining the |
| 6269 | Stack}), this prints lines centered around that line. |
| 6270 | |
| 6271 | @item list - |
| 6272 | Print lines just before the lines last printed. |
| 6273 | @end table |
| 6274 | |
| 6275 | @cindex @code{list}, how many lines to display |
| 6276 | By default, @value{GDBN} prints ten source lines with any of these forms of |
| 6277 | the @code{list} command. You can change this using @code{set listsize}: |
| 6278 | |
| 6279 | @table @code |
| 6280 | @kindex set listsize |
| 6281 | @item set listsize @var{count} |
| 6282 | Make the @code{list} command display @var{count} source lines (unless |
| 6283 | the @code{list} argument explicitly specifies some other number). |
| 6284 | |
| 6285 | @kindex show listsize |
| 6286 | @item show listsize |
| 6287 | Display the number of lines that @code{list} prints. |
| 6288 | @end table |
| 6289 | |
| 6290 | Repeating a @code{list} command with @key{RET} discards the argument, |
| 6291 | so it is equivalent to typing just @code{list}. This is more useful |
| 6292 | than listing the same lines again. An exception is made for an |
| 6293 | argument of @samp{-}; that argument is preserved in repetition so that |
| 6294 | each repetition moves up in the source file. |
| 6295 | |
| 6296 | In general, the @code{list} command expects you to supply zero, one or two |
| 6297 | @dfn{linespecs}. Linespecs specify source lines; there are several ways |
| 6298 | of writing them (@pxref{Specify Location}), but the effect is always |
| 6299 | to specify some source line. |
| 6300 | |
| 6301 | Here is a complete description of the possible arguments for @code{list}: |
| 6302 | |
| 6303 | @table @code |
| 6304 | @item list @var{linespec} |
| 6305 | Print lines centered around the line specified by @var{linespec}. |
| 6306 | |
| 6307 | @item list @var{first},@var{last} |
| 6308 | Print lines from @var{first} to @var{last}. Both arguments are |
| 6309 | linespecs. When a @code{list} command has two linespecs, and the |
| 6310 | source file of the second linespec is omitted, this refers to |
| 6311 | the same source file as the first linespec. |
| 6312 | |
| 6313 | @item list ,@var{last} |
| 6314 | Print lines ending with @var{last}. |
| 6315 | |
| 6316 | @item list @var{first}, |
| 6317 | Print lines starting with @var{first}. |
| 6318 | |
| 6319 | @item list + |
| 6320 | Print lines just after the lines last printed. |
| 6321 | |
| 6322 | @item list - |
| 6323 | Print lines just before the lines last printed. |
| 6324 | |
| 6325 | @item list |
| 6326 | As described in the preceding table. |
| 6327 | @end table |
| 6328 | |
| 6329 | @node Specify Location |
| 6330 | @section Specifying a Location |
| 6331 | @cindex specifying location |
| 6332 | @cindex linespec |
| 6333 | |
| 6334 | Several @value{GDBN} commands accept arguments that specify a location |
| 6335 | of your program's code. Since @value{GDBN} is a source-level |
| 6336 | debugger, a location usually specifies some line in the source code; |
| 6337 | for that reason, locations are also known as @dfn{linespecs}. |
| 6338 | |
| 6339 | Here are all the different ways of specifying a code location that |
| 6340 | @value{GDBN} understands: |
| 6341 | |
| 6342 | @table @code |
| 6343 | @item @var{linenum} |
| 6344 | Specifies the line number @var{linenum} of the current source file. |
| 6345 | |
| 6346 | @item -@var{offset} |
| 6347 | @itemx +@var{offset} |
| 6348 | Specifies the line @var{offset} lines before or after the @dfn{current |
| 6349 | line}. For the @code{list} command, the current line is the last one |
| 6350 | printed; for the breakpoint commands, this is the line at which |
| 6351 | execution stopped in the currently selected @dfn{stack frame} |
| 6352 | (@pxref{Frames, ,Frames}, for a description of stack frames.) When |
| 6353 | used as the second of the two linespecs in a @code{list} command, |
| 6354 | this specifies the line @var{offset} lines up or down from the first |
| 6355 | linespec. |
| 6356 | |
| 6357 | @item @var{filename}:@var{linenum} |
| 6358 | Specifies the line @var{linenum} in the source file @var{filename}. |
| 6359 | |
| 6360 | @item @var{function} |
| 6361 | Specifies the line that begins the body of the function @var{function}. |
| 6362 | For example, in C, this is the line with the open brace. |
| 6363 | |
| 6364 | @item @var{function}:@var{label} |
| 6365 | Specifies the line where @var{label} appears in @var{function}. |
| 6366 | |
| 6367 | @item @var{filename}:@var{function} |
| 6368 | Specifies the line that begins the body of the function @var{function} |
| 6369 | in the file @var{filename}. You only need the file name with a |
| 6370 | function name to avoid ambiguity when there are identically named |
| 6371 | functions in different source files. |
| 6372 | |
| 6373 | @item @var{label} |
| 6374 | Specifies the line at which the label named @var{label} appears. |
| 6375 | @value{GDBN} searches for the label in the function corresponding to |
| 6376 | the currently selected stack frame. If there is no current selected |
| 6377 | stack frame (for instance, if the inferior is not running), then |
| 6378 | @value{GDBN} will not search for a label. |
| 6379 | |
| 6380 | @item *@var{address} |
| 6381 | Specifies the program address @var{address}. For line-oriented |
| 6382 | commands, such as @code{list} and @code{edit}, this specifies a source |
| 6383 | line that contains @var{address}. For @code{break} and other |
| 6384 | breakpoint oriented commands, this can be used to set breakpoints in |
| 6385 | parts of your program which do not have debugging information or |
| 6386 | source files. |
| 6387 | |
| 6388 | Here @var{address} may be any expression valid in the current working |
| 6389 | language (@pxref{Languages, working language}) that specifies a code |
| 6390 | address. In addition, as a convenience, @value{GDBN} extends the |
| 6391 | semantics of expressions used in locations to cover the situations |
| 6392 | that frequently happen during debugging. Here are the various forms |
| 6393 | of @var{address}: |
| 6394 | |
| 6395 | @table @code |
| 6396 | @item @var{expression} |
| 6397 | Any expression valid in the current working language. |
| 6398 | |
| 6399 | @item @var{funcaddr} |
| 6400 | An address of a function or procedure derived from its name. In C, |
| 6401 | C@t{++}, Java, Objective-C, Fortran, minimal, and assembly, this is |
| 6402 | simply the function's name @var{function} (and actually a special case |
| 6403 | of a valid expression). In Pascal and Modula-2, this is |
| 6404 | @code{&@var{function}}. In Ada, this is @code{@var{function}'Address} |
| 6405 | (although the Pascal form also works). |
| 6406 | |
| 6407 | This form specifies the address of the function's first instruction, |
| 6408 | before the stack frame and arguments have been set up. |
| 6409 | |
| 6410 | @item '@var{filename}'::@var{funcaddr} |
| 6411 | Like @var{funcaddr} above, but also specifies the name of the source |
| 6412 | file explicitly. This is useful if the name of the function does not |
| 6413 | specify the function unambiguously, e.g., if there are several |
| 6414 | functions with identical names in different source files. |
| 6415 | @end table |
| 6416 | |
| 6417 | @end table |
| 6418 | |
| 6419 | |
| 6420 | @node Edit |
| 6421 | @section Editing Source Files |
| 6422 | @cindex editing source files |
| 6423 | |
| 6424 | @kindex edit |
| 6425 | @kindex e @r{(@code{edit})} |
| 6426 | To edit the lines in a source file, use the @code{edit} command. |
| 6427 | The editing program of your choice |
| 6428 | is invoked with the current line set to |
| 6429 | the active line in the program. |
| 6430 | Alternatively, there are several ways to specify what part of the file you |
| 6431 | want to print if you want to see other parts of the program: |
| 6432 | |
| 6433 | @table @code |
| 6434 | @item edit @var{location} |
| 6435 | Edit the source file specified by @code{location}. Editing starts at |
| 6436 | that @var{location}, e.g., at the specified source line of the |
| 6437 | specified file. @xref{Specify Location}, for all the possible forms |
| 6438 | of the @var{location} argument; here are the forms of the @code{edit} |
| 6439 | command most commonly used: |
| 6440 | |
| 6441 | @table @code |
| 6442 | @item edit @var{number} |
| 6443 | Edit the current source file with @var{number} as the active line number. |
| 6444 | |
| 6445 | @item edit @var{function} |
| 6446 | Edit the file containing @var{function} at the beginning of its definition. |
| 6447 | @end table |
| 6448 | |
| 6449 | @end table |
| 6450 | |
| 6451 | @subsection Choosing your Editor |
| 6452 | You can customize @value{GDBN} to use any editor you want |
| 6453 | @footnote{ |
| 6454 | The only restriction is that your editor (say @code{ex}), recognizes the |
| 6455 | following command-line syntax: |
| 6456 | @smallexample |
| 6457 | ex +@var{number} file |
| 6458 | @end smallexample |
| 6459 | The optional numeric value +@var{number} specifies the number of the line in |
| 6460 | the file where to start editing.}. |
| 6461 | By default, it is @file{@value{EDITOR}}, but you can change this |
| 6462 | by setting the environment variable @code{EDITOR} before using |
| 6463 | @value{GDBN}. For example, to configure @value{GDBN} to use the |
| 6464 | @code{vi} editor, you could use these commands with the @code{sh} shell: |
| 6465 | @smallexample |
| 6466 | EDITOR=/usr/bin/vi |
| 6467 | export EDITOR |
| 6468 | gdb @dots{} |
| 6469 | @end smallexample |
| 6470 | or in the @code{csh} shell, |
| 6471 | @smallexample |
| 6472 | setenv EDITOR /usr/bin/vi |
| 6473 | gdb @dots{} |
| 6474 | @end smallexample |
| 6475 | |
| 6476 | @node Search |
| 6477 | @section Searching Source Files |
| 6478 | @cindex searching source files |
| 6479 | |
| 6480 | There are two commands for searching through the current source file for a |
| 6481 | regular expression. |
| 6482 | |
| 6483 | @table @code |
| 6484 | @kindex search |
| 6485 | @kindex forward-search |
| 6486 | @item forward-search @var{regexp} |
| 6487 | @itemx search @var{regexp} |
| 6488 | The command @samp{forward-search @var{regexp}} checks each line, |
| 6489 | starting with the one following the last line listed, for a match for |
| 6490 | @var{regexp}. It lists the line that is found. You can use the |
| 6491 | synonym @samp{search @var{regexp}} or abbreviate the command name as |
| 6492 | @code{fo}. |
| 6493 | |
| 6494 | @kindex reverse-search |
| 6495 | @item reverse-search @var{regexp} |
| 6496 | The command @samp{reverse-search @var{regexp}} checks each line, starting |
| 6497 | with the one before the last line listed and going backward, for a match |
| 6498 | for @var{regexp}. It lists the line that is found. You can abbreviate |
| 6499 | this command as @code{rev}. |
| 6500 | @end table |
| 6501 | |
| 6502 | @node Source Path |
| 6503 | @section Specifying Source Directories |
| 6504 | |
| 6505 | @cindex source path |
| 6506 | @cindex directories for source files |
| 6507 | Executable programs sometimes do not record the directories of the source |
| 6508 | files from which they were compiled, just the names. Even when they do, |
| 6509 | the directories could be moved between the compilation and your debugging |
| 6510 | session. @value{GDBN} has a list of directories to search for source files; |
| 6511 | this is called the @dfn{source path}. Each time @value{GDBN} wants a source file, |
| 6512 | it tries all the directories in the list, in the order they are present |
| 6513 | in the list, until it finds a file with the desired name. |
| 6514 | |
| 6515 | For example, suppose an executable references the file |
| 6516 | @file{/usr/src/foo-1.0/lib/foo.c}, and our source path is |
| 6517 | @file{/mnt/cross}. The file is first looked up literally; if this |
| 6518 | fails, @file{/mnt/cross/usr/src/foo-1.0/lib/foo.c} is tried; if this |
| 6519 | fails, @file{/mnt/cross/foo.c} is opened; if this fails, an error |
| 6520 | message is printed. @value{GDBN} does not look up the parts of the |
| 6521 | source file name, such as @file{/mnt/cross/src/foo-1.0/lib/foo.c}. |
| 6522 | Likewise, the subdirectories of the source path are not searched: if |
| 6523 | the source path is @file{/mnt/cross}, and the binary refers to |
| 6524 | @file{foo.c}, @value{GDBN} would not find it under |
| 6525 | @file{/mnt/cross/usr/src/foo-1.0/lib}. |
| 6526 | |
| 6527 | Plain file names, relative file names with leading directories, file |
| 6528 | names containing dots, etc.@: are all treated as described above; for |
| 6529 | instance, if the source path is @file{/mnt/cross}, and the source file |
| 6530 | is recorded as @file{../lib/foo.c}, @value{GDBN} would first try |
| 6531 | @file{../lib/foo.c}, then @file{/mnt/cross/../lib/foo.c}, and after |
| 6532 | that---@file{/mnt/cross/foo.c}. |
| 6533 | |
| 6534 | Note that the executable search path is @emph{not} used to locate the |
| 6535 | source files. |
| 6536 | |
| 6537 | Whenever you reset or rearrange the source path, @value{GDBN} clears out |
| 6538 | any information it has cached about where source files are found and where |
| 6539 | each line is in the file. |
| 6540 | |
| 6541 | @kindex directory |
| 6542 | @kindex dir |
| 6543 | When you start @value{GDBN}, its source path includes only @samp{cdir} |
| 6544 | and @samp{cwd}, in that order. |
| 6545 | To add other directories, use the @code{directory} command. |
| 6546 | |
| 6547 | The search path is used to find both program source files and @value{GDBN} |
| 6548 | script files (read using the @samp{-command} option and @samp{source} command). |
| 6549 | |
| 6550 | In addition to the source path, @value{GDBN} provides a set of commands |
| 6551 | that manage a list of source path substitution rules. A @dfn{substitution |
| 6552 | rule} specifies how to rewrite source directories stored in the program's |
| 6553 | debug information in case the sources were moved to a different |
| 6554 | directory between compilation and debugging. A rule is made of |
| 6555 | two strings, the first specifying what needs to be rewritten in |
| 6556 | the path, and the second specifying how it should be rewritten. |
| 6557 | In @ref{set substitute-path}, we name these two parts @var{from} and |
| 6558 | @var{to} respectively. @value{GDBN} does a simple string replacement |
| 6559 | of @var{from} with @var{to} at the start of the directory part of the |
| 6560 | source file name, and uses that result instead of the original file |
| 6561 | name to look up the sources. |
| 6562 | |
| 6563 | Using the previous example, suppose the @file{foo-1.0} tree has been |
| 6564 | moved from @file{/usr/src} to @file{/mnt/cross}, then you can tell |
| 6565 | @value{GDBN} to replace @file{/usr/src} in all source path names with |
| 6566 | @file{/mnt/cross}. The first lookup will then be |
| 6567 | @file{/mnt/cross/foo-1.0/lib/foo.c} in place of the original location |
| 6568 | of @file{/usr/src/foo-1.0/lib/foo.c}. To define a source path |
| 6569 | substitution rule, use the @code{set substitute-path} command |
| 6570 | (@pxref{set substitute-path}). |
| 6571 | |
| 6572 | To avoid unexpected substitution results, a rule is applied only if the |
| 6573 | @var{from} part of the directory name ends at a directory separator. |
| 6574 | For instance, a rule substituting @file{/usr/source} into |
| 6575 | @file{/mnt/cross} will be applied to @file{/usr/source/foo-1.0} but |
| 6576 | not to @file{/usr/sourceware/foo-2.0}. And because the substitution |
| 6577 | is applied only at the beginning of the directory name, this rule will |
| 6578 | not be applied to @file{/root/usr/source/baz.c} either. |
| 6579 | |
| 6580 | In many cases, you can achieve the same result using the @code{directory} |
| 6581 | command. However, @code{set substitute-path} can be more efficient in |
| 6582 | the case where the sources are organized in a complex tree with multiple |
| 6583 | subdirectories. With the @code{directory} command, you need to add each |
| 6584 | subdirectory of your project. If you moved the entire tree while |
| 6585 | preserving its internal organization, then @code{set substitute-path} |
| 6586 | allows you to direct the debugger to all the sources with one single |
| 6587 | command. |
| 6588 | |
| 6589 | @code{set substitute-path} is also more than just a shortcut command. |
| 6590 | The source path is only used if the file at the original location no |
| 6591 | longer exists. On the other hand, @code{set substitute-path} modifies |
| 6592 | the debugger behavior to look at the rewritten location instead. So, if |
| 6593 | for any reason a source file that is not relevant to your executable is |
| 6594 | located at the original location, a substitution rule is the only |
| 6595 | method available to point @value{GDBN} at the new location. |
| 6596 | |
| 6597 | @cindex @samp{--with-relocated-sources} |
| 6598 | @cindex default source path substitution |
| 6599 | You can configure a default source path substitution rule by |
| 6600 | configuring @value{GDBN} with the |
| 6601 | @samp{--with-relocated-sources=@var{dir}} option. The @var{dir} |
| 6602 | should be the name of a directory under @value{GDBN}'s configured |
| 6603 | prefix (set with @samp{--prefix} or @samp{--exec-prefix}), and |
| 6604 | directory names in debug information under @var{dir} will be adjusted |
| 6605 | automatically if the installed @value{GDBN} is moved to a new |
| 6606 | location. This is useful if @value{GDBN}, libraries or executables |
| 6607 | with debug information and corresponding source code are being moved |
| 6608 | together. |
| 6609 | |
| 6610 | @table @code |
| 6611 | @item directory @var{dirname} @dots{} |
| 6612 | @item dir @var{dirname} @dots{} |
| 6613 | Add directory @var{dirname} to the front of the source path. Several |
| 6614 | directory names may be given to this command, separated by @samp{:} |
| 6615 | (@samp{;} on MS-DOS and MS-Windows, where @samp{:} usually appears as |
| 6616 | part of absolute file names) or |
| 6617 | whitespace. You may specify a directory that is already in the source |
| 6618 | path; this moves it forward, so @value{GDBN} searches it sooner. |
| 6619 | |
| 6620 | @kindex cdir |
| 6621 | @kindex cwd |
| 6622 | @vindex $cdir@r{, convenience variable} |
| 6623 | @vindex $cwd@r{, convenience variable} |
| 6624 | @cindex compilation directory |
| 6625 | @cindex current directory |
| 6626 | @cindex working directory |
| 6627 | @cindex directory, current |
| 6628 | @cindex directory, compilation |
| 6629 | You can use the string @samp{$cdir} to refer to the compilation |
| 6630 | directory (if one is recorded), and @samp{$cwd} to refer to the current |
| 6631 | working directory. @samp{$cwd} is not the same as @samp{.}---the former |
| 6632 | tracks the current working directory as it changes during your @value{GDBN} |
| 6633 | session, while the latter is immediately expanded to the current |
| 6634 | directory at the time you add an entry to the source path. |
| 6635 | |
| 6636 | @item directory |
| 6637 | Reset the source path to its default value (@samp{$cdir:$cwd} on Unix systems). This requires confirmation. |
| 6638 | |
| 6639 | @c RET-repeat for @code{directory} is explicitly disabled, but since |
| 6640 | @c repeating it would be a no-op we do not say that. (thanks to RMS) |
| 6641 | |
| 6642 | @item set directories @var{path-list} |
| 6643 | @kindex set directories |
| 6644 | Set the source path to @var{path-list}. |
| 6645 | @samp{$cdir:$cwd} are added if missing. |
| 6646 | |
| 6647 | @item show directories |
| 6648 | @kindex show directories |
| 6649 | Print the source path: show which directories it contains. |
| 6650 | |
| 6651 | @anchor{set substitute-path} |
| 6652 | @item set substitute-path @var{from} @var{to} |
| 6653 | @kindex set substitute-path |
| 6654 | Define a source path substitution rule, and add it at the end of the |
| 6655 | current list of existing substitution rules. If a rule with the same |
| 6656 | @var{from} was already defined, then the old rule is also deleted. |
| 6657 | |
| 6658 | For example, if the file @file{/foo/bar/baz.c} was moved to |
| 6659 | @file{/mnt/cross/baz.c}, then the command |
| 6660 | |
| 6661 | @smallexample |
| 6662 | (@value{GDBP}) set substitute-path /usr/src /mnt/cross |
| 6663 | @end smallexample |
| 6664 | |
| 6665 | @noindent |
| 6666 | will tell @value{GDBN} to replace @samp{/usr/src} with |
| 6667 | @samp{/mnt/cross}, which will allow @value{GDBN} to find the file |
| 6668 | @file{baz.c} even though it was moved. |
| 6669 | |
| 6670 | In the case when more than one substitution rule have been defined, |
| 6671 | the rules are evaluated one by one in the order where they have been |
| 6672 | defined. The first one matching, if any, is selected to perform |
| 6673 | the substitution. |
| 6674 | |
| 6675 | For instance, if we had entered the following commands: |
| 6676 | |
| 6677 | @smallexample |
| 6678 | (@value{GDBP}) set substitute-path /usr/src/include /mnt/include |
| 6679 | (@value{GDBP}) set substitute-path /usr/src /mnt/src |
| 6680 | @end smallexample |
| 6681 | |
| 6682 | @noindent |
| 6683 | @value{GDBN} would then rewrite @file{/usr/src/include/defs.h} into |
| 6684 | @file{/mnt/include/defs.h} by using the first rule. However, it would |
| 6685 | use the second rule to rewrite @file{/usr/src/lib/foo.c} into |
| 6686 | @file{/mnt/src/lib/foo.c}. |
| 6687 | |
| 6688 | |
| 6689 | @item unset substitute-path [path] |
| 6690 | @kindex unset substitute-path |
| 6691 | If a path is specified, search the current list of substitution rules |
| 6692 | for a rule that would rewrite that path. Delete that rule if found. |
| 6693 | A warning is emitted by the debugger if no rule could be found. |
| 6694 | |
| 6695 | If no path is specified, then all substitution rules are deleted. |
| 6696 | |
| 6697 | @item show substitute-path [path] |
| 6698 | @kindex show substitute-path |
| 6699 | If a path is specified, then print the source path substitution rule |
| 6700 | which would rewrite that path, if any. |
| 6701 | |
| 6702 | If no path is specified, then print all existing source path substitution |
| 6703 | rules. |
| 6704 | |
| 6705 | @end table |
| 6706 | |
| 6707 | If your source path is cluttered with directories that are no longer of |
| 6708 | interest, @value{GDBN} may sometimes cause confusion by finding the wrong |
| 6709 | versions of source. You can correct the situation as follows: |
| 6710 | |
| 6711 | @enumerate |
| 6712 | @item |
| 6713 | Use @code{directory} with no argument to reset the source path to its default value. |
| 6714 | |
| 6715 | @item |
| 6716 | Use @code{directory} with suitable arguments to reinstall the |
| 6717 | directories you want in the source path. You can add all the |
| 6718 | directories in one command. |
| 6719 | @end enumerate |
| 6720 | |
| 6721 | @node Machine Code |
| 6722 | @section Source and Machine Code |
| 6723 | @cindex source line and its code address |
| 6724 | |
| 6725 | You can use the command @code{info line} to map source lines to program |
| 6726 | addresses (and vice versa), and the command @code{disassemble} to display |
| 6727 | a range of addresses as machine instructions. You can use the command |
| 6728 | @code{set disassemble-next-line} to set whether to disassemble next |
| 6729 | source line when execution stops. When run under @sc{gnu} Emacs |
| 6730 | mode, the @code{info line} command causes the arrow to point to the |
| 6731 | line specified. Also, @code{info line} prints addresses in symbolic form as |
| 6732 | well as hex. |
| 6733 | |
| 6734 | @table @code |
| 6735 | @kindex info line |
| 6736 | @item info line @var{linespec} |
| 6737 | Print the starting and ending addresses of the compiled code for |
| 6738 | source line @var{linespec}. You can specify source lines in any of |
| 6739 | the ways documented in @ref{Specify Location}. |
| 6740 | @end table |
| 6741 | |
| 6742 | For example, we can use @code{info line} to discover the location of |
| 6743 | the object code for the first line of function |
| 6744 | @code{m4_changequote}: |
| 6745 | |
| 6746 | @c FIXME: I think this example should also show the addresses in |
| 6747 | @c symbolic form, as they usually would be displayed. |
| 6748 | @smallexample |
| 6749 | (@value{GDBP}) info line m4_changequote |
| 6750 | Line 895 of "builtin.c" starts at pc 0x634c and ends at 0x6350. |
| 6751 | @end smallexample |
| 6752 | |
| 6753 | @noindent |
| 6754 | @cindex code address and its source line |
| 6755 | We can also inquire (using @code{*@var{addr}} as the form for |
| 6756 | @var{linespec}) what source line covers a particular address: |
| 6757 | @smallexample |
| 6758 | (@value{GDBP}) info line *0x63ff |
| 6759 | Line 926 of "builtin.c" starts at pc 0x63e4 and ends at 0x6404. |
| 6760 | @end smallexample |
| 6761 | |
| 6762 | @cindex @code{$_} and @code{info line} |
| 6763 | @cindex @code{x} command, default address |
| 6764 | @kindex x@r{(examine), and} info line |
| 6765 | After @code{info line}, the default address for the @code{x} command |
| 6766 | is changed to the starting address of the line, so that @samp{x/i} is |
| 6767 | sufficient to begin examining the machine code (@pxref{Memory, |
| 6768 | ,Examining Memory}). Also, this address is saved as the value of the |
| 6769 | convenience variable @code{$_} (@pxref{Convenience Vars, ,Convenience |
| 6770 | Variables}). |
| 6771 | |
| 6772 | @table @code |
| 6773 | @kindex disassemble |
| 6774 | @cindex assembly instructions |
| 6775 | @cindex instructions, assembly |
| 6776 | @cindex machine instructions |
| 6777 | @cindex listing machine instructions |
| 6778 | @item disassemble |
| 6779 | @itemx disassemble /m |
| 6780 | @itemx disassemble /r |
| 6781 | This specialized command dumps a range of memory as machine |
| 6782 | instructions. It can also print mixed source+disassembly by specifying |
| 6783 | the @code{/m} modifier and print the raw instructions in hex as well as |
| 6784 | in symbolic form by specifying the @code{/r}. |
| 6785 | The default memory range is the function surrounding the |
| 6786 | program counter of the selected frame. A single argument to this |
| 6787 | command is a program counter value; @value{GDBN} dumps the function |
| 6788 | surrounding this value. When two arguments are given, they should |
| 6789 | be separated by a comma, possibly surrounded by whitespace. The |
| 6790 | arguments specify a range of addresses to dump, in one of two forms: |
| 6791 | |
| 6792 | @table @code |
| 6793 | @item @var{start},@var{end} |
| 6794 | the addresses from @var{start} (inclusive) to @var{end} (exclusive) |
| 6795 | @item @var{start},+@var{length} |
| 6796 | the addresses from @var{start} (inclusive) to |
| 6797 | @code{@var{start}+@var{length}} (exclusive). |
| 6798 | @end table |
| 6799 | |
| 6800 | @noindent |
| 6801 | When 2 arguments are specified, the name of the function is also |
| 6802 | printed (since there could be several functions in the given range). |
| 6803 | |
| 6804 | The argument(s) can be any expression yielding a numeric value, such as |
| 6805 | @samp{0x32c4}, @samp{&main+10} or @samp{$pc - 8}. |
| 6806 | |
| 6807 | If the range of memory being disassembled contains current program counter, |
| 6808 | the instruction at that location is shown with a @code{=>} marker. |
| 6809 | @end table |
| 6810 | |
| 6811 | The following example shows the disassembly of a range of addresses of |
| 6812 | HP PA-RISC 2.0 code: |
| 6813 | |
| 6814 | @smallexample |
| 6815 | (@value{GDBP}) disas 0x32c4, 0x32e4 |
| 6816 | Dump of assembler code from 0x32c4 to 0x32e4: |
| 6817 | 0x32c4 <main+204>: addil 0,dp |
| 6818 | 0x32c8 <main+208>: ldw 0x22c(sr0,r1),r26 |
| 6819 | 0x32cc <main+212>: ldil 0x3000,r31 |
| 6820 | 0x32d0 <main+216>: ble 0x3f8(sr4,r31) |
| 6821 | 0x32d4 <main+220>: ldo 0(r31),rp |
| 6822 | 0x32d8 <main+224>: addil -0x800,dp |
| 6823 | 0x32dc <main+228>: ldo 0x588(r1),r26 |
| 6824 | 0x32e0 <main+232>: ldil 0x3000,r31 |
| 6825 | End of assembler dump. |
| 6826 | @end smallexample |
| 6827 | |
| 6828 | Here is an example showing mixed source+assembly for Intel x86, when the |
| 6829 | program is stopped just after function prologue: |
| 6830 | |
| 6831 | @smallexample |
| 6832 | (@value{GDBP}) disas /m main |
| 6833 | Dump of assembler code for function main: |
| 6834 | 5 @{ |
| 6835 | 0x08048330 <+0>: push %ebp |
| 6836 | 0x08048331 <+1>: mov %esp,%ebp |
| 6837 | 0x08048333 <+3>: sub $0x8,%esp |
| 6838 | 0x08048336 <+6>: and $0xfffffff0,%esp |
| 6839 | 0x08048339 <+9>: sub $0x10,%esp |
| 6840 | |
| 6841 | 6 printf ("Hello.\n"); |
| 6842 | => 0x0804833c <+12>: movl $0x8048440,(%esp) |
| 6843 | 0x08048343 <+19>: call 0x8048284 <puts@@plt> |
| 6844 | |
| 6845 | 7 return 0; |
| 6846 | 8 @} |
| 6847 | 0x08048348 <+24>: mov $0x0,%eax |
| 6848 | 0x0804834d <+29>: leave |
| 6849 | 0x0804834e <+30>: ret |
| 6850 | |
| 6851 | End of assembler dump. |
| 6852 | @end smallexample |
| 6853 | |
| 6854 | Here is another example showing raw instructions in hex for AMD x86-64, |
| 6855 | |
| 6856 | @smallexample |
| 6857 | (gdb) disas /r 0x400281,+10 |
| 6858 | Dump of assembler code from 0x400281 to 0x40028b: |
| 6859 | 0x0000000000400281: 38 36 cmp %dh,(%rsi) |
| 6860 | 0x0000000000400283: 2d 36 34 2e 73 sub $0x732e3436,%eax |
| 6861 | 0x0000000000400288: 6f outsl %ds:(%rsi),(%dx) |
| 6862 | 0x0000000000400289: 2e 32 00 xor %cs:(%rax),%al |
| 6863 | End of assembler dump. |
| 6864 | @end smallexample |
| 6865 | |
| 6866 | Some architectures have more than one commonly-used set of instruction |
| 6867 | mnemonics or other syntax. |
| 6868 | |
| 6869 | For programs that were dynamically linked and use shared libraries, |
| 6870 | instructions that call functions or branch to locations in the shared |
| 6871 | libraries might show a seemingly bogus location---it's actually a |
| 6872 | location of the relocation table. On some architectures, @value{GDBN} |
| 6873 | might be able to resolve these to actual function names. |
| 6874 | |
| 6875 | @table @code |
| 6876 | @kindex set disassembly-flavor |
| 6877 | @cindex Intel disassembly flavor |
| 6878 | @cindex AT&T disassembly flavor |
| 6879 | @item set disassembly-flavor @var{instruction-set} |
| 6880 | Select the instruction set to use when disassembling the |
| 6881 | program via the @code{disassemble} or @code{x/i} commands. |
| 6882 | |
| 6883 | Currently this command is only defined for the Intel x86 family. You |
| 6884 | can set @var{instruction-set} to either @code{intel} or @code{att}. |
| 6885 | The default is @code{att}, the AT&T flavor used by default by Unix |
| 6886 | assemblers for x86-based targets. |
| 6887 | |
| 6888 | @kindex show disassembly-flavor |
| 6889 | @item show disassembly-flavor |
| 6890 | Show the current setting of the disassembly flavor. |
| 6891 | @end table |
| 6892 | |
| 6893 | @table @code |
| 6894 | @kindex set disassemble-next-line |
| 6895 | @kindex show disassemble-next-line |
| 6896 | @item set disassemble-next-line |
| 6897 | @itemx show disassemble-next-line |
| 6898 | Control whether or not @value{GDBN} will disassemble the next source |
| 6899 | line or instruction when execution stops. If ON, @value{GDBN} will |
| 6900 | display disassembly of the next source line when execution of the |
| 6901 | program being debugged stops. This is @emph{in addition} to |
| 6902 | displaying the source line itself, which @value{GDBN} always does if |
| 6903 | possible. If the next source line cannot be displayed for some reason |
| 6904 | (e.g., if @value{GDBN} cannot find the source file, or there's no line |
| 6905 | info in the debug info), @value{GDBN} will display disassembly of the |
| 6906 | next @emph{instruction} instead of showing the next source line. If |
| 6907 | AUTO, @value{GDBN} will display disassembly of next instruction only |
| 6908 | if the source line cannot be displayed. This setting causes |
| 6909 | @value{GDBN} to display some feedback when you step through a function |
| 6910 | with no line info or whose source file is unavailable. The default is |
| 6911 | OFF, which means never display the disassembly of the next line or |
| 6912 | instruction. |
| 6913 | @end table |
| 6914 | |
| 6915 | |
| 6916 | @node Data |
| 6917 | @chapter Examining Data |
| 6918 | |
| 6919 | @cindex printing data |
| 6920 | @cindex examining data |
| 6921 | @kindex print |
| 6922 | @kindex inspect |
| 6923 | @c "inspect" is not quite a synonym if you are using Epoch, which we do not |
| 6924 | @c document because it is nonstandard... Under Epoch it displays in a |
| 6925 | @c different window or something like that. |
| 6926 | The usual way to examine data in your program is with the @code{print} |
| 6927 | command (abbreviated @code{p}), or its synonym @code{inspect}. It |
| 6928 | evaluates and prints the value of an expression of the language your |
| 6929 | program is written in (@pxref{Languages, ,Using @value{GDBN} with |
| 6930 | Different Languages}). It may also print the expression using a |
| 6931 | Python-based pretty-printer (@pxref{Pretty Printing}). |
| 6932 | |
| 6933 | @table @code |
| 6934 | @item print @var{expr} |
| 6935 | @itemx print /@var{f} @var{expr} |
| 6936 | @var{expr} is an expression (in the source language). By default the |
| 6937 | value of @var{expr} is printed in a format appropriate to its data type; |
| 6938 | you can choose a different format by specifying @samp{/@var{f}}, where |
| 6939 | @var{f} is a letter specifying the format; see @ref{Output Formats,,Output |
| 6940 | Formats}. |
| 6941 | |
| 6942 | @item print |
| 6943 | @itemx print /@var{f} |
| 6944 | @cindex reprint the last value |
| 6945 | If you omit @var{expr}, @value{GDBN} displays the last value again (from the |
| 6946 | @dfn{value history}; @pxref{Value History, ,Value History}). This allows you to |
| 6947 | conveniently inspect the same value in an alternative format. |
| 6948 | @end table |
| 6949 | |
| 6950 | A more low-level way of examining data is with the @code{x} command. |
| 6951 | It examines data in memory at a specified address and prints it in a |
| 6952 | specified format. @xref{Memory, ,Examining Memory}. |
| 6953 | |
| 6954 | If you are interested in information about types, or about how the |
| 6955 | fields of a struct or a class are declared, use the @code{ptype @var{exp}} |
| 6956 | command rather than @code{print}. @xref{Symbols, ,Examining the Symbol |
| 6957 | Table}. |
| 6958 | |
| 6959 | @menu |
| 6960 | * Expressions:: Expressions |
| 6961 | * Ambiguous Expressions:: Ambiguous Expressions |
| 6962 | * Variables:: Program variables |
| 6963 | * Arrays:: Artificial arrays |
| 6964 | * Output Formats:: Output formats |
| 6965 | * Memory:: Examining memory |
| 6966 | * Auto Display:: Automatic display |
| 6967 | * Print Settings:: Print settings |
| 6968 | * Pretty Printing:: Python pretty printing |
| 6969 | * Value History:: Value history |
| 6970 | * Convenience Vars:: Convenience variables |
| 6971 | * Registers:: Registers |
| 6972 | * Floating Point Hardware:: Floating point hardware |
| 6973 | * Vector Unit:: Vector Unit |
| 6974 | * OS Information:: Auxiliary data provided by operating system |
| 6975 | * Memory Region Attributes:: Memory region attributes |
| 6976 | * Dump/Restore Files:: Copy between memory and a file |
| 6977 | * Core File Generation:: Cause a program dump its core |
| 6978 | * Character Sets:: Debugging programs that use a different |
| 6979 | character set than GDB does |
| 6980 | * Caching Remote Data:: Data caching for remote targets |
| 6981 | * Searching Memory:: Searching memory for a sequence of bytes |
| 6982 | @end menu |
| 6983 | |
| 6984 | @node Expressions |
| 6985 | @section Expressions |
| 6986 | |
| 6987 | @cindex expressions |
| 6988 | @code{print} and many other @value{GDBN} commands accept an expression and |
| 6989 | compute its value. Any kind of constant, variable or operator defined |
| 6990 | by the programming language you are using is valid in an expression in |
| 6991 | @value{GDBN}. This includes conditional expressions, function calls, |
| 6992 | casts, and string constants. It also includes preprocessor macros, if |
| 6993 | you compiled your program to include this information; see |
| 6994 | @ref{Compilation}. |
| 6995 | |
| 6996 | @cindex arrays in expressions |
| 6997 | @value{GDBN} supports array constants in expressions input by |
| 6998 | the user. The syntax is @{@var{element}, @var{element}@dots{}@}. For example, |
| 6999 | you can use the command @code{print @{1, 2, 3@}} to create an array |
| 7000 | of three integers. If you pass an array to a function or assign it |
| 7001 | to a program variable, @value{GDBN} copies the array to memory that |
| 7002 | is @code{malloc}ed in the target program. |
| 7003 | |
| 7004 | Because C is so widespread, most of the expressions shown in examples in |
| 7005 | this manual are in C. @xref{Languages, , Using @value{GDBN} with Different |
| 7006 | Languages}, for information on how to use expressions in other |
| 7007 | languages. |
| 7008 | |
| 7009 | In this section, we discuss operators that you can use in @value{GDBN} |
| 7010 | expressions regardless of your programming language. |
| 7011 | |
| 7012 | @cindex casts, in expressions |
| 7013 | Casts are supported in all languages, not just in C, because it is so |
| 7014 | useful to cast a number into a pointer in order to examine a structure |
| 7015 | at that address in memory. |
| 7016 | @c FIXME: casts supported---Mod2 true? |
| 7017 | |
| 7018 | @value{GDBN} supports these operators, in addition to those common |
| 7019 | to programming languages: |
| 7020 | |
| 7021 | @table @code |
| 7022 | @item @@ |
| 7023 | @samp{@@} is a binary operator for treating parts of memory as arrays. |
| 7024 | @xref{Arrays, ,Artificial Arrays}, for more information. |
| 7025 | |
| 7026 | @item :: |
| 7027 | @samp{::} allows you to specify a variable in terms of the file or |
| 7028 | function where it is defined. @xref{Variables, ,Program Variables}. |
| 7029 | |
| 7030 | @cindex @{@var{type}@} |
| 7031 | @cindex type casting memory |
| 7032 | @cindex memory, viewing as typed object |
| 7033 | @cindex casts, to view memory |
| 7034 | @item @{@var{type}@} @var{addr} |
| 7035 | Refers to an object of type @var{type} stored at address @var{addr} in |
| 7036 | memory. @var{addr} may be any expression whose value is an integer or |
| 7037 | pointer (but parentheses are required around binary operators, just as in |
| 7038 | a cast). This construct is allowed regardless of what kind of data is |
| 7039 | normally supposed to reside at @var{addr}. |
| 7040 | @end table |
| 7041 | |
| 7042 | @node Ambiguous Expressions |
| 7043 | @section Ambiguous Expressions |
| 7044 | @cindex ambiguous expressions |
| 7045 | |
| 7046 | Expressions can sometimes contain some ambiguous elements. For instance, |
| 7047 | some programming languages (notably Ada, C@t{++} and Objective-C) permit |
| 7048 | a single function name to be defined several times, for application in |
| 7049 | different contexts. This is called @dfn{overloading}. Another example |
| 7050 | involving Ada is generics. A @dfn{generic package} is similar to C@t{++} |
| 7051 | templates and is typically instantiated several times, resulting in |
| 7052 | the same function name being defined in different contexts. |
| 7053 | |
| 7054 | In some cases and depending on the language, it is possible to adjust |
| 7055 | the expression to remove the ambiguity. For instance in C@t{++}, you |
| 7056 | can specify the signature of the function you want to break on, as in |
| 7057 | @kbd{break @var{function}(@var{types})}. In Ada, using the fully |
| 7058 | qualified name of your function often makes the expression unambiguous |
| 7059 | as well. |
| 7060 | |
| 7061 | When an ambiguity that needs to be resolved is detected, the debugger |
| 7062 | has the capability to display a menu of numbered choices for each |
| 7063 | possibility, and then waits for the selection with the prompt @samp{>}. |
| 7064 | The first option is always @samp{[0] cancel}, and typing @kbd{0 @key{RET}} |
| 7065 | aborts the current command. If the command in which the expression was |
| 7066 | used allows more than one choice to be selected, the next option in the |
| 7067 | menu is @samp{[1] all}, and typing @kbd{1 @key{RET}} selects all possible |
| 7068 | choices. |
| 7069 | |
| 7070 | For example, the following session excerpt shows an attempt to set a |
| 7071 | breakpoint at the overloaded symbol @code{String::after}. |
| 7072 | We choose three particular definitions of that function name: |
| 7073 | |
| 7074 | @c FIXME! This is likely to change to show arg type lists, at least |
| 7075 | @smallexample |
| 7076 | @group |
| 7077 | (@value{GDBP}) b String::after |
| 7078 | [0] cancel |
| 7079 | [1] all |
| 7080 | [2] file:String.cc; line number:867 |
| 7081 | [3] file:String.cc; line number:860 |
| 7082 | [4] file:String.cc; line number:875 |
| 7083 | [5] file:String.cc; line number:853 |
| 7084 | [6] file:String.cc; line number:846 |
| 7085 | [7] file:String.cc; line number:735 |
| 7086 | > 2 4 6 |
| 7087 | Breakpoint 1 at 0xb26c: file String.cc, line 867. |
| 7088 | Breakpoint 2 at 0xb344: file String.cc, line 875. |
| 7089 | Breakpoint 3 at 0xafcc: file String.cc, line 846. |
| 7090 | Multiple breakpoints were set. |
| 7091 | Use the "delete" command to delete unwanted |
| 7092 | breakpoints. |
| 7093 | (@value{GDBP}) |
| 7094 | @end group |
| 7095 | @end smallexample |
| 7096 | |
| 7097 | @table @code |
| 7098 | @kindex set multiple-symbols |
| 7099 | @item set multiple-symbols @var{mode} |
| 7100 | @cindex multiple-symbols menu |
| 7101 | |
| 7102 | This option allows you to adjust the debugger behavior when an expression |
| 7103 | is ambiguous. |
| 7104 | |
| 7105 | By default, @var{mode} is set to @code{all}. If the command with which |
| 7106 | the expression is used allows more than one choice, then @value{GDBN} |
| 7107 | automatically selects all possible choices. For instance, inserting |
| 7108 | a breakpoint on a function using an ambiguous name results in a breakpoint |
| 7109 | inserted on each possible match. However, if a unique choice must be made, |
| 7110 | then @value{GDBN} uses the menu to help you disambiguate the expression. |
| 7111 | For instance, printing the address of an overloaded function will result |
| 7112 | in the use of the menu. |
| 7113 | |
| 7114 | When @var{mode} is set to @code{ask}, the debugger always uses the menu |
| 7115 | when an ambiguity is detected. |
| 7116 | |
| 7117 | Finally, when @var{mode} is set to @code{cancel}, the debugger reports |
| 7118 | an error due to the ambiguity and the command is aborted. |
| 7119 | |
| 7120 | @kindex show multiple-symbols |
| 7121 | @item show multiple-symbols |
| 7122 | Show the current value of the @code{multiple-symbols} setting. |
| 7123 | @end table |
| 7124 | |
| 7125 | @node Variables |
| 7126 | @section Program Variables |
| 7127 | |
| 7128 | The most common kind of expression to use is the name of a variable |
| 7129 | in your program. |
| 7130 | |
| 7131 | Variables in expressions are understood in the selected stack frame |
| 7132 | (@pxref{Selection, ,Selecting a Frame}); they must be either: |
| 7133 | |
| 7134 | @itemize @bullet |
| 7135 | @item |
| 7136 | global (or file-static) |
| 7137 | @end itemize |
| 7138 | |
| 7139 | @noindent or |
| 7140 | |
| 7141 | @itemize @bullet |
| 7142 | @item |
| 7143 | visible according to the scope rules of the |
| 7144 | programming language from the point of execution in that frame |
| 7145 | @end itemize |
| 7146 | |
| 7147 | @noindent This means that in the function |
| 7148 | |
| 7149 | @smallexample |
| 7150 | foo (a) |
| 7151 | int a; |
| 7152 | @{ |
| 7153 | bar (a); |
| 7154 | @{ |
| 7155 | int b = test (); |
| 7156 | bar (b); |
| 7157 | @} |
| 7158 | @} |
| 7159 | @end smallexample |
| 7160 | |
| 7161 | @noindent |
| 7162 | you can examine and use the variable @code{a} whenever your program is |
| 7163 | executing within the function @code{foo}, but you can only use or |
| 7164 | examine the variable @code{b} while your program is executing inside |
| 7165 | the block where @code{b} is declared. |
| 7166 | |
| 7167 | @cindex variable name conflict |
| 7168 | There is an exception: you can refer to a variable or function whose |
| 7169 | scope is a single source file even if the current execution point is not |
| 7170 | in this file. But it is possible to have more than one such variable or |
| 7171 | function with the same name (in different source files). If that |
| 7172 | happens, referring to that name has unpredictable effects. If you wish, |
| 7173 | you can specify a static variable in a particular function or file, |
| 7174 | using the colon-colon (@code{::}) notation: |
| 7175 | |
| 7176 | @cindex colon-colon, context for variables/functions |
| 7177 | @ifnotinfo |
| 7178 | @c info cannot cope with a :: index entry, but why deprive hard copy readers? |
| 7179 | @cindex @code{::}, context for variables/functions |
| 7180 | @end ifnotinfo |
| 7181 | @smallexample |
| 7182 | @var{file}::@var{variable} |
| 7183 | @var{function}::@var{variable} |
| 7184 | @end smallexample |
| 7185 | |
| 7186 | @noindent |
| 7187 | Here @var{file} or @var{function} is the name of the context for the |
| 7188 | static @var{variable}. In the case of file names, you can use quotes to |
| 7189 | make sure @value{GDBN} parses the file name as a single word---for example, |
| 7190 | to print a global value of @code{x} defined in @file{f2.c}: |
| 7191 | |
| 7192 | @smallexample |
| 7193 | (@value{GDBP}) p 'f2.c'::x |
| 7194 | @end smallexample |
| 7195 | |
| 7196 | @cindex C@t{++} scope resolution |
| 7197 | This use of @samp{::} is very rarely in conflict with the very similar |
| 7198 | use of the same notation in C@t{++}. @value{GDBN} also supports use of the C@t{++} |
| 7199 | scope resolution operator in @value{GDBN} expressions. |
| 7200 | @c FIXME: Um, so what happens in one of those rare cases where it's in |
| 7201 | @c conflict?? --mew |
| 7202 | |
| 7203 | @cindex wrong values |
| 7204 | @cindex variable values, wrong |
| 7205 | @cindex function entry/exit, wrong values of variables |
| 7206 | @cindex optimized code, wrong values of variables |
| 7207 | @quotation |
| 7208 | @emph{Warning:} Occasionally, a local variable may appear to have the |
| 7209 | wrong value at certain points in a function---just after entry to a new |
| 7210 | scope, and just before exit. |
| 7211 | @end quotation |
| 7212 | You may see this problem when you are stepping by machine instructions. |
| 7213 | This is because, on most machines, it takes more than one instruction to |
| 7214 | set up a stack frame (including local variable definitions); if you are |
| 7215 | stepping by machine instructions, variables may appear to have the wrong |
| 7216 | values until the stack frame is completely built. On exit, it usually |
| 7217 | also takes more than one machine instruction to destroy a stack frame; |
| 7218 | after you begin stepping through that group of instructions, local |
| 7219 | variable definitions may be gone. |
| 7220 | |
| 7221 | This may also happen when the compiler does significant optimizations. |
| 7222 | To be sure of always seeing accurate values, turn off all optimization |
| 7223 | when compiling. |
| 7224 | |
| 7225 | @cindex ``No symbol "foo" in current context'' |
| 7226 | Another possible effect of compiler optimizations is to optimize |
| 7227 | unused variables out of existence, or assign variables to registers (as |
| 7228 | opposed to memory addresses). Depending on the support for such cases |
| 7229 | offered by the debug info format used by the compiler, @value{GDBN} |
| 7230 | might not be able to display values for such local variables. If that |
| 7231 | happens, @value{GDBN} will print a message like this: |
| 7232 | |
| 7233 | @smallexample |
| 7234 | No symbol "foo" in current context. |
| 7235 | @end smallexample |
| 7236 | |
| 7237 | To solve such problems, either recompile without optimizations, or use a |
| 7238 | different debug info format, if the compiler supports several such |
| 7239 | formats. For example, @value{NGCC}, the @sc{gnu} C/C@t{++} compiler, |
| 7240 | usually supports the @option{-gstabs+} option. @option{-gstabs+} |
| 7241 | produces debug info in a format that is superior to formats such as |
| 7242 | COFF. You may be able to use DWARF 2 (@option{-gdwarf-2}), which is also |
| 7243 | an effective form for debug info. @xref{Debugging Options,,Options |
| 7244 | for Debugging Your Program or GCC, gcc.info, Using the @sc{gnu} |
| 7245 | Compiler Collection (GCC)}. |
| 7246 | @xref{C, ,C and C@t{++}}, for more information about debug info formats |
| 7247 | that are best suited to C@t{++} programs. |
| 7248 | |
| 7249 | If you ask to print an object whose contents are unknown to |
| 7250 | @value{GDBN}, e.g., because its data type is not completely specified |
| 7251 | by the debug information, @value{GDBN} will say @samp{<incomplete |
| 7252 | type>}. @xref{Symbols, incomplete type}, for more about this. |
| 7253 | |
| 7254 | Strings are identified as arrays of @code{char} values without specified |
| 7255 | signedness. Arrays of either @code{signed char} or @code{unsigned char} get |
| 7256 | printed as arrays of 1 byte sized integers. @code{-fsigned-char} or |
| 7257 | @code{-funsigned-char} @value{NGCC} options have no effect as @value{GDBN} |
| 7258 | defines literal string type @code{"char"} as @code{char} without a sign. |
| 7259 | For program code |
| 7260 | |
| 7261 | @smallexample |
| 7262 | char var0[] = "A"; |
| 7263 | signed char var1[] = "A"; |
| 7264 | @end smallexample |
| 7265 | |
| 7266 | You get during debugging |
| 7267 | @smallexample |
| 7268 | (gdb) print var0 |
| 7269 | $1 = "A" |
| 7270 | (gdb) print var1 |
| 7271 | $2 = @{65 'A', 0 '\0'@} |
| 7272 | @end smallexample |
| 7273 | |
| 7274 | @node Arrays |
| 7275 | @section Artificial Arrays |
| 7276 | |
| 7277 | @cindex artificial array |
| 7278 | @cindex arrays |
| 7279 | @kindex @@@r{, referencing memory as an array} |
| 7280 | It is often useful to print out several successive objects of the |
| 7281 | same type in memory; a section of an array, or an array of |
| 7282 | dynamically determined size for which only a pointer exists in the |
| 7283 | program. |
| 7284 | |
| 7285 | You can do this by referring to a contiguous span of memory as an |
| 7286 | @dfn{artificial array}, using the binary operator @samp{@@}. The left |
| 7287 | operand of @samp{@@} should be the first element of the desired array |
| 7288 | and be an individual object. The right operand should be the desired length |
| 7289 | of the array. The result is an array value whose elements are all of |
| 7290 | the type of the left argument. The first element is actually the left |
| 7291 | argument; the second element comes from bytes of memory immediately |
| 7292 | following those that hold the first element, and so on. Here is an |
| 7293 | example. If a program says |
| 7294 | |
| 7295 | @smallexample |
| 7296 | int *array = (int *) malloc (len * sizeof (int)); |
| 7297 | @end smallexample |
| 7298 | |
| 7299 | @noindent |
| 7300 | you can print the contents of @code{array} with |
| 7301 | |
| 7302 | @smallexample |
| 7303 | p *array@@len |
| 7304 | @end smallexample |
| 7305 | |
| 7306 | The left operand of @samp{@@} must reside in memory. Array values made |
| 7307 | with @samp{@@} in this way behave just like other arrays in terms of |
| 7308 | subscripting, and are coerced to pointers when used in expressions. |
| 7309 | Artificial arrays most often appear in expressions via the value history |
| 7310 | (@pxref{Value History, ,Value History}), after printing one out. |
| 7311 | |
| 7312 | Another way to create an artificial array is to use a cast. |
| 7313 | This re-interprets a value as if it were an array. |
| 7314 | The value need not be in memory: |
| 7315 | @smallexample |
| 7316 | (@value{GDBP}) p/x (short[2])0x12345678 |
| 7317 | $1 = @{0x1234, 0x5678@} |
| 7318 | @end smallexample |
| 7319 | |
| 7320 | As a convenience, if you leave the array length out (as in |
| 7321 | @samp{(@var{type}[])@var{value}}) @value{GDBN} calculates the size to fill |
| 7322 | the value (as @samp{sizeof(@var{value})/sizeof(@var{type})}: |
| 7323 | @smallexample |
| 7324 | (@value{GDBP}) p/x (short[])0x12345678 |
| 7325 | $2 = @{0x1234, 0x5678@} |
| 7326 | @end smallexample |
| 7327 | |
| 7328 | Sometimes the artificial array mechanism is not quite enough; in |
| 7329 | moderately complex data structures, the elements of interest may not |
| 7330 | actually be adjacent---for example, if you are interested in the values |
| 7331 | of pointers in an array. One useful work-around in this situation is |
| 7332 | to use a convenience variable (@pxref{Convenience Vars, ,Convenience |
| 7333 | Variables}) as a counter in an expression that prints the first |
| 7334 | interesting value, and then repeat that expression via @key{RET}. For |
| 7335 | instance, suppose you have an array @code{dtab} of pointers to |
| 7336 | structures, and you are interested in the values of a field @code{fv} |
| 7337 | in each structure. Here is an example of what you might type: |
| 7338 | |
| 7339 | @smallexample |
| 7340 | set $i = 0 |
| 7341 | p dtab[$i++]->fv |
| 7342 | @key{RET} |
| 7343 | @key{RET} |
| 7344 | @dots{} |
| 7345 | @end smallexample |
| 7346 | |
| 7347 | @node Output Formats |
| 7348 | @section Output Formats |
| 7349 | |
| 7350 | @cindex formatted output |
| 7351 | @cindex output formats |
| 7352 | By default, @value{GDBN} prints a value according to its data type. Sometimes |
| 7353 | this is not what you want. For example, you might want to print a number |
| 7354 | in hex, or a pointer in decimal. Or you might want to view data in memory |
| 7355 | at a certain address as a character string or as an instruction. To do |
| 7356 | these things, specify an @dfn{output format} when you print a value. |
| 7357 | |
| 7358 | The simplest use of output formats is to say how to print a value |
| 7359 | already computed. This is done by starting the arguments of the |
| 7360 | @code{print} command with a slash and a format letter. The format |
| 7361 | letters supported are: |
| 7362 | |
| 7363 | @table @code |
| 7364 | @item x |
| 7365 | Regard the bits of the value as an integer, and print the integer in |
| 7366 | hexadecimal. |
| 7367 | |
| 7368 | @item d |
| 7369 | Print as integer in signed decimal. |
| 7370 | |
| 7371 | @item u |
| 7372 | Print as integer in unsigned decimal. |
| 7373 | |
| 7374 | @item o |
| 7375 | Print as integer in octal. |
| 7376 | |
| 7377 | @item t |
| 7378 | Print as integer in binary. The letter @samp{t} stands for ``two''. |
| 7379 | @footnote{@samp{b} cannot be used because these format letters are also |
| 7380 | used with the @code{x} command, where @samp{b} stands for ``byte''; |
| 7381 | see @ref{Memory,,Examining Memory}.} |
| 7382 | |
| 7383 | @item a |
| 7384 | @cindex unknown address, locating |
| 7385 | @cindex locate address |
| 7386 | Print as an address, both absolute in hexadecimal and as an offset from |
| 7387 | the nearest preceding symbol. You can use this format used to discover |
| 7388 | where (in what function) an unknown address is located: |
| 7389 | |
| 7390 | @smallexample |
| 7391 | (@value{GDBP}) p/a 0x54320 |
| 7392 | $3 = 0x54320 <_initialize_vx+396> |
| 7393 | @end smallexample |
| 7394 | |
| 7395 | @noindent |
| 7396 | The command @code{info symbol 0x54320} yields similar results. |
| 7397 | @xref{Symbols, info symbol}. |
| 7398 | |
| 7399 | @item c |
| 7400 | Regard as an integer and print it as a character constant. This |
| 7401 | prints both the numerical value and its character representation. The |
| 7402 | character representation is replaced with the octal escape @samp{\nnn} |
| 7403 | for characters outside the 7-bit @sc{ascii} range. |
| 7404 | |
| 7405 | Without this format, @value{GDBN} displays @code{char}, |
| 7406 | @w{@code{unsigned char}}, and @w{@code{signed char}} data as character |
| 7407 | constants. Single-byte members of vectors are displayed as integer |
| 7408 | data. |
| 7409 | |
| 7410 | @item f |
| 7411 | Regard the bits of the value as a floating point number and print |
| 7412 | using typical floating point syntax. |
| 7413 | |
| 7414 | @item s |
| 7415 | @cindex printing strings |
| 7416 | @cindex printing byte arrays |
| 7417 | Regard as a string, if possible. With this format, pointers to single-byte |
| 7418 | data are displayed as null-terminated strings and arrays of single-byte data |
| 7419 | are displayed as fixed-length strings. Other values are displayed in their |
| 7420 | natural types. |
| 7421 | |
| 7422 | Without this format, @value{GDBN} displays pointers to and arrays of |
| 7423 | @code{char}, @w{@code{unsigned char}}, and @w{@code{signed char}} as |
| 7424 | strings. Single-byte members of a vector are displayed as an integer |
| 7425 | array. |
| 7426 | |
| 7427 | @item r |
| 7428 | @cindex raw printing |
| 7429 | Print using the @samp{raw} formatting. By default, @value{GDBN} will |
| 7430 | use a Python-based pretty-printer, if one is available (@pxref{Pretty |
| 7431 | Printing}). This typically results in a higher-level display of the |
| 7432 | value's contents. The @samp{r} format bypasses any Python |
| 7433 | pretty-printer which might exist. |
| 7434 | @end table |
| 7435 | |
| 7436 | For example, to print the program counter in hex (@pxref{Registers}), type |
| 7437 | |
| 7438 | @smallexample |
| 7439 | p/x $pc |
| 7440 | @end smallexample |
| 7441 | |
| 7442 | @noindent |
| 7443 | Note that no space is required before the slash; this is because command |
| 7444 | names in @value{GDBN} cannot contain a slash. |
| 7445 | |
| 7446 | To reprint the last value in the value history with a different format, |
| 7447 | you can use the @code{print} command with just a format and no |
| 7448 | expression. For example, @samp{p/x} reprints the last value in hex. |
| 7449 | |
| 7450 | @node Memory |
| 7451 | @section Examining Memory |
| 7452 | |
| 7453 | You can use the command @code{x} (for ``examine'') to examine memory in |
| 7454 | any of several formats, independently of your program's data types. |
| 7455 | |
| 7456 | @cindex examining memory |
| 7457 | @table @code |
| 7458 | @kindex x @r{(examine memory)} |
| 7459 | @item x/@var{nfu} @var{addr} |
| 7460 | @itemx x @var{addr} |
| 7461 | @itemx x |
| 7462 | Use the @code{x} command to examine memory. |
| 7463 | @end table |
| 7464 | |
| 7465 | @var{n}, @var{f}, and @var{u} are all optional parameters that specify how |
| 7466 | much memory to display and how to format it; @var{addr} is an |
| 7467 | expression giving the address where you want to start displaying memory. |
| 7468 | If you use defaults for @var{nfu}, you need not type the slash @samp{/}. |
| 7469 | Several commands set convenient defaults for @var{addr}. |
| 7470 | |
| 7471 | @table @r |
| 7472 | @item @var{n}, the repeat count |
| 7473 | The repeat count is a decimal integer; the default is 1. It specifies |
| 7474 | how much memory (counting by units @var{u}) to display. |
| 7475 | @c This really is **decimal**; unaffected by 'set radix' as of GDB |
| 7476 | @c 4.1.2. |
| 7477 | |
| 7478 | @item @var{f}, the display format |
| 7479 | The display format is one of the formats used by @code{print} |
| 7480 | (@samp{x}, @samp{d}, @samp{u}, @samp{o}, @samp{t}, @samp{a}, @samp{c}, |
| 7481 | @samp{f}, @samp{s}), and in addition @samp{i} (for machine instructions). |
| 7482 | The default is @samp{x} (hexadecimal) initially. The default changes |
| 7483 | each time you use either @code{x} or @code{print}. |
| 7484 | |
| 7485 | @item @var{u}, the unit size |
| 7486 | The unit size is any of |
| 7487 | |
| 7488 | @table @code |
| 7489 | @item b |
| 7490 | Bytes. |
| 7491 | @item h |
| 7492 | Halfwords (two bytes). |
| 7493 | @item w |
| 7494 | Words (four bytes). This is the initial default. |
| 7495 | @item g |
| 7496 | Giant words (eight bytes). |
| 7497 | @end table |
| 7498 | |
| 7499 | Each time you specify a unit size with @code{x}, that size becomes the |
| 7500 | default unit the next time you use @code{x}. For the @samp{i} format, |
| 7501 | the unit size is ignored and is normally not written. For the @samp{s} format, |
| 7502 | the unit size defaults to @samp{b}, unless it is explicitly given. |
| 7503 | Use @kbd{x /hs} to display 16-bit char strings and @kbd{x /ws} to display |
| 7504 | 32-bit strings. The next use of @kbd{x /s} will again display 8-bit strings. |
| 7505 | Note that the results depend on the programming language of the |
| 7506 | current compilation unit. If the language is C, the @samp{s} |
| 7507 | modifier will use the UTF-16 encoding while @samp{w} will use |
| 7508 | UTF-32. The encoding is set by the programming language and cannot |
| 7509 | be altered. |
| 7510 | |
| 7511 | @item @var{addr}, starting display address |
| 7512 | @var{addr} is the address where you want @value{GDBN} to begin displaying |
| 7513 | memory. The expression need not have a pointer value (though it may); |
| 7514 | it is always interpreted as an integer address of a byte of memory. |
| 7515 | @xref{Expressions, ,Expressions}, for more information on expressions. The default for |
| 7516 | @var{addr} is usually just after the last address examined---but several |
| 7517 | other commands also set the default address: @code{info breakpoints} (to |
| 7518 | the address of the last breakpoint listed), @code{info line} (to the |
| 7519 | starting address of a line), and @code{print} (if you use it to display |
| 7520 | a value from memory). |
| 7521 | @end table |
| 7522 | |
| 7523 | For example, @samp{x/3uh 0x54320} is a request to display three halfwords |
| 7524 | (@code{h}) of memory, formatted as unsigned decimal integers (@samp{u}), |
| 7525 | starting at address @code{0x54320}. @samp{x/4xw $sp} prints the four |
| 7526 | words (@samp{w}) of memory above the stack pointer (here, @samp{$sp}; |
| 7527 | @pxref{Registers, ,Registers}) in hexadecimal (@samp{x}). |
| 7528 | |
| 7529 | Since the letters indicating unit sizes are all distinct from the |
| 7530 | letters specifying output formats, you do not have to remember whether |
| 7531 | unit size or format comes first; either order works. The output |
| 7532 | specifications @samp{4xw} and @samp{4wx} mean exactly the same thing. |
| 7533 | (However, the count @var{n} must come first; @samp{wx4} does not work.) |
| 7534 | |
| 7535 | Even though the unit size @var{u} is ignored for the formats @samp{s} |
| 7536 | and @samp{i}, you might still want to use a count @var{n}; for example, |
| 7537 | @samp{3i} specifies that you want to see three machine instructions, |
| 7538 | including any operands. For convenience, especially when used with |
| 7539 | the @code{display} command, the @samp{i} format also prints branch delay |
| 7540 | slot instructions, if any, beyond the count specified, which immediately |
| 7541 | follow the last instruction that is within the count. The command |
| 7542 | @code{disassemble} gives an alternative way of inspecting machine |
| 7543 | instructions; see @ref{Machine Code,,Source and Machine Code}. |
| 7544 | |
| 7545 | All the defaults for the arguments to @code{x} are designed to make it |
| 7546 | easy to continue scanning memory with minimal specifications each time |
| 7547 | you use @code{x}. For example, after you have inspected three machine |
| 7548 | instructions with @samp{x/3i @var{addr}}, you can inspect the next seven |
| 7549 | with just @samp{x/7}. If you use @key{RET} to repeat the @code{x} command, |
| 7550 | the repeat count @var{n} is used again; the other arguments default as |
| 7551 | for successive uses of @code{x}. |
| 7552 | |
| 7553 | When examining machine instructions, the instruction at current program |
| 7554 | counter is shown with a @code{=>} marker. For example: |
| 7555 | |
| 7556 | @smallexample |
| 7557 | (@value{GDBP}) x/5i $pc-6 |
| 7558 | 0x804837f <main+11>: mov %esp,%ebp |
| 7559 | 0x8048381 <main+13>: push %ecx |
| 7560 | 0x8048382 <main+14>: sub $0x4,%esp |
| 7561 | => 0x8048385 <main+17>: movl $0x8048460,(%esp) |
| 7562 | 0x804838c <main+24>: call 0x80482d4 <puts@@plt> |
| 7563 | @end smallexample |
| 7564 | |
| 7565 | @cindex @code{$_}, @code{$__}, and value history |
| 7566 | The addresses and contents printed by the @code{x} command are not saved |
| 7567 | in the value history because there is often too much of them and they |
| 7568 | would get in the way. Instead, @value{GDBN} makes these values available for |
| 7569 | subsequent use in expressions as values of the convenience variables |
| 7570 | @code{$_} and @code{$__}. After an @code{x} command, the last address |
| 7571 | examined is available for use in expressions in the convenience variable |
| 7572 | @code{$_}. The contents of that address, as examined, are available in |
| 7573 | the convenience variable @code{$__}. |
| 7574 | |
| 7575 | If the @code{x} command has a repeat count, the address and contents saved |
| 7576 | are from the last memory unit printed; this is not the same as the last |
| 7577 | address printed if several units were printed on the last line of output. |
| 7578 | |
| 7579 | @cindex remote memory comparison |
| 7580 | @cindex verify remote memory image |
| 7581 | When you are debugging a program running on a remote target machine |
| 7582 | (@pxref{Remote Debugging}), you may wish to verify the program's image in the |
| 7583 | remote machine's memory against the executable file you downloaded to |
| 7584 | the target. The @code{compare-sections} command is provided for such |
| 7585 | situations. |
| 7586 | |
| 7587 | @table @code |
| 7588 | @kindex compare-sections |
| 7589 | @item compare-sections @r{[}@var{section-name}@r{]} |
| 7590 | Compare the data of a loadable section @var{section-name} in the |
| 7591 | executable file of the program being debugged with the same section in |
| 7592 | the remote machine's memory, and report any mismatches. With no |
| 7593 | arguments, compares all loadable sections. This command's |
| 7594 | availability depends on the target's support for the @code{"qCRC"} |
| 7595 | remote request. |
| 7596 | @end table |
| 7597 | |
| 7598 | @node Auto Display |
| 7599 | @section Automatic Display |
| 7600 | @cindex automatic display |
| 7601 | @cindex display of expressions |
| 7602 | |
| 7603 | If you find that you want to print the value of an expression frequently |
| 7604 | (to see how it changes), you might want to add it to the @dfn{automatic |
| 7605 | display list} so that @value{GDBN} prints its value each time your program stops. |
| 7606 | Each expression added to the list is given a number to identify it; |
| 7607 | to remove an expression from the list, you specify that number. |
| 7608 | The automatic display looks like this: |
| 7609 | |
| 7610 | @smallexample |
| 7611 | 2: foo = 38 |
| 7612 | 3: bar[5] = (struct hack *) 0x3804 |
| 7613 | @end smallexample |
| 7614 | |
| 7615 | @noindent |
| 7616 | This display shows item numbers, expressions and their current values. As with |
| 7617 | displays you request manually using @code{x} or @code{print}, you can |
| 7618 | specify the output format you prefer; in fact, @code{display} decides |
| 7619 | whether to use @code{print} or @code{x} depending your format |
| 7620 | specification---it uses @code{x} if you specify either the @samp{i} |
| 7621 | or @samp{s} format, or a unit size; otherwise it uses @code{print}. |
| 7622 | |
| 7623 | @table @code |
| 7624 | @kindex display |
| 7625 | @item display @var{expr} |
| 7626 | Add the expression @var{expr} to the list of expressions to display |
| 7627 | each time your program stops. @xref{Expressions, ,Expressions}. |
| 7628 | |
| 7629 | @code{display} does not repeat if you press @key{RET} again after using it. |
| 7630 | |
| 7631 | @item display/@var{fmt} @var{expr} |
| 7632 | For @var{fmt} specifying only a display format and not a size or |
| 7633 | count, add the expression @var{expr} to the auto-display list but |
| 7634 | arrange to display it each time in the specified format @var{fmt}. |
| 7635 | @xref{Output Formats,,Output Formats}. |
| 7636 | |
| 7637 | @item display/@var{fmt} @var{addr} |
| 7638 | For @var{fmt} @samp{i} or @samp{s}, or including a unit-size or a |
| 7639 | number of units, add the expression @var{addr} as a memory address to |
| 7640 | be examined each time your program stops. Examining means in effect |
| 7641 | doing @samp{x/@var{fmt} @var{addr}}. @xref{Memory, ,Examining Memory}. |
| 7642 | @end table |
| 7643 | |
| 7644 | For example, @samp{display/i $pc} can be helpful, to see the machine |
| 7645 | instruction about to be executed each time execution stops (@samp{$pc} |
| 7646 | is a common name for the program counter; @pxref{Registers, ,Registers}). |
| 7647 | |
| 7648 | @table @code |
| 7649 | @kindex delete display |
| 7650 | @kindex undisplay |
| 7651 | @item undisplay @var{dnums}@dots{} |
| 7652 | @itemx delete display @var{dnums}@dots{} |
| 7653 | Remove items from the list of expressions to display. Specify the |
| 7654 | numbers of the displays that you want affected with the command |
| 7655 | argument @var{dnums}. It can be a single display number, one of the |
| 7656 | numbers shown in the first field of the @samp{info display} display; |
| 7657 | or it could be a range of display numbers, as in @code{2-4}. |
| 7658 | |
| 7659 | @code{undisplay} does not repeat if you press @key{RET} after using it. |
| 7660 | (Otherwise you would just get the error @samp{No display number @dots{}}.) |
| 7661 | |
| 7662 | @kindex disable display |
| 7663 | @item disable display @var{dnums}@dots{} |
| 7664 | Disable the display of item numbers @var{dnums}. A disabled display |
| 7665 | item is not printed automatically, but is not forgotten. It may be |
| 7666 | enabled again later. Specify the numbers of the displays that you |
| 7667 | want affected with the command argument @var{dnums}. It can be a |
| 7668 | single display number, one of the numbers shown in the first field of |
| 7669 | the @samp{info display} display; or it could be a range of display |
| 7670 | numbers, as in @code{2-4}. |
| 7671 | |
| 7672 | @kindex enable display |
| 7673 | @item enable display @var{dnums}@dots{} |
| 7674 | Enable display of item numbers @var{dnums}. It becomes effective once |
| 7675 | again in auto display of its expression, until you specify otherwise. |
| 7676 | Specify the numbers of the displays that you want affected with the |
| 7677 | command argument @var{dnums}. It can be a single display number, one |
| 7678 | of the numbers shown in the first field of the @samp{info display} |
| 7679 | display; or it could be a range of display numbers, as in @code{2-4}. |
| 7680 | |
| 7681 | @item display |
| 7682 | Display the current values of the expressions on the list, just as is |
| 7683 | done when your program stops. |
| 7684 | |
| 7685 | @kindex info display |
| 7686 | @item info display |
| 7687 | Print the list of expressions previously set up to display |
| 7688 | automatically, each one with its item number, but without showing the |
| 7689 | values. This includes disabled expressions, which are marked as such. |
| 7690 | It also includes expressions which would not be displayed right now |
| 7691 | because they refer to automatic variables not currently available. |
| 7692 | @end table |
| 7693 | |
| 7694 | @cindex display disabled out of scope |
| 7695 | If a display expression refers to local variables, then it does not make |
| 7696 | sense outside the lexical context for which it was set up. Such an |
| 7697 | expression is disabled when execution enters a context where one of its |
| 7698 | variables is not defined. For example, if you give the command |
| 7699 | @code{display last_char} while inside a function with an argument |
| 7700 | @code{last_char}, @value{GDBN} displays this argument while your program |
| 7701 | continues to stop inside that function. When it stops elsewhere---where |
| 7702 | there is no variable @code{last_char}---the display is disabled |
| 7703 | automatically. The next time your program stops where @code{last_char} |
| 7704 | is meaningful, you can enable the display expression once again. |
| 7705 | |
| 7706 | @node Print Settings |
| 7707 | @section Print Settings |
| 7708 | |
| 7709 | @cindex format options |
| 7710 | @cindex print settings |
| 7711 | @value{GDBN} provides the following ways to control how arrays, structures, |
| 7712 | and symbols are printed. |
| 7713 | |
| 7714 | @noindent |
| 7715 | These settings are useful for debugging programs in any language: |
| 7716 | |
| 7717 | @table @code |
| 7718 | @kindex set print |
| 7719 | @item set print address |
| 7720 | @itemx set print address on |
| 7721 | @cindex print/don't print memory addresses |
| 7722 | @value{GDBN} prints memory addresses showing the location of stack |
| 7723 | traces, structure values, pointer values, breakpoints, and so forth, |
| 7724 | even when it also displays the contents of those addresses. The default |
| 7725 | is @code{on}. For example, this is what a stack frame display looks like with |
| 7726 | @code{set print address on}: |
| 7727 | |
| 7728 | @smallexample |
| 7729 | @group |
| 7730 | (@value{GDBP}) f |
| 7731 | #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>") |
| 7732 | at input.c:530 |
| 7733 | 530 if (lquote != def_lquote) |
| 7734 | @end group |
| 7735 | @end smallexample |
| 7736 | |
| 7737 | @item set print address off |
| 7738 | Do not print addresses when displaying their contents. For example, |
| 7739 | this is the same stack frame displayed with @code{set print address off}: |
| 7740 | |
| 7741 | @smallexample |
| 7742 | @group |
| 7743 | (@value{GDBP}) set print addr off |
| 7744 | (@value{GDBP}) f |
| 7745 | #0 set_quotes (lq="<<", rq=">>") at input.c:530 |
| 7746 | 530 if (lquote != def_lquote) |
| 7747 | @end group |
| 7748 | @end smallexample |
| 7749 | |
| 7750 | You can use @samp{set print address off} to eliminate all machine |
| 7751 | dependent displays from the @value{GDBN} interface. For example, with |
| 7752 | @code{print address off}, you should get the same text for backtraces on |
| 7753 | all machines---whether or not they involve pointer arguments. |
| 7754 | |
| 7755 | @kindex show print |
| 7756 | @item show print address |
| 7757 | Show whether or not addresses are to be printed. |
| 7758 | @end table |
| 7759 | |
| 7760 | When @value{GDBN} prints a symbolic address, it normally prints the |
| 7761 | closest earlier symbol plus an offset. If that symbol does not uniquely |
| 7762 | identify the address (for example, it is a name whose scope is a single |
| 7763 | source file), you may need to clarify. One way to do this is with |
| 7764 | @code{info line}, for example @samp{info line *0x4537}. Alternately, |
| 7765 | you can set @value{GDBN} to print the source file and line number when |
| 7766 | it prints a symbolic address: |
| 7767 | |
| 7768 | @table @code |
| 7769 | @item set print symbol-filename on |
| 7770 | @cindex source file and line of a symbol |
| 7771 | @cindex symbol, source file and line |
| 7772 | Tell @value{GDBN} to print the source file name and line number of a |
| 7773 | symbol in the symbolic form of an address. |
| 7774 | |
| 7775 | @item set print symbol-filename off |
| 7776 | Do not print source file name and line number of a symbol. This is the |
| 7777 | default. |
| 7778 | |
| 7779 | @item show print symbol-filename |
| 7780 | Show whether or not @value{GDBN} will print the source file name and |
| 7781 | line number of a symbol in the symbolic form of an address. |
| 7782 | @end table |
| 7783 | |
| 7784 | Another situation where it is helpful to show symbol filenames and line |
| 7785 | numbers is when disassembling code; @value{GDBN} shows you the line |
| 7786 | number and source file that corresponds to each instruction. |
| 7787 | |
| 7788 | Also, you may wish to see the symbolic form only if the address being |
| 7789 | printed is reasonably close to the closest earlier symbol: |
| 7790 | |
| 7791 | @table @code |
| 7792 | @item set print max-symbolic-offset @var{max-offset} |
| 7793 | @cindex maximum value for offset of closest symbol |
| 7794 | Tell @value{GDBN} to only display the symbolic form of an address if the |
| 7795 | offset between the closest earlier symbol and the address is less than |
| 7796 | @var{max-offset}. The default is 0, which tells @value{GDBN} |
| 7797 | to always print the symbolic form of an address if any symbol precedes it. |
| 7798 | |
| 7799 | @item show print max-symbolic-offset |
| 7800 | Ask how large the maximum offset is that @value{GDBN} prints in a |
| 7801 | symbolic address. |
| 7802 | @end table |
| 7803 | |
| 7804 | @cindex wild pointer, interpreting |
| 7805 | @cindex pointer, finding referent |
| 7806 | If you have a pointer and you are not sure where it points, try |
| 7807 | @samp{set print symbol-filename on}. Then you can determine the name |
| 7808 | and source file location of the variable where it points, using |
| 7809 | @samp{p/a @var{pointer}}. This interprets the address in symbolic form. |
| 7810 | For example, here @value{GDBN} shows that a variable @code{ptt} points |
| 7811 | at another variable @code{t}, defined in @file{hi2.c}: |
| 7812 | |
| 7813 | @smallexample |
| 7814 | (@value{GDBP}) set print symbol-filename on |
| 7815 | (@value{GDBP}) p/a ptt |
| 7816 | $4 = 0xe008 <t in hi2.c> |
| 7817 | @end smallexample |
| 7818 | |
| 7819 | @quotation |
| 7820 | @emph{Warning:} For pointers that point to a local variable, @samp{p/a} |
| 7821 | does not show the symbol name and filename of the referent, even with |
| 7822 | the appropriate @code{set print} options turned on. |
| 7823 | @end quotation |
| 7824 | |
| 7825 | Other settings control how different kinds of objects are printed: |
| 7826 | |
| 7827 | @table @code |
| 7828 | @item set print array |
| 7829 | @itemx set print array on |
| 7830 | @cindex pretty print arrays |
| 7831 | Pretty print arrays. This format is more convenient to read, |
| 7832 | but uses more space. The default is off. |
| 7833 | |
| 7834 | @item set print array off |
| 7835 | Return to compressed format for arrays. |
| 7836 | |
| 7837 | @item show print array |
| 7838 | Show whether compressed or pretty format is selected for displaying |
| 7839 | arrays. |
| 7840 | |
| 7841 | @cindex print array indexes |
| 7842 | @item set print array-indexes |
| 7843 | @itemx set print array-indexes on |
| 7844 | Print the index of each element when displaying arrays. May be more |
| 7845 | convenient to locate a given element in the array or quickly find the |
| 7846 | index of a given element in that printed array. The default is off. |
| 7847 | |
| 7848 | @item set print array-indexes off |
| 7849 | Stop printing element indexes when displaying arrays. |
| 7850 | |
| 7851 | @item show print array-indexes |
| 7852 | Show whether the index of each element is printed when displaying |
| 7853 | arrays. |
| 7854 | |
| 7855 | @item set print elements @var{number-of-elements} |
| 7856 | @cindex number of array elements to print |
| 7857 | @cindex limit on number of printed array elements |
| 7858 | Set a limit on how many elements of an array @value{GDBN} will print. |
| 7859 | If @value{GDBN} is printing a large array, it stops printing after it has |
| 7860 | printed the number of elements set by the @code{set print elements} command. |
| 7861 | This limit also applies to the display of strings. |
| 7862 | When @value{GDBN} starts, this limit is set to 200. |
| 7863 | Setting @var{number-of-elements} to zero means that the printing is unlimited. |
| 7864 | |
| 7865 | @item show print elements |
| 7866 | Display the number of elements of a large array that @value{GDBN} will print. |
| 7867 | If the number is 0, then the printing is unlimited. |
| 7868 | |
| 7869 | @item set print frame-arguments @var{value} |
| 7870 | @kindex set print frame-arguments |
| 7871 | @cindex printing frame argument values |
| 7872 | @cindex print all frame argument values |
| 7873 | @cindex print frame argument values for scalars only |
| 7874 | @cindex do not print frame argument values |
| 7875 | This command allows to control how the values of arguments are printed |
| 7876 | when the debugger prints a frame (@pxref{Frames}). The possible |
| 7877 | values are: |
| 7878 | |
| 7879 | @table @code |
| 7880 | @item all |
| 7881 | The values of all arguments are printed. |
| 7882 | |
| 7883 | @item scalars |
| 7884 | Print the value of an argument only if it is a scalar. The value of more |
| 7885 | complex arguments such as arrays, structures, unions, etc, is replaced |
| 7886 | by @code{@dots{}}. This is the default. Here is an example where |
| 7887 | only scalar arguments are shown: |
| 7888 | |
| 7889 | @smallexample |
| 7890 | #1 0x08048361 in call_me (i=3, s=@dots{}, ss=0xbf8d508c, u=@dots{}, e=green) |
| 7891 | at frame-args.c:23 |
| 7892 | @end smallexample |
| 7893 | |
| 7894 | @item none |
| 7895 | None of the argument values are printed. Instead, the value of each argument |
| 7896 | is replaced by @code{@dots{}}. In this case, the example above now becomes: |
| 7897 | |
| 7898 | @smallexample |
| 7899 | #1 0x08048361 in call_me (i=@dots{}, s=@dots{}, ss=@dots{}, u=@dots{}, e=@dots{}) |
| 7900 | at frame-args.c:23 |
| 7901 | @end smallexample |
| 7902 | @end table |
| 7903 | |
| 7904 | By default, only scalar arguments are printed. This command can be used |
| 7905 | to configure the debugger to print the value of all arguments, regardless |
| 7906 | of their type. However, it is often advantageous to not print the value |
| 7907 | of more complex parameters. For instance, it reduces the amount of |
| 7908 | information printed in each frame, making the backtrace more readable. |
| 7909 | Also, it improves performance when displaying Ada frames, because |
| 7910 | the computation of large arguments can sometimes be CPU-intensive, |
| 7911 | especially in large applications. Setting @code{print frame-arguments} |
| 7912 | to @code{scalars} (the default) or @code{none} avoids this computation, |
| 7913 | thus speeding up the display of each Ada frame. |
| 7914 | |
| 7915 | @item show print frame-arguments |
| 7916 | Show how the value of arguments should be displayed when printing a frame. |
| 7917 | |
| 7918 | @item set print repeats |
| 7919 | @cindex repeated array elements |
| 7920 | Set the threshold for suppressing display of repeated array |
| 7921 | elements. When the number of consecutive identical elements of an |
| 7922 | array exceeds the threshold, @value{GDBN} prints the string |
| 7923 | @code{"<repeats @var{n} times>"}, where @var{n} is the number of |
| 7924 | identical repetitions, instead of displaying the identical elements |
| 7925 | themselves. Setting the threshold to zero will cause all elements to |
| 7926 | be individually printed. The default threshold is 10. |
| 7927 | |
| 7928 | @item show print repeats |
| 7929 | Display the current threshold for printing repeated identical |
| 7930 | elements. |
| 7931 | |
| 7932 | @item set print null-stop |
| 7933 | @cindex @sc{null} elements in arrays |
| 7934 | Cause @value{GDBN} to stop printing the characters of an array when the first |
| 7935 | @sc{null} is encountered. This is useful when large arrays actually |
| 7936 | contain only short strings. |
| 7937 | The default is off. |
| 7938 | |
| 7939 | @item show print null-stop |
| 7940 | Show whether @value{GDBN} stops printing an array on the first |
| 7941 | @sc{null} character. |
| 7942 | |
| 7943 | @item set print pretty on |
| 7944 | @cindex print structures in indented form |
| 7945 | @cindex indentation in structure display |
| 7946 | Cause @value{GDBN} to print structures in an indented format with one member |
| 7947 | per line, like this: |
| 7948 | |
| 7949 | @smallexample |
| 7950 | @group |
| 7951 | $1 = @{ |
| 7952 | next = 0x0, |
| 7953 | flags = @{ |
| 7954 | sweet = 1, |
| 7955 | sour = 1 |
| 7956 | @}, |
| 7957 | meat = 0x54 "Pork" |
| 7958 | @} |
| 7959 | @end group |
| 7960 | @end smallexample |
| 7961 | |
| 7962 | @item set print pretty off |
| 7963 | Cause @value{GDBN} to print structures in a compact format, like this: |
| 7964 | |
| 7965 | @smallexample |
| 7966 | @group |
| 7967 | $1 = @{next = 0x0, flags = @{sweet = 1, sour = 1@}, \ |
| 7968 | meat = 0x54 "Pork"@} |
| 7969 | @end group |
| 7970 | @end smallexample |
| 7971 | |
| 7972 | @noindent |
| 7973 | This is the default format. |
| 7974 | |
| 7975 | @item show print pretty |
| 7976 | Show which format @value{GDBN} is using to print structures. |
| 7977 | |
| 7978 | @item set print sevenbit-strings on |
| 7979 | @cindex eight-bit characters in strings |
| 7980 | @cindex octal escapes in strings |
| 7981 | Print using only seven-bit characters; if this option is set, |
| 7982 | @value{GDBN} displays any eight-bit characters (in strings or |
| 7983 | character values) using the notation @code{\}@var{nnn}. This setting is |
| 7984 | best if you are working in English (@sc{ascii}) and you use the |
| 7985 | high-order bit of characters as a marker or ``meta'' bit. |
| 7986 | |
| 7987 | @item set print sevenbit-strings off |
| 7988 | Print full eight-bit characters. This allows the use of more |
| 7989 | international character sets, and is the default. |
| 7990 | |
| 7991 | @item show print sevenbit-strings |
| 7992 | Show whether or not @value{GDBN} is printing only seven-bit characters. |
| 7993 | |
| 7994 | @item set print union on |
| 7995 | @cindex unions in structures, printing |
| 7996 | Tell @value{GDBN} to print unions which are contained in structures |
| 7997 | and other unions. This is the default setting. |
| 7998 | |
| 7999 | @item set print union off |
| 8000 | Tell @value{GDBN} not to print unions which are contained in |
| 8001 | structures and other unions. @value{GDBN} will print @code{"@{...@}"} |
| 8002 | instead. |
| 8003 | |
| 8004 | @item show print union |
| 8005 | Ask @value{GDBN} whether or not it will print unions which are contained in |
| 8006 | structures and other unions. |
| 8007 | |
| 8008 | For example, given the declarations |
| 8009 | |
| 8010 | @smallexample |
| 8011 | typedef enum @{Tree, Bug@} Species; |
| 8012 | typedef enum @{Big_tree, Acorn, Seedling@} Tree_forms; |
| 8013 | typedef enum @{Caterpillar, Cocoon, Butterfly@} |
| 8014 | Bug_forms; |
| 8015 | |
| 8016 | struct thing @{ |
| 8017 | Species it; |
| 8018 | union @{ |
| 8019 | Tree_forms tree; |
| 8020 | Bug_forms bug; |
| 8021 | @} form; |
| 8022 | @}; |
| 8023 | |
| 8024 | struct thing foo = @{Tree, @{Acorn@}@}; |
| 8025 | @end smallexample |
| 8026 | |
| 8027 | @noindent |
| 8028 | with @code{set print union on} in effect @samp{p foo} would print |
| 8029 | |
| 8030 | @smallexample |
| 8031 | $1 = @{it = Tree, form = @{tree = Acorn, bug = Cocoon@}@} |
| 8032 | @end smallexample |
| 8033 | |
| 8034 | @noindent |
| 8035 | and with @code{set print union off} in effect it would print |
| 8036 | |
| 8037 | @smallexample |
| 8038 | $1 = @{it = Tree, form = @{...@}@} |
| 8039 | @end smallexample |
| 8040 | |
| 8041 | @noindent |
| 8042 | @code{set print union} affects programs written in C-like languages |
| 8043 | and in Pascal. |
| 8044 | @end table |
| 8045 | |
| 8046 | @need 1000 |
| 8047 | @noindent |
| 8048 | These settings are of interest when debugging C@t{++} programs: |
| 8049 | |
| 8050 | @table @code |
| 8051 | @cindex demangling C@t{++} names |
| 8052 | @item set print demangle |
| 8053 | @itemx set print demangle on |
| 8054 | Print C@t{++} names in their source form rather than in the encoded |
| 8055 | (``mangled'') form passed to the assembler and linker for type-safe |
| 8056 | linkage. The default is on. |
| 8057 | |
| 8058 | @item show print demangle |
| 8059 | Show whether C@t{++} names are printed in mangled or demangled form. |
| 8060 | |
| 8061 | @item set print asm-demangle |
| 8062 | @itemx set print asm-demangle on |
| 8063 | Print C@t{++} names in their source form rather than their mangled form, even |
| 8064 | in assembler code printouts such as instruction disassemblies. |
| 8065 | The default is off. |
| 8066 | |
| 8067 | @item show print asm-demangle |
| 8068 | Show whether C@t{++} names in assembly listings are printed in mangled |
| 8069 | or demangled form. |
| 8070 | |
| 8071 | @cindex C@t{++} symbol decoding style |
| 8072 | @cindex symbol decoding style, C@t{++} |
| 8073 | @kindex set demangle-style |
| 8074 | @item set demangle-style @var{style} |
| 8075 | Choose among several encoding schemes used by different compilers to |
| 8076 | represent C@t{++} names. The choices for @var{style} are currently: |
| 8077 | |
| 8078 | @table @code |
| 8079 | @item auto |
| 8080 | Allow @value{GDBN} to choose a decoding style by inspecting your program. |
| 8081 | |
| 8082 | @item gnu |
| 8083 | Decode based on the @sc{gnu} C@t{++} compiler (@code{g++}) encoding algorithm. |
| 8084 | This is the default. |
| 8085 | |
| 8086 | @item hp |
| 8087 | Decode based on the HP ANSI C@t{++} (@code{aCC}) encoding algorithm. |
| 8088 | |
| 8089 | @item lucid |
| 8090 | Decode based on the Lucid C@t{++} compiler (@code{lcc}) encoding algorithm. |
| 8091 | |
| 8092 | @item arm |
| 8093 | Decode using the algorithm in the @cite{C@t{++} Annotated Reference Manual}. |
| 8094 | @strong{Warning:} this setting alone is not sufficient to allow |
| 8095 | debugging @code{cfront}-generated executables. @value{GDBN} would |
| 8096 | require further enhancement to permit that. |
| 8097 | |
| 8098 | @end table |
| 8099 | If you omit @var{style}, you will see a list of possible formats. |
| 8100 | |
| 8101 | @item show demangle-style |
| 8102 | Display the encoding style currently in use for decoding C@t{++} symbols. |
| 8103 | |
| 8104 | @item set print object |
| 8105 | @itemx set print object on |
| 8106 | @cindex derived type of an object, printing |
| 8107 | @cindex display derived types |
| 8108 | When displaying a pointer to an object, identify the @emph{actual} |
| 8109 | (derived) type of the object rather than the @emph{declared} type, using |
| 8110 | the virtual function table. |
| 8111 | |
| 8112 | @item set print object off |
| 8113 | Display only the declared type of objects, without reference to the |
| 8114 | virtual function table. This is the default setting. |
| 8115 | |
| 8116 | @item show print object |
| 8117 | Show whether actual, or declared, object types are displayed. |
| 8118 | |
| 8119 | @item set print static-members |
| 8120 | @itemx set print static-members on |
| 8121 | @cindex static members of C@t{++} objects |
| 8122 | Print static members when displaying a C@t{++} object. The default is on. |
| 8123 | |
| 8124 | @item set print static-members off |
| 8125 | Do not print static members when displaying a C@t{++} object. |
| 8126 | |
| 8127 | @item show print static-members |
| 8128 | Show whether C@t{++} static members are printed or not. |
| 8129 | |
| 8130 | @item set print pascal_static-members |
| 8131 | @itemx set print pascal_static-members on |
| 8132 | @cindex static members of Pascal objects |
| 8133 | @cindex Pascal objects, static members display |
| 8134 | Print static members when displaying a Pascal object. The default is on. |
| 8135 | |
| 8136 | @item set print pascal_static-members off |
| 8137 | Do not print static members when displaying a Pascal object. |
| 8138 | |
| 8139 | @item show print pascal_static-members |
| 8140 | Show whether Pascal static members are printed or not. |
| 8141 | |
| 8142 | @c These don't work with HP ANSI C++ yet. |
| 8143 | @item set print vtbl |
| 8144 | @itemx set print vtbl on |
| 8145 | @cindex pretty print C@t{++} virtual function tables |
| 8146 | @cindex virtual functions (C@t{++}) display |
| 8147 | @cindex VTBL display |
| 8148 | Pretty print C@t{++} virtual function tables. The default is off. |
| 8149 | (The @code{vtbl} commands do not work on programs compiled with the HP |
| 8150 | ANSI C@t{++} compiler (@code{aCC}).) |
| 8151 | |
| 8152 | @item set print vtbl off |
| 8153 | Do not pretty print C@t{++} virtual function tables. |
| 8154 | |
| 8155 | @item show print vtbl |
| 8156 | Show whether C@t{++} virtual function tables are pretty printed, or not. |
| 8157 | @end table |
| 8158 | |
| 8159 | @node Pretty Printing |
| 8160 | @section Pretty Printing |
| 8161 | |
| 8162 | @value{GDBN} provides a mechanism to allow pretty-printing of values using |
| 8163 | Python code. It greatly simplifies the display of complex objects. This |
| 8164 | mechanism works for both MI and the CLI. |
| 8165 | |
| 8166 | @menu |
| 8167 | * Pretty-Printer Introduction:: Introduction to pretty-printers |
| 8168 | * Pretty-Printer Example:: An example pretty-printer |
| 8169 | * Pretty-Printer Commands:: Pretty-printer commands |
| 8170 | @end menu |
| 8171 | |
| 8172 | @node Pretty-Printer Introduction |
| 8173 | @subsection Pretty-Printer Introduction |
| 8174 | |
| 8175 | When @value{GDBN} prints a value, it first sees if there is a pretty-printer |
| 8176 | registered for the value. If there is then @value{GDBN} invokes the |
| 8177 | pretty-printer to print the value. Otherwise the value is printed normally. |
| 8178 | |
| 8179 | Pretty-printers are normally named. This makes them easy to manage. |
| 8180 | The @samp{info pretty-printer} command will list all the installed |
| 8181 | pretty-printers with their names. |
| 8182 | If a pretty-printer can handle multiple data types, then its |
| 8183 | @dfn{subprinters} are the printers for the individual data types. |
| 8184 | Each such subprinter has its own name. |
| 8185 | The format of the name is @var{printer-name};@var{subprinter-name}. |
| 8186 | |
| 8187 | Pretty-printers are installed by @dfn{registering} them with @value{GDBN}. |
| 8188 | Typically they are automatically loaded and registered when the corresponding |
| 8189 | debug information is loaded, thus making them available without having to |
| 8190 | do anything special. |
| 8191 | |
| 8192 | There are three places where a pretty-printer can be registered. |
| 8193 | |
| 8194 | @itemize @bullet |
| 8195 | @item |
| 8196 | Pretty-printers registered globally are available when debugging |
| 8197 | all inferiors. |
| 8198 | |
| 8199 | @item |
| 8200 | Pretty-printers registered with a program space are available only |
| 8201 | when debugging that program. |
| 8202 | @xref{Progspaces In Python}, for more details on program spaces in Python. |
| 8203 | |
| 8204 | @item |
| 8205 | Pretty-printers registered with an objfile are loaded and unloaded |
| 8206 | with the corresponding objfile (e.g., shared library). |
| 8207 | @xref{Objfiles In Python}, for more details on objfiles in Python. |
| 8208 | @end itemize |
| 8209 | |
| 8210 | @xref{Selecting Pretty-Printers}, for further information on how |
| 8211 | pretty-printers are selected, |
| 8212 | |
| 8213 | @xref{Writing a Pretty-Printer}, for implementing pretty printers |
| 8214 | for new types. |
| 8215 | |
| 8216 | @node Pretty-Printer Example |
| 8217 | @subsection Pretty-Printer Example |
| 8218 | |
| 8219 | Here is how a C@t{++} @code{std::string} looks without a pretty-printer: |
| 8220 | |
| 8221 | @smallexample |
| 8222 | (@value{GDBP}) print s |
| 8223 | $1 = @{ |
| 8224 | static npos = 4294967295, |
| 8225 | _M_dataplus = @{ |
| 8226 | <std::allocator<char>> = @{ |
| 8227 | <__gnu_cxx::new_allocator<char>> = @{ |
| 8228 | <No data fields>@}, <No data fields> |
| 8229 | @}, |
| 8230 | members of std::basic_string<char, std::char_traits<char>, |
| 8231 | std::allocator<char> >::_Alloc_hider: |
| 8232 | _M_p = 0x804a014 "abcd" |
| 8233 | @} |
| 8234 | @} |
| 8235 | @end smallexample |
| 8236 | |
| 8237 | With a pretty-printer for @code{std::string} only the contents are printed: |
| 8238 | |
| 8239 | @smallexample |
| 8240 | (@value{GDBP}) print s |
| 8241 | $2 = "abcd" |
| 8242 | @end smallexample |
| 8243 | |
| 8244 | @node Pretty-Printer Commands |
| 8245 | @subsection Pretty-Printer Commands |
| 8246 | @cindex pretty-printer commands |
| 8247 | |
| 8248 | @table @code |
| 8249 | @kindex info pretty-printer |
| 8250 | @item info pretty-printer [@var{object-regexp} [@var{name-regexp}]] |
| 8251 | Print the list of installed pretty-printers. |
| 8252 | This includes disabled pretty-printers, which are marked as such. |
| 8253 | |
| 8254 | @var{object-regexp} is a regular expression matching the objects |
| 8255 | whose pretty-printers to list. |
| 8256 | Objects can be @code{global}, the program space's file |
| 8257 | (@pxref{Progspaces In Python}), |
| 8258 | and the object files within that program space (@pxref{Objfiles In Python}). |
| 8259 | @xref{Selecting Pretty-Printers}, for details on how @value{GDBN} |
| 8260 | looks up a printer from these three objects. |
| 8261 | |
| 8262 | @var{name-regexp} is a regular expression matching the name of the printers |
| 8263 | to list. |
| 8264 | |
| 8265 | @kindex disable pretty-printer |
| 8266 | @item disable pretty-printer [@var{object-regexp} [@var{name-regexp}]] |
| 8267 | Disable pretty-printers matching @var{object-regexp} and @var{name-regexp}. |
| 8268 | A disabled pretty-printer is not forgotten, it may be enabled again later. |
| 8269 | |
| 8270 | @kindex enable pretty-printer |
| 8271 | @item enable pretty-printer [@var{object-regexp} [@var{name-regexp}]] |
| 8272 | Enable pretty-printers matching @var{object-regexp} and @var{name-regexp}. |
| 8273 | @end table |
| 8274 | |
| 8275 | Example: |
| 8276 | |
| 8277 | Suppose we have three pretty-printers installed: one from library1.so |
| 8278 | named @code{foo} that prints objects of type @code{foo}, and |
| 8279 | another from library2.so named @code{bar} that prints two types of objects, |
| 8280 | @code{bar1} and @code{bar2}. |
| 8281 | |
| 8282 | @smallexample |
| 8283 | (gdb) info pretty-printer |
| 8284 | library1.so: |
| 8285 | foo |
| 8286 | library2.so: |
| 8287 | bar |
| 8288 | bar1 |
| 8289 | bar2 |
| 8290 | (gdb) info pretty-printer library2 |
| 8291 | library2.so: |
| 8292 | bar |
| 8293 | bar1 |
| 8294 | bar2 |
| 8295 | (gdb) disable pretty-printer library1 |
| 8296 | 1 printer disabled |
| 8297 | 2 of 3 printers enabled |
| 8298 | (gdb) info pretty-printer |
| 8299 | library1.so: |
| 8300 | foo [disabled] |
| 8301 | library2.so: |
| 8302 | bar |
| 8303 | bar1 |
| 8304 | bar2 |
| 8305 | (gdb) disable pretty-printer library2 bar:bar1 |
| 8306 | 1 printer disabled |
| 8307 | 1 of 3 printers enabled |
| 8308 | (gdb) info pretty-printer library2 |
| 8309 | library1.so: |
| 8310 | foo [disabled] |
| 8311 | library2.so: |
| 8312 | bar |
| 8313 | bar1 [disabled] |
| 8314 | bar2 |
| 8315 | (gdb) disable pretty-printer library2 bar |
| 8316 | 1 printer disabled |
| 8317 | 0 of 3 printers enabled |
| 8318 | (gdb) info pretty-printer library2 |
| 8319 | library1.so: |
| 8320 | foo [disabled] |
| 8321 | library2.so: |
| 8322 | bar [disabled] |
| 8323 | bar1 [disabled] |
| 8324 | bar2 |
| 8325 | @end smallexample |
| 8326 | |
| 8327 | Note that for @code{bar} the entire printer can be disabled, |
| 8328 | as can each individual subprinter. |
| 8329 | |
| 8330 | @node Value History |
| 8331 | @section Value History |
| 8332 | |
| 8333 | @cindex value history |
| 8334 | @cindex history of values printed by @value{GDBN} |
| 8335 | Values printed by the @code{print} command are saved in the @value{GDBN} |
| 8336 | @dfn{value history}. This allows you to refer to them in other expressions. |
| 8337 | Values are kept until the symbol table is re-read or discarded |
| 8338 | (for example with the @code{file} or @code{symbol-file} commands). |
| 8339 | When the symbol table changes, the value history is discarded, |
| 8340 | since the values may contain pointers back to the types defined in the |
| 8341 | symbol table. |
| 8342 | |
| 8343 | @cindex @code{$} |
| 8344 | @cindex @code{$$} |
| 8345 | @cindex history number |
| 8346 | The values printed are given @dfn{history numbers} by which you can |
| 8347 | refer to them. These are successive integers starting with one. |
| 8348 | @code{print} shows you the history number assigned to a value by |
| 8349 | printing @samp{$@var{num} = } before the value; here @var{num} is the |
| 8350 | history number. |
| 8351 | |
| 8352 | To refer to any previous value, use @samp{$} followed by the value's |
| 8353 | history number. The way @code{print} labels its output is designed to |
| 8354 | remind you of this. Just @code{$} refers to the most recent value in |
| 8355 | the history, and @code{$$} refers to the value before that. |
| 8356 | @code{$$@var{n}} refers to the @var{n}th value from the end; @code{$$2} |
| 8357 | is the value just prior to @code{$$}, @code{$$1} is equivalent to |
| 8358 | @code{$$}, and @code{$$0} is equivalent to @code{$}. |
| 8359 | |
| 8360 | For example, suppose you have just printed a pointer to a structure and |
| 8361 | want to see the contents of the structure. It suffices to type |
| 8362 | |
| 8363 | @smallexample |
| 8364 | p *$ |
| 8365 | @end smallexample |
| 8366 | |
| 8367 | If you have a chain of structures where the component @code{next} points |
| 8368 | to the next one, you can print the contents of the next one with this: |
| 8369 | |
| 8370 | @smallexample |
| 8371 | p *$.next |
| 8372 | @end smallexample |
| 8373 | |
| 8374 | @noindent |
| 8375 | You can print successive links in the chain by repeating this |
| 8376 | command---which you can do by just typing @key{RET}. |
| 8377 | |
| 8378 | Note that the history records values, not expressions. If the value of |
| 8379 | @code{x} is 4 and you type these commands: |
| 8380 | |
| 8381 | @smallexample |
| 8382 | print x |
| 8383 | set x=5 |
| 8384 | @end smallexample |
| 8385 | |
| 8386 | @noindent |
| 8387 | then the value recorded in the value history by the @code{print} command |
| 8388 | remains 4 even though the value of @code{x} has changed. |
| 8389 | |
| 8390 | @table @code |
| 8391 | @kindex show values |
| 8392 | @item show values |
| 8393 | Print the last ten values in the value history, with their item numbers. |
| 8394 | This is like @samp{p@ $$9} repeated ten times, except that @code{show |
| 8395 | values} does not change the history. |
| 8396 | |
| 8397 | @item show values @var{n} |
| 8398 | Print ten history values centered on history item number @var{n}. |
| 8399 | |
| 8400 | @item show values + |
| 8401 | Print ten history values just after the values last printed. If no more |
| 8402 | values are available, @code{show values +} produces no display. |
| 8403 | @end table |
| 8404 | |
| 8405 | Pressing @key{RET} to repeat @code{show values @var{n}} has exactly the |
| 8406 | same effect as @samp{show values +}. |
| 8407 | |
| 8408 | @node Convenience Vars |
| 8409 | @section Convenience Variables |
| 8410 | |
| 8411 | @cindex convenience variables |
| 8412 | @cindex user-defined variables |
| 8413 | @value{GDBN} provides @dfn{convenience variables} that you can use within |
| 8414 | @value{GDBN} to hold on to a value and refer to it later. These variables |
| 8415 | exist entirely within @value{GDBN}; they are not part of your program, and |
| 8416 | setting a convenience variable has no direct effect on further execution |
| 8417 | of your program. That is why you can use them freely. |
| 8418 | |
| 8419 | Convenience variables are prefixed with @samp{$}. Any name preceded by |
| 8420 | @samp{$} can be used for a convenience variable, unless it is one of |
| 8421 | the predefined machine-specific register names (@pxref{Registers, ,Registers}). |
| 8422 | (Value history references, in contrast, are @emph{numbers} preceded |
| 8423 | by @samp{$}. @xref{Value History, ,Value History}.) |
| 8424 | |
| 8425 | You can save a value in a convenience variable with an assignment |
| 8426 | expression, just as you would set a variable in your program. |
| 8427 | For example: |
| 8428 | |
| 8429 | @smallexample |
| 8430 | set $foo = *object_ptr |
| 8431 | @end smallexample |
| 8432 | |
| 8433 | @noindent |
| 8434 | would save in @code{$foo} the value contained in the object pointed to by |
| 8435 | @code{object_ptr}. |
| 8436 | |
| 8437 | Using a convenience variable for the first time creates it, but its |
| 8438 | value is @code{void} until you assign a new value. You can alter the |
| 8439 | value with another assignment at any time. |
| 8440 | |
| 8441 | Convenience variables have no fixed types. You can assign a convenience |
| 8442 | variable any type of value, including structures and arrays, even if |
| 8443 | that variable already has a value of a different type. The convenience |
| 8444 | variable, when used as an expression, has the type of its current value. |
| 8445 | |
| 8446 | @table @code |
| 8447 | @kindex show convenience |
| 8448 | @cindex show all user variables |
| 8449 | @item show convenience |
| 8450 | Print a list of convenience variables used so far, and their values. |
| 8451 | Abbreviated @code{show conv}. |
| 8452 | |
| 8453 | @kindex init-if-undefined |
| 8454 | @cindex convenience variables, initializing |
| 8455 | @item init-if-undefined $@var{variable} = @var{expression} |
| 8456 | Set a convenience variable if it has not already been set. This is useful |
| 8457 | for user-defined commands that keep some state. It is similar, in concept, |
| 8458 | to using local static variables with initializers in C (except that |
| 8459 | convenience variables are global). It can also be used to allow users to |
| 8460 | override default values used in a command script. |
| 8461 | |
| 8462 | If the variable is already defined then the expression is not evaluated so |
| 8463 | any side-effects do not occur. |
| 8464 | @end table |
| 8465 | |
| 8466 | One of the ways to use a convenience variable is as a counter to be |
| 8467 | incremented or a pointer to be advanced. For example, to print |
| 8468 | a field from successive elements of an array of structures: |
| 8469 | |
| 8470 | @smallexample |
| 8471 | set $i = 0 |
| 8472 | print bar[$i++]->contents |
| 8473 | @end smallexample |
| 8474 | |
| 8475 | @noindent |
| 8476 | Repeat that command by typing @key{RET}. |
| 8477 | |
| 8478 | Some convenience variables are created automatically by @value{GDBN} and given |
| 8479 | values likely to be useful. |
| 8480 | |
| 8481 | @table @code |
| 8482 | @vindex $_@r{, convenience variable} |
| 8483 | @item $_ |
| 8484 | The variable @code{$_} is automatically set by the @code{x} command to |
| 8485 | the last address examined (@pxref{Memory, ,Examining Memory}). Other |
| 8486 | commands which provide a default address for @code{x} to examine also |
| 8487 | set @code{$_} to that address; these commands include @code{info line} |
| 8488 | and @code{info breakpoint}. The type of @code{$_} is @code{void *} |
| 8489 | except when set by the @code{x} command, in which case it is a pointer |
| 8490 | to the type of @code{$__}. |
| 8491 | |
| 8492 | @vindex $__@r{, convenience variable} |
| 8493 | @item $__ |
| 8494 | The variable @code{$__} is automatically set by the @code{x} command |
| 8495 | to the value found in the last address examined. Its type is chosen |
| 8496 | to match the format in which the data was printed. |
| 8497 | |
| 8498 | @item $_exitcode |
| 8499 | @vindex $_exitcode@r{, convenience variable} |
| 8500 | The variable @code{$_exitcode} is automatically set to the exit code when |
| 8501 | the program being debugged terminates. |
| 8502 | |
| 8503 | @item $_sdata |
| 8504 | @vindex $_sdata@r{, inspect, convenience variable} |
| 8505 | The variable @code{$_sdata} contains extra collected static tracepoint |
| 8506 | data. @xref{Tracepoint Actions,,Tracepoint Action Lists}. Note that |
| 8507 | @code{$_sdata} could be empty, if not inspecting a trace buffer, or |
| 8508 | if extra static tracepoint data has not been collected. |
| 8509 | |
| 8510 | @item $_siginfo |
| 8511 | @vindex $_siginfo@r{, convenience variable} |
| 8512 | The variable @code{$_siginfo} contains extra signal information |
| 8513 | (@pxref{extra signal information}). Note that @code{$_siginfo} |
| 8514 | could be empty, if the application has not yet received any signals. |
| 8515 | For example, it will be empty before you execute the @code{run} command. |
| 8516 | |
| 8517 | @item $_tlb |
| 8518 | @vindex $_tlb@r{, convenience variable} |
| 8519 | The variable @code{$_tlb} is automatically set when debugging |
| 8520 | applications running on MS-Windows in native mode or connected to |
| 8521 | gdbserver that supports the @code{qGetTIBAddr} request. |
| 8522 | @xref{General Query Packets}. |
| 8523 | This variable contains the address of the thread information block. |
| 8524 | |
| 8525 | @end table |
| 8526 | |
| 8527 | On HP-UX systems, if you refer to a function or variable name that |
| 8528 | begins with a dollar sign, @value{GDBN} searches for a user or system |
| 8529 | name first, before it searches for a convenience variable. |
| 8530 | |
| 8531 | @cindex convenience functions |
| 8532 | @value{GDBN} also supplies some @dfn{convenience functions}. These |
| 8533 | have a syntax similar to convenience variables. A convenience |
| 8534 | function can be used in an expression just like an ordinary function; |
| 8535 | however, a convenience function is implemented internally to |
| 8536 | @value{GDBN}. |
| 8537 | |
| 8538 | @table @code |
| 8539 | @item help function |
| 8540 | @kindex help function |
| 8541 | @cindex show all convenience functions |
| 8542 | Print a list of all convenience functions. |
| 8543 | @end table |
| 8544 | |
| 8545 | @node Registers |
| 8546 | @section Registers |
| 8547 | |
| 8548 | @cindex registers |
| 8549 | You can refer to machine register contents, in expressions, as variables |
| 8550 | with names starting with @samp{$}. The names of registers are different |
| 8551 | for each machine; use @code{info registers} to see the names used on |
| 8552 | your machine. |
| 8553 | |
| 8554 | @table @code |
| 8555 | @kindex info registers |
| 8556 | @item info registers |
| 8557 | Print the names and values of all registers except floating-point |
| 8558 | and vector registers (in the selected stack frame). |
| 8559 | |
| 8560 | @kindex info all-registers |
| 8561 | @cindex floating point registers |
| 8562 | @item info all-registers |
| 8563 | Print the names and values of all registers, including floating-point |
| 8564 | and vector registers (in the selected stack frame). |
| 8565 | |
| 8566 | @item info registers @var{regname} @dots{} |
| 8567 | Print the @dfn{relativized} value of each specified register @var{regname}. |
| 8568 | As discussed in detail below, register values are normally relative to |
| 8569 | the selected stack frame. @var{regname} may be any register name valid on |
| 8570 | the machine you are using, with or without the initial @samp{$}. |
| 8571 | @end table |
| 8572 | |
| 8573 | @cindex stack pointer register |
| 8574 | @cindex program counter register |
| 8575 | @cindex process status register |
| 8576 | @cindex frame pointer register |
| 8577 | @cindex standard registers |
| 8578 | @value{GDBN} has four ``standard'' register names that are available (in |
| 8579 | expressions) on most machines---whenever they do not conflict with an |
| 8580 | architecture's canonical mnemonics for registers. The register names |
| 8581 | @code{$pc} and @code{$sp} are used for the program counter register and |
| 8582 | the stack pointer. @code{$fp} is used for a register that contains a |
| 8583 | pointer to the current stack frame, and @code{$ps} is used for a |
| 8584 | register that contains the processor status. For example, |
| 8585 | you could print the program counter in hex with |
| 8586 | |
| 8587 | @smallexample |
| 8588 | p/x $pc |
| 8589 | @end smallexample |
| 8590 | |
| 8591 | @noindent |
| 8592 | or print the instruction to be executed next with |
| 8593 | |
| 8594 | @smallexample |
| 8595 | x/i $pc |
| 8596 | @end smallexample |
| 8597 | |
| 8598 | @noindent |
| 8599 | or add four to the stack pointer@footnote{This is a way of removing |
| 8600 | one word from the stack, on machines where stacks grow downward in |
| 8601 | memory (most machines, nowadays). This assumes that the innermost |
| 8602 | stack frame is selected; setting @code{$sp} is not allowed when other |
| 8603 | stack frames are selected. To pop entire frames off the stack, |
| 8604 | regardless of machine architecture, use @code{return}; |
| 8605 | see @ref{Returning, ,Returning from a Function}.} with |
| 8606 | |
| 8607 | @smallexample |
| 8608 | set $sp += 4 |
| 8609 | @end smallexample |
| 8610 | |
| 8611 | Whenever possible, these four standard register names are available on |
| 8612 | your machine even though the machine has different canonical mnemonics, |
| 8613 | so long as there is no conflict. The @code{info registers} command |
| 8614 | shows the canonical names. For example, on the SPARC, @code{info |
| 8615 | registers} displays the processor status register as @code{$psr} but you |
| 8616 | can also refer to it as @code{$ps}; and on x86-based machines @code{$ps} |
| 8617 | is an alias for the @sc{eflags} register. |
| 8618 | |
| 8619 | @value{GDBN} always considers the contents of an ordinary register as an |
| 8620 | integer when the register is examined in this way. Some machines have |
| 8621 | special registers which can hold nothing but floating point; these |
| 8622 | registers are considered to have floating point values. There is no way |
| 8623 | to refer to the contents of an ordinary register as floating point value |
| 8624 | (although you can @emph{print} it as a floating point value with |
| 8625 | @samp{print/f $@var{regname}}). |
| 8626 | |
| 8627 | Some registers have distinct ``raw'' and ``virtual'' data formats. This |
| 8628 | means that the data format in which the register contents are saved by |
| 8629 | the operating system is not the same one that your program normally |
| 8630 | sees. For example, the registers of the 68881 floating point |
| 8631 | coprocessor are always saved in ``extended'' (raw) format, but all C |
| 8632 | programs expect to work with ``double'' (virtual) format. In such |
| 8633 | cases, @value{GDBN} normally works with the virtual format only (the format |
| 8634 | that makes sense for your program), but the @code{info registers} command |
| 8635 | prints the data in both formats. |
| 8636 | |
| 8637 | @cindex SSE registers (x86) |
| 8638 | @cindex MMX registers (x86) |
| 8639 | Some machines have special registers whose contents can be interpreted |
| 8640 | in several different ways. For example, modern x86-based machines |
| 8641 | have SSE and MMX registers that can hold several values packed |
| 8642 | together in several different formats. @value{GDBN} refers to such |
| 8643 | registers in @code{struct} notation: |
| 8644 | |
| 8645 | @smallexample |
| 8646 | (@value{GDBP}) print $xmm1 |
| 8647 | $1 = @{ |
| 8648 | v4_float = @{0, 3.43859137e-038, 1.54142831e-044, 1.821688e-044@}, |
| 8649 | v2_double = @{9.92129282474342e-303, 2.7585945287983262e-313@}, |
| 8650 | v16_int8 = "\000\000\000\000\3706;\001\v\000\000\000\r\000\000", |
| 8651 | v8_int16 = @{0, 0, 14072, 315, 11, 0, 13, 0@}, |
| 8652 | v4_int32 = @{0, 20657912, 11, 13@}, |
| 8653 | v2_int64 = @{88725056443645952, 55834574859@}, |
| 8654 | uint128 = 0x0000000d0000000b013b36f800000000 |
| 8655 | @} |
| 8656 | @end smallexample |
| 8657 | |
| 8658 | @noindent |
| 8659 | To set values of such registers, you need to tell @value{GDBN} which |
| 8660 | view of the register you wish to change, as if you were assigning |
| 8661 | value to a @code{struct} member: |
| 8662 | |
| 8663 | @smallexample |
| 8664 | (@value{GDBP}) set $xmm1.uint128 = 0x000000000000000000000000FFFFFFFF |
| 8665 | @end smallexample |
| 8666 | |
| 8667 | Normally, register values are relative to the selected stack frame |
| 8668 | (@pxref{Selection, ,Selecting a Frame}). This means that you get the |
| 8669 | value that the register would contain if all stack frames farther in |
| 8670 | were exited and their saved registers restored. In order to see the |
| 8671 | true contents of hardware registers, you must select the innermost |
| 8672 | frame (with @samp{frame 0}). |
| 8673 | |
| 8674 | However, @value{GDBN} must deduce where registers are saved, from the machine |
| 8675 | code generated by your compiler. If some registers are not saved, or if |
| 8676 | @value{GDBN} is unable to locate the saved registers, the selected stack |
| 8677 | frame makes no difference. |
| 8678 | |
| 8679 | @node Floating Point Hardware |
| 8680 | @section Floating Point Hardware |
| 8681 | @cindex floating point |
| 8682 | |
| 8683 | Depending on the configuration, @value{GDBN} may be able to give |
| 8684 | you more information about the status of the floating point hardware. |
| 8685 | |
| 8686 | @table @code |
| 8687 | @kindex info float |
| 8688 | @item info float |
| 8689 | Display hardware-dependent information about the floating |
| 8690 | point unit. The exact contents and layout vary depending on the |
| 8691 | floating point chip. Currently, @samp{info float} is supported on |
| 8692 | the ARM and x86 machines. |
| 8693 | @end table |
| 8694 | |
| 8695 | @node Vector Unit |
| 8696 | @section Vector Unit |
| 8697 | @cindex vector unit |
| 8698 | |
| 8699 | Depending on the configuration, @value{GDBN} may be able to give you |
| 8700 | more information about the status of the vector unit. |
| 8701 | |
| 8702 | @table @code |
| 8703 | @kindex info vector |
| 8704 | @item info vector |
| 8705 | Display information about the vector unit. The exact contents and |
| 8706 | layout vary depending on the hardware. |
| 8707 | @end table |
| 8708 | |
| 8709 | @node OS Information |
| 8710 | @section Operating System Auxiliary Information |
| 8711 | @cindex OS information |
| 8712 | |
| 8713 | @value{GDBN} provides interfaces to useful OS facilities that can help |
| 8714 | you debug your program. |
| 8715 | |
| 8716 | @cindex @code{ptrace} system call |
| 8717 | @cindex @code{struct user} contents |
| 8718 | When @value{GDBN} runs on a @dfn{Posix system} (such as GNU or Unix |
| 8719 | machines), it interfaces with the inferior via the @code{ptrace} |
| 8720 | system call. The operating system creates a special sata structure, |
| 8721 | called @code{struct user}, for this interface. You can use the |
| 8722 | command @code{info udot} to display the contents of this data |
| 8723 | structure. |
| 8724 | |
| 8725 | @table @code |
| 8726 | @item info udot |
| 8727 | @kindex info udot |
| 8728 | Display the contents of the @code{struct user} maintained by the OS |
| 8729 | kernel for the program being debugged. @value{GDBN} displays the |
| 8730 | contents of @code{struct user} as a list of hex numbers, similar to |
| 8731 | the @code{examine} command. |
| 8732 | @end table |
| 8733 | |
| 8734 | @cindex auxiliary vector |
| 8735 | @cindex vector, auxiliary |
| 8736 | Some operating systems supply an @dfn{auxiliary vector} to programs at |
| 8737 | startup. This is akin to the arguments and environment that you |
| 8738 | specify for a program, but contains a system-dependent variety of |
| 8739 | binary values that tell system libraries important details about the |
| 8740 | hardware, operating system, and process. Each value's purpose is |
| 8741 | identified by an integer tag; the meanings are well-known but system-specific. |
| 8742 | Depending on the configuration and operating system facilities, |
| 8743 | @value{GDBN} may be able to show you this information. For remote |
| 8744 | targets, this functionality may further depend on the remote stub's |
| 8745 | support of the @samp{qXfer:auxv:read} packet, see |
| 8746 | @ref{qXfer auxiliary vector read}. |
| 8747 | |
| 8748 | @table @code |
| 8749 | @kindex info auxv |
| 8750 | @item info auxv |
| 8751 | Display the auxiliary vector of the inferior, which can be either a |
| 8752 | live process or a core dump file. @value{GDBN} prints each tag value |
| 8753 | numerically, and also shows names and text descriptions for recognized |
| 8754 | tags. Some values in the vector are numbers, some bit masks, and some |
| 8755 | pointers to strings or other data. @value{GDBN} displays each value in the |
| 8756 | most appropriate form for a recognized tag, and in hexadecimal for |
| 8757 | an unrecognized tag. |
| 8758 | @end table |
| 8759 | |
| 8760 | On some targets, @value{GDBN} can access operating-system-specific information |
| 8761 | and display it to user, without interpretation. For remote targets, |
| 8762 | this functionality depends on the remote stub's support of the |
| 8763 | @samp{qXfer:osdata:read} packet, see @ref{qXfer osdata read}. |
| 8764 | |
| 8765 | @table @code |
| 8766 | @kindex info os |
| 8767 | @item info os |
| 8768 | List the types of OS information available for the target. If the |
| 8769 | target does not return a list of possible types, this command will |
| 8770 | report an error. |
| 8771 | |
| 8772 | @kindex info os processes |
| 8773 | @item info os processes |
| 8774 | Display the list of processes on the target. For each process, |
| 8775 | @value{GDBN} prints the process identifier, the name of the user, and |
| 8776 | the command corresponding to the process. |
| 8777 | @end table |
| 8778 | |
| 8779 | @node Memory Region Attributes |
| 8780 | @section Memory Region Attributes |
| 8781 | @cindex memory region attributes |
| 8782 | |
| 8783 | @dfn{Memory region attributes} allow you to describe special handling |
| 8784 | required by regions of your target's memory. @value{GDBN} uses |
| 8785 | attributes to determine whether to allow certain types of memory |
| 8786 | accesses; whether to use specific width accesses; and whether to cache |
| 8787 | target memory. By default the description of memory regions is |
| 8788 | fetched from the target (if the current target supports this), but the |
| 8789 | user can override the fetched regions. |
| 8790 | |
| 8791 | Defined memory regions can be individually enabled and disabled. When a |
| 8792 | memory region is disabled, @value{GDBN} uses the default attributes when |
| 8793 | accessing memory in that region. Similarly, if no memory regions have |
| 8794 | been defined, @value{GDBN} uses the default attributes when accessing |
| 8795 | all memory. |
| 8796 | |
| 8797 | When a memory region is defined, it is given a number to identify it; |
| 8798 | to enable, disable, or remove a memory region, you specify that number. |
| 8799 | |
| 8800 | @table @code |
| 8801 | @kindex mem |
| 8802 | @item mem @var{lower} @var{upper} @var{attributes}@dots{} |
| 8803 | Define a memory region bounded by @var{lower} and @var{upper} with |
| 8804 | attributes @var{attributes}@dots{}, and add it to the list of regions |
| 8805 | monitored by @value{GDBN}. Note that @var{upper} == 0 is a special |
| 8806 | case: it is treated as the target's maximum memory address. |
| 8807 | (0xffff on 16 bit targets, 0xffffffff on 32 bit targets, etc.) |
| 8808 | |
| 8809 | @item mem auto |
| 8810 | Discard any user changes to the memory regions and use target-supplied |
| 8811 | regions, if available, or no regions if the target does not support. |
| 8812 | |
| 8813 | @kindex delete mem |
| 8814 | @item delete mem @var{nums}@dots{} |
| 8815 | Remove memory regions @var{nums}@dots{} from the list of regions |
| 8816 | monitored by @value{GDBN}. |
| 8817 | |
| 8818 | @kindex disable mem |
| 8819 | @item disable mem @var{nums}@dots{} |
| 8820 | Disable monitoring of memory regions @var{nums}@dots{}. |
| 8821 | A disabled memory region is not forgotten. |
| 8822 | It may be enabled again later. |
| 8823 | |
| 8824 | @kindex enable mem |
| 8825 | @item enable mem @var{nums}@dots{} |
| 8826 | Enable monitoring of memory regions @var{nums}@dots{}. |
| 8827 | |
| 8828 | @kindex info mem |
| 8829 | @item info mem |
| 8830 | Print a table of all defined memory regions, with the following columns |
| 8831 | for each region: |
| 8832 | |
| 8833 | @table @emph |
| 8834 | @item Memory Region Number |
| 8835 | @item Enabled or Disabled. |
| 8836 | Enabled memory regions are marked with @samp{y}. |
| 8837 | Disabled memory regions are marked with @samp{n}. |
| 8838 | |
| 8839 | @item Lo Address |
| 8840 | The address defining the inclusive lower bound of the memory region. |
| 8841 | |
| 8842 | @item Hi Address |
| 8843 | The address defining the exclusive upper bound of the memory region. |
| 8844 | |
| 8845 | @item Attributes |
| 8846 | The list of attributes set for this memory region. |
| 8847 | @end table |
| 8848 | @end table |
| 8849 | |
| 8850 | |
| 8851 | @subsection Attributes |
| 8852 | |
| 8853 | @subsubsection Memory Access Mode |
| 8854 | The access mode attributes set whether @value{GDBN} may make read or |
| 8855 | write accesses to a memory region. |
| 8856 | |
| 8857 | While these attributes prevent @value{GDBN} from performing invalid |
| 8858 | memory accesses, they do nothing to prevent the target system, I/O DMA, |
| 8859 | etc.@: from accessing memory. |
| 8860 | |
| 8861 | @table @code |
| 8862 | @item ro |
| 8863 | Memory is read only. |
| 8864 | @item wo |
| 8865 | Memory is write only. |
| 8866 | @item rw |
| 8867 | Memory is read/write. This is the default. |
| 8868 | @end table |
| 8869 | |
| 8870 | @subsubsection Memory Access Size |
| 8871 | The access size attribute tells @value{GDBN} to use specific sized |
| 8872 | accesses in the memory region. Often memory mapped device registers |
| 8873 | require specific sized accesses. If no access size attribute is |
| 8874 | specified, @value{GDBN} may use accesses of any size. |
| 8875 | |
| 8876 | @table @code |
| 8877 | @item 8 |
| 8878 | Use 8 bit memory accesses. |
| 8879 | @item 16 |
| 8880 | Use 16 bit memory accesses. |
| 8881 | @item 32 |
| 8882 | Use 32 bit memory accesses. |
| 8883 | @item 64 |
| 8884 | Use 64 bit memory accesses. |
| 8885 | @end table |
| 8886 | |
| 8887 | @c @subsubsection Hardware/Software Breakpoints |
| 8888 | @c The hardware/software breakpoint attributes set whether @value{GDBN} |
| 8889 | @c will use hardware or software breakpoints for the internal breakpoints |
| 8890 | @c used by the step, next, finish, until, etc. commands. |
| 8891 | @c |
| 8892 | @c @table @code |
| 8893 | @c @item hwbreak |
| 8894 | @c Always use hardware breakpoints |
| 8895 | @c @item swbreak (default) |
| 8896 | @c @end table |
| 8897 | |
| 8898 | @subsubsection Data Cache |
| 8899 | The data cache attributes set whether @value{GDBN} will cache target |
| 8900 | memory. While this generally improves performance by reducing debug |
| 8901 | protocol overhead, it can lead to incorrect results because @value{GDBN} |
| 8902 | does not know about volatile variables or memory mapped device |
| 8903 | registers. |
| 8904 | |
| 8905 | @table @code |
| 8906 | @item cache |
| 8907 | Enable @value{GDBN} to cache target memory. |
| 8908 | @item nocache |
| 8909 | Disable @value{GDBN} from caching target memory. This is the default. |
| 8910 | @end table |
| 8911 | |
| 8912 | @subsection Memory Access Checking |
| 8913 | @value{GDBN} can be instructed to refuse accesses to memory that is |
| 8914 | not explicitly described. This can be useful if accessing such |
| 8915 | regions has undesired effects for a specific target, or to provide |
| 8916 | better error checking. The following commands control this behaviour. |
| 8917 | |
| 8918 | @table @code |
| 8919 | @kindex set mem inaccessible-by-default |
| 8920 | @item set mem inaccessible-by-default [on|off] |
| 8921 | If @code{on} is specified, make @value{GDBN} treat memory not |
| 8922 | explicitly described by the memory ranges as non-existent and refuse accesses |
| 8923 | to such memory. The checks are only performed if there's at least one |
| 8924 | memory range defined. If @code{off} is specified, make @value{GDBN} |
| 8925 | treat the memory not explicitly described by the memory ranges as RAM. |
| 8926 | The default value is @code{on}. |
| 8927 | @kindex show mem inaccessible-by-default |
| 8928 | @item show mem inaccessible-by-default |
| 8929 | Show the current handling of accesses to unknown memory. |
| 8930 | @end table |
| 8931 | |
| 8932 | |
| 8933 | @c @subsubsection Memory Write Verification |
| 8934 | @c The memory write verification attributes set whether @value{GDBN} |
| 8935 | @c will re-reads data after each write to verify the write was successful. |
| 8936 | @c |
| 8937 | @c @table @code |
| 8938 | @c @item verify |
| 8939 | @c @item noverify (default) |
| 8940 | @c @end table |
| 8941 | |
| 8942 | @node Dump/Restore Files |
| 8943 | @section Copy Between Memory and a File |
| 8944 | @cindex dump/restore files |
| 8945 | @cindex append data to a file |
| 8946 | @cindex dump data to a file |
| 8947 | @cindex restore data from a file |
| 8948 | |
| 8949 | You can use the commands @code{dump}, @code{append}, and |
| 8950 | @code{restore} to copy data between target memory and a file. The |
| 8951 | @code{dump} and @code{append} commands write data to a file, and the |
| 8952 | @code{restore} command reads data from a file back into the inferior's |
| 8953 | memory. Files may be in binary, Motorola S-record, Intel hex, or |
| 8954 | Tektronix Hex format; however, @value{GDBN} can only append to binary |
| 8955 | files. |
| 8956 | |
| 8957 | @table @code |
| 8958 | |
| 8959 | @kindex dump |
| 8960 | @item dump @r{[}@var{format}@r{]} memory @var{filename} @var{start_addr} @var{end_addr} |
| 8961 | @itemx dump @r{[}@var{format}@r{]} value @var{filename} @var{expr} |
| 8962 | Dump the contents of memory from @var{start_addr} to @var{end_addr}, |
| 8963 | or the value of @var{expr}, to @var{filename} in the given format. |
| 8964 | |
| 8965 | The @var{format} parameter may be any one of: |
| 8966 | @table @code |
| 8967 | @item binary |
| 8968 | Raw binary form. |
| 8969 | @item ihex |
| 8970 | Intel hex format. |
| 8971 | @item srec |
| 8972 | Motorola S-record format. |
| 8973 | @item tekhex |
| 8974 | Tektronix Hex format. |
| 8975 | @end table |
| 8976 | |
| 8977 | @value{GDBN} uses the same definitions of these formats as the |
| 8978 | @sc{gnu} binary utilities, like @samp{objdump} and @samp{objcopy}. If |
| 8979 | @var{format} is omitted, @value{GDBN} dumps the data in raw binary |
| 8980 | form. |
| 8981 | |
| 8982 | @kindex append |
| 8983 | @item append @r{[}binary@r{]} memory @var{filename} @var{start_addr} @var{end_addr} |
| 8984 | @itemx append @r{[}binary@r{]} value @var{filename} @var{expr} |
| 8985 | Append the contents of memory from @var{start_addr} to @var{end_addr}, |
| 8986 | or the value of @var{expr}, to the file @var{filename}, in raw binary form. |
| 8987 | (@value{GDBN} can only append data to files in raw binary form.) |
| 8988 | |
| 8989 | @kindex restore |
| 8990 | @item restore @var{filename} @r{[}binary@r{]} @var{bias} @var{start} @var{end} |
| 8991 | Restore the contents of file @var{filename} into memory. The |
| 8992 | @code{restore} command can automatically recognize any known @sc{bfd} |
| 8993 | file format, except for raw binary. To restore a raw binary file you |
| 8994 | must specify the optional keyword @code{binary} after the filename. |
| 8995 | |
| 8996 | If @var{bias} is non-zero, its value will be added to the addresses |
| 8997 | contained in the file. Binary files always start at address zero, so |
| 8998 | they will be restored at address @var{bias}. Other bfd files have |
| 8999 | a built-in location; they will be restored at offset @var{bias} |
| 9000 | from that location. |
| 9001 | |
| 9002 | If @var{start} and/or @var{end} are non-zero, then only data between |
| 9003 | file offset @var{start} and file offset @var{end} will be restored. |
| 9004 | These offsets are relative to the addresses in the file, before |
| 9005 | the @var{bias} argument is applied. |
| 9006 | |
| 9007 | @end table |
| 9008 | |
| 9009 | @node Core File Generation |
| 9010 | @section How to Produce a Core File from Your Program |
| 9011 | @cindex dump core from inferior |
| 9012 | |
| 9013 | A @dfn{core file} or @dfn{core dump} is a file that records the memory |
| 9014 | image of a running process and its process status (register values |
| 9015 | etc.). Its primary use is post-mortem debugging of a program that |
| 9016 | crashed while it ran outside a debugger. A program that crashes |
| 9017 | automatically produces a core file, unless this feature is disabled by |
| 9018 | the user. @xref{Files}, for information on invoking @value{GDBN} in |
| 9019 | the post-mortem debugging mode. |
| 9020 | |
| 9021 | Occasionally, you may wish to produce a core file of the program you |
| 9022 | are debugging in order to preserve a snapshot of its state. |
| 9023 | @value{GDBN} has a special command for that. |
| 9024 | |
| 9025 | @table @code |
| 9026 | @kindex gcore |
| 9027 | @kindex generate-core-file |
| 9028 | @item generate-core-file [@var{file}] |
| 9029 | @itemx gcore [@var{file}] |
| 9030 | Produce a core dump of the inferior process. The optional argument |
| 9031 | @var{file} specifies the file name where to put the core dump. If not |
| 9032 | specified, the file name defaults to @file{core.@var{pid}}, where |
| 9033 | @var{pid} is the inferior process ID. |
| 9034 | |
| 9035 | Note that this command is implemented only for some systems (as of |
| 9036 | this writing, @sc{gnu}/Linux, FreeBSD, Solaris, Unixware, and S390). |
| 9037 | @end table |
| 9038 | |
| 9039 | @node Character Sets |
| 9040 | @section Character Sets |
| 9041 | @cindex character sets |
| 9042 | @cindex charset |
| 9043 | @cindex translating between character sets |
| 9044 | @cindex host character set |
| 9045 | @cindex target character set |
| 9046 | |
| 9047 | If the program you are debugging uses a different character set to |
| 9048 | represent characters and strings than the one @value{GDBN} uses itself, |
| 9049 | @value{GDBN} can automatically translate between the character sets for |
| 9050 | you. The character set @value{GDBN} uses we call the @dfn{host |
| 9051 | character set}; the one the inferior program uses we call the |
| 9052 | @dfn{target character set}. |
| 9053 | |
| 9054 | For example, if you are running @value{GDBN} on a @sc{gnu}/Linux system, which |
| 9055 | uses the ISO Latin 1 character set, but you are using @value{GDBN}'s |
| 9056 | remote protocol (@pxref{Remote Debugging}) to debug a program |
| 9057 | running on an IBM mainframe, which uses the @sc{ebcdic} character set, |
| 9058 | then the host character set is Latin-1, and the target character set is |
| 9059 | @sc{ebcdic}. If you give @value{GDBN} the command @code{set |
| 9060 | target-charset EBCDIC-US}, then @value{GDBN} translates between |
| 9061 | @sc{ebcdic} and Latin 1 as you print character or string values, or use |
| 9062 | character and string literals in expressions. |
| 9063 | |
| 9064 | @value{GDBN} has no way to automatically recognize which character set |
| 9065 | the inferior program uses; you must tell it, using the @code{set |
| 9066 | target-charset} command, described below. |
| 9067 | |
| 9068 | Here are the commands for controlling @value{GDBN}'s character set |
| 9069 | support: |
| 9070 | |
| 9071 | @table @code |
| 9072 | @item set target-charset @var{charset} |
| 9073 | @kindex set target-charset |
| 9074 | Set the current target character set to @var{charset}. To display the |
| 9075 | list of supported target character sets, type |
| 9076 | @kbd{@w{set target-charset @key{TAB}@key{TAB}}}. |
| 9077 | |
| 9078 | @item set host-charset @var{charset} |
| 9079 | @kindex set host-charset |
| 9080 | Set the current host character set to @var{charset}. |
| 9081 | |
| 9082 | By default, @value{GDBN} uses a host character set appropriate to the |
| 9083 | system it is running on; you can override that default using the |
| 9084 | @code{set host-charset} command. On some systems, @value{GDBN} cannot |
| 9085 | automatically determine the appropriate host character set. In this |
| 9086 | case, @value{GDBN} uses @samp{UTF-8}. |
| 9087 | |
| 9088 | @value{GDBN} can only use certain character sets as its host character |
| 9089 | set. If you type @kbd{@w{set host-charset @key{TAB}@key{TAB}}}, |
| 9090 | @value{GDBN} will list the host character sets it supports. |
| 9091 | |
| 9092 | @item set charset @var{charset} |
| 9093 | @kindex set charset |
| 9094 | Set the current host and target character sets to @var{charset}. As |
| 9095 | above, if you type @kbd{@w{set charset @key{TAB}@key{TAB}}}, |
| 9096 | @value{GDBN} will list the names of the character sets that can be used |
| 9097 | for both host and target. |
| 9098 | |
| 9099 | @item show charset |
| 9100 | @kindex show charset |
| 9101 | Show the names of the current host and target character sets. |
| 9102 | |
| 9103 | @item show host-charset |
| 9104 | @kindex show host-charset |
| 9105 | Show the name of the current host character set. |
| 9106 | |
| 9107 | @item show target-charset |
| 9108 | @kindex show target-charset |
| 9109 | Show the name of the current target character set. |
| 9110 | |
| 9111 | @item set target-wide-charset @var{charset} |
| 9112 | @kindex set target-wide-charset |
| 9113 | Set the current target's wide character set to @var{charset}. This is |
| 9114 | the character set used by the target's @code{wchar_t} type. To |
| 9115 | display the list of supported wide character sets, type |
| 9116 | @kbd{@w{set target-wide-charset @key{TAB}@key{TAB}}}. |
| 9117 | |
| 9118 | @item show target-wide-charset |
| 9119 | @kindex show target-wide-charset |
| 9120 | Show the name of the current target's wide character set. |
| 9121 | @end table |
| 9122 | |
| 9123 | Here is an example of @value{GDBN}'s character set support in action. |
| 9124 | Assume that the following source code has been placed in the file |
| 9125 | @file{charset-test.c}: |
| 9126 | |
| 9127 | @smallexample |
| 9128 | #include <stdio.h> |
| 9129 | |
| 9130 | char ascii_hello[] |
| 9131 | = @{72, 101, 108, 108, 111, 44, 32, 119, |
| 9132 | 111, 114, 108, 100, 33, 10, 0@}; |
| 9133 | char ibm1047_hello[] |
| 9134 | = @{200, 133, 147, 147, 150, 107, 64, 166, |
| 9135 | 150, 153, 147, 132, 90, 37, 0@}; |
| 9136 | |
| 9137 | main () |
| 9138 | @{ |
| 9139 | printf ("Hello, world!\n"); |
| 9140 | @} |
| 9141 | @end smallexample |
| 9142 | |
| 9143 | In this program, @code{ascii_hello} and @code{ibm1047_hello} are arrays |
| 9144 | containing the string @samp{Hello, world!} followed by a newline, |
| 9145 | encoded in the @sc{ascii} and @sc{ibm1047} character sets. |
| 9146 | |
| 9147 | We compile the program, and invoke the debugger on it: |
| 9148 | |
| 9149 | @smallexample |
| 9150 | $ gcc -g charset-test.c -o charset-test |
| 9151 | $ gdb -nw charset-test |
| 9152 | GNU gdb 2001-12-19-cvs |
| 9153 | Copyright 2001 Free Software Foundation, Inc. |
| 9154 | @dots{} |
| 9155 | (@value{GDBP}) |
| 9156 | @end smallexample |
| 9157 | |
| 9158 | We can use the @code{show charset} command to see what character sets |
| 9159 | @value{GDBN} is currently using to interpret and display characters and |
| 9160 | strings: |
| 9161 | |
| 9162 | @smallexample |
| 9163 | (@value{GDBP}) show charset |
| 9164 | The current host and target character set is `ISO-8859-1'. |
| 9165 | (@value{GDBP}) |
| 9166 | @end smallexample |
| 9167 | |
| 9168 | For the sake of printing this manual, let's use @sc{ascii} as our |
| 9169 | initial character set: |
| 9170 | @smallexample |
| 9171 | (@value{GDBP}) set charset ASCII |
| 9172 | (@value{GDBP}) show charset |
| 9173 | The current host and target character set is `ASCII'. |
| 9174 | (@value{GDBP}) |
| 9175 | @end smallexample |
| 9176 | |
| 9177 | Let's assume that @sc{ascii} is indeed the correct character set for our |
| 9178 | host system --- in other words, let's assume that if @value{GDBN} prints |
| 9179 | characters using the @sc{ascii} character set, our terminal will display |
| 9180 | them properly. Since our current target character set is also |
| 9181 | @sc{ascii}, the contents of @code{ascii_hello} print legibly: |
| 9182 | |
| 9183 | @smallexample |
| 9184 | (@value{GDBP}) print ascii_hello |
| 9185 | $1 = 0x401698 "Hello, world!\n" |
| 9186 | (@value{GDBP}) print ascii_hello[0] |
| 9187 | $2 = 72 'H' |
| 9188 | (@value{GDBP}) |
| 9189 | @end smallexample |
| 9190 | |
| 9191 | @value{GDBN} uses the target character set for character and string |
| 9192 | literals you use in expressions: |
| 9193 | |
| 9194 | @smallexample |
| 9195 | (@value{GDBP}) print '+' |
| 9196 | $3 = 43 '+' |
| 9197 | (@value{GDBP}) |
| 9198 | @end smallexample |
| 9199 | |
| 9200 | The @sc{ascii} character set uses the number 43 to encode the @samp{+} |
| 9201 | character. |
| 9202 | |
| 9203 | @value{GDBN} relies on the user to tell it which character set the |
| 9204 | target program uses. If we print @code{ibm1047_hello} while our target |
| 9205 | character set is still @sc{ascii}, we get jibberish: |
| 9206 | |
| 9207 | @smallexample |
| 9208 | (@value{GDBP}) print ibm1047_hello |
| 9209 | $4 = 0x4016a8 "\310\205\223\223\226k@@\246\226\231\223\204Z%" |
| 9210 | (@value{GDBP}) print ibm1047_hello[0] |
| 9211 | $5 = 200 '\310' |
| 9212 | (@value{GDBP}) |
| 9213 | @end smallexample |
| 9214 | |
| 9215 | If we invoke the @code{set target-charset} followed by @key{TAB}@key{TAB}, |
| 9216 | @value{GDBN} tells us the character sets it supports: |
| 9217 | |
| 9218 | @smallexample |
| 9219 | (@value{GDBP}) set target-charset |
| 9220 | ASCII EBCDIC-US IBM1047 ISO-8859-1 |
| 9221 | (@value{GDBP}) set target-charset |
| 9222 | @end smallexample |
| 9223 | |
| 9224 | We can select @sc{ibm1047} as our target character set, and examine the |
| 9225 | program's strings again. Now the @sc{ascii} string is wrong, but |
| 9226 | @value{GDBN} translates the contents of @code{ibm1047_hello} from the |
| 9227 | target character set, @sc{ibm1047}, to the host character set, |
| 9228 | @sc{ascii}, and they display correctly: |
| 9229 | |
| 9230 | @smallexample |
| 9231 | (@value{GDBP}) set target-charset IBM1047 |
| 9232 | (@value{GDBP}) show charset |
| 9233 | The current host character set is `ASCII'. |
| 9234 | The current target character set is `IBM1047'. |
| 9235 | (@value{GDBP}) print ascii_hello |
| 9236 | $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012" |
| 9237 | (@value{GDBP}) print ascii_hello[0] |
| 9238 | $7 = 72 '\110' |
| 9239 | (@value{GDBP}) print ibm1047_hello |
| 9240 | $8 = 0x4016a8 "Hello, world!\n" |
| 9241 | (@value{GDBP}) print ibm1047_hello[0] |
| 9242 | $9 = 200 'H' |
| 9243 | (@value{GDBP}) |
| 9244 | @end smallexample |
| 9245 | |
| 9246 | As above, @value{GDBN} uses the target character set for character and |
| 9247 | string literals you use in expressions: |
| 9248 | |
| 9249 | @smallexample |
| 9250 | (@value{GDBP}) print '+' |
| 9251 | $10 = 78 '+' |
| 9252 | (@value{GDBP}) |
| 9253 | @end smallexample |
| 9254 | |
| 9255 | The @sc{ibm1047} character set uses the number 78 to encode the @samp{+} |
| 9256 | character. |
| 9257 | |
| 9258 | @node Caching Remote Data |
| 9259 | @section Caching Data of Remote Targets |
| 9260 | @cindex caching data of remote targets |
| 9261 | |
| 9262 | @value{GDBN} caches data exchanged between the debugger and a |
| 9263 | remote target (@pxref{Remote Debugging}). Such caching generally improves |
| 9264 | performance, because it reduces the overhead of the remote protocol by |
| 9265 | bundling memory reads and writes into large chunks. Unfortunately, simply |
| 9266 | caching everything would lead to incorrect results, since @value{GDBN} |
| 9267 | does not necessarily know anything about volatile values, memory-mapped I/O |
| 9268 | addresses, etc. Furthermore, in non-stop mode (@pxref{Non-Stop Mode}) |
| 9269 | memory can be changed @emph{while} a gdb command is executing. |
| 9270 | Therefore, by default, @value{GDBN} only caches data |
| 9271 | known to be on the stack@footnote{In non-stop mode, it is moderately |
| 9272 | rare for a running thread to modify the stack of a stopped thread |
| 9273 | in a way that would interfere with a backtrace, and caching of |
| 9274 | stack reads provides a significant speed up of remote backtraces.}. |
| 9275 | Other regions of memory can be explicitly marked as |
| 9276 | cacheable; see @pxref{Memory Region Attributes}. |
| 9277 | |
| 9278 | @table @code |
| 9279 | @kindex set remotecache |
| 9280 | @item set remotecache on |
| 9281 | @itemx set remotecache off |
| 9282 | This option no longer does anything; it exists for compatibility |
| 9283 | with old scripts. |
| 9284 | |
| 9285 | @kindex show remotecache |
| 9286 | @item show remotecache |
| 9287 | Show the current state of the obsolete remotecache flag. |
| 9288 | |
| 9289 | @kindex set stack-cache |
| 9290 | @item set stack-cache on |
| 9291 | @itemx set stack-cache off |
| 9292 | Enable or disable caching of stack accesses. When @code{ON}, use |
| 9293 | caching. By default, this option is @code{ON}. |
| 9294 | |
| 9295 | @kindex show stack-cache |
| 9296 | @item show stack-cache |
| 9297 | Show the current state of data caching for memory accesses. |
| 9298 | |
| 9299 | @kindex info dcache |
| 9300 | @item info dcache @r{[}line@r{]} |
| 9301 | Print the information about the data cache performance. The |
| 9302 | information displayed includes the dcache width and depth, and for |
| 9303 | each cache line, its number, address, and how many times it was |
| 9304 | referenced. This command is useful for debugging the data cache |
| 9305 | operation. |
| 9306 | |
| 9307 | If a line number is specified, the contents of that line will be |
| 9308 | printed in hex. |
| 9309 | @end table |
| 9310 | |
| 9311 | @node Searching Memory |
| 9312 | @section Search Memory |
| 9313 | @cindex searching memory |
| 9314 | |
| 9315 | Memory can be searched for a particular sequence of bytes with the |
| 9316 | @code{find} command. |
| 9317 | |
| 9318 | @table @code |
| 9319 | @kindex find |
| 9320 | @item find @r{[}/@var{sn}@r{]} @var{start_addr}, +@var{len}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]} |
| 9321 | @itemx find @r{[}/@var{sn}@r{]} @var{start_addr}, @var{end_addr}, @var{val1} @r{[}, @var{val2}, @dots{}@r{]} |
| 9322 | Search memory for the sequence of bytes specified by @var{val1}, @var{val2}, |
| 9323 | etc. The search begins at address @var{start_addr} and continues for either |
| 9324 | @var{len} bytes or through to @var{end_addr} inclusive. |
| 9325 | @end table |
| 9326 | |
| 9327 | @var{s} and @var{n} are optional parameters. |
| 9328 | They may be specified in either order, apart or together. |
| 9329 | |
| 9330 | @table @r |
| 9331 | @item @var{s}, search query size |
| 9332 | The size of each search query value. |
| 9333 | |
| 9334 | @table @code |
| 9335 | @item b |
| 9336 | bytes |
| 9337 | @item h |
| 9338 | halfwords (two bytes) |
| 9339 | @item w |
| 9340 | words (four bytes) |
| 9341 | @item g |
| 9342 | giant words (eight bytes) |
| 9343 | @end table |
| 9344 | |
| 9345 | All values are interpreted in the current language. |
| 9346 | This means, for example, that if the current source language is C/C@t{++} |
| 9347 | then searching for the string ``hello'' includes the trailing '\0'. |
| 9348 | |
| 9349 | If the value size is not specified, it is taken from the |
| 9350 | value's type in the current language. |
| 9351 | This is useful when one wants to specify the search |
| 9352 | pattern as a mixture of types. |
| 9353 | Note that this means, for example, that in the case of C-like languages |
| 9354 | a search for an untyped 0x42 will search for @samp{(int) 0x42} |
| 9355 | which is typically four bytes. |
| 9356 | |
| 9357 | @item @var{n}, maximum number of finds |
| 9358 | The maximum number of matches to print. The default is to print all finds. |
| 9359 | @end table |
| 9360 | |
| 9361 | You can use strings as search values. Quote them with double-quotes |
| 9362 | (@code{"}). |
| 9363 | The string value is copied into the search pattern byte by byte, |
| 9364 | regardless of the endianness of the target and the size specification. |
| 9365 | |
| 9366 | The address of each match found is printed as well as a count of the |
| 9367 | number of matches found. |
| 9368 | |
| 9369 | The address of the last value found is stored in convenience variable |
| 9370 | @samp{$_}. |
| 9371 | A count of the number of matches is stored in @samp{$numfound}. |
| 9372 | |
| 9373 | For example, if stopped at the @code{printf} in this function: |
| 9374 | |
| 9375 | @smallexample |
| 9376 | void |
| 9377 | hello () |
| 9378 | @{ |
| 9379 | static char hello[] = "hello-hello"; |
| 9380 | static struct @{ char c; short s; int i; @} |
| 9381 | __attribute__ ((packed)) mixed |
| 9382 | = @{ 'c', 0x1234, 0x87654321 @}; |
| 9383 | printf ("%s\n", hello); |
| 9384 | @} |
| 9385 | @end smallexample |
| 9386 | |
| 9387 | @noindent |
| 9388 | you get during debugging: |
| 9389 | |
| 9390 | @smallexample |
| 9391 | (gdb) find &hello[0], +sizeof(hello), "hello" |
| 9392 | 0x804956d <hello.1620+6> |
| 9393 | 1 pattern found |
| 9394 | (gdb) find &hello[0], +sizeof(hello), 'h', 'e', 'l', 'l', 'o' |
| 9395 | 0x8049567 <hello.1620> |
| 9396 | 0x804956d <hello.1620+6> |
| 9397 | 2 patterns found |
| 9398 | (gdb) find /b1 &hello[0], +sizeof(hello), 'h', 0x65, 'l' |
| 9399 | 0x8049567 <hello.1620> |
| 9400 | 1 pattern found |
| 9401 | (gdb) find &mixed, +sizeof(mixed), (char) 'c', (short) 0x1234, (int) 0x87654321 |
| 9402 | 0x8049560 <mixed.1625> |
| 9403 | 1 pattern found |
| 9404 | (gdb) print $numfound |
| 9405 | $1 = 1 |
| 9406 | (gdb) print $_ |
| 9407 | $2 = (void *) 0x8049560 |
| 9408 | @end smallexample |
| 9409 | |
| 9410 | @node Optimized Code |
| 9411 | @chapter Debugging Optimized Code |
| 9412 | @cindex optimized code, debugging |
| 9413 | @cindex debugging optimized code |
| 9414 | |
| 9415 | Almost all compilers support optimization. With optimization |
| 9416 | disabled, the compiler generates assembly code that corresponds |
| 9417 | directly to your source code, in a simplistic way. As the compiler |
| 9418 | applies more powerful optimizations, the generated assembly code |
| 9419 | diverges from your original source code. With help from debugging |
| 9420 | information generated by the compiler, @value{GDBN} can map from |
| 9421 | the running program back to constructs from your original source. |
| 9422 | |
| 9423 | @value{GDBN} is more accurate with optimization disabled. If you |
| 9424 | can recompile without optimization, it is easier to follow the |
| 9425 | progress of your program during debugging. But, there are many cases |
| 9426 | where you may need to debug an optimized version. |
| 9427 | |
| 9428 | When you debug a program compiled with @samp{-g -O}, remember that the |
| 9429 | optimizer has rearranged your code; the debugger shows you what is |
| 9430 | really there. Do not be too surprised when the execution path does not |
| 9431 | exactly match your source file! An extreme example: if you define a |
| 9432 | variable, but never use it, @value{GDBN} never sees that |
| 9433 | variable---because the compiler optimizes it out of existence. |
| 9434 | |
| 9435 | Some things do not work as well with @samp{-g -O} as with just |
| 9436 | @samp{-g}, particularly on machines with instruction scheduling. If in |
| 9437 | doubt, recompile with @samp{-g} alone, and if this fixes the problem, |
| 9438 | please report it to us as a bug (including a test case!). |
| 9439 | @xref{Variables}, for more information about debugging optimized code. |
| 9440 | |
| 9441 | @menu |
| 9442 | * Inline Functions:: How @value{GDBN} presents inlining |
| 9443 | @end menu |
| 9444 | |
| 9445 | @node Inline Functions |
| 9446 | @section Inline Functions |
| 9447 | @cindex inline functions, debugging |
| 9448 | |
| 9449 | @dfn{Inlining} is an optimization that inserts a copy of the function |
| 9450 | body directly at each call site, instead of jumping to a shared |
| 9451 | routine. @value{GDBN} displays inlined functions just like |
| 9452 | non-inlined functions. They appear in backtraces. You can view their |
| 9453 | arguments and local variables, step into them with @code{step}, skip |
| 9454 | them with @code{next}, and escape from them with @code{finish}. |
| 9455 | You can check whether a function was inlined by using the |
| 9456 | @code{info frame} command. |
| 9457 | |
| 9458 | For @value{GDBN} to support inlined functions, the compiler must |
| 9459 | record information about inlining in the debug information --- |
| 9460 | @value{NGCC} using the @sc{dwarf 2} format does this, and several |
| 9461 | other compilers do also. @value{GDBN} only supports inlined functions |
| 9462 | when using @sc{dwarf 2}. Versions of @value{NGCC} before 4.1 |
| 9463 | do not emit two required attributes (@samp{DW_AT_call_file} and |
| 9464 | @samp{DW_AT_call_line}); @value{GDBN} does not display inlined |
| 9465 | function calls with earlier versions of @value{NGCC}. It instead |
| 9466 | displays the arguments and local variables of inlined functions as |
| 9467 | local variables in the caller. |
| 9468 | |
| 9469 | The body of an inlined function is directly included at its call site; |
| 9470 | unlike a non-inlined function, there are no instructions devoted to |
| 9471 | the call. @value{GDBN} still pretends that the call site and the |
| 9472 | start of the inlined function are different instructions. Stepping to |
| 9473 | the call site shows the call site, and then stepping again shows |
| 9474 | the first line of the inlined function, even though no additional |
| 9475 | instructions are executed. |
| 9476 | |
| 9477 | This makes source-level debugging much clearer; you can see both the |
| 9478 | context of the call and then the effect of the call. Only stepping by |
| 9479 | a single instruction using @code{stepi} or @code{nexti} does not do |
| 9480 | this; single instruction steps always show the inlined body. |
| 9481 | |
| 9482 | There are some ways that @value{GDBN} does not pretend that inlined |
| 9483 | function calls are the same as normal calls: |
| 9484 | |
| 9485 | @itemize @bullet |
| 9486 | @item |
| 9487 | You cannot set breakpoints on inlined functions. @value{GDBN} |
| 9488 | either reports that there is no symbol with that name, or else sets the |
| 9489 | breakpoint only on non-inlined copies of the function. This limitation |
| 9490 | will be removed in a future version of @value{GDBN}; until then, |
| 9491 | set a breakpoint by line number on the first line of the inlined |
| 9492 | function instead. |
| 9493 | |
| 9494 | @item |
| 9495 | Setting breakpoints at the call site of an inlined function may not |
| 9496 | work, because the call site does not contain any code. @value{GDBN} |
| 9497 | may incorrectly move the breakpoint to the next line of the enclosing |
| 9498 | function, after the call. This limitation will be removed in a future |
| 9499 | version of @value{GDBN}; until then, set a breakpoint on an earlier line |
| 9500 | or inside the inlined function instead. |
| 9501 | |
| 9502 | @item |
| 9503 | @value{GDBN} cannot locate the return value of inlined calls after |
| 9504 | using the @code{finish} command. This is a limitation of compiler-generated |
| 9505 | debugging information; after @code{finish}, you can step to the next line |
| 9506 | and print a variable where your program stored the return value. |
| 9507 | |
| 9508 | @end itemize |
| 9509 | |
| 9510 | |
| 9511 | @node Macros |
| 9512 | @chapter C Preprocessor Macros |
| 9513 | |
| 9514 | Some languages, such as C and C@t{++}, provide a way to define and invoke |
| 9515 | ``preprocessor macros'' which expand into strings of tokens. |
| 9516 | @value{GDBN} can evaluate expressions containing macro invocations, show |
| 9517 | the result of macro expansion, and show a macro's definition, including |
| 9518 | where it was defined. |
| 9519 | |
| 9520 | You may need to compile your program specially to provide @value{GDBN} |
| 9521 | with information about preprocessor macros. Most compilers do not |
| 9522 | include macros in their debugging information, even when you compile |
| 9523 | with the @option{-g} flag. @xref{Compilation}. |
| 9524 | |
| 9525 | A program may define a macro at one point, remove that definition later, |
| 9526 | and then provide a different definition after that. Thus, at different |
| 9527 | points in the program, a macro may have different definitions, or have |
| 9528 | no definition at all. If there is a current stack frame, @value{GDBN} |
| 9529 | uses the macros in scope at that frame's source code line. Otherwise, |
| 9530 | @value{GDBN} uses the macros in scope at the current listing location; |
| 9531 | see @ref{List}. |
| 9532 | |
| 9533 | Whenever @value{GDBN} evaluates an expression, it always expands any |
| 9534 | macro invocations present in the expression. @value{GDBN} also provides |
| 9535 | the following commands for working with macros explicitly. |
| 9536 | |
| 9537 | @table @code |
| 9538 | |
| 9539 | @kindex macro expand |
| 9540 | @cindex macro expansion, showing the results of preprocessor |
| 9541 | @cindex preprocessor macro expansion, showing the results of |
| 9542 | @cindex expanding preprocessor macros |
| 9543 | @item macro expand @var{expression} |
| 9544 | @itemx macro exp @var{expression} |
| 9545 | Show the results of expanding all preprocessor macro invocations in |
| 9546 | @var{expression}. Since @value{GDBN} simply expands macros, but does |
| 9547 | not parse the result, @var{expression} need not be a valid expression; |
| 9548 | it can be any string of tokens. |
| 9549 | |
| 9550 | @kindex macro exp1 |
| 9551 | @item macro expand-once @var{expression} |
| 9552 | @itemx macro exp1 @var{expression} |
| 9553 | @cindex expand macro once |
| 9554 | @i{(This command is not yet implemented.)} Show the results of |
| 9555 | expanding those preprocessor macro invocations that appear explicitly in |
| 9556 | @var{expression}. Macro invocations appearing in that expansion are |
| 9557 | left unchanged. This command allows you to see the effect of a |
| 9558 | particular macro more clearly, without being confused by further |
| 9559 | expansions. Since @value{GDBN} simply expands macros, but does not |
| 9560 | parse the result, @var{expression} need not be a valid expression; it |
| 9561 | can be any string of tokens. |
| 9562 | |
| 9563 | @kindex info macro |
| 9564 | @cindex macro definition, showing |
| 9565 | @cindex definition, showing a macro's |
| 9566 | @item info macro @var{macro} |
| 9567 | Show the definition of the macro named @var{macro}, and describe the |
| 9568 | source location or compiler command-line where that definition was established. |
| 9569 | |
| 9570 | @kindex macro define |
| 9571 | @cindex user-defined macros |
| 9572 | @cindex defining macros interactively |
| 9573 | @cindex macros, user-defined |
| 9574 | @item macro define @var{macro} @var{replacement-list} |
| 9575 | @itemx macro define @var{macro}(@var{arglist}) @var{replacement-list} |
| 9576 | Introduce a definition for a preprocessor macro named @var{macro}, |
| 9577 | invocations of which are replaced by the tokens given in |
| 9578 | @var{replacement-list}. The first form of this command defines an |
| 9579 | ``object-like'' macro, which takes no arguments; the second form |
| 9580 | defines a ``function-like'' macro, which takes the arguments given in |
| 9581 | @var{arglist}. |
| 9582 | |
| 9583 | A definition introduced by this command is in scope in every |
| 9584 | expression evaluated in @value{GDBN}, until it is removed with the |
| 9585 | @code{macro undef} command, described below. The definition overrides |
| 9586 | all definitions for @var{macro} present in the program being debugged, |
| 9587 | as well as any previous user-supplied definition. |
| 9588 | |
| 9589 | @kindex macro undef |
| 9590 | @item macro undef @var{macro} |
| 9591 | Remove any user-supplied definition for the macro named @var{macro}. |
| 9592 | This command only affects definitions provided with the @code{macro |
| 9593 | define} command, described above; it cannot remove definitions present |
| 9594 | in the program being debugged. |
| 9595 | |
| 9596 | @kindex macro list |
| 9597 | @item macro list |
| 9598 | List all the macros defined using the @code{macro define} command. |
| 9599 | @end table |
| 9600 | |
| 9601 | @cindex macros, example of debugging with |
| 9602 | Here is a transcript showing the above commands in action. First, we |
| 9603 | show our source files: |
| 9604 | |
| 9605 | @smallexample |
| 9606 | $ cat sample.c |
| 9607 | #include <stdio.h> |
| 9608 | #include "sample.h" |
| 9609 | |
| 9610 | #define M 42 |
| 9611 | #define ADD(x) (M + x) |
| 9612 | |
| 9613 | main () |
| 9614 | @{ |
| 9615 | #define N 28 |
| 9616 | printf ("Hello, world!\n"); |
| 9617 | #undef N |
| 9618 | printf ("We're so creative.\n"); |
| 9619 | #define N 1729 |
| 9620 | printf ("Goodbye, world!\n"); |
| 9621 | @} |
| 9622 | $ cat sample.h |
| 9623 | #define Q < |
| 9624 | $ |
| 9625 | @end smallexample |
| 9626 | |
| 9627 | Now, we compile the program using the @sc{gnu} C compiler, @value{NGCC}. |
| 9628 | We pass the @option{-gdwarf-2} and @option{-g3} flags to ensure the |
| 9629 | compiler includes information about preprocessor macros in the debugging |
| 9630 | information. |
| 9631 | |
| 9632 | @smallexample |
| 9633 | $ gcc -gdwarf-2 -g3 sample.c -o sample |
| 9634 | $ |
| 9635 | @end smallexample |
| 9636 | |
| 9637 | Now, we start @value{GDBN} on our sample program: |
| 9638 | |
| 9639 | @smallexample |
| 9640 | $ gdb -nw sample |
| 9641 | GNU gdb 2002-05-06-cvs |
| 9642 | Copyright 2002 Free Software Foundation, Inc. |
| 9643 | GDB is free software, @dots{} |
| 9644 | (@value{GDBP}) |
| 9645 | @end smallexample |
| 9646 | |
| 9647 | We can expand macros and examine their definitions, even when the |
| 9648 | program is not running. @value{GDBN} uses the current listing position |
| 9649 | to decide which macro definitions are in scope: |
| 9650 | |
| 9651 | @smallexample |
| 9652 | (@value{GDBP}) list main |
| 9653 | 3 |
| 9654 | 4 #define M 42 |
| 9655 | 5 #define ADD(x) (M + x) |
| 9656 | 6 |
| 9657 | 7 main () |
| 9658 | 8 @{ |
| 9659 | 9 #define N 28 |
| 9660 | 10 printf ("Hello, world!\n"); |
| 9661 | 11 #undef N |
| 9662 | 12 printf ("We're so creative.\n"); |
| 9663 | (@value{GDBP}) info macro ADD |
| 9664 | Defined at /home/jimb/gdb/macros/play/sample.c:5 |
| 9665 | #define ADD(x) (M + x) |
| 9666 | (@value{GDBP}) info macro Q |
| 9667 | Defined at /home/jimb/gdb/macros/play/sample.h:1 |
| 9668 | included at /home/jimb/gdb/macros/play/sample.c:2 |
| 9669 | #define Q < |
| 9670 | (@value{GDBP}) macro expand ADD(1) |
| 9671 | expands to: (42 + 1) |
| 9672 | (@value{GDBP}) macro expand-once ADD(1) |
| 9673 | expands to: once (M + 1) |
| 9674 | (@value{GDBP}) |
| 9675 | @end smallexample |
| 9676 | |
| 9677 | In the example above, note that @code{macro expand-once} expands only |
| 9678 | the macro invocation explicit in the original text --- the invocation of |
| 9679 | @code{ADD} --- but does not expand the invocation of the macro @code{M}, |
| 9680 | which was introduced by @code{ADD}. |
| 9681 | |
| 9682 | Once the program is running, @value{GDBN} uses the macro definitions in |
| 9683 | force at the source line of the current stack frame: |
| 9684 | |
| 9685 | @smallexample |
| 9686 | (@value{GDBP}) break main |
| 9687 | Breakpoint 1 at 0x8048370: file sample.c, line 10. |
| 9688 | (@value{GDBP}) run |
| 9689 | Starting program: /home/jimb/gdb/macros/play/sample |
| 9690 | |
| 9691 | Breakpoint 1, main () at sample.c:10 |
| 9692 | 10 printf ("Hello, world!\n"); |
| 9693 | (@value{GDBP}) |
| 9694 | @end smallexample |
| 9695 | |
| 9696 | At line 10, the definition of the macro @code{N} at line 9 is in force: |
| 9697 | |
| 9698 | @smallexample |
| 9699 | (@value{GDBP}) info macro N |
| 9700 | Defined at /home/jimb/gdb/macros/play/sample.c:9 |
| 9701 | #define N 28 |
| 9702 | (@value{GDBP}) macro expand N Q M |
| 9703 | expands to: 28 < 42 |
| 9704 | (@value{GDBP}) print N Q M |
| 9705 | $1 = 1 |
| 9706 | (@value{GDBP}) |
| 9707 | @end smallexample |
| 9708 | |
| 9709 | As we step over directives that remove @code{N}'s definition, and then |
| 9710 | give it a new definition, @value{GDBN} finds the definition (or lack |
| 9711 | thereof) in force at each point: |
| 9712 | |
| 9713 | @smallexample |
| 9714 | (@value{GDBP}) next |
| 9715 | Hello, world! |
| 9716 | 12 printf ("We're so creative.\n"); |
| 9717 | (@value{GDBP}) info macro N |
| 9718 | The symbol `N' has no definition as a C/C++ preprocessor macro |
| 9719 | at /home/jimb/gdb/macros/play/sample.c:12 |
| 9720 | (@value{GDBP}) next |
| 9721 | We're so creative. |
| 9722 | 14 printf ("Goodbye, world!\n"); |
| 9723 | (@value{GDBP}) info macro N |
| 9724 | Defined at /home/jimb/gdb/macros/play/sample.c:13 |
| 9725 | #define N 1729 |
| 9726 | (@value{GDBP}) macro expand N Q M |
| 9727 | expands to: 1729 < 42 |
| 9728 | (@value{GDBP}) print N Q M |
| 9729 | $2 = 0 |
| 9730 | (@value{GDBP}) |
| 9731 | @end smallexample |
| 9732 | |
| 9733 | In addition to source files, macros can be defined on the compilation command |
| 9734 | line using the @option{-D@var{name}=@var{value}} syntax. For macros defined in |
| 9735 | such a way, @value{GDBN} displays the location of their definition as line zero |
| 9736 | of the source file submitted to the compiler. |
| 9737 | |
| 9738 | @smallexample |
| 9739 | (@value{GDBP}) info macro __STDC__ |
| 9740 | Defined at /home/jimb/gdb/macros/play/sample.c:0 |
| 9741 | -D__STDC__=1 |
| 9742 | (@value{GDBP}) |
| 9743 | @end smallexample |
| 9744 | |
| 9745 | |
| 9746 | @node Tracepoints |
| 9747 | @chapter Tracepoints |
| 9748 | @c This chapter is based on the documentation written by Michael |
| 9749 | @c Snyder, David Taylor, Jim Blandy, and Elena Zannoni. |
| 9750 | |
| 9751 | @cindex tracepoints |
| 9752 | In some applications, it is not feasible for the debugger to interrupt |
| 9753 | the program's execution long enough for the developer to learn |
| 9754 | anything helpful about its behavior. If the program's correctness |
| 9755 | depends on its real-time behavior, delays introduced by a debugger |
| 9756 | might cause the program to change its behavior drastically, or perhaps |
| 9757 | fail, even when the code itself is correct. It is useful to be able |
| 9758 | to observe the program's behavior without interrupting it. |
| 9759 | |
| 9760 | Using @value{GDBN}'s @code{trace} and @code{collect} commands, you can |
| 9761 | specify locations in the program, called @dfn{tracepoints}, and |
| 9762 | arbitrary expressions to evaluate when those tracepoints are reached. |
| 9763 | Later, using the @code{tfind} command, you can examine the values |
| 9764 | those expressions had when the program hit the tracepoints. The |
| 9765 | expressions may also denote objects in memory---structures or arrays, |
| 9766 | for example---whose values @value{GDBN} should record; while visiting |
| 9767 | a particular tracepoint, you may inspect those objects as if they were |
| 9768 | in memory at that moment. However, because @value{GDBN} records these |
| 9769 | values without interacting with you, it can do so quickly and |
| 9770 | unobtrusively, hopefully not disturbing the program's behavior. |
| 9771 | |
| 9772 | The tracepoint facility is currently available only for remote |
| 9773 | targets. @xref{Targets}. In addition, your remote target must know |
| 9774 | how to collect trace data. This functionality is implemented in the |
| 9775 | remote stub; however, none of the stubs distributed with @value{GDBN} |
| 9776 | support tracepoints as of this writing. The format of the remote |
| 9777 | packets used to implement tracepoints are described in @ref{Tracepoint |
| 9778 | Packets}. |
| 9779 | |
| 9780 | It is also possible to get trace data from a file, in a manner reminiscent |
| 9781 | of corefiles; you specify the filename, and use @code{tfind} to search |
| 9782 | through the file. @xref{Trace Files}, for more details. |
| 9783 | |
| 9784 | This chapter describes the tracepoint commands and features. |
| 9785 | |
| 9786 | @menu |
| 9787 | * Set Tracepoints:: |
| 9788 | * Analyze Collected Data:: |
| 9789 | * Tracepoint Variables:: |
| 9790 | * Trace Files:: |
| 9791 | @end menu |
| 9792 | |
| 9793 | @node Set Tracepoints |
| 9794 | @section Commands to Set Tracepoints |
| 9795 | |
| 9796 | Before running such a @dfn{trace experiment}, an arbitrary number of |
| 9797 | tracepoints can be set. A tracepoint is actually a special type of |
| 9798 | breakpoint (@pxref{Set Breaks}), so you can manipulate it using |
| 9799 | standard breakpoint commands. For instance, as with breakpoints, |
| 9800 | tracepoint numbers are successive integers starting from one, and many |
| 9801 | of the commands associated with tracepoints take the tracepoint number |
| 9802 | as their argument, to identify which tracepoint to work on. |
| 9803 | |
| 9804 | For each tracepoint, you can specify, in advance, some arbitrary set |
| 9805 | of data that you want the target to collect in the trace buffer when |
| 9806 | it hits that tracepoint. The collected data can include registers, |
| 9807 | local variables, or global data. Later, you can use @value{GDBN} |
| 9808 | commands to examine the values these data had at the time the |
| 9809 | tracepoint was hit. |
| 9810 | |
| 9811 | Tracepoints do not support every breakpoint feature. Ignore counts on |
| 9812 | tracepoints have no effect, and tracepoints cannot run @value{GDBN} |
| 9813 | commands when they are hit. Tracepoints may not be thread-specific |
| 9814 | either. |
| 9815 | |
| 9816 | @cindex fast tracepoints |
| 9817 | Some targets may support @dfn{fast tracepoints}, which are inserted in |
| 9818 | a different way (such as with a jump instead of a trap), that is |
| 9819 | faster but possibly restricted in where they may be installed. |
| 9820 | |
| 9821 | @cindex static tracepoints |
| 9822 | @cindex markers, static tracepoints |
| 9823 | @cindex probing markers, static tracepoints |
| 9824 | Regular and fast tracepoints are dynamic tracing facilities, meaning |
| 9825 | that they can be used to insert tracepoints at (almost) any location |
| 9826 | in the target. Some targets may also support controlling @dfn{static |
| 9827 | tracepoints} from @value{GDBN}. With static tracing, a set of |
| 9828 | instrumentation points, also known as @dfn{markers}, are embedded in |
| 9829 | the target program, and can be activated or deactivated by name or |
| 9830 | address. These are usually placed at locations which facilitate |
| 9831 | investigating what the target is actually doing. @value{GDBN}'s |
| 9832 | support for static tracing includes being able to list instrumentation |
| 9833 | points, and attach them with @value{GDBN} defined high level |
| 9834 | tracepoints that expose the whole range of convenience of |
| 9835 | @value{GDBN}'s tracepoints support. Namelly, support for collecting |
| 9836 | registers values and values of global or local (to the instrumentation |
| 9837 | point) variables; tracepoint conditions and trace state variables. |
| 9838 | The act of installing a @value{GDBN} static tracepoint on an |
| 9839 | instrumentation point, or marker, is referred to as @dfn{probing} a |
| 9840 | static tracepoint marker. |
| 9841 | |
| 9842 | @code{gdbserver} supports tracepoints on some target systems. |
| 9843 | @xref{Server,,Tracepoints support in @code{gdbserver}}. |
| 9844 | |
| 9845 | This section describes commands to set tracepoints and associated |
| 9846 | conditions and actions. |
| 9847 | |
| 9848 | @menu |
| 9849 | * Create and Delete Tracepoints:: |
| 9850 | * Enable and Disable Tracepoints:: |
| 9851 | * Tracepoint Passcounts:: |
| 9852 | * Tracepoint Conditions:: |
| 9853 | * Trace State Variables:: |
| 9854 | * Tracepoint Actions:: |
| 9855 | * Listing Tracepoints:: |
| 9856 | * Listing Static Tracepoint Markers:: |
| 9857 | * Starting and Stopping Trace Experiments:: |
| 9858 | * Tracepoint Restrictions:: |
| 9859 | @end menu |
| 9860 | |
| 9861 | @node Create and Delete Tracepoints |
| 9862 | @subsection Create and Delete Tracepoints |
| 9863 | |
| 9864 | @table @code |
| 9865 | @cindex set tracepoint |
| 9866 | @kindex trace |
| 9867 | @item trace @var{location} |
| 9868 | The @code{trace} command is very similar to the @code{break} command. |
| 9869 | Its argument @var{location} can be a source line, a function name, or |
| 9870 | an address in the target program. @xref{Specify Location}. The |
| 9871 | @code{trace} command defines a tracepoint, which is a point in the |
| 9872 | target program where the debugger will briefly stop, collect some |
| 9873 | data, and then allow the program to continue. Setting a tracepoint or |
| 9874 | changing its actions doesn't take effect until the next @code{tstart} |
| 9875 | command, and once a trace experiment is running, further changes will |
| 9876 | not have any effect until the next trace experiment starts. |
| 9877 | |
| 9878 | Here are some examples of using the @code{trace} command: |
| 9879 | |
| 9880 | @smallexample |
| 9881 | (@value{GDBP}) @b{trace foo.c:121} // a source file and line number |
| 9882 | |
| 9883 | (@value{GDBP}) @b{trace +2} // 2 lines forward |
| 9884 | |
| 9885 | (@value{GDBP}) @b{trace my_function} // first source line of function |
| 9886 | |
| 9887 | (@value{GDBP}) @b{trace *my_function} // EXACT start address of function |
| 9888 | |
| 9889 | (@value{GDBP}) @b{trace *0x2117c4} // an address |
| 9890 | @end smallexample |
| 9891 | |
| 9892 | @noindent |
| 9893 | You can abbreviate @code{trace} as @code{tr}. |
| 9894 | |
| 9895 | @item trace @var{location} if @var{cond} |
| 9896 | Set a tracepoint with condition @var{cond}; evaluate the expression |
| 9897 | @var{cond} each time the tracepoint is reached, and collect data only |
| 9898 | if the value is nonzero---that is, if @var{cond} evaluates as true. |
| 9899 | @xref{Tracepoint Conditions, ,Tracepoint Conditions}, for more |
| 9900 | information on tracepoint conditions. |
| 9901 | |
| 9902 | @item ftrace @var{location} [ if @var{cond} ] |
| 9903 | @cindex set fast tracepoint |
| 9904 | @cindex fast tracepoints, setting |
| 9905 | @kindex ftrace |
| 9906 | The @code{ftrace} command sets a fast tracepoint. For targets that |
| 9907 | support them, fast tracepoints will use a more efficient but possibly |
| 9908 | less general technique to trigger data collection, such as a jump |
| 9909 | instruction instead of a trap, or some sort of hardware support. It |
| 9910 | may not be possible to create a fast tracepoint at the desired |
| 9911 | location, in which case the command will exit with an explanatory |
| 9912 | message. |
| 9913 | |
| 9914 | @value{GDBN} handles arguments to @code{ftrace} exactly as for |
| 9915 | @code{trace}. |
| 9916 | |
| 9917 | @item strace @var{location} [ if @var{cond} ] |
| 9918 | @cindex set static tracepoint |
| 9919 | @cindex static tracepoints, setting |
| 9920 | @cindex probe static tracepoint marker |
| 9921 | @kindex strace |
| 9922 | The @code{strace} command sets a static tracepoint. For targets that |
| 9923 | support it, setting a static tracepoint probes a static |
| 9924 | instrumentation point, or marker, found at @var{location}. It may not |
| 9925 | be possible to set a static tracepoint at the desired location, in |
| 9926 | which case the command will exit with an explanatory message. |
| 9927 | |
| 9928 | @value{GDBN} handles arguments to @code{strace} exactly as for |
| 9929 | @code{trace}, with the addition that the user can also specify |
| 9930 | @code{-m @var{marker}} as @var{location}. This probes the marker |
| 9931 | identified by the @var{marker} string identifier. This identifier |
| 9932 | depends on the static tracepoint backend library your program is |
| 9933 | using. You can find all the marker identifiers in the @samp{ID} field |
| 9934 | of the @code{info static-tracepoint-markers} command output. |
| 9935 | @xref{Listing Static Tracepoint Markers,,Listing Static Tracepoint |
| 9936 | Markers}. For example, in the following small program using the UST |
| 9937 | tracing engine: |
| 9938 | |
| 9939 | @smallexample |
| 9940 | main () |
| 9941 | @{ |
| 9942 | trace_mark(ust, bar33, "str %s", "FOOBAZ"); |
| 9943 | @} |
| 9944 | @end smallexample |
| 9945 | |
| 9946 | @noindent |
| 9947 | the marker id is composed of joining the first two arguments to the |
| 9948 | @code{trace_mark} call with a slash, which translates to: |
| 9949 | |
| 9950 | @smallexample |
| 9951 | (@value{GDBP}) info static-tracepoint-markers |
| 9952 | Cnt Enb ID Address What |
| 9953 | 1 n ust/bar33 0x0000000000400ddc in main at stexample.c:22 |
| 9954 | Data: "str %s" |
| 9955 | [etc...] |
| 9956 | @end smallexample |
| 9957 | |
| 9958 | @noindent |
| 9959 | so you may probe the marker above with: |
| 9960 | |
| 9961 | @smallexample |
| 9962 | (@value{GDBP}) strace -m ust/bar33 |
| 9963 | @end smallexample |
| 9964 | |
| 9965 | Static tracepoints accept an extra collect action --- @code{collect |
| 9966 | $_sdata}. This collects arbitrary user data passed in the probe point |
| 9967 | call to the tracing library. In the UST example above, you'll see |
| 9968 | that the third argument to @code{trace_mark} is a printf-like format |
| 9969 | string. The user data is then the result of running that formating |
| 9970 | string against the following arguments. Note that @code{info |
| 9971 | static-tracepoint-markers} command output lists that format string in |
| 9972 | the @samp{Data:} field. |
| 9973 | |
| 9974 | You can inspect this data when analyzing the trace buffer, by printing |
| 9975 | the $_sdata variable like any other variable available to |
| 9976 | @value{GDBN}. @xref{Tracepoint Actions,,Tracepoint Action Lists}. |
| 9977 | |
| 9978 | @vindex $tpnum |
| 9979 | @cindex last tracepoint number |
| 9980 | @cindex recent tracepoint number |
| 9981 | @cindex tracepoint number |
| 9982 | The convenience variable @code{$tpnum} records the tracepoint number |
| 9983 | of the most recently set tracepoint. |
| 9984 | |
| 9985 | @kindex delete tracepoint |
| 9986 | @cindex tracepoint deletion |
| 9987 | @item delete tracepoint @r{[}@var{num}@r{]} |
| 9988 | Permanently delete one or more tracepoints. With no argument, the |
| 9989 | default is to delete all tracepoints. Note that the regular |
| 9990 | @code{delete} command can remove tracepoints also. |
| 9991 | |
| 9992 | Examples: |
| 9993 | |
| 9994 | @smallexample |
| 9995 | (@value{GDBP}) @b{delete trace 1 2 3} // remove three tracepoints |
| 9996 | |
| 9997 | (@value{GDBP}) @b{delete trace} // remove all tracepoints |
| 9998 | @end smallexample |
| 9999 | |
| 10000 | @noindent |
| 10001 | You can abbreviate this command as @code{del tr}. |
| 10002 | @end table |
| 10003 | |
| 10004 | @node Enable and Disable Tracepoints |
| 10005 | @subsection Enable and Disable Tracepoints |
| 10006 | |
| 10007 | These commands are deprecated; they are equivalent to plain @code{disable} and @code{enable}. |
| 10008 | |
| 10009 | @table @code |
| 10010 | @kindex disable tracepoint |
| 10011 | @item disable tracepoint @r{[}@var{num}@r{]} |
| 10012 | Disable tracepoint @var{num}, or all tracepoints if no argument |
| 10013 | @var{num} is given. A disabled tracepoint will have no effect during |
| 10014 | the next trace experiment, but it is not forgotten. You can re-enable |
| 10015 | a disabled tracepoint using the @code{enable tracepoint} command. |
| 10016 | |
| 10017 | @kindex enable tracepoint |
| 10018 | @item enable tracepoint @r{[}@var{num}@r{]} |
| 10019 | Enable tracepoint @var{num}, or all tracepoints. The enabled |
| 10020 | tracepoints will become effective the next time a trace experiment is |
| 10021 | run. |
| 10022 | @end table |
| 10023 | |
| 10024 | @node Tracepoint Passcounts |
| 10025 | @subsection Tracepoint Passcounts |
| 10026 | |
| 10027 | @table @code |
| 10028 | @kindex passcount |
| 10029 | @cindex tracepoint pass count |
| 10030 | @item passcount @r{[}@var{n} @r{[}@var{num}@r{]]} |
| 10031 | Set the @dfn{passcount} of a tracepoint. The passcount is a way to |
| 10032 | automatically stop a trace experiment. If a tracepoint's passcount is |
| 10033 | @var{n}, then the trace experiment will be automatically stopped on |
| 10034 | the @var{n}'th time that tracepoint is hit. If the tracepoint number |
| 10035 | @var{num} is not specified, the @code{passcount} command sets the |
| 10036 | passcount of the most recently defined tracepoint. If no passcount is |
| 10037 | given, the trace experiment will run until stopped explicitly by the |
| 10038 | user. |
| 10039 | |
| 10040 | Examples: |
| 10041 | |
| 10042 | @smallexample |
| 10043 | (@value{GDBP}) @b{passcount 5 2} // Stop on the 5th execution of |
| 10044 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// tracepoint 2} |
| 10045 | |
| 10046 | (@value{GDBP}) @b{passcount 12} // Stop on the 12th execution of the |
| 10047 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// most recently defined tracepoint.} |
| 10048 | (@value{GDBP}) @b{trace foo} |
| 10049 | (@value{GDBP}) @b{pass 3} |
| 10050 | (@value{GDBP}) @b{trace bar} |
| 10051 | (@value{GDBP}) @b{pass 2} |
| 10052 | (@value{GDBP}) @b{trace baz} |
| 10053 | (@value{GDBP}) @b{pass 1} // Stop tracing when foo has been |
| 10054 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// executed 3 times OR when bar has} |
| 10055 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// been executed 2 times} |
| 10056 | @exdent @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @code{// OR when baz has been executed 1 time.} |
| 10057 | @end smallexample |
| 10058 | @end table |
| 10059 | |
| 10060 | @node Tracepoint Conditions |
| 10061 | @subsection Tracepoint Conditions |
| 10062 | @cindex conditional tracepoints |
| 10063 | @cindex tracepoint conditions |
| 10064 | |
| 10065 | The simplest sort of tracepoint collects data every time your program |
| 10066 | reaches a specified place. You can also specify a @dfn{condition} for |
| 10067 | a tracepoint. A condition is just a Boolean expression in your |
| 10068 | programming language (@pxref{Expressions, ,Expressions}). A |
| 10069 | tracepoint with a condition evaluates the expression each time your |
| 10070 | program reaches it, and data collection happens only if the condition |
| 10071 | is true. |
| 10072 | |
| 10073 | Tracepoint conditions can be specified when a tracepoint is set, by |
| 10074 | using @samp{if} in the arguments to the @code{trace} command. |
| 10075 | @xref{Create and Delete Tracepoints, ,Setting Tracepoints}. They can |
| 10076 | also be set or changed at any time with the @code{condition} command, |
| 10077 | just as with breakpoints. |
| 10078 | |
| 10079 | Unlike breakpoint conditions, @value{GDBN} does not actually evaluate |
| 10080 | the conditional expression itself. Instead, @value{GDBN} encodes the |
| 10081 | expression into an agent expression (@pxref{Agent Expressions}) |
| 10082 | suitable for execution on the target, independently of @value{GDBN}. |
| 10083 | Global variables become raw memory locations, locals become stack |
| 10084 | accesses, and so forth. |
| 10085 | |
| 10086 | For instance, suppose you have a function that is usually called |
| 10087 | frequently, but should not be called after an error has occurred. You |
| 10088 | could use the following tracepoint command to collect data about calls |
| 10089 | of that function that happen while the error code is propagating |
| 10090 | through the program; an unconditional tracepoint could end up |
| 10091 | collecting thousands of useless trace frames that you would have to |
| 10092 | search through. |
| 10093 | |
| 10094 | @smallexample |
| 10095 | (@value{GDBP}) @kbd{trace normal_operation if errcode > 0} |
| 10096 | @end smallexample |
| 10097 | |
| 10098 | @node Trace State Variables |
| 10099 | @subsection Trace State Variables |
| 10100 | @cindex trace state variables |
| 10101 | |
| 10102 | A @dfn{trace state variable} is a special type of variable that is |
| 10103 | created and managed by target-side code. The syntax is the same as |
| 10104 | that for GDB's convenience variables (a string prefixed with ``$''), |
| 10105 | but they are stored on the target. They must be created explicitly, |
| 10106 | using a @code{tvariable} command. They are always 64-bit signed |
| 10107 | integers. |
| 10108 | |
| 10109 | Trace state variables are remembered by @value{GDBN}, and downloaded |
| 10110 | to the target along with tracepoint information when the trace |
| 10111 | experiment starts. There are no intrinsic limits on the number of |
| 10112 | trace state variables, beyond memory limitations of the target. |
| 10113 | |
| 10114 | @cindex convenience variables, and trace state variables |
| 10115 | Although trace state variables are managed by the target, you can use |
| 10116 | them in print commands and expressions as if they were convenience |
| 10117 | variables; @value{GDBN} will get the current value from the target |
| 10118 | while the trace experiment is running. Trace state variables share |
| 10119 | the same namespace as other ``$'' variables, which means that you |
| 10120 | cannot have trace state variables with names like @code{$23} or |
| 10121 | @code{$pc}, nor can you have a trace state variable and a convenience |
| 10122 | variable with the same name. |
| 10123 | |
| 10124 | @table @code |
| 10125 | |
| 10126 | @item tvariable $@var{name} [ = @var{expression} ] |
| 10127 | @kindex tvariable |
| 10128 | The @code{tvariable} command creates a new trace state variable named |
| 10129 | @code{$@var{name}}, and optionally gives it an initial value of |
| 10130 | @var{expression}. @var{expression} is evaluated when this command is |
| 10131 | entered; the result will be converted to an integer if possible, |
| 10132 | otherwise @value{GDBN} will report an error. A subsequent |
| 10133 | @code{tvariable} command specifying the same name does not create a |
| 10134 | variable, but instead assigns the supplied initial value to the |
| 10135 | existing variable of that name, overwriting any previous initial |
| 10136 | value. The default initial value is 0. |
| 10137 | |
| 10138 | @item info tvariables |
| 10139 | @kindex info tvariables |
| 10140 | List all the trace state variables along with their initial values. |
| 10141 | Their current values may also be displayed, if the trace experiment is |
| 10142 | currently running. |
| 10143 | |
| 10144 | @item delete tvariable @r{[} $@var{name} @dots{} @r{]} |
| 10145 | @kindex delete tvariable |
| 10146 | Delete the given trace state variables, or all of them if no arguments |
| 10147 | are specified. |
| 10148 | |
| 10149 | @end table |
| 10150 | |
| 10151 | @node Tracepoint Actions |
| 10152 | @subsection Tracepoint Action Lists |
| 10153 | |
| 10154 | @table @code |
| 10155 | @kindex actions |
| 10156 | @cindex tracepoint actions |
| 10157 | @item actions @r{[}@var{num}@r{]} |
| 10158 | This command will prompt for a list of actions to be taken when the |
| 10159 | tracepoint is hit. If the tracepoint number @var{num} is not |
| 10160 | specified, this command sets the actions for the one that was most |
| 10161 | recently defined (so that you can define a tracepoint and then say |
| 10162 | @code{actions} without bothering about its number). You specify the |
| 10163 | actions themselves on the following lines, one action at a time, and |
| 10164 | terminate the actions list with a line containing just @code{end}. So |
| 10165 | far, the only defined actions are @code{collect}, @code{teval}, and |
| 10166 | @code{while-stepping}. |
| 10167 | |
| 10168 | @code{actions} is actually equivalent to @code{commands} (@pxref{Break |
| 10169 | Commands, ,Breakpoint Command Lists}), except that only the defined |
| 10170 | actions are allowed; any other @value{GDBN} command is rejected. |
| 10171 | |
| 10172 | @cindex remove actions from a tracepoint |
| 10173 | To remove all actions from a tracepoint, type @samp{actions @var{num}} |
| 10174 | and follow it immediately with @samp{end}. |
| 10175 | |
| 10176 | @smallexample |
| 10177 | (@value{GDBP}) @b{collect @var{data}} // collect some data |
| 10178 | |
| 10179 | (@value{GDBP}) @b{while-stepping 5} // single-step 5 times, collect data |
| 10180 | |
| 10181 | (@value{GDBP}) @b{end} // signals the end of actions. |
| 10182 | @end smallexample |
| 10183 | |
| 10184 | In the following example, the action list begins with @code{collect} |
| 10185 | commands indicating the things to be collected when the tracepoint is |
| 10186 | hit. Then, in order to single-step and collect additional data |
| 10187 | following the tracepoint, a @code{while-stepping} command is used, |
| 10188 | followed by the list of things to be collected after each step in a |
| 10189 | sequence of single steps. The @code{while-stepping} command is |
| 10190 | terminated by its own separate @code{end} command. Lastly, the action |
| 10191 | list is terminated by an @code{end} command. |
| 10192 | |
| 10193 | @smallexample |
| 10194 | (@value{GDBP}) @b{trace foo} |
| 10195 | (@value{GDBP}) @b{actions} |
| 10196 | Enter actions for tracepoint 1, one per line: |
| 10197 | > collect bar,baz |
| 10198 | > collect $regs |
| 10199 | > while-stepping 12 |
| 10200 | > collect $pc, arr[i] |
| 10201 | > end |
| 10202 | end |
| 10203 | @end smallexample |
| 10204 | |
| 10205 | @kindex collect @r{(tracepoints)} |
| 10206 | @item collect @var{expr1}, @var{expr2}, @dots{} |
| 10207 | Collect values of the given expressions when the tracepoint is hit. |
| 10208 | This command accepts a comma-separated list of any valid expressions. |
| 10209 | In addition to global, static, or local variables, the following |
| 10210 | special arguments are supported: |
| 10211 | |
| 10212 | @table @code |
| 10213 | @item $regs |
| 10214 | Collect all registers. |
| 10215 | |
| 10216 | @item $args |
| 10217 | Collect all function arguments. |
| 10218 | |
| 10219 | @item $locals |
| 10220 | Collect all local variables. |
| 10221 | |
| 10222 | @item $_sdata |
| 10223 | @vindex $_sdata@r{, collect} |
| 10224 | Collect static tracepoint marker specific data. Only available for |
| 10225 | static tracepoints. @xref{Tracepoint Actions,,Tracepoint Action |
| 10226 | Lists}. On the UST static tracepoints library backend, an |
| 10227 | instrumentation point resembles a @code{printf} function call. The |
| 10228 | tracing library is able to collect user specified data formatted to a |
| 10229 | character string using the format provided by the programmer that |
| 10230 | instrumented the program. Other backends have similar mechanisms. |
| 10231 | Here's an example of a UST marker call: |
| 10232 | |
| 10233 | @smallexample |
| 10234 | const char master_name[] = "$your_name"; |
| 10235 | trace_mark(channel1, marker1, "hello %s", master_name) |
| 10236 | @end smallexample |
| 10237 | |
| 10238 | In this case, collecting @code{$_sdata} collects the string |
| 10239 | @samp{hello $yourname}. When analyzing the trace buffer, you can |
| 10240 | inspect @samp{$_sdata} like any other variable available to |
| 10241 | @value{GDBN}. |
| 10242 | @end table |
| 10243 | |
| 10244 | You can give several consecutive @code{collect} commands, each one |
| 10245 | with a single argument, or one @code{collect} command with several |
| 10246 | arguments separated by commas; the effect is the same. |
| 10247 | |
| 10248 | The command @code{info scope} (@pxref{Symbols, info scope}) is |
| 10249 | particularly useful for figuring out what data to collect. |
| 10250 | |
| 10251 | @kindex teval @r{(tracepoints)} |
| 10252 | @item teval @var{expr1}, @var{expr2}, @dots{} |
| 10253 | Evaluate the given expressions when the tracepoint is hit. This |
| 10254 | command accepts a comma-separated list of expressions. The results |
| 10255 | are discarded, so this is mainly useful for assigning values to trace |
| 10256 | state variables (@pxref{Trace State Variables}) without adding those |
| 10257 | values to the trace buffer, as would be the case if the @code{collect} |
| 10258 | action were used. |
| 10259 | |
| 10260 | @kindex while-stepping @r{(tracepoints)} |
| 10261 | @item while-stepping @var{n} |
| 10262 | Perform @var{n} single-step instruction traces after the tracepoint, |
| 10263 | collecting new data after each step. The @code{while-stepping} |
| 10264 | command is followed by the list of what to collect while stepping |
| 10265 | (followed by its own @code{end} command): |
| 10266 | |
| 10267 | @smallexample |
| 10268 | > while-stepping 12 |
| 10269 | > collect $regs, myglobal |
| 10270 | > end |
| 10271 | > |
| 10272 | @end smallexample |
| 10273 | |
| 10274 | @noindent |
| 10275 | Note that @code{$pc} is not automatically collected by |
| 10276 | @code{while-stepping}; you need to explicitly collect that register if |
| 10277 | you need it. You may abbreviate @code{while-stepping} as @code{ws} or |
| 10278 | @code{stepping}. |
| 10279 | |
| 10280 | @item set default-collect @var{expr1}, @var{expr2}, @dots{} |
| 10281 | @kindex set default-collect |
| 10282 | @cindex default collection action |
| 10283 | This variable is a list of expressions to collect at each tracepoint |
| 10284 | hit. It is effectively an additional @code{collect} action prepended |
| 10285 | to every tracepoint action list. The expressions are parsed |
| 10286 | individually for each tracepoint, so for instance a variable named |
| 10287 | @code{xyz} may be interpreted as a global for one tracepoint, and a |
| 10288 | local for another, as appropriate to the tracepoint's location. |
| 10289 | |
| 10290 | @item show default-collect |
| 10291 | @kindex show default-collect |
| 10292 | Show the list of expressions that are collected by default at each |
| 10293 | tracepoint hit. |
| 10294 | |
| 10295 | @end table |
| 10296 | |
| 10297 | @node Listing Tracepoints |
| 10298 | @subsection Listing Tracepoints |
| 10299 | |
| 10300 | @table @code |
| 10301 | @kindex info tracepoints @r{[}@var{n}@dots{}@r{]} |
| 10302 | @kindex info tp @r{[}@var{n}@dots{}@r{]} |
| 10303 | @cindex information about tracepoints |
| 10304 | @item info tracepoints @r{[}@var{num}@dots{}@r{]} |
| 10305 | Display information about the tracepoint @var{num}. If you don't |
| 10306 | specify a tracepoint number, displays information about all the |
| 10307 | tracepoints defined so far. The format is similar to that used for |
| 10308 | @code{info breakpoints}; in fact, @code{info tracepoints} is the same |
| 10309 | command, simply restricting itself to tracepoints. |
| 10310 | |
| 10311 | A tracepoint's listing may include additional information specific to |
| 10312 | tracing: |
| 10313 | |
| 10314 | @itemize @bullet |
| 10315 | @item |
| 10316 | its passcount as given by the @code{passcount @var{n}} command |
| 10317 | @end itemize |
| 10318 | |
| 10319 | @smallexample |
| 10320 | (@value{GDBP}) @b{info trace} |
| 10321 | Num Type Disp Enb Address What |
| 10322 | 1 tracepoint keep y 0x0804ab57 in foo() at main.cxx:7 |
| 10323 | while-stepping 20 |
| 10324 | collect globfoo, $regs |
| 10325 | end |
| 10326 | collect globfoo2 |
| 10327 | end |
| 10328 | pass count 1200 |
| 10329 | (@value{GDBP}) |
| 10330 | @end smallexample |
| 10331 | |
| 10332 | @noindent |
| 10333 | This command can be abbreviated @code{info tp}. |
| 10334 | @end table |
| 10335 | |
| 10336 | @node Listing Static Tracepoint Markers |
| 10337 | @subsection Listing Static Tracepoint Markers |
| 10338 | |
| 10339 | @table @code |
| 10340 | @kindex info static-tracepoint-markers |
| 10341 | @cindex information about static tracepoint markers |
| 10342 | @item info static-tracepoint-markers |
| 10343 | Display information about all static tracepoint markers defined in the |
| 10344 | program. |
| 10345 | |
| 10346 | For each marker, the following columns are printed: |
| 10347 | |
| 10348 | @table @emph |
| 10349 | @item Count |
| 10350 | An incrementing counter, output to help readability. This is not a |
| 10351 | stable identifier. |
| 10352 | @item ID |
| 10353 | The marker ID, as reported by the target. |
| 10354 | @item Enabled or Disabled |
| 10355 | Probed markers are tagged with @samp{y}. @samp{n} identifies marks |
| 10356 | that are not enabled. |
| 10357 | @item Address |
| 10358 | Where the marker is in your program, as a memory address. |
| 10359 | @item What |
| 10360 | Where the marker is in the source for your program, as a file and line |
| 10361 | number. If the debug information included in the program does not |
| 10362 | allow @value{GDBN} to locate the source of the marker, this column |
| 10363 | will be left blank. |
| 10364 | @end table |
| 10365 | |
| 10366 | @noindent |
| 10367 | In addition, the following information may be printed for each marker: |
| 10368 | |
| 10369 | @table @emph |
| 10370 | @item Data |
| 10371 | User data passed to the tracing library by the marker call. In the |
| 10372 | UST backend, this is the format string passed as argument to the |
| 10373 | marker call. |
| 10374 | @item Static tracepoints probing the marker |
| 10375 | The list of static tracepoints attached to the marker. |
| 10376 | @end table |
| 10377 | |
| 10378 | @smallexample |
| 10379 | (@value{GDBP}) info static-tracepoint-markers |
| 10380 | Cnt ID Enb Address What |
| 10381 | 1 ust/bar2 y 0x0000000000400e1a in main at stexample.c:25 |
| 10382 | Data: number1 %d number2 %d |
| 10383 | Probed by static tracepoints: #2 |
| 10384 | 2 ust/bar33 n 0x0000000000400c87 in main at stexample.c:24 |
| 10385 | Data: str %s |
| 10386 | (@value{GDBP}) |
| 10387 | @end smallexample |
| 10388 | @end table |
| 10389 | |
| 10390 | @node Starting and Stopping Trace Experiments |
| 10391 | @subsection Starting and Stopping Trace Experiments |
| 10392 | |
| 10393 | @table @code |
| 10394 | @kindex tstart |
| 10395 | @cindex start a new trace experiment |
| 10396 | @cindex collected data discarded |
| 10397 | @item tstart |
| 10398 | This command takes no arguments. It starts the trace experiment, and |
| 10399 | begins collecting data. This has the side effect of discarding all |
| 10400 | the data collected in the trace buffer during the previous trace |
| 10401 | experiment. |
| 10402 | |
| 10403 | @kindex tstop |
| 10404 | @cindex stop a running trace experiment |
| 10405 | @item tstop |
| 10406 | This command takes no arguments. It ends the trace experiment, and |
| 10407 | stops collecting data. |
| 10408 | |
| 10409 | @strong{Note}: a trace experiment and data collection may stop |
| 10410 | automatically if any tracepoint's passcount is reached |
| 10411 | (@pxref{Tracepoint Passcounts}), or if the trace buffer becomes full. |
| 10412 | |
| 10413 | @kindex tstatus |
| 10414 | @cindex status of trace data collection |
| 10415 | @cindex trace experiment, status of |
| 10416 | @item tstatus |
| 10417 | This command displays the status of the current trace data |
| 10418 | collection. |
| 10419 | @end table |
| 10420 | |
| 10421 | Here is an example of the commands we described so far: |
| 10422 | |
| 10423 | @smallexample |
| 10424 | (@value{GDBP}) @b{trace gdb_c_test} |
| 10425 | (@value{GDBP}) @b{actions} |
| 10426 | Enter actions for tracepoint #1, one per line. |
| 10427 | > collect $regs,$locals,$args |
| 10428 | > while-stepping 11 |
| 10429 | > collect $regs |
| 10430 | > end |
| 10431 | > end |
| 10432 | (@value{GDBP}) @b{tstart} |
| 10433 | [time passes @dots{}] |
| 10434 | (@value{GDBP}) @b{tstop} |
| 10435 | @end smallexample |
| 10436 | |
| 10437 | @cindex disconnected tracing |
| 10438 | You can choose to continue running the trace experiment even if |
| 10439 | @value{GDBN} disconnects from the target, voluntarily or |
| 10440 | involuntarily. For commands such as @code{detach}, the debugger will |
| 10441 | ask what you want to do with the trace. But for unexpected |
| 10442 | terminations (@value{GDBN} crash, network outage), it would be |
| 10443 | unfortunate to lose hard-won trace data, so the variable |
| 10444 | @code{disconnected-tracing} lets you decide whether the trace should |
| 10445 | continue running without @value{GDBN}. |
| 10446 | |
| 10447 | @table @code |
| 10448 | @item set disconnected-tracing on |
| 10449 | @itemx set disconnected-tracing off |
| 10450 | @kindex set disconnected-tracing |
| 10451 | Choose whether a tracing run should continue to run if @value{GDBN} |
| 10452 | has disconnected from the target. Note that @code{detach} or |
| 10453 | @code{quit} will ask you directly what to do about a running trace no |
| 10454 | matter what this variable's setting, so the variable is mainly useful |
| 10455 | for handling unexpected situations, such as loss of the network. |
| 10456 | |
| 10457 | @item show disconnected-tracing |
| 10458 | @kindex show disconnected-tracing |
| 10459 | Show the current choice for disconnected tracing. |
| 10460 | |
| 10461 | @end table |
| 10462 | |
| 10463 | When you reconnect to the target, the trace experiment may or may not |
| 10464 | still be running; it might have filled the trace buffer in the |
| 10465 | meantime, or stopped for one of the other reasons. If it is running, |
| 10466 | it will continue after reconnection. |
| 10467 | |
| 10468 | Upon reconnection, the target will upload information about the |
| 10469 | tracepoints in effect. @value{GDBN} will then compare that |
| 10470 | information to the set of tracepoints currently defined, and attempt |
| 10471 | to match them up, allowing for the possibility that the numbers may |
| 10472 | have changed due to creation and deletion in the meantime. If one of |
| 10473 | the target's tracepoints does not match any in @value{GDBN}, the |
| 10474 | debugger will create a new tracepoint, so that you have a number with |
| 10475 | which to specify that tracepoint. This matching-up process is |
| 10476 | necessarily heuristic, and it may result in useless tracepoints being |
| 10477 | created; you may simply delete them if they are of no use. |
| 10478 | |
| 10479 | @cindex circular trace buffer |
| 10480 | If your target agent supports a @dfn{circular trace buffer}, then you |
| 10481 | can run a trace experiment indefinitely without filling the trace |
| 10482 | buffer; when space runs out, the agent deletes already-collected trace |
| 10483 | frames, oldest first, until there is enough room to continue |
| 10484 | collecting. This is especially useful if your tracepoints are being |
| 10485 | hit too often, and your trace gets terminated prematurely because the |
| 10486 | buffer is full. To ask for a circular trace buffer, simply set |
| 10487 | @samp{circular-trace-buffer} to on. You can set this at any time, |
| 10488 | including during tracing; if the agent can do it, it will change |
| 10489 | buffer handling on the fly, otherwise it will not take effect until |
| 10490 | the next run. |
| 10491 | |
| 10492 | @table @code |
| 10493 | @item set circular-trace-buffer on |
| 10494 | @itemx set circular-trace-buffer off |
| 10495 | @kindex set circular-trace-buffer |
| 10496 | Choose whether a tracing run should use a linear or circular buffer |
| 10497 | for trace data. A linear buffer will not lose any trace data, but may |
| 10498 | fill up prematurely, while a circular buffer will discard old trace |
| 10499 | data, but it will have always room for the latest tracepoint hits. |
| 10500 | |
| 10501 | @item show circular-trace-buffer |
| 10502 | @kindex show circular-trace-buffer |
| 10503 | Show the current choice for the trace buffer. Note that this may not |
| 10504 | match the agent's current buffer handling, nor is it guaranteed to |
| 10505 | match the setting that might have been in effect during a past run, |
| 10506 | for instance if you are looking at frames from a trace file. |
| 10507 | |
| 10508 | @end table |
| 10509 | |
| 10510 | @node Tracepoint Restrictions |
| 10511 | @subsection Tracepoint Restrictions |
| 10512 | |
| 10513 | @cindex tracepoint restrictions |
| 10514 | There are a number of restrictions on the use of tracepoints. As |
| 10515 | described above, tracepoint data gathering occurs on the target |
| 10516 | without interaction from @value{GDBN}. Thus the full capabilities of |
| 10517 | the debugger are not available during data gathering, and then at data |
| 10518 | examination time, you will be limited by only having what was |
| 10519 | collected. The following items describe some common problems, but it |
| 10520 | is not exhaustive, and you may run into additional difficulties not |
| 10521 | mentioned here. |
| 10522 | |
| 10523 | @itemize @bullet |
| 10524 | |
| 10525 | @item |
| 10526 | Tracepoint expressions are intended to gather objects (lvalues). Thus |
| 10527 | the full flexibility of GDB's expression evaluator is not available. |
| 10528 | You cannot call functions, cast objects to aggregate types, access |
| 10529 | convenience variables or modify values (except by assignment to trace |
| 10530 | state variables). Some language features may implicitly call |
| 10531 | functions (for instance Objective-C fields with accessors), and therefore |
| 10532 | cannot be collected either. |
| 10533 | |
| 10534 | @item |
| 10535 | Collection of local variables, either individually or in bulk with |
| 10536 | @code{$locals} or @code{$args}, during @code{while-stepping} may |
| 10537 | behave erratically. The stepping action may enter a new scope (for |
| 10538 | instance by stepping into a function), or the location of the variable |
| 10539 | may change (for instance it is loaded into a register). The |
| 10540 | tracepoint data recorded uses the location information for the |
| 10541 | variables that is correct for the tracepoint location. When the |
| 10542 | tracepoint is created, it is not possible, in general, to determine |
| 10543 | where the steps of a @code{while-stepping} sequence will advance the |
| 10544 | program---particularly if a conditional branch is stepped. |
| 10545 | |
| 10546 | @item |
| 10547 | Collection of an incompletely-initialized or partially-destroyed object |
| 10548 | may result in something that @value{GDBN} cannot display, or displays |
| 10549 | in a misleading way. |
| 10550 | |
| 10551 | @item |
| 10552 | When @value{GDBN} displays a pointer to character it automatically |
| 10553 | dereferences the pointer to also display characters of the string |
| 10554 | being pointed to. However, collecting the pointer during tracing does |
| 10555 | not automatically collect the string. You need to explicitly |
| 10556 | dereference the pointer and provide size information if you want to |
| 10557 | collect not only the pointer, but the memory pointed to. For example, |
| 10558 | @code{*ptr@@50} can be used to collect the 50 element array pointed to |
| 10559 | by @code{ptr}. |
| 10560 | |
| 10561 | @item |
| 10562 | It is not possible to collect a complete stack backtrace at a |
| 10563 | tracepoint. Instead, you may collect the registers and a few hundred |
| 10564 | bytes from the stack pointer with something like @code{*$esp@@300} |
| 10565 | (adjust to use the name of the actual stack pointer register on your |
| 10566 | target architecture, and the amount of stack you wish to capture). |
| 10567 | Then the @code{backtrace} command will show a partial backtrace when |
| 10568 | using a trace frame. The number of stack frames that can be examined |
| 10569 | depends on the sizes of the frames in the collected stack. Note that |
| 10570 | if you ask for a block so large that it goes past the bottom of the |
| 10571 | stack, the target agent may report an error trying to read from an |
| 10572 | invalid address. |
| 10573 | |
| 10574 | @item |
| 10575 | If you do not collect registers at a tracepoint, @value{GDBN} can |
| 10576 | infer that the value of @code{$pc} must be the same as the address of |
| 10577 | the tracepoint and use that when you are looking at a trace frame |
| 10578 | for that tracepoint. However, this cannot work if the tracepoint has |
| 10579 | multiple locations (for instance if it was set in a function that was |
| 10580 | inlined), or if it has a @code{while-stepping} loop. In those cases |
| 10581 | @value{GDBN} will warn you that it can't infer @code{$pc}, and default |
| 10582 | it to zero. |
| 10583 | |
| 10584 | @end itemize |
| 10585 | |
| 10586 | @node Analyze Collected Data |
| 10587 | @section Using the Collected Data |
| 10588 | |
| 10589 | After the tracepoint experiment ends, you use @value{GDBN} commands |
| 10590 | for examining the trace data. The basic idea is that each tracepoint |
| 10591 | collects a trace @dfn{snapshot} every time it is hit and another |
| 10592 | snapshot every time it single-steps. All these snapshots are |
| 10593 | consecutively numbered from zero and go into a buffer, and you can |
| 10594 | examine them later. The way you examine them is to @dfn{focus} on a |
| 10595 | specific trace snapshot. When the remote stub is focused on a trace |
| 10596 | snapshot, it will respond to all @value{GDBN} requests for memory and |
| 10597 | registers by reading from the buffer which belongs to that snapshot, |
| 10598 | rather than from @emph{real} memory or registers of the program being |
| 10599 | debugged. This means that @strong{all} @value{GDBN} commands |
| 10600 | (@code{print}, @code{info registers}, @code{backtrace}, etc.) will |
| 10601 | behave as if we were currently debugging the program state as it was |
| 10602 | when the tracepoint occurred. Any requests for data that are not in |
| 10603 | the buffer will fail. |
| 10604 | |
| 10605 | @menu |
| 10606 | * tfind:: How to select a trace snapshot |
| 10607 | * tdump:: How to display all data for a snapshot |
| 10608 | * save tracepoints:: How to save tracepoints for a future run |
| 10609 | @end menu |
| 10610 | |
| 10611 | @node tfind |
| 10612 | @subsection @code{tfind @var{n}} |
| 10613 | |
| 10614 | @kindex tfind |
| 10615 | @cindex select trace snapshot |
| 10616 | @cindex find trace snapshot |
| 10617 | The basic command for selecting a trace snapshot from the buffer is |
| 10618 | @code{tfind @var{n}}, which finds trace snapshot number @var{n}, |
| 10619 | counting from zero. If no argument @var{n} is given, the next |
| 10620 | snapshot is selected. |
| 10621 | |
| 10622 | Here are the various forms of using the @code{tfind} command. |
| 10623 | |
| 10624 | @table @code |
| 10625 | @item tfind start |
| 10626 | Find the first snapshot in the buffer. This is a synonym for |
| 10627 | @code{tfind 0} (since 0 is the number of the first snapshot). |
| 10628 | |
| 10629 | @item tfind none |
| 10630 | Stop debugging trace snapshots, resume @emph{live} debugging. |
| 10631 | |
| 10632 | @item tfind end |
| 10633 | Same as @samp{tfind none}. |
| 10634 | |
| 10635 | @item tfind |
| 10636 | No argument means find the next trace snapshot. |
| 10637 | |
| 10638 | @item tfind - |
| 10639 | Find the previous trace snapshot before the current one. This permits |
| 10640 | retracing earlier steps. |
| 10641 | |
| 10642 | @item tfind tracepoint @var{num} |
| 10643 | Find the next snapshot associated with tracepoint @var{num}. Search |
| 10644 | proceeds forward from the last examined trace snapshot. If no |
| 10645 | argument @var{num} is given, it means find the next snapshot collected |
| 10646 | for the same tracepoint as the current snapshot. |
| 10647 | |
| 10648 | @item tfind pc @var{addr} |
| 10649 | Find the next snapshot associated with the value @var{addr} of the |
| 10650 | program counter. Search proceeds forward from the last examined trace |
| 10651 | snapshot. If no argument @var{addr} is given, it means find the next |
| 10652 | snapshot with the same value of PC as the current snapshot. |
| 10653 | |
| 10654 | @item tfind outside @var{addr1}, @var{addr2} |
| 10655 | Find the next snapshot whose PC is outside the given range of |
| 10656 | addresses (exclusive). |
| 10657 | |
| 10658 | @item tfind range @var{addr1}, @var{addr2} |
| 10659 | Find the next snapshot whose PC is between @var{addr1} and |
| 10660 | @var{addr2} (inclusive). |
| 10661 | |
| 10662 | @item tfind line @r{[}@var{file}:@r{]}@var{n} |
| 10663 | Find the next snapshot associated with the source line @var{n}. If |
| 10664 | the optional argument @var{file} is given, refer to line @var{n} in |
| 10665 | that source file. Search proceeds forward from the last examined |
| 10666 | trace snapshot. If no argument @var{n} is given, it means find the |
| 10667 | next line other than the one currently being examined; thus saying |
| 10668 | @code{tfind line} repeatedly can appear to have the same effect as |
| 10669 | stepping from line to line in a @emph{live} debugging session. |
| 10670 | @end table |
| 10671 | |
| 10672 | The default arguments for the @code{tfind} commands are specifically |
| 10673 | designed to make it easy to scan through the trace buffer. For |
| 10674 | instance, @code{tfind} with no argument selects the next trace |
| 10675 | snapshot, and @code{tfind -} with no argument selects the previous |
| 10676 | trace snapshot. So, by giving one @code{tfind} command, and then |
| 10677 | simply hitting @key{RET} repeatedly you can examine all the trace |
| 10678 | snapshots in order. Or, by saying @code{tfind -} and then hitting |
| 10679 | @key{RET} repeatedly you can examine the snapshots in reverse order. |
| 10680 | The @code{tfind line} command with no argument selects the snapshot |
| 10681 | for the next source line executed. The @code{tfind pc} command with |
| 10682 | no argument selects the next snapshot with the same program counter |
| 10683 | (PC) as the current frame. The @code{tfind tracepoint} command with |
| 10684 | no argument selects the next trace snapshot collected by the same |
| 10685 | tracepoint as the current one. |
| 10686 | |
| 10687 | In addition to letting you scan through the trace buffer manually, |
| 10688 | these commands make it easy to construct @value{GDBN} scripts that |
| 10689 | scan through the trace buffer and print out whatever collected data |
| 10690 | you are interested in. Thus, if we want to examine the PC, FP, and SP |
| 10691 | registers from each trace frame in the buffer, we can say this: |
| 10692 | |
| 10693 | @smallexample |
| 10694 | (@value{GDBP}) @b{tfind start} |
| 10695 | (@value{GDBP}) @b{while ($trace_frame != -1)} |
| 10696 | > printf "Frame %d, PC = %08X, SP = %08X, FP = %08X\n", \ |
| 10697 | $trace_frame, $pc, $sp, $fp |
| 10698 | > tfind |
| 10699 | > end |
| 10700 | |
| 10701 | Frame 0, PC = 0020DC64, SP = 0030BF3C, FP = 0030BF44 |
| 10702 | Frame 1, PC = 0020DC6C, SP = 0030BF38, FP = 0030BF44 |
| 10703 | Frame 2, PC = 0020DC70, SP = 0030BF34, FP = 0030BF44 |
| 10704 | Frame 3, PC = 0020DC74, SP = 0030BF30, FP = 0030BF44 |
| 10705 | Frame 4, PC = 0020DC78, SP = 0030BF2C, FP = 0030BF44 |
| 10706 | Frame 5, PC = 0020DC7C, SP = 0030BF28, FP = 0030BF44 |
| 10707 | Frame 6, PC = 0020DC80, SP = 0030BF24, FP = 0030BF44 |
| 10708 | Frame 7, PC = 0020DC84, SP = 0030BF20, FP = 0030BF44 |
| 10709 | Frame 8, PC = 0020DC88, SP = 0030BF1C, FP = 0030BF44 |
| 10710 | Frame 9, PC = 0020DC8E, SP = 0030BF18, FP = 0030BF44 |
| 10711 | Frame 10, PC = 00203F6C, SP = 0030BE3C, FP = 0030BF14 |
| 10712 | @end smallexample |
| 10713 | |
| 10714 | Or, if we want to examine the variable @code{X} at each source line in |
| 10715 | the buffer: |
| 10716 | |
| 10717 | @smallexample |
| 10718 | (@value{GDBP}) @b{tfind start} |
| 10719 | (@value{GDBP}) @b{while ($trace_frame != -1)} |
| 10720 | > printf "Frame %d, X == %d\n", $trace_frame, X |
| 10721 | > tfind line |
| 10722 | > end |
| 10723 | |
| 10724 | Frame 0, X = 1 |
| 10725 | Frame 7, X = 2 |
| 10726 | Frame 13, X = 255 |
| 10727 | @end smallexample |
| 10728 | |
| 10729 | @node tdump |
| 10730 | @subsection @code{tdump} |
| 10731 | @kindex tdump |
| 10732 | @cindex dump all data collected at tracepoint |
| 10733 | @cindex tracepoint data, display |
| 10734 | |
| 10735 | This command takes no arguments. It prints all the data collected at |
| 10736 | the current trace snapshot. |
| 10737 | |
| 10738 | @smallexample |
| 10739 | (@value{GDBP}) @b{trace 444} |
| 10740 | (@value{GDBP}) @b{actions} |
| 10741 | Enter actions for tracepoint #2, one per line: |
| 10742 | > collect $regs, $locals, $args, gdb_long_test |
| 10743 | > end |
| 10744 | |
| 10745 | (@value{GDBP}) @b{tstart} |
| 10746 | |
| 10747 | (@value{GDBP}) @b{tfind line 444} |
| 10748 | #0 gdb_test (p1=0x11, p2=0x22, p3=0x33, p4=0x44, p5=0x55, p6=0x66) |
| 10749 | at gdb_test.c:444 |
| 10750 | 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n", ) |
| 10751 | |
| 10752 | (@value{GDBP}) @b{tdump} |
| 10753 | Data collected at tracepoint 2, trace frame 1: |
| 10754 | d0 0xc4aa0085 -995491707 |
| 10755 | d1 0x18 24 |
| 10756 | d2 0x80 128 |
| 10757 | d3 0x33 51 |
| 10758 | d4 0x71aea3d 119204413 |
| 10759 | d5 0x22 34 |
| 10760 | d6 0xe0 224 |
| 10761 | d7 0x380035 3670069 |
| 10762 | a0 0x19e24a 1696330 |
| 10763 | a1 0x3000668 50333288 |
| 10764 | a2 0x100 256 |
| 10765 | a3 0x322000 3284992 |
| 10766 | a4 0x3000698 50333336 |
| 10767 | a5 0x1ad3cc 1758156 |
| 10768 | fp 0x30bf3c 0x30bf3c |
| 10769 | sp 0x30bf34 0x30bf34 |
| 10770 | ps 0x0 0 |
| 10771 | pc 0x20b2c8 0x20b2c8 |
| 10772 | fpcontrol 0x0 0 |
| 10773 | fpstatus 0x0 0 |
| 10774 | fpiaddr 0x0 0 |
| 10775 | p = 0x20e5b4 "gdb-test" |
| 10776 | p1 = (void *) 0x11 |
| 10777 | p2 = (void *) 0x22 |
| 10778 | p3 = (void *) 0x33 |
| 10779 | p4 = (void *) 0x44 |
| 10780 | p5 = (void *) 0x55 |
| 10781 | p6 = (void *) 0x66 |
| 10782 | gdb_long_test = 17 '\021' |
| 10783 | |
| 10784 | (@value{GDBP}) |
| 10785 | @end smallexample |
| 10786 | |
| 10787 | @code{tdump} works by scanning the tracepoint's current collection |
| 10788 | actions and printing the value of each expression listed. So |
| 10789 | @code{tdump} can fail, if after a run, you change the tracepoint's |
| 10790 | actions to mention variables that were not collected during the run. |
| 10791 | |
| 10792 | Also, for tracepoints with @code{while-stepping} loops, @code{tdump} |
| 10793 | uses the collected value of @code{$pc} to distinguish between trace |
| 10794 | frames that were collected at the tracepoint hit, and frames that were |
| 10795 | collected while stepping. This allows it to correctly choose whether |
| 10796 | to display the basic list of collections, or the collections from the |
| 10797 | body of the while-stepping loop. However, if @code{$pc} was not collected, |
| 10798 | then @code{tdump} will always attempt to dump using the basic collection |
| 10799 | list, and may fail if a while-stepping frame does not include all the |
| 10800 | same data that is collected at the tracepoint hit. |
| 10801 | @c This is getting pretty arcane, example would be good. |
| 10802 | |
| 10803 | @node save tracepoints |
| 10804 | @subsection @code{save tracepoints @var{filename}} |
| 10805 | @kindex save tracepoints |
| 10806 | @kindex save-tracepoints |
| 10807 | @cindex save tracepoints for future sessions |
| 10808 | |
| 10809 | This command saves all current tracepoint definitions together with |
| 10810 | their actions and passcounts, into a file @file{@var{filename}} |
| 10811 | suitable for use in a later debugging session. To read the saved |
| 10812 | tracepoint definitions, use the @code{source} command (@pxref{Command |
| 10813 | Files}). The @w{@code{save-tracepoints}} command is a deprecated |
| 10814 | alias for @w{@code{save tracepoints}} |
| 10815 | |
| 10816 | @node Tracepoint Variables |
| 10817 | @section Convenience Variables for Tracepoints |
| 10818 | @cindex tracepoint variables |
| 10819 | @cindex convenience variables for tracepoints |
| 10820 | |
| 10821 | @table @code |
| 10822 | @vindex $trace_frame |
| 10823 | @item (int) $trace_frame |
| 10824 | The current trace snapshot (a.k.a.@: @dfn{frame}) number, or -1 if no |
| 10825 | snapshot is selected. |
| 10826 | |
| 10827 | @vindex $tracepoint |
| 10828 | @item (int) $tracepoint |
| 10829 | The tracepoint for the current trace snapshot. |
| 10830 | |
| 10831 | @vindex $trace_line |
| 10832 | @item (int) $trace_line |
| 10833 | The line number for the current trace snapshot. |
| 10834 | |
| 10835 | @vindex $trace_file |
| 10836 | @item (char []) $trace_file |
| 10837 | The source file for the current trace snapshot. |
| 10838 | |
| 10839 | @vindex $trace_func |
| 10840 | @item (char []) $trace_func |
| 10841 | The name of the function containing @code{$tracepoint}. |
| 10842 | @end table |
| 10843 | |
| 10844 | Note: @code{$trace_file} is not suitable for use in @code{printf}, |
| 10845 | use @code{output} instead. |
| 10846 | |
| 10847 | Here's a simple example of using these convenience variables for |
| 10848 | stepping through all the trace snapshots and printing some of their |
| 10849 | data. Note that these are not the same as trace state variables, |
| 10850 | which are managed by the target. |
| 10851 | |
| 10852 | @smallexample |
| 10853 | (@value{GDBP}) @b{tfind start} |
| 10854 | |
| 10855 | (@value{GDBP}) @b{while $trace_frame != -1} |
| 10856 | > output $trace_file |
| 10857 | > printf ", line %d (tracepoint #%d)\n", $trace_line, $tracepoint |
| 10858 | > tfind |
| 10859 | > end |
| 10860 | @end smallexample |
| 10861 | |
| 10862 | @node Trace Files |
| 10863 | @section Using Trace Files |
| 10864 | @cindex trace files |
| 10865 | |
| 10866 | In some situations, the target running a trace experiment may no |
| 10867 | longer be available; perhaps it crashed, or the hardware was needed |
| 10868 | for a different activity. To handle these cases, you can arrange to |
| 10869 | dump the trace data into a file, and later use that file as a source |
| 10870 | of trace data, via the @code{target tfile} command. |
| 10871 | |
| 10872 | @table @code |
| 10873 | |
| 10874 | @kindex tsave |
| 10875 | @item tsave [ -r ] @var{filename} |
| 10876 | Save the trace data to @var{filename}. By default, this command |
| 10877 | assumes that @var{filename} refers to the host filesystem, so if |
| 10878 | necessary @value{GDBN} will copy raw trace data up from the target and |
| 10879 | then save it. If the target supports it, you can also supply the |
| 10880 | optional argument @code{-r} (``remote'') to direct the target to save |
| 10881 | the data directly into @var{filename} in its own filesystem, which may be |
| 10882 | more efficient if the trace buffer is very large. (Note, however, that |
| 10883 | @code{target tfile} can only read from files accessible to the host.) |
| 10884 | |
| 10885 | @kindex target tfile |
| 10886 | @kindex tfile |
| 10887 | @item target tfile @var{filename} |
| 10888 | Use the file named @var{filename} as a source of trace data. Commands |
| 10889 | that examine data work as they do with a live target, but it is not |
| 10890 | possible to run any new trace experiments. @code{tstatus} will report |
| 10891 | the state of the trace run at the moment the data was saved, as well |
| 10892 | as the current trace frame you are examining. @var{filename} must be |
| 10893 | on a filesystem accessible to the host. |
| 10894 | |
| 10895 | @end table |
| 10896 | |
| 10897 | @node Overlays |
| 10898 | @chapter Debugging Programs That Use Overlays |
| 10899 | @cindex overlays |
| 10900 | |
| 10901 | If your program is too large to fit completely in your target system's |
| 10902 | memory, you can sometimes use @dfn{overlays} to work around this |
| 10903 | problem. @value{GDBN} provides some support for debugging programs that |
| 10904 | use overlays. |
| 10905 | |
| 10906 | @menu |
| 10907 | * How Overlays Work:: A general explanation of overlays. |
| 10908 | * Overlay Commands:: Managing overlays in @value{GDBN}. |
| 10909 | * Automatic Overlay Debugging:: @value{GDBN} can find out which overlays are |
| 10910 | mapped by asking the inferior. |
| 10911 | * Overlay Sample Program:: A sample program using overlays. |
| 10912 | @end menu |
| 10913 | |
| 10914 | @node How Overlays Work |
| 10915 | @section How Overlays Work |
| 10916 | @cindex mapped overlays |
| 10917 | @cindex unmapped overlays |
| 10918 | @cindex load address, overlay's |
| 10919 | @cindex mapped address |
| 10920 | @cindex overlay area |
| 10921 | |
| 10922 | Suppose you have a computer whose instruction address space is only 64 |
| 10923 | kilobytes long, but which has much more memory which can be accessed by |
| 10924 | other means: special instructions, segment registers, or memory |
| 10925 | management hardware, for example. Suppose further that you want to |
| 10926 | adapt a program which is larger than 64 kilobytes to run on this system. |
| 10927 | |
| 10928 | One solution is to identify modules of your program which are relatively |
| 10929 | independent, and need not call each other directly; call these modules |
| 10930 | @dfn{overlays}. Separate the overlays from the main program, and place |
| 10931 | their machine code in the larger memory. Place your main program in |
| 10932 | instruction memory, but leave at least enough space there to hold the |
| 10933 | largest overlay as well. |
| 10934 | |
| 10935 | Now, to call a function located in an overlay, you must first copy that |
| 10936 | overlay's machine code from the large memory into the space set aside |
| 10937 | for it in the instruction memory, and then jump to its entry point |
| 10938 | there. |
| 10939 | |
| 10940 | @c NB: In the below the mapped area's size is greater or equal to the |
| 10941 | @c size of all overlays. This is intentional to remind the developer |
| 10942 | @c that overlays don't necessarily need to be the same size. |
| 10943 | |
| 10944 | @smallexample |
| 10945 | @group |
| 10946 | Data Instruction Larger |
| 10947 | Address Space Address Space Address Space |
| 10948 | +-----------+ +-----------+ +-----------+ |
| 10949 | | | | | | | |
| 10950 | +-----------+ +-----------+ +-----------+<-- overlay 1 |
| 10951 | | program | | main | .----| overlay 1 | load address |
| 10952 | | variables | | program | | +-----------+ |
| 10953 | | and heap | | | | | | |
| 10954 | +-----------+ | | | +-----------+<-- overlay 2 |
| 10955 | | | +-----------+ | | | load address |
| 10956 | +-----------+ | | | .-| overlay 2 | |
| 10957 | | | | | | | |
| 10958 | mapped --->+-----------+ | | +-----------+ |
| 10959 | address | | | | | | |
| 10960 | | overlay | <-' | | | |
| 10961 | | area | <---' +-----------+<-- overlay 3 |
| 10962 | | | <---. | | load address |
| 10963 | +-----------+ `--| overlay 3 | |
| 10964 | | | | | |
| 10965 | +-----------+ | | |
| 10966 | +-----------+ |
| 10967 | | | |
| 10968 | +-----------+ |
| 10969 | |
| 10970 | @anchor{A code overlay}A code overlay |
| 10971 | @end group |
| 10972 | @end smallexample |
| 10973 | |
| 10974 | The diagram (@pxref{A code overlay}) shows a system with separate data |
| 10975 | and instruction address spaces. To map an overlay, the program copies |
| 10976 | its code from the larger address space to the instruction address space. |
| 10977 | Since the overlays shown here all use the same mapped address, only one |
| 10978 | may be mapped at a time. For a system with a single address space for |
| 10979 | data and instructions, the diagram would be similar, except that the |
| 10980 | program variables and heap would share an address space with the main |
| 10981 | program and the overlay area. |
| 10982 | |
| 10983 | An overlay loaded into instruction memory and ready for use is called a |
| 10984 | @dfn{mapped} overlay; its @dfn{mapped address} is its address in the |
| 10985 | instruction memory. An overlay not present (or only partially present) |
| 10986 | in instruction memory is called @dfn{unmapped}; its @dfn{load address} |
| 10987 | is its address in the larger memory. The mapped address is also called |
| 10988 | the @dfn{virtual memory address}, or @dfn{VMA}; the load address is also |
| 10989 | called the @dfn{load memory address}, or @dfn{LMA}. |
| 10990 | |
| 10991 | Unfortunately, overlays are not a completely transparent way to adapt a |
| 10992 | program to limited instruction memory. They introduce a new set of |
| 10993 | global constraints you must keep in mind as you design your program: |
| 10994 | |
| 10995 | @itemize @bullet |
| 10996 | |
| 10997 | @item |
| 10998 | Before calling or returning to a function in an overlay, your program |
| 10999 | must make sure that overlay is actually mapped. Otherwise, the call or |
| 11000 | return will transfer control to the right address, but in the wrong |
| 11001 | overlay, and your program will probably crash. |
| 11002 | |
| 11003 | @item |
| 11004 | If the process of mapping an overlay is expensive on your system, you |
| 11005 | will need to choose your overlays carefully to minimize their effect on |
| 11006 | your program's performance. |
| 11007 | |
| 11008 | @item |
| 11009 | The executable file you load onto your system must contain each |
| 11010 | overlay's instructions, appearing at the overlay's load address, not its |
| 11011 | mapped address. However, each overlay's instructions must be relocated |
| 11012 | and its symbols defined as if the overlay were at its mapped address. |
| 11013 | You can use GNU linker scripts to specify different load and relocation |
| 11014 | addresses for pieces of your program; see @ref{Overlay Description,,, |
| 11015 | ld.info, Using ld: the GNU linker}. |
| 11016 | |
| 11017 | @item |
| 11018 | The procedure for loading executable files onto your system must be able |
| 11019 | to load their contents into the larger address space as well as the |
| 11020 | instruction and data spaces. |
| 11021 | |
| 11022 | @end itemize |
| 11023 | |
| 11024 | The overlay system described above is rather simple, and could be |
| 11025 | improved in many ways: |
| 11026 | |
| 11027 | @itemize @bullet |
| 11028 | |
| 11029 | @item |
| 11030 | If your system has suitable bank switch registers or memory management |
| 11031 | hardware, you could use those facilities to make an overlay's load area |
| 11032 | contents simply appear at their mapped address in instruction space. |
| 11033 | This would probably be faster than copying the overlay to its mapped |
| 11034 | area in the usual way. |
| 11035 | |
| 11036 | @item |
| 11037 | If your overlays are small enough, you could set aside more than one |
| 11038 | overlay area, and have more than one overlay mapped at a time. |
| 11039 | |
| 11040 | @item |
| 11041 | You can use overlays to manage data, as well as instructions. In |
| 11042 | general, data overlays are even less transparent to your design than |
| 11043 | code overlays: whereas code overlays only require care when you call or |
| 11044 | return to functions, data overlays require care every time you access |
| 11045 | the data. Also, if you change the contents of a data overlay, you |
| 11046 | must copy its contents back out to its load address before you can copy a |
| 11047 | different data overlay into the same mapped area. |
| 11048 | |
| 11049 | @end itemize |
| 11050 | |
| 11051 | |
| 11052 | @node Overlay Commands |
| 11053 | @section Overlay Commands |
| 11054 | |
| 11055 | To use @value{GDBN}'s overlay support, each overlay in your program must |
| 11056 | correspond to a separate section of the executable file. The section's |
| 11057 | virtual memory address and load memory address must be the overlay's |
| 11058 | mapped and load addresses. Identifying overlays with sections allows |
| 11059 | @value{GDBN} to determine the appropriate address of a function or |
| 11060 | variable, depending on whether the overlay is mapped or not. |
| 11061 | |
| 11062 | @value{GDBN}'s overlay commands all start with the word @code{overlay}; |
| 11063 | you can abbreviate this as @code{ov} or @code{ovly}. The commands are: |
| 11064 | |
| 11065 | @table @code |
| 11066 | @item overlay off |
| 11067 | @kindex overlay |
| 11068 | Disable @value{GDBN}'s overlay support. When overlay support is |
| 11069 | disabled, @value{GDBN} assumes that all functions and variables are |
| 11070 | always present at their mapped addresses. By default, @value{GDBN}'s |
| 11071 | overlay support is disabled. |
| 11072 | |
| 11073 | @item overlay manual |
| 11074 | @cindex manual overlay debugging |
| 11075 | Enable @dfn{manual} overlay debugging. In this mode, @value{GDBN} |
| 11076 | relies on you to tell it which overlays are mapped, and which are not, |
| 11077 | using the @code{overlay map-overlay} and @code{overlay unmap-overlay} |
| 11078 | commands described below. |
| 11079 | |
| 11080 | @item overlay map-overlay @var{overlay} |
| 11081 | @itemx overlay map @var{overlay} |
| 11082 | @cindex map an overlay |
| 11083 | Tell @value{GDBN} that @var{overlay} is now mapped; @var{overlay} must |
| 11084 | be the name of the object file section containing the overlay. When an |
| 11085 | overlay is mapped, @value{GDBN} assumes it can find the overlay's |
| 11086 | functions and variables at their mapped addresses. @value{GDBN} assumes |
| 11087 | that any other overlays whose mapped ranges overlap that of |
| 11088 | @var{overlay} are now unmapped. |
| 11089 | |
| 11090 | @item overlay unmap-overlay @var{overlay} |
| 11091 | @itemx overlay unmap @var{overlay} |
| 11092 | @cindex unmap an overlay |
| 11093 | Tell @value{GDBN} that @var{overlay} is no longer mapped; @var{overlay} |
| 11094 | must be the name of the object file section containing the overlay. |
| 11095 | When an overlay is unmapped, @value{GDBN} assumes it can find the |
| 11096 | overlay's functions and variables at their load addresses. |
| 11097 | |
| 11098 | @item overlay auto |
| 11099 | Enable @dfn{automatic} overlay debugging. In this mode, @value{GDBN} |
| 11100 | consults a data structure the overlay manager maintains in the inferior |
| 11101 | to see which overlays are mapped. For details, see @ref{Automatic |
| 11102 | Overlay Debugging}. |
| 11103 | |
| 11104 | @item overlay load-target |
| 11105 | @itemx overlay load |
| 11106 | @cindex reloading the overlay table |
| 11107 | Re-read the overlay table from the inferior. Normally, @value{GDBN} |
| 11108 | re-reads the table @value{GDBN} automatically each time the inferior |
| 11109 | stops, so this command should only be necessary if you have changed the |
| 11110 | overlay mapping yourself using @value{GDBN}. This command is only |
| 11111 | useful when using automatic overlay debugging. |
| 11112 | |
| 11113 | @item overlay list-overlays |
| 11114 | @itemx overlay list |
| 11115 | @cindex listing mapped overlays |
| 11116 | Display a list of the overlays currently mapped, along with their mapped |
| 11117 | addresses, load addresses, and sizes. |
| 11118 | |
| 11119 | @end table |
| 11120 | |
| 11121 | Normally, when @value{GDBN} prints a code address, it includes the name |
| 11122 | of the function the address falls in: |
| 11123 | |
| 11124 | @smallexample |
| 11125 | (@value{GDBP}) print main |
| 11126 | $3 = @{int ()@} 0x11a0 <main> |
| 11127 | @end smallexample |
| 11128 | @noindent |
| 11129 | When overlay debugging is enabled, @value{GDBN} recognizes code in |
| 11130 | unmapped overlays, and prints the names of unmapped functions with |
| 11131 | asterisks around them. For example, if @code{foo} is a function in an |
| 11132 | unmapped overlay, @value{GDBN} prints it this way: |
| 11133 | |
| 11134 | @smallexample |
| 11135 | (@value{GDBP}) overlay list |
| 11136 | No sections are mapped. |
| 11137 | (@value{GDBP}) print foo |
| 11138 | $5 = @{int (int)@} 0x100000 <*foo*> |
| 11139 | @end smallexample |
| 11140 | @noindent |
| 11141 | When @code{foo}'s overlay is mapped, @value{GDBN} prints the function's |
| 11142 | name normally: |
| 11143 | |
| 11144 | @smallexample |
| 11145 | (@value{GDBP}) overlay list |
| 11146 | Section .ov.foo.text, loaded at 0x100000 - 0x100034, |
| 11147 | mapped at 0x1016 - 0x104a |
| 11148 | (@value{GDBP}) print foo |
| 11149 | $6 = @{int (int)@} 0x1016 <foo> |
| 11150 | @end smallexample |
| 11151 | |
| 11152 | When overlay debugging is enabled, @value{GDBN} can find the correct |
| 11153 | address for functions and variables in an overlay, whether or not the |
| 11154 | overlay is mapped. This allows most @value{GDBN} commands, like |
| 11155 | @code{break} and @code{disassemble}, to work normally, even on unmapped |
| 11156 | code. However, @value{GDBN}'s breakpoint support has some limitations: |
| 11157 | |
| 11158 | @itemize @bullet |
| 11159 | @item |
| 11160 | @cindex breakpoints in overlays |
| 11161 | @cindex overlays, setting breakpoints in |
| 11162 | You can set breakpoints in functions in unmapped overlays, as long as |
| 11163 | @value{GDBN} can write to the overlay at its load address. |
| 11164 | @item |
| 11165 | @value{GDBN} can not set hardware or simulator-based breakpoints in |
| 11166 | unmapped overlays. However, if you set a breakpoint at the end of your |
| 11167 | overlay manager (and tell @value{GDBN} which overlays are now mapped, if |
| 11168 | you are using manual overlay management), @value{GDBN} will re-set its |
| 11169 | breakpoints properly. |
| 11170 | @end itemize |
| 11171 | |
| 11172 | |
| 11173 | @node Automatic Overlay Debugging |
| 11174 | @section Automatic Overlay Debugging |
| 11175 | @cindex automatic overlay debugging |
| 11176 | |
| 11177 | @value{GDBN} can automatically track which overlays are mapped and which |
| 11178 | are not, given some simple co-operation from the overlay manager in the |
| 11179 | inferior. If you enable automatic overlay debugging with the |
| 11180 | @code{overlay auto} command (@pxref{Overlay Commands}), @value{GDBN} |
| 11181 | looks in the inferior's memory for certain variables describing the |
| 11182 | current state of the overlays. |
| 11183 | |
| 11184 | Here are the variables your overlay manager must define to support |
| 11185 | @value{GDBN}'s automatic overlay debugging: |
| 11186 | |
| 11187 | @table @asis |
| 11188 | |
| 11189 | @item @code{_ovly_table}: |
| 11190 | This variable must be an array of the following structures: |
| 11191 | |
| 11192 | @smallexample |
| 11193 | struct |
| 11194 | @{ |
| 11195 | /* The overlay's mapped address. */ |
| 11196 | unsigned long vma; |
| 11197 | |
| 11198 | /* The size of the overlay, in bytes. */ |
| 11199 | unsigned long size; |
| 11200 | |
| 11201 | /* The overlay's load address. */ |
| 11202 | unsigned long lma; |
| 11203 | |
| 11204 | /* Non-zero if the overlay is currently mapped; |
| 11205 | zero otherwise. */ |
| 11206 | unsigned long mapped; |
| 11207 | @} |
| 11208 | @end smallexample |
| 11209 | |
| 11210 | @item @code{_novlys}: |
| 11211 | This variable must be a four-byte signed integer, holding the total |
| 11212 | number of elements in @code{_ovly_table}. |
| 11213 | |
| 11214 | @end table |
| 11215 | |
| 11216 | To decide whether a particular overlay is mapped or not, @value{GDBN} |
| 11217 | looks for an entry in @w{@code{_ovly_table}} whose @code{vma} and |
| 11218 | @code{lma} members equal the VMA and LMA of the overlay's section in the |
| 11219 | executable file. When @value{GDBN} finds a matching entry, it consults |
| 11220 | the entry's @code{mapped} member to determine whether the overlay is |
| 11221 | currently mapped. |
| 11222 | |
| 11223 | In addition, your overlay manager may define a function called |
| 11224 | @code{_ovly_debug_event}. If this function is defined, @value{GDBN} |
| 11225 | will silently set a breakpoint there. If the overlay manager then |
| 11226 | calls this function whenever it has changed the overlay table, this |
| 11227 | will enable @value{GDBN} to accurately keep track of which overlays |
| 11228 | are in program memory, and update any breakpoints that may be set |
| 11229 | in overlays. This will allow breakpoints to work even if the |
| 11230 | overlays are kept in ROM or other non-writable memory while they |
| 11231 | are not being executed. |
| 11232 | |
| 11233 | @node Overlay Sample Program |
| 11234 | @section Overlay Sample Program |
| 11235 | @cindex overlay example program |
| 11236 | |
| 11237 | When linking a program which uses overlays, you must place the overlays |
| 11238 | at their load addresses, while relocating them to run at their mapped |
| 11239 | addresses. To do this, you must write a linker script (@pxref{Overlay |
| 11240 | Description,,, ld.info, Using ld: the GNU linker}). Unfortunately, |
| 11241 | since linker scripts are specific to a particular host system, target |
| 11242 | architecture, and target memory layout, this manual cannot provide |
| 11243 | portable sample code demonstrating @value{GDBN}'s overlay support. |
| 11244 | |
| 11245 | However, the @value{GDBN} source distribution does contain an overlaid |
| 11246 | program, with linker scripts for a few systems, as part of its test |
| 11247 | suite. The program consists of the following files from |
| 11248 | @file{gdb/testsuite/gdb.base}: |
| 11249 | |
| 11250 | @table @file |
| 11251 | @item overlays.c |
| 11252 | The main program file. |
| 11253 | @item ovlymgr.c |
| 11254 | A simple overlay manager, used by @file{overlays.c}. |
| 11255 | @item foo.c |
| 11256 | @itemx bar.c |
| 11257 | @itemx baz.c |
| 11258 | @itemx grbx.c |
| 11259 | Overlay modules, loaded and used by @file{overlays.c}. |
| 11260 | @item d10v.ld |
| 11261 | @itemx m32r.ld |
| 11262 | Linker scripts for linking the test program on the @code{d10v-elf} |
| 11263 | and @code{m32r-elf} targets. |
| 11264 | @end table |
| 11265 | |
| 11266 | You can build the test program using the @code{d10v-elf} GCC |
| 11267 | cross-compiler like this: |
| 11268 | |
| 11269 | @smallexample |
| 11270 | $ d10v-elf-gcc -g -c overlays.c |
| 11271 | $ d10v-elf-gcc -g -c ovlymgr.c |
| 11272 | $ d10v-elf-gcc -g -c foo.c |
| 11273 | $ d10v-elf-gcc -g -c bar.c |
| 11274 | $ d10v-elf-gcc -g -c baz.c |
| 11275 | $ d10v-elf-gcc -g -c grbx.c |
| 11276 | $ d10v-elf-gcc -g overlays.o ovlymgr.o foo.o bar.o \ |
| 11277 | baz.o grbx.o -Wl,-Td10v.ld -o overlays |
| 11278 | @end smallexample |
| 11279 | |
| 11280 | The build process is identical for any other architecture, except that |
| 11281 | you must substitute the appropriate compiler and linker script for the |
| 11282 | target system for @code{d10v-elf-gcc} and @code{d10v.ld}. |
| 11283 | |
| 11284 | |
| 11285 | @node Languages |
| 11286 | @chapter Using @value{GDBN} with Different Languages |
| 11287 | @cindex languages |
| 11288 | |
| 11289 | Although programming languages generally have common aspects, they are |
| 11290 | rarely expressed in the same manner. For instance, in ANSI C, |
| 11291 | dereferencing a pointer @code{p} is accomplished by @code{*p}, but in |
| 11292 | Modula-2, it is accomplished by @code{p^}. Values can also be |
| 11293 | represented (and displayed) differently. Hex numbers in C appear as |
| 11294 | @samp{0x1ae}, while in Modula-2 they appear as @samp{1AEH}. |
| 11295 | |
| 11296 | @cindex working language |
| 11297 | Language-specific information is built into @value{GDBN} for some languages, |
| 11298 | allowing you to express operations like the above in your program's |
| 11299 | native language, and allowing @value{GDBN} to output values in a manner |
| 11300 | consistent with the syntax of your program's native language. The |
| 11301 | language you use to build expressions is called the @dfn{working |
| 11302 | language}. |
| 11303 | |
| 11304 | @menu |
| 11305 | * Setting:: Switching between source languages |
| 11306 | * Show:: Displaying the language |
| 11307 | * Checks:: Type and range checks |
| 11308 | * Supported Languages:: Supported languages |
| 11309 | * Unsupported Languages:: Unsupported languages |
| 11310 | @end menu |
| 11311 | |
| 11312 | @node Setting |
| 11313 | @section Switching Between Source Languages |
| 11314 | |
| 11315 | There are two ways to control the working language---either have @value{GDBN} |
| 11316 | set it automatically, or select it manually yourself. You can use the |
| 11317 | @code{set language} command for either purpose. On startup, @value{GDBN} |
| 11318 | defaults to setting the language automatically. The working language is |
| 11319 | used to determine how expressions you type are interpreted, how values |
| 11320 | are printed, etc. |
| 11321 | |
| 11322 | In addition to the working language, every source file that |
| 11323 | @value{GDBN} knows about has its own working language. For some object |
| 11324 | file formats, the compiler might indicate which language a particular |
| 11325 | source file is in. However, most of the time @value{GDBN} infers the |
| 11326 | language from the name of the file. The language of a source file |
| 11327 | controls whether C@t{++} names are demangled---this way @code{backtrace} can |
| 11328 | show each frame appropriately for its own language. There is no way to |
| 11329 | set the language of a source file from within @value{GDBN}, but you can |
| 11330 | set the language associated with a filename extension. @xref{Show, , |
| 11331 | Displaying the Language}. |
| 11332 | |
| 11333 | This is most commonly a problem when you use a program, such |
| 11334 | as @code{cfront} or @code{f2c}, that generates C but is written in |
| 11335 | another language. In that case, make the |
| 11336 | program use @code{#line} directives in its C output; that way |
| 11337 | @value{GDBN} will know the correct language of the source code of the original |
| 11338 | program, and will display that source code, not the generated C code. |
| 11339 | |
| 11340 | @menu |
| 11341 | * Filenames:: Filename extensions and languages. |
| 11342 | * Manually:: Setting the working language manually |
| 11343 | * Automatically:: Having @value{GDBN} infer the source language |
| 11344 | @end menu |
| 11345 | |
| 11346 | @node Filenames |
| 11347 | @subsection List of Filename Extensions and Languages |
| 11348 | |
| 11349 | If a source file name ends in one of the following extensions, then |
| 11350 | @value{GDBN} infers that its language is the one indicated. |
| 11351 | |
| 11352 | @table @file |
| 11353 | @item .ada |
| 11354 | @itemx .ads |
| 11355 | @itemx .adb |
| 11356 | @itemx .a |
| 11357 | Ada source file. |
| 11358 | |
| 11359 | @item .c |
| 11360 | C source file |
| 11361 | |
| 11362 | @item .C |
| 11363 | @itemx .cc |
| 11364 | @itemx .cp |
| 11365 | @itemx .cpp |
| 11366 | @itemx .cxx |
| 11367 | @itemx .c++ |
| 11368 | C@t{++} source file |
| 11369 | |
| 11370 | @item .d |
| 11371 | D source file |
| 11372 | |
| 11373 | @item .m |
| 11374 | Objective-C source file |
| 11375 | |
| 11376 | @item .f |
| 11377 | @itemx .F |
| 11378 | Fortran source file |
| 11379 | |
| 11380 | @item .mod |
| 11381 | Modula-2 source file |
| 11382 | |
| 11383 | @item .s |
| 11384 | @itemx .S |
| 11385 | Assembler source file. This actually behaves almost like C, but |
| 11386 | @value{GDBN} does not skip over function prologues when stepping. |
| 11387 | @end table |
| 11388 | |
| 11389 | In addition, you may set the language associated with a filename |
| 11390 | extension. @xref{Show, , Displaying the Language}. |
| 11391 | |
| 11392 | @node Manually |
| 11393 | @subsection Setting the Working Language |
| 11394 | |
| 11395 | If you allow @value{GDBN} to set the language automatically, |
| 11396 | expressions are interpreted the same way in your debugging session and |
| 11397 | your program. |
| 11398 | |
| 11399 | @kindex set language |
| 11400 | If you wish, you may set the language manually. To do this, issue the |
| 11401 | command @samp{set language @var{lang}}, where @var{lang} is the name of |
| 11402 | a language, such as |
| 11403 | @code{c} or @code{modula-2}. |
| 11404 | For a list of the supported languages, type @samp{set language}. |
| 11405 | |
| 11406 | Setting the language manually prevents @value{GDBN} from updating the working |
| 11407 | language automatically. This can lead to confusion if you try |
| 11408 | to debug a program when the working language is not the same as the |
| 11409 | source language, when an expression is acceptable to both |
| 11410 | languages---but means different things. For instance, if the current |
| 11411 | source file were written in C, and @value{GDBN} was parsing Modula-2, a |
| 11412 | command such as: |
| 11413 | |
| 11414 | @smallexample |
| 11415 | print a = b + c |
| 11416 | @end smallexample |
| 11417 | |
| 11418 | @noindent |
| 11419 | might not have the effect you intended. In C, this means to add |
| 11420 | @code{b} and @code{c} and place the result in @code{a}. The result |
| 11421 | printed would be the value of @code{a}. In Modula-2, this means to compare |
| 11422 | @code{a} to the result of @code{b+c}, yielding a @code{BOOLEAN} value. |
| 11423 | |
| 11424 | @node Automatically |
| 11425 | @subsection Having @value{GDBN} Infer the Source Language |
| 11426 | |
| 11427 | To have @value{GDBN} set the working language automatically, use |
| 11428 | @samp{set language local} or @samp{set language auto}. @value{GDBN} |
| 11429 | then infers the working language. That is, when your program stops in a |
| 11430 | frame (usually by encountering a breakpoint), @value{GDBN} sets the |
| 11431 | working language to the language recorded for the function in that |
| 11432 | frame. If the language for a frame is unknown (that is, if the function |
| 11433 | or block corresponding to the frame was defined in a source file that |
| 11434 | does not have a recognized extension), the current working language is |
| 11435 | not changed, and @value{GDBN} issues a warning. |
| 11436 | |
| 11437 | This may not seem necessary for most programs, which are written |
| 11438 | entirely in one source language. However, program modules and libraries |
| 11439 | written in one source language can be used by a main program written in |
| 11440 | a different source language. Using @samp{set language auto} in this |
| 11441 | case frees you from having to set the working language manually. |
| 11442 | |
| 11443 | @node Show |
| 11444 | @section Displaying the Language |
| 11445 | |
| 11446 | The following commands help you find out which language is the |
| 11447 | working language, and also what language source files were written in. |
| 11448 | |
| 11449 | @table @code |
| 11450 | @item show language |
| 11451 | @kindex show language |
| 11452 | Display the current working language. This is the |
| 11453 | language you can use with commands such as @code{print} to |
| 11454 | build and compute expressions that may involve variables in your program. |
| 11455 | |
| 11456 | @item info frame |
| 11457 | @kindex info frame@r{, show the source language} |
| 11458 | Display the source language for this frame. This language becomes the |
| 11459 | working language if you use an identifier from this frame. |
| 11460 | @xref{Frame Info, ,Information about a Frame}, to identify the other |
| 11461 | information listed here. |
| 11462 | |
| 11463 | @item info source |
| 11464 | @kindex info source@r{, show the source language} |
| 11465 | Display the source language of this source file. |
| 11466 | @xref{Symbols, ,Examining the Symbol Table}, to identify the other |
| 11467 | information listed here. |
| 11468 | @end table |
| 11469 | |
| 11470 | In unusual circumstances, you may have source files with extensions |
| 11471 | not in the standard list. You can then set the extension associated |
| 11472 | with a language explicitly: |
| 11473 | |
| 11474 | @table @code |
| 11475 | @item set extension-language @var{ext} @var{language} |
| 11476 | @kindex set extension-language |
| 11477 | Tell @value{GDBN} that source files with extension @var{ext} are to be |
| 11478 | assumed as written in the source language @var{language}. |
| 11479 | |
| 11480 | @item info extensions |
| 11481 | @kindex info extensions |
| 11482 | List all the filename extensions and the associated languages. |
| 11483 | @end table |
| 11484 | |
| 11485 | @node Checks |
| 11486 | @section Type and Range Checking |
| 11487 | |
| 11488 | @quotation |
| 11489 | @emph{Warning:} In this release, the @value{GDBN} commands for type and range |
| 11490 | checking are included, but they do not yet have any effect. This |
| 11491 | section documents the intended facilities. |
| 11492 | @end quotation |
| 11493 | @c FIXME remove warning when type/range code added |
| 11494 | |
| 11495 | Some languages are designed to guard you against making seemingly common |
| 11496 | errors through a series of compile- and run-time checks. These include |
| 11497 | checking the type of arguments to functions and operators, and making |
| 11498 | sure mathematical overflows are caught at run time. Checks such as |
| 11499 | these help to ensure a program's correctness once it has been compiled |
| 11500 | by eliminating type mismatches, and providing active checks for range |
| 11501 | errors when your program is running. |
| 11502 | |
| 11503 | @value{GDBN} can check for conditions like the above if you wish. |
| 11504 | Although @value{GDBN} does not check the statements in your program, |
| 11505 | it can check expressions entered directly into @value{GDBN} for |
| 11506 | evaluation via the @code{print} command, for example. As with the |
| 11507 | working language, @value{GDBN} can also decide whether or not to check |
| 11508 | automatically based on your program's source language. |
| 11509 | @xref{Supported Languages, ,Supported Languages}, for the default |
| 11510 | settings of supported languages. |
| 11511 | |
| 11512 | @menu |
| 11513 | * Type Checking:: An overview of type checking |
| 11514 | * Range Checking:: An overview of range checking |
| 11515 | @end menu |
| 11516 | |
| 11517 | @cindex type checking |
| 11518 | @cindex checks, type |
| 11519 | @node Type Checking |
| 11520 | @subsection An Overview of Type Checking |
| 11521 | |
| 11522 | Some languages, such as Modula-2, are strongly typed, meaning that the |
| 11523 | arguments to operators and functions have to be of the correct type, |
| 11524 | otherwise an error occurs. These checks prevent type mismatch |
| 11525 | errors from ever causing any run-time problems. For example, |
| 11526 | |
| 11527 | @smallexample |
| 11528 | 1 + 2 @result{} 3 |
| 11529 | @exdent but |
| 11530 | @error{} 1 + 2.3 |
| 11531 | @end smallexample |
| 11532 | |
| 11533 | The second example fails because the @code{CARDINAL} 1 is not |
| 11534 | type-compatible with the @code{REAL} 2.3. |
| 11535 | |
| 11536 | For the expressions you use in @value{GDBN} commands, you can tell the |
| 11537 | @value{GDBN} type checker to skip checking; |
| 11538 | to treat any mismatches as errors and abandon the expression; |
| 11539 | or to only issue warnings when type mismatches occur, |
| 11540 | but evaluate the expression anyway. When you choose the last of |
| 11541 | these, @value{GDBN} evaluates expressions like the second example above, but |
| 11542 | also issues a warning. |
| 11543 | |
| 11544 | Even if you turn type checking off, there may be other reasons |
| 11545 | related to type that prevent @value{GDBN} from evaluating an expression. |
| 11546 | For instance, @value{GDBN} does not know how to add an @code{int} and |
| 11547 | a @code{struct foo}. These particular type errors have nothing to do |
| 11548 | with the language in use, and usually arise from expressions, such as |
| 11549 | the one described above, which make little sense to evaluate anyway. |
| 11550 | |
| 11551 | Each language defines to what degree it is strict about type. For |
| 11552 | instance, both Modula-2 and C require the arguments to arithmetical |
| 11553 | operators to be numbers. In C, enumerated types and pointers can be |
| 11554 | represented as numbers, so that they are valid arguments to mathematical |
| 11555 | operators. @xref{Supported Languages, ,Supported Languages}, for further |
| 11556 | details on specific languages. |
| 11557 | |
| 11558 | @value{GDBN} provides some additional commands for controlling the type checker: |
| 11559 | |
| 11560 | @kindex set check type |
| 11561 | @kindex show check type |
| 11562 | @table @code |
| 11563 | @item set check type auto |
| 11564 | Set type checking on or off based on the current working language. |
| 11565 | @xref{Supported Languages, ,Supported Languages}, for the default settings for |
| 11566 | each language. |
| 11567 | |
| 11568 | @item set check type on |
| 11569 | @itemx set check type off |
| 11570 | Set type checking on or off, overriding the default setting for the |
| 11571 | current working language. Issue a warning if the setting does not |
| 11572 | match the language default. If any type mismatches occur in |
| 11573 | evaluating an expression while type checking is on, @value{GDBN} prints a |
| 11574 | message and aborts evaluation of the expression. |
| 11575 | |
| 11576 | @item set check type warn |
| 11577 | Cause the type checker to issue warnings, but to always attempt to |
| 11578 | evaluate the expression. Evaluating the expression may still |
| 11579 | be impossible for other reasons. For example, @value{GDBN} cannot add |
| 11580 | numbers and structures. |
| 11581 | |
| 11582 | @item show type |
| 11583 | Show the current setting of the type checker, and whether or not @value{GDBN} |
| 11584 | is setting it automatically. |
| 11585 | @end table |
| 11586 | |
| 11587 | @cindex range checking |
| 11588 | @cindex checks, range |
| 11589 | @node Range Checking |
| 11590 | @subsection An Overview of Range Checking |
| 11591 | |
| 11592 | In some languages (such as Modula-2), it is an error to exceed the |
| 11593 | bounds of a type; this is enforced with run-time checks. Such range |
| 11594 | checking is meant to ensure program correctness by making sure |
| 11595 | computations do not overflow, or indices on an array element access do |
| 11596 | not exceed the bounds of the array. |
| 11597 | |
| 11598 | For expressions you use in @value{GDBN} commands, you can tell |
| 11599 | @value{GDBN} to treat range errors in one of three ways: ignore them, |
| 11600 | always treat them as errors and abandon the expression, or issue |
| 11601 | warnings but evaluate the expression anyway. |
| 11602 | |
| 11603 | A range error can result from numerical overflow, from exceeding an |
| 11604 | array index bound, or when you type a constant that is not a member |
| 11605 | of any type. Some languages, however, do not treat overflows as an |
| 11606 | error. In many implementations of C, mathematical overflow causes the |
| 11607 | result to ``wrap around'' to lower values---for example, if @var{m} is |
| 11608 | the largest integer value, and @var{s} is the smallest, then |
| 11609 | |
| 11610 | @smallexample |
| 11611 | @var{m} + 1 @result{} @var{s} |
| 11612 | @end smallexample |
| 11613 | |
| 11614 | This, too, is specific to individual languages, and in some cases |
| 11615 | specific to individual compilers or machines. @xref{Supported Languages, , |
| 11616 | Supported Languages}, for further details on specific languages. |
| 11617 | |
| 11618 | @value{GDBN} provides some additional commands for controlling the range checker: |
| 11619 | |
| 11620 | @kindex set check range |
| 11621 | @kindex show check range |
| 11622 | @table @code |
| 11623 | @item set check range auto |
| 11624 | Set range checking on or off based on the current working language. |
| 11625 | @xref{Supported Languages, ,Supported Languages}, for the default settings for |
| 11626 | each language. |
| 11627 | |
| 11628 | @item set check range on |
| 11629 | @itemx set check range off |
| 11630 | Set range checking on or off, overriding the default setting for the |
| 11631 | current working language. A warning is issued if the setting does not |
| 11632 | match the language default. If a range error occurs and range checking is on, |
| 11633 | then a message is printed and evaluation of the expression is aborted. |
| 11634 | |
| 11635 | @item set check range warn |
| 11636 | Output messages when the @value{GDBN} range checker detects a range error, |
| 11637 | but attempt to evaluate the expression anyway. Evaluating the |
| 11638 | expression may still be impossible for other reasons, such as accessing |
| 11639 | memory that the process does not own (a typical example from many Unix |
| 11640 | systems). |
| 11641 | |
| 11642 | @item show range |
| 11643 | Show the current setting of the range checker, and whether or not it is |
| 11644 | being set automatically by @value{GDBN}. |
| 11645 | @end table |
| 11646 | |
| 11647 | @node Supported Languages |
| 11648 | @section Supported Languages |
| 11649 | |
| 11650 | @value{GDBN} supports C, C@t{++}, D, Objective-C, Fortran, Java, OpenCL C, Pascal, |
| 11651 | assembly, Modula-2, and Ada. |
| 11652 | @c This is false ... |
| 11653 | Some @value{GDBN} features may be used in expressions regardless of the |
| 11654 | language you use: the @value{GDBN} @code{@@} and @code{::} operators, |
| 11655 | and the @samp{@{type@}addr} construct (@pxref{Expressions, |
| 11656 | ,Expressions}) can be used with the constructs of any supported |
| 11657 | language. |
| 11658 | |
| 11659 | The following sections detail to what degree each source language is |
| 11660 | supported by @value{GDBN}. These sections are not meant to be language |
| 11661 | tutorials or references, but serve only as a reference guide to what the |
| 11662 | @value{GDBN} expression parser accepts, and what input and output |
| 11663 | formats should look like for different languages. There are many good |
| 11664 | books written on each of these languages; please look to these for a |
| 11665 | language reference or tutorial. |
| 11666 | |
| 11667 | @menu |
| 11668 | * C:: C and C@t{++} |
| 11669 | * D:: D |
| 11670 | * Objective-C:: Objective-C |
| 11671 | * OpenCL C:: OpenCL C |
| 11672 | * Fortran:: Fortran |
| 11673 | * Pascal:: Pascal |
| 11674 | * Modula-2:: Modula-2 |
| 11675 | * Ada:: Ada |
| 11676 | @end menu |
| 11677 | |
| 11678 | @node C |
| 11679 | @subsection C and C@t{++} |
| 11680 | |
| 11681 | @cindex C and C@t{++} |
| 11682 | @cindex expressions in C or C@t{++} |
| 11683 | |
| 11684 | Since C and C@t{++} are so closely related, many features of @value{GDBN} apply |
| 11685 | to both languages. Whenever this is the case, we discuss those languages |
| 11686 | together. |
| 11687 | |
| 11688 | @cindex C@t{++} |
| 11689 | @cindex @code{g++}, @sc{gnu} C@t{++} compiler |
| 11690 | @cindex @sc{gnu} C@t{++} |
| 11691 | The C@t{++} debugging facilities are jointly implemented by the C@t{++} |
| 11692 | compiler and @value{GDBN}. Therefore, to debug your C@t{++} code |
| 11693 | effectively, you must compile your C@t{++} programs with a supported |
| 11694 | C@t{++} compiler, such as @sc{gnu} @code{g++}, or the HP ANSI C@t{++} |
| 11695 | compiler (@code{aCC}). |
| 11696 | |
| 11697 | For best results when using @sc{gnu} C@t{++}, use the DWARF 2 debugging |
| 11698 | format; if it doesn't work on your system, try the stabs+ debugging |
| 11699 | format. You can select those formats explicitly with the @code{g++} |
| 11700 | command-line options @option{-gdwarf-2} and @option{-gstabs+}. |
| 11701 | @xref{Debugging Options,,Options for Debugging Your Program or GCC, |
| 11702 | gcc.info, Using the @sc{gnu} Compiler Collection (GCC)}. |
| 11703 | |
| 11704 | @menu |
| 11705 | * C Operators:: C and C@t{++} operators |
| 11706 | * C Constants:: C and C@t{++} constants |
| 11707 | * C Plus Plus Expressions:: C@t{++} expressions |
| 11708 | * C Defaults:: Default settings for C and C@t{++} |
| 11709 | * C Checks:: C and C@t{++} type and range checks |
| 11710 | * Debugging C:: @value{GDBN} and C |
| 11711 | * Debugging C Plus Plus:: @value{GDBN} features for C@t{++} |
| 11712 | * Decimal Floating Point:: Numbers in Decimal Floating Point format |
| 11713 | @end menu |
| 11714 | |
| 11715 | @node C Operators |
| 11716 | @subsubsection C and C@t{++} Operators |
| 11717 | |
| 11718 | @cindex C and C@t{++} operators |
| 11719 | |
| 11720 | Operators must be defined on values of specific types. For instance, |
| 11721 | @code{+} is defined on numbers, but not on structures. Operators are |
| 11722 | often defined on groups of types. |
| 11723 | |
| 11724 | For the purposes of C and C@t{++}, the following definitions hold: |
| 11725 | |
| 11726 | @itemize @bullet |
| 11727 | |
| 11728 | @item |
| 11729 | @emph{Integral types} include @code{int} with any of its storage-class |
| 11730 | specifiers; @code{char}; @code{enum}; and, for C@t{++}, @code{bool}. |
| 11731 | |
| 11732 | @item |
| 11733 | @emph{Floating-point types} include @code{float}, @code{double}, and |
| 11734 | @code{long double} (if supported by the target platform). |
| 11735 | |
| 11736 | @item |
| 11737 | @emph{Pointer types} include all types defined as @code{(@var{type} *)}. |
| 11738 | |
| 11739 | @item |
| 11740 | @emph{Scalar types} include all of the above. |
| 11741 | |
| 11742 | @end itemize |
| 11743 | |
| 11744 | @noindent |
| 11745 | The following operators are supported. They are listed here |
| 11746 | in order of increasing precedence: |
| 11747 | |
| 11748 | @table @code |
| 11749 | @item , |
| 11750 | The comma or sequencing operator. Expressions in a comma-separated list |
| 11751 | are evaluated from left to right, with the result of the entire |
| 11752 | expression being the last expression evaluated. |
| 11753 | |
| 11754 | @item = |
| 11755 | Assignment. The value of an assignment expression is the value |
| 11756 | assigned. Defined on scalar types. |
| 11757 | |
| 11758 | @item @var{op}= |
| 11759 | Used in an expression of the form @w{@code{@var{a} @var{op}= @var{b}}}, |
| 11760 | and translated to @w{@code{@var{a} = @var{a op b}}}. |
| 11761 | @w{@code{@var{op}=}} and @code{=} have the same precedence. |
| 11762 | @var{op} is any one of the operators @code{|}, @code{^}, @code{&}, |
| 11763 | @code{<<}, @code{>>}, @code{+}, @code{-}, @code{*}, @code{/}, @code{%}. |
| 11764 | |
| 11765 | @item ?: |
| 11766 | The ternary operator. @code{@var{a} ? @var{b} : @var{c}} can be thought |
| 11767 | of as: if @var{a} then @var{b} else @var{c}. @var{a} should be of an |
| 11768 | integral type. |
| 11769 | |
| 11770 | @item || |
| 11771 | Logical @sc{or}. Defined on integral types. |
| 11772 | |
| 11773 | @item && |
| 11774 | Logical @sc{and}. Defined on integral types. |
| 11775 | |
| 11776 | @item | |
| 11777 | Bitwise @sc{or}. Defined on integral types. |
| 11778 | |
| 11779 | @item ^ |
| 11780 | Bitwise exclusive-@sc{or}. Defined on integral types. |
| 11781 | |
| 11782 | @item & |
| 11783 | Bitwise @sc{and}. Defined on integral types. |
| 11784 | |
| 11785 | @item ==@r{, }!= |
| 11786 | Equality and inequality. Defined on scalar types. The value of these |
| 11787 | expressions is 0 for false and non-zero for true. |
| 11788 | |
| 11789 | @item <@r{, }>@r{, }<=@r{, }>= |
| 11790 | Less than, greater than, less than or equal, greater than or equal. |
| 11791 | Defined on scalar types. The value of these expressions is 0 for false |
| 11792 | and non-zero for true. |
| 11793 | |
| 11794 | @item <<@r{, }>> |
| 11795 | left shift, and right shift. Defined on integral types. |
| 11796 | |
| 11797 | @item @@ |
| 11798 | The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}). |
| 11799 | |
| 11800 | @item +@r{, }- |
| 11801 | Addition and subtraction. Defined on integral types, floating-point types and |
| 11802 | pointer types. |
| 11803 | |
| 11804 | @item *@r{, }/@r{, }% |
| 11805 | Multiplication, division, and modulus. Multiplication and division are |
| 11806 | defined on integral and floating-point types. Modulus is defined on |
| 11807 | integral types. |
| 11808 | |
| 11809 | @item ++@r{, }-- |
| 11810 | Increment and decrement. When appearing before a variable, the |
| 11811 | operation is performed before the variable is used in an expression; |
| 11812 | when appearing after it, the variable's value is used before the |
| 11813 | operation takes place. |
| 11814 | |
| 11815 | @item * |
| 11816 | Pointer dereferencing. Defined on pointer types. Same precedence as |
| 11817 | @code{++}. |
| 11818 | |
| 11819 | @item & |
| 11820 | Address operator. Defined on variables. Same precedence as @code{++}. |
| 11821 | |
| 11822 | For debugging C@t{++}, @value{GDBN} implements a use of @samp{&} beyond what is |
| 11823 | allowed in the C@t{++} language itself: you can use @samp{&(&@var{ref})} |
| 11824 | to examine the address |
| 11825 | where a C@t{++} reference variable (declared with @samp{&@var{ref}}) is |
| 11826 | stored. |
| 11827 | |
| 11828 | @item - |
| 11829 | Negative. Defined on integral and floating-point types. Same |
| 11830 | precedence as @code{++}. |
| 11831 | |
| 11832 | @item ! |
| 11833 | Logical negation. Defined on integral types. Same precedence as |
| 11834 | @code{++}. |
| 11835 | |
| 11836 | @item ~ |
| 11837 | Bitwise complement operator. Defined on integral types. Same precedence as |
| 11838 | @code{++}. |
| 11839 | |
| 11840 | |
| 11841 | @item .@r{, }-> |
| 11842 | Structure member, and pointer-to-structure member. For convenience, |
| 11843 | @value{GDBN} regards the two as equivalent, choosing whether to dereference a |
| 11844 | pointer based on the stored type information. |
| 11845 | Defined on @code{struct} and @code{union} data. |
| 11846 | |
| 11847 | @item .*@r{, }->* |
| 11848 | Dereferences of pointers to members. |
| 11849 | |
| 11850 | @item [] |
| 11851 | Array indexing. @code{@var{a}[@var{i}]} is defined as |
| 11852 | @code{*(@var{a}+@var{i})}. Same precedence as @code{->}. |
| 11853 | |
| 11854 | @item () |
| 11855 | Function parameter list. Same precedence as @code{->}. |
| 11856 | |
| 11857 | @item :: |
| 11858 | C@t{++} scope resolution operator. Defined on @code{struct}, @code{union}, |
| 11859 | and @code{class} types. |
| 11860 | |
| 11861 | @item :: |
| 11862 | Doubled colons also represent the @value{GDBN} scope operator |
| 11863 | (@pxref{Expressions, ,Expressions}). Same precedence as @code{::}, |
| 11864 | above. |
| 11865 | @end table |
| 11866 | |
| 11867 | If an operator is redefined in the user code, @value{GDBN} usually |
| 11868 | attempts to invoke the redefined version instead of using the operator's |
| 11869 | predefined meaning. |
| 11870 | |
| 11871 | @node C Constants |
| 11872 | @subsubsection C and C@t{++} Constants |
| 11873 | |
| 11874 | @cindex C and C@t{++} constants |
| 11875 | |
| 11876 | @value{GDBN} allows you to express the constants of C and C@t{++} in the |
| 11877 | following ways: |
| 11878 | |
| 11879 | @itemize @bullet |
| 11880 | @item |
| 11881 | Integer constants are a sequence of digits. Octal constants are |
| 11882 | specified by a leading @samp{0} (i.e.@: zero), and hexadecimal constants |
| 11883 | by a leading @samp{0x} or @samp{0X}. Constants may also end with a letter |
| 11884 | @samp{l}, specifying that the constant should be treated as a |
| 11885 | @code{long} value. |
| 11886 | |
| 11887 | @item |
| 11888 | Floating point constants are a sequence of digits, followed by a decimal |
| 11889 | point, followed by a sequence of digits, and optionally followed by an |
| 11890 | exponent. An exponent is of the form: |
| 11891 | @samp{@w{e@r{[[}+@r{]|}-@r{]}@var{nnn}}}, where @var{nnn} is another |
| 11892 | sequence of digits. The @samp{+} is optional for positive exponents. |
| 11893 | A floating-point constant may also end with a letter @samp{f} or |
| 11894 | @samp{F}, specifying that the constant should be treated as being of |
| 11895 | the @code{float} (as opposed to the default @code{double}) type; or with |
| 11896 | a letter @samp{l} or @samp{L}, which specifies a @code{long double} |
| 11897 | constant. |
| 11898 | |
| 11899 | @item |
| 11900 | Enumerated constants consist of enumerated identifiers, or their |
| 11901 | integral equivalents. |
| 11902 | |
| 11903 | @item |
| 11904 | Character constants are a single character surrounded by single quotes |
| 11905 | (@code{'}), or a number---the ordinal value of the corresponding character |
| 11906 | (usually its @sc{ascii} value). Within quotes, the single character may |
| 11907 | be represented by a letter or by @dfn{escape sequences}, which are of |
| 11908 | the form @samp{\@var{nnn}}, where @var{nnn} is the octal representation |
| 11909 | of the character's ordinal value; or of the form @samp{\@var{x}}, where |
| 11910 | @samp{@var{x}} is a predefined special character---for example, |
| 11911 | @samp{\n} for newline. |
| 11912 | |
| 11913 | @item |
| 11914 | String constants are a sequence of character constants surrounded by |
| 11915 | double quotes (@code{"}). Any valid character constant (as described |
| 11916 | above) may appear. Double quotes within the string must be preceded by |
| 11917 | a backslash, so for instance @samp{"a\"b'c"} is a string of five |
| 11918 | characters. |
| 11919 | |
| 11920 | @item |
| 11921 | Pointer constants are an integral value. You can also write pointers |
| 11922 | to constants using the C operator @samp{&}. |
| 11923 | |
| 11924 | @item |
| 11925 | Array constants are comma-separated lists surrounded by braces @samp{@{} |
| 11926 | and @samp{@}}; for example, @samp{@{1,2,3@}} is a three-element array of |
| 11927 | integers, @samp{@{@{1,2@}, @{3,4@}, @{5,6@}@}} is a three-by-two array, |
| 11928 | and @samp{@{&"hi", &"there", &"fred"@}} is a three-element array of pointers. |
| 11929 | @end itemize |
| 11930 | |
| 11931 | @node C Plus Plus Expressions |
| 11932 | @subsubsection C@t{++} Expressions |
| 11933 | |
| 11934 | @cindex expressions in C@t{++} |
| 11935 | @value{GDBN} expression handling can interpret most C@t{++} expressions. |
| 11936 | |
| 11937 | @cindex debugging C@t{++} programs |
| 11938 | @cindex C@t{++} compilers |
| 11939 | @cindex debug formats and C@t{++} |
| 11940 | @cindex @value{NGCC} and C@t{++} |
| 11941 | @quotation |
| 11942 | @emph{Warning:} @value{GDBN} can only debug C@t{++} code if you use the |
| 11943 | proper compiler and the proper debug format. Currently, @value{GDBN} |
| 11944 | works best when debugging C@t{++} code that is compiled with |
| 11945 | @value{NGCC} 2.95.3 or with @value{NGCC} 3.1 or newer, using the options |
| 11946 | @option{-gdwarf-2} or @option{-gstabs+}. DWARF 2 is preferred over |
| 11947 | stabs+. Most configurations of @value{NGCC} emit either DWARF 2 or |
| 11948 | stabs+ as their default debug format, so you usually don't need to |
| 11949 | specify a debug format explicitly. Other compilers and/or debug formats |
| 11950 | are likely to work badly or not at all when using @value{GDBN} to debug |
| 11951 | C@t{++} code. |
| 11952 | @end quotation |
| 11953 | |
| 11954 | @enumerate |
| 11955 | |
| 11956 | @cindex member functions |
| 11957 | @item |
| 11958 | Member function calls are allowed; you can use expressions like |
| 11959 | |
| 11960 | @smallexample |
| 11961 | count = aml->GetOriginal(x, y) |
| 11962 | @end smallexample |
| 11963 | |
| 11964 | @vindex this@r{, inside C@t{++} member functions} |
| 11965 | @cindex namespace in C@t{++} |
| 11966 | @item |
| 11967 | While a member function is active (in the selected stack frame), your |
| 11968 | expressions have the same namespace available as the member function; |
| 11969 | that is, @value{GDBN} allows implicit references to the class instance |
| 11970 | pointer @code{this} following the same rules as C@t{++}. |
| 11971 | |
| 11972 | @cindex call overloaded functions |
| 11973 | @cindex overloaded functions, calling |
| 11974 | @cindex type conversions in C@t{++} |
| 11975 | @item |
| 11976 | You can call overloaded functions; @value{GDBN} resolves the function |
| 11977 | call to the right definition, with some restrictions. @value{GDBN} does not |
| 11978 | perform overload resolution involving user-defined type conversions, |
| 11979 | calls to constructors, or instantiations of templates that do not exist |
| 11980 | in the program. It also cannot handle ellipsis argument lists or |
| 11981 | default arguments. |
| 11982 | |
| 11983 | It does perform integral conversions and promotions, floating-point |
| 11984 | promotions, arithmetic conversions, pointer conversions, conversions of |
| 11985 | class objects to base classes, and standard conversions such as those of |
| 11986 | functions or arrays to pointers; it requires an exact match on the |
| 11987 | number of function arguments. |
| 11988 | |
| 11989 | Overload resolution is always performed, unless you have specified |
| 11990 | @code{set overload-resolution off}. @xref{Debugging C Plus Plus, |
| 11991 | ,@value{GDBN} Features for C@t{++}}. |
| 11992 | |
| 11993 | You must specify @code{set overload-resolution off} in order to use an |
| 11994 | explicit function signature to call an overloaded function, as in |
| 11995 | @smallexample |
| 11996 | p 'foo(char,int)'('x', 13) |
| 11997 | @end smallexample |
| 11998 | |
| 11999 | The @value{GDBN} command-completion facility can simplify this; |
| 12000 | see @ref{Completion, ,Command Completion}. |
| 12001 | |
| 12002 | @cindex reference declarations |
| 12003 | @item |
| 12004 | @value{GDBN} understands variables declared as C@t{++} references; you can use |
| 12005 | them in expressions just as you do in C@t{++} source---they are automatically |
| 12006 | dereferenced. |
| 12007 | |
| 12008 | In the parameter list shown when @value{GDBN} displays a frame, the values of |
| 12009 | reference variables are not displayed (unlike other variables); this |
| 12010 | avoids clutter, since references are often used for large structures. |
| 12011 | The @emph{address} of a reference variable is always shown, unless |
| 12012 | you have specified @samp{set print address off}. |
| 12013 | |
| 12014 | @item |
| 12015 | @value{GDBN} supports the C@t{++} name resolution operator @code{::}---your |
| 12016 | expressions can use it just as expressions in your program do. Since |
| 12017 | one scope may be defined in another, you can use @code{::} repeatedly if |
| 12018 | necessary, for example in an expression like |
| 12019 | @samp{@var{scope1}::@var{scope2}::@var{name}}. @value{GDBN} also allows |
| 12020 | resolving name scope by reference to source files, in both C and C@t{++} |
| 12021 | debugging (@pxref{Variables, ,Program Variables}). |
| 12022 | @end enumerate |
| 12023 | |
| 12024 | In addition, when used with HP's C@t{++} compiler, @value{GDBN} supports |
| 12025 | calling virtual functions correctly, printing out virtual bases of |
| 12026 | objects, calling functions in a base subobject, casting objects, and |
| 12027 | invoking user-defined operators. |
| 12028 | |
| 12029 | @node C Defaults |
| 12030 | @subsubsection C and C@t{++} Defaults |
| 12031 | |
| 12032 | @cindex C and C@t{++} defaults |
| 12033 | |
| 12034 | If you allow @value{GDBN} to set type and range checking automatically, they |
| 12035 | both default to @code{off} whenever the working language changes to |
| 12036 | C or C@t{++}. This happens regardless of whether you or @value{GDBN} |
| 12037 | selects the working language. |
| 12038 | |
| 12039 | If you allow @value{GDBN} to set the language automatically, it |
| 12040 | recognizes source files whose names end with @file{.c}, @file{.C}, or |
| 12041 | @file{.cc}, etc, and when @value{GDBN} enters code compiled from one of |
| 12042 | these files, it sets the working language to C or C@t{++}. |
| 12043 | @xref{Automatically, ,Having @value{GDBN} Infer the Source Language}, |
| 12044 | for further details. |
| 12045 | |
| 12046 | @c Type checking is (a) primarily motivated by Modula-2, and (b) |
| 12047 | @c unimplemented. If (b) changes, it might make sense to let this node |
| 12048 | @c appear even if Mod-2 does not, but meanwhile ignore it. roland 16jul93. |
| 12049 | |
| 12050 | @node C Checks |
| 12051 | @subsubsection C and C@t{++} Type and Range Checks |
| 12052 | |
| 12053 | @cindex C and C@t{++} checks |
| 12054 | |
| 12055 | By default, when @value{GDBN} parses C or C@t{++} expressions, type checking |
| 12056 | is not used. However, if you turn type checking on, @value{GDBN} |
| 12057 | considers two variables type equivalent if: |
| 12058 | |
| 12059 | @itemize @bullet |
| 12060 | @item |
| 12061 | The two variables are structured and have the same structure, union, or |
| 12062 | enumerated tag. |
| 12063 | |
| 12064 | @item |
| 12065 | The two variables have the same type name, or types that have been |
| 12066 | declared equivalent through @code{typedef}. |
| 12067 | |
| 12068 | @ignore |
| 12069 | @c leaving this out because neither J Gilmore nor R Pesch understand it. |
| 12070 | @c FIXME--beers? |
| 12071 | @item |
| 12072 | The two @code{struct}, @code{union}, or @code{enum} variables are |
| 12073 | declared in the same declaration. (Note: this may not be true for all C |
| 12074 | compilers.) |
| 12075 | @end ignore |
| 12076 | @end itemize |
| 12077 | |
| 12078 | Range checking, if turned on, is done on mathematical operations. Array |
| 12079 | indices are not checked, since they are often used to index a pointer |
| 12080 | that is not itself an array. |
| 12081 | |
| 12082 | @node Debugging C |
| 12083 | @subsubsection @value{GDBN} and C |
| 12084 | |
| 12085 | The @code{set print union} and @code{show print union} commands apply to |
| 12086 | the @code{union} type. When set to @samp{on}, any @code{union} that is |
| 12087 | inside a @code{struct} or @code{class} is also printed. Otherwise, it |
| 12088 | appears as @samp{@{...@}}. |
| 12089 | |
| 12090 | The @code{@@} operator aids in the debugging of dynamic arrays, formed |
| 12091 | with pointers and a memory allocation function. @xref{Expressions, |
| 12092 | ,Expressions}. |
| 12093 | |
| 12094 | @node Debugging C Plus Plus |
| 12095 | @subsubsection @value{GDBN} Features for C@t{++} |
| 12096 | |
| 12097 | @cindex commands for C@t{++} |
| 12098 | |
| 12099 | Some @value{GDBN} commands are particularly useful with C@t{++}, and some are |
| 12100 | designed specifically for use with C@t{++}. Here is a summary: |
| 12101 | |
| 12102 | @table @code |
| 12103 | @cindex break in overloaded functions |
| 12104 | @item @r{breakpoint menus} |
| 12105 | When you want a breakpoint in a function whose name is overloaded, |
| 12106 | @value{GDBN} has the capability to display a menu of possible breakpoint |
| 12107 | locations to help you specify which function definition you want. |
| 12108 | @xref{Ambiguous Expressions,,Ambiguous Expressions}. |
| 12109 | |
| 12110 | @cindex overloading in C@t{++} |
| 12111 | @item rbreak @var{regex} |
| 12112 | Setting breakpoints using regular expressions is helpful for setting |
| 12113 | breakpoints on overloaded functions that are not members of any special |
| 12114 | classes. |
| 12115 | @xref{Set Breaks, ,Setting Breakpoints}. |
| 12116 | |
| 12117 | @cindex C@t{++} exception handling |
| 12118 | @item catch throw |
| 12119 | @itemx catch catch |
| 12120 | Debug C@t{++} exception handling using these commands. @xref{Set |
| 12121 | Catchpoints, , Setting Catchpoints}. |
| 12122 | |
| 12123 | @cindex inheritance |
| 12124 | @item ptype @var{typename} |
| 12125 | Print inheritance relationships as well as other information for type |
| 12126 | @var{typename}. |
| 12127 | @xref{Symbols, ,Examining the Symbol Table}. |
| 12128 | |
| 12129 | @cindex C@t{++} symbol display |
| 12130 | @item set print demangle |
| 12131 | @itemx show print demangle |
| 12132 | @itemx set print asm-demangle |
| 12133 | @itemx show print asm-demangle |
| 12134 | Control whether C@t{++} symbols display in their source form, both when |
| 12135 | displaying code as C@t{++} source and when displaying disassemblies. |
| 12136 | @xref{Print Settings, ,Print Settings}. |
| 12137 | |
| 12138 | @item set print object |
| 12139 | @itemx show print object |
| 12140 | Choose whether to print derived (actual) or declared types of objects. |
| 12141 | @xref{Print Settings, ,Print Settings}. |
| 12142 | |
| 12143 | @item set print vtbl |
| 12144 | @itemx show print vtbl |
| 12145 | Control the format for printing virtual function tables. |
| 12146 | @xref{Print Settings, ,Print Settings}. |
| 12147 | (The @code{vtbl} commands do not work on programs compiled with the HP |
| 12148 | ANSI C@t{++} compiler (@code{aCC}).) |
| 12149 | |
| 12150 | @kindex set overload-resolution |
| 12151 | @cindex overloaded functions, overload resolution |
| 12152 | @item set overload-resolution on |
| 12153 | Enable overload resolution for C@t{++} expression evaluation. The default |
| 12154 | is on. For overloaded functions, @value{GDBN} evaluates the arguments |
| 12155 | and searches for a function whose signature matches the argument types, |
| 12156 | using the standard C@t{++} conversion rules (see @ref{C Plus Plus |
| 12157 | Expressions, ,C@t{++} Expressions}, for details). |
| 12158 | If it cannot find a match, it emits a message. |
| 12159 | |
| 12160 | @item set overload-resolution off |
| 12161 | Disable overload resolution for C@t{++} expression evaluation. For |
| 12162 | overloaded functions that are not class member functions, @value{GDBN} |
| 12163 | chooses the first function of the specified name that it finds in the |
| 12164 | symbol table, whether or not its arguments are of the correct type. For |
| 12165 | overloaded functions that are class member functions, @value{GDBN} |
| 12166 | searches for a function whose signature @emph{exactly} matches the |
| 12167 | argument types. |
| 12168 | |
| 12169 | @kindex show overload-resolution |
| 12170 | @item show overload-resolution |
| 12171 | Show the current setting of overload resolution. |
| 12172 | |
| 12173 | @item @r{Overloaded symbol names} |
| 12174 | You can specify a particular definition of an overloaded symbol, using |
| 12175 | the same notation that is used to declare such symbols in C@t{++}: type |
| 12176 | @code{@var{symbol}(@var{types})} rather than just @var{symbol}. You can |
| 12177 | also use the @value{GDBN} command-line word completion facilities to list the |
| 12178 | available choices, or to finish the type list for you. |
| 12179 | @xref{Completion,, Command Completion}, for details on how to do this. |
| 12180 | @end table |
| 12181 | |
| 12182 | @node Decimal Floating Point |
| 12183 | @subsubsection Decimal Floating Point format |
| 12184 | @cindex decimal floating point format |
| 12185 | |
| 12186 | @value{GDBN} can examine, set and perform computations with numbers in |
| 12187 | decimal floating point format, which in the C language correspond to the |
| 12188 | @code{_Decimal32}, @code{_Decimal64} and @code{_Decimal128} types as |
| 12189 | specified by the extension to support decimal floating-point arithmetic. |
| 12190 | |
| 12191 | There are two encodings in use, depending on the architecture: BID (Binary |
| 12192 | Integer Decimal) for x86 and x86-64, and DPD (Densely Packed Decimal) for |
| 12193 | PowerPC. @value{GDBN} will use the appropriate encoding for the configured |
| 12194 | target. |
| 12195 | |
| 12196 | Because of a limitation in @file{libdecnumber}, the library used by @value{GDBN} |
| 12197 | to manipulate decimal floating point numbers, it is not possible to convert |
| 12198 | (using a cast, for example) integers wider than 32-bit to decimal float. |
| 12199 | |
| 12200 | In addition, in order to imitate @value{GDBN}'s behaviour with binary floating |
| 12201 | point computations, error checking in decimal float operations ignores |
| 12202 | underflow, overflow and divide by zero exceptions. |
| 12203 | |
| 12204 | In the PowerPC architecture, @value{GDBN} provides a set of pseudo-registers |
| 12205 | to inspect @code{_Decimal128} values stored in floating point registers. |
| 12206 | See @ref{PowerPC,,PowerPC} for more details. |
| 12207 | |
| 12208 | @node D |
| 12209 | @subsection D |
| 12210 | |
| 12211 | @cindex D |
| 12212 | @value{GDBN} can be used to debug programs written in D and compiled with |
| 12213 | GDC, LDC or DMD compilers. Currently @value{GDBN} supports only one D |
| 12214 | specific feature --- dynamic arrays. |
| 12215 | |
| 12216 | @node Objective-C |
| 12217 | @subsection Objective-C |
| 12218 | |
| 12219 | @cindex Objective-C |
| 12220 | This section provides information about some commands and command |
| 12221 | options that are useful for debugging Objective-C code. See also |
| 12222 | @ref{Symbols, info classes}, and @ref{Symbols, info selectors}, for a |
| 12223 | few more commands specific to Objective-C support. |
| 12224 | |
| 12225 | @menu |
| 12226 | * Method Names in Commands:: |
| 12227 | * The Print Command with Objective-C:: |
| 12228 | @end menu |
| 12229 | |
| 12230 | @node Method Names in Commands |
| 12231 | @subsubsection Method Names in Commands |
| 12232 | |
| 12233 | The following commands have been extended to accept Objective-C method |
| 12234 | names as line specifications: |
| 12235 | |
| 12236 | @kindex clear@r{, and Objective-C} |
| 12237 | @kindex break@r{, and Objective-C} |
| 12238 | @kindex info line@r{, and Objective-C} |
| 12239 | @kindex jump@r{, and Objective-C} |
| 12240 | @kindex list@r{, and Objective-C} |
| 12241 | @itemize |
| 12242 | @item @code{clear} |
| 12243 | @item @code{break} |
| 12244 | @item @code{info line} |
| 12245 | @item @code{jump} |
| 12246 | @item @code{list} |
| 12247 | @end itemize |
| 12248 | |
| 12249 | A fully qualified Objective-C method name is specified as |
| 12250 | |
| 12251 | @smallexample |
| 12252 | -[@var{Class} @var{methodName}] |
| 12253 | @end smallexample |
| 12254 | |
| 12255 | where the minus sign is used to indicate an instance method and a |
| 12256 | plus sign (not shown) is used to indicate a class method. The class |
| 12257 | name @var{Class} and method name @var{methodName} are enclosed in |
| 12258 | brackets, similar to the way messages are specified in Objective-C |
| 12259 | source code. For example, to set a breakpoint at the @code{create} |
| 12260 | instance method of class @code{Fruit} in the program currently being |
| 12261 | debugged, enter: |
| 12262 | |
| 12263 | @smallexample |
| 12264 | break -[Fruit create] |
| 12265 | @end smallexample |
| 12266 | |
| 12267 | To list ten program lines around the @code{initialize} class method, |
| 12268 | enter: |
| 12269 | |
| 12270 | @smallexample |
| 12271 | list +[NSText initialize] |
| 12272 | @end smallexample |
| 12273 | |
| 12274 | In the current version of @value{GDBN}, the plus or minus sign is |
| 12275 | required. In future versions of @value{GDBN}, the plus or minus |
| 12276 | sign will be optional, but you can use it to narrow the search. It |
| 12277 | is also possible to specify just a method name: |
| 12278 | |
| 12279 | @smallexample |
| 12280 | break create |
| 12281 | @end smallexample |
| 12282 | |
| 12283 | You must specify the complete method name, including any colons. If |
| 12284 | your program's source files contain more than one @code{create} method, |
| 12285 | you'll be presented with a numbered list of classes that implement that |
| 12286 | method. Indicate your choice by number, or type @samp{0} to exit if |
| 12287 | none apply. |
| 12288 | |
| 12289 | As another example, to clear a breakpoint established at the |
| 12290 | @code{makeKeyAndOrderFront:} method of the @code{NSWindow} class, enter: |
| 12291 | |
| 12292 | @smallexample |
| 12293 | clear -[NSWindow makeKeyAndOrderFront:] |
| 12294 | @end smallexample |
| 12295 | |
| 12296 | @node The Print Command with Objective-C |
| 12297 | @subsubsection The Print Command With Objective-C |
| 12298 | @cindex Objective-C, print objects |
| 12299 | @kindex print-object |
| 12300 | @kindex po @r{(@code{print-object})} |
| 12301 | |
| 12302 | The print command has also been extended to accept methods. For example: |
| 12303 | |
| 12304 | @smallexample |
| 12305 | print -[@var{object} hash] |
| 12306 | @end smallexample |
| 12307 | |
| 12308 | @cindex print an Objective-C object description |
| 12309 | @cindex @code{_NSPrintForDebugger}, and printing Objective-C objects |
| 12310 | @noindent |
| 12311 | will tell @value{GDBN} to send the @code{hash} message to @var{object} |
| 12312 | and print the result. Also, an additional command has been added, |
| 12313 | @code{print-object} or @code{po} for short, which is meant to print |
| 12314 | the description of an object. However, this command may only work |
| 12315 | with certain Objective-C libraries that have a particular hook |
| 12316 | function, @code{_NSPrintForDebugger}, defined. |
| 12317 | |
| 12318 | @node OpenCL C |
| 12319 | @subsection OpenCL C |
| 12320 | |
| 12321 | @cindex OpenCL C |
| 12322 | This section provides information about @value{GDBN}s OpenCL C support. |
| 12323 | |
| 12324 | @menu |
| 12325 | * OpenCL C Datatypes:: |
| 12326 | * OpenCL C Expressions:: |
| 12327 | * OpenCL C Operators:: |
| 12328 | @end menu |
| 12329 | |
| 12330 | @node OpenCL C Datatypes |
| 12331 | @subsubsection OpenCL C Datatypes |
| 12332 | |
| 12333 | @cindex OpenCL C Datatypes |
| 12334 | @value{GDBN} supports the builtin scalar and vector datatypes specified |
| 12335 | by OpenCL 1.1. In addition the half- and double-precision floating point |
| 12336 | data types of the @code{cl_khr_fp16} and @code{cl_khr_fp64} OpenCL |
| 12337 | extensions are also known to @value{GDBN}. |
| 12338 | |
| 12339 | @node OpenCL C Expressions |
| 12340 | @subsubsection OpenCL C Expressions |
| 12341 | |
| 12342 | @cindex OpenCL C Expressions |
| 12343 | @value{GDBN} supports accesses to vector components including the access as |
| 12344 | lvalue where possible. Since OpenCL C is based on C99 most C expressions |
| 12345 | supported by @value{GDBN} can be used as well. |
| 12346 | |
| 12347 | @node OpenCL C Operators |
| 12348 | @subsubsection OpenCL C Operators |
| 12349 | |
| 12350 | @cindex OpenCL C Operators |
| 12351 | @value{GDBN} supports the operators specified by OpenCL 1.1 for scalar and |
| 12352 | vector data types. |
| 12353 | |
| 12354 | @node Fortran |
| 12355 | @subsection Fortran |
| 12356 | @cindex Fortran-specific support in @value{GDBN} |
| 12357 | |
| 12358 | @value{GDBN} can be used to debug programs written in Fortran, but it |
| 12359 | currently supports only the features of Fortran 77 language. |
| 12360 | |
| 12361 | @cindex trailing underscore, in Fortran symbols |
| 12362 | Some Fortran compilers (@sc{gnu} Fortran 77 and Fortran 95 compilers |
| 12363 | among them) append an underscore to the names of variables and |
| 12364 | functions. When you debug programs compiled by those compilers, you |
| 12365 | will need to refer to variables and functions with a trailing |
| 12366 | underscore. |
| 12367 | |
| 12368 | @menu |
| 12369 | * Fortran Operators:: Fortran operators and expressions |
| 12370 | * Fortran Defaults:: Default settings for Fortran |
| 12371 | * Special Fortran Commands:: Special @value{GDBN} commands for Fortran |
| 12372 | @end menu |
| 12373 | |
| 12374 | @node Fortran Operators |
| 12375 | @subsubsection Fortran Operators and Expressions |
| 12376 | |
| 12377 | @cindex Fortran operators and expressions |
| 12378 | |
| 12379 | Operators must be defined on values of specific types. For instance, |
| 12380 | @code{+} is defined on numbers, but not on characters or other non- |
| 12381 | arithmetic types. Operators are often defined on groups of types. |
| 12382 | |
| 12383 | @table @code |
| 12384 | @item ** |
| 12385 | The exponentiation operator. It raises the first operand to the power |
| 12386 | of the second one. |
| 12387 | |
| 12388 | @item : |
| 12389 | The range operator. Normally used in the form of array(low:high) to |
| 12390 | represent a section of array. |
| 12391 | |
| 12392 | @item % |
| 12393 | The access component operator. Normally used to access elements in derived |
| 12394 | types. Also suitable for unions. As unions aren't part of regular Fortran, |
| 12395 | this can only happen when accessing a register that uses a gdbarch-defined |
| 12396 | union type. |
| 12397 | @end table |
| 12398 | |
| 12399 | @node Fortran Defaults |
| 12400 | @subsubsection Fortran Defaults |
| 12401 | |
| 12402 | @cindex Fortran Defaults |
| 12403 | |
| 12404 | Fortran symbols are usually case-insensitive, so @value{GDBN} by |
| 12405 | default uses case-insensitive matches for Fortran symbols. You can |
| 12406 | change that with the @samp{set case-insensitive} command, see |
| 12407 | @ref{Symbols}, for the details. |
| 12408 | |
| 12409 | @node Special Fortran Commands |
| 12410 | @subsubsection Special Fortran Commands |
| 12411 | |
| 12412 | @cindex Special Fortran commands |
| 12413 | |
| 12414 | @value{GDBN} has some commands to support Fortran-specific features, |
| 12415 | such as displaying common blocks. |
| 12416 | |
| 12417 | @table @code |
| 12418 | @cindex @code{COMMON} blocks, Fortran |
| 12419 | @kindex info common |
| 12420 | @item info common @r{[}@var{common-name}@r{]} |
| 12421 | This command prints the values contained in the Fortran @code{COMMON} |
| 12422 | block whose name is @var{common-name}. With no argument, the names of |
| 12423 | all @code{COMMON} blocks visible at the current program location are |
| 12424 | printed. |
| 12425 | @end table |
| 12426 | |
| 12427 | @node Pascal |
| 12428 | @subsection Pascal |
| 12429 | |
| 12430 | @cindex Pascal support in @value{GDBN}, limitations |
| 12431 | Debugging Pascal programs which use sets, subranges, file variables, or |
| 12432 | nested functions does not currently work. @value{GDBN} does not support |
| 12433 | entering expressions, printing values, or similar features using Pascal |
| 12434 | syntax. |
| 12435 | |
| 12436 | The Pascal-specific command @code{set print pascal_static-members} |
| 12437 | controls whether static members of Pascal objects are displayed. |
| 12438 | @xref{Print Settings, pascal_static-members}. |
| 12439 | |
| 12440 | @node Modula-2 |
| 12441 | @subsection Modula-2 |
| 12442 | |
| 12443 | @cindex Modula-2, @value{GDBN} support |
| 12444 | |
| 12445 | The extensions made to @value{GDBN} to support Modula-2 only support |
| 12446 | output from the @sc{gnu} Modula-2 compiler (which is currently being |
| 12447 | developed). Other Modula-2 compilers are not currently supported, and |
| 12448 | attempting to debug executables produced by them is most likely |
| 12449 | to give an error as @value{GDBN} reads in the executable's symbol |
| 12450 | table. |
| 12451 | |
| 12452 | @cindex expressions in Modula-2 |
| 12453 | @menu |
| 12454 | * M2 Operators:: Built-in operators |
| 12455 | * Built-In Func/Proc:: Built-in functions and procedures |
| 12456 | * M2 Constants:: Modula-2 constants |
| 12457 | * M2 Types:: Modula-2 types |
| 12458 | * M2 Defaults:: Default settings for Modula-2 |
| 12459 | * Deviations:: Deviations from standard Modula-2 |
| 12460 | * M2 Checks:: Modula-2 type and range checks |
| 12461 | * M2 Scope:: The scope operators @code{::} and @code{.} |
| 12462 | * GDB/M2:: @value{GDBN} and Modula-2 |
| 12463 | @end menu |
| 12464 | |
| 12465 | @node M2 Operators |
| 12466 | @subsubsection Operators |
| 12467 | @cindex Modula-2 operators |
| 12468 | |
| 12469 | Operators must be defined on values of specific types. For instance, |
| 12470 | @code{+} is defined on numbers, but not on structures. Operators are |
| 12471 | often defined on groups of types. For the purposes of Modula-2, the |
| 12472 | following definitions hold: |
| 12473 | |
| 12474 | @itemize @bullet |
| 12475 | |
| 12476 | @item |
| 12477 | @emph{Integral types} consist of @code{INTEGER}, @code{CARDINAL}, and |
| 12478 | their subranges. |
| 12479 | |
| 12480 | @item |
| 12481 | @emph{Character types} consist of @code{CHAR} and its subranges. |
| 12482 | |
| 12483 | @item |
| 12484 | @emph{Floating-point types} consist of @code{REAL}. |
| 12485 | |
| 12486 | @item |
| 12487 | @emph{Pointer types} consist of anything declared as @code{POINTER TO |
| 12488 | @var{type}}. |
| 12489 | |
| 12490 | @item |
| 12491 | @emph{Scalar types} consist of all of the above. |
| 12492 | |
| 12493 | @item |
| 12494 | @emph{Set types} consist of @code{SET} and @code{BITSET} types. |
| 12495 | |
| 12496 | @item |
| 12497 | @emph{Boolean types} consist of @code{BOOLEAN}. |
| 12498 | @end itemize |
| 12499 | |
| 12500 | @noindent |
| 12501 | The following operators are supported, and appear in order of |
| 12502 | increasing precedence: |
| 12503 | |
| 12504 | @table @code |
| 12505 | @item , |
| 12506 | Function argument or array index separator. |
| 12507 | |
| 12508 | @item := |
| 12509 | Assignment. The value of @var{var} @code{:=} @var{value} is |
| 12510 | @var{value}. |
| 12511 | |
| 12512 | @item <@r{, }> |
| 12513 | Less than, greater than on integral, floating-point, or enumerated |
| 12514 | types. |
| 12515 | |
| 12516 | @item <=@r{, }>= |
| 12517 | Less than or equal to, greater than or equal to |
| 12518 | on integral, floating-point and enumerated types, or set inclusion on |
| 12519 | set types. Same precedence as @code{<}. |
| 12520 | |
| 12521 | @item =@r{, }<>@r{, }# |
| 12522 | Equality and two ways of expressing inequality, valid on scalar types. |
| 12523 | Same precedence as @code{<}. In @value{GDBN} scripts, only @code{<>} is |
| 12524 | available for inequality, since @code{#} conflicts with the script |
| 12525 | comment character. |
| 12526 | |
| 12527 | @item IN |
| 12528 | Set membership. Defined on set types and the types of their members. |
| 12529 | Same precedence as @code{<}. |
| 12530 | |
| 12531 | @item OR |
| 12532 | Boolean disjunction. Defined on boolean types. |
| 12533 | |
| 12534 | @item AND@r{, }& |
| 12535 | Boolean conjunction. Defined on boolean types. |
| 12536 | |
| 12537 | @item @@ |
| 12538 | The @value{GDBN} ``artificial array'' operator (@pxref{Expressions, ,Expressions}). |
| 12539 | |
| 12540 | @item +@r{, }- |
| 12541 | Addition and subtraction on integral and floating-point types, or union |
| 12542 | and difference on set types. |
| 12543 | |
| 12544 | @item * |
| 12545 | Multiplication on integral and floating-point types, or set intersection |
| 12546 | on set types. |
| 12547 | |
| 12548 | @item / |
| 12549 | Division on floating-point types, or symmetric set difference on set |
| 12550 | types. Same precedence as @code{*}. |
| 12551 | |
| 12552 | @item DIV@r{, }MOD |
| 12553 | Integer division and remainder. Defined on integral types. Same |
| 12554 | precedence as @code{*}. |
| 12555 | |
| 12556 | @item - |
| 12557 | Negative. Defined on @code{INTEGER} and @code{REAL} data. |
| 12558 | |
| 12559 | @item ^ |
| 12560 | Pointer dereferencing. Defined on pointer types. |
| 12561 | |
| 12562 | @item NOT |
| 12563 | Boolean negation. Defined on boolean types. Same precedence as |
| 12564 | @code{^}. |
| 12565 | |
| 12566 | @item . |
| 12567 | @code{RECORD} field selector. Defined on @code{RECORD} data. Same |
| 12568 | precedence as @code{^}. |
| 12569 | |
| 12570 | @item [] |
| 12571 | Array indexing. Defined on @code{ARRAY} data. Same precedence as @code{^}. |
| 12572 | |
| 12573 | @item () |
| 12574 | Procedure argument list. Defined on @code{PROCEDURE} objects. Same precedence |
| 12575 | as @code{^}. |
| 12576 | |
| 12577 | @item ::@r{, }. |
| 12578 | @value{GDBN} and Modula-2 scope operators. |
| 12579 | @end table |
| 12580 | |
| 12581 | @quotation |
| 12582 | @emph{Warning:} Set expressions and their operations are not yet supported, so @value{GDBN} |
| 12583 | treats the use of the operator @code{IN}, or the use of operators |
| 12584 | @code{+}, @code{-}, @code{*}, @code{/}, @code{=}, , @code{<>}, @code{#}, |
| 12585 | @code{<=}, and @code{>=} on sets as an error. |
| 12586 | @end quotation |
| 12587 | |
| 12588 | |
| 12589 | @node Built-In Func/Proc |
| 12590 | @subsubsection Built-in Functions and Procedures |
| 12591 | @cindex Modula-2 built-ins |
| 12592 | |
| 12593 | Modula-2 also makes available several built-in procedures and functions. |
| 12594 | In describing these, the following metavariables are used: |
| 12595 | |
| 12596 | @table @var |
| 12597 | |
| 12598 | @item a |
| 12599 | represents an @code{ARRAY} variable. |
| 12600 | |
| 12601 | @item c |
| 12602 | represents a @code{CHAR} constant or variable. |
| 12603 | |
| 12604 | @item i |
| 12605 | represents a variable or constant of integral type. |
| 12606 | |
| 12607 | @item m |
| 12608 | represents an identifier that belongs to a set. Generally used in the |
| 12609 | same function with the metavariable @var{s}. The type of @var{s} should |
| 12610 | be @code{SET OF @var{mtype}} (where @var{mtype} is the type of @var{m}). |
| 12611 | |
| 12612 | @item n |
| 12613 | represents a variable or constant of integral or floating-point type. |
| 12614 | |
| 12615 | @item r |
| 12616 | represents a variable or constant of floating-point type. |
| 12617 | |
| 12618 | @item t |
| 12619 | represents a type. |
| 12620 | |
| 12621 | @item v |
| 12622 | represents a variable. |
| 12623 | |
| 12624 | @item x |
| 12625 | represents a variable or constant of one of many types. See the |
| 12626 | explanation of the function for details. |
| 12627 | @end table |
| 12628 | |
| 12629 | All Modula-2 built-in procedures also return a result, described below. |
| 12630 | |
| 12631 | @table @code |
| 12632 | @item ABS(@var{n}) |
| 12633 | Returns the absolute value of @var{n}. |
| 12634 | |
| 12635 | @item CAP(@var{c}) |
| 12636 | If @var{c} is a lower case letter, it returns its upper case |
| 12637 | equivalent, otherwise it returns its argument. |
| 12638 | |
| 12639 | @item CHR(@var{i}) |
| 12640 | Returns the character whose ordinal value is @var{i}. |
| 12641 | |
| 12642 | @item DEC(@var{v}) |
| 12643 | Decrements the value in the variable @var{v} by one. Returns the new value. |
| 12644 | |
| 12645 | @item DEC(@var{v},@var{i}) |
| 12646 | Decrements the value in the variable @var{v} by @var{i}. Returns the |
| 12647 | new value. |
| 12648 | |
| 12649 | @item EXCL(@var{m},@var{s}) |
| 12650 | Removes the element @var{m} from the set @var{s}. Returns the new |
| 12651 | set. |
| 12652 | |
| 12653 | @item FLOAT(@var{i}) |
| 12654 | Returns the floating point equivalent of the integer @var{i}. |
| 12655 | |
| 12656 | @item HIGH(@var{a}) |
| 12657 | Returns the index of the last member of @var{a}. |
| 12658 | |
| 12659 | @item INC(@var{v}) |
| 12660 | Increments the value in the variable @var{v} by one. Returns the new value. |
| 12661 | |
| 12662 | @item INC(@var{v},@var{i}) |
| 12663 | Increments the value in the variable @var{v} by @var{i}. Returns the |
| 12664 | new value. |
| 12665 | |
| 12666 | @item INCL(@var{m},@var{s}) |
| 12667 | Adds the element @var{m} to the set @var{s} if it is not already |
| 12668 | there. Returns the new set. |
| 12669 | |
| 12670 | @item MAX(@var{t}) |
| 12671 | Returns the maximum value of the type @var{t}. |
| 12672 | |
| 12673 | @item MIN(@var{t}) |
| 12674 | Returns the minimum value of the type @var{t}. |
| 12675 | |
| 12676 | @item ODD(@var{i}) |
| 12677 | Returns boolean TRUE if @var{i} is an odd number. |
| 12678 | |
| 12679 | @item ORD(@var{x}) |
| 12680 | Returns the ordinal value of its argument. For example, the ordinal |
| 12681 | value of a character is its @sc{ascii} value (on machines supporting the |
| 12682 | @sc{ascii} character set). @var{x} must be of an ordered type, which include |
| 12683 | integral, character and enumerated types. |
| 12684 | |
| 12685 | @item SIZE(@var{x}) |
| 12686 | Returns the size of its argument. @var{x} can be a variable or a type. |
| 12687 | |
| 12688 | @item TRUNC(@var{r}) |
| 12689 | Returns the integral part of @var{r}. |
| 12690 | |
| 12691 | @item TSIZE(@var{x}) |
| 12692 | Returns the size of its argument. @var{x} can be a variable or a type. |
| 12693 | |
| 12694 | @item VAL(@var{t},@var{i}) |
| 12695 | Returns the member of the type @var{t} whose ordinal value is @var{i}. |
| 12696 | @end table |
| 12697 | |
| 12698 | @quotation |
| 12699 | @emph{Warning:} Sets and their operations are not yet supported, so |
| 12700 | @value{GDBN} treats the use of procedures @code{INCL} and @code{EXCL} as |
| 12701 | an error. |
| 12702 | @end quotation |
| 12703 | |
| 12704 | @cindex Modula-2 constants |
| 12705 | @node M2 Constants |
| 12706 | @subsubsection Constants |
| 12707 | |
| 12708 | @value{GDBN} allows you to express the constants of Modula-2 in the following |
| 12709 | ways: |
| 12710 | |
| 12711 | @itemize @bullet |
| 12712 | |
| 12713 | @item |
| 12714 | Integer constants are simply a sequence of digits. When used in an |
| 12715 | expression, a constant is interpreted to be type-compatible with the |
| 12716 | rest of the expression. Hexadecimal integers are specified by a |
| 12717 | trailing @samp{H}, and octal integers by a trailing @samp{B}. |
| 12718 | |
| 12719 | @item |
| 12720 | Floating point constants appear as a sequence of digits, followed by a |
| 12721 | decimal point and another sequence of digits. An optional exponent can |
| 12722 | then be specified, in the form @samp{E@r{[}+@r{|}-@r{]}@var{nnn}}, where |
| 12723 | @samp{@r{[}+@r{|}-@r{]}@var{nnn}} is the desired exponent. All of the |
| 12724 | digits of the floating point constant must be valid decimal (base 10) |
| 12725 | digits. |
| 12726 | |
| 12727 | @item |
| 12728 | Character constants consist of a single character enclosed by a pair of |
| 12729 | like quotes, either single (@code{'}) or double (@code{"}). They may |
| 12730 | also be expressed by their ordinal value (their @sc{ascii} value, usually) |
| 12731 | followed by a @samp{C}. |
| 12732 | |
| 12733 | @item |
| 12734 | String constants consist of a sequence of characters enclosed by a |
| 12735 | pair of like quotes, either single (@code{'}) or double (@code{"}). |
| 12736 | Escape sequences in the style of C are also allowed. @xref{C |
| 12737 | Constants, ,C and C@t{++} Constants}, for a brief explanation of escape |
| 12738 | sequences. |
| 12739 | |
| 12740 | @item |
| 12741 | Enumerated constants consist of an enumerated identifier. |
| 12742 | |
| 12743 | @item |
| 12744 | Boolean constants consist of the identifiers @code{TRUE} and |
| 12745 | @code{FALSE}. |
| 12746 | |
| 12747 | @item |
| 12748 | Pointer constants consist of integral values only. |
| 12749 | |
| 12750 | @item |
| 12751 | Set constants are not yet supported. |
| 12752 | @end itemize |
| 12753 | |
| 12754 | @node M2 Types |
| 12755 | @subsubsection Modula-2 Types |
| 12756 | @cindex Modula-2 types |
| 12757 | |
| 12758 | Currently @value{GDBN} can print the following data types in Modula-2 |
| 12759 | syntax: array types, record types, set types, pointer types, procedure |
| 12760 | types, enumerated types, subrange types and base types. You can also |
| 12761 | print the contents of variables declared using these type. |
| 12762 | This section gives a number of simple source code examples together with |
| 12763 | sample @value{GDBN} sessions. |
| 12764 | |
| 12765 | The first example contains the following section of code: |
| 12766 | |
| 12767 | @smallexample |
| 12768 | VAR |
| 12769 | s: SET OF CHAR ; |
| 12770 | r: [20..40] ; |
| 12771 | @end smallexample |
| 12772 | |
| 12773 | @noindent |
| 12774 | and you can request @value{GDBN} to interrogate the type and value of |
| 12775 | @code{r} and @code{s}. |
| 12776 | |
| 12777 | @smallexample |
| 12778 | (@value{GDBP}) print s |
| 12779 | @{'A'..'C', 'Z'@} |
| 12780 | (@value{GDBP}) ptype s |
| 12781 | SET OF CHAR |
| 12782 | (@value{GDBP}) print r |
| 12783 | 21 |
| 12784 | (@value{GDBP}) ptype r |
| 12785 | [20..40] |
| 12786 | @end smallexample |
| 12787 | |
| 12788 | @noindent |
| 12789 | Likewise if your source code declares @code{s} as: |
| 12790 | |
| 12791 | @smallexample |
| 12792 | VAR |
| 12793 | s: SET ['A'..'Z'] ; |
| 12794 | @end smallexample |
| 12795 | |
| 12796 | @noindent |
| 12797 | then you may query the type of @code{s} by: |
| 12798 | |
| 12799 | @smallexample |
| 12800 | (@value{GDBP}) ptype s |
| 12801 | type = SET ['A'..'Z'] |
| 12802 | @end smallexample |
| 12803 | |
| 12804 | @noindent |
| 12805 | Note that at present you cannot interactively manipulate set |
| 12806 | expressions using the debugger. |
| 12807 | |
| 12808 | The following example shows how you might declare an array in Modula-2 |
| 12809 | and how you can interact with @value{GDBN} to print its type and contents: |
| 12810 | |
| 12811 | @smallexample |
| 12812 | VAR |
| 12813 | s: ARRAY [-10..10] OF CHAR ; |
| 12814 | @end smallexample |
| 12815 | |
| 12816 | @smallexample |
| 12817 | (@value{GDBP}) ptype s |
| 12818 | ARRAY [-10..10] OF CHAR |
| 12819 | @end smallexample |
| 12820 | |
| 12821 | Note that the array handling is not yet complete and although the type |
| 12822 | is printed correctly, expression handling still assumes that all |
| 12823 | arrays have a lower bound of zero and not @code{-10} as in the example |
| 12824 | above. |
| 12825 | |
| 12826 | Here are some more type related Modula-2 examples: |
| 12827 | |
| 12828 | @smallexample |
| 12829 | TYPE |
| 12830 | colour = (blue, red, yellow, green) ; |
| 12831 | t = [blue..yellow] ; |
| 12832 | VAR |
| 12833 | s: t ; |
| 12834 | BEGIN |
| 12835 | s := blue ; |
| 12836 | @end smallexample |
| 12837 | |
| 12838 | @noindent |
| 12839 | The @value{GDBN} interaction shows how you can query the data type |
| 12840 | and value of a variable. |
| 12841 | |
| 12842 | @smallexample |
| 12843 | (@value{GDBP}) print s |
| 12844 | $1 = blue |
| 12845 | (@value{GDBP}) ptype t |
| 12846 | type = [blue..yellow] |
| 12847 | @end smallexample |
| 12848 | |
| 12849 | @noindent |
| 12850 | In this example a Modula-2 array is declared and its contents |
| 12851 | displayed. Observe that the contents are written in the same way as |
| 12852 | their @code{C} counterparts. |
| 12853 | |
| 12854 | @smallexample |
| 12855 | VAR |
| 12856 | s: ARRAY [1..5] OF CARDINAL ; |
| 12857 | BEGIN |
| 12858 | s[1] := 1 ; |
| 12859 | @end smallexample |
| 12860 | |
| 12861 | @smallexample |
| 12862 | (@value{GDBP}) print s |
| 12863 | $1 = @{1, 0, 0, 0, 0@} |
| 12864 | (@value{GDBP}) ptype s |
| 12865 | type = ARRAY [1..5] OF CARDINAL |
| 12866 | @end smallexample |
| 12867 | |
| 12868 | The Modula-2 language interface to @value{GDBN} also understands |
| 12869 | pointer types as shown in this example: |
| 12870 | |
| 12871 | @smallexample |
| 12872 | VAR |
| 12873 | s: POINTER TO ARRAY [1..5] OF CARDINAL ; |
| 12874 | BEGIN |
| 12875 | NEW(s) ; |
| 12876 | s^[1] := 1 ; |
| 12877 | @end smallexample |
| 12878 | |
| 12879 | @noindent |
| 12880 | and you can request that @value{GDBN} describes the type of @code{s}. |
| 12881 | |
| 12882 | @smallexample |
| 12883 | (@value{GDBP}) ptype s |
| 12884 | type = POINTER TO ARRAY [1..5] OF CARDINAL |
| 12885 | @end smallexample |
| 12886 | |
| 12887 | @value{GDBN} handles compound types as we can see in this example. |
| 12888 | Here we combine array types, record types, pointer types and subrange |
| 12889 | types: |
| 12890 | |
| 12891 | @smallexample |
| 12892 | TYPE |
| 12893 | foo = RECORD |
| 12894 | f1: CARDINAL ; |
| 12895 | f2: CHAR ; |
| 12896 | f3: myarray ; |
| 12897 | END ; |
| 12898 | |
| 12899 | myarray = ARRAY myrange OF CARDINAL ; |
| 12900 | myrange = [-2..2] ; |
| 12901 | VAR |
| 12902 | s: POINTER TO ARRAY myrange OF foo ; |
| 12903 | @end smallexample |
| 12904 | |
| 12905 | @noindent |
| 12906 | and you can ask @value{GDBN} to describe the type of @code{s} as shown |
| 12907 | below. |
| 12908 | |
| 12909 | @smallexample |
| 12910 | (@value{GDBP}) ptype s |
| 12911 | type = POINTER TO ARRAY [-2..2] OF foo = RECORD |
| 12912 | f1 : CARDINAL; |
| 12913 | f2 : CHAR; |
| 12914 | f3 : ARRAY [-2..2] OF CARDINAL; |
| 12915 | END |
| 12916 | @end smallexample |
| 12917 | |
| 12918 | @node M2 Defaults |
| 12919 | @subsubsection Modula-2 Defaults |
| 12920 | @cindex Modula-2 defaults |
| 12921 | |
| 12922 | If type and range checking are set automatically by @value{GDBN}, they |
| 12923 | both default to @code{on} whenever the working language changes to |
| 12924 | Modula-2. This happens regardless of whether you or @value{GDBN} |
| 12925 | selected the working language. |
| 12926 | |
| 12927 | If you allow @value{GDBN} to set the language automatically, then entering |
| 12928 | code compiled from a file whose name ends with @file{.mod} sets the |
| 12929 | working language to Modula-2. @xref{Automatically, ,Having @value{GDBN} |
| 12930 | Infer the Source Language}, for further details. |
| 12931 | |
| 12932 | @node Deviations |
| 12933 | @subsubsection Deviations from Standard Modula-2 |
| 12934 | @cindex Modula-2, deviations from |
| 12935 | |
| 12936 | A few changes have been made to make Modula-2 programs easier to debug. |
| 12937 | This is done primarily via loosening its type strictness: |
| 12938 | |
| 12939 | @itemize @bullet |
| 12940 | @item |
| 12941 | Unlike in standard Modula-2, pointer constants can be formed by |
| 12942 | integers. This allows you to modify pointer variables during |
| 12943 | debugging. (In standard Modula-2, the actual address contained in a |
| 12944 | pointer variable is hidden from you; it can only be modified |
| 12945 | through direct assignment to another pointer variable or expression that |
| 12946 | returned a pointer.) |
| 12947 | |
| 12948 | @item |
| 12949 | C escape sequences can be used in strings and characters to represent |
| 12950 | non-printable characters. @value{GDBN} prints out strings with these |
| 12951 | escape sequences embedded. Single non-printable characters are |
| 12952 | printed using the @samp{CHR(@var{nnn})} format. |
| 12953 | |
| 12954 | @item |
| 12955 | The assignment operator (@code{:=}) returns the value of its right-hand |
| 12956 | argument. |
| 12957 | |
| 12958 | @item |
| 12959 | All built-in procedures both modify @emph{and} return their argument. |
| 12960 | @end itemize |
| 12961 | |
| 12962 | @node M2 Checks |
| 12963 | @subsubsection Modula-2 Type and Range Checks |
| 12964 | @cindex Modula-2 checks |
| 12965 | |
| 12966 | @quotation |
| 12967 | @emph{Warning:} in this release, @value{GDBN} does not yet perform type or |
| 12968 | range checking. |
| 12969 | @end quotation |
| 12970 | @c FIXME remove warning when type/range checks added |
| 12971 | |
| 12972 | @value{GDBN} considers two Modula-2 variables type equivalent if: |
| 12973 | |
| 12974 | @itemize @bullet |
| 12975 | @item |
| 12976 | They are of types that have been declared equivalent via a @code{TYPE |
| 12977 | @var{t1} = @var{t2}} statement |
| 12978 | |
| 12979 | @item |
| 12980 | They have been declared on the same line. (Note: This is true of the |
| 12981 | @sc{gnu} Modula-2 compiler, but it may not be true of other compilers.) |
| 12982 | @end itemize |
| 12983 | |
| 12984 | As long as type checking is enabled, any attempt to combine variables |
| 12985 | whose types are not equivalent is an error. |
| 12986 | |
| 12987 | Range checking is done on all mathematical operations, assignment, array |
| 12988 | index bounds, and all built-in functions and procedures. |
| 12989 | |
| 12990 | @node M2 Scope |
| 12991 | @subsubsection The Scope Operators @code{::} and @code{.} |
| 12992 | @cindex scope |
| 12993 | @cindex @code{.}, Modula-2 scope operator |
| 12994 | @cindex colon, doubled as scope operator |
| 12995 | @ifinfo |
| 12996 | @vindex colon-colon@r{, in Modula-2} |
| 12997 | @c Info cannot handle :: but TeX can. |
| 12998 | @end ifinfo |
| 12999 | @ifnotinfo |
| 13000 | @vindex ::@r{, in Modula-2} |
| 13001 | @end ifnotinfo |
| 13002 | |
| 13003 | There are a few subtle differences between the Modula-2 scope operator |
| 13004 | (@code{.}) and the @value{GDBN} scope operator (@code{::}). The two have |
| 13005 | similar syntax: |
| 13006 | |
| 13007 | @smallexample |
| 13008 | |
| 13009 | @var{module} . @var{id} |
| 13010 | @var{scope} :: @var{id} |
| 13011 | @end smallexample |
| 13012 | |
| 13013 | @noindent |
| 13014 | where @var{scope} is the name of a module or a procedure, |
| 13015 | @var{module} the name of a module, and @var{id} is any declared |
| 13016 | identifier within your program, except another module. |
| 13017 | |
| 13018 | Using the @code{::} operator makes @value{GDBN} search the scope |
| 13019 | specified by @var{scope} for the identifier @var{id}. If it is not |
| 13020 | found in the specified scope, then @value{GDBN} searches all scopes |
| 13021 | enclosing the one specified by @var{scope}. |
| 13022 | |
| 13023 | Using the @code{.} operator makes @value{GDBN} search the current scope for |
| 13024 | the identifier specified by @var{id} that was imported from the |
| 13025 | definition module specified by @var{module}. With this operator, it is |
| 13026 | an error if the identifier @var{id} was not imported from definition |
| 13027 | module @var{module}, or if @var{id} is not an identifier in |
| 13028 | @var{module}. |
| 13029 | |
| 13030 | @node GDB/M2 |
| 13031 | @subsubsection @value{GDBN} and Modula-2 |
| 13032 | |
| 13033 | Some @value{GDBN} commands have little use when debugging Modula-2 programs. |
| 13034 | Five subcommands of @code{set print} and @code{show print} apply |
| 13035 | specifically to C and C@t{++}: @samp{vtbl}, @samp{demangle}, |
| 13036 | @samp{asm-demangle}, @samp{object}, and @samp{union}. The first four |
| 13037 | apply to C@t{++}, and the last to the C @code{union} type, which has no direct |
| 13038 | analogue in Modula-2. |
| 13039 | |
| 13040 | The @code{@@} operator (@pxref{Expressions, ,Expressions}), while available |
| 13041 | with any language, is not useful with Modula-2. Its |
| 13042 | intent is to aid the debugging of @dfn{dynamic arrays}, which cannot be |
| 13043 | created in Modula-2 as they can in C or C@t{++}. However, because an |
| 13044 | address can be specified by an integral constant, the construct |
| 13045 | @samp{@{@var{type}@}@var{adrexp}} is still useful. |
| 13046 | |
| 13047 | @cindex @code{#} in Modula-2 |
| 13048 | In @value{GDBN} scripts, the Modula-2 inequality operator @code{#} is |
| 13049 | interpreted as the beginning of a comment. Use @code{<>} instead. |
| 13050 | |
| 13051 | @node Ada |
| 13052 | @subsection Ada |
| 13053 | @cindex Ada |
| 13054 | |
| 13055 | The extensions made to @value{GDBN} for Ada only support |
| 13056 | output from the @sc{gnu} Ada (GNAT) compiler. |
| 13057 | Other Ada compilers are not currently supported, and |
| 13058 | attempting to debug executables produced by them is most likely |
| 13059 | to be difficult. |
| 13060 | |
| 13061 | |
| 13062 | @cindex expressions in Ada |
| 13063 | @menu |
| 13064 | * Ada Mode Intro:: General remarks on the Ada syntax |
| 13065 | and semantics supported by Ada mode |
| 13066 | in @value{GDBN}. |
| 13067 | * Omissions from Ada:: Restrictions on the Ada expression syntax. |
| 13068 | * Additions to Ada:: Extensions of the Ada expression syntax. |
| 13069 | * Stopping Before Main Program:: Debugging the program during elaboration. |
| 13070 | * Ada Tasks:: Listing and setting breakpoints in tasks. |
| 13071 | * Ada Tasks and Core Files:: Tasking Support when Debugging Core Files |
| 13072 | * Ravenscar Profile:: Tasking Support when using the Ravenscar |
| 13073 | Profile |
| 13074 | * Ada Glitches:: Known peculiarities of Ada mode. |
| 13075 | @end menu |
| 13076 | |
| 13077 | @node Ada Mode Intro |
| 13078 | @subsubsection Introduction |
| 13079 | @cindex Ada mode, general |
| 13080 | |
| 13081 | The Ada mode of @value{GDBN} supports a fairly large subset of Ada expression |
| 13082 | syntax, with some extensions. |
| 13083 | The philosophy behind the design of this subset is |
| 13084 | |
| 13085 | @itemize @bullet |
| 13086 | @item |
| 13087 | That @value{GDBN} should provide basic literals and access to operations for |
| 13088 | arithmetic, dereferencing, field selection, indexing, and subprogram calls, |
| 13089 | leaving more sophisticated computations to subprograms written into the |
| 13090 | program (which therefore may be called from @value{GDBN}). |
| 13091 | |
| 13092 | @item |
| 13093 | That type safety and strict adherence to Ada language restrictions |
| 13094 | are not particularly important to the @value{GDBN} user. |
| 13095 | |
| 13096 | @item |
| 13097 | That brevity is important to the @value{GDBN} user. |
| 13098 | @end itemize |
| 13099 | |
| 13100 | Thus, for brevity, the debugger acts as if all names declared in |
| 13101 | user-written packages are directly visible, even if they are not visible |
| 13102 | according to Ada rules, thus making it unnecessary to fully qualify most |
| 13103 | names with their packages, regardless of context. Where this causes |
| 13104 | ambiguity, @value{GDBN} asks the user's intent. |
| 13105 | |
| 13106 | The debugger will start in Ada mode if it detects an Ada main program. |
| 13107 | As for other languages, it will enter Ada mode when stopped in a program that |
| 13108 | was translated from an Ada source file. |
| 13109 | |
| 13110 | While in Ada mode, you may use `@t{--}' for comments. This is useful |
| 13111 | mostly for documenting command files. The standard @value{GDBN} comment |
| 13112 | (@samp{#}) still works at the beginning of a line in Ada mode, but not in the |
| 13113 | middle (to allow based literals). |
| 13114 | |
| 13115 | The debugger supports limited overloading. Given a subprogram call in which |
| 13116 | the function symbol has multiple definitions, it will use the number of |
| 13117 | actual parameters and some information about their types to attempt to narrow |
| 13118 | the set of definitions. It also makes very limited use of context, preferring |
| 13119 | procedures to functions in the context of the @code{call} command, and |
| 13120 | functions to procedures elsewhere. |
| 13121 | |
| 13122 | @node Omissions from Ada |
| 13123 | @subsubsection Omissions from Ada |
| 13124 | @cindex Ada, omissions from |
| 13125 | |
| 13126 | Here are the notable omissions from the subset: |
| 13127 | |
| 13128 | @itemize @bullet |
| 13129 | @item |
| 13130 | Only a subset of the attributes are supported: |
| 13131 | |
| 13132 | @itemize @minus |
| 13133 | @item |
| 13134 | @t{'First}, @t{'Last}, and @t{'Length} |
| 13135 | on array objects (not on types and subtypes). |
| 13136 | |
| 13137 | @item |
| 13138 | @t{'Min} and @t{'Max}. |
| 13139 | |
| 13140 | @item |
| 13141 | @t{'Pos} and @t{'Val}. |
| 13142 | |
| 13143 | @item |
| 13144 | @t{'Tag}. |
| 13145 | |
| 13146 | @item |
| 13147 | @t{'Range} on array objects (not subtypes), but only as the right |
| 13148 | operand of the membership (@code{in}) operator. |
| 13149 | |
| 13150 | @item |
| 13151 | @t{'Access}, @t{'Unchecked_Access}, and |
| 13152 | @t{'Unrestricted_Access} (a GNAT extension). |
| 13153 | |
| 13154 | @item |
| 13155 | @t{'Address}. |
| 13156 | @end itemize |
| 13157 | |
| 13158 | @item |
| 13159 | The names in |
| 13160 | @code{Characters.Latin_1} are not available and |
| 13161 | concatenation is not implemented. Thus, escape characters in strings are |
| 13162 | not currently available. |
| 13163 | |
| 13164 | @item |
| 13165 | Equality tests (@samp{=} and @samp{/=}) on arrays test for bitwise |
| 13166 | equality of representations. They will generally work correctly |
| 13167 | for strings and arrays whose elements have integer or enumeration types. |
| 13168 | They may not work correctly for arrays whose element |
| 13169 | types have user-defined equality, for arrays of real values |
| 13170 | (in particular, IEEE-conformant floating point, because of negative |
| 13171 | zeroes and NaNs), and for arrays whose elements contain unused bits with |
| 13172 | indeterminate values. |
| 13173 | |
| 13174 | @item |
| 13175 | The other component-by-component array operations (@code{and}, @code{or}, |
| 13176 | @code{xor}, @code{not}, and relational tests other than equality) |
| 13177 | are not implemented. |
| 13178 | |
| 13179 | @item |
| 13180 | @cindex array aggregates (Ada) |
| 13181 | @cindex record aggregates (Ada) |
| 13182 | @cindex aggregates (Ada) |
| 13183 | There is limited support for array and record aggregates. They are |
| 13184 | permitted only on the right sides of assignments, as in these examples: |
| 13185 | |
| 13186 | @smallexample |
| 13187 | (@value{GDBP}) set An_Array := (1, 2, 3, 4, 5, 6) |
| 13188 | (@value{GDBP}) set An_Array := (1, others => 0) |
| 13189 | (@value{GDBP}) set An_Array := (0|4 => 1, 1..3 => 2, 5 => 6) |
| 13190 | (@value{GDBP}) set A_2D_Array := ((1, 2, 3), (4, 5, 6), (7, 8, 9)) |
| 13191 | (@value{GDBP}) set A_Record := (1, "Peter", True); |
| 13192 | (@value{GDBP}) set A_Record := (Name => "Peter", Id => 1, Alive => True) |
| 13193 | @end smallexample |
| 13194 | |
| 13195 | Changing a |
| 13196 | discriminant's value by assigning an aggregate has an |
| 13197 | undefined effect if that discriminant is used within the record. |
| 13198 | However, you can first modify discriminants by directly assigning to |
| 13199 | them (which normally would not be allowed in Ada), and then performing an |
| 13200 | aggregate assignment. For example, given a variable @code{A_Rec} |
| 13201 | declared to have a type such as: |
| 13202 | |
| 13203 | @smallexample |
| 13204 | type Rec (Len : Small_Integer := 0) is record |
| 13205 | Id : Integer; |
| 13206 | Vals : IntArray (1 .. Len); |
| 13207 | end record; |
| 13208 | @end smallexample |
| 13209 | |
| 13210 | you can assign a value with a different size of @code{Vals} with two |
| 13211 | assignments: |
| 13212 | |
| 13213 | @smallexample |
| 13214 | (@value{GDBP}) set A_Rec.Len := 4 |
| 13215 | (@value{GDBP}) set A_Rec := (Id => 42, Vals => (1, 2, 3, 4)) |
| 13216 | @end smallexample |
| 13217 | |
| 13218 | As this example also illustrates, @value{GDBN} is very loose about the usual |
| 13219 | rules concerning aggregates. You may leave out some of the |
| 13220 | components of an array or record aggregate (such as the @code{Len} |
| 13221 | component in the assignment to @code{A_Rec} above); they will retain their |
| 13222 | original values upon assignment. You may freely use dynamic values as |
| 13223 | indices in component associations. You may even use overlapping or |
| 13224 | redundant component associations, although which component values are |
| 13225 | assigned in such cases is not defined. |
| 13226 | |
| 13227 | @item |
| 13228 | Calls to dispatching subprograms are not implemented. |
| 13229 | |
| 13230 | @item |
| 13231 | The overloading algorithm is much more limited (i.e., less selective) |
| 13232 | than that of real Ada. It makes only limited use of the context in |
| 13233 | which a subexpression appears to resolve its meaning, and it is much |
| 13234 | looser in its rules for allowing type matches. As a result, some |
| 13235 | function calls will be ambiguous, and the user will be asked to choose |
| 13236 | the proper resolution. |
| 13237 | |
| 13238 | @item |
| 13239 | The @code{new} operator is not implemented. |
| 13240 | |
| 13241 | @item |
| 13242 | Entry calls are not implemented. |
| 13243 | |
| 13244 | @item |
| 13245 | Aside from printing, arithmetic operations on the native VAX floating-point |
| 13246 | formats are not supported. |
| 13247 | |
| 13248 | @item |
| 13249 | It is not possible to slice a packed array. |
| 13250 | |
| 13251 | @item |
| 13252 | The names @code{True} and @code{False}, when not part of a qualified name, |
| 13253 | are interpreted as if implicitly prefixed by @code{Standard}, regardless of |
| 13254 | context. |
| 13255 | Should your program |
| 13256 | redefine these names in a package or procedure (at best a dubious practice), |
| 13257 | you will have to use fully qualified names to access their new definitions. |
| 13258 | @end itemize |
| 13259 | |
| 13260 | @node Additions to Ada |
| 13261 | @subsubsection Additions to Ada |
| 13262 | @cindex Ada, deviations from |
| 13263 | |
| 13264 | As it does for other languages, @value{GDBN} makes certain generic |
| 13265 | extensions to Ada (@pxref{Expressions}): |
| 13266 | |
| 13267 | @itemize @bullet |
| 13268 | @item |
| 13269 | If the expression @var{E} is a variable residing in memory (typically |
| 13270 | a local variable or array element) and @var{N} is a positive integer, |
| 13271 | then @code{@var{E}@@@var{N}} displays the values of @var{E} and the |
| 13272 | @var{N}-1 adjacent variables following it in memory as an array. In |
| 13273 | Ada, this operator is generally not necessary, since its prime use is |
| 13274 | in displaying parts of an array, and slicing will usually do this in |
| 13275 | Ada. However, there are occasional uses when debugging programs in |
| 13276 | which certain debugging information has been optimized away. |
| 13277 | |
| 13278 | @item |
| 13279 | @code{@var{B}::@var{var}} means ``the variable named @var{var} that |
| 13280 | appears in function or file @var{B}.'' When @var{B} is a file name, |
| 13281 | you must typically surround it in single quotes. |
| 13282 | |
| 13283 | @item |
| 13284 | The expression @code{@{@var{type}@} @var{addr}} means ``the variable of type |
| 13285 | @var{type} that appears at address @var{addr}.'' |
| 13286 | |
| 13287 | @item |
| 13288 | A name starting with @samp{$} is a convenience variable |
| 13289 | (@pxref{Convenience Vars}) or a machine register (@pxref{Registers}). |
| 13290 | @end itemize |
| 13291 | |
| 13292 | In addition, @value{GDBN} provides a few other shortcuts and outright |
| 13293 | additions specific to Ada: |
| 13294 | |
| 13295 | @itemize @bullet |
| 13296 | @item |
| 13297 | The assignment statement is allowed as an expression, returning |
| 13298 | its right-hand operand as its value. Thus, you may enter |
| 13299 | |
| 13300 | @smallexample |
| 13301 | (@value{GDBP}) set x := y + 3 |
| 13302 | (@value{GDBP}) print A(tmp := y + 1) |
| 13303 | @end smallexample |
| 13304 | |
| 13305 | @item |
| 13306 | The semicolon is allowed as an ``operator,'' returning as its value |
| 13307 | the value of its right-hand operand. |
| 13308 | This allows, for example, |
| 13309 | complex conditional breaks: |
| 13310 | |
| 13311 | @smallexample |
| 13312 | (@value{GDBP}) break f |
| 13313 | (@value{GDBP}) condition 1 (report(i); k += 1; A(k) > 100) |
| 13314 | @end smallexample |
| 13315 | |
| 13316 | @item |
| 13317 | Rather than use catenation and symbolic character names to introduce special |
| 13318 | characters into strings, one may instead use a special bracket notation, |
| 13319 | which is also used to print strings. A sequence of characters of the form |
| 13320 | @samp{["@var{XX}"]} within a string or character literal denotes the |
| 13321 | (single) character whose numeric encoding is @var{XX} in hexadecimal. The |
| 13322 | sequence of characters @samp{["""]} also denotes a single quotation mark |
| 13323 | in strings. For example, |
| 13324 | @smallexample |
| 13325 | "One line.["0a"]Next line.["0a"]" |
| 13326 | @end smallexample |
| 13327 | @noindent |
| 13328 | contains an ASCII newline character (@code{Ada.Characters.Latin_1.LF}) |
| 13329 | after each period. |
| 13330 | |
| 13331 | @item |
| 13332 | The subtype used as a prefix for the attributes @t{'Pos}, @t{'Min}, and |
| 13333 | @t{'Max} is optional (and is ignored in any case). For example, it is valid |
| 13334 | to write |
| 13335 | |
| 13336 | @smallexample |
| 13337 | (@value{GDBP}) print 'max(x, y) |
| 13338 | @end smallexample |
| 13339 | |
| 13340 | @item |
| 13341 | When printing arrays, @value{GDBN} uses positional notation when the |
| 13342 | array has a lower bound of 1, and uses a modified named notation otherwise. |
| 13343 | For example, a one-dimensional array of three integers with a lower bound |
| 13344 | of 3 might print as |
| 13345 | |
| 13346 | @smallexample |
| 13347 | (3 => 10, 17, 1) |
| 13348 | @end smallexample |
| 13349 | |
| 13350 | @noindent |
| 13351 | That is, in contrast to valid Ada, only the first component has a @code{=>} |
| 13352 | clause. |
| 13353 | |
| 13354 | @item |
| 13355 | You may abbreviate attributes in expressions with any unique, |
| 13356 | multi-character subsequence of |
| 13357 | their names (an exact match gets preference). |
| 13358 | For example, you may use @t{a'len}, @t{a'gth}, or @t{a'lh} |
| 13359 | in place of @t{a'length}. |
| 13360 | |
| 13361 | @item |
| 13362 | @cindex quoting Ada internal identifiers |
| 13363 | Since Ada is case-insensitive, the debugger normally maps identifiers you type |
| 13364 | to lower case. The GNAT compiler uses upper-case characters for |
| 13365 | some of its internal identifiers, which are normally of no interest to users. |
| 13366 | For the rare occasions when you actually have to look at them, |
| 13367 | enclose them in angle brackets to avoid the lower-case mapping. |
| 13368 | For example, |
| 13369 | @smallexample |
| 13370 | (@value{GDBP}) print <JMPBUF_SAVE>[0] |
| 13371 | @end smallexample |
| 13372 | |
| 13373 | @item |
| 13374 | Printing an object of class-wide type or dereferencing an |
| 13375 | access-to-class-wide value will display all the components of the object's |
| 13376 | specific type (as indicated by its run-time tag). Likewise, component |
| 13377 | selection on such a value will operate on the specific type of the |
| 13378 | object. |
| 13379 | |
| 13380 | @end itemize |
| 13381 | |
| 13382 | @node Stopping Before Main Program |
| 13383 | @subsubsection Stopping at the Very Beginning |
| 13384 | |
| 13385 | @cindex breakpointing Ada elaboration code |
| 13386 | It is sometimes necessary to debug the program during elaboration, and |
| 13387 | before reaching the main procedure. |
| 13388 | As defined in the Ada Reference |
| 13389 | Manual, the elaboration code is invoked from a procedure called |
| 13390 | @code{adainit}. To run your program up to the beginning of |
| 13391 | elaboration, simply use the following two commands: |
| 13392 | @code{tbreak adainit} and @code{run}. |
| 13393 | |
| 13394 | @node Ada Tasks |
| 13395 | @subsubsection Extensions for Ada Tasks |
| 13396 | @cindex Ada, tasking |
| 13397 | |
| 13398 | Support for Ada tasks is analogous to that for threads (@pxref{Threads}). |
| 13399 | @value{GDBN} provides the following task-related commands: |
| 13400 | |
| 13401 | @table @code |
| 13402 | @kindex info tasks |
| 13403 | @item info tasks |
| 13404 | This command shows a list of current Ada tasks, as in the following example: |
| 13405 | |
| 13406 | |
| 13407 | @smallexample |
| 13408 | @iftex |
| 13409 | @leftskip=0.5cm |
| 13410 | @end iftex |
| 13411 | (@value{GDBP}) info tasks |
| 13412 | ID TID P-ID Pri State Name |
| 13413 | 1 8088000 0 15 Child Activation Wait main_task |
| 13414 | 2 80a4000 1 15 Accept Statement b |
| 13415 | 3 809a800 1 15 Child Activation Wait a |
| 13416 | * 4 80ae800 3 15 Runnable c |
| 13417 | |
| 13418 | @end smallexample |
| 13419 | |
| 13420 | @noindent |
| 13421 | In this listing, the asterisk before the last task indicates it to be the |
| 13422 | task currently being inspected. |
| 13423 | |
| 13424 | @table @asis |
| 13425 | @item ID |
| 13426 | Represents @value{GDBN}'s internal task number. |
| 13427 | |
| 13428 | @item TID |
| 13429 | The Ada task ID. |
| 13430 | |
| 13431 | @item P-ID |
| 13432 | The parent's task ID (@value{GDBN}'s internal task number). |
| 13433 | |
| 13434 | @item Pri |
| 13435 | The base priority of the task. |
| 13436 | |
| 13437 | @item State |
| 13438 | Current state of the task. |
| 13439 | |
| 13440 | @table @code |
| 13441 | @item Unactivated |
| 13442 | The task has been created but has not been activated. It cannot be |
| 13443 | executing. |
| 13444 | |
| 13445 | @item Runnable |
| 13446 | The task is not blocked for any reason known to Ada. (It may be waiting |
| 13447 | for a mutex, though.) It is conceptually "executing" in normal mode. |
| 13448 | |
| 13449 | @item Terminated |
| 13450 | The task is terminated, in the sense of ARM 9.3 (5). Any dependents |
| 13451 | that were waiting on terminate alternatives have been awakened and have |
| 13452 | terminated themselves. |
| 13453 | |
| 13454 | @item Child Activation Wait |
| 13455 | The task is waiting for created tasks to complete activation. |
| 13456 | |
| 13457 | @item Accept Statement |
| 13458 | The task is waiting on an accept or selective wait statement. |
| 13459 | |
| 13460 | @item Waiting on entry call |
| 13461 | The task is waiting on an entry call. |
| 13462 | |
| 13463 | @item Async Select Wait |
| 13464 | The task is waiting to start the abortable part of an asynchronous |
| 13465 | select statement. |
| 13466 | |
| 13467 | @item Delay Sleep |
| 13468 | The task is waiting on a select statement with only a delay |
| 13469 | alternative open. |
| 13470 | |
| 13471 | @item Child Termination Wait |
| 13472 | The task is sleeping having completed a master within itself, and is |
| 13473 | waiting for the tasks dependent on that master to become terminated or |
| 13474 | waiting on a terminate Phase. |
| 13475 | |
| 13476 | @item Wait Child in Term Alt |
| 13477 | The task is sleeping waiting for tasks on terminate alternatives to |
| 13478 | finish terminating. |
| 13479 | |
| 13480 | @item Accepting RV with @var{taskno} |
| 13481 | The task is accepting a rendez-vous with the task @var{taskno}. |
| 13482 | @end table |
| 13483 | |
| 13484 | @item Name |
| 13485 | Name of the task in the program. |
| 13486 | |
| 13487 | @end table |
| 13488 | |
| 13489 | @kindex info task @var{taskno} |
| 13490 | @item info task @var{taskno} |
| 13491 | This command shows detailled informations on the specified task, as in |
| 13492 | the following example: |
| 13493 | @smallexample |
| 13494 | @iftex |
| 13495 | @leftskip=0.5cm |
| 13496 | @end iftex |
| 13497 | (@value{GDBP}) info tasks |
| 13498 | ID TID P-ID Pri State Name |
| 13499 | 1 8077880 0 15 Child Activation Wait main_task |
| 13500 | * 2 807c468 1 15 Runnable task_1 |
| 13501 | (@value{GDBP}) info task 2 |
| 13502 | Ada Task: 0x807c468 |
| 13503 | Name: task_1 |
| 13504 | Thread: 0x807f378 |
| 13505 | Parent: 1 (main_task) |
| 13506 | Base Priority: 15 |
| 13507 | State: Runnable |
| 13508 | @end smallexample |
| 13509 | |
| 13510 | @item task |
| 13511 | @kindex task@r{ (Ada)} |
| 13512 | @cindex current Ada task ID |
| 13513 | This command prints the ID of the current task. |
| 13514 | |
| 13515 | @smallexample |
| 13516 | @iftex |
| 13517 | @leftskip=0.5cm |
| 13518 | @end iftex |
| 13519 | (@value{GDBP}) info tasks |
| 13520 | ID TID P-ID Pri State Name |
| 13521 | 1 8077870 0 15 Child Activation Wait main_task |
| 13522 | * 2 807c458 1 15 Runnable t |
| 13523 | (@value{GDBP}) task |
| 13524 | [Current task is 2] |
| 13525 | @end smallexample |
| 13526 | |
| 13527 | @item task @var{taskno} |
| 13528 | @cindex Ada task switching |
| 13529 | This command is like the @code{thread @var{threadno}} |
| 13530 | command (@pxref{Threads}). It switches the context of debugging |
| 13531 | from the current task to the given task. |
| 13532 | |
| 13533 | @smallexample |
| 13534 | @iftex |
| 13535 | @leftskip=0.5cm |
| 13536 | @end iftex |
| 13537 | (@value{GDBP}) info tasks |
| 13538 | ID TID P-ID Pri State Name |
| 13539 | 1 8077870 0 15 Child Activation Wait main_task |
| 13540 | * 2 807c458 1 15 Runnable t |
| 13541 | (@value{GDBP}) task 1 |
| 13542 | [Switching to task 1] |
| 13543 | #0 0x8067726 in pthread_cond_wait () |
| 13544 | (@value{GDBP}) bt |
| 13545 | #0 0x8067726 in pthread_cond_wait () |
| 13546 | #1 0x8056714 in system.os_interface.pthread_cond_wait () |
| 13547 | #2 0x805cb63 in system.task_primitives.operations.sleep () |
| 13548 | #3 0x806153e in system.tasking.stages.activate_tasks () |
| 13549 | #4 0x804aacc in un () at un.adb:5 |
| 13550 | @end smallexample |
| 13551 | |
| 13552 | @item break @var{linespec} task @var{taskno} |
| 13553 | @itemx break @var{linespec} task @var{taskno} if @dots{} |
| 13554 | @cindex breakpoints and tasks, in Ada |
| 13555 | @cindex task breakpoints, in Ada |
| 13556 | @kindex break @dots{} task @var{taskno}@r{ (Ada)} |
| 13557 | These commands are like the @code{break @dots{} thread @dots{}} |
| 13558 | command (@pxref{Thread Stops}). |
| 13559 | @var{linespec} specifies source lines, as described |
| 13560 | in @ref{Specify Location}. |
| 13561 | |
| 13562 | Use the qualifier @samp{task @var{taskno}} with a breakpoint command |
| 13563 | to specify that you only want @value{GDBN} to stop the program when a |
| 13564 | particular Ada task reaches this breakpoint. @var{taskno} is one of the |
| 13565 | numeric task identifiers assigned by @value{GDBN}, shown in the first |
| 13566 | column of the @samp{info tasks} display. |
| 13567 | |
| 13568 | If you do not specify @samp{task @var{taskno}} when you set a |
| 13569 | breakpoint, the breakpoint applies to @emph{all} tasks of your |
| 13570 | program. |
| 13571 | |
| 13572 | You can use the @code{task} qualifier on conditional breakpoints as |
| 13573 | well; in this case, place @samp{task @var{taskno}} before the |
| 13574 | breakpoint condition (before the @code{if}). |
| 13575 | |
| 13576 | For example, |
| 13577 | |
| 13578 | @smallexample |
| 13579 | @iftex |
| 13580 | @leftskip=0.5cm |
| 13581 | @end iftex |
| 13582 | (@value{GDBP}) info tasks |
| 13583 | ID TID P-ID Pri State Name |
| 13584 | 1 140022020 0 15 Child Activation Wait main_task |
| 13585 | 2 140045060 1 15 Accept/Select Wait t2 |
| 13586 | 3 140044840 1 15 Runnable t1 |
| 13587 | * 4 140056040 1 15 Runnable t3 |
| 13588 | (@value{GDBP}) b 15 task 2 |
| 13589 | Breakpoint 5 at 0x120044cb0: file test_task_debug.adb, line 15. |
| 13590 | (@value{GDBP}) cont |
| 13591 | Continuing. |
| 13592 | task # 1 running |
| 13593 | task # 2 running |
| 13594 | |
| 13595 | Breakpoint 5, test_task_debug () at test_task_debug.adb:15 |
| 13596 | 15 flush; |
| 13597 | (@value{GDBP}) info tasks |
| 13598 | ID TID P-ID Pri State Name |
| 13599 | 1 140022020 0 15 Child Activation Wait main_task |
| 13600 | * 2 140045060 1 15 Runnable t2 |
| 13601 | 3 140044840 1 15 Runnable t1 |
| 13602 | 4 140056040 1 15 Delay Sleep t3 |
| 13603 | @end smallexample |
| 13604 | @end table |
| 13605 | |
| 13606 | @node Ada Tasks and Core Files |
| 13607 | @subsubsection Tasking Support when Debugging Core Files |
| 13608 | @cindex Ada tasking and core file debugging |
| 13609 | |
| 13610 | When inspecting a core file, as opposed to debugging a live program, |
| 13611 | tasking support may be limited or even unavailable, depending on |
| 13612 | the platform being used. |
| 13613 | For instance, on x86-linux, the list of tasks is available, but task |
| 13614 | switching is not supported. On Tru64, however, task switching will work |
| 13615 | as usual. |
| 13616 | |
| 13617 | On certain platforms, including Tru64, the debugger needs to perform some |
| 13618 | memory writes in order to provide Ada tasking support. When inspecting |
| 13619 | a core file, this means that the core file must be opened with read-write |
| 13620 | privileges, using the command @samp{"set write on"} (@pxref{Patching}). |
| 13621 | Under these circumstances, you should make a backup copy of the core |
| 13622 | file before inspecting it with @value{GDBN}. |
| 13623 | |
| 13624 | @node Ravenscar Profile |
| 13625 | @subsubsection Tasking Support when using the Ravenscar Profile |
| 13626 | @cindex Ravenscar Profile |
| 13627 | |
| 13628 | The @dfn{Ravenscar Profile} is a subset of the Ada tasking features, |
| 13629 | specifically designed for systems with safety-critical real-time |
| 13630 | requirements. |
| 13631 | |
| 13632 | @table @code |
| 13633 | @kindex set ravenscar task-switching on |
| 13634 | @cindex task switching with program using Ravenscar Profile |
| 13635 | @item set ravenscar task-switching on |
| 13636 | Allows task switching when debugging a program that uses the Ravenscar |
| 13637 | Profile. This is the default. |
| 13638 | |
| 13639 | @kindex set ravenscar task-switching off |
| 13640 | @item set ravenscar task-switching off |
| 13641 | Turn off task switching when debugging a program that uses the Ravenscar |
| 13642 | Profile. This is mostly intended to disable the code that adds support |
| 13643 | for the Ravenscar Profile, in case a bug in either @value{GDBN} or in |
| 13644 | the Ravenscar runtime is preventing @value{GDBN} from working properly. |
| 13645 | To be effective, this command should be run before the program is started. |
| 13646 | |
| 13647 | @kindex show ravenscar task-switching |
| 13648 | @item show ravenscar task-switching |
| 13649 | Show whether it is possible to switch from task to task in a program |
| 13650 | using the Ravenscar Profile. |
| 13651 | |
| 13652 | @end table |
| 13653 | |
| 13654 | @node Ada Glitches |
| 13655 | @subsubsection Known Peculiarities of Ada Mode |
| 13656 | @cindex Ada, problems |
| 13657 | |
| 13658 | Besides the omissions listed previously (@pxref{Omissions from Ada}), |
| 13659 | we know of several problems with and limitations of Ada mode in |
| 13660 | @value{GDBN}, |
| 13661 | some of which will be fixed with planned future releases of the debugger |
| 13662 | and the GNU Ada compiler. |
| 13663 | |
| 13664 | @itemize @bullet |
| 13665 | @item |
| 13666 | Static constants that the compiler chooses not to materialize as objects in |
| 13667 | storage are invisible to the debugger. |
| 13668 | |
| 13669 | @item |
| 13670 | Named parameter associations in function argument lists are ignored (the |
| 13671 | argument lists are treated as positional). |
| 13672 | |
| 13673 | @item |
| 13674 | Many useful library packages are currently invisible to the debugger. |
| 13675 | |
| 13676 | @item |
| 13677 | Fixed-point arithmetic, conversions, input, and output is carried out using |
| 13678 | floating-point arithmetic, and may give results that only approximate those on |
| 13679 | the host machine. |
| 13680 | |
| 13681 | @item |
| 13682 | The GNAT compiler never generates the prefix @code{Standard} for any of |
| 13683 | the standard symbols defined by the Ada language. @value{GDBN} knows about |
| 13684 | this: it will strip the prefix from names when you use it, and will never |
| 13685 | look for a name you have so qualified among local symbols, nor match against |
| 13686 | symbols in other packages or subprograms. If you have |
| 13687 | defined entities anywhere in your program other than parameters and |
| 13688 | local variables whose simple names match names in @code{Standard}, |
| 13689 | GNAT's lack of qualification here can cause confusion. When this happens, |
| 13690 | you can usually resolve the confusion |
| 13691 | by qualifying the problematic names with package |
| 13692 | @code{Standard} explicitly. |
| 13693 | @end itemize |
| 13694 | |
| 13695 | Older versions of the compiler sometimes generate erroneous debugging |
| 13696 | information, resulting in the debugger incorrectly printing the value |
| 13697 | of affected entities. In some cases, the debugger is able to work |
| 13698 | around an issue automatically. In other cases, the debugger is able |
| 13699 | to work around the issue, but the work-around has to be specifically |
| 13700 | enabled. |
| 13701 | |
| 13702 | @kindex set ada trust-PAD-over-XVS |
| 13703 | @kindex show ada trust-PAD-over-XVS |
| 13704 | @table @code |
| 13705 | |
| 13706 | @item set ada trust-PAD-over-XVS on |
| 13707 | Configure GDB to strictly follow the GNAT encoding when computing the |
| 13708 | value of Ada entities, particularly when @code{PAD} and @code{PAD___XVS} |
| 13709 | types are involved (see @code{ada/exp_dbug.ads} in the GCC sources for |
| 13710 | a complete description of the encoding used by the GNAT compiler). |
| 13711 | This is the default. |
| 13712 | |
| 13713 | @item set ada trust-PAD-over-XVS off |
| 13714 | This is related to the encoding using by the GNAT compiler. If @value{GDBN} |
| 13715 | sometimes prints the wrong value for certain entities, changing @code{ada |
| 13716 | trust-PAD-over-XVS} to @code{off} activates a work-around which may fix |
| 13717 | the issue. It is always safe to set @code{ada trust-PAD-over-XVS} to |
| 13718 | @code{off}, but this incurs a slight performance penalty, so it is |
| 13719 | recommended to leave this setting to @code{on} unless necessary. |
| 13720 | |
| 13721 | @end table |
| 13722 | |
| 13723 | @node Unsupported Languages |
| 13724 | @section Unsupported Languages |
| 13725 | |
| 13726 | @cindex unsupported languages |
| 13727 | @cindex minimal language |
| 13728 | In addition to the other fully-supported programming languages, |
| 13729 | @value{GDBN} also provides a pseudo-language, called @code{minimal}. |
| 13730 | It does not represent a real programming language, but provides a set |
| 13731 | of capabilities close to what the C or assembly languages provide. |
| 13732 | This should allow most simple operations to be performed while debugging |
| 13733 | an application that uses a language currently not supported by @value{GDBN}. |
| 13734 | |
| 13735 | If the language is set to @code{auto}, @value{GDBN} will automatically |
| 13736 | select this language if the current frame corresponds to an unsupported |
| 13737 | language. |
| 13738 | |
| 13739 | @node Symbols |
| 13740 | @chapter Examining the Symbol Table |
| 13741 | |
| 13742 | The commands described in this chapter allow you to inquire about the |
| 13743 | symbols (names of variables, functions and types) defined in your |
| 13744 | program. This information is inherent in the text of your program and |
| 13745 | does not change as your program executes. @value{GDBN} finds it in your |
| 13746 | program's symbol table, in the file indicated when you started @value{GDBN} |
| 13747 | (@pxref{File Options, ,Choosing Files}), or by one of the |
| 13748 | file-management commands (@pxref{Files, ,Commands to Specify Files}). |
| 13749 | |
| 13750 | @cindex symbol names |
| 13751 | @cindex names of symbols |
| 13752 | @cindex quoting names |
| 13753 | Occasionally, you may need to refer to symbols that contain unusual |
| 13754 | characters, which @value{GDBN} ordinarily treats as word delimiters. The |
| 13755 | most frequent case is in referring to static variables in other |
| 13756 | source files (@pxref{Variables,,Program Variables}). File names |
| 13757 | are recorded in object files as debugging symbols, but @value{GDBN} would |
| 13758 | ordinarily parse a typical file name, like @file{foo.c}, as the three words |
| 13759 | @samp{foo} @samp{.} @samp{c}. To allow @value{GDBN} to recognize |
| 13760 | @samp{foo.c} as a single symbol, enclose it in single quotes; for example, |
| 13761 | |
| 13762 | @smallexample |
| 13763 | p 'foo.c'::x |
| 13764 | @end smallexample |
| 13765 | |
| 13766 | @noindent |
| 13767 | looks up the value of @code{x} in the scope of the file @file{foo.c}. |
| 13768 | |
| 13769 | @table @code |
| 13770 | @cindex case-insensitive symbol names |
| 13771 | @cindex case sensitivity in symbol names |
| 13772 | @kindex set case-sensitive |
| 13773 | @item set case-sensitive on |
| 13774 | @itemx set case-sensitive off |
| 13775 | @itemx set case-sensitive auto |
| 13776 | Normally, when @value{GDBN} looks up symbols, it matches their names |
| 13777 | with case sensitivity determined by the current source language. |
| 13778 | Occasionally, you may wish to control that. The command @code{set |
| 13779 | case-sensitive} lets you do that by specifying @code{on} for |
| 13780 | case-sensitive matches or @code{off} for case-insensitive ones. If |
| 13781 | you specify @code{auto}, case sensitivity is reset to the default |
| 13782 | suitable for the source language. The default is case-sensitive |
| 13783 | matches for all languages except for Fortran, for which the default is |
| 13784 | case-insensitive matches. |
| 13785 | |
| 13786 | @kindex show case-sensitive |
| 13787 | @item show case-sensitive |
| 13788 | This command shows the current setting of case sensitivity for symbols |
| 13789 | lookups. |
| 13790 | |
| 13791 | @kindex info address |
| 13792 | @cindex address of a symbol |
| 13793 | @item info address @var{symbol} |
| 13794 | Describe where the data for @var{symbol} is stored. For a register |
| 13795 | variable, this says which register it is kept in. For a non-register |
| 13796 | local variable, this prints the stack-frame offset at which the variable |
| 13797 | is always stored. |
| 13798 | |
| 13799 | Note the contrast with @samp{print &@var{symbol}}, which does not work |
| 13800 | at all for a register variable, and for a stack local variable prints |
| 13801 | the exact address of the current instantiation of the variable. |
| 13802 | |
| 13803 | @kindex info symbol |
| 13804 | @cindex symbol from address |
| 13805 | @cindex closest symbol and offset for an address |
| 13806 | @item info symbol @var{addr} |
| 13807 | Print the name of a symbol which is stored at the address @var{addr}. |
| 13808 | If no symbol is stored exactly at @var{addr}, @value{GDBN} prints the |
| 13809 | nearest symbol and an offset from it: |
| 13810 | |
| 13811 | @smallexample |
| 13812 | (@value{GDBP}) info symbol 0x54320 |
| 13813 | _initialize_vx + 396 in section .text |
| 13814 | @end smallexample |
| 13815 | |
| 13816 | @noindent |
| 13817 | This is the opposite of the @code{info address} command. You can use |
| 13818 | it to find out the name of a variable or a function given its address. |
| 13819 | |
| 13820 | For dynamically linked executables, the name of executable or shared |
| 13821 | library containing the symbol is also printed: |
| 13822 | |
| 13823 | @smallexample |
| 13824 | (@value{GDBP}) info symbol 0x400225 |
| 13825 | _start + 5 in section .text of /tmp/a.out |
| 13826 | (@value{GDBP}) info symbol 0x2aaaac2811cf |
| 13827 | __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6 |
| 13828 | @end smallexample |
| 13829 | |
| 13830 | @kindex whatis |
| 13831 | @item whatis [@var{arg}] |
| 13832 | Print the data type of @var{arg}, which can be either an expression or |
| 13833 | a data type. With no argument, print the data type of @code{$}, the |
| 13834 | last value in the value history. If @var{arg} is an expression, it is |
| 13835 | not actually evaluated, and any side-effecting operations (such as |
| 13836 | assignments or function calls) inside it do not take place. If |
| 13837 | @var{arg} is a type name, it may be the name of a type or typedef, or |
| 13838 | for C code it may have the form @samp{class @var{class-name}}, |
| 13839 | @samp{struct @var{struct-tag}}, @samp{union @var{union-tag}} or |
| 13840 | @samp{enum @var{enum-tag}}. |
| 13841 | @xref{Expressions, ,Expressions}. |
| 13842 | |
| 13843 | @kindex ptype |
| 13844 | @item ptype [@var{arg}] |
| 13845 | @code{ptype} accepts the same arguments as @code{whatis}, but prints a |
| 13846 | detailed description of the type, instead of just the name of the type. |
| 13847 | @xref{Expressions, ,Expressions}. |
| 13848 | |
| 13849 | For example, for this variable declaration: |
| 13850 | |
| 13851 | @smallexample |
| 13852 | struct complex @{double real; double imag;@} v; |
| 13853 | @end smallexample |
| 13854 | |
| 13855 | @noindent |
| 13856 | the two commands give this output: |
| 13857 | |
| 13858 | @smallexample |
| 13859 | @group |
| 13860 | (@value{GDBP}) whatis v |
| 13861 | type = struct complex |
| 13862 | (@value{GDBP}) ptype v |
| 13863 | type = struct complex @{ |
| 13864 | double real; |
| 13865 | double imag; |
| 13866 | @} |
| 13867 | @end group |
| 13868 | @end smallexample |
| 13869 | |
| 13870 | @noindent |
| 13871 | As with @code{whatis}, using @code{ptype} without an argument refers to |
| 13872 | the type of @code{$}, the last value in the value history. |
| 13873 | |
| 13874 | @cindex incomplete type |
| 13875 | Sometimes, programs use opaque data types or incomplete specifications |
| 13876 | of complex data structure. If the debug information included in the |
| 13877 | program does not allow @value{GDBN} to display a full declaration of |
| 13878 | the data type, it will say @samp{<incomplete type>}. For example, |
| 13879 | given these declarations: |
| 13880 | |
| 13881 | @smallexample |
| 13882 | struct foo; |
| 13883 | struct foo *fooptr; |
| 13884 | @end smallexample |
| 13885 | |
| 13886 | @noindent |
| 13887 | but no definition for @code{struct foo} itself, @value{GDBN} will say: |
| 13888 | |
| 13889 | @smallexample |
| 13890 | (@value{GDBP}) ptype foo |
| 13891 | $1 = <incomplete type> |
| 13892 | @end smallexample |
| 13893 | |
| 13894 | @noindent |
| 13895 | ``Incomplete type'' is C terminology for data types that are not |
| 13896 | completely specified. |
| 13897 | |
| 13898 | @kindex info types |
| 13899 | @item info types @var{regexp} |
| 13900 | @itemx info types |
| 13901 | Print a brief description of all types whose names match the regular |
| 13902 | expression @var{regexp} (or all types in your program, if you supply |
| 13903 | no argument). Each complete typename is matched as though it were a |
| 13904 | complete line; thus, @samp{i type value} gives information on all |
| 13905 | types in your program whose names include the string @code{value}, but |
| 13906 | @samp{i type ^value$} gives information only on types whose complete |
| 13907 | name is @code{value}. |
| 13908 | |
| 13909 | This command differs from @code{ptype} in two ways: first, like |
| 13910 | @code{whatis}, it does not print a detailed description; second, it |
| 13911 | lists all source files where a type is defined. |
| 13912 | |
| 13913 | @kindex info scope |
| 13914 | @cindex local variables |
| 13915 | @item info scope @var{location} |
| 13916 | List all the variables local to a particular scope. This command |
| 13917 | accepts a @var{location} argument---a function name, a source line, or |
| 13918 | an address preceded by a @samp{*}, and prints all the variables local |
| 13919 | to the scope defined by that location. (@xref{Specify Location}, for |
| 13920 | details about supported forms of @var{location}.) For example: |
| 13921 | |
| 13922 | @smallexample |
| 13923 | (@value{GDBP}) @b{info scope command_line_handler} |
| 13924 | Scope for command_line_handler: |
| 13925 | Symbol rl is an argument at stack/frame offset 8, length 4. |
| 13926 | Symbol linebuffer is in static storage at address 0x150a18, length 4. |
| 13927 | Symbol linelength is in static storage at address 0x150a1c, length 4. |
| 13928 | Symbol p is a local variable in register $esi, length 4. |
| 13929 | Symbol p1 is a local variable in register $ebx, length 4. |
| 13930 | Symbol nline is a local variable in register $edx, length 4. |
| 13931 | Symbol repeat is a local variable at frame offset -8, length 4. |
| 13932 | @end smallexample |
| 13933 | |
| 13934 | @noindent |
| 13935 | This command is especially useful for determining what data to collect |
| 13936 | during a @dfn{trace experiment}, see @ref{Tracepoint Actions, |
| 13937 | collect}. |
| 13938 | |
| 13939 | @kindex info source |
| 13940 | @item info source |
| 13941 | Show information about the current source file---that is, the source file for |
| 13942 | the function containing the current point of execution: |
| 13943 | @itemize @bullet |
| 13944 | @item |
| 13945 | the name of the source file, and the directory containing it, |
| 13946 | @item |
| 13947 | the directory it was compiled in, |
| 13948 | @item |
| 13949 | its length, in lines, |
| 13950 | @item |
| 13951 | which programming language it is written in, |
| 13952 | @item |
| 13953 | whether the executable includes debugging information for that file, and |
| 13954 | if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and |
| 13955 | @item |
| 13956 | whether the debugging information includes information about |
| 13957 | preprocessor macros. |
| 13958 | @end itemize |
| 13959 | |
| 13960 | |
| 13961 | @kindex info sources |
| 13962 | @item info sources |
| 13963 | Print the names of all source files in your program for which there is |
| 13964 | debugging information, organized into two lists: files whose symbols |
| 13965 | have already been read, and files whose symbols will be read when needed. |
| 13966 | |
| 13967 | @kindex info functions |
| 13968 | @item info functions |
| 13969 | Print the names and data types of all defined functions. |
| 13970 | |
| 13971 | @item info functions @var{regexp} |
| 13972 | Print the names and data types of all defined functions |
| 13973 | whose names contain a match for regular expression @var{regexp}. |
| 13974 | Thus, @samp{info fun step} finds all functions whose names |
| 13975 | include @code{step}; @samp{info fun ^step} finds those whose names |
| 13976 | start with @code{step}. If a function name contains characters |
| 13977 | that conflict with the regular expression language (e.g.@: |
| 13978 | @samp{operator*()}), they may be quoted with a backslash. |
| 13979 | |
| 13980 | @kindex info variables |
| 13981 | @item info variables |
| 13982 | Print the names and data types of all variables that are defined |
| 13983 | outside of functions (i.e.@: excluding local variables). |
| 13984 | |
| 13985 | @item info variables @var{regexp} |
| 13986 | Print the names and data types of all variables (except for local |
| 13987 | variables) whose names contain a match for regular expression |
| 13988 | @var{regexp}. |
| 13989 | |
| 13990 | @kindex info classes |
| 13991 | @cindex Objective-C, classes and selectors |
| 13992 | @item info classes |
| 13993 | @itemx info classes @var{regexp} |
| 13994 | Display all Objective-C classes in your program, or |
| 13995 | (with the @var{regexp} argument) all those matching a particular regular |
| 13996 | expression. |
| 13997 | |
| 13998 | @kindex info selectors |
| 13999 | @item info selectors |
| 14000 | @itemx info selectors @var{regexp} |
| 14001 | Display all Objective-C selectors in your program, or |
| 14002 | (with the @var{regexp} argument) all those matching a particular regular |
| 14003 | expression. |
| 14004 | |
| 14005 | @ignore |
| 14006 | This was never implemented. |
| 14007 | @kindex info methods |
| 14008 | @item info methods |
| 14009 | @itemx info methods @var{regexp} |
| 14010 | The @code{info methods} command permits the user to examine all defined |
| 14011 | methods within C@t{++} program, or (with the @var{regexp} argument) a |
| 14012 | specific set of methods found in the various C@t{++} classes. Many |
| 14013 | C@t{++} classes provide a large number of methods. Thus, the output |
| 14014 | from the @code{ptype} command can be overwhelming and hard to use. The |
| 14015 | @code{info-methods} command filters the methods, printing only those |
| 14016 | which match the regular-expression @var{regexp}. |
| 14017 | @end ignore |
| 14018 | |
| 14019 | @cindex reloading symbols |
| 14020 | Some systems allow individual object files that make up your program to |
| 14021 | be replaced without stopping and restarting your program. For example, |
| 14022 | in VxWorks you can simply recompile a defective object file and keep on |
| 14023 | running. If you are running on one of these systems, you can allow |
| 14024 | @value{GDBN} to reload the symbols for automatically relinked modules: |
| 14025 | |
| 14026 | @table @code |
| 14027 | @kindex set symbol-reloading |
| 14028 | @item set symbol-reloading on |
| 14029 | Replace symbol definitions for the corresponding source file when an |
| 14030 | object file with a particular name is seen again. |
| 14031 | |
| 14032 | @item set symbol-reloading off |
| 14033 | Do not replace symbol definitions when encountering object files of the |
| 14034 | same name more than once. This is the default state; if you are not |
| 14035 | running on a system that permits automatic relinking of modules, you |
| 14036 | should leave @code{symbol-reloading} off, since otherwise @value{GDBN} |
| 14037 | may discard symbols when linking large programs, that may contain |
| 14038 | several modules (from different directories or libraries) with the same |
| 14039 | name. |
| 14040 | |
| 14041 | @kindex show symbol-reloading |
| 14042 | @item show symbol-reloading |
| 14043 | Show the current @code{on} or @code{off} setting. |
| 14044 | @end table |
| 14045 | |
| 14046 | @cindex opaque data types |
| 14047 | @kindex set opaque-type-resolution |
| 14048 | @item set opaque-type-resolution on |
| 14049 | Tell @value{GDBN} to resolve opaque types. An opaque type is a type |
| 14050 | declared as a pointer to a @code{struct}, @code{class}, or |
| 14051 | @code{union}---for example, @code{struct MyType *}---that is used in one |
| 14052 | source file although the full declaration of @code{struct MyType} is in |
| 14053 | another source file. The default is on. |
| 14054 | |
| 14055 | A change in the setting of this subcommand will not take effect until |
| 14056 | the next time symbols for a file are loaded. |
| 14057 | |
| 14058 | @item set opaque-type-resolution off |
| 14059 | Tell @value{GDBN} not to resolve opaque types. In this case, the type |
| 14060 | is printed as follows: |
| 14061 | @smallexample |
| 14062 | @{<no data fields>@} |
| 14063 | @end smallexample |
| 14064 | |
| 14065 | @kindex show opaque-type-resolution |
| 14066 | @item show opaque-type-resolution |
| 14067 | Show whether opaque types are resolved or not. |
| 14068 | |
| 14069 | @kindex maint print symbols |
| 14070 | @cindex symbol dump |
| 14071 | @kindex maint print psymbols |
| 14072 | @cindex partial symbol dump |
| 14073 | @item maint print symbols @var{filename} |
| 14074 | @itemx maint print psymbols @var{filename} |
| 14075 | @itemx maint print msymbols @var{filename} |
| 14076 | Write a dump of debugging symbol data into the file @var{filename}. |
| 14077 | These commands are used to debug the @value{GDBN} symbol-reading code. Only |
| 14078 | symbols with debugging data are included. If you use @samp{maint print |
| 14079 | symbols}, @value{GDBN} includes all the symbols for which it has already |
| 14080 | collected full details: that is, @var{filename} reflects symbols for |
| 14081 | only those files whose symbols @value{GDBN} has read. You can use the |
| 14082 | command @code{info sources} to find out which files these are. If you |
| 14083 | use @samp{maint print psymbols} instead, the dump shows information about |
| 14084 | symbols that @value{GDBN} only knows partially---that is, symbols defined in |
| 14085 | files that @value{GDBN} has skimmed, but not yet read completely. Finally, |
| 14086 | @samp{maint print msymbols} dumps just the minimal symbol information |
| 14087 | required for each object file from which @value{GDBN} has read some symbols. |
| 14088 | @xref{Files, ,Commands to Specify Files}, for a discussion of how |
| 14089 | @value{GDBN} reads symbols (in the description of @code{symbol-file}). |
| 14090 | |
| 14091 | @kindex maint info symtabs |
| 14092 | @kindex maint info psymtabs |
| 14093 | @cindex listing @value{GDBN}'s internal symbol tables |
| 14094 | @cindex symbol tables, listing @value{GDBN}'s internal |
| 14095 | @cindex full symbol tables, listing @value{GDBN}'s internal |
| 14096 | @cindex partial symbol tables, listing @value{GDBN}'s internal |
| 14097 | @item maint info symtabs @r{[} @var{regexp} @r{]} |
| 14098 | @itemx maint info psymtabs @r{[} @var{regexp} @r{]} |
| 14099 | |
| 14100 | List the @code{struct symtab} or @code{struct partial_symtab} |
| 14101 | structures whose names match @var{regexp}. If @var{regexp} is not |
| 14102 | given, list them all. The output includes expressions which you can |
| 14103 | copy into a @value{GDBN} debugging this one to examine a particular |
| 14104 | structure in more detail. For example: |
| 14105 | |
| 14106 | @smallexample |
| 14107 | (@value{GDBP}) maint info psymtabs dwarf2read |
| 14108 | @{ objfile /home/gnu/build/gdb/gdb |
| 14109 | ((struct objfile *) 0x82e69d0) |
| 14110 | @{ psymtab /home/gnu/src/gdb/dwarf2read.c |
| 14111 | ((struct partial_symtab *) 0x8474b10) |
| 14112 | readin no |
| 14113 | fullname (null) |
| 14114 | text addresses 0x814d3c8 -- 0x8158074 |
| 14115 | globals (* (struct partial_symbol **) 0x8507a08 @@ 9) |
| 14116 | statics (* (struct partial_symbol **) 0x40e95b78 @@ 2882) |
| 14117 | dependencies (none) |
| 14118 | @} |
| 14119 | @} |
| 14120 | (@value{GDBP}) maint info symtabs |
| 14121 | (@value{GDBP}) |
| 14122 | @end smallexample |
| 14123 | @noindent |
| 14124 | We see that there is one partial symbol table whose filename contains |
| 14125 | the string @samp{dwarf2read}, belonging to the @samp{gdb} executable; |
| 14126 | and we see that @value{GDBN} has not read in any symtabs yet at all. |
| 14127 | If we set a breakpoint on a function, that will cause @value{GDBN} to |
| 14128 | read the symtab for the compilation unit containing that function: |
| 14129 | |
| 14130 | @smallexample |
| 14131 | (@value{GDBP}) break dwarf2_psymtab_to_symtab |
| 14132 | Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c, |
| 14133 | line 1574. |
| 14134 | (@value{GDBP}) maint info symtabs |
| 14135 | @{ objfile /home/gnu/build/gdb/gdb |
| 14136 | ((struct objfile *) 0x82e69d0) |
| 14137 | @{ symtab /home/gnu/src/gdb/dwarf2read.c |
| 14138 | ((struct symtab *) 0x86c1f38) |
| 14139 | dirname (null) |
| 14140 | fullname (null) |
| 14141 | blockvector ((struct blockvector *) 0x86c1bd0) (primary) |
| 14142 | linetable ((struct linetable *) 0x8370fa0) |
| 14143 | debugformat DWARF 2 |
| 14144 | @} |
| 14145 | @} |
| 14146 | (@value{GDBP}) |
| 14147 | @end smallexample |
| 14148 | @end table |
| 14149 | |
| 14150 | |
| 14151 | @node Altering |
| 14152 | @chapter Altering Execution |
| 14153 | |
| 14154 | Once you think you have found an error in your program, you might want to |
| 14155 | find out for certain whether correcting the apparent error would lead to |
| 14156 | correct results in the rest of the run. You can find the answer by |
| 14157 | experiment, using the @value{GDBN} features for altering execution of the |
| 14158 | program. |
| 14159 | |
| 14160 | For example, you can store new values into variables or memory |
| 14161 | locations, give your program a signal, restart it at a different |
| 14162 | address, or even return prematurely from a function. |
| 14163 | |
| 14164 | @menu |
| 14165 | * Assignment:: Assignment to variables |
| 14166 | * Jumping:: Continuing at a different address |
| 14167 | * Signaling:: Giving your program a signal |
| 14168 | * Returning:: Returning from a function |
| 14169 | * Calling:: Calling your program's functions |
| 14170 | * Patching:: Patching your program |
| 14171 | @end menu |
| 14172 | |
| 14173 | @node Assignment |
| 14174 | @section Assignment to Variables |
| 14175 | |
| 14176 | @cindex assignment |
| 14177 | @cindex setting variables |
| 14178 | To alter the value of a variable, evaluate an assignment expression. |
| 14179 | @xref{Expressions, ,Expressions}. For example, |
| 14180 | |
| 14181 | @smallexample |
| 14182 | print x=4 |
| 14183 | @end smallexample |
| 14184 | |
| 14185 | @noindent |
| 14186 | stores the value 4 into the variable @code{x}, and then prints the |
| 14187 | value of the assignment expression (which is 4). |
| 14188 | @xref{Languages, ,Using @value{GDBN} with Different Languages}, for more |
| 14189 | information on operators in supported languages. |
| 14190 | |
| 14191 | @kindex set variable |
| 14192 | @cindex variables, setting |
| 14193 | If you are not interested in seeing the value of the assignment, use the |
| 14194 | @code{set} command instead of the @code{print} command. @code{set} is |
| 14195 | really the same as @code{print} except that the expression's value is |
| 14196 | not printed and is not put in the value history (@pxref{Value History, |
| 14197 | ,Value History}). The expression is evaluated only for its effects. |
| 14198 | |
| 14199 | If the beginning of the argument string of the @code{set} command |
| 14200 | appears identical to a @code{set} subcommand, use the @code{set |
| 14201 | variable} command instead of just @code{set}. This command is identical |
| 14202 | to @code{set} except for its lack of subcommands. For example, if your |
| 14203 | program has a variable @code{width}, you get an error if you try to set |
| 14204 | a new value with just @samp{set width=13}, because @value{GDBN} has the |
| 14205 | command @code{set width}: |
| 14206 | |
| 14207 | @smallexample |
| 14208 | (@value{GDBP}) whatis width |
| 14209 | type = double |
| 14210 | (@value{GDBP}) p width |
| 14211 | $4 = 13 |
| 14212 | (@value{GDBP}) set width=47 |
| 14213 | Invalid syntax in expression. |
| 14214 | @end smallexample |
| 14215 | |
| 14216 | @noindent |
| 14217 | The invalid expression, of course, is @samp{=47}. In |
| 14218 | order to actually set the program's variable @code{width}, use |
| 14219 | |
| 14220 | @smallexample |
| 14221 | (@value{GDBP}) set var width=47 |
| 14222 | @end smallexample |
| 14223 | |
| 14224 | Because the @code{set} command has many subcommands that can conflict |
| 14225 | with the names of program variables, it is a good idea to use the |
| 14226 | @code{set variable} command instead of just @code{set}. For example, if |
| 14227 | your program has a variable @code{g}, you run into problems if you try |
| 14228 | to set a new value with just @samp{set g=4}, because @value{GDBN} has |
| 14229 | the command @code{set gnutarget}, abbreviated @code{set g}: |
| 14230 | |
| 14231 | @smallexample |
| 14232 | @group |
| 14233 | (@value{GDBP}) whatis g |
| 14234 | type = double |
| 14235 | (@value{GDBP}) p g |
| 14236 | $1 = 1 |
| 14237 | (@value{GDBP}) set g=4 |
| 14238 | (@value{GDBP}) p g |
| 14239 | $2 = 1 |
| 14240 | (@value{GDBP}) r |
| 14241 | The program being debugged has been started already. |
| 14242 | Start it from the beginning? (y or n) y |
| 14243 | Starting program: /home/smith/cc_progs/a.out |
| 14244 | "/home/smith/cc_progs/a.out": can't open to read symbols: |
| 14245 | Invalid bfd target. |
| 14246 | (@value{GDBP}) show g |
| 14247 | The current BFD target is "=4". |
| 14248 | @end group |
| 14249 | @end smallexample |
| 14250 | |
| 14251 | @noindent |
| 14252 | The program variable @code{g} did not change, and you silently set the |
| 14253 | @code{gnutarget} to an invalid value. In order to set the variable |
| 14254 | @code{g}, use |
| 14255 | |
| 14256 | @smallexample |
| 14257 | (@value{GDBP}) set var g=4 |
| 14258 | @end smallexample |
| 14259 | |
| 14260 | @value{GDBN} allows more implicit conversions in assignments than C; you can |
| 14261 | freely store an integer value into a pointer variable or vice versa, |
| 14262 | and you can convert any structure to any other structure that is the |
| 14263 | same length or shorter. |
| 14264 | @comment FIXME: how do structs align/pad in these conversions? |
| 14265 | @comment /doc@cygnus.com 18dec1990 |
| 14266 | |
| 14267 | To store values into arbitrary places in memory, use the @samp{@{@dots{}@}} |
| 14268 | construct to generate a value of specified type at a specified address |
| 14269 | (@pxref{Expressions, ,Expressions}). For example, @code{@{int@}0x83040} refers |
| 14270 | to memory location @code{0x83040} as an integer (which implies a certain size |
| 14271 | and representation in memory), and |
| 14272 | |
| 14273 | @smallexample |
| 14274 | set @{int@}0x83040 = 4 |
| 14275 | @end smallexample |
| 14276 | |
| 14277 | @noindent |
| 14278 | stores the value 4 into that memory location. |
| 14279 | |
| 14280 | @node Jumping |
| 14281 | @section Continuing at a Different Address |
| 14282 | |
| 14283 | Ordinarily, when you continue your program, you do so at the place where |
| 14284 | it stopped, with the @code{continue} command. You can instead continue at |
| 14285 | an address of your own choosing, with the following commands: |
| 14286 | |
| 14287 | @table @code |
| 14288 | @kindex jump |
| 14289 | @item jump @var{linespec} |
| 14290 | @itemx jump @var{location} |
| 14291 | Resume execution at line @var{linespec} or at address given by |
| 14292 | @var{location}. Execution stops again immediately if there is a |
| 14293 | breakpoint there. @xref{Specify Location}, for a description of the |
| 14294 | different forms of @var{linespec} and @var{location}. It is common |
| 14295 | practice to use the @code{tbreak} command in conjunction with |
| 14296 | @code{jump}. @xref{Set Breaks, ,Setting Breakpoints}. |
| 14297 | |
| 14298 | The @code{jump} command does not change the current stack frame, or |
| 14299 | the stack pointer, or the contents of any memory location or any |
| 14300 | register other than the program counter. If line @var{linespec} is in |
| 14301 | a different function from the one currently executing, the results may |
| 14302 | be bizarre if the two functions expect different patterns of arguments or |
| 14303 | of local variables. For this reason, the @code{jump} command requests |
| 14304 | confirmation if the specified line is not in the function currently |
| 14305 | executing. However, even bizarre results are predictable if you are |
| 14306 | well acquainted with the machine-language code of your program. |
| 14307 | @end table |
| 14308 | |
| 14309 | @c Doesn't work on HP-UX; have to set $pcoqh and $pcoqt. |
| 14310 | On many systems, you can get much the same effect as the @code{jump} |
| 14311 | command by storing a new value into the register @code{$pc}. The |
| 14312 | difference is that this does not start your program running; it only |
| 14313 | changes the address of where it @emph{will} run when you continue. For |
| 14314 | example, |
| 14315 | |
| 14316 | @smallexample |
| 14317 | set $pc = 0x485 |
| 14318 | @end smallexample |
| 14319 | |
| 14320 | @noindent |
| 14321 | makes the next @code{continue} command or stepping command execute at |
| 14322 | address @code{0x485}, rather than at the address where your program stopped. |
| 14323 | @xref{Continuing and Stepping, ,Continuing and Stepping}. |
| 14324 | |
| 14325 | The most common occasion to use the @code{jump} command is to back |
| 14326 | up---perhaps with more breakpoints set---over a portion of a program |
| 14327 | that has already executed, in order to examine its execution in more |
| 14328 | detail. |
| 14329 | |
| 14330 | @c @group |
| 14331 | @node Signaling |
| 14332 | @section Giving your Program a Signal |
| 14333 | @cindex deliver a signal to a program |
| 14334 | |
| 14335 | @table @code |
| 14336 | @kindex signal |
| 14337 | @item signal @var{signal} |
| 14338 | Resume execution where your program stopped, but immediately give it the |
| 14339 | signal @var{signal}. @var{signal} can be the name or the number of a |
| 14340 | signal. For example, on many systems @code{signal 2} and @code{signal |
| 14341 | SIGINT} are both ways of sending an interrupt signal. |
| 14342 | |
| 14343 | Alternatively, if @var{signal} is zero, continue execution without |
| 14344 | giving a signal. This is useful when your program stopped on account of |
| 14345 | a signal and would ordinary see the signal when resumed with the |
| 14346 | @code{continue} command; @samp{signal 0} causes it to resume without a |
| 14347 | signal. |
| 14348 | |
| 14349 | @code{signal} does not repeat when you press @key{RET} a second time |
| 14350 | after executing the command. |
| 14351 | @end table |
| 14352 | @c @end group |
| 14353 | |
| 14354 | Invoking the @code{signal} command is not the same as invoking the |
| 14355 | @code{kill} utility from the shell. Sending a signal with @code{kill} |
| 14356 | causes @value{GDBN} to decide what to do with the signal depending on |
| 14357 | the signal handling tables (@pxref{Signals}). The @code{signal} command |
| 14358 | passes the signal directly to your program. |
| 14359 | |
| 14360 | |
| 14361 | @node Returning |
| 14362 | @section Returning from a Function |
| 14363 | |
| 14364 | @table @code |
| 14365 | @cindex returning from a function |
| 14366 | @kindex return |
| 14367 | @item return |
| 14368 | @itemx return @var{expression} |
| 14369 | You can cancel execution of a function call with the @code{return} |
| 14370 | command. If you give an |
| 14371 | @var{expression} argument, its value is used as the function's return |
| 14372 | value. |
| 14373 | @end table |
| 14374 | |
| 14375 | When you use @code{return}, @value{GDBN} discards the selected stack frame |
| 14376 | (and all frames within it). You can think of this as making the |
| 14377 | discarded frame return prematurely. If you wish to specify a value to |
| 14378 | be returned, give that value as the argument to @code{return}. |
| 14379 | |
| 14380 | This pops the selected stack frame (@pxref{Selection, ,Selecting a |
| 14381 | Frame}), and any other frames inside of it, leaving its caller as the |
| 14382 | innermost remaining frame. That frame becomes selected. The |
| 14383 | specified value is stored in the registers used for returning values |
| 14384 | of functions. |
| 14385 | |
| 14386 | The @code{return} command does not resume execution; it leaves the |
| 14387 | program stopped in the state that would exist if the function had just |
| 14388 | returned. In contrast, the @code{finish} command (@pxref{Continuing |
| 14389 | and Stepping, ,Continuing and Stepping}) resumes execution until the |
| 14390 | selected stack frame returns naturally. |
| 14391 | |
| 14392 | @value{GDBN} needs to know how the @var{expression} argument should be set for |
| 14393 | the inferior. The concrete registers assignment depends on the OS ABI and the |
| 14394 | type being returned by the selected stack frame. For example it is common for |
| 14395 | OS ABI to return floating point values in FPU registers while integer values in |
| 14396 | CPU registers. Still some ABIs return even floating point values in CPU |
| 14397 | registers. Larger integer widths (such as @code{long long int}) also have |
| 14398 | specific placement rules. @value{GDBN} already knows the OS ABI from its |
| 14399 | current target so it needs to find out also the type being returned to make the |
| 14400 | assignment into the right register(s). |
| 14401 | |
| 14402 | Normally, the selected stack frame has debug info. @value{GDBN} will always |
| 14403 | use the debug info instead of the implicit type of @var{expression} when the |
| 14404 | debug info is available. For example, if you type @kbd{return -1}, and the |
| 14405 | function in the current stack frame is declared to return a @code{long long |
| 14406 | int}, @value{GDBN} transparently converts the implicit @code{int} value of -1 |
| 14407 | into a @code{long long int}: |
| 14408 | |
| 14409 | @smallexample |
| 14410 | Breakpoint 1, func () at gdb.base/return-nodebug.c:29 |
| 14411 | 29 return 31; |
| 14412 | (@value{GDBP}) return -1 |
| 14413 | Make func return now? (y or n) y |
| 14414 | #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43 |
| 14415 | 43 printf ("result=%lld\n", func ()); |
| 14416 | (@value{GDBP}) |
| 14417 | @end smallexample |
| 14418 | |
| 14419 | However, if the selected stack frame does not have a debug info, e.g., if the |
| 14420 | function was compiled without debug info, @value{GDBN} has to find out the type |
| 14421 | to return from user. Specifying a different type by mistake may set the value |
| 14422 | in different inferior registers than the caller code expects. For example, |
| 14423 | typing @kbd{return -1} with its implicit type @code{int} would set only a part |
| 14424 | of a @code{long long int} result for a debug info less function (on 32-bit |
| 14425 | architectures). Therefore the user is required to specify the return type by |
| 14426 | an appropriate cast explicitly: |
| 14427 | |
| 14428 | @smallexample |
| 14429 | Breakpoint 2, 0x0040050b in func () |
| 14430 | (@value{GDBP}) return -1 |
| 14431 | Return value type not available for selected stack frame. |
| 14432 | Please use an explicit cast of the value to return. |
| 14433 | (@value{GDBP}) return (long long int) -1 |
| 14434 | Make selected stack frame return now? (y or n) y |
| 14435 | #0 0x00400526 in main () |
| 14436 | (@value{GDBP}) |
| 14437 | @end smallexample |
| 14438 | |
| 14439 | @node Calling |
| 14440 | @section Calling Program Functions |
| 14441 | |
| 14442 | @table @code |
| 14443 | @cindex calling functions |
| 14444 | @cindex inferior functions, calling |
| 14445 | @item print @var{expr} |
| 14446 | Evaluate the expression @var{expr} and display the resulting value. |
| 14447 | @var{expr} may include calls to functions in the program being |
| 14448 | debugged. |
| 14449 | |
| 14450 | @kindex call |
| 14451 | @item call @var{expr} |
| 14452 | Evaluate the expression @var{expr} without displaying @code{void} |
| 14453 | returned values. |
| 14454 | |
| 14455 | You can use this variant of the @code{print} command if you want to |
| 14456 | execute a function from your program that does not return anything |
| 14457 | (a.k.a.@: @dfn{a void function}), but without cluttering the output |
| 14458 | with @code{void} returned values that @value{GDBN} will otherwise |
| 14459 | print. If the result is not void, it is printed and saved in the |
| 14460 | value history. |
| 14461 | @end table |
| 14462 | |
| 14463 | It is possible for the function you call via the @code{print} or |
| 14464 | @code{call} command to generate a signal (e.g., if there's a bug in |
| 14465 | the function, or if you passed it incorrect arguments). What happens |
| 14466 | in that case is controlled by the @code{set unwindonsignal} command. |
| 14467 | |
| 14468 | Similarly, with a C@t{++} program it is possible for the function you |
| 14469 | call via the @code{print} or @code{call} command to generate an |
| 14470 | exception that is not handled due to the constraints of the dummy |
| 14471 | frame. In this case, any exception that is raised in the frame, but has |
| 14472 | an out-of-frame exception handler will not be found. GDB builds a |
| 14473 | dummy-frame for the inferior function call, and the unwinder cannot |
| 14474 | seek for exception handlers outside of this dummy-frame. What happens |
| 14475 | in that case is controlled by the |
| 14476 | @code{set unwind-on-terminating-exception} command. |
| 14477 | |
| 14478 | @table @code |
| 14479 | @item set unwindonsignal |
| 14480 | @kindex set unwindonsignal |
| 14481 | @cindex unwind stack in called functions |
| 14482 | @cindex call dummy stack unwinding |
| 14483 | Set unwinding of the stack if a signal is received while in a function |
| 14484 | that @value{GDBN} called in the program being debugged. If set to on, |
| 14485 | @value{GDBN} unwinds the stack it created for the call and restores |
| 14486 | the context to what it was before the call. If set to off (the |
| 14487 | default), @value{GDBN} stops in the frame where the signal was |
| 14488 | received. |
| 14489 | |
| 14490 | @item show unwindonsignal |
| 14491 | @kindex show unwindonsignal |
| 14492 | Show the current setting of stack unwinding in the functions called by |
| 14493 | @value{GDBN}. |
| 14494 | |
| 14495 | @item set unwind-on-terminating-exception |
| 14496 | @kindex set unwind-on-terminating-exception |
| 14497 | @cindex unwind stack in called functions with unhandled exceptions |
| 14498 | @cindex call dummy stack unwinding on unhandled exception. |
| 14499 | Set unwinding of the stack if a C@t{++} exception is raised, but left |
| 14500 | unhandled while in a function that @value{GDBN} called in the program being |
| 14501 | debugged. If set to on (the default), @value{GDBN} unwinds the stack |
| 14502 | it created for the call and restores the context to what it was before |
| 14503 | the call. If set to off, @value{GDBN} the exception is delivered to |
| 14504 | the default C@t{++} exception handler and the inferior terminated. |
| 14505 | |
| 14506 | @item show unwind-on-terminating-exception |
| 14507 | @kindex show unwind-on-terminating-exception |
| 14508 | Show the current setting of stack unwinding in the functions called by |
| 14509 | @value{GDBN}. |
| 14510 | |
| 14511 | @end table |
| 14512 | |
| 14513 | @cindex weak alias functions |
| 14514 | Sometimes, a function you wish to call is actually a @dfn{weak alias} |
| 14515 | for another function. In such case, @value{GDBN} might not pick up |
| 14516 | the type information, including the types of the function arguments, |
| 14517 | which causes @value{GDBN} to call the inferior function incorrectly. |
| 14518 | As a result, the called function will function erroneously and may |
| 14519 | even crash. A solution to that is to use the name of the aliased |
| 14520 | function instead. |
| 14521 | |
| 14522 | @node Patching |
| 14523 | @section Patching Programs |
| 14524 | |
| 14525 | @cindex patching binaries |
| 14526 | @cindex writing into executables |
| 14527 | @cindex writing into corefiles |
| 14528 | |
| 14529 | By default, @value{GDBN} opens the file containing your program's |
| 14530 | executable code (or the corefile) read-only. This prevents accidental |
| 14531 | alterations to machine code; but it also prevents you from intentionally |
| 14532 | patching your program's binary. |
| 14533 | |
| 14534 | If you'd like to be able to patch the binary, you can specify that |
| 14535 | explicitly with the @code{set write} command. For example, you might |
| 14536 | want to turn on internal debugging flags, or even to make emergency |
| 14537 | repairs. |
| 14538 | |
| 14539 | @table @code |
| 14540 | @kindex set write |
| 14541 | @item set write on |
| 14542 | @itemx set write off |
| 14543 | If you specify @samp{set write on}, @value{GDBN} opens executable and |
| 14544 | core files for both reading and writing; if you specify @kbd{set write |
| 14545 | off} (the default), @value{GDBN} opens them read-only. |
| 14546 | |
| 14547 | If you have already loaded a file, you must load it again (using the |
| 14548 | @code{exec-file} or @code{core-file} command) after changing @code{set |
| 14549 | write}, for your new setting to take effect. |
| 14550 | |
| 14551 | @item show write |
| 14552 | @kindex show write |
| 14553 | Display whether executable files and core files are opened for writing |
| 14554 | as well as reading. |
| 14555 | @end table |
| 14556 | |
| 14557 | @node GDB Files |
| 14558 | @chapter @value{GDBN} Files |
| 14559 | |
| 14560 | @value{GDBN} needs to know the file name of the program to be debugged, |
| 14561 | both in order to read its symbol table and in order to start your |
| 14562 | program. To debug a core dump of a previous run, you must also tell |
| 14563 | @value{GDBN} the name of the core dump file. |
| 14564 | |
| 14565 | @menu |
| 14566 | * Files:: Commands to specify files |
| 14567 | * Separate Debug Files:: Debugging information in separate files |
| 14568 | * Index Files:: Index files speed up GDB |
| 14569 | * Symbol Errors:: Errors reading symbol files |
| 14570 | * Data Files:: GDB data files |
| 14571 | @end menu |
| 14572 | |
| 14573 | @node Files |
| 14574 | @section Commands to Specify Files |
| 14575 | |
| 14576 | @cindex symbol table |
| 14577 | @cindex core dump file |
| 14578 | |
| 14579 | You may want to specify executable and core dump file names. The usual |
| 14580 | way to do this is at start-up time, using the arguments to |
| 14581 | @value{GDBN}'s start-up commands (@pxref{Invocation, , Getting In and |
| 14582 | Out of @value{GDBN}}). |
| 14583 | |
| 14584 | Occasionally it is necessary to change to a different file during a |
| 14585 | @value{GDBN} session. Or you may run @value{GDBN} and forget to |
| 14586 | specify a file you want to use. Or you are debugging a remote target |
| 14587 | via @code{gdbserver} (@pxref{Server, file, Using the @code{gdbserver} |
| 14588 | Program}). In these situations the @value{GDBN} commands to specify |
| 14589 | new files are useful. |
| 14590 | |
| 14591 | @table @code |
| 14592 | @cindex executable file |
| 14593 | @kindex file |
| 14594 | @item file @var{filename} |
| 14595 | Use @var{filename} as the program to be debugged. It is read for its |
| 14596 | symbols and for the contents of pure memory. It is also the program |
| 14597 | executed when you use the @code{run} command. If you do not specify a |
| 14598 | directory and the file is not found in the @value{GDBN} working directory, |
| 14599 | @value{GDBN} uses the environment variable @code{PATH} as a list of |
| 14600 | directories to search, just as the shell does when looking for a program |
| 14601 | to run. You can change the value of this variable, for both @value{GDBN} |
| 14602 | and your program, using the @code{path} command. |
| 14603 | |
| 14604 | @cindex unlinked object files |
| 14605 | @cindex patching object files |
| 14606 | You can load unlinked object @file{.o} files into @value{GDBN} using |
| 14607 | the @code{file} command. You will not be able to ``run'' an object |
| 14608 | file, but you can disassemble functions and inspect variables. Also, |
| 14609 | if the underlying BFD functionality supports it, you could use |
| 14610 | @kbd{gdb -write} to patch object files using this technique. Note |
| 14611 | that @value{GDBN} can neither interpret nor modify relocations in this |
| 14612 | case, so branches and some initialized variables will appear to go to |
| 14613 | the wrong place. But this feature is still handy from time to time. |
| 14614 | |
| 14615 | @item file |
| 14616 | @code{file} with no argument makes @value{GDBN} discard any information it |
| 14617 | has on both executable file and the symbol table. |
| 14618 | |
| 14619 | @kindex exec-file |
| 14620 | @item exec-file @r{[} @var{filename} @r{]} |
| 14621 | Specify that the program to be run (but not the symbol table) is found |
| 14622 | in @var{filename}. @value{GDBN} searches the environment variable @code{PATH} |
| 14623 | if necessary to locate your program. Omitting @var{filename} means to |
| 14624 | discard information on the executable file. |
| 14625 | |
| 14626 | @kindex symbol-file |
| 14627 | @item symbol-file @r{[} @var{filename} @r{]} |
| 14628 | Read symbol table information from file @var{filename}. @code{PATH} is |
| 14629 | searched when necessary. Use the @code{file} command to get both symbol |
| 14630 | table and program to run from the same file. |
| 14631 | |
| 14632 | @code{symbol-file} with no argument clears out @value{GDBN} information on your |
| 14633 | program's symbol table. |
| 14634 | |
| 14635 | The @code{symbol-file} command causes @value{GDBN} to forget the contents of |
| 14636 | some breakpoints and auto-display expressions. This is because they may |
| 14637 | contain pointers to the internal data recording symbols and data types, |
| 14638 | which are part of the old symbol table data being discarded inside |
| 14639 | @value{GDBN}. |
| 14640 | |
| 14641 | @code{symbol-file} does not repeat if you press @key{RET} again after |
| 14642 | executing it once. |
| 14643 | |
| 14644 | When @value{GDBN} is configured for a particular environment, it |
| 14645 | understands debugging information in whatever format is the standard |
| 14646 | generated for that environment; you may use either a @sc{gnu} compiler, or |
| 14647 | other compilers that adhere to the local conventions. |
| 14648 | Best results are usually obtained from @sc{gnu} compilers; for example, |
| 14649 | using @code{@value{NGCC}} you can generate debugging information for |
| 14650 | optimized code. |
| 14651 | |
| 14652 | For most kinds of object files, with the exception of old SVR3 systems |
| 14653 | using COFF, the @code{symbol-file} command does not normally read the |
| 14654 | symbol table in full right away. Instead, it scans the symbol table |
| 14655 | quickly to find which source files and which symbols are present. The |
| 14656 | details are read later, one source file at a time, as they are needed. |
| 14657 | |
| 14658 | The purpose of this two-stage reading strategy is to make @value{GDBN} |
| 14659 | start up faster. For the most part, it is invisible except for |
| 14660 | occasional pauses while the symbol table details for a particular source |
| 14661 | file are being read. (The @code{set verbose} command can turn these |
| 14662 | pauses into messages if desired. @xref{Messages/Warnings, ,Optional |
| 14663 | Warnings and Messages}.) |
| 14664 | |
| 14665 | We have not implemented the two-stage strategy for COFF yet. When the |
| 14666 | symbol table is stored in COFF format, @code{symbol-file} reads the |
| 14667 | symbol table data in full right away. Note that ``stabs-in-COFF'' |
| 14668 | still does the two-stage strategy, since the debug info is actually |
| 14669 | in stabs format. |
| 14670 | |
| 14671 | @kindex readnow |
| 14672 | @cindex reading symbols immediately |
| 14673 | @cindex symbols, reading immediately |
| 14674 | @item symbol-file @r{[} -readnow @r{]} @var{filename} |
| 14675 | @itemx file @r{[} -readnow @r{]} @var{filename} |
| 14676 | You can override the @value{GDBN} two-stage strategy for reading symbol |
| 14677 | tables by using the @samp{-readnow} option with any of the commands that |
| 14678 | load symbol table information, if you want to be sure @value{GDBN} has the |
| 14679 | entire symbol table available. |
| 14680 | |
| 14681 | @c FIXME: for now no mention of directories, since this seems to be in |
| 14682 | @c flux. 13mar1992 status is that in theory GDB would look either in |
| 14683 | @c current dir or in same dir as myprog; but issues like competing |
| 14684 | @c GDB's, or clutter in system dirs, mean that in practice right now |
| 14685 | @c only current dir is used. FFish says maybe a special GDB hierarchy |
| 14686 | @c (eg rooted in val of env var GDBSYMS) could exist for mappable symbol |
| 14687 | @c files. |
| 14688 | |
| 14689 | @kindex core-file |
| 14690 | @item core-file @r{[}@var{filename}@r{]} |
| 14691 | @itemx core |
| 14692 | Specify the whereabouts of a core dump file to be used as the ``contents |
| 14693 | of memory''. Traditionally, core files contain only some parts of the |
| 14694 | address space of the process that generated them; @value{GDBN} can access the |
| 14695 | executable file itself for other parts. |
| 14696 | |
| 14697 | @code{core-file} with no argument specifies that no core file is |
| 14698 | to be used. |
| 14699 | |
| 14700 | Note that the core file is ignored when your program is actually running |
| 14701 | under @value{GDBN}. So, if you have been running your program and you |
| 14702 | wish to debug a core file instead, you must kill the subprocess in which |
| 14703 | the program is running. To do this, use the @code{kill} command |
| 14704 | (@pxref{Kill Process, ,Killing the Child Process}). |
| 14705 | |
| 14706 | @kindex add-symbol-file |
| 14707 | @cindex dynamic linking |
| 14708 | @item add-symbol-file @var{filename} @var{address} |
| 14709 | @itemx add-symbol-file @var{filename} @var{address} @r{[} -readnow @r{]} |
| 14710 | @itemx add-symbol-file @var{filename} @r{-s}@var{section} @var{address} @dots{} |
| 14711 | The @code{add-symbol-file} command reads additional symbol table |
| 14712 | information from the file @var{filename}. You would use this command |
| 14713 | when @var{filename} has been dynamically loaded (by some other means) |
| 14714 | into the program that is running. @var{address} should be the memory |
| 14715 | address at which the file has been loaded; @value{GDBN} cannot figure |
| 14716 | this out for itself. You can additionally specify an arbitrary number |
| 14717 | of @samp{@r{-s}@var{section} @var{address}} pairs, to give an explicit |
| 14718 | section name and base address for that section. You can specify any |
| 14719 | @var{address} as an expression. |
| 14720 | |
| 14721 | The symbol table of the file @var{filename} is added to the symbol table |
| 14722 | originally read with the @code{symbol-file} command. You can use the |
| 14723 | @code{add-symbol-file} command any number of times; the new symbol data |
| 14724 | thus read keeps adding to the old. To discard all old symbol data |
| 14725 | instead, use the @code{symbol-file} command without any arguments. |
| 14726 | |
| 14727 | @cindex relocatable object files, reading symbols from |
| 14728 | @cindex object files, relocatable, reading symbols from |
| 14729 | @cindex reading symbols from relocatable object files |
| 14730 | @cindex symbols, reading from relocatable object files |
| 14731 | @cindex @file{.o} files, reading symbols from |
| 14732 | Although @var{filename} is typically a shared library file, an |
| 14733 | executable file, or some other object file which has been fully |
| 14734 | relocated for loading into a process, you can also load symbolic |
| 14735 | information from relocatable @file{.o} files, as long as: |
| 14736 | |
| 14737 | @itemize @bullet |
| 14738 | @item |
| 14739 | the file's symbolic information refers only to linker symbols defined in |
| 14740 | that file, not to symbols defined by other object files, |
| 14741 | @item |
| 14742 | every section the file's symbolic information refers to has actually |
| 14743 | been loaded into the inferior, as it appears in the file, and |
| 14744 | @item |
| 14745 | you can determine the address at which every section was loaded, and |
| 14746 | provide these to the @code{add-symbol-file} command. |
| 14747 | @end itemize |
| 14748 | |
| 14749 | @noindent |
| 14750 | Some embedded operating systems, like Sun Chorus and VxWorks, can load |
| 14751 | relocatable files into an already running program; such systems |
| 14752 | typically make the requirements above easy to meet. However, it's |
| 14753 | important to recognize that many native systems use complex link |
| 14754 | procedures (@code{.linkonce} section factoring and C@t{++} constructor table |
| 14755 | assembly, for example) that make the requirements difficult to meet. In |
| 14756 | general, one cannot assume that using @code{add-symbol-file} to read a |
| 14757 | relocatable object file's symbolic information will have the same effect |
| 14758 | as linking the relocatable object file into the program in the normal |
| 14759 | way. |
| 14760 | |
| 14761 | @code{add-symbol-file} does not repeat if you press @key{RET} after using it. |
| 14762 | |
| 14763 | @kindex add-symbol-file-from-memory |
| 14764 | @cindex @code{syscall DSO} |
| 14765 | @cindex load symbols from memory |
| 14766 | @item add-symbol-file-from-memory @var{address} |
| 14767 | Load symbols from the given @var{address} in a dynamically loaded |
| 14768 | object file whose image is mapped directly into the inferior's memory. |
| 14769 | For example, the Linux kernel maps a @code{syscall DSO} into each |
| 14770 | process's address space; this DSO provides kernel-specific code for |
| 14771 | some system calls. The argument can be any expression whose |
| 14772 | evaluation yields the address of the file's shared object file header. |
| 14773 | For this command to work, you must have used @code{symbol-file} or |
| 14774 | @code{exec-file} commands in advance. |
| 14775 | |
| 14776 | @kindex add-shared-symbol-files |
| 14777 | @kindex assf |
| 14778 | @item add-shared-symbol-files @var{library-file} |
| 14779 | @itemx assf @var{library-file} |
| 14780 | The @code{add-shared-symbol-files} command can currently be used only |
| 14781 | in the Cygwin build of @value{GDBN} on MS-Windows OS, where it is an |
| 14782 | alias for the @code{dll-symbols} command (@pxref{Cygwin Native}). |
| 14783 | @value{GDBN} automatically looks for shared libraries, however if |
| 14784 | @value{GDBN} does not find yours, you can invoke |
| 14785 | @code{add-shared-symbol-files}. It takes one argument: the shared |
| 14786 | library's file name. @code{assf} is a shorthand alias for |
| 14787 | @code{add-shared-symbol-files}. |
| 14788 | |
| 14789 | @kindex section |
| 14790 | @item section @var{section} @var{addr} |
| 14791 | The @code{section} command changes the base address of the named |
| 14792 | @var{section} of the exec file to @var{addr}. This can be used if the |
| 14793 | exec file does not contain section addresses, (such as in the |
| 14794 | @code{a.out} format), or when the addresses specified in the file |
| 14795 | itself are wrong. Each section must be changed separately. The |
| 14796 | @code{info files} command, described below, lists all the sections and |
| 14797 | their addresses. |
| 14798 | |
| 14799 | @kindex info files |
| 14800 | @kindex info target |
| 14801 | @item info files |
| 14802 | @itemx info target |
| 14803 | @code{info files} and @code{info target} are synonymous; both print the |
| 14804 | current target (@pxref{Targets, ,Specifying a Debugging Target}), |
| 14805 | including the names of the executable and core dump files currently in |
| 14806 | use by @value{GDBN}, and the files from which symbols were loaded. The |
| 14807 | command @code{help target} lists all possible targets rather than |
| 14808 | current ones. |
| 14809 | |
| 14810 | @kindex maint info sections |
| 14811 | @item maint info sections |
| 14812 | Another command that can give you extra information about program sections |
| 14813 | is @code{maint info sections}. In addition to the section information |
| 14814 | displayed by @code{info files}, this command displays the flags and file |
| 14815 | offset of each section in the executable and core dump files. In addition, |
| 14816 | @code{maint info sections} provides the following command options (which |
| 14817 | may be arbitrarily combined): |
| 14818 | |
| 14819 | @table @code |
| 14820 | @item ALLOBJ |
| 14821 | Display sections for all loaded object files, including shared libraries. |
| 14822 | @item @var{sections} |
| 14823 | Display info only for named @var{sections}. |
| 14824 | @item @var{section-flags} |
| 14825 | Display info only for sections for which @var{section-flags} are true. |
| 14826 | The section flags that @value{GDBN} currently knows about are: |
| 14827 | @table @code |
| 14828 | @item ALLOC |
| 14829 | Section will have space allocated in the process when loaded. |
| 14830 | Set for all sections except those containing debug information. |
| 14831 | @item LOAD |
| 14832 | Section will be loaded from the file into the child process memory. |
| 14833 | Set for pre-initialized code and data, clear for @code{.bss} sections. |
| 14834 | @item RELOC |
| 14835 | Section needs to be relocated before loading. |
| 14836 | @item READONLY |
| 14837 | Section cannot be modified by the child process. |
| 14838 | @item CODE |
| 14839 | Section contains executable code only. |
| 14840 | @item DATA |
| 14841 | Section contains data only (no executable code). |
| 14842 | @item ROM |
| 14843 | Section will reside in ROM. |
| 14844 | @item CONSTRUCTOR |
| 14845 | Section contains data for constructor/destructor lists. |
| 14846 | @item HAS_CONTENTS |
| 14847 | Section is not empty. |
| 14848 | @item NEVER_LOAD |
| 14849 | An instruction to the linker to not output the section. |
| 14850 | @item COFF_SHARED_LIBRARY |
| 14851 | A notification to the linker that the section contains |
| 14852 | COFF shared library information. |
| 14853 | @item IS_COMMON |
| 14854 | Section contains common symbols. |
| 14855 | @end table |
| 14856 | @end table |
| 14857 | @kindex set trust-readonly-sections |
| 14858 | @cindex read-only sections |
| 14859 | @item set trust-readonly-sections on |
| 14860 | Tell @value{GDBN} that readonly sections in your object file |
| 14861 | really are read-only (i.e.@: that their contents will not change). |
| 14862 | In that case, @value{GDBN} can fetch values from these sections |
| 14863 | out of the object file, rather than from the target program. |
| 14864 | For some targets (notably embedded ones), this can be a significant |
| 14865 | enhancement to debugging performance. |
| 14866 | |
| 14867 | The default is off. |
| 14868 | |
| 14869 | @item set trust-readonly-sections off |
| 14870 | Tell @value{GDBN} not to trust readonly sections. This means that |
| 14871 | the contents of the section might change while the program is running, |
| 14872 | and must therefore be fetched from the target when needed. |
| 14873 | |
| 14874 | @item show trust-readonly-sections |
| 14875 | Show the current setting of trusting readonly sections. |
| 14876 | @end table |
| 14877 | |
| 14878 | All file-specifying commands allow both absolute and relative file names |
| 14879 | as arguments. @value{GDBN} always converts the file name to an absolute file |
| 14880 | name and remembers it that way. |
| 14881 | |
| 14882 | @cindex shared libraries |
| 14883 | @anchor{Shared Libraries} |
| 14884 | @value{GDBN} supports @sc{gnu}/Linux, MS-Windows, HP-UX, SunOS, SVr4, Irix, |
| 14885 | and IBM RS/6000 AIX shared libraries. |
| 14886 | |
| 14887 | On MS-Windows @value{GDBN} must be linked with the Expat library to support |
| 14888 | shared libraries. @xref{Expat}. |
| 14889 | |
| 14890 | @value{GDBN} automatically loads symbol definitions from shared libraries |
| 14891 | when you use the @code{run} command, or when you examine a core file. |
| 14892 | (Before you issue the @code{run} command, @value{GDBN} does not understand |
| 14893 | references to a function in a shared library, however---unless you are |
| 14894 | debugging a core file). |
| 14895 | |
| 14896 | On HP-UX, if the program loads a library explicitly, @value{GDBN} |
| 14897 | automatically loads the symbols at the time of the @code{shl_load} call. |
| 14898 | |
| 14899 | @c FIXME: some @value{GDBN} release may permit some refs to undef |
| 14900 | @c FIXME...symbols---eg in a break cmd---assuming they are from a shared |
| 14901 | @c FIXME...lib; check this from time to time when updating manual |
| 14902 | |
| 14903 | There are times, however, when you may wish to not automatically load |
| 14904 | symbol definitions from shared libraries, such as when they are |
| 14905 | particularly large or there are many of them. |
| 14906 | |
| 14907 | To control the automatic loading of shared library symbols, use the |
| 14908 | commands: |
| 14909 | |
| 14910 | @table @code |
| 14911 | @kindex set auto-solib-add |
| 14912 | @item set auto-solib-add @var{mode} |
| 14913 | If @var{mode} is @code{on}, symbols from all shared object libraries |
| 14914 | will be loaded automatically when the inferior begins execution, you |
| 14915 | attach to an independently started inferior, or when the dynamic linker |
| 14916 | informs @value{GDBN} that a new library has been loaded. If @var{mode} |
| 14917 | is @code{off}, symbols must be loaded manually, using the |
| 14918 | @code{sharedlibrary} command. The default value is @code{on}. |
| 14919 | |
| 14920 | @cindex memory used for symbol tables |
| 14921 | If your program uses lots of shared libraries with debug info that |
| 14922 | takes large amounts of memory, you can decrease the @value{GDBN} |
| 14923 | memory footprint by preventing it from automatically loading the |
| 14924 | symbols from shared libraries. To that end, type @kbd{set |
| 14925 | auto-solib-add off} before running the inferior, then load each |
| 14926 | library whose debug symbols you do need with @kbd{sharedlibrary |
| 14927 | @var{regexp}}, where @var{regexp} is a regular expression that matches |
| 14928 | the libraries whose symbols you want to be loaded. |
| 14929 | |
| 14930 | @kindex show auto-solib-add |
| 14931 | @item show auto-solib-add |
| 14932 | Display the current autoloading mode. |
| 14933 | @end table |
| 14934 | |
| 14935 | @cindex load shared library |
| 14936 | To explicitly load shared library symbols, use the @code{sharedlibrary} |
| 14937 | command: |
| 14938 | |
| 14939 | @table @code |
| 14940 | @kindex info sharedlibrary |
| 14941 | @kindex info share |
| 14942 | @item info share @var{regex} |
| 14943 | @itemx info sharedlibrary @var{regex} |
| 14944 | Print the names of the shared libraries which are currently loaded |
| 14945 | that match @var{regex}. If @var{regex} is omitted then print |
| 14946 | all shared libraries that are loaded. |
| 14947 | |
| 14948 | @kindex sharedlibrary |
| 14949 | @kindex share |
| 14950 | @item sharedlibrary @var{regex} |
| 14951 | @itemx share @var{regex} |
| 14952 | Load shared object library symbols for files matching a |
| 14953 | Unix regular expression. |
| 14954 | As with files loaded automatically, it only loads shared libraries |
| 14955 | required by your program for a core file or after typing @code{run}. If |
| 14956 | @var{regex} is omitted all shared libraries required by your program are |
| 14957 | loaded. |
| 14958 | |
| 14959 | @item nosharedlibrary |
| 14960 | @kindex nosharedlibrary |
| 14961 | @cindex unload symbols from shared libraries |
| 14962 | Unload all shared object library symbols. This discards all symbols |
| 14963 | that have been loaded from all shared libraries. Symbols from shared |
| 14964 | libraries that were loaded by explicit user requests are not |
| 14965 | discarded. |
| 14966 | @end table |
| 14967 | |
| 14968 | Sometimes you may wish that @value{GDBN} stops and gives you control |
| 14969 | when any of shared library events happen. Use the @code{set |
| 14970 | stop-on-solib-events} command for this: |
| 14971 | |
| 14972 | @table @code |
| 14973 | @item set stop-on-solib-events |
| 14974 | @kindex set stop-on-solib-events |
| 14975 | This command controls whether @value{GDBN} should give you control |
| 14976 | when the dynamic linker notifies it about some shared library event. |
| 14977 | The most common event of interest is loading or unloading of a new |
| 14978 | shared library. |
| 14979 | |
| 14980 | @item show stop-on-solib-events |
| 14981 | @kindex show stop-on-solib-events |
| 14982 | Show whether @value{GDBN} stops and gives you control when shared |
| 14983 | library events happen. |
| 14984 | @end table |
| 14985 | |
| 14986 | Shared libraries are also supported in many cross or remote debugging |
| 14987 | configurations. @value{GDBN} needs to have access to the target's libraries; |
| 14988 | this can be accomplished either by providing copies of the libraries |
| 14989 | on the host system, or by asking @value{GDBN} to automatically retrieve the |
| 14990 | libraries from the target. If copies of the target libraries are |
| 14991 | provided, they need to be the same as the target libraries, although the |
| 14992 | copies on the target can be stripped as long as the copies on the host are |
| 14993 | not. |
| 14994 | |
| 14995 | @cindex where to look for shared libraries |
| 14996 | For remote debugging, you need to tell @value{GDBN} where the target |
| 14997 | libraries are, so that it can load the correct copies---otherwise, it |
| 14998 | may try to load the host's libraries. @value{GDBN} has two variables |
| 14999 | to specify the search directories for target libraries. |
| 15000 | |
| 15001 | @table @code |
| 15002 | @cindex prefix for shared library file names |
| 15003 | @cindex system root, alternate |
| 15004 | @kindex set solib-absolute-prefix |
| 15005 | @kindex set sysroot |
| 15006 | @item set sysroot @var{path} |
| 15007 | Use @var{path} as the system root for the program being debugged. Any |
| 15008 | absolute shared library paths will be prefixed with @var{path}; many |
| 15009 | runtime loaders store the absolute paths to the shared library in the |
| 15010 | target program's memory. If you use @code{set sysroot} to find shared |
| 15011 | libraries, they need to be laid out in the same way that they are on |
| 15012 | the target, with e.g.@: a @file{/lib} and @file{/usr/lib} hierarchy |
| 15013 | under @var{path}. |
| 15014 | |
| 15015 | If @var{path} starts with the sequence @file{remote:}, @value{GDBN} will |
| 15016 | retrieve the target libraries from the remote system. This is only |
| 15017 | supported when using a remote target that supports the @code{remote get} |
| 15018 | command (@pxref{File Transfer,,Sending files to a remote system}). |
| 15019 | The part of @var{path} following the initial @file{remote:} |
| 15020 | (if present) is used as system root prefix on the remote file system. |
| 15021 | @footnote{If you want to specify a local system root using a directory |
| 15022 | that happens to be named @file{remote:}, you need to use some equivalent |
| 15023 | variant of the name like @file{./remote:}.} |
| 15024 | |
| 15025 | For targets with an MS-DOS based filesystem, such as MS-Windows and |
| 15026 | SymbianOS, @value{GDBN} tries prefixing a few variants of the target |
| 15027 | absolute file name with @var{path}. But first, on Unix hosts, |
| 15028 | @value{GDBN} converts all backslash directory separators into forward |
| 15029 | slashes, because the backslash is not a directory separator on Unix: |
| 15030 | |
| 15031 | @smallexample |
| 15032 | c:\foo\bar.dll @result{} c:/foo/bar.dll |
| 15033 | @end smallexample |
| 15034 | |
| 15035 | Then, @value{GDBN} attempts prefixing the target file name with |
| 15036 | @var{path}, and looks for the resulting file name in the host file |
| 15037 | system: |
| 15038 | |
| 15039 | @smallexample |
| 15040 | c:/foo/bar.dll @result{} /path/to/sysroot/c:/foo/bar.dll |
| 15041 | @end smallexample |
| 15042 | |
| 15043 | If that does not find the shared library, @value{GDBN} tries removing |
| 15044 | the @samp{:} character from the drive spec, both for convenience, and, |
| 15045 | for the case of the host file system not supporting file names with |
| 15046 | colons: |
| 15047 | |
| 15048 | @smallexample |
| 15049 | c:/foo/bar.dll @result{} /path/to/sysroot/c/foo/bar.dll |
| 15050 | @end smallexample |
| 15051 | |
| 15052 | This makes it possible to have a system root that mirrors a target |
| 15053 | with more than one drive. E.g., you may want to setup your local |
| 15054 | copies of the target system shared libraries like so (note @samp{c} vs |
| 15055 | @samp{z}): |
| 15056 | |
| 15057 | @smallexample |
| 15058 | @file{/path/to/sysroot/c/sys/bin/foo.dll} |
| 15059 | @file{/path/to/sysroot/c/sys/bin/bar.dll} |
| 15060 | @file{/path/to/sysroot/z/sys/bin/bar.dll} |
| 15061 | @end smallexample |
| 15062 | |
| 15063 | @noindent |
| 15064 | and point the system root at @file{/path/to/sysroot}, so that |
| 15065 | @value{GDBN} can find the correct copies of both |
| 15066 | @file{c:\sys\bin\foo.dll}, and @file{z:\sys\bin\bar.dll}. |
| 15067 | |
| 15068 | If that still does not find the shared library, @value{GDBN} tries |
| 15069 | removing the whole drive spec from the target file name: |
| 15070 | |
| 15071 | @smallexample |
| 15072 | c:/foo/bar.dll @result{} /path/to/sysroot/foo/bar.dll |
| 15073 | @end smallexample |
| 15074 | |
| 15075 | This last lookup makes it possible to not care about the drive name, |
| 15076 | if you don't want or need to. |
| 15077 | |
| 15078 | The @code{set solib-absolute-prefix} command is an alias for @code{set |
| 15079 | sysroot}. |
| 15080 | |
| 15081 | @cindex default system root |
| 15082 | @cindex @samp{--with-sysroot} |
| 15083 | You can set the default system root by using the configure-time |
| 15084 | @samp{--with-sysroot} option. If the system root is inside |
| 15085 | @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or |
| 15086 | @samp{--exec-prefix}), then the default system root will be updated |
| 15087 | automatically if the installed @value{GDBN} is moved to a new |
| 15088 | location. |
| 15089 | |
| 15090 | @kindex show sysroot |
| 15091 | @item show sysroot |
| 15092 | Display the current shared library prefix. |
| 15093 | |
| 15094 | @kindex set solib-search-path |
| 15095 | @item set solib-search-path @var{path} |
| 15096 | If this variable is set, @var{path} is a colon-separated list of |
| 15097 | directories to search for shared libraries. @samp{solib-search-path} |
| 15098 | is used after @samp{sysroot} fails to locate the library, or if the |
| 15099 | path to the library is relative instead of absolute. If you want to |
| 15100 | use @samp{solib-search-path} instead of @samp{sysroot}, be sure to set |
| 15101 | @samp{sysroot} to a nonexistent directory to prevent @value{GDBN} from |
| 15102 | finding your host's libraries. @samp{sysroot} is preferred; setting |
| 15103 | it to a nonexistent directory may interfere with automatic loading |
| 15104 | of shared library symbols. |
| 15105 | |
| 15106 | @kindex show solib-search-path |
| 15107 | @item show solib-search-path |
| 15108 | Display the current shared library search path. |
| 15109 | |
| 15110 | @cindex DOS file-name semantics of file names. |
| 15111 | @kindex set target-file-system-kind (unix|dos-based|auto) |
| 15112 | @kindex show target-file-system-kind |
| 15113 | @item set target-file-system-kind @var{kind} |
| 15114 | Set assumed file system kind for target reported file names. |
| 15115 | |
| 15116 | Shared library file names as reported by the target system may not |
| 15117 | make sense as is on the system @value{GDBN} is running on. For |
| 15118 | example, when remote debugging a target that has MS-DOS based file |
| 15119 | system semantics, from a Unix host, the target may be reporting to |
| 15120 | @value{GDBN} a list of loaded shared libraries with file names such as |
| 15121 | @file{c:\Windows\kernel32.dll}. On Unix hosts, there's no concept of |
| 15122 | drive letters, so the @samp{c:\} prefix is not normally understood as |
| 15123 | indicating an absolute file name, and neither is the backslash |
| 15124 | normally considered a directory separator character. In that case, |
| 15125 | the native file system would interpret this whole absolute file name |
| 15126 | as a relative file name with no directory components. This would make |
| 15127 | it impossible to point @value{GDBN} at a copy of the remote target's |
| 15128 | shared libraries on the host using @code{set sysroot}, and impractical |
| 15129 | with @code{set solib-search-path}. Setting |
| 15130 | @code{target-file-system-kind} to @code{dos-based} tells @value{GDBN} |
| 15131 | to interpret such file names similarly to how the target would, and to |
| 15132 | map them to file names valid on @value{GDBN}'s native file system |
| 15133 | semantics. The value of @var{kind} can be @code{"auto"}, in addition |
| 15134 | to one of the supported file system kinds. In that case, @value{GDBN} |
| 15135 | tries to determine the appropriate file system variant based on the |
| 15136 | current target's operating system (@pxref{ABI, ,Configuring the |
| 15137 | Current ABI}). The supported file system settings are: |
| 15138 | |
| 15139 | @table @code |
| 15140 | @item unix |
| 15141 | Instruct @value{GDBN} to assume the target file system is of Unix |
| 15142 | kind. Only file names starting the forward slash (@samp{/}) character |
| 15143 | are considered absolute, and the directory separator character is also |
| 15144 | the forward slash. |
| 15145 | |
| 15146 | @item dos-based |
| 15147 | Instruct @value{GDBN} to assume the target file system is DOS based. |
| 15148 | File names starting with either a forward slash, or a drive letter |
| 15149 | followed by a colon (e.g., @samp{c:}), are considered absolute, and |
| 15150 | both the slash (@samp{/}) and the backslash (@samp{\\}) characters are |
| 15151 | considered directory separators. |
| 15152 | |
| 15153 | @item auto |
| 15154 | Instruct @value{GDBN} to use the file system kind associated with the |
| 15155 | target operating system (@pxref{ABI, ,Configuring the Current ABI}). |
| 15156 | This is the default. |
| 15157 | @end table |
| 15158 | @end table |
| 15159 | |
| 15160 | |
| 15161 | @node Separate Debug Files |
| 15162 | @section Debugging Information in Separate Files |
| 15163 | @cindex separate debugging information files |
| 15164 | @cindex debugging information in separate files |
| 15165 | @cindex @file{.debug} subdirectories |
| 15166 | @cindex debugging information directory, global |
| 15167 | @cindex global debugging information directory |
| 15168 | @cindex build ID, and separate debugging files |
| 15169 | @cindex @file{.build-id} directory |
| 15170 | |
| 15171 | @value{GDBN} allows you to put a program's debugging information in a |
| 15172 | file separate from the executable itself, in a way that allows |
| 15173 | @value{GDBN} to find and load the debugging information automatically. |
| 15174 | Since debugging information can be very large---sometimes larger |
| 15175 | than the executable code itself---some systems distribute debugging |
| 15176 | information for their executables in separate files, which users can |
| 15177 | install only when they need to debug a problem. |
| 15178 | |
| 15179 | @value{GDBN} supports two ways of specifying the separate debug info |
| 15180 | file: |
| 15181 | |
| 15182 | @itemize @bullet |
| 15183 | @item |
| 15184 | The executable contains a @dfn{debug link} that specifies the name of |
| 15185 | the separate debug info file. The separate debug file's name is |
| 15186 | usually @file{@var{executable}.debug}, where @var{executable} is the |
| 15187 | name of the corresponding executable file without leading directories |
| 15188 | (e.g., @file{ls.debug} for @file{/usr/bin/ls}). In addition, the |
| 15189 | debug link specifies a 32-bit @dfn{Cyclic Redundancy Check} (CRC) |
| 15190 | checksum for the debug file, which @value{GDBN} uses to validate that |
| 15191 | the executable and the debug file came from the same build. |
| 15192 | |
| 15193 | @item |
| 15194 | The executable contains a @dfn{build ID}, a unique bit string that is |
| 15195 | also present in the corresponding debug info file. (This is supported |
| 15196 | only on some operating systems, notably those which use the ELF format |
| 15197 | for binary files and the @sc{gnu} Binutils.) For more details about |
| 15198 | this feature, see the description of the @option{--build-id} |
| 15199 | command-line option in @ref{Options, , Command Line Options, ld.info, |
| 15200 | The GNU Linker}. The debug info file's name is not specified |
| 15201 | explicitly by the build ID, but can be computed from the build ID, see |
| 15202 | below. |
| 15203 | @end itemize |
| 15204 | |
| 15205 | Depending on the way the debug info file is specified, @value{GDBN} |
| 15206 | uses two different methods of looking for the debug file: |
| 15207 | |
| 15208 | @itemize @bullet |
| 15209 | @item |
| 15210 | For the ``debug link'' method, @value{GDBN} looks up the named file in |
| 15211 | the directory of the executable file, then in a subdirectory of that |
| 15212 | directory named @file{.debug}, and finally under the global debug |
| 15213 | directory, in a subdirectory whose name is identical to the leading |
| 15214 | directories of the executable's absolute file name. |
| 15215 | |
| 15216 | @item |
| 15217 | For the ``build ID'' method, @value{GDBN} looks in the |
| 15218 | @file{.build-id} subdirectory of the global debug directory for a file |
| 15219 | named @file{@var{nn}/@var{nnnnnnnn}.debug}, where @var{nn} are the |
| 15220 | first 2 hex characters of the build ID bit string, and @var{nnnnnnnn} |
| 15221 | are the rest of the bit string. (Real build ID strings are 32 or more |
| 15222 | hex characters, not 10.) |
| 15223 | @end itemize |
| 15224 | |
| 15225 | So, for example, suppose you ask @value{GDBN} to debug |
| 15226 | @file{/usr/bin/ls}, which has a debug link that specifies the |
| 15227 | file @file{ls.debug}, and a build ID whose value in hex is |
| 15228 | @code{abcdef1234}. If the global debug directory is |
| 15229 | @file{/usr/lib/debug}, then @value{GDBN} will look for the following |
| 15230 | debug information files, in the indicated order: |
| 15231 | |
| 15232 | @itemize @minus |
| 15233 | @item |
| 15234 | @file{/usr/lib/debug/.build-id/ab/cdef1234.debug} |
| 15235 | @item |
| 15236 | @file{/usr/bin/ls.debug} |
| 15237 | @item |
| 15238 | @file{/usr/bin/.debug/ls.debug} |
| 15239 | @item |
| 15240 | @file{/usr/lib/debug/usr/bin/ls.debug}. |
| 15241 | @end itemize |
| 15242 | |
| 15243 | You can set the global debugging info directory's name, and view the |
| 15244 | name @value{GDBN} is currently using. |
| 15245 | |
| 15246 | @table @code |
| 15247 | |
| 15248 | @kindex set debug-file-directory |
| 15249 | @item set debug-file-directory @var{directories} |
| 15250 | Set the directories which @value{GDBN} searches for separate debugging |
| 15251 | information files to @var{directory}. Multiple directory components can be set |
| 15252 | concatenating them by a directory separator. |
| 15253 | |
| 15254 | @kindex show debug-file-directory |
| 15255 | @item show debug-file-directory |
| 15256 | Show the directories @value{GDBN} searches for separate debugging |
| 15257 | information files. |
| 15258 | |
| 15259 | @end table |
| 15260 | |
| 15261 | @cindex @code{.gnu_debuglink} sections |
| 15262 | @cindex debug link sections |
| 15263 | A debug link is a special section of the executable file named |
| 15264 | @code{.gnu_debuglink}. The section must contain: |
| 15265 | |
| 15266 | @itemize |
| 15267 | @item |
| 15268 | A filename, with any leading directory components removed, followed by |
| 15269 | a zero byte, |
| 15270 | @item |
| 15271 | zero to three bytes of padding, as needed to reach the next four-byte |
| 15272 | boundary within the section, and |
| 15273 | @item |
| 15274 | a four-byte CRC checksum, stored in the same endianness used for the |
| 15275 | executable file itself. The checksum is computed on the debugging |
| 15276 | information file's full contents by the function given below, passing |
| 15277 | zero as the @var{crc} argument. |
| 15278 | @end itemize |
| 15279 | |
| 15280 | Any executable file format can carry a debug link, as long as it can |
| 15281 | contain a section named @code{.gnu_debuglink} with the contents |
| 15282 | described above. |
| 15283 | |
| 15284 | @cindex @code{.note.gnu.build-id} sections |
| 15285 | @cindex build ID sections |
| 15286 | The build ID is a special section in the executable file (and in other |
| 15287 | ELF binary files that @value{GDBN} may consider). This section is |
| 15288 | often named @code{.note.gnu.build-id}, but that name is not mandatory. |
| 15289 | It contains unique identification for the built files---the ID remains |
| 15290 | the same across multiple builds of the same build tree. The default |
| 15291 | algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the |
| 15292 | content for the build ID string. The same section with an identical |
| 15293 | value is present in the original built binary with symbols, in its |
| 15294 | stripped variant, and in the separate debugging information file. |
| 15295 | |
| 15296 | The debugging information file itself should be an ordinary |
| 15297 | executable, containing a full set of linker symbols, sections, and |
| 15298 | debugging information. The sections of the debugging information file |
| 15299 | should have the same names, addresses, and sizes as the original file, |
| 15300 | but they need not contain any data---much like a @code{.bss} section |
| 15301 | in an ordinary executable. |
| 15302 | |
| 15303 | The @sc{gnu} binary utilities (Binutils) package includes the |
| 15304 | @samp{objcopy} utility that can produce |
| 15305 | the separated executable / debugging information file pairs using the |
| 15306 | following commands: |
| 15307 | |
| 15308 | @smallexample |
| 15309 | @kbd{objcopy --only-keep-debug foo foo.debug} |
| 15310 | @kbd{strip -g foo} |
| 15311 | @end smallexample |
| 15312 | |
| 15313 | @noindent |
| 15314 | These commands remove the debugging |
| 15315 | information from the executable file @file{foo} and place it in the file |
| 15316 | @file{foo.debug}. You can use the first, second or both methods to link the |
| 15317 | two files: |
| 15318 | |
| 15319 | @itemize @bullet |
| 15320 | @item |
| 15321 | The debug link method needs the following additional command to also leave |
| 15322 | behind a debug link in @file{foo}: |
| 15323 | |
| 15324 | @smallexample |
| 15325 | @kbd{objcopy --add-gnu-debuglink=foo.debug foo} |
| 15326 | @end smallexample |
| 15327 | |
| 15328 | Ulrich Drepper's @file{elfutils} package, starting with version 0.53, contains |
| 15329 | a version of the @code{strip} command such that the command @kbd{strip foo -f |
| 15330 | foo.debug} has the same functionality as the two @code{objcopy} commands and |
| 15331 | the @code{ln -s} command above, together. |
| 15332 | |
| 15333 | @item |
| 15334 | Build ID gets embedded into the main executable using @code{ld --build-id} or |
| 15335 | the @value{NGCC} counterpart @code{gcc -Wl,--build-id}. Build ID support plus |
| 15336 | compatibility fixes for debug files separation are present in @sc{gnu} binary |
| 15337 | utilities (Binutils) package since version 2.18. |
| 15338 | @end itemize |
| 15339 | |
| 15340 | @noindent |
| 15341 | |
| 15342 | @cindex CRC algorithm definition |
| 15343 | The CRC used in @code{.gnu_debuglink} is the CRC-32 defined in |
| 15344 | IEEE 802.3 using the polynomial: |
| 15345 | |
| 15346 | @c TexInfo requires naked braces for multi-digit exponents for Tex |
| 15347 | @c output, but this causes HTML output to barf. HTML has to be set using |
| 15348 | @c raw commands. So we end up having to specify this equation in 2 |
| 15349 | @c different ways! |
| 15350 | @ifhtml |
| 15351 | @display |
| 15352 | @html |
| 15353 | <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> |
| 15354 | + <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 |
| 15355 | @end html |
| 15356 | @end display |
| 15357 | @end ifhtml |
| 15358 | @ifnothtml |
| 15359 | @display |
| 15360 | @math{x^{32} + x^{26} + x^{23} + x^{22} + x^{16} + x^{12} + x^{11}} |
| 15361 | @math{+ x^{10} + x^8 + x^7 + x^5 + x^4 + x^2 + x + 1} |
| 15362 | @end display |
| 15363 | @end ifnothtml |
| 15364 | |
| 15365 | The function is computed byte at a time, taking the least |
| 15366 | significant bit of each byte first. The initial pattern |
| 15367 | @code{0xffffffff} is used, to ensure leading zeros affect the CRC and |
| 15368 | the final result is inverted to ensure trailing zeros also affect the |
| 15369 | CRC. |
| 15370 | |
| 15371 | @emph{Note:} This is the same CRC polynomial as used in handling the |
| 15372 | @dfn{Remote Serial Protocol} @code{qCRC} packet (@pxref{Remote Protocol, |
| 15373 | , @value{GDBN} Remote Serial Protocol}). However in the |
| 15374 | case of the Remote Serial Protocol, the CRC is computed @emph{most} |
| 15375 | significant bit first, and the result is not inverted, so trailing |
| 15376 | zeros have no effect on the CRC value. |
| 15377 | |
| 15378 | To complete the description, we show below the code of the function |
| 15379 | which produces the CRC used in @code{.gnu_debuglink}. Inverting the |
| 15380 | initially supplied @code{crc} argument means that an initial call to |
| 15381 | this function passing in zero will start computing the CRC using |
| 15382 | @code{0xffffffff}. |
| 15383 | |
| 15384 | @kindex gnu_debuglink_crc32 |
| 15385 | @smallexample |
| 15386 | unsigned long |
| 15387 | gnu_debuglink_crc32 (unsigned long crc, |
| 15388 | unsigned char *buf, size_t len) |
| 15389 | @{ |
| 15390 | static const unsigned long crc32_table[256] = |
| 15391 | @{ |
| 15392 | 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, |
| 15393 | 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, |
| 15394 | 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, |
| 15395 | 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, |
| 15396 | 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856, |
| 15397 | 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, |
| 15398 | 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, |
| 15399 | 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, |
| 15400 | 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, |
| 15401 | 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a, |
| 15402 | 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, |
| 15403 | 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, |
| 15404 | 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, |
| 15405 | 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, |
| 15406 | 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e, |
| 15407 | 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, |
| 15408 | 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, |
| 15409 | 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950, |
| 15410 | 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, |
| 15411 | 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, |
| 15412 | 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, |
| 15413 | 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, |
| 15414 | 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010, |
| 15415 | 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, |
| 15416 | 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, |
| 15417 | 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, |
| 15418 | 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, |
| 15419 | 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, |
| 15420 | 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344, |
| 15421 | 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, |
| 15422 | 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, |
| 15423 | 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, |
| 15424 | 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, |
| 15425 | 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c, |
| 15426 | 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, |
| 15427 | 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, |
| 15428 | 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, |
| 15429 | 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, |
| 15430 | 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c, |
| 15431 | 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, |
| 15432 | 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, |
| 15433 | 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242, |
| 15434 | 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, |
| 15435 | 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, |
| 15436 | 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278, |
| 15437 | 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, |
| 15438 | 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66, |
| 15439 | 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, |
| 15440 | 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, |
| 15441 | 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, |
| 15442 | 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, |
| 15443 | 0x2d02ef8d |
| 15444 | @}; |
| 15445 | unsigned char *end; |
| 15446 | |
| 15447 | crc = ~crc & 0xffffffff; |
| 15448 | for (end = buf + len; buf < end; ++buf) |
| 15449 | crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8); |
| 15450 | return ~crc & 0xffffffff; |
| 15451 | @} |
| 15452 | @end smallexample |
| 15453 | |
| 15454 | @noindent |
| 15455 | This computation does not apply to the ``build ID'' method. |
| 15456 | |
| 15457 | |
| 15458 | @node Index Files |
| 15459 | @section Index Files Speed Up @value{GDBN} |
| 15460 | @cindex index files |
| 15461 | @cindex @samp{.gdb_index} section |
| 15462 | |
| 15463 | When @value{GDBN} finds a symbol file, it scans the symbols in the |
| 15464 | file in order to construct an internal symbol table. This lets most |
| 15465 | @value{GDBN} operations work quickly---at the cost of a delay early |
| 15466 | on. For large programs, this delay can be quite lengthy, so |
| 15467 | @value{GDBN} provides a way to build an index, which speeds up |
| 15468 | startup. |
| 15469 | |
| 15470 | The index is stored as a section in the symbol file. @value{GDBN} can |
| 15471 | write the index to a file, then you can put it into the symbol file |
| 15472 | using @command{objcopy}. |
| 15473 | |
| 15474 | To create an index file, use the @code{save gdb-index} command: |
| 15475 | |
| 15476 | @table @code |
| 15477 | @item save gdb-index @var{directory} |
| 15478 | @kindex save gdb-index |
| 15479 | Create an index file for each symbol file currently known by |
| 15480 | @value{GDBN}. Each file is named after its corresponding symbol file, |
| 15481 | with @samp{.gdb-index} appended, and is written into the given |
| 15482 | @var{directory}. |
| 15483 | @end table |
| 15484 | |
| 15485 | Once you have created an index file you can merge it into your symbol |
| 15486 | file, here named @file{symfile}, using @command{objcopy}: |
| 15487 | |
| 15488 | @smallexample |
| 15489 | $ objcopy --add-section .gdb_index=symfile.gdb-index \ |
| 15490 | --set-section-flags .gdb_index=readonly symfile symfile |
| 15491 | @end smallexample |
| 15492 | |
| 15493 | There are currently some limitation on indices. They only work when |
| 15494 | for DWARF debugging information, not stabs. And, they do not |
| 15495 | currently work for programs using Ada. |
| 15496 | |
| 15497 | @node Symbol Errors |
| 15498 | @section Errors Reading Symbol Files |
| 15499 | |
| 15500 | While reading a symbol file, @value{GDBN} occasionally encounters problems, |
| 15501 | such as symbol types it does not recognize, or known bugs in compiler |
| 15502 | output. By default, @value{GDBN} does not notify you of such problems, since |
| 15503 | they are relatively common and primarily of interest to people |
| 15504 | debugging compilers. If you are interested in seeing information |
| 15505 | about ill-constructed symbol tables, you can either ask @value{GDBN} to print |
| 15506 | only one message about each such type of problem, no matter how many |
| 15507 | times the problem occurs; or you can ask @value{GDBN} to print more messages, |
| 15508 | to see how many times the problems occur, with the @code{set |
| 15509 | complaints} command (@pxref{Messages/Warnings, ,Optional Warnings and |
| 15510 | Messages}). |
| 15511 | |
| 15512 | The messages currently printed, and their meanings, include: |
| 15513 | |
| 15514 | @table @code |
| 15515 | @item inner block not inside outer block in @var{symbol} |
| 15516 | |
| 15517 | The symbol information shows where symbol scopes begin and end |
| 15518 | (such as at the start of a function or a block of statements). This |
| 15519 | error indicates that an inner scope block is not fully contained |
| 15520 | in its outer scope blocks. |
| 15521 | |
| 15522 | @value{GDBN} circumvents the problem by treating the inner block as if it had |
| 15523 | the same scope as the outer block. In the error message, @var{symbol} |
| 15524 | may be shown as ``@code{(don't know)}'' if the outer block is not a |
| 15525 | function. |
| 15526 | |
| 15527 | @item block at @var{address} out of order |
| 15528 | |
| 15529 | The symbol information for symbol scope blocks should occur in |
| 15530 | order of increasing addresses. This error indicates that it does not |
| 15531 | do so. |
| 15532 | |
| 15533 | @value{GDBN} does not circumvent this problem, and has trouble |
| 15534 | locating symbols in the source file whose symbols it is reading. (You |
| 15535 | can often determine what source file is affected by specifying |
| 15536 | @code{set verbose on}. @xref{Messages/Warnings, ,Optional Warnings and |
| 15537 | Messages}.) |
| 15538 | |
| 15539 | @item bad block start address patched |
| 15540 | |
| 15541 | The symbol information for a symbol scope block has a start address |
| 15542 | smaller than the address of the preceding source line. This is known |
| 15543 | to occur in the SunOS 4.1.1 (and earlier) C compiler. |
| 15544 | |
| 15545 | @value{GDBN} circumvents the problem by treating the symbol scope block as |
| 15546 | starting on the previous source line. |
| 15547 | |
| 15548 | @item bad string table offset in symbol @var{n} |
| 15549 | |
| 15550 | @cindex foo |
| 15551 | Symbol number @var{n} contains a pointer into the string table which is |
| 15552 | larger than the size of the string table. |
| 15553 | |
| 15554 | @value{GDBN} circumvents the problem by considering the symbol to have the |
| 15555 | name @code{foo}, which may cause other problems if many symbols end up |
| 15556 | with this name. |
| 15557 | |
| 15558 | @item unknown symbol type @code{0x@var{nn}} |
| 15559 | |
| 15560 | The symbol information contains new data types that @value{GDBN} does |
| 15561 | not yet know how to read. @code{0x@var{nn}} is the symbol type of the |
| 15562 | uncomprehended information, in hexadecimal. |
| 15563 | |
| 15564 | @value{GDBN} circumvents the error by ignoring this symbol information. |
| 15565 | This usually allows you to debug your program, though certain symbols |
| 15566 | are not accessible. If you encounter such a problem and feel like |
| 15567 | debugging it, you can debug @code{@value{GDBP}} with itself, breakpoint |
| 15568 | on @code{complain}, then go up to the function @code{read_dbx_symtab} |
| 15569 | and examine @code{*bufp} to see the symbol. |
| 15570 | |
| 15571 | @item stub type has NULL name |
| 15572 | |
| 15573 | @value{GDBN} could not find the full definition for a struct or class. |
| 15574 | |
| 15575 | @item const/volatile indicator missing (ok if using g++ v1.x), got@dots{} |
| 15576 | The symbol information for a C@t{++} member function is missing some |
| 15577 | information that recent versions of the compiler should have output for |
| 15578 | it. |
| 15579 | |
| 15580 | @item info mismatch between compiler and debugger |
| 15581 | |
| 15582 | @value{GDBN} could not parse a type specification output by the compiler. |
| 15583 | |
| 15584 | @end table |
| 15585 | |
| 15586 | @node Data Files |
| 15587 | @section GDB Data Files |
| 15588 | |
| 15589 | @cindex prefix for data files |
| 15590 | @value{GDBN} will sometimes read an auxiliary data file. These files |
| 15591 | are kept in a directory known as the @dfn{data directory}. |
| 15592 | |
| 15593 | You can set the data directory's name, and view the name @value{GDBN} |
| 15594 | is currently using. |
| 15595 | |
| 15596 | @table @code |
| 15597 | @kindex set data-directory |
| 15598 | @item set data-directory @var{directory} |
| 15599 | Set the directory which @value{GDBN} searches for auxiliary data files |
| 15600 | to @var{directory}. |
| 15601 | |
| 15602 | @kindex show data-directory |
| 15603 | @item show data-directory |
| 15604 | Show the directory @value{GDBN} searches for auxiliary data files. |
| 15605 | @end table |
| 15606 | |
| 15607 | @cindex default data directory |
| 15608 | @cindex @samp{--with-gdb-datadir} |
| 15609 | You can set the default data directory by using the configure-time |
| 15610 | @samp{--with-gdb-datadir} option. If the data directory is inside |
| 15611 | @value{GDBN}'s configured binary prefix (set with @samp{--prefix} or |
| 15612 | @samp{--exec-prefix}), then the default data directory will be updated |
| 15613 | automatically if the installed @value{GDBN} is moved to a new |
| 15614 | location. |
| 15615 | |
| 15616 | The data directory may also be specified with the |
| 15617 | @code{--data-directory} command line option. |
| 15618 | @xref{Mode Options}. |
| 15619 | |
| 15620 | @node Targets |
| 15621 | @chapter Specifying a Debugging Target |
| 15622 | |
| 15623 | @cindex debugging target |
| 15624 | A @dfn{target} is the execution environment occupied by your program. |
| 15625 | |
| 15626 | Often, @value{GDBN} runs in the same host environment as your program; |
| 15627 | in that case, the debugging target is specified as a side effect when |
| 15628 | you use the @code{file} or @code{core} commands. When you need more |
| 15629 | flexibility---for example, running @value{GDBN} on a physically separate |
| 15630 | host, or controlling a standalone system over a serial port or a |
| 15631 | realtime system over a TCP/IP connection---you can use the @code{target} |
| 15632 | command to specify one of the target types configured for @value{GDBN} |
| 15633 | (@pxref{Target Commands, ,Commands for Managing Targets}). |
| 15634 | |
| 15635 | @cindex target architecture |
| 15636 | It is possible to build @value{GDBN} for several different @dfn{target |
| 15637 | architectures}. When @value{GDBN} is built like that, you can choose |
| 15638 | one of the available architectures with the @kbd{set architecture} |
| 15639 | command. |
| 15640 | |
| 15641 | @table @code |
| 15642 | @kindex set architecture |
| 15643 | @kindex show architecture |
| 15644 | @item set architecture @var{arch} |
| 15645 | This command sets the current target architecture to @var{arch}. The |
| 15646 | value of @var{arch} can be @code{"auto"}, in addition to one of the |
| 15647 | supported architectures. |
| 15648 | |
| 15649 | @item show architecture |
| 15650 | Show the current target architecture. |
| 15651 | |
| 15652 | @item set processor |
| 15653 | @itemx processor |
| 15654 | @kindex set processor |
| 15655 | @kindex show processor |
| 15656 | These are alias commands for, respectively, @code{set architecture} |
| 15657 | and @code{show architecture}. |
| 15658 | @end table |
| 15659 | |
| 15660 | @menu |
| 15661 | * Active Targets:: Active targets |
| 15662 | * Target Commands:: Commands for managing targets |
| 15663 | * Byte Order:: Choosing target byte order |
| 15664 | @end menu |
| 15665 | |
| 15666 | @node Active Targets |
| 15667 | @section Active Targets |
| 15668 | |
| 15669 | @cindex stacking targets |
| 15670 | @cindex active targets |
| 15671 | @cindex multiple targets |
| 15672 | |
| 15673 | There are multiple classes of targets such as: processes, executable files or |
| 15674 | recording sessions. Core files belong to the process class, making core file |
| 15675 | and process mutually exclusive. Otherwise, @value{GDBN} can work concurrently |
| 15676 | on multiple active targets, one in each class. This allows you to (for |
| 15677 | example) start a process and inspect its activity, while still having access to |
| 15678 | the executable file after the process finishes. Or if you start process |
| 15679 | recording (@pxref{Reverse Execution}) and @code{reverse-step} there, you are |
| 15680 | presented a virtual layer of the recording target, while the process target |
| 15681 | remains stopped at the chronologically last point of the process execution. |
| 15682 | |
| 15683 | Use the @code{core-file} and @code{exec-file} commands to select a new core |
| 15684 | file or executable target (@pxref{Files, ,Commands to Specify Files}). To |
| 15685 | specify as a target a process that is already running, use the @code{attach} |
| 15686 | command (@pxref{Attach, ,Debugging an Already-running Process}). |
| 15687 | |
| 15688 | @node Target Commands |
| 15689 | @section Commands for Managing Targets |
| 15690 | |
| 15691 | @table @code |
| 15692 | @item target @var{type} @var{parameters} |
| 15693 | Connects the @value{GDBN} host environment to a target machine or |
| 15694 | process. A target is typically a protocol for talking to debugging |
| 15695 | facilities. You use the argument @var{type} to specify the type or |
| 15696 | protocol of the target machine. |
| 15697 | |
| 15698 | Further @var{parameters} are interpreted by the target protocol, but |
| 15699 | typically include things like device names or host names to connect |
| 15700 | with, process numbers, and baud rates. |
| 15701 | |
| 15702 | The @code{target} command does not repeat if you press @key{RET} again |
| 15703 | after executing the command. |
| 15704 | |
| 15705 | @kindex help target |
| 15706 | @item help target |
| 15707 | Displays the names of all targets available. To display targets |
| 15708 | currently selected, use either @code{info target} or @code{info files} |
| 15709 | (@pxref{Files, ,Commands to Specify Files}). |
| 15710 | |
| 15711 | @item help target @var{name} |
| 15712 | Describe a particular target, including any parameters necessary to |
| 15713 | select it. |
| 15714 | |
| 15715 | @kindex set gnutarget |
| 15716 | @item set gnutarget @var{args} |
| 15717 | @value{GDBN} uses its own library BFD to read your files. @value{GDBN} |
| 15718 | knows whether it is reading an @dfn{executable}, |
| 15719 | a @dfn{core}, or a @dfn{.o} file; however, you can specify the file format |
| 15720 | with the @code{set gnutarget} command. Unlike most @code{target} commands, |
| 15721 | with @code{gnutarget} the @code{target} refers to a program, not a machine. |
| 15722 | |
| 15723 | @quotation |
| 15724 | @emph{Warning:} To specify a file format with @code{set gnutarget}, |
| 15725 | you must know the actual BFD name. |
| 15726 | @end quotation |
| 15727 | |
| 15728 | @noindent |
| 15729 | @xref{Files, , Commands to Specify Files}. |
| 15730 | |
| 15731 | @kindex show gnutarget |
| 15732 | @item show gnutarget |
| 15733 | Use the @code{show gnutarget} command to display what file format |
| 15734 | @code{gnutarget} is set to read. If you have not set @code{gnutarget}, |
| 15735 | @value{GDBN} will determine the file format for each file automatically, |
| 15736 | and @code{show gnutarget} displays @samp{The current BDF target is "auto"}. |
| 15737 | @end table |
| 15738 | |
| 15739 | @cindex common targets |
| 15740 | Here are some common targets (available, or not, depending on the GDB |
| 15741 | configuration): |
| 15742 | |
| 15743 | @table @code |
| 15744 | @kindex target |
| 15745 | @item target exec @var{program} |
| 15746 | @cindex executable file target |
| 15747 | An executable file. @samp{target exec @var{program}} is the same as |
| 15748 | @samp{exec-file @var{program}}. |
| 15749 | |
| 15750 | @item target core @var{filename} |
| 15751 | @cindex core dump file target |
| 15752 | A core dump file. @samp{target core @var{filename}} is the same as |
| 15753 | @samp{core-file @var{filename}}. |
| 15754 | |
| 15755 | @item target remote @var{medium} |
| 15756 | @cindex remote target |
| 15757 | A remote system connected to @value{GDBN} via a serial line or network |
| 15758 | connection. This command tells @value{GDBN} to use its own remote |
| 15759 | protocol over @var{medium} for debugging. @xref{Remote Debugging}. |
| 15760 | |
| 15761 | For example, if you have a board connected to @file{/dev/ttya} on the |
| 15762 | machine running @value{GDBN}, you could say: |
| 15763 | |
| 15764 | @smallexample |
| 15765 | target remote /dev/ttya |
| 15766 | @end smallexample |
| 15767 | |
| 15768 | @code{target remote} supports the @code{load} command. This is only |
| 15769 | useful if you have some other way of getting the stub to the target |
| 15770 | system, and you can put it somewhere in memory where it won't get |
| 15771 | clobbered by the download. |
| 15772 | |
| 15773 | @item target sim @r{[}@var{simargs}@r{]} @dots{} |
| 15774 | @cindex built-in simulator target |
| 15775 | Builtin CPU simulator. @value{GDBN} includes simulators for most architectures. |
| 15776 | In general, |
| 15777 | @smallexample |
| 15778 | target sim |
| 15779 | load |
| 15780 | run |
| 15781 | @end smallexample |
| 15782 | @noindent |
| 15783 | works; however, you cannot assume that a specific memory map, device |
| 15784 | drivers, or even basic I/O is available, although some simulators do |
| 15785 | provide these. For info about any processor-specific simulator details, |
| 15786 | see the appropriate section in @ref{Embedded Processors, ,Embedded |
| 15787 | Processors}. |
| 15788 | |
| 15789 | @end table |
| 15790 | |
| 15791 | Some configurations may include these targets as well: |
| 15792 | |
| 15793 | @table @code |
| 15794 | |
| 15795 | @item target nrom @var{dev} |
| 15796 | @cindex NetROM ROM emulator target |
| 15797 | NetROM ROM emulator. This target only supports downloading. |
| 15798 | |
| 15799 | @end table |
| 15800 | |
| 15801 | Different targets are available on different configurations of @value{GDBN}; |
| 15802 | your configuration may have more or fewer targets. |
| 15803 | |
| 15804 | Many remote targets require you to download the executable's code once |
| 15805 | you've successfully established a connection. You may wish to control |
| 15806 | various aspects of this process. |
| 15807 | |
| 15808 | @table @code |
| 15809 | |
| 15810 | @item set hash |
| 15811 | @kindex set hash@r{, for remote monitors} |
| 15812 | @cindex hash mark while downloading |
| 15813 | This command controls whether a hash mark @samp{#} is displayed while |
| 15814 | downloading a file to the remote monitor. If on, a hash mark is |
| 15815 | displayed after each S-record is successfully downloaded to the |
| 15816 | monitor. |
| 15817 | |
| 15818 | @item show hash |
| 15819 | @kindex show hash@r{, for remote monitors} |
| 15820 | Show the current status of displaying the hash mark. |
| 15821 | |
| 15822 | @item set debug monitor |
| 15823 | @kindex set debug monitor |
| 15824 | @cindex display remote monitor communications |
| 15825 | Enable or disable display of communications messages between |
| 15826 | @value{GDBN} and the remote monitor. |
| 15827 | |
| 15828 | @item show debug monitor |
| 15829 | @kindex show debug monitor |
| 15830 | Show the current status of displaying communications between |
| 15831 | @value{GDBN} and the remote monitor. |
| 15832 | @end table |
| 15833 | |
| 15834 | @table @code |
| 15835 | |
| 15836 | @kindex load @var{filename} |
| 15837 | @item load @var{filename} |
| 15838 | @anchor{load} |
| 15839 | Depending on what remote debugging facilities are configured into |
| 15840 | @value{GDBN}, the @code{load} command may be available. Where it exists, it |
| 15841 | is meant to make @var{filename} (an executable) available for debugging |
| 15842 | on the remote system---by downloading, or dynamic linking, for example. |
| 15843 | @code{load} also records the @var{filename} symbol table in @value{GDBN}, like |
| 15844 | the @code{add-symbol-file} command. |
| 15845 | |
| 15846 | If your @value{GDBN} does not have a @code{load} command, attempting to |
| 15847 | execute it gets the error message ``@code{You can't do that when your |
| 15848 | target is @dots{}}'' |
| 15849 | |
| 15850 | The file is loaded at whatever address is specified in the executable. |
| 15851 | For some object file formats, you can specify the load address when you |
| 15852 | link the program; for other formats, like a.out, the object file format |
| 15853 | specifies a fixed address. |
| 15854 | @c FIXME! This would be a good place for an xref to the GNU linker doc. |
| 15855 | |
| 15856 | Depending on the remote side capabilities, @value{GDBN} may be able to |
| 15857 | load programs into flash memory. |
| 15858 | |
| 15859 | @code{load} does not repeat if you press @key{RET} again after using it. |
| 15860 | @end table |
| 15861 | |
| 15862 | @node Byte Order |
| 15863 | @section Choosing Target Byte Order |
| 15864 | |
| 15865 | @cindex choosing target byte order |
| 15866 | @cindex target byte order |
| 15867 | |
| 15868 | Some types of processors, such as the MIPS, PowerPC, and Renesas SH, |
| 15869 | offer the ability to run either big-endian or little-endian byte |
| 15870 | orders. Usually the executable or symbol will include a bit to |
| 15871 | designate the endian-ness, and you will not need to worry about |
| 15872 | which to use. However, you may still find it useful to adjust |
| 15873 | @value{GDBN}'s idea of processor endian-ness manually. |
| 15874 | |
| 15875 | @table @code |
| 15876 | @kindex set endian |
| 15877 | @item set endian big |
| 15878 | Instruct @value{GDBN} to assume the target is big-endian. |
| 15879 | |
| 15880 | @item set endian little |
| 15881 | Instruct @value{GDBN} to assume the target is little-endian. |
| 15882 | |
| 15883 | @item set endian auto |
| 15884 | Instruct @value{GDBN} to use the byte order associated with the |
| 15885 | executable. |
| 15886 | |
| 15887 | @item show endian |
| 15888 | Display @value{GDBN}'s current idea of the target byte order. |
| 15889 | |
| 15890 | @end table |
| 15891 | |
| 15892 | Note that these commands merely adjust interpretation of symbolic |
| 15893 | data on the host, and that they have absolutely no effect on the |
| 15894 | target system. |
| 15895 | |
| 15896 | |
| 15897 | @node Remote Debugging |
| 15898 | @chapter Debugging Remote Programs |
| 15899 | @cindex remote debugging |
| 15900 | |
| 15901 | If you are trying to debug a program running on a machine that cannot run |
| 15902 | @value{GDBN} in the usual way, it is often useful to use remote debugging. |
| 15903 | For example, you might use remote debugging on an operating system kernel, |
| 15904 | or on a small system which does not have a general purpose operating system |
| 15905 | powerful enough to run a full-featured debugger. |
| 15906 | |
| 15907 | Some configurations of @value{GDBN} have special serial or TCP/IP interfaces |
| 15908 | to make this work with particular debugging targets. In addition, |
| 15909 | @value{GDBN} comes with a generic serial protocol (specific to @value{GDBN}, |
| 15910 | but not specific to any particular target system) which you can use if you |
| 15911 | write the remote stubs---the code that runs on the remote system to |
| 15912 | communicate with @value{GDBN}. |
| 15913 | |
| 15914 | Other remote targets may be available in your |
| 15915 | configuration of @value{GDBN}; use @code{help target} to list them. |
| 15916 | |
| 15917 | @menu |
| 15918 | * Connecting:: Connecting to a remote target |
| 15919 | * File Transfer:: Sending files to a remote system |
| 15920 | * Server:: Using the gdbserver program |
| 15921 | * Remote Configuration:: Remote configuration |
| 15922 | * Remote Stub:: Implementing a remote stub |
| 15923 | @end menu |
| 15924 | |
| 15925 | @node Connecting |
| 15926 | @section Connecting to a Remote Target |
| 15927 | |
| 15928 | On the @value{GDBN} host machine, you will need an unstripped copy of |
| 15929 | your program, since @value{GDBN} needs symbol and debugging information. |
| 15930 | Start up @value{GDBN} as usual, using the name of the local copy of your |
| 15931 | program as the first argument. |
| 15932 | |
| 15933 | @cindex @code{target remote} |
| 15934 | @value{GDBN} can communicate with the target over a serial line, or |
| 15935 | over an @acronym{IP} network using @acronym{TCP} or @acronym{UDP}. In |
| 15936 | each case, @value{GDBN} uses the same protocol for debugging your |
| 15937 | program; only the medium carrying the debugging packets varies. The |
| 15938 | @code{target remote} command establishes a connection to the target. |
| 15939 | Its arguments indicate which medium to use: |
| 15940 | |
| 15941 | @table @code |
| 15942 | |
| 15943 | @item target remote @var{serial-device} |
| 15944 | @cindex serial line, @code{target remote} |
| 15945 | Use @var{serial-device} to communicate with the target. For example, |
| 15946 | to use a serial line connected to the device named @file{/dev/ttyb}: |
| 15947 | |
| 15948 | @smallexample |
| 15949 | target remote /dev/ttyb |
| 15950 | @end smallexample |
| 15951 | |
| 15952 | If you're using a serial line, you may want to give @value{GDBN} the |
| 15953 | @w{@samp{--baud}} option, or use the @code{set remotebaud} command |
| 15954 | (@pxref{Remote Configuration, set remotebaud}) before the |
| 15955 | @code{target} command. |
| 15956 | |
| 15957 | @item target remote @code{@var{host}:@var{port}} |
| 15958 | @itemx target remote @code{tcp:@var{host}:@var{port}} |
| 15959 | @cindex @acronym{TCP} port, @code{target remote} |
| 15960 | Debug using a @acronym{TCP} connection to @var{port} on @var{host}. |
| 15961 | The @var{host} may be either a host name or a numeric @acronym{IP} |
| 15962 | address; @var{port} must be a decimal number. The @var{host} could be |
| 15963 | the target machine itself, if it is directly connected to the net, or |
| 15964 | it might be a terminal server which in turn has a serial line to the |
| 15965 | target. |
| 15966 | |
| 15967 | For example, to connect to port 2828 on a terminal server named |
| 15968 | @code{manyfarms}: |
| 15969 | |
| 15970 | @smallexample |
| 15971 | target remote manyfarms:2828 |
| 15972 | @end smallexample |
| 15973 | |
| 15974 | If your remote target is actually running on the same machine as your |
| 15975 | debugger session (e.g.@: a simulator for your target running on the |
| 15976 | same host), you can omit the hostname. For example, to connect to |
| 15977 | port 1234 on your local machine: |
| 15978 | |
| 15979 | @smallexample |
| 15980 | target remote :1234 |
| 15981 | @end smallexample |
| 15982 | @noindent |
| 15983 | |
| 15984 | Note that the colon is still required here. |
| 15985 | |
| 15986 | @item target remote @code{udp:@var{host}:@var{port}} |
| 15987 | @cindex @acronym{UDP} port, @code{target remote} |
| 15988 | Debug using @acronym{UDP} packets to @var{port} on @var{host}. For example, to |
| 15989 | connect to @acronym{UDP} port 2828 on a terminal server named @code{manyfarms}: |
| 15990 | |
| 15991 | @smallexample |
| 15992 | target remote udp:manyfarms:2828 |
| 15993 | @end smallexample |
| 15994 | |
| 15995 | When using a @acronym{UDP} connection for remote debugging, you should |
| 15996 | keep in mind that the `U' stands for ``Unreliable''. @acronym{UDP} |
| 15997 | can silently drop packets on busy or unreliable networks, which will |
| 15998 | cause havoc with your debugging session. |
| 15999 | |
| 16000 | @item target remote | @var{command} |
| 16001 | @cindex pipe, @code{target remote} to |
| 16002 | Run @var{command} in the background and communicate with it using a |
| 16003 | pipe. The @var{command} is a shell command, to be parsed and expanded |
| 16004 | by the system's command shell, @code{/bin/sh}; it should expect remote |
| 16005 | protocol packets on its standard input, and send replies on its |
| 16006 | standard output. You could use this to run a stand-alone simulator |
| 16007 | that speaks the remote debugging protocol, to make net connections |
| 16008 | using programs like @code{ssh}, or for other similar tricks. |
| 16009 | |
| 16010 | If @var{command} closes its standard output (perhaps by exiting), |
| 16011 | @value{GDBN} will try to send it a @code{SIGTERM} signal. (If the |
| 16012 | program has already exited, this will have no effect.) |
| 16013 | |
| 16014 | @end table |
| 16015 | |
| 16016 | Once the connection has been established, you can use all the usual |
| 16017 | commands to examine and change data. The remote program is already |
| 16018 | running; you can use @kbd{step} and @kbd{continue}, and you do not |
| 16019 | need to use @kbd{run}. |
| 16020 | |
| 16021 | @cindex interrupting remote programs |
| 16022 | @cindex remote programs, interrupting |
| 16023 | Whenever @value{GDBN} is waiting for the remote program, if you type the |
| 16024 | interrupt character (often @kbd{Ctrl-c}), @value{GDBN} attempts to stop the |
| 16025 | program. This may or may not succeed, depending in part on the hardware |
| 16026 | and the serial drivers the remote system uses. If you type the |
| 16027 | interrupt character once again, @value{GDBN} displays this prompt: |
| 16028 | |
| 16029 | @smallexample |
| 16030 | Interrupted while waiting for the program. |
| 16031 | Give up (and stop debugging it)? (y or n) |
| 16032 | @end smallexample |
| 16033 | |
| 16034 | If you type @kbd{y}, @value{GDBN} abandons the remote debugging session. |
| 16035 | (If you decide you want to try again later, you can use @samp{target |
| 16036 | remote} again to connect once more.) If you type @kbd{n}, @value{GDBN} |
| 16037 | goes back to waiting. |
| 16038 | |
| 16039 | @table @code |
| 16040 | @kindex detach (remote) |
| 16041 | @item detach |
| 16042 | When you have finished debugging the remote program, you can use the |
| 16043 | @code{detach} command to release it from @value{GDBN} control. |
| 16044 | Detaching from the target normally resumes its execution, but the results |
| 16045 | will depend on your particular remote stub. After the @code{detach} |
| 16046 | command, @value{GDBN} is free to connect to another target. |
| 16047 | |
| 16048 | @kindex disconnect |
| 16049 | @item disconnect |
| 16050 | The @code{disconnect} command behaves like @code{detach}, except that |
| 16051 | the target is generally not resumed. It will wait for @value{GDBN} |
| 16052 | (this instance or another one) to connect and continue debugging. After |
| 16053 | the @code{disconnect} command, @value{GDBN} is again free to connect to |
| 16054 | another target. |
| 16055 | |
| 16056 | @cindex send command to remote monitor |
| 16057 | @cindex extend @value{GDBN} for remote targets |
| 16058 | @cindex add new commands for external monitor |
| 16059 | @kindex monitor |
| 16060 | @item monitor @var{cmd} |
| 16061 | This command allows you to send arbitrary commands directly to the |
| 16062 | remote monitor. Since @value{GDBN} doesn't care about the commands it |
| 16063 | sends like this, this command is the way to extend @value{GDBN}---you |
| 16064 | can add new commands that only the external monitor will understand |
| 16065 | and implement. |
| 16066 | @end table |
| 16067 | |
| 16068 | @node File Transfer |
| 16069 | @section Sending files to a remote system |
| 16070 | @cindex remote target, file transfer |
| 16071 | @cindex file transfer |
| 16072 | @cindex sending files to remote systems |
| 16073 | |
| 16074 | Some remote targets offer the ability to transfer files over the same |
| 16075 | connection used to communicate with @value{GDBN}. This is convenient |
| 16076 | for targets accessible through other means, e.g.@: @sc{gnu}/Linux systems |
| 16077 | running @code{gdbserver} over a network interface. For other targets, |
| 16078 | e.g.@: embedded devices with only a single serial port, this may be |
| 16079 | the only way to upload or download files. |
| 16080 | |
| 16081 | Not all remote targets support these commands. |
| 16082 | |
| 16083 | @table @code |
| 16084 | @kindex remote put |
| 16085 | @item remote put @var{hostfile} @var{targetfile} |
| 16086 | Copy file @var{hostfile} from the host system (the machine running |
| 16087 | @value{GDBN}) to @var{targetfile} on the target system. |
| 16088 | |
| 16089 | @kindex remote get |
| 16090 | @item remote get @var{targetfile} @var{hostfile} |
| 16091 | Copy file @var{targetfile} from the target system to @var{hostfile} |
| 16092 | on the host system. |
| 16093 | |
| 16094 | @kindex remote delete |
| 16095 | @item remote delete @var{targetfile} |
| 16096 | Delete @var{targetfile} from the target system. |
| 16097 | |
| 16098 | @end table |
| 16099 | |
| 16100 | @node Server |
| 16101 | @section Using the @code{gdbserver} Program |
| 16102 | |
| 16103 | @kindex gdbserver |
| 16104 | @cindex remote connection without stubs |
| 16105 | @code{gdbserver} is a control program for Unix-like systems, which |
| 16106 | allows you to connect your program with a remote @value{GDBN} via |
| 16107 | @code{target remote}---but without linking in the usual debugging stub. |
| 16108 | |
| 16109 | @code{gdbserver} is not a complete replacement for the debugging stubs, |
| 16110 | because it requires essentially the same operating-system facilities |
| 16111 | that @value{GDBN} itself does. In fact, a system that can run |
| 16112 | @code{gdbserver} to connect to a remote @value{GDBN} could also run |
| 16113 | @value{GDBN} locally! @code{gdbserver} is sometimes useful nevertheless, |
| 16114 | because it is a much smaller program than @value{GDBN} itself. It is |
| 16115 | also easier to port than all of @value{GDBN}, so you may be able to get |
| 16116 | started more quickly on a new system by using @code{gdbserver}. |
| 16117 | Finally, if you develop code for real-time systems, you may find that |
| 16118 | the tradeoffs involved in real-time operation make it more convenient to |
| 16119 | do as much development work as possible on another system, for example |
| 16120 | by cross-compiling. You can use @code{gdbserver} to make a similar |
| 16121 | choice for debugging. |
| 16122 | |
| 16123 | @value{GDBN} and @code{gdbserver} communicate via either a serial line |
| 16124 | or a TCP connection, using the standard @value{GDBN} remote serial |
| 16125 | protocol. |
| 16126 | |
| 16127 | @quotation |
| 16128 | @emph{Warning:} @code{gdbserver} does not have any built-in security. |
| 16129 | Do not run @code{gdbserver} connected to any public network; a |
| 16130 | @value{GDBN} connection to @code{gdbserver} provides access to the |
| 16131 | target system with the same privileges as the user running |
| 16132 | @code{gdbserver}. |
| 16133 | @end quotation |
| 16134 | |
| 16135 | @subsection Running @code{gdbserver} |
| 16136 | @cindex arguments, to @code{gdbserver} |
| 16137 | |
| 16138 | Run @code{gdbserver} on the target system. You need a copy of the |
| 16139 | program you want to debug, including any libraries it requires. |
| 16140 | @code{gdbserver} does not need your program's symbol table, so you can |
| 16141 | strip the program if necessary to save space. @value{GDBN} on the host |
| 16142 | system does all the symbol handling. |
| 16143 | |
| 16144 | To use the server, you must tell it how to communicate with @value{GDBN}; |
| 16145 | the name of your program; and the arguments for your program. The usual |
| 16146 | syntax is: |
| 16147 | |
| 16148 | @smallexample |
| 16149 | target> gdbserver @var{comm} @var{program} [ @var{args} @dots{} ] |
| 16150 | @end smallexample |
| 16151 | |
| 16152 | @var{comm} is either a device name (to use a serial line) or a TCP |
| 16153 | hostname and portnumber. For example, to debug Emacs with the argument |
| 16154 | @samp{foo.txt} and communicate with @value{GDBN} over the serial port |
| 16155 | @file{/dev/com1}: |
| 16156 | |
| 16157 | @smallexample |
| 16158 | target> gdbserver /dev/com1 emacs foo.txt |
| 16159 | @end smallexample |
| 16160 | |
| 16161 | @code{gdbserver} waits passively for the host @value{GDBN} to communicate |
| 16162 | with it. |
| 16163 | |
| 16164 | To use a TCP connection instead of a serial line: |
| 16165 | |
| 16166 | @smallexample |
| 16167 | target> gdbserver host:2345 emacs foo.txt |
| 16168 | @end smallexample |
| 16169 | |
| 16170 | The only difference from the previous example is the first argument, |
| 16171 | specifying that you are communicating with the host @value{GDBN} via |
| 16172 | TCP. The @samp{host:2345} argument means that @code{gdbserver} is to |
| 16173 | expect a TCP connection from machine @samp{host} to local TCP port 2345. |
| 16174 | (Currently, the @samp{host} part is ignored.) You can choose any number |
| 16175 | you want for the port number as long as it does not conflict with any |
| 16176 | TCP ports already in use on the target system (for example, @code{23} is |
| 16177 | reserved for @code{telnet}).@footnote{If you choose a port number that |
| 16178 | conflicts with another service, @code{gdbserver} prints an error message |
| 16179 | and exits.} You must use the same port number with the host @value{GDBN} |
| 16180 | @code{target remote} command. |
| 16181 | |
| 16182 | @subsubsection Attaching to a Running Program |
| 16183 | |
| 16184 | On some targets, @code{gdbserver} can also attach to running programs. |
| 16185 | This is accomplished via the @code{--attach} argument. The syntax is: |
| 16186 | |
| 16187 | @smallexample |
| 16188 | target> gdbserver --attach @var{comm} @var{pid} |
| 16189 | @end smallexample |
| 16190 | |
| 16191 | @var{pid} is the process ID of a currently running process. It isn't necessary |
| 16192 | to point @code{gdbserver} at a binary for the running process. |
| 16193 | |
| 16194 | @pindex pidof |
| 16195 | @cindex attach to a program by name |
| 16196 | You can debug processes by name instead of process ID if your target has the |
| 16197 | @code{pidof} utility: |
| 16198 | |
| 16199 | @smallexample |
| 16200 | target> gdbserver --attach @var{comm} `pidof @var{program}` |
| 16201 | @end smallexample |
| 16202 | |
| 16203 | In case more than one copy of @var{program} is running, or @var{program} |
| 16204 | has multiple threads, most versions of @code{pidof} support the |
| 16205 | @code{-s} option to only return the first process ID. |
| 16206 | |
| 16207 | @subsubsection Multi-Process Mode for @code{gdbserver} |
| 16208 | @cindex gdbserver, multiple processes |
| 16209 | @cindex multiple processes with gdbserver |
| 16210 | |
| 16211 | When you connect to @code{gdbserver} using @code{target remote}, |
| 16212 | @code{gdbserver} debugs the specified program only once. When the |
| 16213 | program exits, or you detach from it, @value{GDBN} closes the connection |
| 16214 | and @code{gdbserver} exits. |
| 16215 | |
| 16216 | If you connect using @kbd{target extended-remote}, @code{gdbserver} |
| 16217 | enters multi-process mode. When the debugged program exits, or you |
| 16218 | detach from it, @value{GDBN} stays connected to @code{gdbserver} even |
| 16219 | though no program is running. The @code{run} and @code{attach} |
| 16220 | commands instruct @code{gdbserver} to run or attach to a new program. |
| 16221 | The @code{run} command uses @code{set remote exec-file} (@pxref{set |
| 16222 | remote exec-file}) to select the program to run. Command line |
| 16223 | arguments are supported, except for wildcard expansion and I/O |
| 16224 | redirection (@pxref{Arguments}). |
| 16225 | |
| 16226 | To start @code{gdbserver} without supplying an initial command to run |
| 16227 | or process ID to attach, use the @option{--multi} command line option. |
| 16228 | Then you can connect using @kbd{target extended-remote} and start |
| 16229 | the program you want to debug. |
| 16230 | |
| 16231 | @code{gdbserver} does not automatically exit in multi-process mode. |
| 16232 | You can terminate it by using @code{monitor exit} |
| 16233 | (@pxref{Monitor Commands for gdbserver}). |
| 16234 | |
| 16235 | @subsubsection Other Command-Line Arguments for @code{gdbserver} |
| 16236 | |
| 16237 | The @option{--debug} option tells @code{gdbserver} to display extra |
| 16238 | status information about the debugging process. The |
| 16239 | @option{--remote-debug} option tells @code{gdbserver} to display |
| 16240 | remote protocol debug output. These options are intended for |
| 16241 | @code{gdbserver} development and for bug reports to the developers. |
| 16242 | |
| 16243 | The @option{--wrapper} option specifies a wrapper to launch programs |
| 16244 | for debugging. The option should be followed by the name of the |
| 16245 | wrapper, then any command-line arguments to pass to the wrapper, then |
| 16246 | @kbd{--} indicating the end of the wrapper arguments. |
| 16247 | |
| 16248 | @code{gdbserver} runs the specified wrapper program with a combined |
| 16249 | command line including the wrapper arguments, then the name of the |
| 16250 | program to debug, then any arguments to the program. The wrapper |
| 16251 | runs until it executes your program, and then @value{GDBN} gains control. |
| 16252 | |
| 16253 | You can use any program that eventually calls @code{execve} with |
| 16254 | its arguments as a wrapper. Several standard Unix utilities do |
| 16255 | this, e.g.@: @code{env} and @code{nohup}. Any Unix shell script ending |
| 16256 | with @code{exec "$@@"} will also work. |
| 16257 | |
| 16258 | For example, you can use @code{env} to pass an environment variable to |
| 16259 | the debugged program, without setting the variable in @code{gdbserver}'s |
| 16260 | environment: |
| 16261 | |
| 16262 | @smallexample |
| 16263 | $ gdbserver --wrapper env LD_PRELOAD=libtest.so -- :2222 ./testprog |
| 16264 | @end smallexample |
| 16265 | |
| 16266 | @subsection Connecting to @code{gdbserver} |
| 16267 | |
| 16268 | Run @value{GDBN} on the host system. |
| 16269 | |
| 16270 | First make sure you have the necessary symbol files. Load symbols for |
| 16271 | your application using the @code{file} command before you connect. Use |
| 16272 | @code{set sysroot} to locate target libraries (unless your @value{GDBN} |
| 16273 | was compiled with the correct sysroot using @code{--with-sysroot}). |
| 16274 | |
| 16275 | The symbol file and target libraries must exactly match the executable |
| 16276 | and libraries on the target, with one exception: the files on the host |
| 16277 | system should not be stripped, even if the files on the target system |
| 16278 | are. Mismatched or missing files will lead to confusing results |
| 16279 | during debugging. On @sc{gnu}/Linux targets, mismatched or missing |
| 16280 | files may also prevent @code{gdbserver} from debugging multi-threaded |
| 16281 | programs. |
| 16282 | |
| 16283 | Connect to your target (@pxref{Connecting,,Connecting to a Remote Target}). |
| 16284 | For TCP connections, you must start up @code{gdbserver} prior to using |
| 16285 | the @code{target remote} command. Otherwise you may get an error whose |
| 16286 | text depends on the host system, but which usually looks something like |
| 16287 | @samp{Connection refused}. Don't use the @code{load} |
| 16288 | command in @value{GDBN} when using @code{gdbserver}, since the program is |
| 16289 | already on the target. |
| 16290 | |
| 16291 | @subsection Monitor Commands for @code{gdbserver} |
| 16292 | @cindex monitor commands, for @code{gdbserver} |
| 16293 | @anchor{Monitor Commands for gdbserver} |
| 16294 | |
| 16295 | During a @value{GDBN} session using @code{gdbserver}, you can use the |
| 16296 | @code{monitor} command to send special requests to @code{gdbserver}. |
| 16297 | Here are the available commands. |
| 16298 | |
| 16299 | @table @code |
| 16300 | @item monitor help |
| 16301 | List the available monitor commands. |
| 16302 | |
| 16303 | @item monitor set debug 0 |
| 16304 | @itemx monitor set debug 1 |
| 16305 | Disable or enable general debugging messages. |
| 16306 | |
| 16307 | @item monitor set remote-debug 0 |
| 16308 | @itemx monitor set remote-debug 1 |
| 16309 | Disable or enable specific debugging messages associated with the remote |
| 16310 | protocol (@pxref{Remote Protocol}). |
| 16311 | |
| 16312 | @item monitor set libthread-db-search-path [PATH] |
| 16313 | @cindex gdbserver, search path for @code{libthread_db} |
| 16314 | When this command is issued, @var{path} is a colon-separated list of |
| 16315 | directories to search for @code{libthread_db} (@pxref{Threads,,set |
| 16316 | libthread-db-search-path}). If you omit @var{path}, |
| 16317 | @samp{libthread-db-search-path} will be reset to an empty list. |
| 16318 | |
| 16319 | @item monitor exit |
| 16320 | Tell gdbserver to exit immediately. This command should be followed by |
| 16321 | @code{disconnect} to close the debugging session. @code{gdbserver} will |
| 16322 | detach from any attached processes and kill any processes it created. |
| 16323 | Use @code{monitor exit} to terminate @code{gdbserver} at the end |
| 16324 | of a multi-process mode debug session. |
| 16325 | |
| 16326 | @end table |
| 16327 | |
| 16328 | @subsection Tracepoints support in @code{gdbserver} |
| 16329 | @cindex tracepoints support in @code{gdbserver} |
| 16330 | |
| 16331 | On some targets, @code{gdbserver} supports tracepoints, fast |
| 16332 | tracepoints and static tracepoints. |
| 16333 | |
| 16334 | For fast or static tracepoints to work, a special library called the |
| 16335 | @dfn{in-process agent} (IPA), must be loaded in the inferior process. |
| 16336 | This library is built and distributed as an integral part of |
| 16337 | @code{gdbserver}. In addition, support for static tracepoints |
| 16338 | requires building the in-process agent library with static tracepoints |
| 16339 | support. At present, the UST (LTTng Userspace Tracer, |
| 16340 | @url{http://lttng.org/ust}) tracing engine is supported. This support |
| 16341 | is automatically available if UST development headers are found in the |
| 16342 | standard include path when @code{gdbserver} is built, or if |
| 16343 | @code{gdbserver} was explicitly configured using @option{--with-ust} |
| 16344 | to point at such headers. You can explicitly disable the support |
| 16345 | using @option{--with-ust=no}. |
| 16346 | |
| 16347 | There are several ways to load the in-process agent in your program: |
| 16348 | |
| 16349 | @table @code |
| 16350 | @item Specifying it as dependency at link time |
| 16351 | |
| 16352 | You can link your program dynamically with the in-process agent |
| 16353 | library. On most systems, this is accomplished by adding |
| 16354 | @code{-linproctrace} to the link command. |
| 16355 | |
| 16356 | @item Using the system's preloading mechanisms |
| 16357 | |
| 16358 | You can force loading the in-process agent at startup time by using |
| 16359 | your system's support for preloading shared libraries. Many Unixes |
| 16360 | support the concept of preloading user defined libraries. In most |
| 16361 | cases, you do that by specifying @code{LD_PRELOAD=libinproctrace.so} |
| 16362 | in the environment. See also the description of @code{gdbserver}'s |
| 16363 | @option{--wrapper} command line option. |
| 16364 | |
| 16365 | @item Using @value{GDBN} to force loading the agent at run time |
| 16366 | |
| 16367 | On some systems, you can force the inferior to load a shared library, |
| 16368 | by calling a dynamic loader function in the inferior that takes care |
| 16369 | of dynamically looking up and loading a shared library. On most Unix |
| 16370 | systems, the function is @code{dlopen}. You'll use the @code{call} |
| 16371 | command for that. For example: |
| 16372 | |
| 16373 | @smallexample |
| 16374 | (@value{GDBP}) call dlopen ("libinproctrace.so", ...) |
| 16375 | @end smallexample |
| 16376 | |
| 16377 | Note that on most Unix systems, for the @code{dlopen} function to be |
| 16378 | available, the program needs to be linked with @code{-ldl}. |
| 16379 | @end table |
| 16380 | |
| 16381 | On systems that have a userspace dynamic loader, like most Unix |
| 16382 | systems, when you connect to @code{gdbserver} using @code{target |
| 16383 | remote}, you'll find that the program is stopped at the dynamic |
| 16384 | loader's entry point, and no shared library has been loaded in the |
| 16385 | program's address space yet, including the in-process agent. In that |
| 16386 | case, before being able to use any of the fast or static tracepoints |
| 16387 | features, you need to let the loader run and load the shared |
| 16388 | libraries. The simplest way to do that is to run the program to the |
| 16389 | main procedure. E.g., if debugging a C or C@t{++} program, start |
| 16390 | @code{gdbserver} like so: |
| 16391 | |
| 16392 | @smallexample |
| 16393 | $ gdbserver :9999 myprogram |
| 16394 | @end smallexample |
| 16395 | |
| 16396 | Start GDB and connect to @code{gdbserver} like so, and run to main: |
| 16397 | |
| 16398 | @smallexample |
| 16399 | $ gdb myprogram |
| 16400 | (@value{GDBP}) target remote myhost:9999 |
| 16401 | 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64.so.2 |
| 16402 | (@value{GDBP}) b main |
| 16403 | (@value{GDBP}) continue |
| 16404 | @end smallexample |
| 16405 | |
| 16406 | The in-process tracing agent library should now be loaded into the |
| 16407 | process; you can confirm it with the @code{info sharedlibrary} |
| 16408 | command, which will list @file{libinproctrace.so} as loaded in the |
| 16409 | process. You are now ready to install fast tracepoints, list static |
| 16410 | tracepoint markers, probe static tracepoints markers, and start |
| 16411 | tracing. |
| 16412 | |
| 16413 | @node Remote Configuration |
| 16414 | @section Remote Configuration |
| 16415 | |
| 16416 | @kindex set remote |
| 16417 | @kindex show remote |
| 16418 | This section documents the configuration options available when |
| 16419 | debugging remote programs. For the options related to the File I/O |
| 16420 | extensions of the remote protocol, see @ref{system, |
| 16421 | system-call-allowed}. |
| 16422 | |
| 16423 | @table @code |
| 16424 | @item set remoteaddresssize @var{bits} |
| 16425 | @cindex address size for remote targets |
| 16426 | @cindex bits in remote address |
| 16427 | Set the maximum size of address in a memory packet to the specified |
| 16428 | number of bits. @value{GDBN} will mask off the address bits above |
| 16429 | that number, when it passes addresses to the remote target. The |
| 16430 | default value is the number of bits in the target's address. |
| 16431 | |
| 16432 | @item show remoteaddresssize |
| 16433 | Show the current value of remote address size in bits. |
| 16434 | |
| 16435 | @item set remotebaud @var{n} |
| 16436 | @cindex baud rate for remote targets |
| 16437 | Set the baud rate for the remote serial I/O to @var{n} baud. The |
| 16438 | value is used to set the speed of the serial port used for debugging |
| 16439 | remote targets. |
| 16440 | |
| 16441 | @item show remotebaud |
| 16442 | Show the current speed of the remote connection. |
| 16443 | |
| 16444 | @item set remotebreak |
| 16445 | @cindex interrupt remote programs |
| 16446 | @cindex BREAK signal instead of Ctrl-C |
| 16447 | @anchor{set remotebreak} |
| 16448 | If set to on, @value{GDBN} sends a @code{BREAK} signal to the remote |
| 16449 | when you type @kbd{Ctrl-c} to interrupt the program running |
| 16450 | on the remote. If set to off, @value{GDBN} sends the @samp{Ctrl-C} |
| 16451 | character instead. The default is off, since most remote systems |
| 16452 | expect to see @samp{Ctrl-C} as the interrupt signal. |
| 16453 | |
| 16454 | @item show remotebreak |
| 16455 | Show whether @value{GDBN} sends @code{BREAK} or @samp{Ctrl-C} to |
| 16456 | interrupt the remote program. |
| 16457 | |
| 16458 | @item set remoteflow on |
| 16459 | @itemx set remoteflow off |
| 16460 | @kindex set remoteflow |
| 16461 | Enable or disable hardware flow control (@code{RTS}/@code{CTS}) |
| 16462 | on the serial port used to communicate to the remote target. |
| 16463 | |
| 16464 | @item show remoteflow |
| 16465 | @kindex show remoteflow |
| 16466 | Show the current setting of hardware flow control. |
| 16467 | |
| 16468 | @item set remotelogbase @var{base} |
| 16469 | Set the base (a.k.a.@: radix) of logging serial protocol |
| 16470 | communications to @var{base}. Supported values of @var{base} are: |
| 16471 | @code{ascii}, @code{octal}, and @code{hex}. The default is |
| 16472 | @code{ascii}. |
| 16473 | |
| 16474 | @item show remotelogbase |
| 16475 | Show the current setting of the radix for logging remote serial |
| 16476 | protocol. |
| 16477 | |
| 16478 | @item set remotelogfile @var{file} |
| 16479 | @cindex record serial communications on file |
| 16480 | Record remote serial communications on the named @var{file}. The |
| 16481 | default is not to record at all. |
| 16482 | |
| 16483 | @item show remotelogfile. |
| 16484 | Show the current setting of the file name on which to record the |
| 16485 | serial communications. |
| 16486 | |
| 16487 | @item set remotetimeout @var{num} |
| 16488 | @cindex timeout for serial communications |
| 16489 | @cindex remote timeout |
| 16490 | Set the timeout limit to wait for the remote target to respond to |
| 16491 | @var{num} seconds. The default is 2 seconds. |
| 16492 | |
| 16493 | @item show remotetimeout |
| 16494 | Show the current number of seconds to wait for the remote target |
| 16495 | responses. |
| 16496 | |
| 16497 | @cindex limit hardware breakpoints and watchpoints |
| 16498 | @cindex remote target, limit break- and watchpoints |
| 16499 | @anchor{set remote hardware-watchpoint-limit} |
| 16500 | @anchor{set remote hardware-breakpoint-limit} |
| 16501 | @item set remote hardware-watchpoint-limit @var{limit} |
| 16502 | @itemx set remote hardware-breakpoint-limit @var{limit} |
| 16503 | Restrict @value{GDBN} to using @var{limit} remote hardware breakpoint or |
| 16504 | watchpoints. A limit of -1, the default, is treated as unlimited. |
| 16505 | |
| 16506 | @item set remote exec-file @var{filename} |
| 16507 | @itemx show remote exec-file |
| 16508 | @anchor{set remote exec-file} |
| 16509 | @cindex executable file, for remote target |
| 16510 | Select the file used for @code{run} with @code{target |
| 16511 | extended-remote}. This should be set to a filename valid on the |
| 16512 | target system. If it is not set, the target will use a default |
| 16513 | filename (e.g.@: the last program run). |
| 16514 | |
| 16515 | @item set remote interrupt-sequence |
| 16516 | @cindex interrupt remote programs |
| 16517 | @cindex select Ctrl-C, BREAK or BREAK-g |
| 16518 | Allow the user to select one of @samp{Ctrl-C}, a @code{BREAK} or |
| 16519 | @samp{BREAK-g} as the |
| 16520 | sequence to the remote target in order to interrupt the execution. |
| 16521 | @samp{Ctrl-C} is a default. Some system prefers @code{BREAK} which |
| 16522 | is high level of serial line for some certain time. |
| 16523 | Linux kernel prefers @samp{BREAK-g}, a.k.a Magic SysRq g. |
| 16524 | It is @code{BREAK} signal followed by character @code{g}. |
| 16525 | |
| 16526 | @item show interrupt-sequence |
| 16527 | Show which of @samp{Ctrl-C}, @code{BREAK} or @code{BREAK-g} |
| 16528 | is sent by @value{GDBN} to interrupt the remote program. |
| 16529 | @code{BREAK-g} is BREAK signal followed by @code{g} and |
| 16530 | also known as Magic SysRq g. |
| 16531 | |
| 16532 | @item set remote interrupt-on-connect |
| 16533 | @cindex send interrupt-sequence on start |
| 16534 | Specify whether interrupt-sequence is sent to remote target when |
| 16535 | @value{GDBN} connects to it. This is mostly needed when you debug |
| 16536 | Linux kernel. Linux kernel expects @code{BREAK} followed by @code{g} |
| 16537 | which is known as Magic SysRq g in order to connect @value{GDBN}. |
| 16538 | |
| 16539 | @item show interrupt-on-connect |
| 16540 | Show whether interrupt-sequence is sent |
| 16541 | to remote target when @value{GDBN} connects to it. |
| 16542 | |
| 16543 | @kindex set tcp |
| 16544 | @kindex show tcp |
| 16545 | @item set tcp auto-retry on |
| 16546 | @cindex auto-retry, for remote TCP target |
| 16547 | Enable auto-retry for remote TCP connections. This is useful if the remote |
| 16548 | debugging agent is launched in parallel with @value{GDBN}; there is a race |
| 16549 | condition because the agent may not become ready to accept the connection |
| 16550 | before @value{GDBN} attempts to connect. When auto-retry is |
| 16551 | enabled, if the initial attempt to connect fails, @value{GDBN} reattempts |
| 16552 | to establish the connection using the timeout specified by |
| 16553 | @code{set tcp connect-timeout}. |
| 16554 | |
| 16555 | @item set tcp auto-retry off |
| 16556 | Do not auto-retry failed TCP connections. |
| 16557 | |
| 16558 | @item show tcp auto-retry |
| 16559 | Show the current auto-retry setting. |
| 16560 | |
| 16561 | @item set tcp connect-timeout @var{seconds} |
| 16562 | @cindex connection timeout, for remote TCP target |
| 16563 | @cindex timeout, for remote target connection |
| 16564 | Set the timeout for establishing a TCP connection to the remote target to |
| 16565 | @var{seconds}. The timeout affects both polling to retry failed connections |
| 16566 | (enabled by @code{set tcp auto-retry on}) and waiting for connections |
| 16567 | that are merely slow to complete, and represents an approximate cumulative |
| 16568 | value. |
| 16569 | |
| 16570 | @item show tcp connect-timeout |
| 16571 | Show the current connection timeout setting. |
| 16572 | @end table |
| 16573 | |
| 16574 | @cindex remote packets, enabling and disabling |
| 16575 | The @value{GDBN} remote protocol autodetects the packets supported by |
| 16576 | your debugging stub. If you need to override the autodetection, you |
| 16577 | can use these commands to enable or disable individual packets. Each |
| 16578 | packet can be set to @samp{on} (the remote target supports this |
| 16579 | packet), @samp{off} (the remote target does not support this packet), |
| 16580 | or @samp{auto} (detect remote target support for this packet). They |
| 16581 | all default to @samp{auto}. For more information about each packet, |
| 16582 | see @ref{Remote Protocol}. |
| 16583 | |
| 16584 | During normal use, you should not have to use any of these commands. |
| 16585 | If you do, that may be a bug in your remote debugging stub, or a bug |
| 16586 | in @value{GDBN}. You may want to report the problem to the |
| 16587 | @value{GDBN} developers. |
| 16588 | |
| 16589 | For each packet @var{name}, the command to enable or disable the |
| 16590 | packet is @code{set remote @var{name}-packet}. The available settings |
| 16591 | are: |
| 16592 | |
| 16593 | @multitable @columnfractions 0.28 0.32 0.25 |
| 16594 | @item Command Name |
| 16595 | @tab Remote Packet |
| 16596 | @tab Related Features |
| 16597 | |
| 16598 | @item @code{fetch-register} |
| 16599 | @tab @code{p} |
| 16600 | @tab @code{info registers} |
| 16601 | |
| 16602 | @item @code{set-register} |
| 16603 | @tab @code{P} |
| 16604 | @tab @code{set} |
| 16605 | |
| 16606 | @item @code{binary-download} |
| 16607 | @tab @code{X} |
| 16608 | @tab @code{load}, @code{set} |
| 16609 | |
| 16610 | @item @code{read-aux-vector} |
| 16611 | @tab @code{qXfer:auxv:read} |
| 16612 | @tab @code{info auxv} |
| 16613 | |
| 16614 | @item @code{symbol-lookup} |
| 16615 | @tab @code{qSymbol} |
| 16616 | @tab Detecting multiple threads |
| 16617 | |
| 16618 | @item @code{attach} |
| 16619 | @tab @code{vAttach} |
| 16620 | @tab @code{attach} |
| 16621 | |
| 16622 | @item @code{verbose-resume} |
| 16623 | @tab @code{vCont} |
| 16624 | @tab Stepping or resuming multiple threads |
| 16625 | |
| 16626 | @item @code{run} |
| 16627 | @tab @code{vRun} |
| 16628 | @tab @code{run} |
| 16629 | |
| 16630 | @item @code{software-breakpoint} |
| 16631 | @tab @code{Z0} |
| 16632 | @tab @code{break} |
| 16633 | |
| 16634 | @item @code{hardware-breakpoint} |
| 16635 | @tab @code{Z1} |
| 16636 | @tab @code{hbreak} |
| 16637 | |
| 16638 | @item @code{write-watchpoint} |
| 16639 | @tab @code{Z2} |
| 16640 | @tab @code{watch} |
| 16641 | |
| 16642 | @item @code{read-watchpoint} |
| 16643 | @tab @code{Z3} |
| 16644 | @tab @code{rwatch} |
| 16645 | |
| 16646 | @item @code{access-watchpoint} |
| 16647 | @tab @code{Z4} |
| 16648 | @tab @code{awatch} |
| 16649 | |
| 16650 | @item @code{target-features} |
| 16651 | @tab @code{qXfer:features:read} |
| 16652 | @tab @code{set architecture} |
| 16653 | |
| 16654 | @item @code{library-info} |
| 16655 | @tab @code{qXfer:libraries:read} |
| 16656 | @tab @code{info sharedlibrary} |
| 16657 | |
| 16658 | @item @code{memory-map} |
| 16659 | @tab @code{qXfer:memory-map:read} |
| 16660 | @tab @code{info mem} |
| 16661 | |
| 16662 | @item @code{read-sdata-object} |
| 16663 | @tab @code{qXfer:sdata:read} |
| 16664 | @tab @code{print $_sdata} |
| 16665 | |
| 16666 | @item @code{read-spu-object} |
| 16667 | @tab @code{qXfer:spu:read} |
| 16668 | @tab @code{info spu} |
| 16669 | |
| 16670 | @item @code{write-spu-object} |
| 16671 | @tab @code{qXfer:spu:write} |
| 16672 | @tab @code{info spu} |
| 16673 | |
| 16674 | @item @code{read-siginfo-object} |
| 16675 | @tab @code{qXfer:siginfo:read} |
| 16676 | @tab @code{print $_siginfo} |
| 16677 | |
| 16678 | @item @code{write-siginfo-object} |
| 16679 | @tab @code{qXfer:siginfo:write} |
| 16680 | @tab @code{set $_siginfo} |
| 16681 | |
| 16682 | @item @code{threads} |
| 16683 | @tab @code{qXfer:threads:read} |
| 16684 | @tab @code{info threads} |
| 16685 | |
| 16686 | @item @code{get-thread-local-@*storage-address} |
| 16687 | @tab @code{qGetTLSAddr} |
| 16688 | @tab Displaying @code{__thread} variables |
| 16689 | |
| 16690 | @item @code{get-thread-information-block-address} |
| 16691 | @tab @code{qGetTIBAddr} |
| 16692 | @tab Display MS-Windows Thread Information Block. |
| 16693 | |
| 16694 | @item @code{search-memory} |
| 16695 | @tab @code{qSearch:memory} |
| 16696 | @tab @code{find} |
| 16697 | |
| 16698 | @item @code{supported-packets} |
| 16699 | @tab @code{qSupported} |
| 16700 | @tab Remote communications parameters |
| 16701 | |
| 16702 | @item @code{pass-signals} |
| 16703 | @tab @code{QPassSignals} |
| 16704 | @tab @code{handle @var{signal}} |
| 16705 | |
| 16706 | @item @code{hostio-close-packet} |
| 16707 | @tab @code{vFile:close} |
| 16708 | @tab @code{remote get}, @code{remote put} |
| 16709 | |
| 16710 | @item @code{hostio-open-packet} |
| 16711 | @tab @code{vFile:open} |
| 16712 | @tab @code{remote get}, @code{remote put} |
| 16713 | |
| 16714 | @item @code{hostio-pread-packet} |
| 16715 | @tab @code{vFile:pread} |
| 16716 | @tab @code{remote get}, @code{remote put} |
| 16717 | |
| 16718 | @item @code{hostio-pwrite-packet} |
| 16719 | @tab @code{vFile:pwrite} |
| 16720 | @tab @code{remote get}, @code{remote put} |
| 16721 | |
| 16722 | @item @code{hostio-unlink-packet} |
| 16723 | @tab @code{vFile:unlink} |
| 16724 | @tab @code{remote delete} |
| 16725 | |
| 16726 | @item @code{noack-packet} |
| 16727 | @tab @code{QStartNoAckMode} |
| 16728 | @tab Packet acknowledgment |
| 16729 | |
| 16730 | @item @code{osdata} |
| 16731 | @tab @code{qXfer:osdata:read} |
| 16732 | @tab @code{info os} |
| 16733 | |
| 16734 | @item @code{query-attached} |
| 16735 | @tab @code{qAttached} |
| 16736 | @tab Querying remote process attach state. |
| 16737 | |
| 16738 | @item @code{traceframe-info} |
| 16739 | @tab @code{qXfer:traceframe-info:read} |
| 16740 | @tab Traceframe info |
| 16741 | @end multitable |
| 16742 | |
| 16743 | @node Remote Stub |
| 16744 | @section Implementing a Remote Stub |
| 16745 | |
| 16746 | @cindex debugging stub, example |
| 16747 | @cindex remote stub, example |
| 16748 | @cindex stub example, remote debugging |
| 16749 | The stub files provided with @value{GDBN} implement the target side of the |
| 16750 | communication protocol, and the @value{GDBN} side is implemented in the |
| 16751 | @value{GDBN} source file @file{remote.c}. Normally, you can simply allow |
| 16752 | these subroutines to communicate, and ignore the details. (If you're |
| 16753 | implementing your own stub file, you can still ignore the details: start |
| 16754 | with one of the existing stub files. @file{sparc-stub.c} is the best |
| 16755 | organized, and therefore the easiest to read.) |
| 16756 | |
| 16757 | @cindex remote serial debugging, overview |
| 16758 | To debug a program running on another machine (the debugging |
| 16759 | @dfn{target} machine), you must first arrange for all the usual |
| 16760 | prerequisites for the program to run by itself. For example, for a C |
| 16761 | program, you need: |
| 16762 | |
| 16763 | @enumerate |
| 16764 | @item |
| 16765 | A startup routine to set up the C runtime environment; these usually |
| 16766 | have a name like @file{crt0}. The startup routine may be supplied by |
| 16767 | your hardware supplier, or you may have to write your own. |
| 16768 | |
| 16769 | @item |
| 16770 | A C subroutine library to support your program's |
| 16771 | subroutine calls, notably managing input and output. |
| 16772 | |
| 16773 | @item |
| 16774 | A way of getting your program to the other machine---for example, a |
| 16775 | download program. These are often supplied by the hardware |
| 16776 | manufacturer, but you may have to write your own from hardware |
| 16777 | documentation. |
| 16778 | @end enumerate |
| 16779 | |
| 16780 | The next step is to arrange for your program to use a serial port to |
| 16781 | communicate with the machine where @value{GDBN} is running (the @dfn{host} |
| 16782 | machine). In general terms, the scheme looks like this: |
| 16783 | |
| 16784 | @table @emph |
| 16785 | @item On the host, |
| 16786 | @value{GDBN} already understands how to use this protocol; when everything |
| 16787 | else is set up, you can simply use the @samp{target remote} command |
| 16788 | (@pxref{Targets,,Specifying a Debugging Target}). |
| 16789 | |
| 16790 | @item On the target, |
| 16791 | you must link with your program a few special-purpose subroutines that |
| 16792 | implement the @value{GDBN} remote serial protocol. The file containing these |
| 16793 | subroutines is called a @dfn{debugging stub}. |
| 16794 | |
| 16795 | On certain remote targets, you can use an auxiliary program |
| 16796 | @code{gdbserver} instead of linking a stub into your program. |
| 16797 | @xref{Server,,Using the @code{gdbserver} Program}, for details. |
| 16798 | @end table |
| 16799 | |
| 16800 | The debugging stub is specific to the architecture of the remote |
| 16801 | machine; for example, use @file{sparc-stub.c} to debug programs on |
| 16802 | @sc{sparc} boards. |
| 16803 | |
| 16804 | @cindex remote serial stub list |
| 16805 | These working remote stubs are distributed with @value{GDBN}: |
| 16806 | |
| 16807 | @table @code |
| 16808 | |
| 16809 | @item i386-stub.c |
| 16810 | @cindex @file{i386-stub.c} |
| 16811 | @cindex Intel |
| 16812 | @cindex i386 |
| 16813 | For Intel 386 and compatible architectures. |
| 16814 | |
| 16815 | @item m68k-stub.c |
| 16816 | @cindex @file{m68k-stub.c} |
| 16817 | @cindex Motorola 680x0 |
| 16818 | @cindex m680x0 |
| 16819 | For Motorola 680x0 architectures. |
| 16820 | |
| 16821 | @item sh-stub.c |
| 16822 | @cindex @file{sh-stub.c} |
| 16823 | @cindex Renesas |
| 16824 | @cindex SH |
| 16825 | For Renesas SH architectures. |
| 16826 | |
| 16827 | @item sparc-stub.c |
| 16828 | @cindex @file{sparc-stub.c} |
| 16829 | @cindex Sparc |
| 16830 | For @sc{sparc} architectures. |
| 16831 | |
| 16832 | @item sparcl-stub.c |
| 16833 | @cindex @file{sparcl-stub.c} |
| 16834 | @cindex Fujitsu |
| 16835 | @cindex SparcLite |
| 16836 | For Fujitsu @sc{sparclite} architectures. |
| 16837 | |
| 16838 | @end table |
| 16839 | |
| 16840 | The @file{README} file in the @value{GDBN} distribution may list other |
| 16841 | recently added stubs. |
| 16842 | |
| 16843 | @menu |
| 16844 | * Stub Contents:: What the stub can do for you |
| 16845 | * Bootstrapping:: What you must do for the stub |
| 16846 | * Debug Session:: Putting it all together |
| 16847 | @end menu |
| 16848 | |
| 16849 | @node Stub Contents |
| 16850 | @subsection What the Stub Can Do for You |
| 16851 | |
| 16852 | @cindex remote serial stub |
| 16853 | The debugging stub for your architecture supplies these three |
| 16854 | subroutines: |
| 16855 | |
| 16856 | @table @code |
| 16857 | @item set_debug_traps |
| 16858 | @findex set_debug_traps |
| 16859 | @cindex remote serial stub, initialization |
| 16860 | This routine arranges for @code{handle_exception} to run when your |
| 16861 | program stops. You must call this subroutine explicitly near the |
| 16862 | beginning of your program. |
| 16863 | |
| 16864 | @item handle_exception |
| 16865 | @findex handle_exception |
| 16866 | @cindex remote serial stub, main routine |
| 16867 | This is the central workhorse, but your program never calls it |
| 16868 | explicitly---the setup code arranges for @code{handle_exception} to |
| 16869 | run when a trap is triggered. |
| 16870 | |
| 16871 | @code{handle_exception} takes control when your program stops during |
| 16872 | execution (for example, on a breakpoint), and mediates communications |
| 16873 | with @value{GDBN} on the host machine. This is where the communications |
| 16874 | protocol is implemented; @code{handle_exception} acts as the @value{GDBN} |
| 16875 | representative on the target machine. It begins by sending summary |
| 16876 | information on the state of your program, then continues to execute, |
| 16877 | retrieving and transmitting any information @value{GDBN} needs, until you |
| 16878 | execute a @value{GDBN} command that makes your program resume; at that point, |
| 16879 | @code{handle_exception} returns control to your own code on the target |
| 16880 | machine. |
| 16881 | |
| 16882 | @item breakpoint |
| 16883 | @cindex @code{breakpoint} subroutine, remote |
| 16884 | Use this auxiliary subroutine to make your program contain a |
| 16885 | breakpoint. Depending on the particular situation, this may be the only |
| 16886 | way for @value{GDBN} to get control. For instance, if your target |
| 16887 | machine has some sort of interrupt button, you won't need to call this; |
| 16888 | pressing the interrupt button transfers control to |
| 16889 | @code{handle_exception}---in effect, to @value{GDBN}. On some machines, |
| 16890 | simply receiving characters on the serial port may also trigger a trap; |
| 16891 | again, in that situation, you don't need to call @code{breakpoint} from |
| 16892 | your own program---simply running @samp{target remote} from the host |
| 16893 | @value{GDBN} session gets control. |
| 16894 | |
| 16895 | Call @code{breakpoint} if none of these is true, or if you simply want |
| 16896 | to make certain your program stops at a predetermined point for the |
| 16897 | start of your debugging session. |
| 16898 | @end table |
| 16899 | |
| 16900 | @node Bootstrapping |
| 16901 | @subsection What You Must Do for the Stub |
| 16902 | |
| 16903 | @cindex remote stub, support routines |
| 16904 | The debugging stubs that come with @value{GDBN} are set up for a particular |
| 16905 | chip architecture, but they have no information about the rest of your |
| 16906 | debugging target machine. |
| 16907 | |
| 16908 | First of all you need to tell the stub how to communicate with the |
| 16909 | serial port. |
| 16910 | |
| 16911 | @table @code |
| 16912 | @item int getDebugChar() |
| 16913 | @findex getDebugChar |
| 16914 | Write this subroutine to read a single character from the serial port. |
| 16915 | It may be identical to @code{getchar} for your target system; a |
| 16916 | different name is used to allow you to distinguish the two if you wish. |
| 16917 | |
| 16918 | @item void putDebugChar(int) |
| 16919 | @findex putDebugChar |
| 16920 | Write this subroutine to write a single character to the serial port. |
| 16921 | It may be identical to @code{putchar} for your target system; a |
| 16922 | different name is used to allow you to distinguish the two if you wish. |
| 16923 | @end table |
| 16924 | |
| 16925 | @cindex control C, and remote debugging |
| 16926 | @cindex interrupting remote targets |
| 16927 | If you want @value{GDBN} to be able to stop your program while it is |
| 16928 | running, you need to use an interrupt-driven serial driver, and arrange |
| 16929 | for it to stop when it receives a @code{^C} (@samp{\003}, the control-C |
| 16930 | character). That is the character which @value{GDBN} uses to tell the |
| 16931 | remote system to stop. |
| 16932 | |
| 16933 | Getting the debugging target to return the proper status to @value{GDBN} |
| 16934 | probably requires changes to the standard stub; one quick and dirty way |
| 16935 | is to just execute a breakpoint instruction (the ``dirty'' part is that |
| 16936 | @value{GDBN} reports a @code{SIGTRAP} instead of a @code{SIGINT}). |
| 16937 | |
| 16938 | Other routines you need to supply are: |
| 16939 | |
| 16940 | @table @code |
| 16941 | @item void exceptionHandler (int @var{exception_number}, void *@var{exception_address}) |
| 16942 | @findex exceptionHandler |
| 16943 | Write this function to install @var{exception_address} in the exception |
| 16944 | handling tables. You need to do this because the stub does not have any |
| 16945 | way of knowing what the exception handling tables on your target system |
| 16946 | are like (for example, the processor's table might be in @sc{rom}, |
| 16947 | containing entries which point to a table in @sc{ram}). |
| 16948 | @var{exception_number} is the exception number which should be changed; |
| 16949 | its meaning is architecture-dependent (for example, different numbers |
| 16950 | might represent divide by zero, misaligned access, etc). When this |
| 16951 | exception occurs, control should be transferred directly to |
| 16952 | @var{exception_address}, and the processor state (stack, registers, |
| 16953 | and so on) should be just as it is when a processor exception occurs. So if |
| 16954 | you want to use a jump instruction to reach @var{exception_address}, it |
| 16955 | should be a simple jump, not a jump to subroutine. |
| 16956 | |
| 16957 | For the 386, @var{exception_address} should be installed as an interrupt |
| 16958 | gate so that interrupts are masked while the handler runs. The gate |
| 16959 | should be at privilege level 0 (the most privileged level). The |
| 16960 | @sc{sparc} and 68k stubs are able to mask interrupts themselves without |
| 16961 | help from @code{exceptionHandler}. |
| 16962 | |
| 16963 | @item void flush_i_cache() |
| 16964 | @findex flush_i_cache |
| 16965 | On @sc{sparc} and @sc{sparclite} only, write this subroutine to flush the |
| 16966 | instruction cache, if any, on your target machine. If there is no |
| 16967 | instruction cache, this subroutine may be a no-op. |
| 16968 | |
| 16969 | On target machines that have instruction caches, @value{GDBN} requires this |
| 16970 | function to make certain that the state of your program is stable. |
| 16971 | @end table |
| 16972 | |
| 16973 | @noindent |
| 16974 | You must also make sure this library routine is available: |
| 16975 | |
| 16976 | @table @code |
| 16977 | @item void *memset(void *, int, int) |
| 16978 | @findex memset |
| 16979 | This is the standard library function @code{memset} that sets an area of |
| 16980 | memory to a known value. If you have one of the free versions of |
| 16981 | @code{libc.a}, @code{memset} can be found there; otherwise, you must |
| 16982 | either obtain it from your hardware manufacturer, or write your own. |
| 16983 | @end table |
| 16984 | |
| 16985 | If you do not use the GNU C compiler, you may need other standard |
| 16986 | library subroutines as well; this varies from one stub to another, |
| 16987 | but in general the stubs are likely to use any of the common library |
| 16988 | subroutines which @code{@value{NGCC}} generates as inline code. |
| 16989 | |
| 16990 | |
| 16991 | @node Debug Session |
| 16992 | @subsection Putting it All Together |
| 16993 | |
| 16994 | @cindex remote serial debugging summary |
| 16995 | In summary, when your program is ready to debug, you must follow these |
| 16996 | steps. |
| 16997 | |
| 16998 | @enumerate |
| 16999 | @item |
| 17000 | Make sure you have defined the supporting low-level routines |
| 17001 | (@pxref{Bootstrapping,,What You Must Do for the Stub}): |
| 17002 | @display |
| 17003 | @code{getDebugChar}, @code{putDebugChar}, |
| 17004 | @code{flush_i_cache}, @code{memset}, @code{exceptionHandler}. |
| 17005 | @end display |
| 17006 | |
| 17007 | @item |
| 17008 | Insert these lines near the top of your program: |
| 17009 | |
| 17010 | @smallexample |
| 17011 | set_debug_traps(); |
| 17012 | breakpoint(); |
| 17013 | @end smallexample |
| 17014 | |
| 17015 | @item |
| 17016 | For the 680x0 stub only, you need to provide a variable called |
| 17017 | @code{exceptionHook}. Normally you just use: |
| 17018 | |
| 17019 | @smallexample |
| 17020 | void (*exceptionHook)() = 0; |
| 17021 | @end smallexample |
| 17022 | |
| 17023 | @noindent |
| 17024 | but if before calling @code{set_debug_traps}, you set it to point to a |
| 17025 | function in your program, that function is called when |
| 17026 | @code{@value{GDBN}} continues after stopping on a trap (for example, bus |
| 17027 | error). The function indicated by @code{exceptionHook} is called with |
| 17028 | one parameter: an @code{int} which is the exception number. |
| 17029 | |
| 17030 | @item |
| 17031 | Compile and link together: your program, the @value{GDBN} debugging stub for |
| 17032 | your target architecture, and the supporting subroutines. |
| 17033 | |
| 17034 | @item |
| 17035 | Make sure you have a serial connection between your target machine and |
| 17036 | the @value{GDBN} host, and identify the serial port on the host. |
| 17037 | |
| 17038 | @item |
| 17039 | @c The "remote" target now provides a `load' command, so we should |
| 17040 | @c document that. FIXME. |
| 17041 | Download your program to your target machine (or get it there by |
| 17042 | whatever means the manufacturer provides), and start it. |
| 17043 | |
| 17044 | @item |
| 17045 | Start @value{GDBN} on the host, and connect to the target |
| 17046 | (@pxref{Connecting,,Connecting to a Remote Target}). |
| 17047 | |
| 17048 | @end enumerate |
| 17049 | |
| 17050 | @node Configurations |
| 17051 | @chapter Configuration-Specific Information |
| 17052 | |
| 17053 | While nearly all @value{GDBN} commands are available for all native and |
| 17054 | cross versions of the debugger, there are some exceptions. This chapter |
| 17055 | describes things that are only available in certain configurations. |
| 17056 | |
| 17057 | There are three major categories of configurations: native |
| 17058 | configurations, where the host and target are the same, embedded |
| 17059 | operating system configurations, which are usually the same for several |
| 17060 | different processor architectures, and bare embedded processors, which |
| 17061 | are quite different from each other. |
| 17062 | |
| 17063 | @menu |
| 17064 | * Native:: |
| 17065 | * Embedded OS:: |
| 17066 | * Embedded Processors:: |
| 17067 | * Architectures:: |
| 17068 | @end menu |
| 17069 | |
| 17070 | @node Native |
| 17071 | @section Native |
| 17072 | |
| 17073 | This section describes details specific to particular native |
| 17074 | configurations. |
| 17075 | |
| 17076 | @menu |
| 17077 | * HP-UX:: HP-UX |
| 17078 | * BSD libkvm Interface:: Debugging BSD kernel memory images |
| 17079 | * SVR4 Process Information:: SVR4 process information |
| 17080 | * DJGPP Native:: Features specific to the DJGPP port |
| 17081 | * Cygwin Native:: Features specific to the Cygwin port |
| 17082 | * Hurd Native:: Features specific to @sc{gnu} Hurd |
| 17083 | * Neutrino:: Features specific to QNX Neutrino |
| 17084 | * Darwin:: Features specific to Darwin |
| 17085 | @end menu |
| 17086 | |
| 17087 | @node HP-UX |
| 17088 | @subsection HP-UX |
| 17089 | |
| 17090 | On HP-UX systems, if you refer to a function or variable name that |
| 17091 | begins with a dollar sign, @value{GDBN} searches for a user or system |
| 17092 | name first, before it searches for a convenience variable. |
| 17093 | |
| 17094 | |
| 17095 | @node BSD libkvm Interface |
| 17096 | @subsection BSD libkvm Interface |
| 17097 | |
| 17098 | @cindex libkvm |
| 17099 | @cindex kernel memory image |
| 17100 | @cindex kernel crash dump |
| 17101 | |
| 17102 | BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory |
| 17103 | interface that provides a uniform interface for accessing kernel virtual |
| 17104 | memory images, including live systems and crash dumps. @value{GDBN} |
| 17105 | uses this interface to allow you to debug live kernels and kernel crash |
| 17106 | dumps on many native BSD configurations. This is implemented as a |
| 17107 | special @code{kvm} debugging target. For debugging a live system, load |
| 17108 | the currently running kernel into @value{GDBN} and connect to the |
| 17109 | @code{kvm} target: |
| 17110 | |
| 17111 | @smallexample |
| 17112 | (@value{GDBP}) @b{target kvm} |
| 17113 | @end smallexample |
| 17114 | |
| 17115 | For debugging crash dumps, provide the file name of the crash dump as an |
| 17116 | argument: |
| 17117 | |
| 17118 | @smallexample |
| 17119 | (@value{GDBP}) @b{target kvm /var/crash/bsd.0} |
| 17120 | @end smallexample |
| 17121 | |
| 17122 | Once connected to the @code{kvm} target, the following commands are |
| 17123 | available: |
| 17124 | |
| 17125 | @table @code |
| 17126 | @kindex kvm |
| 17127 | @item kvm pcb |
| 17128 | Set current context from the @dfn{Process Control Block} (PCB) address. |
| 17129 | |
| 17130 | @item kvm proc |
| 17131 | Set current context from proc address. This command isn't available on |
| 17132 | modern FreeBSD systems. |
| 17133 | @end table |
| 17134 | |
| 17135 | @node SVR4 Process Information |
| 17136 | @subsection SVR4 Process Information |
| 17137 | @cindex /proc |
| 17138 | @cindex examine process image |
| 17139 | @cindex process info via @file{/proc} |
| 17140 | |
| 17141 | Many versions of SVR4 and compatible systems provide a facility called |
| 17142 | @samp{/proc} that can be used to examine the image of a running |
| 17143 | process using file-system subroutines. If @value{GDBN} is configured |
| 17144 | for an operating system with this facility, the command @code{info |
| 17145 | proc} is available to report information about the process running |
| 17146 | your program, or about any process running on your system. @code{info |
| 17147 | proc} works only on SVR4 systems that include the @code{procfs} code. |
| 17148 | This includes, as of this writing, @sc{gnu}/Linux, OSF/1 (Digital |
| 17149 | Unix), Solaris, Irix, and Unixware, but not HP-UX, for example. |
| 17150 | |
| 17151 | @table @code |
| 17152 | @kindex info proc |
| 17153 | @cindex process ID |
| 17154 | @item info proc |
| 17155 | @itemx info proc @var{process-id} |
| 17156 | Summarize available information about any running process. If a |
| 17157 | process ID is specified by @var{process-id}, display information about |
| 17158 | that process; otherwise display information about the program being |
| 17159 | debugged. The summary includes the debugged process ID, the command |
| 17160 | line used to invoke it, its current working directory, and its |
| 17161 | executable file's absolute file name. |
| 17162 | |
| 17163 | On some systems, @var{process-id} can be of the form |
| 17164 | @samp{[@var{pid}]/@var{tid}} which specifies a certain thread ID |
| 17165 | within a process. If the optional @var{pid} part is missing, it means |
| 17166 | a thread from the process being debugged (the leading @samp{/} still |
| 17167 | needs to be present, or else @value{GDBN} will interpret the number as |
| 17168 | a process ID rather than a thread ID). |
| 17169 | |
| 17170 | @item info proc mappings |
| 17171 | @cindex memory address space mappings |
| 17172 | Report the memory address space ranges accessible in the program, with |
| 17173 | information on whether the process has read, write, or execute access |
| 17174 | rights to each range. On @sc{gnu}/Linux systems, each memory range |
| 17175 | includes the object file which is mapped to that range, instead of the |
| 17176 | memory access rights to that range. |
| 17177 | |
| 17178 | @item info proc stat |
| 17179 | @itemx info proc status |
| 17180 | @cindex process detailed status information |
| 17181 | These subcommands are specific to @sc{gnu}/Linux systems. They show |
| 17182 | the process-related information, including the user ID and group ID; |
| 17183 | how many threads are there in the process; its virtual memory usage; |
| 17184 | the signals that are pending, blocked, and ignored; its TTY; its |
| 17185 | consumption of system and user time; its stack size; its @samp{nice} |
| 17186 | value; etc. For more information, see the @samp{proc} man page |
| 17187 | (type @kbd{man 5 proc} from your shell prompt). |
| 17188 | |
| 17189 | @item info proc all |
| 17190 | Show all the information about the process described under all of the |
| 17191 | above @code{info proc} subcommands. |
| 17192 | |
| 17193 | @ignore |
| 17194 | @comment These sub-options of 'info proc' were not included when |
| 17195 | @comment procfs.c was re-written. Keep their descriptions around |
| 17196 | @comment against the day when someone finds the time to put them back in. |
| 17197 | @kindex info proc times |
| 17198 | @item info proc times |
| 17199 | Starting time, user CPU time, and system CPU time for your program and |
| 17200 | its children. |
| 17201 | |
| 17202 | @kindex info proc id |
| 17203 | @item info proc id |
| 17204 | Report on the process IDs related to your program: its own process ID, |
| 17205 | the ID of its parent, the process group ID, and the session ID. |
| 17206 | @end ignore |
| 17207 | |
| 17208 | @item set procfs-trace |
| 17209 | @kindex set procfs-trace |
| 17210 | @cindex @code{procfs} API calls |
| 17211 | This command enables and disables tracing of @code{procfs} API calls. |
| 17212 | |
| 17213 | @item show procfs-trace |
| 17214 | @kindex show procfs-trace |
| 17215 | Show the current state of @code{procfs} API call tracing. |
| 17216 | |
| 17217 | @item set procfs-file @var{file} |
| 17218 | @kindex set procfs-file |
| 17219 | Tell @value{GDBN} to write @code{procfs} API trace to the named |
| 17220 | @var{file}. @value{GDBN} appends the trace info to the previous |
| 17221 | contents of the file. The default is to display the trace on the |
| 17222 | standard output. |
| 17223 | |
| 17224 | @item show procfs-file |
| 17225 | @kindex show procfs-file |
| 17226 | Show the file to which @code{procfs} API trace is written. |
| 17227 | |
| 17228 | @item proc-trace-entry |
| 17229 | @itemx proc-trace-exit |
| 17230 | @itemx proc-untrace-entry |
| 17231 | @itemx proc-untrace-exit |
| 17232 | @kindex proc-trace-entry |
| 17233 | @kindex proc-trace-exit |
| 17234 | @kindex proc-untrace-entry |
| 17235 | @kindex proc-untrace-exit |
| 17236 | These commands enable and disable tracing of entries into and exits |
| 17237 | from the @code{syscall} interface. |
| 17238 | |
| 17239 | @item info pidlist |
| 17240 | @kindex info pidlist |
| 17241 | @cindex process list, QNX Neutrino |
| 17242 | For QNX Neutrino only, this command displays the list of all the |
| 17243 | processes and all the threads within each process. |
| 17244 | |
| 17245 | @item info meminfo |
| 17246 | @kindex info meminfo |
| 17247 | @cindex mapinfo list, QNX Neutrino |
| 17248 | For QNX Neutrino only, this command displays the list of all mapinfos. |
| 17249 | @end table |
| 17250 | |
| 17251 | @node DJGPP Native |
| 17252 | @subsection Features for Debugging @sc{djgpp} Programs |
| 17253 | @cindex @sc{djgpp} debugging |
| 17254 | @cindex native @sc{djgpp} debugging |
| 17255 | @cindex MS-DOS-specific commands |
| 17256 | |
| 17257 | @cindex DPMI |
| 17258 | @sc{djgpp} is a port of the @sc{gnu} development tools to MS-DOS and |
| 17259 | MS-Windows. @sc{djgpp} programs are 32-bit protected-mode programs |
| 17260 | that use the @dfn{DPMI} (DOS Protected-Mode Interface) API to run on |
| 17261 | top of real-mode DOS systems and their emulations. |
| 17262 | |
| 17263 | @value{GDBN} supports native debugging of @sc{djgpp} programs, and |
| 17264 | defines a few commands specific to the @sc{djgpp} port. This |
| 17265 | subsection describes those commands. |
| 17266 | |
| 17267 | @table @code |
| 17268 | @kindex info dos |
| 17269 | @item info dos |
| 17270 | This is a prefix of @sc{djgpp}-specific commands which print |
| 17271 | information about the target system and important OS structures. |
| 17272 | |
| 17273 | @kindex sysinfo |
| 17274 | @cindex MS-DOS system info |
| 17275 | @cindex free memory information (MS-DOS) |
| 17276 | @item info dos sysinfo |
| 17277 | This command displays assorted information about the underlying |
| 17278 | platform: the CPU type and features, the OS version and flavor, the |
| 17279 | DPMI version, and the available conventional and DPMI memory. |
| 17280 | |
| 17281 | @cindex GDT |
| 17282 | @cindex LDT |
| 17283 | @cindex IDT |
| 17284 | @cindex segment descriptor tables |
| 17285 | @cindex descriptor tables display |
| 17286 | @item info dos gdt |
| 17287 | @itemx info dos ldt |
| 17288 | @itemx info dos idt |
| 17289 | These 3 commands display entries from, respectively, Global, Local, |
| 17290 | and Interrupt Descriptor Tables (GDT, LDT, and IDT). The descriptor |
| 17291 | tables are data structures which store a descriptor for each segment |
| 17292 | that is currently in use. The segment's selector is an index into a |
| 17293 | descriptor table; the table entry for that index holds the |
| 17294 | descriptor's base address and limit, and its attributes and access |
| 17295 | rights. |
| 17296 | |
| 17297 | A typical @sc{djgpp} program uses 3 segments: a code segment, a data |
| 17298 | segment (used for both data and the stack), and a DOS segment (which |
| 17299 | allows access to DOS/BIOS data structures and absolute addresses in |
| 17300 | conventional memory). However, the DPMI host will usually define |
| 17301 | additional segments in order to support the DPMI environment. |
| 17302 | |
| 17303 | @cindex garbled pointers |
| 17304 | These commands allow to display entries from the descriptor tables. |
| 17305 | Without an argument, all entries from the specified table are |
| 17306 | displayed. An argument, which should be an integer expression, means |
| 17307 | display a single entry whose index is given by the argument. For |
| 17308 | example, here's a convenient way to display information about the |
| 17309 | debugged program's data segment: |
| 17310 | |
| 17311 | @smallexample |
| 17312 | @exdent @code{(@value{GDBP}) info dos ldt $ds} |
| 17313 | @exdent @code{0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write, Exp-up)} |
| 17314 | @end smallexample |
| 17315 | |
| 17316 | @noindent |
| 17317 | This comes in handy when you want to see whether a pointer is outside |
| 17318 | the data segment's limit (i.e.@: @dfn{garbled}). |
| 17319 | |
| 17320 | @cindex page tables display (MS-DOS) |
| 17321 | @item info dos pde |
| 17322 | @itemx info dos pte |
| 17323 | These two commands display entries from, respectively, the Page |
| 17324 | Directory and the Page Tables. Page Directories and Page Tables are |
| 17325 | data structures which control how virtual memory addresses are mapped |
| 17326 | into physical addresses. A Page Table includes an entry for every |
| 17327 | page of memory that is mapped into the program's address space; there |
| 17328 | may be several Page Tables, each one holding up to 4096 entries. A |
| 17329 | Page Directory has up to 4096 entries, one each for every Page Table |
| 17330 | that is currently in use. |
| 17331 | |
| 17332 | Without an argument, @kbd{info dos pde} displays the entire Page |
| 17333 | Directory, and @kbd{info dos pte} displays all the entries in all of |
| 17334 | the Page Tables. An argument, an integer expression, given to the |
| 17335 | @kbd{info dos pde} command means display only that entry from the Page |
| 17336 | Directory table. An argument given to the @kbd{info dos pte} command |
| 17337 | means display entries from a single Page Table, the one pointed to by |
| 17338 | the specified entry in the Page Directory. |
| 17339 | |
| 17340 | @cindex direct memory access (DMA) on MS-DOS |
| 17341 | These commands are useful when your program uses @dfn{DMA} (Direct |
| 17342 | Memory Access), which needs physical addresses to program the DMA |
| 17343 | controller. |
| 17344 | |
| 17345 | These commands are supported only with some DPMI servers. |
| 17346 | |
| 17347 | @cindex physical address from linear address |
| 17348 | @item info dos address-pte @var{addr} |
| 17349 | This command displays the Page Table entry for a specified linear |
| 17350 | address. The argument @var{addr} is a linear address which should |
| 17351 | already have the appropriate segment's base address added to it, |
| 17352 | because this command accepts addresses which may belong to @emph{any} |
| 17353 | segment. For example, here's how to display the Page Table entry for |
| 17354 | the page where a variable @code{i} is stored: |
| 17355 | |
| 17356 | @smallexample |
| 17357 | @exdent @code{(@value{GDBP}) info dos address-pte __djgpp_base_address + (char *)&i} |
| 17358 | @exdent @code{Page Table entry for address 0x11a00d30:} |
| 17359 | @exdent @code{Base=0x02698000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0xd30} |
| 17360 | @end smallexample |
| 17361 | |
| 17362 | @noindent |
| 17363 | This says that @code{i} is stored at offset @code{0xd30} from the page |
| 17364 | whose physical base address is @code{0x02698000}, and shows all the |
| 17365 | attributes of that page. |
| 17366 | |
| 17367 | Note that you must cast the addresses of variables to a @code{char *}, |
| 17368 | since otherwise the value of @code{__djgpp_base_address}, the base |
| 17369 | address of all variables and functions in a @sc{djgpp} program, will |
| 17370 | be added using the rules of C pointer arithmetics: if @code{i} is |
| 17371 | declared an @code{int}, @value{GDBN} will add 4 times the value of |
| 17372 | @code{__djgpp_base_address} to the address of @code{i}. |
| 17373 | |
| 17374 | Here's another example, it displays the Page Table entry for the |
| 17375 | transfer buffer: |
| 17376 | |
| 17377 | @smallexample |
| 17378 | @exdent @code{(@value{GDBP}) info dos address-pte *((unsigned *)&_go32_info_block + 3)} |
| 17379 | @exdent @code{Page Table entry for address 0x29110:} |
| 17380 | @exdent @code{Base=0x00029000 Dirty Acc. Not-Cached Write-Back Usr Read-Write +0x110} |
| 17381 | @end smallexample |
| 17382 | |
| 17383 | @noindent |
| 17384 | (The @code{+ 3} offset is because the transfer buffer's address is the |
| 17385 | 3rd member of the @code{_go32_info_block} structure.) The output |
| 17386 | clearly shows that this DPMI server maps the addresses in conventional |
| 17387 | memory 1:1, i.e.@: the physical (@code{0x00029000} + @code{0x110}) and |
| 17388 | linear (@code{0x29110}) addresses are identical. |
| 17389 | |
| 17390 | This command is supported only with some DPMI servers. |
| 17391 | @end table |
| 17392 | |
| 17393 | @cindex DOS serial data link, remote debugging |
| 17394 | In addition to native debugging, the DJGPP port supports remote |
| 17395 | debugging via a serial data link. The following commands are specific |
| 17396 | to remote serial debugging in the DJGPP port of @value{GDBN}. |
| 17397 | |
| 17398 | @table @code |
| 17399 | @kindex set com1base |
| 17400 | @kindex set com1irq |
| 17401 | @kindex set com2base |
| 17402 | @kindex set com2irq |
| 17403 | @kindex set com3base |
| 17404 | @kindex set com3irq |
| 17405 | @kindex set com4base |
| 17406 | @kindex set com4irq |
| 17407 | @item set com1base @var{addr} |
| 17408 | This command sets the base I/O port address of the @file{COM1} serial |
| 17409 | port. |
| 17410 | |
| 17411 | @item set com1irq @var{irq} |
| 17412 | This command sets the @dfn{Interrupt Request} (@code{IRQ}) line to use |
| 17413 | for the @file{COM1} serial port. |
| 17414 | |
| 17415 | There are similar commands @samp{set com2base}, @samp{set com3irq}, |
| 17416 | etc.@: for setting the port address and the @code{IRQ} lines for the |
| 17417 | other 3 COM ports. |
| 17418 | |
| 17419 | @kindex show com1base |
| 17420 | @kindex show com1irq |
| 17421 | @kindex show com2base |
| 17422 | @kindex show com2irq |
| 17423 | @kindex show com3base |
| 17424 | @kindex show com3irq |
| 17425 | @kindex show com4base |
| 17426 | @kindex show com4irq |
| 17427 | The related commands @samp{show com1base}, @samp{show com1irq} etc.@: |
| 17428 | display the current settings of the base address and the @code{IRQ} |
| 17429 | lines used by the COM ports. |
| 17430 | |
| 17431 | @item info serial |
| 17432 | @kindex info serial |
| 17433 | @cindex DOS serial port status |
| 17434 | This command prints the status of the 4 DOS serial ports. For each |
| 17435 | port, it prints whether it's active or not, its I/O base address and |
| 17436 | IRQ number, whether it uses a 16550-style FIFO, its baudrate, and the |
| 17437 | counts of various errors encountered so far. |
| 17438 | @end table |
| 17439 | |
| 17440 | |
| 17441 | @node Cygwin Native |
| 17442 | @subsection Features for Debugging MS Windows PE Executables |
| 17443 | @cindex MS Windows debugging |
| 17444 | @cindex native Cygwin debugging |
| 17445 | @cindex Cygwin-specific commands |
| 17446 | |
| 17447 | @value{GDBN} supports native debugging of MS Windows programs, including |
| 17448 | DLLs with and without symbolic debugging information. |
| 17449 | |
| 17450 | @cindex Ctrl-BREAK, MS-Windows |
| 17451 | @cindex interrupt debuggee on MS-Windows |
| 17452 | MS-Windows programs that call @code{SetConsoleMode} to switch off the |
| 17453 | special meaning of the @samp{Ctrl-C} keystroke cannot be interrupted |
| 17454 | by typing @kbd{C-c}. For this reason, @value{GDBN} on MS-Windows |
| 17455 | supports @kbd{C-@key{BREAK}} as an alternative interrupt key |
| 17456 | sequence, which can be used to interrupt the debuggee even if it |
| 17457 | ignores @kbd{C-c}. |
| 17458 | |
| 17459 | There are various additional Cygwin-specific commands, described in |
| 17460 | this section. Working with DLLs that have no debugging symbols is |
| 17461 | described in @ref{Non-debug DLL Symbols}. |
| 17462 | |
| 17463 | @table @code |
| 17464 | @kindex info w32 |
| 17465 | @item info w32 |
| 17466 | This is a prefix of MS Windows-specific commands which print |
| 17467 | information about the target system and important OS structures. |
| 17468 | |
| 17469 | @item info w32 selector |
| 17470 | This command displays information returned by |
| 17471 | the Win32 API @code{GetThreadSelectorEntry} function. |
| 17472 | It takes an optional argument that is evaluated to |
| 17473 | a long value to give the information about this given selector. |
| 17474 | Without argument, this command displays information |
| 17475 | about the six segment registers. |
| 17476 | |
| 17477 | @item info w32 thread-information-block |
| 17478 | This command displays thread specific information stored in the |
| 17479 | Thread Information Block (readable on the X86 CPU family using @code{$fs} |
| 17480 | selector for 32-bit programs and @code{$gs} for 64-bit programs). |
| 17481 | |
| 17482 | @kindex info dll |
| 17483 | @item info dll |
| 17484 | This is a Cygwin-specific alias of @code{info shared}. |
| 17485 | |
| 17486 | @kindex dll-symbols |
| 17487 | @item dll-symbols |
| 17488 | This command loads symbols from a dll similarly to |
| 17489 | add-sym command but without the need to specify a base address. |
| 17490 | |
| 17491 | @kindex set cygwin-exceptions |
| 17492 | @cindex debugging the Cygwin DLL |
| 17493 | @cindex Cygwin DLL, debugging |
| 17494 | @item set cygwin-exceptions @var{mode} |
| 17495 | If @var{mode} is @code{on}, @value{GDBN} will break on exceptions that |
| 17496 | happen inside the Cygwin DLL. If @var{mode} is @code{off}, |
| 17497 | @value{GDBN} will delay recognition of exceptions, and may ignore some |
| 17498 | exceptions which seem to be caused by internal Cygwin DLL |
| 17499 | ``bookkeeping''. This option is meant primarily for debugging the |
| 17500 | Cygwin DLL itself; the default value is @code{off} to avoid annoying |
| 17501 | @value{GDBN} users with false @code{SIGSEGV} signals. |
| 17502 | |
| 17503 | @kindex show cygwin-exceptions |
| 17504 | @item show cygwin-exceptions |
| 17505 | Displays whether @value{GDBN} will break on exceptions that happen |
| 17506 | inside the Cygwin DLL itself. |
| 17507 | |
| 17508 | @kindex set new-console |
| 17509 | @item set new-console @var{mode} |
| 17510 | If @var{mode} is @code{on} the debuggee will |
| 17511 | be started in a new console on next start. |
| 17512 | If @var{mode} is @code{off}, the debuggee will |
| 17513 | be started in the same console as the debugger. |
| 17514 | |
| 17515 | @kindex show new-console |
| 17516 | @item show new-console |
| 17517 | Displays whether a new console is used |
| 17518 | when the debuggee is started. |
| 17519 | |
| 17520 | @kindex set new-group |
| 17521 | @item set new-group @var{mode} |
| 17522 | This boolean value controls whether the debuggee should |
| 17523 | start a new group or stay in the same group as the debugger. |
| 17524 | This affects the way the Windows OS handles |
| 17525 | @samp{Ctrl-C}. |
| 17526 | |
| 17527 | @kindex show new-group |
| 17528 | @item show new-group |
| 17529 | Displays current value of new-group boolean. |
| 17530 | |
| 17531 | @kindex set debugevents |
| 17532 | @item set debugevents |
| 17533 | This boolean value adds debug output concerning kernel events related |
| 17534 | to the debuggee seen by the debugger. This includes events that |
| 17535 | signal thread and process creation and exit, DLL loading and |
| 17536 | unloading, console interrupts, and debugging messages produced by the |
| 17537 | Windows @code{OutputDebugString} API call. |
| 17538 | |
| 17539 | @kindex set debugexec |
| 17540 | @item set debugexec |
| 17541 | This boolean value adds debug output concerning execute events |
| 17542 | (such as resume thread) seen by the debugger. |
| 17543 | |
| 17544 | @kindex set debugexceptions |
| 17545 | @item set debugexceptions |
| 17546 | This boolean value adds debug output concerning exceptions in the |
| 17547 | debuggee seen by the debugger. |
| 17548 | |
| 17549 | @kindex set debugmemory |
| 17550 | @item set debugmemory |
| 17551 | This boolean value adds debug output concerning debuggee memory reads |
| 17552 | and writes by the debugger. |
| 17553 | |
| 17554 | @kindex set shell |
| 17555 | @item set shell |
| 17556 | This boolean values specifies whether the debuggee is called |
| 17557 | via a shell or directly (default value is on). |
| 17558 | |
| 17559 | @kindex show shell |
| 17560 | @item show shell |
| 17561 | Displays if the debuggee will be started with a shell. |
| 17562 | |
| 17563 | @end table |
| 17564 | |
| 17565 | @menu |
| 17566 | * Non-debug DLL Symbols:: Support for DLLs without debugging symbols |
| 17567 | @end menu |
| 17568 | |
| 17569 | @node Non-debug DLL Symbols |
| 17570 | @subsubsection Support for DLLs without Debugging Symbols |
| 17571 | @cindex DLLs with no debugging symbols |
| 17572 | @cindex Minimal symbols and DLLs |
| 17573 | |
| 17574 | Very often on windows, some of the DLLs that your program relies on do |
| 17575 | not include symbolic debugging information (for example, |
| 17576 | @file{kernel32.dll}). When @value{GDBN} doesn't recognize any debugging |
| 17577 | symbols in a DLL, it relies on the minimal amount of symbolic |
| 17578 | information contained in the DLL's export table. This section |
| 17579 | describes working with such symbols, known internally to @value{GDBN} as |
| 17580 | ``minimal symbols''. |
| 17581 | |
| 17582 | Note that before the debugged program has started execution, no DLLs |
| 17583 | will have been loaded. The easiest way around this problem is simply to |
| 17584 | start the program --- either by setting a breakpoint or letting the |
| 17585 | program run once to completion. It is also possible to force |
| 17586 | @value{GDBN} to load a particular DLL before starting the executable --- |
| 17587 | see the shared library information in @ref{Files}, or the |
| 17588 | @code{dll-symbols} command in @ref{Cygwin Native}. Currently, |
| 17589 | explicitly loading symbols from a DLL with no debugging information will |
| 17590 | cause the symbol names to be duplicated in @value{GDBN}'s lookup table, |
| 17591 | which may adversely affect symbol lookup performance. |
| 17592 | |
| 17593 | @subsubsection DLL Name Prefixes |
| 17594 | |
| 17595 | In keeping with the naming conventions used by the Microsoft debugging |
| 17596 | tools, DLL export symbols are made available with a prefix based on the |
| 17597 | DLL name, for instance @code{KERNEL32!CreateFileA}. The plain name is |
| 17598 | also entered into the symbol table, so @code{CreateFileA} is often |
| 17599 | sufficient. In some cases there will be name clashes within a program |
| 17600 | (particularly if the executable itself includes full debugging symbols) |
| 17601 | necessitating the use of the fully qualified name when referring to the |
| 17602 | contents of the DLL. Use single-quotes around the name to avoid the |
| 17603 | exclamation mark (``!'') being interpreted as a language operator. |
| 17604 | |
| 17605 | Note that the internal name of the DLL may be all upper-case, even |
| 17606 | though the file name of the DLL is lower-case, or vice-versa. Since |
| 17607 | symbols within @value{GDBN} are @emph{case-sensitive} this may cause |
| 17608 | some confusion. If in doubt, try the @code{info functions} and |
| 17609 | @code{info variables} commands or even @code{maint print msymbols} |
| 17610 | (@pxref{Symbols}). Here's an example: |
| 17611 | |
| 17612 | @smallexample |
| 17613 | (@value{GDBP}) info function CreateFileA |
| 17614 | All functions matching regular expression "CreateFileA": |
| 17615 | |
| 17616 | Non-debugging symbols: |
| 17617 | 0x77e885f4 CreateFileA |
| 17618 | 0x77e885f4 KERNEL32!CreateFileA |
| 17619 | @end smallexample |
| 17620 | |
| 17621 | @smallexample |
| 17622 | (@value{GDBP}) info function ! |
| 17623 | All functions matching regular expression "!": |
| 17624 | |
| 17625 | Non-debugging symbols: |
| 17626 | 0x6100114c cygwin1!__assert |
| 17627 | 0x61004034 cygwin1!_dll_crt0@@0 |
| 17628 | 0x61004240 cygwin1!dll_crt0(per_process *) |
| 17629 | [etc...] |
| 17630 | @end smallexample |
| 17631 | |
| 17632 | @subsubsection Working with Minimal Symbols |
| 17633 | |
| 17634 | Symbols extracted from a DLL's export table do not contain very much |
| 17635 | type information. All that @value{GDBN} can do is guess whether a symbol |
| 17636 | refers to a function or variable depending on the linker section that |
| 17637 | contains the symbol. Also note that the actual contents of the memory |
| 17638 | contained in a DLL are not available unless the program is running. This |
| 17639 | means that you cannot examine the contents of a variable or disassemble |
| 17640 | a function within a DLL without a running program. |
| 17641 | |
| 17642 | Variables are generally treated as pointers and dereferenced |
| 17643 | automatically. For this reason, it is often necessary to prefix a |
| 17644 | variable name with the address-of operator (``&'') and provide explicit |
| 17645 | type information in the command. Here's an example of the type of |
| 17646 | problem: |
| 17647 | |
| 17648 | @smallexample |
| 17649 | (@value{GDBP}) print 'cygwin1!__argv' |
| 17650 | $1 = 268572168 |
| 17651 | @end smallexample |
| 17652 | |
| 17653 | @smallexample |
| 17654 | (@value{GDBP}) x 'cygwin1!__argv' |
| 17655 | 0x10021610: "\230y\"" |
| 17656 | @end smallexample |
| 17657 | |
| 17658 | And two possible solutions: |
| 17659 | |
| 17660 | @smallexample |
| 17661 | (@value{GDBP}) print ((char **)'cygwin1!__argv')[0] |
| 17662 | $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram" |
| 17663 | @end smallexample |
| 17664 | |
| 17665 | @smallexample |
| 17666 | (@value{GDBP}) x/2x &'cygwin1!__argv' |
| 17667 | 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000 |
| 17668 | (@value{GDBP}) x/x 0x10021608 |
| 17669 | 0x10021608: 0x0022fd98 |
| 17670 | (@value{GDBP}) x/s 0x0022fd98 |
| 17671 | 0x22fd98: "/cygdrive/c/mydirectory/myprogram" |
| 17672 | @end smallexample |
| 17673 | |
| 17674 | Setting a break point within a DLL is possible even before the program |
| 17675 | starts execution. However, under these circumstances, @value{GDBN} can't |
| 17676 | examine the initial instructions of the function in order to skip the |
| 17677 | function's frame set-up code. You can work around this by using ``*&'' |
| 17678 | to set the breakpoint at a raw memory address: |
| 17679 | |
| 17680 | @smallexample |
| 17681 | (@value{GDBP}) break *&'python22!PyOS_Readline' |
| 17682 | Breakpoint 1 at 0x1e04eff0 |
| 17683 | @end smallexample |
| 17684 | |
| 17685 | The author of these extensions is not entirely convinced that setting a |
| 17686 | break point within a shared DLL like @file{kernel32.dll} is completely |
| 17687 | safe. |
| 17688 | |
| 17689 | @node Hurd Native |
| 17690 | @subsection Commands Specific to @sc{gnu} Hurd Systems |
| 17691 | @cindex @sc{gnu} Hurd debugging |
| 17692 | |
| 17693 | This subsection describes @value{GDBN} commands specific to the |
| 17694 | @sc{gnu} Hurd native debugging. |
| 17695 | |
| 17696 | @table @code |
| 17697 | @item set signals |
| 17698 | @itemx set sigs |
| 17699 | @kindex set signals@r{, Hurd command} |
| 17700 | @kindex set sigs@r{, Hurd command} |
| 17701 | This command toggles the state of inferior signal interception by |
| 17702 | @value{GDBN}. Mach exceptions, such as breakpoint traps, are not |
| 17703 | affected by this command. @code{sigs} is a shorthand alias for |
| 17704 | @code{signals}. |
| 17705 | |
| 17706 | @item show signals |
| 17707 | @itemx show sigs |
| 17708 | @kindex show signals@r{, Hurd command} |
| 17709 | @kindex show sigs@r{, Hurd command} |
| 17710 | Show the current state of intercepting inferior's signals. |
| 17711 | |
| 17712 | @item set signal-thread |
| 17713 | @itemx set sigthread |
| 17714 | @kindex set signal-thread |
| 17715 | @kindex set sigthread |
| 17716 | This command tells @value{GDBN} which thread is the @code{libc} signal |
| 17717 | thread. That thread is run when a signal is delivered to a running |
| 17718 | process. @code{set sigthread} is the shorthand alias of @code{set |
| 17719 | signal-thread}. |
| 17720 | |
| 17721 | @item show signal-thread |
| 17722 | @itemx show sigthread |
| 17723 | @kindex show signal-thread |
| 17724 | @kindex show sigthread |
| 17725 | These two commands show which thread will run when the inferior is |
| 17726 | delivered a signal. |
| 17727 | |
| 17728 | @item set stopped |
| 17729 | @kindex set stopped@r{, Hurd command} |
| 17730 | This commands tells @value{GDBN} that the inferior process is stopped, |
| 17731 | as with the @code{SIGSTOP} signal. The stopped process can be |
| 17732 | continued by delivering a signal to it. |
| 17733 | |
| 17734 | @item show stopped |
| 17735 | @kindex show stopped@r{, Hurd command} |
| 17736 | This command shows whether @value{GDBN} thinks the debuggee is |
| 17737 | stopped. |
| 17738 | |
| 17739 | @item set exceptions |
| 17740 | @kindex set exceptions@r{, Hurd command} |
| 17741 | Use this command to turn off trapping of exceptions in the inferior. |
| 17742 | When exception trapping is off, neither breakpoints nor |
| 17743 | single-stepping will work. To restore the default, set exception |
| 17744 | trapping on. |
| 17745 | |
| 17746 | @item show exceptions |
| 17747 | @kindex show exceptions@r{, Hurd command} |
| 17748 | Show the current state of trapping exceptions in the inferior. |
| 17749 | |
| 17750 | @item set task pause |
| 17751 | @kindex set task@r{, Hurd commands} |
| 17752 | @cindex task attributes (@sc{gnu} Hurd) |
| 17753 | @cindex pause current task (@sc{gnu} Hurd) |
| 17754 | This command toggles task suspension when @value{GDBN} has control. |
| 17755 | Setting it to on takes effect immediately, and the task is suspended |
| 17756 | whenever @value{GDBN} gets control. Setting it to off will take |
| 17757 | effect the next time the inferior is continued. If this option is set |
| 17758 | to off, you can use @code{set thread default pause on} or @code{set |
| 17759 | thread pause on} (see below) to pause individual threads. |
| 17760 | |
| 17761 | @item show task pause |
| 17762 | @kindex show task@r{, Hurd commands} |
| 17763 | Show the current state of task suspension. |
| 17764 | |
| 17765 | @item set task detach-suspend-count |
| 17766 | @cindex task suspend count |
| 17767 | @cindex detach from task, @sc{gnu} Hurd |
| 17768 | This command sets the suspend count the task will be left with when |
| 17769 | @value{GDBN} detaches from it. |
| 17770 | |
| 17771 | @item show task detach-suspend-count |
| 17772 | Show the suspend count the task will be left with when detaching. |
| 17773 | |
| 17774 | @item set task exception-port |
| 17775 | @itemx set task excp |
| 17776 | @cindex task exception port, @sc{gnu} Hurd |
| 17777 | This command sets the task exception port to which @value{GDBN} will |
| 17778 | forward exceptions. The argument should be the value of the @dfn{send |
| 17779 | rights} of the task. @code{set task excp} is a shorthand alias. |
| 17780 | |
| 17781 | @item set noninvasive |
| 17782 | @cindex noninvasive task options |
| 17783 | This command switches @value{GDBN} to a mode that is the least |
| 17784 | invasive as far as interfering with the inferior is concerned. This |
| 17785 | is the same as using @code{set task pause}, @code{set exceptions}, and |
| 17786 | @code{set signals} to values opposite to the defaults. |
| 17787 | |
| 17788 | @item info send-rights |
| 17789 | @itemx info receive-rights |
| 17790 | @itemx info port-rights |
| 17791 | @itemx info port-sets |
| 17792 | @itemx info dead-names |
| 17793 | @itemx info ports |
| 17794 | @itemx info psets |
| 17795 | @cindex send rights, @sc{gnu} Hurd |
| 17796 | @cindex receive rights, @sc{gnu} Hurd |
| 17797 | @cindex port rights, @sc{gnu} Hurd |
| 17798 | @cindex port sets, @sc{gnu} Hurd |
| 17799 | @cindex dead names, @sc{gnu} Hurd |
| 17800 | These commands display information about, respectively, send rights, |
| 17801 | receive rights, port rights, port sets, and dead names of a task. |
| 17802 | There are also shorthand aliases: @code{info ports} for @code{info |
| 17803 | port-rights} and @code{info psets} for @code{info port-sets}. |
| 17804 | |
| 17805 | @item set thread pause |
| 17806 | @kindex set thread@r{, Hurd command} |
| 17807 | @cindex thread properties, @sc{gnu} Hurd |
| 17808 | @cindex pause current thread (@sc{gnu} Hurd) |
| 17809 | This command toggles current thread suspension when @value{GDBN} has |
| 17810 | control. Setting it to on takes effect immediately, and the current |
| 17811 | thread is suspended whenever @value{GDBN} gets control. Setting it to |
| 17812 | off will take effect the next time the inferior is continued. |
| 17813 | Normally, this command has no effect, since when @value{GDBN} has |
| 17814 | control, the whole task is suspended. However, if you used @code{set |
| 17815 | task pause off} (see above), this command comes in handy to suspend |
| 17816 | only the current thread. |
| 17817 | |
| 17818 | @item show thread pause |
| 17819 | @kindex show thread@r{, Hurd command} |
| 17820 | This command shows the state of current thread suspension. |
| 17821 | |
| 17822 | @item set thread run |
| 17823 | This command sets whether the current thread is allowed to run. |
| 17824 | |
| 17825 | @item show thread run |
| 17826 | Show whether the current thread is allowed to run. |
| 17827 | |
| 17828 | @item set thread detach-suspend-count |
| 17829 | @cindex thread suspend count, @sc{gnu} Hurd |
| 17830 | @cindex detach from thread, @sc{gnu} Hurd |
| 17831 | This command sets the suspend count @value{GDBN} will leave on a |
| 17832 | thread when detaching. This number is relative to the suspend count |
| 17833 | found by @value{GDBN} when it notices the thread; use @code{set thread |
| 17834 | takeover-suspend-count} to force it to an absolute value. |
| 17835 | |
| 17836 | @item show thread detach-suspend-count |
| 17837 | Show the suspend count @value{GDBN} will leave on the thread when |
| 17838 | detaching. |
| 17839 | |
| 17840 | @item set thread exception-port |
| 17841 | @itemx set thread excp |
| 17842 | Set the thread exception port to which to forward exceptions. This |
| 17843 | overrides the port set by @code{set task exception-port} (see above). |
| 17844 | @code{set thread excp} is the shorthand alias. |
| 17845 | |
| 17846 | @item set thread takeover-suspend-count |
| 17847 | Normally, @value{GDBN}'s thread suspend counts are relative to the |
| 17848 | value @value{GDBN} finds when it notices each thread. This command |
| 17849 | changes the suspend counts to be absolute instead. |
| 17850 | |
| 17851 | @item set thread default |
| 17852 | @itemx show thread default |
| 17853 | @cindex thread default settings, @sc{gnu} Hurd |
| 17854 | Each of the above @code{set thread} commands has a @code{set thread |
| 17855 | default} counterpart (e.g., @code{set thread default pause}, @code{set |
| 17856 | thread default exception-port}, etc.). The @code{thread default} |
| 17857 | variety of commands sets the default thread properties for all |
| 17858 | threads; you can then change the properties of individual threads with |
| 17859 | the non-default commands. |
| 17860 | @end table |
| 17861 | |
| 17862 | |
| 17863 | @node Neutrino |
| 17864 | @subsection QNX Neutrino |
| 17865 | @cindex QNX Neutrino |
| 17866 | |
| 17867 | @value{GDBN} provides the following commands specific to the QNX |
| 17868 | Neutrino target: |
| 17869 | |
| 17870 | @table @code |
| 17871 | @item set debug nto-debug |
| 17872 | @kindex set debug nto-debug |
| 17873 | When set to on, enables debugging messages specific to the QNX |
| 17874 | Neutrino support. |
| 17875 | |
| 17876 | @item show debug nto-debug |
| 17877 | @kindex show debug nto-debug |
| 17878 | Show the current state of QNX Neutrino messages. |
| 17879 | @end table |
| 17880 | |
| 17881 | @node Darwin |
| 17882 | @subsection Darwin |
| 17883 | @cindex Darwin |
| 17884 | |
| 17885 | @value{GDBN} provides the following commands specific to the Darwin target: |
| 17886 | |
| 17887 | @table @code |
| 17888 | @item set debug darwin @var{num} |
| 17889 | @kindex set debug darwin |
| 17890 | When set to a non zero value, enables debugging messages specific to |
| 17891 | the Darwin support. Higher values produce more verbose output. |
| 17892 | |
| 17893 | @item show debug darwin |
| 17894 | @kindex show debug darwin |
| 17895 | Show the current state of Darwin messages. |
| 17896 | |
| 17897 | @item set debug mach-o @var{num} |
| 17898 | @kindex set debug mach-o |
| 17899 | When set to a non zero value, enables debugging messages while |
| 17900 | @value{GDBN} is reading Darwin object files. (@dfn{Mach-O} is the |
| 17901 | file format used on Darwin for object and executable files.) Higher |
| 17902 | values produce more verbose output. This is a command to diagnose |
| 17903 | problems internal to @value{GDBN} and should not be needed in normal |
| 17904 | usage. |
| 17905 | |
| 17906 | @item show debug mach-o |
| 17907 | @kindex show debug mach-o |
| 17908 | Show the current state of Mach-O file messages. |
| 17909 | |
| 17910 | @item set mach-exceptions on |
| 17911 | @itemx set mach-exceptions off |
| 17912 | @kindex set mach-exceptions |
| 17913 | On Darwin, faults are first reported as a Mach exception and are then |
| 17914 | mapped to a Posix signal. Use this command to turn on trapping of |
| 17915 | Mach exceptions in the inferior. This might be sometimes useful to |
| 17916 | better understand the cause of a fault. The default is off. |
| 17917 | |
| 17918 | @item show mach-exceptions |
| 17919 | @kindex show mach-exceptions |
| 17920 | Show the current state of exceptions trapping. |
| 17921 | @end table |
| 17922 | |
| 17923 | |
| 17924 | @node Embedded OS |
| 17925 | @section Embedded Operating Systems |
| 17926 | |
| 17927 | This section describes configurations involving the debugging of |
| 17928 | embedded operating systems that are available for several different |
| 17929 | architectures. |
| 17930 | |
| 17931 | @menu |
| 17932 | * VxWorks:: Using @value{GDBN} with VxWorks |
| 17933 | @end menu |
| 17934 | |
| 17935 | @value{GDBN} includes the ability to debug programs running on |
| 17936 | various real-time operating systems. |
| 17937 | |
| 17938 | @node VxWorks |
| 17939 | @subsection Using @value{GDBN} with VxWorks |
| 17940 | |
| 17941 | @cindex VxWorks |
| 17942 | |
| 17943 | @table @code |
| 17944 | |
| 17945 | @kindex target vxworks |
| 17946 | @item target vxworks @var{machinename} |
| 17947 | A VxWorks system, attached via TCP/IP. The argument @var{machinename} |
| 17948 | is the target system's machine name or IP address. |
| 17949 | |
| 17950 | @end table |
| 17951 | |
| 17952 | On VxWorks, @code{load} links @var{filename} dynamically on the |
| 17953 | current target system as well as adding its symbols in @value{GDBN}. |
| 17954 | |
| 17955 | @value{GDBN} enables developers to spawn and debug tasks running on networked |
| 17956 | VxWorks targets from a Unix host. Already-running tasks spawned from |
| 17957 | the VxWorks shell can also be debugged. @value{GDBN} uses code that runs on |
| 17958 | both the Unix host and on the VxWorks target. The program |
| 17959 | @code{@value{GDBP}} is installed and executed on the Unix host. (It may be |
| 17960 | installed with the name @code{vxgdb}, to distinguish it from a |
| 17961 | @value{GDBN} for debugging programs on the host itself.) |
| 17962 | |
| 17963 | @table @code |
| 17964 | @item VxWorks-timeout @var{args} |
| 17965 | @kindex vxworks-timeout |
| 17966 | All VxWorks-based targets now support the option @code{vxworks-timeout}. |
| 17967 | This option is set by the user, and @var{args} represents the number of |
| 17968 | seconds @value{GDBN} waits for responses to rpc's. You might use this if |
| 17969 | your VxWorks target is a slow software simulator or is on the far side |
| 17970 | of a thin network line. |
| 17971 | @end table |
| 17972 | |
| 17973 | The following information on connecting to VxWorks was current when |
| 17974 | this manual was produced; newer releases of VxWorks may use revised |
| 17975 | procedures. |
| 17976 | |
| 17977 | @findex INCLUDE_RDB |
| 17978 | To use @value{GDBN} with VxWorks, you must rebuild your VxWorks kernel |
| 17979 | to include the remote debugging interface routines in the VxWorks |
| 17980 | library @file{rdb.a}. To do this, define @code{INCLUDE_RDB} in the |
| 17981 | VxWorks configuration file @file{configAll.h} and rebuild your VxWorks |
| 17982 | kernel. The resulting kernel contains @file{rdb.a}, and spawns the |
| 17983 | source debugging task @code{tRdbTask} when VxWorks is booted. For more |
| 17984 | information on configuring and remaking VxWorks, see the manufacturer's |
| 17985 | manual. |
| 17986 | @c VxWorks, see the @cite{VxWorks Programmer's Guide}. |
| 17987 | |
| 17988 | Once you have included @file{rdb.a} in your VxWorks system image and set |
| 17989 | your Unix execution search path to find @value{GDBN}, you are ready to |
| 17990 | run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} (or |
| 17991 | @code{vxgdb}, depending on your installation). |
| 17992 | |
| 17993 | @value{GDBN} comes up showing the prompt: |
| 17994 | |
| 17995 | @smallexample |
| 17996 | (vxgdb) |
| 17997 | @end smallexample |
| 17998 | |
| 17999 | @menu |
| 18000 | * VxWorks Connection:: Connecting to VxWorks |
| 18001 | * VxWorks Download:: VxWorks download |
| 18002 | * VxWorks Attach:: Running tasks |
| 18003 | @end menu |
| 18004 | |
| 18005 | @node VxWorks Connection |
| 18006 | @subsubsection Connecting to VxWorks |
| 18007 | |
| 18008 | The @value{GDBN} command @code{target} lets you connect to a VxWorks target on the |
| 18009 | network. To connect to a target whose host name is ``@code{tt}'', type: |
| 18010 | |
| 18011 | @smallexample |
| 18012 | (vxgdb) target vxworks tt |
| 18013 | @end smallexample |
| 18014 | |
| 18015 | @need 750 |
| 18016 | @value{GDBN} displays messages like these: |
| 18017 | |
| 18018 | @smallexample |
| 18019 | Attaching remote machine across net... |
| 18020 | Connected to tt. |
| 18021 | @end smallexample |
| 18022 | |
| 18023 | @need 1000 |
| 18024 | @value{GDBN} then attempts to read the symbol tables of any object modules |
| 18025 | loaded into the VxWorks target since it was last booted. @value{GDBN} locates |
| 18026 | these files by searching the directories listed in the command search |
| 18027 | path (@pxref{Environment, ,Your Program's Environment}); if it fails |
| 18028 | to find an object file, it displays a message such as: |
| 18029 | |
| 18030 | @smallexample |
| 18031 | prog.o: No such file or directory. |
| 18032 | @end smallexample |
| 18033 | |
| 18034 | When this happens, add the appropriate directory to the search path with |
| 18035 | the @value{GDBN} command @code{path}, and execute the @code{target} |
| 18036 | command again. |
| 18037 | |
| 18038 | @node VxWorks Download |
| 18039 | @subsubsection VxWorks Download |
| 18040 | |
| 18041 | @cindex download to VxWorks |
| 18042 | If you have connected to the VxWorks target and you want to debug an |
| 18043 | object that has not yet been loaded, you can use the @value{GDBN} |
| 18044 | @code{load} command to download a file from Unix to VxWorks |
| 18045 | incrementally. The object file given as an argument to the @code{load} |
| 18046 | command is actually opened twice: first by the VxWorks target in order |
| 18047 | to download the code, then by @value{GDBN} in order to read the symbol |
| 18048 | table. This can lead to problems if the current working directories on |
| 18049 | the two systems differ. If both systems have NFS mounted the same |
| 18050 | filesystems, you can avoid these problems by using absolute paths. |
| 18051 | Otherwise, it is simplest to set the working directory on both systems |
| 18052 | to the directory in which the object file resides, and then to reference |
| 18053 | the file by its name, without any path. For instance, a program |
| 18054 | @file{prog.o} may reside in @file{@var{vxpath}/vw/demo/rdb} in VxWorks |
| 18055 | and in @file{@var{hostpath}/vw/demo/rdb} on the host. To load this |
| 18056 | program, type this on VxWorks: |
| 18057 | |
| 18058 | @smallexample |
| 18059 | -> cd "@var{vxpath}/vw/demo/rdb" |
| 18060 | @end smallexample |
| 18061 | |
| 18062 | @noindent |
| 18063 | Then, in @value{GDBN}, type: |
| 18064 | |
| 18065 | @smallexample |
| 18066 | (vxgdb) cd @var{hostpath}/vw/demo/rdb |
| 18067 | (vxgdb) load prog.o |
| 18068 | @end smallexample |
| 18069 | |
| 18070 | @value{GDBN} displays a response similar to this: |
| 18071 | |
| 18072 | @smallexample |
| 18073 | Reading symbol data from wherever/vw/demo/rdb/prog.o... done. |
| 18074 | @end smallexample |
| 18075 | |
| 18076 | You can also use the @code{load} command to reload an object module |
| 18077 | after editing and recompiling the corresponding source file. Note that |
| 18078 | this makes @value{GDBN} delete all currently-defined breakpoints, |
| 18079 | auto-displays, and convenience variables, and to clear the value |
| 18080 | history. (This is necessary in order to preserve the integrity of |
| 18081 | debugger's data structures that reference the target system's symbol |
| 18082 | table.) |
| 18083 | |
| 18084 | @node VxWorks Attach |
| 18085 | @subsubsection Running Tasks |
| 18086 | |
| 18087 | @cindex running VxWorks tasks |
| 18088 | You can also attach to an existing task using the @code{attach} command as |
| 18089 | follows: |
| 18090 | |
| 18091 | @smallexample |
| 18092 | (vxgdb) attach @var{task} |
| 18093 | @end smallexample |
| 18094 | |
| 18095 | @noindent |
| 18096 | where @var{task} is the VxWorks hexadecimal task ID. The task can be running |
| 18097 | or suspended when you attach to it. Running tasks are suspended at |
| 18098 | the time of attachment. |
| 18099 | |
| 18100 | @node Embedded Processors |
| 18101 | @section Embedded Processors |
| 18102 | |
| 18103 | This section goes into details specific to particular embedded |
| 18104 | configurations. |
| 18105 | |
| 18106 | @cindex send command to simulator |
| 18107 | Whenever a specific embedded processor has a simulator, @value{GDBN} |
| 18108 | allows to send an arbitrary command to the simulator. |
| 18109 | |
| 18110 | @table @code |
| 18111 | @item sim @var{command} |
| 18112 | @kindex sim@r{, a command} |
| 18113 | Send an arbitrary @var{command} string to the simulator. Consult the |
| 18114 | documentation for the specific simulator in use for information about |
| 18115 | acceptable commands. |
| 18116 | @end table |
| 18117 | |
| 18118 | |
| 18119 | @menu |
| 18120 | * ARM:: ARM RDI |
| 18121 | * M32R/D:: Renesas M32R/D |
| 18122 | * M68K:: Motorola M68K |
| 18123 | * MicroBlaze:: Xilinx MicroBlaze |
| 18124 | * MIPS Embedded:: MIPS Embedded |
| 18125 | * OpenRISC 1000:: OpenRisc 1000 |
| 18126 | * PA:: HP PA Embedded |
| 18127 | * PowerPC Embedded:: PowerPC Embedded |
| 18128 | * Sparclet:: Tsqware Sparclet |
| 18129 | * Sparclite:: Fujitsu Sparclite |
| 18130 | * Z8000:: Zilog Z8000 |
| 18131 | * AVR:: Atmel AVR |
| 18132 | * CRIS:: CRIS |
| 18133 | * Super-H:: Renesas Super-H |
| 18134 | @end menu |
| 18135 | |
| 18136 | @node ARM |
| 18137 | @subsection ARM |
| 18138 | @cindex ARM RDI |
| 18139 | |
| 18140 | @table @code |
| 18141 | @kindex target rdi |
| 18142 | @item target rdi @var{dev} |
| 18143 | ARM Angel monitor, via RDI library interface to ADP protocol. You may |
| 18144 | use this target to communicate with both boards running the Angel |
| 18145 | monitor, or with the EmbeddedICE JTAG debug device. |
| 18146 | |
| 18147 | @kindex target rdp |
| 18148 | @item target rdp @var{dev} |
| 18149 | ARM Demon monitor. |
| 18150 | |
| 18151 | @end table |
| 18152 | |
| 18153 | @value{GDBN} provides the following ARM-specific commands: |
| 18154 | |
| 18155 | @table @code |
| 18156 | @item set arm disassembler |
| 18157 | @kindex set arm |
| 18158 | This commands selects from a list of disassembly styles. The |
| 18159 | @code{"std"} style is the standard style. |
| 18160 | |
| 18161 | @item show arm disassembler |
| 18162 | @kindex show arm |
| 18163 | Show the current disassembly style. |
| 18164 | |
| 18165 | @item set arm apcs32 |
| 18166 | @cindex ARM 32-bit mode |
| 18167 | This command toggles ARM operation mode between 32-bit and 26-bit. |
| 18168 | |
| 18169 | @item show arm apcs32 |
| 18170 | Display the current usage of the ARM 32-bit mode. |
| 18171 | |
| 18172 | @item set arm fpu @var{fputype} |
| 18173 | This command sets the ARM floating-point unit (FPU) type. The |
| 18174 | argument @var{fputype} can be one of these: |
| 18175 | |
| 18176 | @table @code |
| 18177 | @item auto |
| 18178 | Determine the FPU type by querying the OS ABI. |
| 18179 | @item softfpa |
| 18180 | Software FPU, with mixed-endian doubles on little-endian ARM |
| 18181 | processors. |
| 18182 | @item fpa |
| 18183 | GCC-compiled FPA co-processor. |
| 18184 | @item softvfp |
| 18185 | Software FPU with pure-endian doubles. |
| 18186 | @item vfp |
| 18187 | VFP co-processor. |
| 18188 | @end table |
| 18189 | |
| 18190 | @item show arm fpu |
| 18191 | Show the current type of the FPU. |
| 18192 | |
| 18193 | @item set arm abi |
| 18194 | This command forces @value{GDBN} to use the specified ABI. |
| 18195 | |
| 18196 | @item show arm abi |
| 18197 | Show the currently used ABI. |
| 18198 | |
| 18199 | @item set arm fallback-mode (arm|thumb|auto) |
| 18200 | @value{GDBN} uses the symbol table, when available, to determine |
| 18201 | whether instructions are ARM or Thumb. This command controls |
| 18202 | @value{GDBN}'s default behavior when the symbol table is not |
| 18203 | available. The default is @samp{auto}, which causes @value{GDBN} to |
| 18204 | use the current execution mode (from the @code{T} bit in the @code{CPSR} |
| 18205 | register). |
| 18206 | |
| 18207 | @item show arm fallback-mode |
| 18208 | Show the current fallback instruction mode. |
| 18209 | |
| 18210 | @item set arm force-mode (arm|thumb|auto) |
| 18211 | This command overrides use of the symbol table to determine whether |
| 18212 | instructions are ARM or Thumb. The default is @samp{auto}, which |
| 18213 | causes @value{GDBN} to use the symbol table and then the setting |
| 18214 | of @samp{set arm fallback-mode}. |
| 18215 | |
| 18216 | @item show arm force-mode |
| 18217 | Show the current forced instruction mode. |
| 18218 | |
| 18219 | @item set debug arm |
| 18220 | Toggle whether to display ARM-specific debugging messages from the ARM |
| 18221 | target support subsystem. |
| 18222 | |
| 18223 | @item show debug arm |
| 18224 | Show whether ARM-specific debugging messages are enabled. |
| 18225 | @end table |
| 18226 | |
| 18227 | The following commands are available when an ARM target is debugged |
| 18228 | using the RDI interface: |
| 18229 | |
| 18230 | @table @code |
| 18231 | @item rdilogfile @r{[}@var{file}@r{]} |
| 18232 | @kindex rdilogfile |
| 18233 | @cindex ADP (Angel Debugger Protocol) logging |
| 18234 | Set the filename for the ADP (Angel Debugger Protocol) packet log. |
| 18235 | With an argument, sets the log file to the specified @var{file}. With |
| 18236 | no argument, show the current log file name. The default log file is |
| 18237 | @file{rdi.log}. |
| 18238 | |
| 18239 | @item rdilogenable @r{[}@var{arg}@r{]} |
| 18240 | @kindex rdilogenable |
| 18241 | Control logging of ADP packets. With an argument of 1 or @code{"yes"} |
| 18242 | enables logging, with an argument 0 or @code{"no"} disables it. With |
| 18243 | no arguments displays the current setting. When logging is enabled, |
| 18244 | ADP packets exchanged between @value{GDBN} and the RDI target device |
| 18245 | are logged to a file. |
| 18246 | |
| 18247 | @item set rdiromatzero |
| 18248 | @kindex set rdiromatzero |
| 18249 | @cindex ROM at zero address, RDI |
| 18250 | Tell @value{GDBN} whether the target has ROM at address 0. If on, |
| 18251 | vector catching is disabled, so that zero address can be used. If off |
| 18252 | (the default), vector catching is enabled. For this command to take |
| 18253 | effect, it needs to be invoked prior to the @code{target rdi} command. |
| 18254 | |
| 18255 | @item show rdiromatzero |
| 18256 | @kindex show rdiromatzero |
| 18257 | Show the current setting of ROM at zero address. |
| 18258 | |
| 18259 | @item set rdiheartbeat |
| 18260 | @kindex set rdiheartbeat |
| 18261 | @cindex RDI heartbeat |
| 18262 | Enable or disable RDI heartbeat packets. It is not recommended to |
| 18263 | turn on this option, since it confuses ARM and EPI JTAG interface, as |
| 18264 | well as the Angel monitor. |
| 18265 | |
| 18266 | @item show rdiheartbeat |
| 18267 | @kindex show rdiheartbeat |
| 18268 | Show the setting of RDI heartbeat packets. |
| 18269 | @end table |
| 18270 | |
| 18271 | @table @code |
| 18272 | @item target sim @r{[}@var{simargs}@r{]} @dots{} |
| 18273 | The @value{GDBN} ARM simulator accepts the following optional arguments. |
| 18274 | |
| 18275 | @table @code |
| 18276 | @item --swi-support=@var{type} |
| 18277 | Tell the simulator which SWI interfaces to support. |
| 18278 | @var{type} may be a comma separated list of the following values. |
| 18279 | The default value is @code{all}. |
| 18280 | |
| 18281 | @table @code |
| 18282 | @item none |
| 18283 | @item demon |
| 18284 | @item angel |
| 18285 | @item redboot |
| 18286 | @item all |
| 18287 | @end table |
| 18288 | @end table |
| 18289 | @end table |
| 18290 | |
| 18291 | @node M32R/D |
| 18292 | @subsection Renesas M32R/D and M32R/SDI |
| 18293 | |
| 18294 | @table @code |
| 18295 | @kindex target m32r |
| 18296 | @item target m32r @var{dev} |
| 18297 | Renesas M32R/D ROM monitor. |
| 18298 | |
| 18299 | @kindex target m32rsdi |
| 18300 | @item target m32rsdi @var{dev} |
| 18301 | Renesas M32R SDI server, connected via parallel port to the board. |
| 18302 | @end table |
| 18303 | |
| 18304 | The following @value{GDBN} commands are specific to the M32R monitor: |
| 18305 | |
| 18306 | @table @code |
| 18307 | @item set download-path @var{path} |
| 18308 | @kindex set download-path |
| 18309 | @cindex find downloadable @sc{srec} files (M32R) |
| 18310 | Set the default path for finding downloadable @sc{srec} files. |
| 18311 | |
| 18312 | @item show download-path |
| 18313 | @kindex show download-path |
| 18314 | Show the default path for downloadable @sc{srec} files. |
| 18315 | |
| 18316 | @item set board-address @var{addr} |
| 18317 | @kindex set board-address |
| 18318 | @cindex M32-EVA target board address |
| 18319 | Set the IP address for the M32R-EVA target board. |
| 18320 | |
| 18321 | @item show board-address |
| 18322 | @kindex show board-address |
| 18323 | Show the current IP address of the target board. |
| 18324 | |
| 18325 | @item set server-address @var{addr} |
| 18326 | @kindex set server-address |
| 18327 | @cindex download server address (M32R) |
| 18328 | Set the IP address for the download server, which is the @value{GDBN}'s |
| 18329 | host machine. |
| 18330 | |
| 18331 | @item show server-address |
| 18332 | @kindex show server-address |
| 18333 | Display the IP address of the download server. |
| 18334 | |
| 18335 | @item upload @r{[}@var{file}@r{]} |
| 18336 | @kindex upload@r{, M32R} |
| 18337 | Upload the specified @sc{srec} @var{file} via the monitor's Ethernet |
| 18338 | upload capability. If no @var{file} argument is given, the current |
| 18339 | executable file is uploaded. |
| 18340 | |
| 18341 | @item tload @r{[}@var{file}@r{]} |
| 18342 | @kindex tload@r{, M32R} |
| 18343 | Test the @code{upload} command. |
| 18344 | @end table |
| 18345 | |
| 18346 | The following commands are available for M32R/SDI: |
| 18347 | |
| 18348 | @table @code |
| 18349 | @item sdireset |
| 18350 | @kindex sdireset |
| 18351 | @cindex reset SDI connection, M32R |
| 18352 | This command resets the SDI connection. |
| 18353 | |
| 18354 | @item sdistatus |
| 18355 | @kindex sdistatus |
| 18356 | This command shows the SDI connection status. |
| 18357 | |
| 18358 | @item debug_chaos |
| 18359 | @kindex debug_chaos |
| 18360 | @cindex M32R/Chaos debugging |
| 18361 | Instructs the remote that M32R/Chaos debugging is to be used. |
| 18362 | |
| 18363 | @item use_debug_dma |
| 18364 | @kindex use_debug_dma |
| 18365 | Instructs the remote to use the DEBUG_DMA method of accessing memory. |
| 18366 | |
| 18367 | @item use_mon_code |
| 18368 | @kindex use_mon_code |
| 18369 | Instructs the remote to use the MON_CODE method of accessing memory. |
| 18370 | |
| 18371 | @item use_ib_break |
| 18372 | @kindex use_ib_break |
| 18373 | Instructs the remote to set breakpoints by IB break. |
| 18374 | |
| 18375 | @item use_dbt_break |
| 18376 | @kindex use_dbt_break |
| 18377 | Instructs the remote to set breakpoints by DBT. |
| 18378 | @end table |
| 18379 | |
| 18380 | @node M68K |
| 18381 | @subsection M68k |
| 18382 | |
| 18383 | The Motorola m68k configuration includes ColdFire support, and a |
| 18384 | target command for the following ROM monitor. |
| 18385 | |
| 18386 | @table @code |
| 18387 | |
| 18388 | @kindex target dbug |
| 18389 | @item target dbug @var{dev} |
| 18390 | dBUG ROM monitor for Motorola ColdFire. |
| 18391 | |
| 18392 | @end table |
| 18393 | |
| 18394 | @node MicroBlaze |
| 18395 | @subsection MicroBlaze |
| 18396 | @cindex Xilinx MicroBlaze |
| 18397 | @cindex XMD, Xilinx Microprocessor Debugger |
| 18398 | |
| 18399 | The MicroBlaze is a soft-core processor supported on various Xilinx |
| 18400 | FPGAs, such as Spartan or Virtex series. Boards with these processors |
| 18401 | usually have JTAG ports which connect to a host system running the Xilinx |
| 18402 | Embedded Development Kit (EDK) or Software Development Kit (SDK). |
| 18403 | This host system is used to download the configuration bitstream to |
| 18404 | the target FPGA. The Xilinx Microprocessor Debugger (XMD) program |
| 18405 | communicates with the target board using the JTAG interface and |
| 18406 | presents a @code{gdbserver} interface to the board. By default |
| 18407 | @code{xmd} uses port @code{1234}. (While it is possible to change |
| 18408 | this default port, it requires the use of undocumented @code{xmd} |
| 18409 | commands. Contact Xilinx support if you need to do this.) |
| 18410 | |
| 18411 | Use these GDB commands to connect to the MicroBlaze target processor. |
| 18412 | |
| 18413 | @table @code |
| 18414 | @item target remote :1234 |
| 18415 | Use this command to connect to the target if you are running @value{GDBN} |
| 18416 | on the same system as @code{xmd}. |
| 18417 | |
| 18418 | @item target remote @var{xmd-host}:1234 |
| 18419 | Use this command to connect to the target if it is connected to @code{xmd} |
| 18420 | running on a different system named @var{xmd-host}. |
| 18421 | |
| 18422 | @item load |
| 18423 | Use this command to download a program to the MicroBlaze target. |
| 18424 | |
| 18425 | @item set debug microblaze @var{n} |
| 18426 | Enable MicroBlaze-specific debugging messages if non-zero. |
| 18427 | |
| 18428 | @item show debug microblaze @var{n} |
| 18429 | Show MicroBlaze-specific debugging level. |
| 18430 | @end table |
| 18431 | |
| 18432 | @node MIPS Embedded |
| 18433 | @subsection MIPS Embedded |
| 18434 | |
| 18435 | @cindex MIPS boards |
| 18436 | @value{GDBN} can use the MIPS remote debugging protocol to talk to a |
| 18437 | MIPS board attached to a serial line. This is available when |
| 18438 | you configure @value{GDBN} with @samp{--target=mips-idt-ecoff}. |
| 18439 | |
| 18440 | @need 1000 |
| 18441 | Use these @value{GDBN} commands to specify the connection to your target board: |
| 18442 | |
| 18443 | @table @code |
| 18444 | @item target mips @var{port} |
| 18445 | @kindex target mips @var{port} |
| 18446 | To run a program on the board, start up @code{@value{GDBP}} with the |
| 18447 | name of your program as the argument. To connect to the board, use the |
| 18448 | command @samp{target mips @var{port}}, where @var{port} is the name of |
| 18449 | the serial port connected to the board. If the program has not already |
| 18450 | been downloaded to the board, you may use the @code{load} command to |
| 18451 | download it. You can then use all the usual @value{GDBN} commands. |
| 18452 | |
| 18453 | For example, this sequence connects to the target board through a serial |
| 18454 | port, and loads and runs a program called @var{prog} through the |
| 18455 | debugger: |
| 18456 | |
| 18457 | @smallexample |
| 18458 | host$ @value{GDBP} @var{prog} |
| 18459 | @value{GDBN} is free software and @dots{} |
| 18460 | (@value{GDBP}) target mips /dev/ttyb |
| 18461 | (@value{GDBP}) load @var{prog} |
| 18462 | (@value{GDBP}) run |
| 18463 | @end smallexample |
| 18464 | |
| 18465 | @item target mips @var{hostname}:@var{portnumber} |
| 18466 | On some @value{GDBN} host configurations, you can specify a TCP |
| 18467 | connection (for instance, to a serial line managed by a terminal |
| 18468 | concentrator) instead of a serial port, using the syntax |
| 18469 | @samp{@var{hostname}:@var{portnumber}}. |
| 18470 | |
| 18471 | @item target pmon @var{port} |
| 18472 | @kindex target pmon @var{port} |
| 18473 | PMON ROM monitor. |
| 18474 | |
| 18475 | @item target ddb @var{port} |
| 18476 | @kindex target ddb @var{port} |
| 18477 | NEC's DDB variant of PMON for Vr4300. |
| 18478 | |
| 18479 | @item target lsi @var{port} |
| 18480 | @kindex target lsi @var{port} |
| 18481 | LSI variant of PMON. |
| 18482 | |
| 18483 | @kindex target r3900 |
| 18484 | @item target r3900 @var{dev} |
| 18485 | Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips. |
| 18486 | |
| 18487 | @kindex target array |
| 18488 | @item target array @var{dev} |
| 18489 | Array Tech LSI33K RAID controller board. |
| 18490 | |
| 18491 | @end table |
| 18492 | |
| 18493 | |
| 18494 | @noindent |
| 18495 | @value{GDBN} also supports these special commands for MIPS targets: |
| 18496 | |
| 18497 | @table @code |
| 18498 | @item set mipsfpu double |
| 18499 | @itemx set mipsfpu single |
| 18500 | @itemx set mipsfpu none |
| 18501 | @itemx set mipsfpu auto |
| 18502 | @itemx show mipsfpu |
| 18503 | @kindex set mipsfpu |
| 18504 | @kindex show mipsfpu |
| 18505 | @cindex MIPS remote floating point |
| 18506 | @cindex floating point, MIPS remote |
| 18507 | If your target board does not support the MIPS floating point |
| 18508 | coprocessor, you should use the command @samp{set mipsfpu none} (if you |
| 18509 | need this, you may wish to put the command in your @value{GDBN} init |
| 18510 | file). This tells @value{GDBN} how to find the return value of |
| 18511 | functions which return floating point values. It also allows |
| 18512 | @value{GDBN} to avoid saving the floating point registers when calling |
| 18513 | functions on the board. If you are using a floating point coprocessor |
| 18514 | with only single precision floating point support, as on the @sc{r4650} |
| 18515 | processor, use the command @samp{set mipsfpu single}. The default |
| 18516 | double precision floating point coprocessor may be selected using |
| 18517 | @samp{set mipsfpu double}. |
| 18518 | |
| 18519 | In previous versions the only choices were double precision or no |
| 18520 | floating point, so @samp{set mipsfpu on} will select double precision |
| 18521 | and @samp{set mipsfpu off} will select no floating point. |
| 18522 | |
| 18523 | As usual, you can inquire about the @code{mipsfpu} variable with |
| 18524 | @samp{show mipsfpu}. |
| 18525 | |
| 18526 | @item set timeout @var{seconds} |
| 18527 | @itemx set retransmit-timeout @var{seconds} |
| 18528 | @itemx show timeout |
| 18529 | @itemx show retransmit-timeout |
| 18530 | @cindex @code{timeout}, MIPS protocol |
| 18531 | @cindex @code{retransmit-timeout}, MIPS protocol |
| 18532 | @kindex set timeout |
| 18533 | @kindex show timeout |
| 18534 | @kindex set retransmit-timeout |
| 18535 | @kindex show retransmit-timeout |
| 18536 | You can control the timeout used while waiting for a packet, in the MIPS |
| 18537 | remote protocol, with the @code{set timeout @var{seconds}} command. The |
| 18538 | default is 5 seconds. Similarly, you can control the timeout used while |
| 18539 | waiting for an acknowledgment of a packet with the @code{set |
| 18540 | retransmit-timeout @var{seconds}} command. The default is 3 seconds. |
| 18541 | You can inspect both values with @code{show timeout} and @code{show |
| 18542 | retransmit-timeout}. (These commands are @emph{only} available when |
| 18543 | @value{GDBN} is configured for @samp{--target=mips-idt-ecoff}.) |
| 18544 | |
| 18545 | The timeout set by @code{set timeout} does not apply when @value{GDBN} |
| 18546 | is waiting for your program to stop. In that case, @value{GDBN} waits |
| 18547 | forever because it has no way of knowing how long the program is going |
| 18548 | to run before stopping. |
| 18549 | |
| 18550 | @item set syn-garbage-limit @var{num} |
| 18551 | @kindex set syn-garbage-limit@r{, MIPS remote} |
| 18552 | @cindex synchronize with remote MIPS target |
| 18553 | Limit the maximum number of characters @value{GDBN} should ignore when |
| 18554 | it tries to synchronize with the remote target. The default is 10 |
| 18555 | characters. Setting the limit to -1 means there's no limit. |
| 18556 | |
| 18557 | @item show syn-garbage-limit |
| 18558 | @kindex show syn-garbage-limit@r{, MIPS remote} |
| 18559 | Show the current limit on the number of characters to ignore when |
| 18560 | trying to synchronize with the remote system. |
| 18561 | |
| 18562 | @item set monitor-prompt @var{prompt} |
| 18563 | @kindex set monitor-prompt@r{, MIPS remote} |
| 18564 | @cindex remote monitor prompt |
| 18565 | Tell @value{GDBN} to expect the specified @var{prompt} string from the |
| 18566 | remote monitor. The default depends on the target: |
| 18567 | @table @asis |
| 18568 | @item pmon target |
| 18569 | @samp{PMON} |
| 18570 | @item ddb target |
| 18571 | @samp{NEC010} |
| 18572 | @item lsi target |
| 18573 | @samp{PMON>} |
| 18574 | @end table |
| 18575 | |
| 18576 | @item show monitor-prompt |
| 18577 | @kindex show monitor-prompt@r{, MIPS remote} |
| 18578 | Show the current strings @value{GDBN} expects as the prompt from the |
| 18579 | remote monitor. |
| 18580 | |
| 18581 | @item set monitor-warnings |
| 18582 | @kindex set monitor-warnings@r{, MIPS remote} |
| 18583 | Enable or disable monitor warnings about hardware breakpoints. This |
| 18584 | has effect only for the @code{lsi} target. When on, @value{GDBN} will |
| 18585 | display warning messages whose codes are returned by the @code{lsi} |
| 18586 | PMON monitor for breakpoint commands. |
| 18587 | |
| 18588 | @item show monitor-warnings |
| 18589 | @kindex show monitor-warnings@r{, MIPS remote} |
| 18590 | Show the current setting of printing monitor warnings. |
| 18591 | |
| 18592 | @item pmon @var{command} |
| 18593 | @kindex pmon@r{, MIPS remote} |
| 18594 | @cindex send PMON command |
| 18595 | This command allows sending an arbitrary @var{command} string to the |
| 18596 | monitor. The monitor must be in debug mode for this to work. |
| 18597 | @end table |
| 18598 | |
| 18599 | @node OpenRISC 1000 |
| 18600 | @subsection OpenRISC 1000 |
| 18601 | @cindex OpenRISC 1000 |
| 18602 | |
| 18603 | @cindex or1k boards |
| 18604 | See OR1k Architecture document (@uref{www.opencores.org}) for more information |
| 18605 | about platform and commands. |
| 18606 | |
| 18607 | @table @code |
| 18608 | |
| 18609 | @kindex target jtag |
| 18610 | @item target jtag jtag://@var{host}:@var{port} |
| 18611 | |
| 18612 | Connects to remote JTAG server. |
| 18613 | JTAG remote server can be either an or1ksim or JTAG server, |
| 18614 | connected via parallel port to the board. |
| 18615 | |
| 18616 | Example: @code{target jtag jtag://localhost:9999} |
| 18617 | |
| 18618 | @kindex or1ksim |
| 18619 | @item or1ksim @var{command} |
| 18620 | If connected to @code{or1ksim} OpenRISC 1000 Architectural |
| 18621 | Simulator, proprietary commands can be executed. |
| 18622 | |
| 18623 | @kindex info or1k spr |
| 18624 | @item info or1k spr |
| 18625 | Displays spr groups. |
| 18626 | |
| 18627 | @item info or1k spr @var{group} |
| 18628 | @itemx info or1k spr @var{groupno} |
| 18629 | Displays register names in selected group. |
| 18630 | |
| 18631 | @item info or1k spr @var{group} @var{register} |
| 18632 | @itemx info or1k spr @var{register} |
| 18633 | @itemx info or1k spr @var{groupno} @var{registerno} |
| 18634 | @itemx info or1k spr @var{registerno} |
| 18635 | Shows information about specified spr register. |
| 18636 | |
| 18637 | @kindex spr |
| 18638 | @item spr @var{group} @var{register} @var{value} |
| 18639 | @itemx spr @var{register @var{value}} |
| 18640 | @itemx spr @var{groupno} @var{registerno @var{value}} |
| 18641 | @itemx spr @var{registerno @var{value}} |
| 18642 | Writes @var{value} to specified spr register. |
| 18643 | @end table |
| 18644 | |
| 18645 | Some implementations of OpenRISC 1000 Architecture also have hardware trace. |
| 18646 | It is very similar to @value{GDBN} trace, except it does not interfere with normal |
| 18647 | program execution and is thus much faster. Hardware breakpoints/watchpoint |
| 18648 | triggers can be set using: |
| 18649 | @table @code |
| 18650 | @item $LEA/$LDATA |
| 18651 | Load effective address/data |
| 18652 | @item $SEA/$SDATA |
| 18653 | Store effective address/data |
| 18654 | @item $AEA/$ADATA |
| 18655 | Access effective address ($SEA or $LEA) or data ($SDATA/$LDATA) |
| 18656 | @item $FETCH |
| 18657 | Fetch data |
| 18658 | @end table |
| 18659 | |
| 18660 | When triggered, it can capture low level data, like: @code{PC}, @code{LSEA}, |
| 18661 | @code{LDATA}, @code{SDATA}, @code{READSPR}, @code{WRITESPR}, @code{INSTR}. |
| 18662 | |
| 18663 | @code{htrace} commands: |
| 18664 | @cindex OpenRISC 1000 htrace |
| 18665 | @table @code |
| 18666 | @kindex hwatch |
| 18667 | @item hwatch @var{conditional} |
| 18668 | Set hardware watchpoint on combination of Load/Store Effective Address(es) |
| 18669 | or Data. For example: |
| 18670 | |
| 18671 | @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)} |
| 18672 | |
| 18673 | @code{hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50)} |
| 18674 | |
| 18675 | @kindex htrace |
| 18676 | @item htrace info |
| 18677 | Display information about current HW trace configuration. |
| 18678 | |
| 18679 | @item htrace trigger @var{conditional} |
| 18680 | Set starting criteria for HW trace. |
| 18681 | |
| 18682 | @item htrace qualifier @var{conditional} |
| 18683 | Set acquisition qualifier for HW trace. |
| 18684 | |
| 18685 | @item htrace stop @var{conditional} |
| 18686 | Set HW trace stopping criteria. |
| 18687 | |
| 18688 | @item htrace record [@var{data}]* |
| 18689 | Selects the data to be recorded, when qualifier is met and HW trace was |
| 18690 | triggered. |
| 18691 | |
| 18692 | @item htrace enable |
| 18693 | @itemx htrace disable |
| 18694 | Enables/disables the HW trace. |
| 18695 | |
| 18696 | @item htrace rewind [@var{filename}] |
| 18697 | Clears currently recorded trace data. |
| 18698 | |
| 18699 | If filename is specified, new trace file is made and any newly collected data |
| 18700 | will be written there. |
| 18701 | |
| 18702 | @item htrace print [@var{start} [@var{len}]] |
| 18703 | Prints trace buffer, using current record configuration. |
| 18704 | |
| 18705 | @item htrace mode continuous |
| 18706 | Set continuous trace mode. |
| 18707 | |
| 18708 | @item htrace mode suspend |
| 18709 | Set suspend trace mode. |
| 18710 | |
| 18711 | @end table |
| 18712 | |
| 18713 | @node PowerPC Embedded |
| 18714 | @subsection PowerPC Embedded |
| 18715 | |
| 18716 | @cindex DVC register |
| 18717 | @value{GDBN} supports using the DVC (Data Value Compare) register to |
| 18718 | implement in hardware simple hardware watchpoint conditions of the form: |
| 18719 | |
| 18720 | @smallexample |
| 18721 | (@value{GDBP}) watch @var{ADDRESS|VARIABLE} \ |
| 18722 | if @var{ADDRESS|VARIABLE} == @var{CONSTANT EXPRESSION} |
| 18723 | @end smallexample |
| 18724 | |
| 18725 | The DVC register will be automatically used when @value{GDBN} detects |
| 18726 | such pattern in a condition expression, and the created watchpoint uses one |
| 18727 | debug register (either the @code{exact-watchpoints} option is on and the |
| 18728 | variable is scalar, or the variable has a length of one byte). This feature |
| 18729 | is available in native @value{GDBN} running on a Linux kernel version 2.6.34 |
| 18730 | or newer. |
| 18731 | |
| 18732 | When running on PowerPC embedded processors, @value{GDBN} automatically uses |
| 18733 | ranged hardware watchpoints, unless the @code{exact-watchpoints} option is on, |
| 18734 | in which case watchpoints using only one debug register are created when |
| 18735 | watching variables of scalar types. |
| 18736 | |
| 18737 | You can create an artificial array to watch an arbitrary memory |
| 18738 | region using one of the following commands (@pxref{Expressions}): |
| 18739 | |
| 18740 | @smallexample |
| 18741 | (@value{GDBP}) watch *((char *) @var{address})@@@var{length} |
| 18742 | (@value{GDBP}) watch @{char[@var{length}]@} @var{address} |
| 18743 | @end smallexample |
| 18744 | |
| 18745 | @value{GDBN} provides the following PowerPC-specific commands: |
| 18746 | |
| 18747 | @table @code |
| 18748 | @kindex set powerpc |
| 18749 | @item set powerpc soft-float |
| 18750 | @itemx show powerpc soft-float |
| 18751 | Force @value{GDBN} to use (or not use) a software floating point calling |
| 18752 | convention. By default, @value{GDBN} selects the calling convention based |
| 18753 | on the selected architecture and the provided executable file. |
| 18754 | |
| 18755 | @item set powerpc vector-abi |
| 18756 | @itemx show powerpc vector-abi |
| 18757 | Force @value{GDBN} to use the specified calling convention for vector |
| 18758 | arguments and return values. The valid options are @samp{auto}; |
| 18759 | @samp{generic}, to avoid vector registers even if they are present; |
| 18760 | @samp{altivec}, to use AltiVec registers; and @samp{spe} to use SPE |
| 18761 | registers. By default, @value{GDBN} selects the calling convention |
| 18762 | based on the selected architecture and the provided executable file. |
| 18763 | |
| 18764 | @item set powerpc exact-watchpoints |
| 18765 | @itemx show powerpc exact-watchpoints |
| 18766 | Allow @value{GDBN} to use only one debug register when watching a variable |
| 18767 | of scalar type, thus assuming that the variable is accessed through the |
| 18768 | address of its first byte. |
| 18769 | |
| 18770 | @kindex target dink32 |
| 18771 | @item target dink32 @var{dev} |
| 18772 | DINK32 ROM monitor. |
| 18773 | |
| 18774 | @kindex target ppcbug |
| 18775 | @item target ppcbug @var{dev} |
| 18776 | @kindex target ppcbug1 |
| 18777 | @item target ppcbug1 @var{dev} |
| 18778 | PPCBUG ROM monitor for PowerPC. |
| 18779 | |
| 18780 | @kindex target sds |
| 18781 | @item target sds @var{dev} |
| 18782 | SDS monitor, running on a PowerPC board (such as Motorola's ADS). |
| 18783 | @end table |
| 18784 | |
| 18785 | @cindex SDS protocol |
| 18786 | The following commands specific to the SDS protocol are supported |
| 18787 | by @value{GDBN}: |
| 18788 | |
| 18789 | @table @code |
| 18790 | @item set sdstimeout @var{nsec} |
| 18791 | @kindex set sdstimeout |
| 18792 | Set the timeout for SDS protocol reads to be @var{nsec} seconds. The |
| 18793 | default is 2 seconds. |
| 18794 | |
| 18795 | @item show sdstimeout |
| 18796 | @kindex show sdstimeout |
| 18797 | Show the current value of the SDS timeout. |
| 18798 | |
| 18799 | @item sds @var{command} |
| 18800 | @kindex sds@r{, a command} |
| 18801 | Send the specified @var{command} string to the SDS monitor. |
| 18802 | @end table |
| 18803 | |
| 18804 | |
| 18805 | @node PA |
| 18806 | @subsection HP PA Embedded |
| 18807 | |
| 18808 | @table @code |
| 18809 | |
| 18810 | @kindex target op50n |
| 18811 | @item target op50n @var{dev} |
| 18812 | OP50N monitor, running on an OKI HPPA board. |
| 18813 | |
| 18814 | @kindex target w89k |
| 18815 | @item target w89k @var{dev} |
| 18816 | W89K monitor, running on a Winbond HPPA board. |
| 18817 | |
| 18818 | @end table |
| 18819 | |
| 18820 | @node Sparclet |
| 18821 | @subsection Tsqware Sparclet |
| 18822 | |
| 18823 | @cindex Sparclet |
| 18824 | |
| 18825 | @value{GDBN} enables developers to debug tasks running on |
| 18826 | Sparclet targets from a Unix host. |
| 18827 | @value{GDBN} uses code that runs on |
| 18828 | both the Unix host and on the Sparclet target. The program |
| 18829 | @code{@value{GDBP}} is installed and executed on the Unix host. |
| 18830 | |
| 18831 | @table @code |
| 18832 | @item remotetimeout @var{args} |
| 18833 | @kindex remotetimeout |
| 18834 | @value{GDBN} supports the option @code{remotetimeout}. |
| 18835 | This option is set by the user, and @var{args} represents the number of |
| 18836 | seconds @value{GDBN} waits for responses. |
| 18837 | @end table |
| 18838 | |
| 18839 | @cindex compiling, on Sparclet |
| 18840 | When compiling for debugging, include the options @samp{-g} to get debug |
| 18841 | information and @samp{-Ttext} to relocate the program to where you wish to |
| 18842 | load it on the target. You may also want to add the options @samp{-n} or |
| 18843 | @samp{-N} in order to reduce the size of the sections. Example: |
| 18844 | |
| 18845 | @smallexample |
| 18846 | sparclet-aout-gcc prog.c -Ttext 0x12010000 -g -o prog -N |
| 18847 | @end smallexample |
| 18848 | |
| 18849 | You can use @code{objdump} to verify that the addresses are what you intended: |
| 18850 | |
| 18851 | @smallexample |
| 18852 | sparclet-aout-objdump --headers --syms prog |
| 18853 | @end smallexample |
| 18854 | |
| 18855 | @cindex running, on Sparclet |
| 18856 | Once you have set |
| 18857 | your Unix execution search path to find @value{GDBN}, you are ready to |
| 18858 | run @value{GDBN}. From your Unix host, run @code{@value{GDBP}} |
| 18859 | (or @code{sparclet-aout-gdb}, depending on your installation). |
| 18860 | |
| 18861 | @value{GDBN} comes up showing the prompt: |
| 18862 | |
| 18863 | @smallexample |
| 18864 | (gdbslet) |
| 18865 | @end smallexample |
| 18866 | |
| 18867 | @menu |
| 18868 | * Sparclet File:: Setting the file to debug |
| 18869 | * Sparclet Connection:: Connecting to Sparclet |
| 18870 | * Sparclet Download:: Sparclet download |
| 18871 | * Sparclet Execution:: Running and debugging |
| 18872 | @end menu |
| 18873 | |
| 18874 | @node Sparclet File |
| 18875 | @subsubsection Setting File to Debug |
| 18876 | |
| 18877 | The @value{GDBN} command @code{file} lets you choose with program to debug. |
| 18878 | |
| 18879 | @smallexample |
| 18880 | (gdbslet) file prog |
| 18881 | @end smallexample |
| 18882 | |
| 18883 | @need 1000 |
| 18884 | @value{GDBN} then attempts to read the symbol table of @file{prog}. |
| 18885 | @value{GDBN} locates |
| 18886 | the file by searching the directories listed in the command search |
| 18887 | path. |
| 18888 | If the file was compiled with debug information (option @samp{-g}), source |
| 18889 | files will be searched as well. |
| 18890 | @value{GDBN} locates |
| 18891 | the source files by searching the directories listed in the directory search |
| 18892 | path (@pxref{Environment, ,Your Program's Environment}). |
| 18893 | If it fails |
| 18894 | to find a file, it displays a message such as: |
| 18895 | |
| 18896 | @smallexample |
| 18897 | prog: No such file or directory. |
| 18898 | @end smallexample |
| 18899 | |
| 18900 | When this happens, add the appropriate directories to the search paths with |
| 18901 | the @value{GDBN} commands @code{path} and @code{dir}, and execute the |
| 18902 | @code{target} command again. |
| 18903 | |
| 18904 | @node Sparclet Connection |
| 18905 | @subsubsection Connecting to Sparclet |
| 18906 | |
| 18907 | The @value{GDBN} command @code{target} lets you connect to a Sparclet target. |
| 18908 | To connect to a target on serial port ``@code{ttya}'', type: |
| 18909 | |
| 18910 | @smallexample |
| 18911 | (gdbslet) target sparclet /dev/ttya |
| 18912 | Remote target sparclet connected to /dev/ttya |
| 18913 | main () at ../prog.c:3 |
| 18914 | @end smallexample |
| 18915 | |
| 18916 | @need 750 |
| 18917 | @value{GDBN} displays messages like these: |
| 18918 | |
| 18919 | @smallexample |
| 18920 | Connected to ttya. |
| 18921 | @end smallexample |
| 18922 | |
| 18923 | @node Sparclet Download |
| 18924 | @subsubsection Sparclet Download |
| 18925 | |
| 18926 | @cindex download to Sparclet |
| 18927 | Once connected to the Sparclet target, |
| 18928 | you can use the @value{GDBN} |
| 18929 | @code{load} command to download the file from the host to the target. |
| 18930 | The file name and load offset should be given as arguments to the @code{load} |
| 18931 | command. |
| 18932 | Since the file format is aout, the program must be loaded to the starting |
| 18933 | address. You can use @code{objdump} to find out what this value is. The load |
| 18934 | offset is an offset which is added to the VMA (virtual memory address) |
| 18935 | of each of the file's sections. |
| 18936 | For instance, if the program |
| 18937 | @file{prog} was linked to text address 0x1201000, with data at 0x12010160 |
| 18938 | and bss at 0x12010170, in @value{GDBN}, type: |
| 18939 | |
| 18940 | @smallexample |
| 18941 | (gdbslet) load prog 0x12010000 |
| 18942 | Loading section .text, size 0xdb0 vma 0x12010000 |
| 18943 | @end smallexample |
| 18944 | |
| 18945 | If the code is loaded at a different address then what the program was linked |
| 18946 | to, you may need to use the @code{section} and @code{add-symbol-file} commands |
| 18947 | to tell @value{GDBN} where to map the symbol table. |
| 18948 | |
| 18949 | @node Sparclet Execution |
| 18950 | @subsubsection Running and Debugging |
| 18951 | |
| 18952 | @cindex running and debugging Sparclet programs |
| 18953 | You can now begin debugging the task using @value{GDBN}'s execution control |
| 18954 | commands, @code{b}, @code{step}, @code{run}, etc. See the @value{GDBN} |
| 18955 | manual for the list of commands. |
| 18956 | |
| 18957 | @smallexample |
| 18958 | (gdbslet) b main |
| 18959 | Breakpoint 1 at 0x12010000: file prog.c, line 3. |
| 18960 | (gdbslet) run |
| 18961 | Starting program: prog |
| 18962 | Breakpoint 1, main (argc=1, argv=0xeffff21c) at prog.c:3 |
| 18963 | 3 char *symarg = 0; |
| 18964 | (gdbslet) step |
| 18965 | 4 char *execarg = "hello!"; |
| 18966 | (gdbslet) |
| 18967 | @end smallexample |
| 18968 | |
| 18969 | @node Sparclite |
| 18970 | @subsection Fujitsu Sparclite |
| 18971 | |
| 18972 | @table @code |
| 18973 | |
| 18974 | @kindex target sparclite |
| 18975 | @item target sparclite @var{dev} |
| 18976 | Fujitsu sparclite boards, used only for the purpose of loading. |
| 18977 | You must use an additional command to debug the program. |
| 18978 | For example: target remote @var{dev} using @value{GDBN} standard |
| 18979 | remote protocol. |
| 18980 | |
| 18981 | @end table |
| 18982 | |
| 18983 | @node Z8000 |
| 18984 | @subsection Zilog Z8000 |
| 18985 | |
| 18986 | @cindex Z8000 |
| 18987 | @cindex simulator, Z8000 |
| 18988 | @cindex Zilog Z8000 simulator |
| 18989 | |
| 18990 | When configured for debugging Zilog Z8000 targets, @value{GDBN} includes |
| 18991 | a Z8000 simulator. |
| 18992 | |
| 18993 | For the Z8000 family, @samp{target sim} simulates either the Z8002 (the |
| 18994 | unsegmented variant of the Z8000 architecture) or the Z8001 (the |
| 18995 | segmented variant). The simulator recognizes which architecture is |
| 18996 | appropriate by inspecting the object code. |
| 18997 | |
| 18998 | @table @code |
| 18999 | @item target sim @var{args} |
| 19000 | @kindex sim |
| 19001 | @kindex target sim@r{, with Z8000} |
| 19002 | Debug programs on a simulated CPU. If the simulator supports setup |
| 19003 | options, specify them via @var{args}. |
| 19004 | @end table |
| 19005 | |
| 19006 | @noindent |
| 19007 | After specifying this target, you can debug programs for the simulated |
| 19008 | CPU in the same style as programs for your host computer; use the |
| 19009 | @code{file} command to load a new program image, the @code{run} command |
| 19010 | to run your program, and so on. |
| 19011 | |
| 19012 | As well as making available all the usual machine registers |
| 19013 | (@pxref{Registers, ,Registers}), the Z8000 simulator provides three |
| 19014 | additional items of information as specially named registers: |
| 19015 | |
| 19016 | @table @code |
| 19017 | |
| 19018 | @item cycles |
| 19019 | Counts clock-ticks in the simulator. |
| 19020 | |
| 19021 | @item insts |
| 19022 | Counts instructions run in the simulator. |
| 19023 | |
| 19024 | @item time |
| 19025 | Execution time in 60ths of a second. |
| 19026 | |
| 19027 | @end table |
| 19028 | |
| 19029 | You can refer to these values in @value{GDBN} expressions with the usual |
| 19030 | conventions; for example, @w{@samp{b fputc if $cycles>5000}} sets a |
| 19031 | conditional breakpoint that suspends only after at least 5000 |
| 19032 | simulated clock ticks. |
| 19033 | |
| 19034 | @node AVR |
| 19035 | @subsection Atmel AVR |
| 19036 | @cindex AVR |
| 19037 | |
| 19038 | When configured for debugging the Atmel AVR, @value{GDBN} supports the |
| 19039 | following AVR-specific commands: |
| 19040 | |
| 19041 | @table @code |
| 19042 | @item info io_registers |
| 19043 | @kindex info io_registers@r{, AVR} |
| 19044 | @cindex I/O registers (Atmel AVR) |
| 19045 | This command displays information about the AVR I/O registers. For |
| 19046 | each register, @value{GDBN} prints its number and value. |
| 19047 | @end table |
| 19048 | |
| 19049 | @node CRIS |
| 19050 | @subsection CRIS |
| 19051 | @cindex CRIS |
| 19052 | |
| 19053 | When configured for debugging CRIS, @value{GDBN} provides the |
| 19054 | following CRIS-specific commands: |
| 19055 | |
| 19056 | @table @code |
| 19057 | @item set cris-version @var{ver} |
| 19058 | @cindex CRIS version |
| 19059 | Set the current CRIS version to @var{ver}, either @samp{10} or @samp{32}. |
| 19060 | The CRIS version affects register names and sizes. This command is useful in |
| 19061 | case autodetection of the CRIS version fails. |
| 19062 | |
| 19063 | @item show cris-version |
| 19064 | Show the current CRIS version. |
| 19065 | |
| 19066 | @item set cris-dwarf2-cfi |
| 19067 | @cindex DWARF-2 CFI and CRIS |
| 19068 | Set the usage of DWARF-2 CFI for CRIS debugging. The default is @samp{on}. |
| 19069 | Change to @samp{off} when using @code{gcc-cris} whose version is below |
| 19070 | @code{R59}. |
| 19071 | |
| 19072 | @item show cris-dwarf2-cfi |
| 19073 | Show the current state of using DWARF-2 CFI. |
| 19074 | |
| 19075 | @item set cris-mode @var{mode} |
| 19076 | @cindex CRIS mode |
| 19077 | Set the current CRIS mode to @var{mode}. It should only be changed when |
| 19078 | debugging in guru mode, in which case it should be set to |
| 19079 | @samp{guru} (the default is @samp{normal}). |
| 19080 | |
| 19081 | @item show cris-mode |
| 19082 | Show the current CRIS mode. |
| 19083 | @end table |
| 19084 | |
| 19085 | @node Super-H |
| 19086 | @subsection Renesas Super-H |
| 19087 | @cindex Super-H |
| 19088 | |
| 19089 | For the Renesas Super-H processor, @value{GDBN} provides these |
| 19090 | commands: |
| 19091 | |
| 19092 | @table @code |
| 19093 | @item regs |
| 19094 | @kindex regs@r{, Super-H} |
| 19095 | Show the values of all Super-H registers. |
| 19096 | |
| 19097 | @item set sh calling-convention @var{convention} |
| 19098 | @kindex set sh calling-convention |
| 19099 | Set the calling-convention used when calling functions from @value{GDBN}. |
| 19100 | Allowed values are @samp{gcc}, which is the default setting, and @samp{renesas}. |
| 19101 | With the @samp{gcc} setting, functions are called using the @value{NGCC} calling |
| 19102 | convention. If the DWARF-2 information of the called function specifies |
| 19103 | that the function follows the Renesas calling convention, the function |
| 19104 | is called using the Renesas calling convention. If the calling convention |
| 19105 | is set to @samp{renesas}, the Renesas calling convention is always used, |
| 19106 | regardless of the DWARF-2 information. This can be used to override the |
| 19107 | default of @samp{gcc} if debug information is missing, or the compiler |
| 19108 | does not emit the DWARF-2 calling convention entry for a function. |
| 19109 | |
| 19110 | @item show sh calling-convention |
| 19111 | @kindex show sh calling-convention |
| 19112 | Show the current calling convention setting. |
| 19113 | |
| 19114 | @end table |
| 19115 | |
| 19116 | |
| 19117 | @node Architectures |
| 19118 | @section Architectures |
| 19119 | |
| 19120 | This section describes characteristics of architectures that affect |
| 19121 | all uses of @value{GDBN} with the architecture, both native and cross. |
| 19122 | |
| 19123 | @menu |
| 19124 | * i386:: |
| 19125 | * A29K:: |
| 19126 | * Alpha:: |
| 19127 | * MIPS:: |
| 19128 | * HPPA:: HP PA architecture |
| 19129 | * SPU:: Cell Broadband Engine SPU architecture |
| 19130 | * PowerPC:: |
| 19131 | @end menu |
| 19132 | |
| 19133 | @node i386 |
| 19134 | @subsection x86 Architecture-specific Issues |
| 19135 | |
| 19136 | @table @code |
| 19137 | @item set struct-convention @var{mode} |
| 19138 | @kindex set struct-convention |
| 19139 | @cindex struct return convention |
| 19140 | @cindex struct/union returned in registers |
| 19141 | Set the convention used by the inferior to return @code{struct}s and |
| 19142 | @code{union}s from functions to @var{mode}. Possible values of |
| 19143 | @var{mode} are @code{"pcc"}, @code{"reg"}, and @code{"default"} (the |
| 19144 | default). @code{"default"} or @code{"pcc"} means that @code{struct}s |
| 19145 | are returned on the stack, while @code{"reg"} means that a |
| 19146 | @code{struct} or a @code{union} whose size is 1, 2, 4, or 8 bytes will |
| 19147 | be returned in a register. |
| 19148 | |
| 19149 | @item show struct-convention |
| 19150 | @kindex show struct-convention |
| 19151 | Show the current setting of the convention to return @code{struct}s |
| 19152 | from functions. |
| 19153 | @end table |
| 19154 | |
| 19155 | @node A29K |
| 19156 | @subsection A29K |
| 19157 | |
| 19158 | @table @code |
| 19159 | |
| 19160 | @kindex set rstack_high_address |
| 19161 | @cindex AMD 29K register stack |
| 19162 | @cindex register stack, AMD29K |
| 19163 | @item set rstack_high_address @var{address} |
| 19164 | On AMD 29000 family processors, registers are saved in a separate |
| 19165 | @dfn{register stack}. There is no way for @value{GDBN} to determine the |
| 19166 | extent of this stack. Normally, @value{GDBN} just assumes that the |
| 19167 | stack is ``large enough''. This may result in @value{GDBN} referencing |
| 19168 | memory locations that do not exist. If necessary, you can get around |
| 19169 | this problem by specifying the ending address of the register stack with |
| 19170 | the @code{set rstack_high_address} command. The argument should be an |
| 19171 | address, which you probably want to precede with @samp{0x} to specify in |
| 19172 | hexadecimal. |
| 19173 | |
| 19174 | @kindex show rstack_high_address |
| 19175 | @item show rstack_high_address |
| 19176 | Display the current limit of the register stack, on AMD 29000 family |
| 19177 | processors. |
| 19178 | |
| 19179 | @end table |
| 19180 | |
| 19181 | @node Alpha |
| 19182 | @subsection Alpha |
| 19183 | |
| 19184 | See the following section. |
| 19185 | |
| 19186 | @node MIPS |
| 19187 | @subsection MIPS |
| 19188 | |
| 19189 | @cindex stack on Alpha |
| 19190 | @cindex stack on MIPS |
| 19191 | @cindex Alpha stack |
| 19192 | @cindex MIPS stack |
| 19193 | Alpha- and MIPS-based computers use an unusual stack frame, which |
| 19194 | sometimes requires @value{GDBN} to search backward in the object code to |
| 19195 | find the beginning of a function. |
| 19196 | |
| 19197 | @cindex response time, MIPS debugging |
| 19198 | To improve response time (especially for embedded applications, where |
| 19199 | @value{GDBN} may be restricted to a slow serial line for this search) |
| 19200 | you may want to limit the size of this search, using one of these |
| 19201 | commands: |
| 19202 | |
| 19203 | @table @code |
| 19204 | @cindex @code{heuristic-fence-post} (Alpha, MIPS) |
| 19205 | @item set heuristic-fence-post @var{limit} |
| 19206 | Restrict @value{GDBN} to examining at most @var{limit} bytes in its |
| 19207 | search for the beginning of a function. A value of @var{0} (the |
| 19208 | default) means there is no limit. However, except for @var{0}, the |
| 19209 | larger the limit the more bytes @code{heuristic-fence-post} must search |
| 19210 | and therefore the longer it takes to run. You should only need to use |
| 19211 | this command when debugging a stripped executable. |
| 19212 | |
| 19213 | @item show heuristic-fence-post |
| 19214 | Display the current limit. |
| 19215 | @end table |
| 19216 | |
| 19217 | @noindent |
| 19218 | These commands are available @emph{only} when @value{GDBN} is configured |
| 19219 | for debugging programs on Alpha or MIPS processors. |
| 19220 | |
| 19221 | Several MIPS-specific commands are available when debugging MIPS |
| 19222 | programs: |
| 19223 | |
| 19224 | @table @code |
| 19225 | @item set mips abi @var{arg} |
| 19226 | @kindex set mips abi |
| 19227 | @cindex set ABI for MIPS |
| 19228 | Tell @value{GDBN} which MIPS ABI is used by the inferior. Possible |
| 19229 | values of @var{arg} are: |
| 19230 | |
| 19231 | @table @samp |
| 19232 | @item auto |
| 19233 | The default ABI associated with the current binary (this is the |
| 19234 | default). |
| 19235 | @item o32 |
| 19236 | @item o64 |
| 19237 | @item n32 |
| 19238 | @item n64 |
| 19239 | @item eabi32 |
| 19240 | @item eabi64 |
| 19241 | @item auto |
| 19242 | @end table |
| 19243 | |
| 19244 | @item show mips abi |
| 19245 | @kindex show mips abi |
| 19246 | Show the MIPS ABI used by @value{GDBN} to debug the inferior. |
| 19247 | |
| 19248 | @item set mipsfpu |
| 19249 | @itemx show mipsfpu |
| 19250 | @xref{MIPS Embedded, set mipsfpu}. |
| 19251 | |
| 19252 | @item set mips mask-address @var{arg} |
| 19253 | @kindex set mips mask-address |
| 19254 | @cindex MIPS addresses, masking |
| 19255 | This command determines whether the most-significant 32 bits of 64-bit |
| 19256 | MIPS addresses are masked off. The argument @var{arg} can be |
| 19257 | @samp{on}, @samp{off}, or @samp{auto}. The latter is the default |
| 19258 | setting, which lets @value{GDBN} determine the correct value. |
| 19259 | |
| 19260 | @item show mips mask-address |
| 19261 | @kindex show mips mask-address |
| 19262 | Show whether the upper 32 bits of MIPS addresses are masked off or |
| 19263 | not. |
| 19264 | |
| 19265 | @item set remote-mips64-transfers-32bit-regs |
| 19266 | @kindex set remote-mips64-transfers-32bit-regs |
| 19267 | This command controls compatibility with 64-bit MIPS targets that |
| 19268 | transfer data in 32-bit quantities. If you have an old MIPS 64 target |
| 19269 | that transfers 32 bits for some registers, like @sc{sr} and @sc{fsr}, |
| 19270 | and 64 bits for other registers, set this option to @samp{on}. |
| 19271 | |
| 19272 | @item show remote-mips64-transfers-32bit-regs |
| 19273 | @kindex show remote-mips64-transfers-32bit-regs |
| 19274 | Show the current setting of compatibility with older MIPS 64 targets. |
| 19275 | |
| 19276 | @item set debug mips |
| 19277 | @kindex set debug mips |
| 19278 | This command turns on and off debugging messages for the MIPS-specific |
| 19279 | target code in @value{GDBN}. |
| 19280 | |
| 19281 | @item show debug mips |
| 19282 | @kindex show debug mips |
| 19283 | Show the current setting of MIPS debugging messages. |
| 19284 | @end table |
| 19285 | |
| 19286 | |
| 19287 | @node HPPA |
| 19288 | @subsection HPPA |
| 19289 | @cindex HPPA support |
| 19290 | |
| 19291 | When @value{GDBN} is debugging the HP PA architecture, it provides the |
| 19292 | following special commands: |
| 19293 | |
| 19294 | @table @code |
| 19295 | @item set debug hppa |
| 19296 | @kindex set debug hppa |
| 19297 | This command determines whether HPPA architecture-specific debugging |
| 19298 | messages are to be displayed. |
| 19299 | |
| 19300 | @item show debug hppa |
| 19301 | Show whether HPPA debugging messages are displayed. |
| 19302 | |
| 19303 | @item maint print unwind @var{address} |
| 19304 | @kindex maint print unwind@r{, HPPA} |
| 19305 | This command displays the contents of the unwind table entry at the |
| 19306 | given @var{address}. |
| 19307 | |
| 19308 | @end table |
| 19309 | |
| 19310 | |
| 19311 | @node SPU |
| 19312 | @subsection Cell Broadband Engine SPU architecture |
| 19313 | @cindex Cell Broadband Engine |
| 19314 | @cindex SPU |
| 19315 | |
| 19316 | When @value{GDBN} is debugging the Cell Broadband Engine SPU architecture, |
| 19317 | it provides the following special commands: |
| 19318 | |
| 19319 | @table @code |
| 19320 | @item info spu event |
| 19321 | @kindex info spu |
| 19322 | Display SPU event facility status. Shows current event mask |
| 19323 | and pending event status. |
| 19324 | |
| 19325 | @item info spu signal |
| 19326 | Display SPU signal notification facility status. Shows pending |
| 19327 | signal-control word and signal notification mode of both signal |
| 19328 | notification channels. |
| 19329 | |
| 19330 | @item info spu mailbox |
| 19331 | Display SPU mailbox facility status. Shows all pending entries, |
| 19332 | in order of processing, in each of the SPU Write Outbound, |
| 19333 | SPU Write Outbound Interrupt, and SPU Read Inbound mailboxes. |
| 19334 | |
| 19335 | @item info spu dma |
| 19336 | Display MFC DMA status. Shows all pending commands in the MFC |
| 19337 | DMA queue. For each entry, opcode, tag, class IDs, effective |
| 19338 | and local store addresses and transfer size are shown. |
| 19339 | |
| 19340 | @item info spu proxydma |
| 19341 | Display MFC Proxy-DMA status. Shows all pending commands in the MFC |
| 19342 | Proxy-DMA queue. For each entry, opcode, tag, class IDs, effective |
| 19343 | and local store addresses and transfer size are shown. |
| 19344 | |
| 19345 | @end table |
| 19346 | |
| 19347 | When @value{GDBN} is debugging a combined PowerPC/SPU application |
| 19348 | on the Cell Broadband Engine, it provides in addition the following |
| 19349 | special commands: |
| 19350 | |
| 19351 | @table @code |
| 19352 | @item set spu stop-on-load @var{arg} |
| 19353 | @kindex set spu |
| 19354 | Set whether to stop for new SPE threads. When set to @code{on}, @value{GDBN} |
| 19355 | will give control to the user when a new SPE thread enters its @code{main} |
| 19356 | function. The default is @code{off}. |
| 19357 | |
| 19358 | @item show spu stop-on-load |
| 19359 | @kindex show spu |
| 19360 | Show whether to stop for new SPE threads. |
| 19361 | |
| 19362 | @item set spu auto-flush-cache @var{arg} |
| 19363 | Set whether to automatically flush the software-managed cache. When set to |
| 19364 | @code{on}, @value{GDBN} will automatically cause the SPE software-managed |
| 19365 | cache to be flushed whenever SPE execution stops. This provides a consistent |
| 19366 | view of PowerPC memory that is accessed via the cache. If an application |
| 19367 | does not use the software-managed cache, this option has no effect. |
| 19368 | |
| 19369 | @item show spu auto-flush-cache |
| 19370 | Show whether to automatically flush the software-managed cache. |
| 19371 | |
| 19372 | @end table |
| 19373 | |
| 19374 | @node PowerPC |
| 19375 | @subsection PowerPC |
| 19376 | @cindex PowerPC architecture |
| 19377 | |
| 19378 | When @value{GDBN} is debugging the PowerPC architecture, it provides a set of |
| 19379 | pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point |
| 19380 | numbers stored in the floating point registers. These values must be stored |
| 19381 | in two consecutive registers, always starting at an even register like |
| 19382 | @code{f0} or @code{f2}. |
| 19383 | |
| 19384 | The pseudo-registers go from @code{$dl0} through @code{$dl15}, and are formed |
| 19385 | by joining the even/odd register pairs @code{f0} and @code{f1} for @code{$dl0}, |
| 19386 | @code{f2} and @code{f3} for @code{$dl1} and so on. |
| 19387 | |
| 19388 | For POWER7 processors, @value{GDBN} provides a set of pseudo-registers, the 64-bit |
| 19389 | wide Extended Floating Point Registers (@samp{f32} through @samp{f63}). |
| 19390 | |
| 19391 | |
| 19392 | @node Controlling GDB |
| 19393 | @chapter Controlling @value{GDBN} |
| 19394 | |
| 19395 | You can alter the way @value{GDBN} interacts with you by using the |
| 19396 | @code{set} command. For commands controlling how @value{GDBN} displays |
| 19397 | data, see @ref{Print Settings, ,Print Settings}. Other settings are |
| 19398 | described here. |
| 19399 | |
| 19400 | @menu |
| 19401 | * Prompt:: Prompt |
| 19402 | * Editing:: Command editing |
| 19403 | * Command History:: Command history |
| 19404 | * Screen Size:: Screen size |
| 19405 | * Numbers:: Numbers |
| 19406 | * ABI:: Configuring the current ABI |
| 19407 | * Messages/Warnings:: Optional warnings and messages |
| 19408 | * Debugging Output:: Optional messages about internal happenings |
| 19409 | * Other Misc Settings:: Other Miscellaneous Settings |
| 19410 | @end menu |
| 19411 | |
| 19412 | @node Prompt |
| 19413 | @section Prompt |
| 19414 | |
| 19415 | @cindex prompt |
| 19416 | |
| 19417 | @value{GDBN} indicates its readiness to read a command by printing a string |
| 19418 | called the @dfn{prompt}. This string is normally @samp{(@value{GDBP})}. You |
| 19419 | can change the prompt string with the @code{set prompt} command. For |
| 19420 | instance, when debugging @value{GDBN} with @value{GDBN}, it is useful to change |
| 19421 | the prompt in one of the @value{GDBN} sessions so that you can always tell |
| 19422 | which one you are talking to. |
| 19423 | |
| 19424 | @emph{Note:} @code{set prompt} does not add a space for you after the |
| 19425 | prompt you set. This allows you to set a prompt which ends in a space |
| 19426 | or a prompt that does not. |
| 19427 | |
| 19428 | @table @code |
| 19429 | @kindex set prompt |
| 19430 | @item set prompt @var{newprompt} |
| 19431 | Directs @value{GDBN} to use @var{newprompt} as its prompt string henceforth. |
| 19432 | |
| 19433 | @kindex show prompt |
| 19434 | @item show prompt |
| 19435 | Prints a line of the form: @samp{Gdb's prompt is: @var{your-prompt}} |
| 19436 | @end table |
| 19437 | |
| 19438 | @node Editing |
| 19439 | @section Command Editing |
| 19440 | @cindex readline |
| 19441 | @cindex command line editing |
| 19442 | |
| 19443 | @value{GDBN} reads its input commands via the @dfn{Readline} interface. This |
| 19444 | @sc{gnu} library provides consistent behavior for programs which provide a |
| 19445 | command line interface to the user. Advantages are @sc{gnu} Emacs-style |
| 19446 | or @dfn{vi}-style inline editing of commands, @code{csh}-like history |
| 19447 | substitution, and a storage and recall of command history across |
| 19448 | debugging sessions. |
| 19449 | |
| 19450 | You may control the behavior of command line editing in @value{GDBN} with the |
| 19451 | command @code{set}. |
| 19452 | |
| 19453 | @table @code |
| 19454 | @kindex set editing |
| 19455 | @cindex editing |
| 19456 | @item set editing |
| 19457 | @itemx set editing on |
| 19458 | Enable command line editing (enabled by default). |
| 19459 | |
| 19460 | @item set editing off |
| 19461 | Disable command line editing. |
| 19462 | |
| 19463 | @kindex show editing |
| 19464 | @item show editing |
| 19465 | Show whether command line editing is enabled. |
| 19466 | @end table |
| 19467 | |
| 19468 | @ifset SYSTEM_READLINE |
| 19469 | @xref{Command Line Editing, , , rluserman, GNU Readline Library}, |
| 19470 | @end ifset |
| 19471 | @ifclear SYSTEM_READLINE |
| 19472 | @xref{Command Line Editing}, |
| 19473 | @end ifclear |
| 19474 | for more details about the Readline |
| 19475 | interface. Users unfamiliar with @sc{gnu} Emacs or @code{vi} are |
| 19476 | encouraged to read that chapter. |
| 19477 | |
| 19478 | @node Command History |
| 19479 | @section Command History |
| 19480 | @cindex command history |
| 19481 | |
| 19482 | @value{GDBN} can keep track of the commands you type during your |
| 19483 | debugging sessions, so that you can be certain of precisely what |
| 19484 | happened. Use these commands to manage the @value{GDBN} command |
| 19485 | history facility. |
| 19486 | |
| 19487 | @value{GDBN} uses the @sc{gnu} History library, a part of the Readline |
| 19488 | package, to provide the history facility. |
| 19489 | @ifset SYSTEM_READLINE |
| 19490 | @xref{Using History Interactively, , , history, GNU History Library}, |
| 19491 | @end ifset |
| 19492 | @ifclear SYSTEM_READLINE |
| 19493 | @xref{Using History Interactively}, |
| 19494 | @end ifclear |
| 19495 | for the detailed description of the History library. |
| 19496 | |
| 19497 | To issue a command to @value{GDBN} without affecting certain aspects of |
| 19498 | the state which is seen by users, prefix it with @samp{server } |
| 19499 | (@pxref{Server Prefix}). This |
| 19500 | means that this command will not affect the command history, nor will it |
| 19501 | affect @value{GDBN}'s notion of which command to repeat if @key{RET} is |
| 19502 | pressed on a line by itself. |
| 19503 | |
| 19504 | @cindex @code{server}, command prefix |
| 19505 | The server prefix does not affect the recording of values into the value |
| 19506 | history; to print a value without recording it into the value history, |
| 19507 | use the @code{output} command instead of the @code{print} command. |
| 19508 | |
| 19509 | Here is the description of @value{GDBN} commands related to command |
| 19510 | history. |
| 19511 | |
| 19512 | @table @code |
| 19513 | @cindex history substitution |
| 19514 | @cindex history file |
| 19515 | @kindex set history filename |
| 19516 | @cindex @env{GDBHISTFILE}, environment variable |
| 19517 | @item set history filename @var{fname} |
| 19518 | Set the name of the @value{GDBN} command history file to @var{fname}. |
| 19519 | This is the file where @value{GDBN} reads an initial command history |
| 19520 | list, and where it writes the command history from this session when it |
| 19521 | exits. You can access this list through history expansion or through |
| 19522 | the history command editing characters listed below. This file defaults |
| 19523 | to the value of the environment variable @code{GDBHISTFILE}, or to |
| 19524 | @file{./.gdb_history} (@file{./_gdb_history} on MS-DOS) if this variable |
| 19525 | is not set. |
| 19526 | |
| 19527 | @cindex save command history |
| 19528 | @kindex set history save |
| 19529 | @item set history save |
| 19530 | @itemx set history save on |
| 19531 | Record command history in a file, whose name may be specified with the |
| 19532 | @code{set history filename} command. By default, this option is disabled. |
| 19533 | |
| 19534 | @item set history save off |
| 19535 | Stop recording command history in a file. |
| 19536 | |
| 19537 | @cindex history size |
| 19538 | @kindex set history size |
| 19539 | @cindex @env{HISTSIZE}, environment variable |
| 19540 | @item set history size @var{size} |
| 19541 | Set the number of commands which @value{GDBN} keeps in its history list. |
| 19542 | This defaults to the value of the environment variable |
| 19543 | @code{HISTSIZE}, or to 256 if this variable is not set. |
| 19544 | @end table |
| 19545 | |
| 19546 | History expansion assigns special meaning to the character @kbd{!}. |
| 19547 | @ifset SYSTEM_READLINE |
| 19548 | @xref{Event Designators, , , history, GNU History Library}, |
| 19549 | @end ifset |
| 19550 | @ifclear SYSTEM_READLINE |
| 19551 | @xref{Event Designators}, |
| 19552 | @end ifclear |
| 19553 | for more details. |
| 19554 | |
| 19555 | @cindex history expansion, turn on/off |
| 19556 | Since @kbd{!} is also the logical not operator in C, history expansion |
| 19557 | is off by default. If you decide to enable history expansion with the |
| 19558 | @code{set history expansion on} command, you may sometimes need to |
| 19559 | follow @kbd{!} (when it is used as logical not, in an expression) with |
| 19560 | a space or a tab to prevent it from being expanded. The readline |
| 19561 | history facilities do not attempt substitution on the strings |
| 19562 | @kbd{!=} and @kbd{!(}, even when history expansion is enabled. |
| 19563 | |
| 19564 | The commands to control history expansion are: |
| 19565 | |
| 19566 | @table @code |
| 19567 | @item set history expansion on |
| 19568 | @itemx set history expansion |
| 19569 | @kindex set history expansion |
| 19570 | Enable history expansion. History expansion is off by default. |
| 19571 | |
| 19572 | @item set history expansion off |
| 19573 | Disable history expansion. |
| 19574 | |
| 19575 | @c @group |
| 19576 | @kindex show history |
| 19577 | @item show history |
| 19578 | @itemx show history filename |
| 19579 | @itemx show history save |
| 19580 | @itemx show history size |
| 19581 | @itemx show history expansion |
| 19582 | These commands display the state of the @value{GDBN} history parameters. |
| 19583 | @code{show history} by itself displays all four states. |
| 19584 | @c @end group |
| 19585 | @end table |
| 19586 | |
| 19587 | @table @code |
| 19588 | @kindex show commands |
| 19589 | @cindex show last commands |
| 19590 | @cindex display command history |
| 19591 | @item show commands |
| 19592 | Display the last ten commands in the command history. |
| 19593 | |
| 19594 | @item show commands @var{n} |
| 19595 | Print ten commands centered on command number @var{n}. |
| 19596 | |
| 19597 | @item show commands + |
| 19598 | Print ten commands just after the commands last printed. |
| 19599 | @end table |
| 19600 | |
| 19601 | @node Screen Size |
| 19602 | @section Screen Size |
| 19603 | @cindex size of screen |
| 19604 | @cindex pauses in output |
| 19605 | |
| 19606 | Certain commands to @value{GDBN} may produce large amounts of |
| 19607 | information output to the screen. To help you read all of it, |
| 19608 | @value{GDBN} pauses and asks you for input at the end of each page of |
| 19609 | output. Type @key{RET} when you want to continue the output, or @kbd{q} |
| 19610 | to discard the remaining output. Also, the screen width setting |
| 19611 | determines when to wrap lines of output. Depending on what is being |
| 19612 | printed, @value{GDBN} tries to break the line at a readable place, |
| 19613 | rather than simply letting it overflow onto the following line. |
| 19614 | |
| 19615 | Normally @value{GDBN} knows the size of the screen from the terminal |
| 19616 | driver software. For example, on Unix @value{GDBN} uses the termcap data base |
| 19617 | together with the value of the @code{TERM} environment variable and the |
| 19618 | @code{stty rows} and @code{stty cols} settings. If this is not correct, |
| 19619 | you can override it with the @code{set height} and @code{set |
| 19620 | width} commands: |
| 19621 | |
| 19622 | @table @code |
| 19623 | @kindex set height |
| 19624 | @kindex set width |
| 19625 | @kindex show width |
| 19626 | @kindex show height |
| 19627 | @item set height @var{lpp} |
| 19628 | @itemx show height |
| 19629 | @itemx set width @var{cpl} |
| 19630 | @itemx show width |
| 19631 | These @code{set} commands specify a screen height of @var{lpp} lines and |
| 19632 | a screen width of @var{cpl} characters. The associated @code{show} |
| 19633 | commands display the current settings. |
| 19634 | |
| 19635 | If you specify a height of zero lines, @value{GDBN} does not pause during |
| 19636 | output no matter how long the output is. This is useful if output is to a |
| 19637 | file or to an editor buffer. |
| 19638 | |
| 19639 | Likewise, you can specify @samp{set width 0} to prevent @value{GDBN} |
| 19640 | from wrapping its output. |
| 19641 | |
| 19642 | @item set pagination on |
| 19643 | @itemx set pagination off |
| 19644 | @kindex set pagination |
| 19645 | Turn the output pagination on or off; the default is on. Turning |
| 19646 | pagination off is the alternative to @code{set height 0}. Note that |
| 19647 | running @value{GDBN} with the @option{--batch} option (@pxref{Mode |
| 19648 | Options, -batch}) also automatically disables pagination. |
| 19649 | |
| 19650 | @item show pagination |
| 19651 | @kindex show pagination |
| 19652 | Show the current pagination mode. |
| 19653 | @end table |
| 19654 | |
| 19655 | @node Numbers |
| 19656 | @section Numbers |
| 19657 | @cindex number representation |
| 19658 | @cindex entering numbers |
| 19659 | |
| 19660 | You can always enter numbers in octal, decimal, or hexadecimal in |
| 19661 | @value{GDBN} by the usual conventions: octal numbers begin with |
| 19662 | @samp{0}, decimal numbers end with @samp{.}, and hexadecimal numbers |
| 19663 | begin with @samp{0x}. Numbers that neither begin with @samp{0} or |
| 19664 | @samp{0x}, nor end with a @samp{.} are, by default, entered in base |
| 19665 | 10; likewise, the default display for numbers---when no particular |
| 19666 | format is specified---is base 10. You can change the default base for |
| 19667 | both input and output with the commands described below. |
| 19668 | |
| 19669 | @table @code |
| 19670 | @kindex set input-radix |
| 19671 | @item set input-radix @var{base} |
| 19672 | Set the default base for numeric input. Supported choices |
| 19673 | for @var{base} are decimal 8, 10, or 16. @var{base} must itself be |
| 19674 | specified either unambiguously or using the current input radix; for |
| 19675 | example, any of |
| 19676 | |
| 19677 | @smallexample |
| 19678 | set input-radix 012 |
| 19679 | set input-radix 10. |
| 19680 | set input-radix 0xa |
| 19681 | @end smallexample |
| 19682 | |
| 19683 | @noindent |
| 19684 | sets the input base to decimal. On the other hand, @samp{set input-radix 10} |
| 19685 | leaves the input radix unchanged, no matter what it was, since |
| 19686 | @samp{10}, being without any leading or trailing signs of its base, is |
| 19687 | interpreted in the current radix. Thus, if the current radix is 16, |
| 19688 | @samp{10} is interpreted in hex, i.e.@: as 16 decimal, which doesn't |
| 19689 | change the radix. |
| 19690 | |
| 19691 | @kindex set output-radix |
| 19692 | @item set output-radix @var{base} |
| 19693 | Set the default base for numeric display. Supported choices |
| 19694 | for @var{base} are decimal 8, 10, or 16. @var{base} must itself be |
| 19695 | specified either unambiguously or using the current input radix. |
| 19696 | |
| 19697 | @kindex show input-radix |
| 19698 | @item show input-radix |
| 19699 | Display the current default base for numeric input. |
| 19700 | |
| 19701 | @kindex show output-radix |
| 19702 | @item show output-radix |
| 19703 | Display the current default base for numeric display. |
| 19704 | |
| 19705 | @item set radix @r{[}@var{base}@r{]} |
| 19706 | @itemx show radix |
| 19707 | @kindex set radix |
| 19708 | @kindex show radix |
| 19709 | These commands set and show the default base for both input and output |
| 19710 | of numbers. @code{set radix} sets the radix of input and output to |
| 19711 | the same base; without an argument, it resets the radix back to its |
| 19712 | default value of 10. |
| 19713 | |
| 19714 | @end table |
| 19715 | |
| 19716 | @node ABI |
| 19717 | @section Configuring the Current ABI |
| 19718 | |
| 19719 | @value{GDBN} can determine the @dfn{ABI} (Application Binary Interface) of your |
| 19720 | application automatically. However, sometimes you need to override its |
| 19721 | conclusions. Use these commands to manage @value{GDBN}'s view of the |
| 19722 | current ABI. |
| 19723 | |
| 19724 | @cindex OS ABI |
| 19725 | @kindex set osabi |
| 19726 | @kindex show osabi |
| 19727 | |
| 19728 | One @value{GDBN} configuration can debug binaries for multiple operating |
| 19729 | system targets, either via remote debugging or native emulation. |
| 19730 | @value{GDBN} will autodetect the @dfn{OS ABI} (Operating System ABI) in use, |
| 19731 | but you can override its conclusion using the @code{set osabi} command. |
| 19732 | One example where this is useful is in debugging of binaries which use |
| 19733 | an alternate C library (e.g.@: @sc{uClibc} for @sc{gnu}/Linux) which does |
| 19734 | not have the same identifying marks that the standard C library for your |
| 19735 | platform provides. |
| 19736 | |
| 19737 | @table @code |
| 19738 | @item show osabi |
| 19739 | Show the OS ABI currently in use. |
| 19740 | |
| 19741 | @item set osabi |
| 19742 | With no argument, show the list of registered available OS ABI's. |
| 19743 | |
| 19744 | @item set osabi @var{abi} |
| 19745 | Set the current OS ABI to @var{abi}. |
| 19746 | @end table |
| 19747 | |
| 19748 | @cindex float promotion |
| 19749 | |
| 19750 | Generally, the way that an argument of type @code{float} is passed to a |
| 19751 | function depends on whether the function is prototyped. For a prototyped |
| 19752 | (i.e.@: ANSI/ISO style) function, @code{float} arguments are passed unchanged, |
| 19753 | according to the architecture's convention for @code{float}. For unprototyped |
| 19754 | (i.e.@: K&R style) functions, @code{float} arguments are first promoted to type |
| 19755 | @code{double} and then passed. |
| 19756 | |
| 19757 | Unfortunately, some forms of debug information do not reliably indicate whether |
| 19758 | a function is prototyped. If @value{GDBN} calls a function that is not marked |
| 19759 | as prototyped, it consults @kbd{set coerce-float-to-double}. |
| 19760 | |
| 19761 | @table @code |
| 19762 | @kindex set coerce-float-to-double |
| 19763 | @item set coerce-float-to-double |
| 19764 | @itemx set coerce-float-to-double on |
| 19765 | Arguments of type @code{float} will be promoted to @code{double} when passed |
| 19766 | to an unprototyped function. This is the default setting. |
| 19767 | |
| 19768 | @item set coerce-float-to-double off |
| 19769 | Arguments of type @code{float} will be passed directly to unprototyped |
| 19770 | functions. |
| 19771 | |
| 19772 | @kindex show coerce-float-to-double |
| 19773 | @item show coerce-float-to-double |
| 19774 | Show the current setting of promoting @code{float} to @code{double}. |
| 19775 | @end table |
| 19776 | |
| 19777 | @kindex set cp-abi |
| 19778 | @kindex show cp-abi |
| 19779 | @value{GDBN} needs to know the ABI used for your program's C@t{++} |
| 19780 | objects. The correct C@t{++} ABI depends on which C@t{++} compiler was |
| 19781 | used to build your application. @value{GDBN} only fully supports |
| 19782 | programs with a single C@t{++} ABI; if your program contains code using |
| 19783 | multiple C@t{++} ABI's or if @value{GDBN} can not identify your |
| 19784 | program's ABI correctly, you can tell @value{GDBN} which ABI to use. |
| 19785 | Currently supported ABI's include ``gnu-v2'', for @code{g++} versions |
| 19786 | before 3.0, ``gnu-v3'', for @code{g++} versions 3.0 and later, and |
| 19787 | ``hpaCC'' for the HP ANSI C@t{++} compiler. Other C@t{++} compilers may |
| 19788 | use the ``gnu-v2'' or ``gnu-v3'' ABI's as well. The default setting is |
| 19789 | ``auto''. |
| 19790 | |
| 19791 | @table @code |
| 19792 | @item show cp-abi |
| 19793 | Show the C@t{++} ABI currently in use. |
| 19794 | |
| 19795 | @item set cp-abi |
| 19796 | With no argument, show the list of supported C@t{++} ABI's. |
| 19797 | |
| 19798 | @item set cp-abi @var{abi} |
| 19799 | @itemx set cp-abi auto |
| 19800 | Set the current C@t{++} ABI to @var{abi}, or return to automatic detection. |
| 19801 | @end table |
| 19802 | |
| 19803 | @node Messages/Warnings |
| 19804 | @section Optional Warnings and Messages |
| 19805 | |
| 19806 | @cindex verbose operation |
| 19807 | @cindex optional warnings |
| 19808 | By default, @value{GDBN} is silent about its inner workings. If you are |
| 19809 | running on a slow machine, you may want to use the @code{set verbose} |
| 19810 | command. This makes @value{GDBN} tell you when it does a lengthy |
| 19811 | internal operation, so you will not think it has crashed. |
| 19812 | |
| 19813 | Currently, the messages controlled by @code{set verbose} are those |
| 19814 | which announce that the symbol table for a source file is being read; |
| 19815 | see @code{symbol-file} in @ref{Files, ,Commands to Specify Files}. |
| 19816 | |
| 19817 | @table @code |
| 19818 | @kindex set verbose |
| 19819 | @item set verbose on |
| 19820 | Enables @value{GDBN} output of certain informational messages. |
| 19821 | |
| 19822 | @item set verbose off |
| 19823 | Disables @value{GDBN} output of certain informational messages. |
| 19824 | |
| 19825 | @kindex show verbose |
| 19826 | @item show verbose |
| 19827 | Displays whether @code{set verbose} is on or off. |
| 19828 | @end table |
| 19829 | |
| 19830 | By default, if @value{GDBN} encounters bugs in the symbol table of an |
| 19831 | object file, it is silent; but if you are debugging a compiler, you may |
| 19832 | find this information useful (@pxref{Symbol Errors, ,Errors Reading |
| 19833 | Symbol Files}). |
| 19834 | |
| 19835 | @table @code |
| 19836 | |
| 19837 | @kindex set complaints |
| 19838 | @item set complaints @var{limit} |
| 19839 | Permits @value{GDBN} to output @var{limit} complaints about each type of |
| 19840 | unusual symbols before becoming silent about the problem. Set |
| 19841 | @var{limit} to zero to suppress all complaints; set it to a large number |
| 19842 | to prevent complaints from being suppressed. |
| 19843 | |
| 19844 | @kindex show complaints |
| 19845 | @item show complaints |
| 19846 | Displays how many symbol complaints @value{GDBN} is permitted to produce. |
| 19847 | |
| 19848 | @end table |
| 19849 | |
| 19850 | @anchor{confirmation requests} |
| 19851 | By default, @value{GDBN} is cautious, and asks what sometimes seems to be a |
| 19852 | lot of stupid questions to confirm certain commands. For example, if |
| 19853 | you try to run a program which is already running: |
| 19854 | |
| 19855 | @smallexample |
| 19856 | (@value{GDBP}) run |
| 19857 | The program being debugged has been started already. |
| 19858 | Start it from the beginning? (y or n) |
| 19859 | @end smallexample |
| 19860 | |
| 19861 | If you are willing to unflinchingly face the consequences of your own |
| 19862 | commands, you can disable this ``feature'': |
| 19863 | |
| 19864 | @table @code |
| 19865 | |
| 19866 | @kindex set confirm |
| 19867 | @cindex flinching |
| 19868 | @cindex confirmation |
| 19869 | @cindex stupid questions |
| 19870 | @item set confirm off |
| 19871 | Disables confirmation requests. Note that running @value{GDBN} with |
| 19872 | the @option{--batch} option (@pxref{Mode Options, -batch}) also |
| 19873 | automatically disables confirmation requests. |
| 19874 | |
| 19875 | @item set confirm on |
| 19876 | Enables confirmation requests (the default). |
| 19877 | |
| 19878 | @kindex show confirm |
| 19879 | @item show confirm |
| 19880 | Displays state of confirmation requests. |
| 19881 | |
| 19882 | @end table |
| 19883 | |
| 19884 | @cindex command tracing |
| 19885 | If you need to debug user-defined commands or sourced files you may find it |
| 19886 | useful to enable @dfn{command tracing}. In this mode each command will be |
| 19887 | printed as it is executed, prefixed with one or more @samp{+} symbols, the |
| 19888 | quantity denoting the call depth of each command. |
| 19889 | |
| 19890 | @table @code |
| 19891 | @kindex set trace-commands |
| 19892 | @cindex command scripts, debugging |
| 19893 | @item set trace-commands on |
| 19894 | Enable command tracing. |
| 19895 | @item set trace-commands off |
| 19896 | Disable command tracing. |
| 19897 | @item show trace-commands |
| 19898 | Display the current state of command tracing. |
| 19899 | @end table |
| 19900 | |
| 19901 | @node Debugging Output |
| 19902 | @section Optional Messages about Internal Happenings |
| 19903 | @cindex optional debugging messages |
| 19904 | |
| 19905 | @value{GDBN} has commands that enable optional debugging messages from |
| 19906 | various @value{GDBN} subsystems; normally these commands are of |
| 19907 | interest to @value{GDBN} maintainers, or when reporting a bug. This |
| 19908 | section documents those commands. |
| 19909 | |
| 19910 | @table @code |
| 19911 | @kindex set exec-done-display |
| 19912 | @item set exec-done-display |
| 19913 | Turns on or off the notification of asynchronous commands' |
| 19914 | completion. When on, @value{GDBN} will print a message when an |
| 19915 | asynchronous command finishes its execution. The default is off. |
| 19916 | @kindex show exec-done-display |
| 19917 | @item show exec-done-display |
| 19918 | Displays the current setting of asynchronous command completion |
| 19919 | notification. |
| 19920 | @kindex set debug |
| 19921 | @cindex gdbarch debugging info |
| 19922 | @cindex architecture debugging info |
| 19923 | @item set debug arch |
| 19924 | Turns on or off display of gdbarch debugging info. The default is off |
| 19925 | @kindex show debug |
| 19926 | @item show debug arch |
| 19927 | Displays the current state of displaying gdbarch debugging info. |
| 19928 | @item set debug aix-thread |
| 19929 | @cindex AIX threads |
| 19930 | Display debugging messages about inner workings of the AIX thread |
| 19931 | module. |
| 19932 | @item show debug aix-thread |
| 19933 | Show the current state of AIX thread debugging info display. |
| 19934 | @item set debug dwarf2-die |
| 19935 | @cindex DWARF2 DIEs |
| 19936 | Dump DWARF2 DIEs after they are read in. |
| 19937 | The value is the number of nesting levels to print. |
| 19938 | A value of zero turns off the display. |
| 19939 | @item show debug dwarf2-die |
| 19940 | Show the current state of DWARF2 DIE debugging. |
| 19941 | @item set debug displaced |
| 19942 | @cindex displaced stepping debugging info |
| 19943 | Turns on or off display of @value{GDBN} debugging info for the |
| 19944 | displaced stepping support. The default is off. |
| 19945 | @item show debug displaced |
| 19946 | Displays the current state of displaying @value{GDBN} debugging info |
| 19947 | related to displaced stepping. |
| 19948 | @item set debug event |
| 19949 | @cindex event debugging info |
| 19950 | Turns on or off display of @value{GDBN} event debugging info. The |
| 19951 | default is off. |
| 19952 | @item show debug event |
| 19953 | Displays the current state of displaying @value{GDBN} event debugging |
| 19954 | info. |
| 19955 | @item set debug expression |
| 19956 | @cindex expression debugging info |
| 19957 | Turns on or off display of debugging info about @value{GDBN} |
| 19958 | expression parsing. The default is off. |
| 19959 | @item show debug expression |
| 19960 | Displays the current state of displaying debugging info about |
| 19961 | @value{GDBN} expression parsing. |
| 19962 | @item set debug frame |
| 19963 | @cindex frame debugging info |
| 19964 | Turns on or off display of @value{GDBN} frame debugging info. The |
| 19965 | default is off. |
| 19966 | @item show debug frame |
| 19967 | Displays the current state of displaying @value{GDBN} frame debugging |
| 19968 | info. |
| 19969 | @item set debug gnu-nat |
| 19970 | @cindex @sc{gnu}/Hurd debug messages |
| 19971 | Turns on or off debugging messages from the @sc{gnu}/Hurd debug support. |
| 19972 | @item show debug gnu-nat |
| 19973 | Show the current state of @sc{gnu}/Hurd debugging messages. |
| 19974 | @item set debug infrun |
| 19975 | @cindex inferior debugging info |
| 19976 | Turns on or off display of @value{GDBN} debugging info for running the inferior. |
| 19977 | The default is off. @file{infrun.c} contains GDB's runtime state machine used |
| 19978 | for implementing operations such as single-stepping the inferior. |
| 19979 | @item show debug infrun |
| 19980 | Displays the current state of @value{GDBN} inferior debugging. |
| 19981 | @item set debug jit |
| 19982 | @cindex just-in-time compilation, debugging messages |
| 19983 | Turns on or off debugging messages from JIT debug support. |
| 19984 | @item show debug jit |
| 19985 | Displays the current state of @value{GDBN} JIT debugging. |
| 19986 | @item set debug lin-lwp |
| 19987 | @cindex @sc{gnu}/Linux LWP debug messages |
| 19988 | @cindex Linux lightweight processes |
| 19989 | Turns on or off debugging messages from the Linux LWP debug support. |
| 19990 | @item show debug lin-lwp |
| 19991 | Show the current state of Linux LWP debugging messages. |
| 19992 | @item set debug lin-lwp-async |
| 19993 | @cindex @sc{gnu}/Linux LWP async debug messages |
| 19994 | @cindex Linux lightweight processes |
| 19995 | Turns on or off debugging messages from the Linux LWP async debug support. |
| 19996 | @item show debug lin-lwp-async |
| 19997 | Show the current state of Linux LWP async debugging messages. |
| 19998 | @item set debug observer |
| 19999 | @cindex observer debugging info |
| 20000 | Turns on or off display of @value{GDBN} observer debugging. This |
| 20001 | includes info such as the notification of observable events. |
| 20002 | @item show debug observer |
| 20003 | Displays the current state of observer debugging. |
| 20004 | @item set debug overload |
| 20005 | @cindex C@t{++} overload debugging info |
| 20006 | Turns on or off display of @value{GDBN} C@t{++} overload debugging |
| 20007 | info. This includes info such as ranking of functions, etc. The default |
| 20008 | is off. |
| 20009 | @item show debug overload |
| 20010 | Displays the current state of displaying @value{GDBN} C@t{++} overload |
| 20011 | debugging info. |
| 20012 | @cindex expression parser, debugging info |
| 20013 | @cindex debug expression parser |
| 20014 | @item set debug parser |
| 20015 | Turns on or off the display of expression parser debugging output. |
| 20016 | Internally, this sets the @code{yydebug} variable in the expression |
| 20017 | parser. @xref{Tracing, , Tracing Your Parser, bison, Bison}, for |
| 20018 | details. The default is off. |
| 20019 | @item show debug parser |
| 20020 | Show the current state of expression parser debugging. |
| 20021 | @cindex packets, reporting on stdout |
| 20022 | @cindex serial connections, debugging |
| 20023 | @cindex debug remote protocol |
| 20024 | @cindex remote protocol debugging |
| 20025 | @cindex display remote packets |
| 20026 | @item set debug remote |
| 20027 | Turns on or off display of reports on all packets sent back and forth across |
| 20028 | the serial line to the remote machine. The info is printed on the |
| 20029 | @value{GDBN} standard output stream. The default is off. |
| 20030 | @item show debug remote |
| 20031 | Displays the state of display of remote packets. |
| 20032 | @item set debug serial |
| 20033 | Turns on or off display of @value{GDBN} serial debugging info. The |
| 20034 | default is off. |
| 20035 | @item show debug serial |
| 20036 | Displays the current state of displaying @value{GDBN} serial debugging |
| 20037 | info. |
| 20038 | @item set debug solib-frv |
| 20039 | @cindex FR-V shared-library debugging |
| 20040 | Turns on or off debugging messages for FR-V shared-library code. |
| 20041 | @item show debug solib-frv |
| 20042 | Display the current state of FR-V shared-library code debugging |
| 20043 | messages. |
| 20044 | @item set debug target |
| 20045 | @cindex target debugging info |
| 20046 | Turns on or off display of @value{GDBN} target debugging info. This info |
| 20047 | includes what is going on at the target level of GDB, as it happens. The |
| 20048 | default is 0. Set it to 1 to track events, and to 2 to also track the |
| 20049 | value of large memory transfers. Changes to this flag do not take effect |
| 20050 | until the next time you connect to a target or use the @code{run} command. |
| 20051 | @item show debug target |
| 20052 | Displays the current state of displaying @value{GDBN} target debugging |
| 20053 | info. |
| 20054 | @item set debug timestamp |
| 20055 | @cindex timestampping debugging info |
| 20056 | Turns on or off display of timestamps with @value{GDBN} debugging info. |
| 20057 | When enabled, seconds and microseconds are displayed before each debugging |
| 20058 | message. |
| 20059 | @item show debug timestamp |
| 20060 | Displays the current state of displaying timestamps with @value{GDBN} |
| 20061 | debugging info. |
| 20062 | @item set debugvarobj |
| 20063 | @cindex variable object debugging info |
| 20064 | Turns on or off display of @value{GDBN} variable object debugging |
| 20065 | info. The default is off. |
| 20066 | @item show debugvarobj |
| 20067 | Displays the current state of displaying @value{GDBN} variable object |
| 20068 | debugging info. |
| 20069 | @item set debug xml |
| 20070 | @cindex XML parser debugging |
| 20071 | Turns on or off debugging messages for built-in XML parsers. |
| 20072 | @item show debug xml |
| 20073 | Displays the current state of XML debugging messages. |
| 20074 | @end table |
| 20075 | |
| 20076 | @node Other Misc Settings |
| 20077 | @section Other Miscellaneous Settings |
| 20078 | @cindex miscellaneous settings |
| 20079 | |
| 20080 | @table @code |
| 20081 | @kindex set interactive-mode |
| 20082 | @item set interactive-mode |
| 20083 | If @code{on}, forces @value{GDBN} to assume that GDB was started |
| 20084 | in a terminal. In practice, this means that @value{GDBN} should wait |
| 20085 | for the user to answer queries generated by commands entered at |
| 20086 | the command prompt. If @code{off}, forces @value{GDBN} to operate |
| 20087 | in the opposite mode, and it uses the default answers to all queries. |
| 20088 | If @code{auto} (the default), @value{GDBN} tries to determine whether |
| 20089 | its standard input is a terminal, and works in interactive-mode if it |
| 20090 | is, non-interactively otherwise. |
| 20091 | |
| 20092 | In the vast majority of cases, the debugger should be able to guess |
| 20093 | correctly which mode should be used. But this setting can be useful |
| 20094 | in certain specific cases, such as running a MinGW @value{GDBN} |
| 20095 | inside a cygwin window. |
| 20096 | |
| 20097 | @kindex show interactive-mode |
| 20098 | @item show interactive-mode |
| 20099 | Displays whether the debugger is operating in interactive mode or not. |
| 20100 | @end table |
| 20101 | |
| 20102 | @node Extending GDB |
| 20103 | @chapter Extending @value{GDBN} |
| 20104 | @cindex extending GDB |
| 20105 | |
| 20106 | @value{GDBN} provides two mechanisms for extension. The first is based |
| 20107 | on composition of @value{GDBN} commands, and the second is based on the |
| 20108 | Python scripting language. |
| 20109 | |
| 20110 | To facilitate the use of these extensions, @value{GDBN} is capable |
| 20111 | of evaluating the contents of a file. When doing so, @value{GDBN} |
| 20112 | can recognize which scripting language is being used by looking at |
| 20113 | the filename extension. Files with an unrecognized filename extension |
| 20114 | are always treated as a @value{GDBN} Command Files. |
| 20115 | @xref{Command Files,, Command files}. |
| 20116 | |
| 20117 | You can control how @value{GDBN} evaluates these files with the following |
| 20118 | setting: |
| 20119 | |
| 20120 | @table @code |
| 20121 | @kindex set script-extension |
| 20122 | @kindex show script-extension |
| 20123 | @item set script-extension off |
| 20124 | All scripts are always evaluated as @value{GDBN} Command Files. |
| 20125 | |
| 20126 | @item set script-extension soft |
| 20127 | The debugger determines the scripting language based on filename |
| 20128 | extension. If this scripting language is supported, @value{GDBN} |
| 20129 | evaluates the script using that language. Otherwise, it evaluates |
| 20130 | the file as a @value{GDBN} Command File. |
| 20131 | |
| 20132 | @item set script-extension strict |
| 20133 | The debugger determines the scripting language based on filename |
| 20134 | extension, and evaluates the script using that language. If the |
| 20135 | language is not supported, then the evaluation fails. |
| 20136 | |
| 20137 | @item show script-extension |
| 20138 | Display the current value of the @code{script-extension} option. |
| 20139 | |
| 20140 | @end table |
| 20141 | |
| 20142 | @menu |
| 20143 | * Sequences:: Canned Sequences of Commands |
| 20144 | * Python:: Scripting @value{GDBN} using Python |
| 20145 | @end menu |
| 20146 | |
| 20147 | @node Sequences |
| 20148 | @section Canned Sequences of Commands |
| 20149 | |
| 20150 | Aside from breakpoint commands (@pxref{Break Commands, ,Breakpoint |
| 20151 | Command Lists}), @value{GDBN} provides two ways to store sequences of |
| 20152 | commands for execution as a unit: user-defined commands and command |
| 20153 | files. |
| 20154 | |
| 20155 | @menu |
| 20156 | * Define:: How to define your own commands |
| 20157 | * Hooks:: Hooks for user-defined commands |
| 20158 | * Command Files:: How to write scripts of commands to be stored in a file |
| 20159 | * Output:: Commands for controlled output |
| 20160 | @end menu |
| 20161 | |
| 20162 | @node Define |
| 20163 | @subsection User-defined Commands |
| 20164 | |
| 20165 | @cindex user-defined command |
| 20166 | @cindex arguments, to user-defined commands |
| 20167 | A @dfn{user-defined command} is a sequence of @value{GDBN} commands to |
| 20168 | which you assign a new name as a command. This is done with the |
| 20169 | @code{define} command. User commands may accept up to 10 arguments |
| 20170 | separated by whitespace. Arguments are accessed within the user command |
| 20171 | via @code{$arg0@dots{}$arg9}. A trivial example: |
| 20172 | |
| 20173 | @smallexample |
| 20174 | define adder |
| 20175 | print $arg0 + $arg1 + $arg2 |
| 20176 | end |
| 20177 | @end smallexample |
| 20178 | |
| 20179 | @noindent |
| 20180 | To execute the command use: |
| 20181 | |
| 20182 | @smallexample |
| 20183 | adder 1 2 3 |
| 20184 | @end smallexample |
| 20185 | |
| 20186 | @noindent |
| 20187 | This defines the command @code{adder}, which prints the sum of |
| 20188 | its three arguments. Note the arguments are text substitutions, so they may |
| 20189 | reference variables, use complex expressions, or even perform inferior |
| 20190 | functions calls. |
| 20191 | |
| 20192 | @cindex argument count in user-defined commands |
| 20193 | @cindex how many arguments (user-defined commands) |
| 20194 | In addition, @code{$argc} may be used to find out how many arguments have |
| 20195 | been passed. This expands to a number in the range 0@dots{}10. |
| 20196 | |
| 20197 | @smallexample |
| 20198 | define adder |
| 20199 | if $argc == 2 |
| 20200 | print $arg0 + $arg1 |
| 20201 | end |
| 20202 | if $argc == 3 |
| 20203 | print $arg0 + $arg1 + $arg2 |
| 20204 | end |
| 20205 | end |
| 20206 | @end smallexample |
| 20207 | |
| 20208 | @table @code |
| 20209 | |
| 20210 | @kindex define |
| 20211 | @item define @var{commandname} |
| 20212 | Define a command named @var{commandname}. If there is already a command |
| 20213 | by that name, you are asked to confirm that you want to redefine it. |
| 20214 | @var{commandname} may be a bare command name consisting of letters, |
| 20215 | numbers, dashes, and underscores. It may also start with any predefined |
| 20216 | prefix command. For example, @samp{define target my-target} creates |
| 20217 | a user-defined @samp{target my-target} command. |
| 20218 | |
| 20219 | The definition of the command is made up of other @value{GDBN} command lines, |
| 20220 | which are given following the @code{define} command. The end of these |
| 20221 | commands is marked by a line containing @code{end}. |
| 20222 | |
| 20223 | @kindex document |
| 20224 | @kindex end@r{ (user-defined commands)} |
| 20225 | @item document @var{commandname} |
| 20226 | Document the user-defined command @var{commandname}, so that it can be |
| 20227 | accessed by @code{help}. The command @var{commandname} must already be |
| 20228 | defined. This command reads lines of documentation just as @code{define} |
| 20229 | reads the lines of the command definition, ending with @code{end}. |
| 20230 | After the @code{document} command is finished, @code{help} on command |
| 20231 | @var{commandname} displays the documentation you have written. |
| 20232 | |
| 20233 | You may use the @code{document} command again to change the |
| 20234 | documentation of a command. Redefining the command with @code{define} |
| 20235 | does not change the documentation. |
| 20236 | |
| 20237 | @kindex dont-repeat |
| 20238 | @cindex don't repeat command |
| 20239 | @item dont-repeat |
| 20240 | Used inside a user-defined command, this tells @value{GDBN} that this |
| 20241 | command should not be repeated when the user hits @key{RET} |
| 20242 | (@pxref{Command Syntax, repeat last command}). |
| 20243 | |
| 20244 | @kindex help user-defined |
| 20245 | @item help user-defined |
| 20246 | List all user-defined commands, with the first line of the documentation |
| 20247 | (if any) for each. |
| 20248 | |
| 20249 | @kindex show user |
| 20250 | @item show user |
| 20251 | @itemx show user @var{commandname} |
| 20252 | Display the @value{GDBN} commands used to define @var{commandname} (but |
| 20253 | not its documentation). If no @var{commandname} is given, display the |
| 20254 | definitions for all user-defined commands. |
| 20255 | |
| 20256 | @cindex infinite recursion in user-defined commands |
| 20257 | @kindex show max-user-call-depth |
| 20258 | @kindex set max-user-call-depth |
| 20259 | @item show max-user-call-depth |
| 20260 | @itemx set max-user-call-depth |
| 20261 | The value of @code{max-user-call-depth} controls how many recursion |
| 20262 | levels are allowed in user-defined commands before @value{GDBN} suspects an |
| 20263 | infinite recursion and aborts the command. |
| 20264 | @end table |
| 20265 | |
| 20266 | In addition to the above commands, user-defined commands frequently |
| 20267 | use control flow commands, described in @ref{Command Files}. |
| 20268 | |
| 20269 | When user-defined commands are executed, the |
| 20270 | commands of the definition are not printed. An error in any command |
| 20271 | stops execution of the user-defined command. |
| 20272 | |
| 20273 | If used interactively, commands that would ask for confirmation proceed |
| 20274 | without asking when used inside a user-defined command. Many @value{GDBN} |
| 20275 | commands that normally print messages to say what they are doing omit the |
| 20276 | messages when used in a user-defined command. |
| 20277 | |
| 20278 | @node Hooks |
| 20279 | @subsection User-defined Command Hooks |
| 20280 | @cindex command hooks |
| 20281 | @cindex hooks, for commands |
| 20282 | @cindex hooks, pre-command |
| 20283 | |
| 20284 | @kindex hook |
| 20285 | You may define @dfn{hooks}, which are a special kind of user-defined |
| 20286 | command. Whenever you run the command @samp{foo}, if the user-defined |
| 20287 | command @samp{hook-foo} exists, it is executed (with no arguments) |
| 20288 | before that command. |
| 20289 | |
| 20290 | @cindex hooks, post-command |
| 20291 | @kindex hookpost |
| 20292 | A hook may also be defined which is run after the command you executed. |
| 20293 | Whenever you run the command @samp{foo}, if the user-defined command |
| 20294 | @samp{hookpost-foo} exists, it is executed (with no arguments) after |
| 20295 | that command. Post-execution hooks may exist simultaneously with |
| 20296 | pre-execution hooks, for the same command. |
| 20297 | |
| 20298 | It is valid for a hook to call the command which it hooks. If this |
| 20299 | occurs, the hook is not re-executed, thereby avoiding infinite recursion. |
| 20300 | |
| 20301 | @c It would be nice if hookpost could be passed a parameter indicating |
| 20302 | @c if the command it hooks executed properly or not. FIXME! |
| 20303 | |
| 20304 | @kindex stop@r{, a pseudo-command} |
| 20305 | In addition, a pseudo-command, @samp{stop} exists. Defining |
| 20306 | (@samp{hook-stop}) makes the associated commands execute every time |
| 20307 | execution stops in your program: before breakpoint commands are run, |
| 20308 | displays are printed, or the stack frame is printed. |
| 20309 | |
| 20310 | For example, to ignore @code{SIGALRM} signals while |
| 20311 | single-stepping, but treat them normally during normal execution, |
| 20312 | you could define: |
| 20313 | |
| 20314 | @smallexample |
| 20315 | define hook-stop |
| 20316 | handle SIGALRM nopass |
| 20317 | end |
| 20318 | |
| 20319 | define hook-run |
| 20320 | handle SIGALRM pass |
| 20321 | end |
| 20322 | |
| 20323 | define hook-continue |
| 20324 | handle SIGALRM pass |
| 20325 | end |
| 20326 | @end smallexample |
| 20327 | |
| 20328 | As a further example, to hook at the beginning and end of the @code{echo} |
| 20329 | command, and to add extra text to the beginning and end of the message, |
| 20330 | you could define: |
| 20331 | |
| 20332 | @smallexample |
| 20333 | define hook-echo |
| 20334 | echo <<<--- |
| 20335 | end |
| 20336 | |
| 20337 | define hookpost-echo |
| 20338 | echo --->>>\n |
| 20339 | end |
| 20340 | |
| 20341 | (@value{GDBP}) echo Hello World |
| 20342 | <<<---Hello World--->>> |
| 20343 | (@value{GDBP}) |
| 20344 | |
| 20345 | @end smallexample |
| 20346 | |
| 20347 | You can define a hook for any single-word command in @value{GDBN}, but |
| 20348 | not for command aliases; you should define a hook for the basic command |
| 20349 | name, e.g.@: @code{backtrace} rather than @code{bt}. |
| 20350 | @c FIXME! So how does Joe User discover whether a command is an alias |
| 20351 | @c or not? |
| 20352 | You can hook a multi-word command by adding @code{hook-} or |
| 20353 | @code{hookpost-} to the last word of the command, e.g.@: |
| 20354 | @samp{define target hook-remote} to add a hook to @samp{target remote}. |
| 20355 | |
| 20356 | If an error occurs during the execution of your hook, execution of |
| 20357 | @value{GDBN} commands stops and @value{GDBN} issues a prompt |
| 20358 | (before the command that you actually typed had a chance to run). |
| 20359 | |
| 20360 | If you try to define a hook which does not match any known command, you |
| 20361 | get a warning from the @code{define} command. |
| 20362 | |
| 20363 | @node Command Files |
| 20364 | @subsection Command Files |
| 20365 | |
| 20366 | @cindex command files |
| 20367 | @cindex scripting commands |
| 20368 | A command file for @value{GDBN} is a text file made of lines that are |
| 20369 | @value{GDBN} commands. Comments (lines starting with @kbd{#}) may |
| 20370 | also be included. An empty line in a command file does nothing; it |
| 20371 | does not mean to repeat the last command, as it would from the |
| 20372 | terminal. |
| 20373 | |
| 20374 | You can request the execution of a command file with the @code{source} |
| 20375 | command. Note that the @code{source} command is also used to evaluate |
| 20376 | scripts that are not Command Files. The exact behavior can be configured |
| 20377 | using the @code{script-extension} setting. |
| 20378 | @xref{Extending GDB,, Extending GDB}. |
| 20379 | |
| 20380 | @table @code |
| 20381 | @kindex source |
| 20382 | @cindex execute commands from a file |
| 20383 | @item source [-s] [-v] @var{filename} |
| 20384 | Execute the command file @var{filename}. |
| 20385 | @end table |
| 20386 | |
| 20387 | The lines in a command file are generally executed sequentially, |
| 20388 | unless the order of execution is changed by one of the |
| 20389 | @emph{flow-control commands} described below. The commands are not |
| 20390 | printed as they are executed. An error in any command terminates |
| 20391 | execution of the command file and control is returned to the console. |
| 20392 | |
| 20393 | @value{GDBN} first searches for @var{filename} in the current directory. |
| 20394 | If the file is not found there, and @var{filename} does not specify a |
| 20395 | directory, then @value{GDBN} also looks for the file on the source search path |
| 20396 | (specified with the @samp{directory} command); |
| 20397 | except that @file{$cdir} is not searched because the compilation directory |
| 20398 | is not relevant to scripts. |
| 20399 | |
| 20400 | If @code{-s} is specified, then @value{GDBN} searches for @var{filename} |
| 20401 | on the search path even if @var{filename} specifies a directory. |
| 20402 | The search is done by appending @var{filename} to each element of the |
| 20403 | search path. So, for example, if @var{filename} is @file{mylib/myscript} |
| 20404 | and the search path contains @file{/home/user} then @value{GDBN} will |
| 20405 | look for the script @file{/home/user/mylib/myscript}. |
| 20406 | The search is also done if @var{filename} is an absolute path. |
| 20407 | For example, if @var{filename} is @file{/tmp/myscript} and |
| 20408 | the search path contains @file{/home/user} then @value{GDBN} will |
| 20409 | look for the script @file{/home/user/tmp/myscript}. |
| 20410 | For DOS-like systems, if @var{filename} contains a drive specification, |
| 20411 | it is stripped before concatenation. For example, if @var{filename} is |
| 20412 | @file{d:myscript} and the search path contains @file{c:/tmp} then @value{GDBN} |
| 20413 | will look for the script @file{c:/tmp/myscript}. |
| 20414 | |
| 20415 | If @code{-v}, for verbose mode, is given then @value{GDBN} displays |
| 20416 | each command as it is executed. The option must be given before |
| 20417 | @var{filename}, and is interpreted as part of the filename anywhere else. |
| 20418 | |
| 20419 | Commands that would ask for confirmation if used interactively proceed |
| 20420 | without asking when used in a command file. Many @value{GDBN} commands that |
| 20421 | normally print messages to say what they are doing omit the messages |
| 20422 | when called from command files. |
| 20423 | |
| 20424 | @value{GDBN} also accepts command input from standard input. In this |
| 20425 | mode, normal output goes to standard output and error output goes to |
| 20426 | standard error. Errors in a command file supplied on standard input do |
| 20427 | not terminate execution of the command file---execution continues with |
| 20428 | the next command. |
| 20429 | |
| 20430 | @smallexample |
| 20431 | gdb < cmds > log 2>&1 |
| 20432 | @end smallexample |
| 20433 | |
| 20434 | (The syntax above will vary depending on the shell used.) This example |
| 20435 | will execute commands from the file @file{cmds}. All output and errors |
| 20436 | would be directed to @file{log}. |
| 20437 | |
| 20438 | Since commands stored on command files tend to be more general than |
| 20439 | commands typed interactively, they frequently need to deal with |
| 20440 | complicated situations, such as different or unexpected values of |
| 20441 | variables and symbols, changes in how the program being debugged is |
| 20442 | built, etc. @value{GDBN} provides a set of flow-control commands to |
| 20443 | deal with these complexities. Using these commands, you can write |
| 20444 | complex scripts that loop over data structures, execute commands |
| 20445 | conditionally, etc. |
| 20446 | |
| 20447 | @table @code |
| 20448 | @kindex if |
| 20449 | @kindex else |
| 20450 | @item if |
| 20451 | @itemx else |
| 20452 | This command allows to include in your script conditionally executed |
| 20453 | commands. The @code{if} command takes a single argument, which is an |
| 20454 | expression to evaluate. It is followed by a series of commands that |
| 20455 | are executed only if the expression is true (its value is nonzero). |
| 20456 | There can then optionally be an @code{else} line, followed by a series |
| 20457 | of commands that are only executed if the expression was false. The |
| 20458 | end of the list is marked by a line containing @code{end}. |
| 20459 | |
| 20460 | @kindex while |
| 20461 | @item while |
| 20462 | This command allows to write loops. Its syntax is similar to |
| 20463 | @code{if}: the command takes a single argument, which is an expression |
| 20464 | to evaluate, and must be followed by the commands to execute, one per |
| 20465 | line, terminated by an @code{end}. These commands are called the |
| 20466 | @dfn{body} of the loop. The commands in the body of @code{while} are |
| 20467 | executed repeatedly as long as the expression evaluates to true. |
| 20468 | |
| 20469 | @kindex loop_break |
| 20470 | @item loop_break |
| 20471 | This command exits the @code{while} loop in whose body it is included. |
| 20472 | Execution of the script continues after that @code{while}s @code{end} |
| 20473 | line. |
| 20474 | |
| 20475 | @kindex loop_continue |
| 20476 | @item loop_continue |
| 20477 | This command skips the execution of the rest of the body of commands |
| 20478 | in the @code{while} loop in whose body it is included. Execution |
| 20479 | branches to the beginning of the @code{while} loop, where it evaluates |
| 20480 | the controlling expression. |
| 20481 | |
| 20482 | @kindex end@r{ (if/else/while commands)} |
| 20483 | @item end |
| 20484 | Terminate the block of commands that are the body of @code{if}, |
| 20485 | @code{else}, or @code{while} flow-control commands. |
| 20486 | @end table |
| 20487 | |
| 20488 | |
| 20489 | @node Output |
| 20490 | @subsection Commands for Controlled Output |
| 20491 | |
| 20492 | During the execution of a command file or a user-defined command, normal |
| 20493 | @value{GDBN} output is suppressed; the only output that appears is what is |
| 20494 | explicitly printed by the commands in the definition. This section |
| 20495 | describes three commands useful for generating exactly the output you |
| 20496 | want. |
| 20497 | |
| 20498 | @table @code |
| 20499 | @kindex echo |
| 20500 | @item echo @var{text} |
| 20501 | @c I do not consider backslash-space a standard C escape sequence |
| 20502 | @c because it is not in ANSI. |
| 20503 | Print @var{text}. Nonprinting characters can be included in |
| 20504 | @var{text} using C escape sequences, such as @samp{\n} to print a |
| 20505 | newline. @strong{No newline is printed unless you specify one.} |
| 20506 | In addition to the standard C escape sequences, a backslash followed |
| 20507 | by a space stands for a space. This is useful for displaying a |
| 20508 | string with spaces at the beginning or the end, since leading and |
| 20509 | trailing spaces are otherwise trimmed from all arguments. |
| 20510 | To print @samp{@w{ }and foo =@w{ }}, use the command |
| 20511 | @samp{echo \@w{ }and foo = \@w{ }}. |
| 20512 | |
| 20513 | A backslash at the end of @var{text} can be used, as in C, to continue |
| 20514 | the command onto subsequent lines. For example, |
| 20515 | |
| 20516 | @smallexample |
| 20517 | echo This is some text\n\ |
| 20518 | which is continued\n\ |
| 20519 | onto several lines.\n |
| 20520 | @end smallexample |
| 20521 | |
| 20522 | produces the same output as |
| 20523 | |
| 20524 | @smallexample |
| 20525 | echo This is some text\n |
| 20526 | echo which is continued\n |
| 20527 | echo onto several lines.\n |
| 20528 | @end smallexample |
| 20529 | |
| 20530 | @kindex output |
| 20531 | @item output @var{expression} |
| 20532 | Print the value of @var{expression} and nothing but that value: no |
| 20533 | newlines, no @samp{$@var{nn} = }. The value is not entered in the |
| 20534 | value history either. @xref{Expressions, ,Expressions}, for more information |
| 20535 | on expressions. |
| 20536 | |
| 20537 | @item output/@var{fmt} @var{expression} |
| 20538 | Print the value of @var{expression} in format @var{fmt}. You can use |
| 20539 | the same formats as for @code{print}. @xref{Output Formats,,Output |
| 20540 | Formats}, for more information. |
| 20541 | |
| 20542 | @kindex printf |
| 20543 | @item printf @var{template}, @var{expressions}@dots{} |
| 20544 | Print the values of one or more @var{expressions} under the control of |
| 20545 | the string @var{template}. To print several values, make |
| 20546 | @var{expressions} be a comma-separated list of individual expressions, |
| 20547 | which may be either numbers or pointers. Their values are printed as |
| 20548 | specified by @var{template}, exactly as a C program would do by |
| 20549 | executing the code below: |
| 20550 | |
| 20551 | @smallexample |
| 20552 | printf (@var{template}, @var{expressions}@dots{}); |
| 20553 | @end smallexample |
| 20554 | |
| 20555 | As in @code{C} @code{printf}, ordinary characters in @var{template} |
| 20556 | are printed verbatim, while @dfn{conversion specification} introduced |
| 20557 | by the @samp{%} character cause subsequent @var{expressions} to be |
| 20558 | evaluated, their values converted and formatted according to type and |
| 20559 | style information encoded in the conversion specifications, and then |
| 20560 | printed. |
| 20561 | |
| 20562 | For example, you can print two values in hex like this: |
| 20563 | |
| 20564 | @smallexample |
| 20565 | printf "foo, bar-foo = 0x%x, 0x%x\n", foo, bar-foo |
| 20566 | @end smallexample |
| 20567 | |
| 20568 | @code{printf} supports all the standard @code{C} conversion |
| 20569 | specifications, including the flags and modifiers between the @samp{%} |
| 20570 | character and the conversion letter, with the following exceptions: |
| 20571 | |
| 20572 | @itemize @bullet |
| 20573 | @item |
| 20574 | The argument-ordering modifiers, such as @samp{2$}, are not supported. |
| 20575 | |
| 20576 | @item |
| 20577 | The modifier @samp{*} is not supported for specifying precision or |
| 20578 | width. |
| 20579 | |
| 20580 | @item |
| 20581 | The @samp{'} flag (for separation of digits into groups according to |
| 20582 | @code{LC_NUMERIC'}) is not supported. |
| 20583 | |
| 20584 | @item |
| 20585 | The type modifiers @samp{hh}, @samp{j}, @samp{t}, and @samp{z} are not |
| 20586 | supported. |
| 20587 | |
| 20588 | @item |
| 20589 | The conversion letter @samp{n} (as in @samp{%n}) is not supported. |
| 20590 | |
| 20591 | @item |
| 20592 | The conversion letters @samp{a} and @samp{A} are not supported. |
| 20593 | @end itemize |
| 20594 | |
| 20595 | @noindent |
| 20596 | Note that the @samp{ll} type modifier is supported only if the |
| 20597 | underlying @code{C} implementation used to build @value{GDBN} supports |
| 20598 | the @code{long long int} type, and the @samp{L} type modifier is |
| 20599 | supported only if @code{long double} type is available. |
| 20600 | |
| 20601 | As in @code{C}, @code{printf} supports simple backslash-escape |
| 20602 | sequences, such as @code{\n}, @samp{\t}, @samp{\\}, @samp{\"}, |
| 20603 | @samp{\a}, and @samp{\f}, that consist of backslash followed by a |
| 20604 | single character. Octal and hexadecimal escape sequences are not |
| 20605 | supported. |
| 20606 | |
| 20607 | Additionally, @code{printf} supports conversion specifications for DFP |
| 20608 | (@dfn{Decimal Floating Point}) types using the following length modifiers |
| 20609 | together with a floating point specifier. |
| 20610 | letters: |
| 20611 | |
| 20612 | @itemize @bullet |
| 20613 | @item |
| 20614 | @samp{H} for printing @code{Decimal32} types. |
| 20615 | |
| 20616 | @item |
| 20617 | @samp{D} for printing @code{Decimal64} types. |
| 20618 | |
| 20619 | @item |
| 20620 | @samp{DD} for printing @code{Decimal128} types. |
| 20621 | @end itemize |
| 20622 | |
| 20623 | If the underlying @code{C} implementation used to build @value{GDBN} has |
| 20624 | support for the three length modifiers for DFP types, other modifiers |
| 20625 | such as width and precision will also be available for @value{GDBN} to use. |
| 20626 | |
| 20627 | In case there is no such @code{C} support, no additional modifiers will be |
| 20628 | available and the value will be printed in the standard way. |
| 20629 | |
| 20630 | Here's an example of printing DFP types using the above conversion letters: |
| 20631 | @smallexample |
| 20632 | printf "D32: %Hf - D64: %Df - D128: %DDf\n",1.2345df,1.2E10dd,1.2E1dl |
| 20633 | @end smallexample |
| 20634 | |
| 20635 | @kindex eval |
| 20636 | @item eval @var{template}, @var{expressions}@dots{} |
| 20637 | Convert the values of one or more @var{expressions} under the control of |
| 20638 | the string @var{template} to a command line, and call it. |
| 20639 | |
| 20640 | @end table |
| 20641 | |
| 20642 | @node Python |
| 20643 | @section Scripting @value{GDBN} using Python |
| 20644 | @cindex python scripting |
| 20645 | @cindex scripting with python |
| 20646 | |
| 20647 | You can script @value{GDBN} using the @uref{http://www.python.org/, |
| 20648 | Python programming language}. This feature is available only if |
| 20649 | @value{GDBN} was configured using @option{--with-python}. |
| 20650 | |
| 20651 | @cindex python directory |
| 20652 | Python scripts used by @value{GDBN} should be installed in |
| 20653 | @file{@var{data-directory}/python}, where @var{data-directory} is |
| 20654 | the data directory as determined at @value{GDBN} startup (@pxref{Data Files}). |
| 20655 | This directory, known as the @dfn{python directory}, |
| 20656 | is automatically added to the Python Search Path in order to allow |
| 20657 | the Python interpreter to locate all scripts installed at this location. |
| 20658 | |
| 20659 | @menu |
| 20660 | * Python Commands:: Accessing Python from @value{GDBN}. |
| 20661 | * Python API:: Accessing @value{GDBN} from Python. |
| 20662 | * Auto-loading:: Automatically loading Python code. |
| 20663 | * Python modules:: Python modules provided by @value{GDBN}. |
| 20664 | @end menu |
| 20665 | |
| 20666 | @node Python Commands |
| 20667 | @subsection Python Commands |
| 20668 | @cindex python commands |
| 20669 | @cindex commands to access python |
| 20670 | |
| 20671 | @value{GDBN} provides one command for accessing the Python interpreter, |
| 20672 | and one related setting: |
| 20673 | |
| 20674 | @table @code |
| 20675 | @kindex python |
| 20676 | @item python @r{[}@var{code}@r{]} |
| 20677 | The @code{python} command can be used to evaluate Python code. |
| 20678 | |
| 20679 | If given an argument, the @code{python} command will evaluate the |
| 20680 | argument as a Python command. For example: |
| 20681 | |
| 20682 | @smallexample |
| 20683 | (@value{GDBP}) python print 23 |
| 20684 | 23 |
| 20685 | @end smallexample |
| 20686 | |
| 20687 | If you do not provide an argument to @code{python}, it will act as a |
| 20688 | multi-line command, like @code{define}. In this case, the Python |
| 20689 | script is made up of subsequent command lines, given after the |
| 20690 | @code{python} command. This command list is terminated using a line |
| 20691 | containing @code{end}. For example: |
| 20692 | |
| 20693 | @smallexample |
| 20694 | (@value{GDBP}) python |
| 20695 | Type python script |
| 20696 | End with a line saying just "end". |
| 20697 | >print 23 |
| 20698 | >end |
| 20699 | 23 |
| 20700 | @end smallexample |
| 20701 | |
| 20702 | @kindex maint set python print-stack |
| 20703 | @item maint set python print-stack |
| 20704 | By default, @value{GDBN} will print a stack trace when an error occurs |
| 20705 | in a Python script. This can be controlled using @code{maint set |
| 20706 | python print-stack}: if @code{on}, the default, then Python stack |
| 20707 | printing is enabled; if @code{off}, then Python stack printing is |
| 20708 | disabled. |
| 20709 | @end table |
| 20710 | |
| 20711 | It is also possible to execute a Python script from the @value{GDBN} |
| 20712 | interpreter: |
| 20713 | |
| 20714 | @table @code |
| 20715 | @item source @file{script-name} |
| 20716 | The script name must end with @samp{.py} and @value{GDBN} must be configured |
| 20717 | to recognize the script language based on filename extension using |
| 20718 | the @code{script-extension} setting. @xref{Extending GDB, ,Extending GDB}. |
| 20719 | |
| 20720 | @item python execfile ("script-name") |
| 20721 | This method is based on the @code{execfile} Python built-in function, |
| 20722 | and thus is always available. |
| 20723 | @end table |
| 20724 | |
| 20725 | @node Python API |
| 20726 | @subsection Python API |
| 20727 | @cindex python api |
| 20728 | @cindex programming in python |
| 20729 | |
| 20730 | @cindex python stdout |
| 20731 | @cindex python pagination |
| 20732 | At startup, @value{GDBN} overrides Python's @code{sys.stdout} and |
| 20733 | @code{sys.stderr} to print using @value{GDBN}'s output-paging streams. |
| 20734 | A Python program which outputs to one of these streams may have its |
| 20735 | output interrupted by the user (@pxref{Screen Size}). In this |
| 20736 | situation, a Python @code{KeyboardInterrupt} exception is thrown. |
| 20737 | |
| 20738 | @menu |
| 20739 | * Basic Python:: Basic Python Functions. |
| 20740 | * Exception Handling:: How Python exceptions are translated. |
| 20741 | * Values From Inferior:: Python representation of values. |
| 20742 | * Types In Python:: Python representation of types. |
| 20743 | * Pretty Printing API:: Pretty-printing values. |
| 20744 | * Selecting Pretty-Printers:: How GDB chooses a pretty-printer. |
| 20745 | * Writing a Pretty-Printer:: Writing a Pretty-Printer. |
| 20746 | * Inferiors In Python:: Python representation of inferiors (processes) |
| 20747 | * Events In Python:: Listening for events from @value{GDBN}. |
| 20748 | * Threads In Python:: Accessing inferior threads from Python. |
| 20749 | * Commands In Python:: Implementing new commands in Python. |
| 20750 | * Parameters In Python:: Adding new @value{GDBN} parameters. |
| 20751 | * Functions In Python:: Writing new convenience functions. |
| 20752 | * Progspaces In Python:: Program spaces. |
| 20753 | * Objfiles In Python:: Object files. |
| 20754 | * Frames In Python:: Accessing inferior stack frames from Python. |
| 20755 | * Blocks In Python:: Accessing frame blocks from Python. |
| 20756 | * Symbols In Python:: Python representation of symbols. |
| 20757 | * Symbol Tables In Python:: Python representation of symbol tables. |
| 20758 | * Lazy Strings In Python:: Python representation of lazy strings. |
| 20759 | * Breakpoints In Python:: Manipulating breakpoints using Python. |
| 20760 | @end menu |
| 20761 | |
| 20762 | @node Basic Python |
| 20763 | @subsubsection Basic Python |
| 20764 | |
| 20765 | @cindex python functions |
| 20766 | @cindex python module |
| 20767 | @cindex gdb module |
| 20768 | @value{GDBN} introduces a new Python module, named @code{gdb}. All |
| 20769 | methods and classes added by @value{GDBN} are placed in this module. |
| 20770 | @value{GDBN} automatically @code{import}s the @code{gdb} module for |
| 20771 | use in all scripts evaluated by the @code{python} command. |
| 20772 | |
| 20773 | @findex gdb.PYTHONDIR |
| 20774 | @defvar PYTHONDIR |
| 20775 | A string containing the python directory (@pxref{Python}). |
| 20776 | @end defvar |
| 20777 | |
| 20778 | @findex gdb.execute |
| 20779 | @defun execute command [from_tty] [to_string] |
| 20780 | Evaluate @var{command}, a string, as a @value{GDBN} CLI command. |
| 20781 | If a GDB exception happens while @var{command} runs, it is |
| 20782 | translated as described in @ref{Exception Handling,,Exception Handling}. |
| 20783 | |
| 20784 | @var{from_tty} specifies whether @value{GDBN} ought to consider this |
| 20785 | command as having originated from the user invoking it interactively. |
| 20786 | It must be a boolean value. If omitted, it defaults to @code{False}. |
| 20787 | |
| 20788 | By default, any output produced by @var{command} is sent to |
| 20789 | @value{GDBN}'s standard output. If the @var{to_string} parameter is |
| 20790 | @code{True}, then output will be collected by @code{gdb.execute} and |
| 20791 | returned as a string. The default is @code{False}, in which case the |
| 20792 | return value is @code{None}. If @var{to_string} is @code{True}, the |
| 20793 | @value{GDBN} virtual terminal will be temporarily set to unlimited width |
| 20794 | and height, and its pagination will be disabled; @pxref{Screen Size}. |
| 20795 | @end defun |
| 20796 | |
| 20797 | @findex gdb.breakpoints |
| 20798 | @defun breakpoints |
| 20799 | Return a sequence holding all of @value{GDBN}'s breakpoints. |
| 20800 | @xref{Breakpoints In Python}, for more information. |
| 20801 | @end defun |
| 20802 | |
| 20803 | @findex gdb.parameter |
| 20804 | @defun parameter parameter |
| 20805 | Return the value of a @value{GDBN} parameter. @var{parameter} is a |
| 20806 | string naming the parameter to look up; @var{parameter} may contain |
| 20807 | spaces if the parameter has a multi-part name. For example, |
| 20808 | @samp{print object} is a valid parameter name. |
| 20809 | |
| 20810 | If the named parameter does not exist, this function throws a |
| 20811 | @code{gdb.error} (@pxref{Exception Handling}). Otherwise, the |
| 20812 | parameter's value is converted to a Python value of the appropriate |
| 20813 | type, and returned. |
| 20814 | @end defun |
| 20815 | |
| 20816 | @findex gdb.history |
| 20817 | @defun history number |
| 20818 | Return a value from @value{GDBN}'s value history (@pxref{Value |
| 20819 | History}). @var{number} indicates which history element to return. |
| 20820 | If @var{number} is negative, then @value{GDBN} will take its absolute value |
| 20821 | and count backward from the last element (i.e., the most recent element) to |
| 20822 | find the value to return. If @var{number} is zero, then @value{GDBN} will |
| 20823 | return the most recent element. If the element specified by @var{number} |
| 20824 | doesn't exist in the value history, a @code{gdb.error} exception will be |
| 20825 | raised. |
| 20826 | |
| 20827 | If no exception is raised, the return value is always an instance of |
| 20828 | @code{gdb.Value} (@pxref{Values From Inferior}). |
| 20829 | @end defun |
| 20830 | |
| 20831 | @findex gdb.parse_and_eval |
| 20832 | @defun parse_and_eval expression |
| 20833 | Parse @var{expression} as an expression in the current language, |
| 20834 | evaluate it, and return the result as a @code{gdb.Value}. |
| 20835 | @var{expression} must be a string. |
| 20836 | |
| 20837 | This function can be useful when implementing a new command |
| 20838 | (@pxref{Commands In Python}), as it provides a way to parse the |
| 20839 | command's argument as an expression. It is also useful simply to |
| 20840 | compute values, for example, it is the only way to get the value of a |
| 20841 | convenience variable (@pxref{Convenience Vars}) as a @code{gdb.Value}. |
| 20842 | @end defun |
| 20843 | |
| 20844 | @findex gdb.post_event |
| 20845 | @defun post_event event |
| 20846 | Put @var{event}, a callable object taking no arguments, into |
| 20847 | @value{GDBN}'s internal event queue. This callable will be invoked at |
| 20848 | some later point, during @value{GDBN}'s event processing. Events |
| 20849 | posted using @code{post_event} will be run in the order in which they |
| 20850 | were posted; however, there is no way to know when they will be |
| 20851 | processed relative to other events inside @value{GDBN}. |
| 20852 | |
| 20853 | @value{GDBN} is not thread-safe. If your Python program uses multiple |
| 20854 | threads, you must be careful to only call @value{GDBN}-specific |
| 20855 | functions in the main @value{GDBN} thread. @code{post_event} ensures |
| 20856 | this. For example: |
| 20857 | |
| 20858 | @smallexample |
| 20859 | (@value{GDBP}) python |
| 20860 | >import threading |
| 20861 | > |
| 20862 | >class Writer(): |
| 20863 | > def __init__(self, message): |
| 20864 | > self.message = message; |
| 20865 | > def __call__(self): |
| 20866 | > gdb.write(self.message) |
| 20867 | > |
| 20868 | >class MyThread1 (threading.Thread): |
| 20869 | > def run (self): |
| 20870 | > gdb.post_event(Writer("Hello ")) |
| 20871 | > |
| 20872 | >class MyThread2 (threading.Thread): |
| 20873 | > def run (self): |
| 20874 | > gdb.post_event(Writer("World\n")) |
| 20875 | > |
| 20876 | >MyThread1().start() |
| 20877 | >MyThread2().start() |
| 20878 | >end |
| 20879 | (@value{GDBP}) Hello World |
| 20880 | @end smallexample |
| 20881 | @end defun |
| 20882 | |
| 20883 | @findex gdb.write |
| 20884 | @defun write string @r{[}stream{]} |
| 20885 | Print a string to @value{GDBN}'s paginated output stream. The |
| 20886 | optional @var{stream} determines the stream to print to. The default |
| 20887 | stream is @value{GDBN}'s standard output stream. Possible stream |
| 20888 | values are: |
| 20889 | |
| 20890 | @table @code |
| 20891 | @findex STDOUT |
| 20892 | @findex gdb.STDOUT |
| 20893 | @item STDOUT |
| 20894 | @value{GDBN}'s standard output stream. |
| 20895 | |
| 20896 | @findex STDERR |
| 20897 | @findex gdb.STDERR |
| 20898 | @item STDERR |
| 20899 | @value{GDBN}'s standard error stream. |
| 20900 | |
| 20901 | @findex STDLOG |
| 20902 | @findex gdb.STDLOG |
| 20903 | @item STDLOG |
| 20904 | @value{GDBN}'s log stream (@pxref{Logging Output}). |
| 20905 | @end table |
| 20906 | |
| 20907 | Writing to @code{sys.stdout} or @code{sys.stderr} will automatically |
| 20908 | call this function and will automatically direct the output to the |
| 20909 | relevant stream. |
| 20910 | @end defun |
| 20911 | |
| 20912 | @findex gdb.flush |
| 20913 | @defun flush |
| 20914 | Flush the buffer of a @value{GDBN} paginated stream so that the |
| 20915 | contents are displayed immediately. @value{GDBN} will flush the |
| 20916 | contents of a stream automatically when it encounters a newline in the |
| 20917 | buffer. The optional @var{stream} determines the stream to flush. The |
| 20918 | default stream is @value{GDBN}'s standard output stream. Possible |
| 20919 | stream values are: |
| 20920 | |
| 20921 | @table @code |
| 20922 | @findex STDOUT |
| 20923 | @findex gdb.STDOUT |
| 20924 | @item STDOUT |
| 20925 | @value{GDBN}'s standard output stream. |
| 20926 | |
| 20927 | @findex STDERR |
| 20928 | @findex gdb.STDERR |
| 20929 | @item STDERR |
| 20930 | @value{GDBN}'s standard error stream. |
| 20931 | |
| 20932 | @findex STDLOG |
| 20933 | @findex gdb.STDLOG |
| 20934 | @item STDLOG |
| 20935 | @value{GDBN}'s log stream (@pxref{Logging Output}). |
| 20936 | |
| 20937 | @end table |
| 20938 | |
| 20939 | Flushing @code{sys.stdout} or @code{sys.stderr} will automatically |
| 20940 | call this function for the relevant stream. |
| 20941 | @end defun |
| 20942 | |
| 20943 | @findex gdb.target_charset |
| 20944 | @defun target_charset |
| 20945 | Return the name of the current target character set (@pxref{Character |
| 20946 | Sets}). This differs from @code{gdb.parameter('target-charset')} in |
| 20947 | that @samp{auto} is never returned. |
| 20948 | @end defun |
| 20949 | |
| 20950 | @findex gdb.target_wide_charset |
| 20951 | @defun target_wide_charset |
| 20952 | Return the name of the current target wide character set |
| 20953 | (@pxref{Character Sets}). This differs from |
| 20954 | @code{gdb.parameter('target-wide-charset')} in that @samp{auto} is |
| 20955 | never returned. |
| 20956 | @end defun |
| 20957 | |
| 20958 | @findex gdb.solib_name |
| 20959 | @defun solib_name address |
| 20960 | Return the name of the shared library holding the given @var{address} |
| 20961 | as a string, or @code{None}. |
| 20962 | @end defun |
| 20963 | |
| 20964 | @findex gdb.decode_line |
| 20965 | @defun decode_line @r{[}expression@r{]} |
| 20966 | Return locations of the line specified by @var{expression}, or of the |
| 20967 | current line if no argument was given. This function returns a Python |
| 20968 | tuple containing two elements. The first element contains a string |
| 20969 | holding any unparsed section of @var{expression} (or @code{None} if |
| 20970 | the expression has been fully parsed). The second element contains |
| 20971 | either @code{None} or another tuple that contains all the locations |
| 20972 | that match the expression represented as @code{gdb.Symtab_and_line} |
| 20973 | objects (@pxref{Symbol Tables In Python}). If @var{expression} is |
| 20974 | provided, it is decoded the way that @value{GDBN}'s inbuilt |
| 20975 | @code{break} or @code{edit} commands do (@pxref{Specify Location}). |
| 20976 | @end defun |
| 20977 | |
| 20978 | @node Exception Handling |
| 20979 | @subsubsection Exception Handling |
| 20980 | @cindex python exceptions |
| 20981 | @cindex exceptions, python |
| 20982 | |
| 20983 | When executing the @code{python} command, Python exceptions |
| 20984 | uncaught within the Python code are translated to calls to |
| 20985 | @value{GDBN} error-reporting mechanism. If the command that called |
| 20986 | @code{python} does not handle the error, @value{GDBN} will |
| 20987 | terminate it and print an error message containing the Python |
| 20988 | exception name, the associated value, and the Python call stack |
| 20989 | backtrace at the point where the exception was raised. Example: |
| 20990 | |
| 20991 | @smallexample |
| 20992 | (@value{GDBP}) python print foo |
| 20993 | Traceback (most recent call last): |
| 20994 | File "<string>", line 1, in <module> |
| 20995 | NameError: name 'foo' is not defined |
| 20996 | @end smallexample |
| 20997 | |
| 20998 | @value{GDBN} errors that happen in @value{GDBN} commands invoked by |
| 20999 | Python code are converted to Python exceptions. The type of the |
| 21000 | Python exception depends on the error. |
| 21001 | |
| 21002 | @ftable @code |
| 21003 | @item gdb.error |
| 21004 | This is the base class for most exceptions generated by @value{GDBN}. |
| 21005 | It is derived from @code{RuntimeError}, for compatibility with earlier |
| 21006 | versions of @value{GDBN}. |
| 21007 | |
| 21008 | If an error occurring in @value{GDBN} does not fit into some more |
| 21009 | specific category, then the generated exception will have this type. |
| 21010 | |
| 21011 | @item gdb.MemoryError |
| 21012 | This is a subclass of @code{gdb.error} which is thrown when an |
| 21013 | operation tried to access invalid memory in the inferior. |
| 21014 | |
| 21015 | @item KeyboardInterrupt |
| 21016 | User interrupt (via @kbd{C-c} or by typing @kbd{q} at a pagination |
| 21017 | prompt) is translated to a Python @code{KeyboardInterrupt} exception. |
| 21018 | @end ftable |
| 21019 | |
| 21020 | In all cases, your exception handler will see the @value{GDBN} error |
| 21021 | message as its value and the Python call stack backtrace at the Python |
| 21022 | statement closest to where the @value{GDBN} error occured as the |
| 21023 | traceback. |
| 21024 | |
| 21025 | @findex gdb.GdbError |
| 21026 | When implementing @value{GDBN} commands in Python via @code{gdb.Command}, |
| 21027 | it is useful to be able to throw an exception that doesn't cause a |
| 21028 | traceback to be printed. For example, the user may have invoked the |
| 21029 | command incorrectly. Use the @code{gdb.GdbError} exception |
| 21030 | to handle this case. Example: |
| 21031 | |
| 21032 | @smallexample |
| 21033 | (gdb) python |
| 21034 | >class HelloWorld (gdb.Command): |
| 21035 | > """Greet the whole world.""" |
| 21036 | > def __init__ (self): |
| 21037 | > super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_OBSCURE) |
| 21038 | > def invoke (self, args, from_tty): |
| 21039 | > argv = gdb.string_to_argv (args) |
| 21040 | > if len (argv) != 0: |
| 21041 | > raise gdb.GdbError ("hello-world takes no arguments") |
| 21042 | > print "Hello, World!" |
| 21043 | >HelloWorld () |
| 21044 | >end |
| 21045 | (gdb) hello-world 42 |
| 21046 | hello-world takes no arguments |
| 21047 | @end smallexample |
| 21048 | |
| 21049 | @node Values From Inferior |
| 21050 | @subsubsection Values From Inferior |
| 21051 | @cindex values from inferior, with Python |
| 21052 | @cindex python, working with values from inferior |
| 21053 | |
| 21054 | @cindex @code{gdb.Value} |
| 21055 | @value{GDBN} provides values it obtains from the inferior program in |
| 21056 | an object of type @code{gdb.Value}. @value{GDBN} uses this object |
| 21057 | for its internal bookkeeping of the inferior's values, and for |
| 21058 | fetching values when necessary. |
| 21059 | |
| 21060 | Inferior values that are simple scalars can be used directly in |
| 21061 | Python expressions that are valid for the value's data type. Here's |
| 21062 | an example for an integer or floating-point value @code{some_val}: |
| 21063 | |
| 21064 | @smallexample |
| 21065 | bar = some_val + 2 |
| 21066 | @end smallexample |
| 21067 | |
| 21068 | @noindent |
| 21069 | As result of this, @code{bar} will also be a @code{gdb.Value} object |
| 21070 | whose values are of the same type as those of @code{some_val}. |
| 21071 | |
| 21072 | Inferior values that are structures or instances of some class can |
| 21073 | be accessed using the Python @dfn{dictionary syntax}. For example, if |
| 21074 | @code{some_val} is a @code{gdb.Value} instance holding a structure, you |
| 21075 | can access its @code{foo} element with: |
| 21076 | |
| 21077 | @smallexample |
| 21078 | bar = some_val['foo'] |
| 21079 | @end smallexample |
| 21080 | |
| 21081 | Again, @code{bar} will also be a @code{gdb.Value} object. |
| 21082 | |
| 21083 | A @code{gdb.Value} that represents a function can be executed via |
| 21084 | inferior function call. Any arguments provided to the call must match |
| 21085 | the function's prototype, and must be provided in the order specified |
| 21086 | by that prototype. |
| 21087 | |
| 21088 | For example, @code{some_val} is a @code{gdb.Value} instance |
| 21089 | representing a function that takes two integers as arguments. To |
| 21090 | execute this function, call it like so: |
| 21091 | |
| 21092 | @smallexample |
| 21093 | result = some_val (10,20) |
| 21094 | @end smallexample |
| 21095 | |
| 21096 | Any values returned from a function call will be stored as a |
| 21097 | @code{gdb.Value}. |
| 21098 | |
| 21099 | The following attributes are provided: |
| 21100 | |
| 21101 | @table @code |
| 21102 | @defivar Value address |
| 21103 | If this object is addressable, this read-only attribute holds a |
| 21104 | @code{gdb.Value} object representing the address. Otherwise, |
| 21105 | this attribute holds @code{None}. |
| 21106 | @end defivar |
| 21107 | |
| 21108 | @cindex optimized out value in Python |
| 21109 | @defivar Value is_optimized_out |
| 21110 | This read-only boolean attribute is true if the compiler optimized out |
| 21111 | this value, thus it is not available for fetching from the inferior. |
| 21112 | @end defivar |
| 21113 | |
| 21114 | @defivar Value type |
| 21115 | The type of this @code{gdb.Value}. The value of this attribute is a |
| 21116 | @code{gdb.Type} object (@pxref{Types In Python}). |
| 21117 | @end defivar |
| 21118 | |
| 21119 | @defivar Value dynamic_type |
| 21120 | The dynamic type of this @code{gdb.Value}. This uses C@t{++} run-time |
| 21121 | type information (@acronym{RTTI}) to determine the dynamic type of the |
| 21122 | value. If this value is of class type, it will return the class in |
| 21123 | which the value is embedded, if any. If this value is of pointer or |
| 21124 | reference to a class type, it will compute the dynamic type of the |
| 21125 | referenced object, and return a pointer or reference to that type, |
| 21126 | respectively. In all other cases, it will return the value's static |
| 21127 | type. |
| 21128 | |
| 21129 | Note that this feature will only work when debugging a C@t{++} program |
| 21130 | that includes @acronym{RTTI} for the object in question. Otherwise, |
| 21131 | it will just return the static type of the value as in @kbd{ptype foo} |
| 21132 | (@pxref{Symbols, ptype}). |
| 21133 | @end defivar |
| 21134 | @end table |
| 21135 | |
| 21136 | The following methods are provided: |
| 21137 | |
| 21138 | @table @code |
| 21139 | @defmethod Value __init__ @var{val} |
| 21140 | Many Python values can be converted directly to a @code{gdb.Value} via |
| 21141 | this object initializer. Specifically: |
| 21142 | |
| 21143 | @table @asis |
| 21144 | @item Python boolean |
| 21145 | A Python boolean is converted to the boolean type from the current |
| 21146 | language. |
| 21147 | |
| 21148 | @item Python integer |
| 21149 | A Python integer is converted to the C @code{long} type for the |
| 21150 | current architecture. |
| 21151 | |
| 21152 | @item Python long |
| 21153 | A Python long is converted to the C @code{long long} type for the |
| 21154 | current architecture. |
| 21155 | |
| 21156 | @item Python float |
| 21157 | A Python float is converted to the C @code{double} type for the |
| 21158 | current architecture. |
| 21159 | |
| 21160 | @item Python string |
| 21161 | A Python string is converted to a target string, using the current |
| 21162 | target encoding. |
| 21163 | |
| 21164 | @item @code{gdb.Value} |
| 21165 | If @code{val} is a @code{gdb.Value}, then a copy of the value is made. |
| 21166 | |
| 21167 | @item @code{gdb.LazyString} |
| 21168 | If @code{val} is a @code{gdb.LazyString} (@pxref{Lazy Strings In |
| 21169 | Python}), then the lazy string's @code{value} method is called, and |
| 21170 | its result is used. |
| 21171 | @end table |
| 21172 | @end defmethod |
| 21173 | |
| 21174 | @defmethod Value cast type |
| 21175 | Return a new instance of @code{gdb.Value} that is the result of |
| 21176 | casting this instance to the type described by @var{type}, which must |
| 21177 | be a @code{gdb.Type} object. If the cast cannot be performed for some |
| 21178 | reason, this method throws an exception. |
| 21179 | @end defmethod |
| 21180 | |
| 21181 | @defmethod Value dereference |
| 21182 | For pointer data types, this method returns a new @code{gdb.Value} object |
| 21183 | whose contents is the object pointed to by the pointer. For example, if |
| 21184 | @code{foo} is a C pointer to an @code{int}, declared in your C program as |
| 21185 | |
| 21186 | @smallexample |
| 21187 | int *foo; |
| 21188 | @end smallexample |
| 21189 | |
| 21190 | @noindent |
| 21191 | then you can use the corresponding @code{gdb.Value} to access what |
| 21192 | @code{foo} points to like this: |
| 21193 | |
| 21194 | @smallexample |
| 21195 | bar = foo.dereference () |
| 21196 | @end smallexample |
| 21197 | |
| 21198 | The result @code{bar} will be a @code{gdb.Value} object holding the |
| 21199 | value pointed to by @code{foo}. |
| 21200 | @end defmethod |
| 21201 | |
| 21202 | @defmethod Value dynamic_cast type |
| 21203 | Like @code{Value.cast}, but works as if the C@t{++} @code{dynamic_cast} |
| 21204 | operator were used. Consult a C@t{++} reference for details. |
| 21205 | @end defmethod |
| 21206 | |
| 21207 | @defmethod Value reinterpret_cast type |
| 21208 | Like @code{Value.cast}, but works as if the C@t{++} @code{reinterpret_cast} |
| 21209 | operator were used. Consult a C@t{++} reference for details. |
| 21210 | @end defmethod |
| 21211 | |
| 21212 | @defmethod Value string @r{[}encoding@r{]} @r{[}errors@r{]} @r{[}length@r{]} |
| 21213 | If this @code{gdb.Value} represents a string, then this method |
| 21214 | converts the contents to a Python string. Otherwise, this method will |
| 21215 | throw an exception. |
| 21216 | |
| 21217 | Strings are recognized in a language-specific way; whether a given |
| 21218 | @code{gdb.Value} represents a string is determined by the current |
| 21219 | language. |
| 21220 | |
| 21221 | For C-like languages, a value is a string if it is a pointer to or an |
| 21222 | array of characters or ints. The string is assumed to be terminated |
| 21223 | by a zero of the appropriate width. However if the optional length |
| 21224 | argument is given, the string will be converted to that given length, |
| 21225 | ignoring any embedded zeros that the string may contain. |
| 21226 | |
| 21227 | If the optional @var{encoding} argument is given, it must be a string |
| 21228 | naming the encoding of the string in the @code{gdb.Value}, such as |
| 21229 | @code{"ascii"}, @code{"iso-8859-6"} or @code{"utf-8"}. It accepts |
| 21230 | the same encodings as the corresponding argument to Python's |
| 21231 | @code{string.decode} method, and the Python codec machinery will be used |
| 21232 | to convert the string. If @var{encoding} is not given, or if |
| 21233 | @var{encoding} is the empty string, then either the @code{target-charset} |
| 21234 | (@pxref{Character Sets}) will be used, or a language-specific encoding |
| 21235 | will be used, if the current language is able to supply one. |
| 21236 | |
| 21237 | The optional @var{errors} argument is the same as the corresponding |
| 21238 | argument to Python's @code{string.decode} method. |
| 21239 | |
| 21240 | If the optional @var{length} argument is given, the string will be |
| 21241 | fetched and converted to the given length. |
| 21242 | @end defmethod |
| 21243 | |
| 21244 | @defmethod Value lazy_string @r{[}encoding@r{]} @r{[}length@r{]} |
| 21245 | If this @code{gdb.Value} represents a string, then this method |
| 21246 | converts the contents to a @code{gdb.LazyString} (@pxref{Lazy Strings |
| 21247 | In Python}). Otherwise, this method will throw an exception. |
| 21248 | |
| 21249 | If the optional @var{encoding} argument is given, it must be a string |
| 21250 | naming the encoding of the @code{gdb.LazyString}. Some examples are: |
| 21251 | @samp{ascii}, @samp{iso-8859-6} or @samp{utf-8}. If the |
| 21252 | @var{encoding} argument is an encoding that @value{GDBN} does |
| 21253 | recognize, @value{GDBN} will raise an error. |
| 21254 | |
| 21255 | When a lazy string is printed, the @value{GDBN} encoding machinery is |
| 21256 | used to convert the string during printing. If the optional |
| 21257 | @var{encoding} argument is not provided, or is an empty string, |
| 21258 | @value{GDBN} will automatically select the encoding most suitable for |
| 21259 | the string type. For further information on encoding in @value{GDBN} |
| 21260 | please see @ref{Character Sets}. |
| 21261 | |
| 21262 | If the optional @var{length} argument is given, the string will be |
| 21263 | fetched and encoded to the length of characters specified. If |
| 21264 | the @var{length} argument is not provided, the string will be fetched |
| 21265 | and encoded until a null of appropriate width is found. |
| 21266 | @end defmethod |
| 21267 | @end table |
| 21268 | |
| 21269 | @node Types In Python |
| 21270 | @subsubsection Types In Python |
| 21271 | @cindex types in Python |
| 21272 | @cindex Python, working with types |
| 21273 | |
| 21274 | @tindex gdb.Type |
| 21275 | @value{GDBN} represents types from the inferior using the class |
| 21276 | @code{gdb.Type}. |
| 21277 | |
| 21278 | The following type-related functions are available in the @code{gdb} |
| 21279 | module: |
| 21280 | |
| 21281 | @findex gdb.lookup_type |
| 21282 | @defun lookup_type name [block] |
| 21283 | This function looks up a type by name. @var{name} is the name of the |
| 21284 | type to look up. It must be a string. |
| 21285 | |
| 21286 | If @var{block} is given, then @var{name} is looked up in that scope. |
| 21287 | Otherwise, it is searched for globally. |
| 21288 | |
| 21289 | Ordinarily, this function will return an instance of @code{gdb.Type}. |
| 21290 | If the named type cannot be found, it will throw an exception. |
| 21291 | @end defun |
| 21292 | |
| 21293 | An instance of @code{Type} has the following attributes: |
| 21294 | |
| 21295 | @table @code |
| 21296 | @defivar Type code |
| 21297 | The type code for this type. The type code will be one of the |
| 21298 | @code{TYPE_CODE_} constants defined below. |
| 21299 | @end defivar |
| 21300 | |
| 21301 | @defivar Type sizeof |
| 21302 | The size of this type, in target @code{char} units. Usually, a |
| 21303 | target's @code{char} type will be an 8-bit byte. However, on some |
| 21304 | unusual platforms, this type may have a different size. |
| 21305 | @end defivar |
| 21306 | |
| 21307 | @defivar Type tag |
| 21308 | The tag name for this type. The tag name is the name after |
| 21309 | @code{struct}, @code{union}, or @code{enum} in C and C@t{++}; not all |
| 21310 | languages have this concept. If this type has no tag name, then |
| 21311 | @code{None} is returned. |
| 21312 | @end defivar |
| 21313 | @end table |
| 21314 | |
| 21315 | The following methods are provided: |
| 21316 | |
| 21317 | @table @code |
| 21318 | @defmethod Type fields |
| 21319 | For structure and union types, this method returns the fields. Range |
| 21320 | types have two fields, the minimum and maximum values. Enum types |
| 21321 | have one field per enum constant. Function and method types have one |
| 21322 | field per parameter. The base types of C@t{++} classes are also |
| 21323 | represented as fields. If the type has no fields, or does not fit |
| 21324 | into one of these categories, an empty sequence will be returned. |
| 21325 | |
| 21326 | Each field is an object, with some pre-defined attributes: |
| 21327 | @table @code |
| 21328 | @item bitpos |
| 21329 | This attribute is not available for @code{static} fields (as in |
| 21330 | C@t{++} or Java). For non-@code{static} fields, the value is the bit |
| 21331 | position of the field. |
| 21332 | |
| 21333 | @item name |
| 21334 | The name of the field, or @code{None} for anonymous fields. |
| 21335 | |
| 21336 | @item artificial |
| 21337 | This is @code{True} if the field is artificial, usually meaning that |
| 21338 | it was provided by the compiler and not the user. This attribute is |
| 21339 | always provided, and is @code{False} if the field is not artificial. |
| 21340 | |
| 21341 | @item is_base_class |
| 21342 | This is @code{True} if the field represents a base class of a C@t{++} |
| 21343 | structure. This attribute is always provided, and is @code{False} |
| 21344 | if the field is not a base class of the type that is the argument of |
| 21345 | @code{fields}, or if that type was not a C@t{++} class. |
| 21346 | |
| 21347 | @item bitsize |
| 21348 | If the field is packed, or is a bitfield, then this will have a |
| 21349 | non-zero value, which is the size of the field in bits. Otherwise, |
| 21350 | this will be zero; in this case the field's size is given by its type. |
| 21351 | |
| 21352 | @item type |
| 21353 | The type of the field. This is usually an instance of @code{Type}, |
| 21354 | but it can be @code{None} in some situations. |
| 21355 | @end table |
| 21356 | @end defmethod |
| 21357 | |
| 21358 | @defmethod Type array @var{n1} @r{[}@var{n2}@r{]} |
| 21359 | Return a new @code{gdb.Type} object which represents an array of this |
| 21360 | type. If one argument is given, it is the inclusive upper bound of |
| 21361 | the array; in this case the lower bound is zero. If two arguments are |
| 21362 | given, the first argument is the lower bound of the array, and the |
| 21363 | second argument is the upper bound of the array. An array's length |
| 21364 | must not be negative, but the bounds can be. |
| 21365 | @end defmethod |
| 21366 | |
| 21367 | @defmethod Type const |
| 21368 | Return a new @code{gdb.Type} object which represents a |
| 21369 | @code{const}-qualified variant of this type. |
| 21370 | @end defmethod |
| 21371 | |
| 21372 | @defmethod Type volatile |
| 21373 | Return a new @code{gdb.Type} object which represents a |
| 21374 | @code{volatile}-qualified variant of this type. |
| 21375 | @end defmethod |
| 21376 | |
| 21377 | @defmethod Type unqualified |
| 21378 | Return a new @code{gdb.Type} object which represents an unqualified |
| 21379 | variant of this type. That is, the result is neither @code{const} nor |
| 21380 | @code{volatile}. |
| 21381 | @end defmethod |
| 21382 | |
| 21383 | @defmethod Type range |
| 21384 | Return a Python @code{Tuple} object that contains two elements: the |
| 21385 | low bound of the argument type and the high bound of that type. If |
| 21386 | the type does not have a range, @value{GDBN} will raise a |
| 21387 | @code{gdb.error} exception (@pxref{Exception Handling}). |
| 21388 | @end defmethod |
| 21389 | |
| 21390 | @defmethod Type reference |
| 21391 | Return a new @code{gdb.Type} object which represents a reference to this |
| 21392 | type. |
| 21393 | @end defmethod |
| 21394 | |
| 21395 | @defmethod Type pointer |
| 21396 | Return a new @code{gdb.Type} object which represents a pointer to this |
| 21397 | type. |
| 21398 | @end defmethod |
| 21399 | |
| 21400 | @defmethod Type strip_typedefs |
| 21401 | Return a new @code{gdb.Type} that represents the real type, |
| 21402 | after removing all layers of typedefs. |
| 21403 | @end defmethod |
| 21404 | |
| 21405 | @defmethod Type target |
| 21406 | Return a new @code{gdb.Type} object which represents the target type |
| 21407 | of this type. |
| 21408 | |
| 21409 | For a pointer type, the target type is the type of the pointed-to |
| 21410 | object. For an array type (meaning C-like arrays), the target type is |
| 21411 | the type of the elements of the array. For a function or method type, |
| 21412 | the target type is the type of the return value. For a complex type, |
| 21413 | the target type is the type of the elements. For a typedef, the |
| 21414 | target type is the aliased type. |
| 21415 | |
| 21416 | If the type does not have a target, this method will throw an |
| 21417 | exception. |
| 21418 | @end defmethod |
| 21419 | |
| 21420 | @defmethod Type template_argument n [block] |
| 21421 | If this @code{gdb.Type} is an instantiation of a template, this will |
| 21422 | return a new @code{gdb.Type} which represents the type of the |
| 21423 | @var{n}th template argument. |
| 21424 | |
| 21425 | If this @code{gdb.Type} is not a template type, this will throw an |
| 21426 | exception. Ordinarily, only C@t{++} code will have template types. |
| 21427 | |
| 21428 | If @var{block} is given, then @var{name} is looked up in that scope. |
| 21429 | Otherwise, it is searched for globally. |
| 21430 | @end defmethod |
| 21431 | @end table |
| 21432 | |
| 21433 | |
| 21434 | Each type has a code, which indicates what category this type falls |
| 21435 | into. The available type categories are represented by constants |
| 21436 | defined in the @code{gdb} module: |
| 21437 | |
| 21438 | @table @code |
| 21439 | @findex TYPE_CODE_PTR |
| 21440 | @findex gdb.TYPE_CODE_PTR |
| 21441 | @item TYPE_CODE_PTR |
| 21442 | The type is a pointer. |
| 21443 | |
| 21444 | @findex TYPE_CODE_ARRAY |
| 21445 | @findex gdb.TYPE_CODE_ARRAY |
| 21446 | @item TYPE_CODE_ARRAY |
| 21447 | The type is an array. |
| 21448 | |
| 21449 | @findex TYPE_CODE_STRUCT |
| 21450 | @findex gdb.TYPE_CODE_STRUCT |
| 21451 | @item TYPE_CODE_STRUCT |
| 21452 | The type is a structure. |
| 21453 | |
| 21454 | @findex TYPE_CODE_UNION |
| 21455 | @findex gdb.TYPE_CODE_UNION |
| 21456 | @item TYPE_CODE_UNION |
| 21457 | The type is a union. |
| 21458 | |
| 21459 | @findex TYPE_CODE_ENUM |
| 21460 | @findex gdb.TYPE_CODE_ENUM |
| 21461 | @item TYPE_CODE_ENUM |
| 21462 | The type is an enum. |
| 21463 | |
| 21464 | @findex TYPE_CODE_FLAGS |
| 21465 | @findex gdb.TYPE_CODE_FLAGS |
| 21466 | @item TYPE_CODE_FLAGS |
| 21467 | A bit flags type, used for things such as status registers. |
| 21468 | |
| 21469 | @findex TYPE_CODE_FUNC |
| 21470 | @findex gdb.TYPE_CODE_FUNC |
| 21471 | @item TYPE_CODE_FUNC |
| 21472 | The type is a function. |
| 21473 | |
| 21474 | @findex TYPE_CODE_INT |
| 21475 | @findex gdb.TYPE_CODE_INT |
| 21476 | @item TYPE_CODE_INT |
| 21477 | The type is an integer type. |
| 21478 | |
| 21479 | @findex TYPE_CODE_FLT |
| 21480 | @findex gdb.TYPE_CODE_FLT |
| 21481 | @item TYPE_CODE_FLT |
| 21482 | A floating point type. |
| 21483 | |
| 21484 | @findex TYPE_CODE_VOID |
| 21485 | @findex gdb.TYPE_CODE_VOID |
| 21486 | @item TYPE_CODE_VOID |
| 21487 | The special type @code{void}. |
| 21488 | |
| 21489 | @findex TYPE_CODE_SET |
| 21490 | @findex gdb.TYPE_CODE_SET |
| 21491 | @item TYPE_CODE_SET |
| 21492 | A Pascal set type. |
| 21493 | |
| 21494 | @findex TYPE_CODE_RANGE |
| 21495 | @findex gdb.TYPE_CODE_RANGE |
| 21496 | @item TYPE_CODE_RANGE |
| 21497 | A range type, that is, an integer type with bounds. |
| 21498 | |
| 21499 | @findex TYPE_CODE_STRING |
| 21500 | @findex gdb.TYPE_CODE_STRING |
| 21501 | @item TYPE_CODE_STRING |
| 21502 | A string type. Note that this is only used for certain languages with |
| 21503 | language-defined string types; C strings are not represented this way. |
| 21504 | |
| 21505 | @findex TYPE_CODE_BITSTRING |
| 21506 | @findex gdb.TYPE_CODE_BITSTRING |
| 21507 | @item TYPE_CODE_BITSTRING |
| 21508 | A string of bits. |
| 21509 | |
| 21510 | @findex TYPE_CODE_ERROR |
| 21511 | @findex gdb.TYPE_CODE_ERROR |
| 21512 | @item TYPE_CODE_ERROR |
| 21513 | An unknown or erroneous type. |
| 21514 | |
| 21515 | @findex TYPE_CODE_METHOD |
| 21516 | @findex gdb.TYPE_CODE_METHOD |
| 21517 | @item TYPE_CODE_METHOD |
| 21518 | A method type, as found in C@t{++} or Java. |
| 21519 | |
| 21520 | @findex TYPE_CODE_METHODPTR |
| 21521 | @findex gdb.TYPE_CODE_METHODPTR |
| 21522 | @item TYPE_CODE_METHODPTR |
| 21523 | A pointer-to-member-function. |
| 21524 | |
| 21525 | @findex TYPE_CODE_MEMBERPTR |
| 21526 | @findex gdb.TYPE_CODE_MEMBERPTR |
| 21527 | @item TYPE_CODE_MEMBERPTR |
| 21528 | A pointer-to-member. |
| 21529 | |
| 21530 | @findex TYPE_CODE_REF |
| 21531 | @findex gdb.TYPE_CODE_REF |
| 21532 | @item TYPE_CODE_REF |
| 21533 | A reference type. |
| 21534 | |
| 21535 | @findex TYPE_CODE_CHAR |
| 21536 | @findex gdb.TYPE_CODE_CHAR |
| 21537 | @item TYPE_CODE_CHAR |
| 21538 | A character type. |
| 21539 | |
| 21540 | @findex TYPE_CODE_BOOL |
| 21541 | @findex gdb.TYPE_CODE_BOOL |
| 21542 | @item TYPE_CODE_BOOL |
| 21543 | A boolean type. |
| 21544 | |
| 21545 | @findex TYPE_CODE_COMPLEX |
| 21546 | @findex gdb.TYPE_CODE_COMPLEX |
| 21547 | @item TYPE_CODE_COMPLEX |
| 21548 | A complex float type. |
| 21549 | |
| 21550 | @findex TYPE_CODE_TYPEDEF |
| 21551 | @findex gdb.TYPE_CODE_TYPEDEF |
| 21552 | @item TYPE_CODE_TYPEDEF |
| 21553 | A typedef to some other type. |
| 21554 | |
| 21555 | @findex TYPE_CODE_NAMESPACE |
| 21556 | @findex gdb.TYPE_CODE_NAMESPACE |
| 21557 | @item TYPE_CODE_NAMESPACE |
| 21558 | A C@t{++} namespace. |
| 21559 | |
| 21560 | @findex TYPE_CODE_DECFLOAT |
| 21561 | @findex gdb.TYPE_CODE_DECFLOAT |
| 21562 | @item TYPE_CODE_DECFLOAT |
| 21563 | A decimal floating point type. |
| 21564 | |
| 21565 | @findex TYPE_CODE_INTERNAL_FUNCTION |
| 21566 | @findex gdb.TYPE_CODE_INTERNAL_FUNCTION |
| 21567 | @item TYPE_CODE_INTERNAL_FUNCTION |
| 21568 | A function internal to @value{GDBN}. This is the type used to represent |
| 21569 | convenience functions. |
| 21570 | @end table |
| 21571 | |
| 21572 | Further support for types is provided in the @code{gdb.types} |
| 21573 | Python module (@pxref{gdb.types}). |
| 21574 | |
| 21575 | @node Pretty Printing API |
| 21576 | @subsubsection Pretty Printing API |
| 21577 | |
| 21578 | An example output is provided (@pxref{Pretty Printing}). |
| 21579 | |
| 21580 | A pretty-printer is just an object that holds a value and implements a |
| 21581 | specific interface, defined here. |
| 21582 | |
| 21583 | @defop Operation {pretty printer} children (self) |
| 21584 | @value{GDBN} will call this method on a pretty-printer to compute the |
| 21585 | children of the pretty-printer's value. |
| 21586 | |
| 21587 | This method must return an object conforming to the Python iterator |
| 21588 | protocol. Each item returned by the iterator must be a tuple holding |
| 21589 | two elements. The first element is the ``name'' of the child; the |
| 21590 | second element is the child's value. The value can be any Python |
| 21591 | object which is convertible to a @value{GDBN} value. |
| 21592 | |
| 21593 | This method is optional. If it does not exist, @value{GDBN} will act |
| 21594 | as though the value has no children. |
| 21595 | @end defop |
| 21596 | |
| 21597 | @defop Operation {pretty printer} display_hint (self) |
| 21598 | The CLI may call this method and use its result to change the |
| 21599 | formatting of a value. The result will also be supplied to an MI |
| 21600 | consumer as a @samp{displayhint} attribute of the variable being |
| 21601 | printed. |
| 21602 | |
| 21603 | This method is optional. If it does exist, this method must return a |
| 21604 | string. |
| 21605 | |
| 21606 | Some display hints are predefined by @value{GDBN}: |
| 21607 | |
| 21608 | @table @samp |
| 21609 | @item array |
| 21610 | Indicate that the object being printed is ``array-like''. The CLI |
| 21611 | uses this to respect parameters such as @code{set print elements} and |
| 21612 | @code{set print array}. |
| 21613 | |
| 21614 | @item map |
| 21615 | Indicate that the object being printed is ``map-like'', and that the |
| 21616 | children of this value can be assumed to alternate between keys and |
| 21617 | values. |
| 21618 | |
| 21619 | @item string |
| 21620 | Indicate that the object being printed is ``string-like''. If the |
| 21621 | printer's @code{to_string} method returns a Python string of some |
| 21622 | kind, then @value{GDBN} will call its internal language-specific |
| 21623 | string-printing function to format the string. For the CLI this means |
| 21624 | adding quotation marks, possibly escaping some characters, respecting |
| 21625 | @code{set print elements}, and the like. |
| 21626 | @end table |
| 21627 | @end defop |
| 21628 | |
| 21629 | @defop Operation {pretty printer} to_string (self) |
| 21630 | @value{GDBN} will call this method to display the string |
| 21631 | representation of the value passed to the object's constructor. |
| 21632 | |
| 21633 | When printing from the CLI, if the @code{to_string} method exists, |
| 21634 | then @value{GDBN} will prepend its result to the values returned by |
| 21635 | @code{children}. Exactly how this formatting is done is dependent on |
| 21636 | the display hint, and may change as more hints are added. Also, |
| 21637 | depending on the print settings (@pxref{Print Settings}), the CLI may |
| 21638 | print just the result of @code{to_string} in a stack trace, omitting |
| 21639 | the result of @code{children}. |
| 21640 | |
| 21641 | If this method returns a string, it is printed verbatim. |
| 21642 | |
| 21643 | Otherwise, if this method returns an instance of @code{gdb.Value}, |
| 21644 | then @value{GDBN} prints this value. This may result in a call to |
| 21645 | another pretty-printer. |
| 21646 | |
| 21647 | If instead the method returns a Python value which is convertible to a |
| 21648 | @code{gdb.Value}, then @value{GDBN} performs the conversion and prints |
| 21649 | the resulting value. Again, this may result in a call to another |
| 21650 | pretty-printer. Python scalars (integers, floats, and booleans) and |
| 21651 | strings are convertible to @code{gdb.Value}; other types are not. |
| 21652 | |
| 21653 | Finally, if this method returns @code{None} then no further operations |
| 21654 | are peformed in this method and nothing is printed. |
| 21655 | |
| 21656 | If the result is not one of these types, an exception is raised. |
| 21657 | @end defop |
| 21658 | |
| 21659 | @value{GDBN} provides a function which can be used to look up the |
| 21660 | default pretty-printer for a @code{gdb.Value}: |
| 21661 | |
| 21662 | @findex gdb.default_visualizer |
| 21663 | @defun default_visualizer value |
| 21664 | This function takes a @code{gdb.Value} object as an argument. If a |
| 21665 | pretty-printer for this value exists, then it is returned. If no such |
| 21666 | printer exists, then this returns @code{None}. |
| 21667 | @end defun |
| 21668 | |
| 21669 | @node Selecting Pretty-Printers |
| 21670 | @subsubsection Selecting Pretty-Printers |
| 21671 | |
| 21672 | The Python list @code{gdb.pretty_printers} contains an array of |
| 21673 | functions or callable objects that have been registered via addition |
| 21674 | as a pretty-printer. Printers in this list are called @code{global} |
| 21675 | printers, they're available when debugging all inferiors. |
| 21676 | Each @code{gdb.Progspace} contains a @code{pretty_printers} attribute. |
| 21677 | Each @code{gdb.Objfile} also contains a @code{pretty_printers} |
| 21678 | attribute. |
| 21679 | |
| 21680 | Each function on these lists is passed a single @code{gdb.Value} |
| 21681 | argument and should return a pretty-printer object conforming to the |
| 21682 | interface definition above (@pxref{Pretty Printing API}). If a function |
| 21683 | cannot create a pretty-printer for the value, it should return |
| 21684 | @code{None}. |
| 21685 | |
| 21686 | @value{GDBN} first checks the @code{pretty_printers} attribute of each |
| 21687 | @code{gdb.Objfile} in the current program space and iteratively calls |
| 21688 | each enabled lookup routine in the list for that @code{gdb.Objfile} |
| 21689 | until it receives a pretty-printer object. |
| 21690 | If no pretty-printer is found in the objfile lists, @value{GDBN} then |
| 21691 | searches the pretty-printer list of the current program space, |
| 21692 | calling each enabled function until an object is returned. |
| 21693 | After these lists have been exhausted, it tries the global |
| 21694 | @code{gdb.pretty_printers} list, again calling each enabled function until an |
| 21695 | object is returned. |
| 21696 | |
| 21697 | The order in which the objfiles are searched is not specified. For a |
| 21698 | given list, functions are always invoked from the head of the list, |
| 21699 | and iterated over sequentially until the end of the list, or a printer |
| 21700 | object is returned. |
| 21701 | |
| 21702 | For various reasons a pretty-printer may not work. |
| 21703 | For example, the underlying data structure may have changed and |
| 21704 | the pretty-printer is out of date. |
| 21705 | |
| 21706 | The consequences of a broken pretty-printer are severe enough that |
| 21707 | @value{GDBN} provides support for enabling and disabling individual |
| 21708 | printers. For example, if @code{print frame-arguments} is on, |
| 21709 | a backtrace can become highly illegible if any argument is printed |
| 21710 | with a broken printer. |
| 21711 | |
| 21712 | Pretty-printers are enabled and disabled by attaching an @code{enabled} |
| 21713 | attribute to the registered function or callable object. If this attribute |
| 21714 | is present and its value is @code{False}, the printer is disabled, otherwise |
| 21715 | the printer is enabled. |
| 21716 | |
| 21717 | @node Writing a Pretty-Printer |
| 21718 | @subsubsection Writing a Pretty-Printer |
| 21719 | @cindex writing a pretty-printer |
| 21720 | |
| 21721 | A pretty-printer consists of two parts: a lookup function to detect |
| 21722 | if the type is supported, and the printer itself. |
| 21723 | |
| 21724 | Here is an example showing how a @code{std::string} printer might be |
| 21725 | written. @xref{Pretty Printing API}, for details on the API this class |
| 21726 | must provide. |
| 21727 | |
| 21728 | @smallexample |
| 21729 | class StdStringPrinter(object): |
| 21730 | "Print a std::string" |
| 21731 | |
| 21732 | def __init__(self, val): |
| 21733 | self.val = val |
| 21734 | |
| 21735 | def to_string(self): |
| 21736 | return self.val['_M_dataplus']['_M_p'] |
| 21737 | |
| 21738 | def display_hint(self): |
| 21739 | return 'string' |
| 21740 | @end smallexample |
| 21741 | |
| 21742 | And here is an example showing how a lookup function for the printer |
| 21743 | example above might be written. |
| 21744 | |
| 21745 | @smallexample |
| 21746 | def str_lookup_function(val): |
| 21747 | lookup_tag = val.type.tag |
| 21748 | if lookup_tag == None: |
| 21749 | return None |
| 21750 | regex = re.compile("^std::basic_string<char,.*>$") |
| 21751 | if regex.match(lookup_tag): |
| 21752 | return StdStringPrinter(val) |
| 21753 | return None |
| 21754 | @end smallexample |
| 21755 | |
| 21756 | The example lookup function extracts the value's type, and attempts to |
| 21757 | match it to a type that it can pretty-print. If it is a type the |
| 21758 | printer can pretty-print, it will return a printer object. If not, it |
| 21759 | returns @code{None}. |
| 21760 | |
| 21761 | We recommend that you put your core pretty-printers into a Python |
| 21762 | package. If your pretty-printers are for use with a library, we |
| 21763 | further recommend embedding a version number into the package name. |
| 21764 | This practice will enable @value{GDBN} to load multiple versions of |
| 21765 | your pretty-printers at the same time, because they will have |
| 21766 | different names. |
| 21767 | |
| 21768 | You should write auto-loaded code (@pxref{Auto-loading}) such that it |
| 21769 | can be evaluated multiple times without changing its meaning. An |
| 21770 | ideal auto-load file will consist solely of @code{import}s of your |
| 21771 | printer modules, followed by a call to a register pretty-printers with |
| 21772 | the current objfile. |
| 21773 | |
| 21774 | Taken as a whole, this approach will scale nicely to multiple |
| 21775 | inferiors, each potentially using a different library version. |
| 21776 | Embedding a version number in the Python package name will ensure that |
| 21777 | @value{GDBN} is able to load both sets of printers simultaneously. |
| 21778 | Then, because the search for pretty-printers is done by objfile, and |
| 21779 | because your auto-loaded code took care to register your library's |
| 21780 | printers with a specific objfile, @value{GDBN} will find the correct |
| 21781 | printers for the specific version of the library used by each |
| 21782 | inferior. |
| 21783 | |
| 21784 | To continue the @code{std::string} example (@pxref{Pretty Printing API}), |
| 21785 | this code might appear in @code{gdb.libstdcxx.v6}: |
| 21786 | |
| 21787 | @smallexample |
| 21788 | def register_printers(objfile): |
| 21789 | objfile.pretty_printers.add(str_lookup_function) |
| 21790 | @end smallexample |
| 21791 | |
| 21792 | @noindent |
| 21793 | And then the corresponding contents of the auto-load file would be: |
| 21794 | |
| 21795 | @smallexample |
| 21796 | import gdb.libstdcxx.v6 |
| 21797 | gdb.libstdcxx.v6.register_printers(gdb.current_objfile()) |
| 21798 | @end smallexample |
| 21799 | |
| 21800 | The previous example illustrates a basic pretty-printer. |
| 21801 | There are a few things that can be improved on. |
| 21802 | The printer doesn't have a name, making it hard to identify in a |
| 21803 | list of installed printers. The lookup function has a name, but |
| 21804 | lookup functions can have arbitrary, even identical, names. |
| 21805 | |
| 21806 | Second, the printer only handles one type, whereas a library typically has |
| 21807 | several types. One could install a lookup function for each desired type |
| 21808 | in the library, but one could also have a single lookup function recognize |
| 21809 | several types. The latter is the conventional way this is handled. |
| 21810 | If a pretty-printer can handle multiple data types, then its |
| 21811 | @dfn{subprinters} are the printers for the individual data types. |
| 21812 | |
| 21813 | The @code{gdb.printing} module provides a formal way of solving these |
| 21814 | problems (@pxref{gdb.printing}). |
| 21815 | Here is another example that handles multiple types. |
| 21816 | |
| 21817 | These are the types we are going to pretty-print: |
| 21818 | |
| 21819 | @smallexample |
| 21820 | struct foo @{ int a, b; @}; |
| 21821 | struct bar @{ struct foo x, y; @}; |
| 21822 | @end smallexample |
| 21823 | |
| 21824 | Here are the printers: |
| 21825 | |
| 21826 | @smallexample |
| 21827 | class fooPrinter: |
| 21828 | """Print a foo object.""" |
| 21829 | |
| 21830 | def __init__(self, val): |
| 21831 | self.val = val |
| 21832 | |
| 21833 | def to_string(self): |
| 21834 | return ("a=<" + str(self.val["a"]) + |
| 21835 | "> b=<" + str(self.val["b"]) + ">") |
| 21836 | |
| 21837 | class barPrinter: |
| 21838 | """Print a bar object.""" |
| 21839 | |
| 21840 | def __init__(self, val): |
| 21841 | self.val = val |
| 21842 | |
| 21843 | def to_string(self): |
| 21844 | return ("x=<" + str(self.val["x"]) + |
| 21845 | "> y=<" + str(self.val["y"]) + ">") |
| 21846 | @end smallexample |
| 21847 | |
| 21848 | This example doesn't need a lookup function, that is handled by the |
| 21849 | @code{gdb.printing} module. Instead a function is provided to build up |
| 21850 | the object that handles the lookup. |
| 21851 | |
| 21852 | @smallexample |
| 21853 | import gdb.printing |
| 21854 | |
| 21855 | def build_pretty_printer(): |
| 21856 | pp = gdb.printing.RegexpCollectionPrettyPrinter( |
| 21857 | "my_library") |
| 21858 | pp.add_printer('foo', '^foo$', fooPrinter) |
| 21859 | pp.add_printer('bar', '^bar$', barPrinter) |
| 21860 | return pp |
| 21861 | @end smallexample |
| 21862 | |
| 21863 | And here is the autoload support: |
| 21864 | |
| 21865 | @smallexample |
| 21866 | import gdb.printing |
| 21867 | import my_library |
| 21868 | gdb.printing.register_pretty_printer( |
| 21869 | gdb.current_objfile(), |
| 21870 | my_library.build_pretty_printer()) |
| 21871 | @end smallexample |
| 21872 | |
| 21873 | Finally, when this printer is loaded into @value{GDBN}, here is the |
| 21874 | corresponding output of @samp{info pretty-printer}: |
| 21875 | |
| 21876 | @smallexample |
| 21877 | (gdb) info pretty-printer |
| 21878 | my_library.so: |
| 21879 | my_library |
| 21880 | foo |
| 21881 | bar |
| 21882 | @end smallexample |
| 21883 | |
| 21884 | @node Inferiors In Python |
| 21885 | @subsubsection Inferiors In Python |
| 21886 | @cindex inferiors in Python |
| 21887 | |
| 21888 | @findex gdb.Inferior |
| 21889 | Programs which are being run under @value{GDBN} are called inferiors |
| 21890 | (@pxref{Inferiors and Programs}). Python scripts can access |
| 21891 | information about and manipulate inferiors controlled by @value{GDBN} |
| 21892 | via objects of the @code{gdb.Inferior} class. |
| 21893 | |
| 21894 | The following inferior-related functions are available in the @code{gdb} |
| 21895 | module: |
| 21896 | |
| 21897 | @defun inferiors |
| 21898 | Return a tuple containing all inferior objects. |
| 21899 | @end defun |
| 21900 | |
| 21901 | A @code{gdb.Inferior} object has the following attributes: |
| 21902 | |
| 21903 | @table @code |
| 21904 | @defivar Inferior num |
| 21905 | ID of inferior, as assigned by GDB. |
| 21906 | @end defivar |
| 21907 | |
| 21908 | @defivar Inferior pid |
| 21909 | Process ID of the inferior, as assigned by the underlying operating |
| 21910 | system. |
| 21911 | @end defivar |
| 21912 | |
| 21913 | @defivar Inferior was_attached |
| 21914 | Boolean signaling whether the inferior was created using `attach', or |
| 21915 | started by @value{GDBN} itself. |
| 21916 | @end defivar |
| 21917 | @end table |
| 21918 | |
| 21919 | A @code{gdb.Inferior} object has the following methods: |
| 21920 | |
| 21921 | @table @code |
| 21922 | @defmethod Inferior is_valid |
| 21923 | Returns @code{True} if the @code{gdb.Inferior} object is valid, |
| 21924 | @code{False} if not. A @code{gdb.Inferior} object will become invalid |
| 21925 | if the inferior no longer exists within @value{GDBN}. All other |
| 21926 | @code{gdb.Inferior} methods will throw an exception if it is invalid |
| 21927 | at the time the method is called. |
| 21928 | @end defmethod |
| 21929 | |
| 21930 | @defmethod Inferior threads |
| 21931 | This method returns a tuple holding all the threads which are valid |
| 21932 | when it is called. If there are no valid threads, the method will |
| 21933 | return an empty tuple. |
| 21934 | @end defmethod |
| 21935 | |
| 21936 | @findex gdb.read_memory |
| 21937 | @defmethod Inferior read_memory address length |
| 21938 | Read @var{length} bytes of memory from the inferior, starting at |
| 21939 | @var{address}. Returns a buffer object, which behaves much like an array |
| 21940 | or a string. It can be modified and given to the @code{gdb.write_memory} |
| 21941 | function. |
| 21942 | @end defmethod |
| 21943 | |
| 21944 | @findex gdb.write_memory |
| 21945 | @defmethod Inferior write_memory address buffer @r{[}length@r{]} |
| 21946 | Write the contents of @var{buffer} to the inferior, starting at |
| 21947 | @var{address}. The @var{buffer} parameter must be a Python object |
| 21948 | which supports the buffer protocol, i.e., a string, an array or the |
| 21949 | object returned from @code{gdb.read_memory}. If given, @var{length} |
| 21950 | determines the number of bytes from @var{buffer} to be written. |
| 21951 | @end defmethod |
| 21952 | |
| 21953 | @findex gdb.search_memory |
| 21954 | @defmethod Inferior search_memory address length pattern |
| 21955 | Search a region of the inferior memory starting at @var{address} with |
| 21956 | the given @var{length} using the search pattern supplied in |
| 21957 | @var{pattern}. The @var{pattern} parameter must be a Python object |
| 21958 | which supports the buffer protocol, i.e., a string, an array or the |
| 21959 | object returned from @code{gdb.read_memory}. Returns a Python @code{Long} |
| 21960 | containing the address where the pattern was found, or @code{None} if |
| 21961 | the pattern could not be found. |
| 21962 | @end defmethod |
| 21963 | @end table |
| 21964 | |
| 21965 | @node Events In Python |
| 21966 | @subsubsection Events In Python |
| 21967 | @cindex inferior events in Python |
| 21968 | |
| 21969 | @value{GDBN} provides a general event facility so that Python code can be |
| 21970 | notified of various state changes, particularly changes that occur in |
| 21971 | the inferior. |
| 21972 | |
| 21973 | An @dfn{event} is just an object that describes some state change. The |
| 21974 | type of the object and its attributes will vary depending on the details |
| 21975 | of the change. All the existing events are described below. |
| 21976 | |
| 21977 | In order to be notified of an event, you must register an event handler |
| 21978 | with an @dfn{event registry}. An event registry is an object in the |
| 21979 | @code{gdb.events} module which dispatches particular events. A registry |
| 21980 | provides methods to register and unregister event handlers: |
| 21981 | |
| 21982 | @table @code |
| 21983 | @defmethod EventRegistry connect object |
| 21984 | Add the given callable @var{object} to the registry. This object will be |
| 21985 | called when an event corresponding to this registry occurs. |
| 21986 | @end defmethod |
| 21987 | |
| 21988 | @defmethod EventRegistry disconnect object |
| 21989 | Remove the given @var{object} from the registry. Once removed, the object |
| 21990 | will no longer receive notifications of events. |
| 21991 | @end defmethod |
| 21992 | @end table |
| 21993 | |
| 21994 | Here is an example: |
| 21995 | |
| 21996 | @smallexample |
| 21997 | def exit_handler (event): |
| 21998 | print "event type: exit" |
| 21999 | print "exit code: %d" % (event.exit_code) |
| 22000 | |
| 22001 | gdb.events.exited.connect (exit_handler) |
| 22002 | @end smallexample |
| 22003 | |
| 22004 | In the above example we connect our handler @code{exit_handler} to the |
| 22005 | registry @code{events.exited}. Once connected, @code{exit_handler} gets |
| 22006 | called when the inferior exits. The argument @dfn{event} in this example is |
| 22007 | of type @code{gdb.ExitedEvent}. As you can see in the example the |
| 22008 | @code{ExitedEvent} object has an attribute which indicates the exit code of |
| 22009 | the inferior. |
| 22010 | |
| 22011 | The following is a listing of the event registries that are available and |
| 22012 | details of the events they emit: |
| 22013 | |
| 22014 | @table @code |
| 22015 | |
| 22016 | @item events.cont |
| 22017 | Emits @code{gdb.ThreadEvent}. |
| 22018 | |
| 22019 | Some events can be thread specific when @value{GDBN} is running in non-stop |
| 22020 | mode. When represented in Python, these events all extend |
| 22021 | @code{gdb.ThreadEvent}. Note, this event is not emitted directly; instead, |
| 22022 | events which are emitted by this or other modules might extend this event. |
| 22023 | Examples of these events are @code{gdb.BreakpointEvent} and |
| 22024 | @code{gdb.ContinueEvent}. |
| 22025 | |
| 22026 | @table @code |
| 22027 | @defivar ThreadEvent inferior_thread |
| 22028 | In non-stop mode this attribute will be set to the specific thread which was |
| 22029 | involved in the emitted event. Otherwise, it will be set to @code{None}. |
| 22030 | @end defivar |
| 22031 | @end table |
| 22032 | |
| 22033 | Emits @code{gdb.ContinueEvent} which extends @code{gdb.ThreadEvent}. |
| 22034 | |
| 22035 | This event indicates that the inferior has been continued after a stop. For |
| 22036 | inherited attribute refer to @code{gdb.ThreadEvent} above. |
| 22037 | |
| 22038 | @item events.exited |
| 22039 | Emits @code{events.ExitedEvent} which indicates that the inferior has exited. |
| 22040 | @code{events.ExitedEvent} has one attribute: |
| 22041 | @table @code |
| 22042 | @defivar ExitedEvent exit_code |
| 22043 | An integer representing the exit code which the inferior has returned. |
| 22044 | @end defivar |
| 22045 | @end table |
| 22046 | |
| 22047 | @item events.stop |
| 22048 | Emits @code{gdb.StopEvent} which extends @code{gdb.ThreadEvent}. |
| 22049 | |
| 22050 | Indicates that the inferior has stopped. All events emitted by this registry |
| 22051 | extend StopEvent. As a child of @code{gdb.ThreadEvent}, @code{gdb.StopEvent} |
| 22052 | will indicate the stopped thread when @value{GDBN} is running in non-stop |
| 22053 | mode. Refer to @code{gdb.ThreadEvent} above for more details. |
| 22054 | |
| 22055 | Emits @code{gdb.SignalEvent} which extends @code{gdb.StopEvent}. |
| 22056 | |
| 22057 | This event indicates that the inferior or one of its threads has received as |
| 22058 | signal. @code{gdb.SignalEvent} has the following attributes: |
| 22059 | |
| 22060 | @table @code |
| 22061 | @defivar SignalEvent stop_signal |
| 22062 | A string representing the signal received by the inferior. A list of possible |
| 22063 | signal values can be obtained by running the command @code{info signals} in |
| 22064 | the @value{GDBN} command prompt. |
| 22065 | @end defivar |
| 22066 | @end table |
| 22067 | |
| 22068 | Also emits @code{gdb.BreakpointEvent} which extends @code{gdb.StopEvent}. |
| 22069 | |
| 22070 | @code{gdb.BreakpointEvent} event indicates that a breakpoint has been hit, and |
| 22071 | has the following attributes: |
| 22072 | |
| 22073 | @table @code |
| 22074 | @defivar BreakpointEvent breakpoint |
| 22075 | A reference to the breakpoint that was hit of type @code{gdb.Breakpoint}. |
| 22076 | @xref{Breakpoints In Python}, for details of the @code{gdb.Breakpoint} object. |
| 22077 | @end defivar |
| 22078 | @end table |
| 22079 | |
| 22080 | @end table |
| 22081 | |
| 22082 | @node Threads In Python |
| 22083 | @subsubsection Threads In Python |
| 22084 | @cindex threads in python |
| 22085 | |
| 22086 | @findex gdb.InferiorThread |
| 22087 | Python scripts can access information about, and manipulate inferior threads |
| 22088 | controlled by @value{GDBN}, via objects of the @code{gdb.InferiorThread} class. |
| 22089 | |
| 22090 | The following thread-related functions are available in the @code{gdb} |
| 22091 | module: |
| 22092 | |
| 22093 | @findex gdb.selected_thread |
| 22094 | @defun selected_thread |
| 22095 | This function returns the thread object for the selected thread. If there |
| 22096 | is no selected thread, this will return @code{None}. |
| 22097 | @end defun |
| 22098 | |
| 22099 | A @code{gdb.InferiorThread} object has the following attributes: |
| 22100 | |
| 22101 | @table @code |
| 22102 | @defivar InferiorThread name |
| 22103 | The name of the thread. If the user specified a name using |
| 22104 | @code{thread name}, then this returns that name. Otherwise, if an |
| 22105 | OS-supplied name is available, then it is returned. Otherwise, this |
| 22106 | returns @code{None}. |
| 22107 | |
| 22108 | This attribute can be assigned to. The new value must be a string |
| 22109 | object, which sets the new name, or @code{None}, which removes any |
| 22110 | user-specified thread name. |
| 22111 | @end defivar |
| 22112 | |
| 22113 | @defivar InferiorThread num |
| 22114 | ID of the thread, as assigned by GDB. |
| 22115 | @end defivar |
| 22116 | |
| 22117 | @defivar InferiorThread ptid |
| 22118 | ID of the thread, as assigned by the operating system. This attribute is a |
| 22119 | tuple containing three integers. The first is the Process ID (PID); the second |
| 22120 | is the Lightweight Process ID (LWPID), and the third is the Thread ID (TID). |
| 22121 | Either the LWPID or TID may be 0, which indicates that the operating system |
| 22122 | does not use that identifier. |
| 22123 | @end defivar |
| 22124 | @end table |
| 22125 | |
| 22126 | A @code{gdb.InferiorThread} object has the following methods: |
| 22127 | |
| 22128 | @table @code |
| 22129 | @defmethod InferiorThread is_valid |
| 22130 | Returns @code{True} if the @code{gdb.InferiorThread} object is valid, |
| 22131 | @code{False} if not. A @code{gdb.InferiorThread} object will become |
| 22132 | invalid if the thread exits, or the inferior that the thread belongs |
| 22133 | is deleted. All other @code{gdb.InferiorThread} methods will throw an |
| 22134 | exception if it is invalid at the time the method is called. |
| 22135 | @end defmethod |
| 22136 | |
| 22137 | @defmethod InferiorThread switch |
| 22138 | This changes @value{GDBN}'s currently selected thread to the one represented |
| 22139 | by this object. |
| 22140 | @end defmethod |
| 22141 | |
| 22142 | @defmethod InferiorThread is_stopped |
| 22143 | Return a Boolean indicating whether the thread is stopped. |
| 22144 | @end defmethod |
| 22145 | |
| 22146 | @defmethod InferiorThread is_running |
| 22147 | Return a Boolean indicating whether the thread is running. |
| 22148 | @end defmethod |
| 22149 | |
| 22150 | @defmethod InferiorThread is_exited |
| 22151 | Return a Boolean indicating whether the thread is exited. |
| 22152 | @end defmethod |
| 22153 | @end table |
| 22154 | |
| 22155 | @node Commands In Python |
| 22156 | @subsubsection Commands In Python |
| 22157 | |
| 22158 | @cindex commands in python |
| 22159 | @cindex python commands |
| 22160 | You can implement new @value{GDBN} CLI commands in Python. A CLI |
| 22161 | command is implemented using an instance of the @code{gdb.Command} |
| 22162 | class, most commonly using a subclass. |
| 22163 | |
| 22164 | @defmethod Command __init__ name @var{command_class} @r{[}@var{completer_class}@r{]} @r{[}@var{prefix}@r{]} |
| 22165 | The object initializer for @code{Command} registers the new command |
| 22166 | with @value{GDBN}. This initializer is normally invoked from the |
| 22167 | subclass' own @code{__init__} method. |
| 22168 | |
| 22169 | @var{name} is the name of the command. If @var{name} consists of |
| 22170 | multiple words, then the initial words are looked for as prefix |
| 22171 | commands. In this case, if one of the prefix commands does not exist, |
| 22172 | an exception is raised. |
| 22173 | |
| 22174 | There is no support for multi-line commands. |
| 22175 | |
| 22176 | @var{command_class} should be one of the @samp{COMMAND_} constants |
| 22177 | defined below. This argument tells @value{GDBN} how to categorize the |
| 22178 | new command in the help system. |
| 22179 | |
| 22180 | @var{completer_class} is an optional argument. If given, it should be |
| 22181 | one of the @samp{COMPLETE_} constants defined below. This argument |
| 22182 | tells @value{GDBN} how to perform completion for this command. If not |
| 22183 | given, @value{GDBN} will attempt to complete using the object's |
| 22184 | @code{complete} method (see below); if no such method is found, an |
| 22185 | error will occur when completion is attempted. |
| 22186 | |
| 22187 | @var{prefix} is an optional argument. If @code{True}, then the new |
| 22188 | command is a prefix command; sub-commands of this command may be |
| 22189 | registered. |
| 22190 | |
| 22191 | The help text for the new command is taken from the Python |
| 22192 | documentation string for the command's class, if there is one. If no |
| 22193 | documentation string is provided, the default value ``This command is |
| 22194 | not documented.'' is used. |
| 22195 | @end defmethod |
| 22196 | |
| 22197 | @cindex don't repeat Python command |
| 22198 | @defmethod Command dont_repeat |
| 22199 | By default, a @value{GDBN} command is repeated when the user enters a |
| 22200 | blank line at the command prompt. A command can suppress this |
| 22201 | behavior by invoking the @code{dont_repeat} method. This is similar |
| 22202 | to the user command @code{dont-repeat}, see @ref{Define, dont-repeat}. |
| 22203 | @end defmethod |
| 22204 | |
| 22205 | @defmethod Command invoke argument from_tty |
| 22206 | This method is called by @value{GDBN} when this command is invoked. |
| 22207 | |
| 22208 | @var{argument} is a string. It is the argument to the command, after |
| 22209 | leading and trailing whitespace has been stripped. |
| 22210 | |
| 22211 | @var{from_tty} is a boolean argument. When true, this means that the |
| 22212 | command was entered by the user at the terminal; when false it means |
| 22213 | that the command came from elsewhere. |
| 22214 | |
| 22215 | If this method throws an exception, it is turned into a @value{GDBN} |
| 22216 | @code{error} call. Otherwise, the return value is ignored. |
| 22217 | |
| 22218 | @findex gdb.string_to_argv |
| 22219 | To break @var{argument} up into an argv-like string use |
| 22220 | @code{gdb.string_to_argv}. This function behaves identically to |
| 22221 | @value{GDBN}'s internal argument lexer @code{buildargv}. |
| 22222 | It is recommended to use this for consistency. |
| 22223 | Arguments are separated by spaces and may be quoted. |
| 22224 | Example: |
| 22225 | |
| 22226 | @smallexample |
| 22227 | print gdb.string_to_argv ("1 2\ \\\"3 '4 \"5' \"6 '7\"") |
| 22228 | ['1', '2 "3', '4 "5', "6 '7"] |
| 22229 | @end smallexample |
| 22230 | |
| 22231 | @end defmethod |
| 22232 | |
| 22233 | @cindex completion of Python commands |
| 22234 | @defmethod Command complete text word |
| 22235 | This method is called by @value{GDBN} when the user attempts |
| 22236 | completion on this command. All forms of completion are handled by |
| 22237 | this method, that is, the @key{TAB} and @key{M-?} key bindings |
| 22238 | (@pxref{Completion}), and the @code{complete} command (@pxref{Help, |
| 22239 | complete}). |
| 22240 | |
| 22241 | The arguments @var{text} and @var{word} are both strings. @var{text} |
| 22242 | holds the complete command line up to the cursor's location. |
| 22243 | @var{word} holds the last word of the command line; this is computed |
| 22244 | using a word-breaking heuristic. |
| 22245 | |
| 22246 | The @code{complete} method can return several values: |
| 22247 | @itemize @bullet |
| 22248 | @item |
| 22249 | If the return value is a sequence, the contents of the sequence are |
| 22250 | used as the completions. It is up to @code{complete} to ensure that the |
| 22251 | contents actually do complete the word. A zero-length sequence is |
| 22252 | allowed, it means that there were no completions available. Only |
| 22253 | string elements of the sequence are used; other elements in the |
| 22254 | sequence are ignored. |
| 22255 | |
| 22256 | @item |
| 22257 | If the return value is one of the @samp{COMPLETE_} constants defined |
| 22258 | below, then the corresponding @value{GDBN}-internal completion |
| 22259 | function is invoked, and its result is used. |
| 22260 | |
| 22261 | @item |
| 22262 | All other results are treated as though there were no available |
| 22263 | completions. |
| 22264 | @end itemize |
| 22265 | @end defmethod |
| 22266 | |
| 22267 | When a new command is registered, it must be declared as a member of |
| 22268 | some general class of commands. This is used to classify top-level |
| 22269 | commands in the on-line help system; note that prefix commands are not |
| 22270 | listed under their own category but rather that of their top-level |
| 22271 | command. The available classifications are represented by constants |
| 22272 | defined in the @code{gdb} module: |
| 22273 | |
| 22274 | @table @code |
| 22275 | @findex COMMAND_NONE |
| 22276 | @findex gdb.COMMAND_NONE |
| 22277 | @item COMMAND_NONE |
| 22278 | The command does not belong to any particular class. A command in |
| 22279 | this category will not be displayed in any of the help categories. |
| 22280 | |
| 22281 | @findex COMMAND_RUNNING |
| 22282 | @findex gdb.COMMAND_RUNNING |
| 22283 | @item COMMAND_RUNNING |
| 22284 | The command is related to running the inferior. For example, |
| 22285 | @code{start}, @code{step}, and @code{continue} are in this category. |
| 22286 | Type @kbd{help running} at the @value{GDBN} prompt to see a list of |
| 22287 | commands in this category. |
| 22288 | |
| 22289 | @findex COMMAND_DATA |
| 22290 | @findex gdb.COMMAND_DATA |
| 22291 | @item COMMAND_DATA |
| 22292 | The command is related to data or variables. For example, |
| 22293 | @code{call}, @code{find}, and @code{print} are in this category. Type |
| 22294 | @kbd{help data} at the @value{GDBN} prompt to see a list of commands |
| 22295 | in this category. |
| 22296 | |
| 22297 | @findex COMMAND_STACK |
| 22298 | @findex gdb.COMMAND_STACK |
| 22299 | @item COMMAND_STACK |
| 22300 | The command has to do with manipulation of the stack. For example, |
| 22301 | @code{backtrace}, @code{frame}, and @code{return} are in this |
| 22302 | category. Type @kbd{help stack} at the @value{GDBN} prompt to see a |
| 22303 | list of commands in this category. |
| 22304 | |
| 22305 | @findex COMMAND_FILES |
| 22306 | @findex gdb.COMMAND_FILES |
| 22307 | @item COMMAND_FILES |
| 22308 | This class is used for file-related commands. For example, |
| 22309 | @code{file}, @code{list} and @code{section} are in this category. |
| 22310 | Type @kbd{help files} at the @value{GDBN} prompt to see a list of |
| 22311 | commands in this category. |
| 22312 | |
| 22313 | @findex COMMAND_SUPPORT |
| 22314 | @findex gdb.COMMAND_SUPPORT |
| 22315 | @item COMMAND_SUPPORT |
| 22316 | This should be used for ``support facilities'', generally meaning |
| 22317 | things that are useful to the user when interacting with @value{GDBN}, |
| 22318 | but not related to the state of the inferior. For example, |
| 22319 | @code{help}, @code{make}, and @code{shell} are in this category. Type |
| 22320 | @kbd{help support} at the @value{GDBN} prompt to see a list of |
| 22321 | commands in this category. |
| 22322 | |
| 22323 | @findex COMMAND_STATUS |
| 22324 | @findex gdb.COMMAND_STATUS |
| 22325 | @item COMMAND_STATUS |
| 22326 | The command is an @samp{info}-related command, that is, related to the |
| 22327 | state of @value{GDBN} itself. For example, @code{info}, @code{macro}, |
| 22328 | and @code{show} are in this category. Type @kbd{help status} at the |
| 22329 | @value{GDBN} prompt to see a list of commands in this category. |
| 22330 | |
| 22331 | @findex COMMAND_BREAKPOINTS |
| 22332 | @findex gdb.COMMAND_BREAKPOINTS |
| 22333 | @item COMMAND_BREAKPOINTS |
| 22334 | The command has to do with breakpoints. For example, @code{break}, |
| 22335 | @code{clear}, and @code{delete} are in this category. Type @kbd{help |
| 22336 | breakpoints} at the @value{GDBN} prompt to see a list of commands in |
| 22337 | this category. |
| 22338 | |
| 22339 | @findex COMMAND_TRACEPOINTS |
| 22340 | @findex gdb.COMMAND_TRACEPOINTS |
| 22341 | @item COMMAND_TRACEPOINTS |
| 22342 | The command has to do with tracepoints. For example, @code{trace}, |
| 22343 | @code{actions}, and @code{tfind} are in this category. Type |
| 22344 | @kbd{help tracepoints} at the @value{GDBN} prompt to see a list of |
| 22345 | commands in this category. |
| 22346 | |
| 22347 | @findex COMMAND_OBSCURE |
| 22348 | @findex gdb.COMMAND_OBSCURE |
| 22349 | @item COMMAND_OBSCURE |
| 22350 | The command is only used in unusual circumstances, or is not of |
| 22351 | general interest to users. For example, @code{checkpoint}, |
| 22352 | @code{fork}, and @code{stop} are in this category. Type @kbd{help |
| 22353 | obscure} at the @value{GDBN} prompt to see a list of commands in this |
| 22354 | category. |
| 22355 | |
| 22356 | @findex COMMAND_MAINTENANCE |
| 22357 | @findex gdb.COMMAND_MAINTENANCE |
| 22358 | @item COMMAND_MAINTENANCE |
| 22359 | The command is only useful to @value{GDBN} maintainers. The |
| 22360 | @code{maintenance} and @code{flushregs} commands are in this category. |
| 22361 | Type @kbd{help internals} at the @value{GDBN} prompt to see a list of |
| 22362 | commands in this category. |
| 22363 | @end table |
| 22364 | |
| 22365 | A new command can use a predefined completion function, either by |
| 22366 | specifying it via an argument at initialization, or by returning it |
| 22367 | from the @code{complete} method. These predefined completion |
| 22368 | constants are all defined in the @code{gdb} module: |
| 22369 | |
| 22370 | @table @code |
| 22371 | @findex COMPLETE_NONE |
| 22372 | @findex gdb.COMPLETE_NONE |
| 22373 | @item COMPLETE_NONE |
| 22374 | This constant means that no completion should be done. |
| 22375 | |
| 22376 | @findex COMPLETE_FILENAME |
| 22377 | @findex gdb.COMPLETE_FILENAME |
| 22378 | @item COMPLETE_FILENAME |
| 22379 | This constant means that filename completion should be performed. |
| 22380 | |
| 22381 | @findex COMPLETE_LOCATION |
| 22382 | @findex gdb.COMPLETE_LOCATION |
| 22383 | @item COMPLETE_LOCATION |
| 22384 | This constant means that location completion should be done. |
| 22385 | @xref{Specify Location}. |
| 22386 | |
| 22387 | @findex COMPLETE_COMMAND |
| 22388 | @findex gdb.COMPLETE_COMMAND |
| 22389 | @item COMPLETE_COMMAND |
| 22390 | This constant means that completion should examine @value{GDBN} |
| 22391 | command names. |
| 22392 | |
| 22393 | @findex COMPLETE_SYMBOL |
| 22394 | @findex gdb.COMPLETE_SYMBOL |
| 22395 | @item COMPLETE_SYMBOL |
| 22396 | This constant means that completion should be done using symbol names |
| 22397 | as the source. |
| 22398 | @end table |
| 22399 | |
| 22400 | The following code snippet shows how a trivial CLI command can be |
| 22401 | implemented in Python: |
| 22402 | |
| 22403 | @smallexample |
| 22404 | class HelloWorld (gdb.Command): |
| 22405 | """Greet the whole world.""" |
| 22406 | |
| 22407 | def __init__ (self): |
| 22408 | super (HelloWorld, self).__init__ ("hello-world", gdb.COMMAND_OBSCURE) |
| 22409 | |
| 22410 | def invoke (self, arg, from_tty): |
| 22411 | print "Hello, World!" |
| 22412 | |
| 22413 | HelloWorld () |
| 22414 | @end smallexample |
| 22415 | |
| 22416 | The last line instantiates the class, and is necessary to trigger the |
| 22417 | registration of the command with @value{GDBN}. Depending on how the |
| 22418 | Python code is read into @value{GDBN}, you may need to import the |
| 22419 | @code{gdb} module explicitly. |
| 22420 | |
| 22421 | @node Parameters In Python |
| 22422 | @subsubsection Parameters In Python |
| 22423 | |
| 22424 | @cindex parameters in python |
| 22425 | @cindex python parameters |
| 22426 | @tindex gdb.Parameter |
| 22427 | @tindex Parameter |
| 22428 | You can implement new @value{GDBN} parameters using Python. A new |
| 22429 | parameter is implemented as an instance of the @code{gdb.Parameter} |
| 22430 | class. |
| 22431 | |
| 22432 | Parameters are exposed to the user via the @code{set} and |
| 22433 | @code{show} commands. @xref{Help}. |
| 22434 | |
| 22435 | There are many parameters that already exist and can be set in |
| 22436 | @value{GDBN}. Two examples are: @code{set follow fork} and |
| 22437 | @code{set charset}. Setting these parameters influences certain |
| 22438 | behavior in @value{GDBN}. Similarly, you can define parameters that |
| 22439 | can be used to influence behavior in custom Python scripts and commands. |
| 22440 | |
| 22441 | @defmethod Parameter __init__ name @var{command-class} @var{parameter-class} @r{[}@var{enum-sequence}@r{]} |
| 22442 | The object initializer for @code{Parameter} registers the new |
| 22443 | parameter with @value{GDBN}. This initializer is normally invoked |
| 22444 | from the subclass' own @code{__init__} method. |
| 22445 | |
| 22446 | @var{name} is the name of the new parameter. If @var{name} consists |
| 22447 | of multiple words, then the initial words are looked for as prefix |
| 22448 | parameters. An example of this can be illustrated with the |
| 22449 | @code{set print} set of parameters. If @var{name} is |
| 22450 | @code{print foo}, then @code{print} will be searched as the prefix |
| 22451 | parameter. In this case the parameter can subsequently be accessed in |
| 22452 | @value{GDBN} as @code{set print foo}. |
| 22453 | |
| 22454 | If @var{name} consists of multiple words, and no prefix parameter group |
| 22455 | can be found, an exception is raised. |
| 22456 | |
| 22457 | @var{command-class} should be one of the @samp{COMMAND_} constants |
| 22458 | (@pxref{Commands In Python}). This argument tells @value{GDBN} how to |
| 22459 | categorize the new parameter in the help system. |
| 22460 | |
| 22461 | @var{parameter-class} should be one of the @samp{PARAM_} constants |
| 22462 | defined below. This argument tells @value{GDBN} the type of the new |
| 22463 | parameter; this information is used for input validation and |
| 22464 | completion. |
| 22465 | |
| 22466 | If @var{parameter-class} is @code{PARAM_ENUM}, then |
| 22467 | @var{enum-sequence} must be a sequence of strings. These strings |
| 22468 | represent the possible values for the parameter. |
| 22469 | |
| 22470 | If @var{parameter-class} is not @code{PARAM_ENUM}, then the presence |
| 22471 | of a fourth argument will cause an exception to be thrown. |
| 22472 | |
| 22473 | The help text for the new parameter is taken from the Python |
| 22474 | documentation string for the parameter's class, if there is one. If |
| 22475 | there is no documentation string, a default value is used. |
| 22476 | @end defmethod |
| 22477 | |
| 22478 | @defivar Parameter set_doc |
| 22479 | If this attribute exists, and is a string, then its value is used as |
| 22480 | the help text for this parameter's @code{set} command. The value is |
| 22481 | examined when @code{Parameter.__init__} is invoked; subsequent changes |
| 22482 | have no effect. |
| 22483 | @end defivar |
| 22484 | |
| 22485 | @defivar Parameter show_doc |
| 22486 | If this attribute exists, and is a string, then its value is used as |
| 22487 | the help text for this parameter's @code{show} command. The value is |
| 22488 | examined when @code{Parameter.__init__} is invoked; subsequent changes |
| 22489 | have no effect. |
| 22490 | @end defivar |
| 22491 | |
| 22492 | @defivar Parameter value |
| 22493 | The @code{value} attribute holds the underlying value of the |
| 22494 | parameter. It can be read and assigned to just as any other |
| 22495 | attribute. @value{GDBN} does validation when assignments are made. |
| 22496 | @end defivar |
| 22497 | |
| 22498 | There are two methods that should be implemented in any |
| 22499 | @code{Parameter} class. These are: |
| 22500 | |
| 22501 | @defop Operation {parameter} get_set_string self |
| 22502 | @value{GDBN} will call this method when a @var{parameter}'s value has |
| 22503 | been changed via the @code{set} API (for example, @kbd{set foo off}). |
| 22504 | The @code{value} attribute has already been populated with the new |
| 22505 | value and may be used in output. This method must return a string. |
| 22506 | @end defop |
| 22507 | |
| 22508 | @defop Operation {parameter} get_show_string self svalue |
| 22509 | @value{GDBN} will call this method when a @var{parameter}'s |
| 22510 | @code{show} API has been invoked (for example, @kbd{show foo}). The |
| 22511 | argument @code{svalue} receives the string representation of the |
| 22512 | current value. This method must return a string. |
| 22513 | @end defop |
| 22514 | |
| 22515 | When a new parameter is defined, its type must be specified. The |
| 22516 | available types are represented by constants defined in the @code{gdb} |
| 22517 | module: |
| 22518 | |
| 22519 | @table @code |
| 22520 | @findex PARAM_BOOLEAN |
| 22521 | @findex gdb.PARAM_BOOLEAN |
| 22522 | @item PARAM_BOOLEAN |
| 22523 | The value is a plain boolean. The Python boolean values, @code{True} |
| 22524 | and @code{False} are the only valid values. |
| 22525 | |
| 22526 | @findex PARAM_AUTO_BOOLEAN |
| 22527 | @findex gdb.PARAM_AUTO_BOOLEAN |
| 22528 | @item PARAM_AUTO_BOOLEAN |
| 22529 | The value has three possible states: true, false, and @samp{auto}. In |
| 22530 | Python, true and false are represented using boolean constants, and |
| 22531 | @samp{auto} is represented using @code{None}. |
| 22532 | |
| 22533 | @findex PARAM_UINTEGER |
| 22534 | @findex gdb.PARAM_UINTEGER |
| 22535 | @item PARAM_UINTEGER |
| 22536 | The value is an unsigned integer. The value of 0 should be |
| 22537 | interpreted to mean ``unlimited''. |
| 22538 | |
| 22539 | @findex PARAM_INTEGER |
| 22540 | @findex gdb.PARAM_INTEGER |
| 22541 | @item PARAM_INTEGER |
| 22542 | The value is a signed integer. The value of 0 should be interpreted |
| 22543 | to mean ``unlimited''. |
| 22544 | |
| 22545 | @findex PARAM_STRING |
| 22546 | @findex gdb.PARAM_STRING |
| 22547 | @item PARAM_STRING |
| 22548 | The value is a string. When the user modifies the string, any escape |
| 22549 | sequences, such as @samp{\t}, @samp{\f}, and octal escapes, are |
| 22550 | translated into corresponding characters and encoded into the current |
| 22551 | host charset. |
| 22552 | |
| 22553 | @findex PARAM_STRING_NOESCAPE |
| 22554 | @findex gdb.PARAM_STRING_NOESCAPE |
| 22555 | @item PARAM_STRING_NOESCAPE |
| 22556 | The value is a string. When the user modifies the string, escapes are |
| 22557 | passed through untranslated. |
| 22558 | |
| 22559 | @findex PARAM_OPTIONAL_FILENAME |
| 22560 | @findex gdb.PARAM_OPTIONAL_FILENAME |
| 22561 | @item PARAM_OPTIONAL_FILENAME |
| 22562 | The value is a either a filename (a string), or @code{None}. |
| 22563 | |
| 22564 | @findex PARAM_FILENAME |
| 22565 | @findex gdb.PARAM_FILENAME |
| 22566 | @item PARAM_FILENAME |
| 22567 | The value is a filename. This is just like |
| 22568 | @code{PARAM_STRING_NOESCAPE}, but uses file names for completion. |
| 22569 | |
| 22570 | @findex PARAM_ZINTEGER |
| 22571 | @findex gdb.PARAM_ZINTEGER |
| 22572 | @item PARAM_ZINTEGER |
| 22573 | The value is an integer. This is like @code{PARAM_INTEGER}, except 0 |
| 22574 | is interpreted as itself. |
| 22575 | |
| 22576 | @findex PARAM_ENUM |
| 22577 | @findex gdb.PARAM_ENUM |
| 22578 | @item PARAM_ENUM |
| 22579 | The value is a string, which must be one of a collection string |
| 22580 | constants provided when the parameter is created. |
| 22581 | @end table |
| 22582 | |
| 22583 | @node Functions In Python |
| 22584 | @subsubsection Writing new convenience functions |
| 22585 | |
| 22586 | @cindex writing convenience functions |
| 22587 | @cindex convenience functions in python |
| 22588 | @cindex python convenience functions |
| 22589 | @tindex gdb.Function |
| 22590 | @tindex Function |
| 22591 | You can implement new convenience functions (@pxref{Convenience Vars}) |
| 22592 | in Python. A convenience function is an instance of a subclass of the |
| 22593 | class @code{gdb.Function}. |
| 22594 | |
| 22595 | @defmethod Function __init__ name |
| 22596 | The initializer for @code{Function} registers the new function with |
| 22597 | @value{GDBN}. The argument @var{name} is the name of the function, |
| 22598 | a string. The function will be visible to the user as a convenience |
| 22599 | variable of type @code{internal function}, whose name is the same as |
| 22600 | the given @var{name}. |
| 22601 | |
| 22602 | The documentation for the new function is taken from the documentation |
| 22603 | string for the new class. |
| 22604 | @end defmethod |
| 22605 | |
| 22606 | @defmethod Function invoke @var{*args} |
| 22607 | When a convenience function is evaluated, its arguments are converted |
| 22608 | to instances of @code{gdb.Value}, and then the function's |
| 22609 | @code{invoke} method is called. Note that @value{GDBN} does not |
| 22610 | predetermine the arity of convenience functions. Instead, all |
| 22611 | available arguments are passed to @code{invoke}, following the |
| 22612 | standard Python calling convention. In particular, a convenience |
| 22613 | function can have default values for parameters without ill effect. |
| 22614 | |
| 22615 | The return value of this method is used as its value in the enclosing |
| 22616 | expression. If an ordinary Python value is returned, it is converted |
| 22617 | to a @code{gdb.Value} following the usual rules. |
| 22618 | @end defmethod |
| 22619 | |
| 22620 | The following code snippet shows how a trivial convenience function can |
| 22621 | be implemented in Python: |
| 22622 | |
| 22623 | @smallexample |
| 22624 | class Greet (gdb.Function): |
| 22625 | """Return string to greet someone. |
| 22626 | Takes a name as argument.""" |
| 22627 | |
| 22628 | def __init__ (self): |
| 22629 | super (Greet, self).__init__ ("greet") |
| 22630 | |
| 22631 | def invoke (self, name): |
| 22632 | return "Hello, %s!" % name.string () |
| 22633 | |
| 22634 | Greet () |
| 22635 | @end smallexample |
| 22636 | |
| 22637 | The last line instantiates the class, and is necessary to trigger the |
| 22638 | registration of the function with @value{GDBN}. Depending on how the |
| 22639 | Python code is read into @value{GDBN}, you may need to import the |
| 22640 | @code{gdb} module explicitly. |
| 22641 | |
| 22642 | @node Progspaces In Python |
| 22643 | @subsubsection Program Spaces In Python |
| 22644 | |
| 22645 | @cindex progspaces in python |
| 22646 | @tindex gdb.Progspace |
| 22647 | @tindex Progspace |
| 22648 | A program space, or @dfn{progspace}, represents a symbolic view |
| 22649 | of an address space. |
| 22650 | It consists of all of the objfiles of the program. |
| 22651 | @xref{Objfiles In Python}. |
| 22652 | @xref{Inferiors and Programs, program spaces}, for more details |
| 22653 | about program spaces. |
| 22654 | |
| 22655 | The following progspace-related functions are available in the |
| 22656 | @code{gdb} module: |
| 22657 | |
| 22658 | @findex gdb.current_progspace |
| 22659 | @defun current_progspace |
| 22660 | This function returns the program space of the currently selected inferior. |
| 22661 | @xref{Inferiors and Programs}. |
| 22662 | @end defun |
| 22663 | |
| 22664 | @findex gdb.progspaces |
| 22665 | @defun progspaces |
| 22666 | Return a sequence of all the progspaces currently known to @value{GDBN}. |
| 22667 | @end defun |
| 22668 | |
| 22669 | Each progspace is represented by an instance of the @code{gdb.Progspace} |
| 22670 | class. |
| 22671 | |
| 22672 | @defivar Progspace filename |
| 22673 | The file name of the progspace as a string. |
| 22674 | @end defivar |
| 22675 | |
| 22676 | @defivar Progspace pretty_printers |
| 22677 | The @code{pretty_printers} attribute is a list of functions. It is |
| 22678 | used to look up pretty-printers. A @code{Value} is passed to each |
| 22679 | function in order; if the function returns @code{None}, then the |
| 22680 | search continues. Otherwise, the return value should be an object |
| 22681 | which is used to format the value. @xref{Pretty Printing API}, for more |
| 22682 | information. |
| 22683 | @end defivar |
| 22684 | |
| 22685 | @node Objfiles In Python |
| 22686 | @subsubsection Objfiles In Python |
| 22687 | |
| 22688 | @cindex objfiles in python |
| 22689 | @tindex gdb.Objfile |
| 22690 | @tindex Objfile |
| 22691 | @value{GDBN} loads symbols for an inferior from various |
| 22692 | symbol-containing files (@pxref{Files}). These include the primary |
| 22693 | executable file, any shared libraries used by the inferior, and any |
| 22694 | separate debug info files (@pxref{Separate Debug Files}). |
| 22695 | @value{GDBN} calls these symbol-containing files @dfn{objfiles}. |
| 22696 | |
| 22697 | The following objfile-related functions are available in the |
| 22698 | @code{gdb} module: |
| 22699 | |
| 22700 | @findex gdb.current_objfile |
| 22701 | @defun current_objfile |
| 22702 | When auto-loading a Python script (@pxref{Auto-loading}), @value{GDBN} |
| 22703 | sets the ``current objfile'' to the corresponding objfile. This |
| 22704 | function returns the current objfile. If there is no current objfile, |
| 22705 | this function returns @code{None}. |
| 22706 | @end defun |
| 22707 | |
| 22708 | @findex gdb.objfiles |
| 22709 | @defun objfiles |
| 22710 | Return a sequence of all the objfiles current known to @value{GDBN}. |
| 22711 | @xref{Objfiles In Python}. |
| 22712 | @end defun |
| 22713 | |
| 22714 | Each objfile is represented by an instance of the @code{gdb.Objfile} |
| 22715 | class. |
| 22716 | |
| 22717 | @defivar Objfile filename |
| 22718 | The file name of the objfile as a string. |
| 22719 | @end defivar |
| 22720 | |
| 22721 | @defivar Objfile pretty_printers |
| 22722 | The @code{pretty_printers} attribute is a list of functions. It is |
| 22723 | used to look up pretty-printers. A @code{Value} is passed to each |
| 22724 | function in order; if the function returns @code{None}, then the |
| 22725 | search continues. Otherwise, the return value should be an object |
| 22726 | which is used to format the value. @xref{Pretty Printing API}, for more |
| 22727 | information. |
| 22728 | @end defivar |
| 22729 | |
| 22730 | A @code{gdb.Objfile} object has the following methods: |
| 22731 | |
| 22732 | @defmethod Objfile is_valid |
| 22733 | Returns @code{True} if the @code{gdb.Objfile} object is valid, |
| 22734 | @code{False} if not. A @code{gdb.Objfile} object can become invalid |
| 22735 | if the object file it refers to is not loaded in @value{GDBN} any |
| 22736 | longer. All other @code{gdb.Objfile} methods will throw an exception |
| 22737 | if it is invalid at the time the method is called. |
| 22738 | @end defmethod |
| 22739 | |
| 22740 | @node Frames In Python |
| 22741 | @subsubsection Accessing inferior stack frames from Python. |
| 22742 | |
| 22743 | @cindex frames in python |
| 22744 | When the debugged program stops, @value{GDBN} is able to analyze its call |
| 22745 | stack (@pxref{Frames,,Stack frames}). The @code{gdb.Frame} class |
| 22746 | represents a frame in the stack. A @code{gdb.Frame} object is only valid |
| 22747 | while its corresponding frame exists in the inferior's stack. If you try |
| 22748 | to use an invalid frame object, @value{GDBN} will throw a @code{gdb.error} |
| 22749 | exception (@pxref{Exception Handling}). |
| 22750 | |
| 22751 | Two @code{gdb.Frame} objects can be compared for equality with the @code{==} |
| 22752 | operator, like: |
| 22753 | |
| 22754 | @smallexample |
| 22755 | (@value{GDBP}) python print gdb.newest_frame() == gdb.selected_frame () |
| 22756 | True |
| 22757 | @end smallexample |
| 22758 | |
| 22759 | The following frame-related functions are available in the @code{gdb} module: |
| 22760 | |
| 22761 | @findex gdb.selected_frame |
| 22762 | @defun selected_frame |
| 22763 | Return the selected frame object. (@pxref{Selection,,Selecting a Frame}). |
| 22764 | @end defun |
| 22765 | |
| 22766 | @findex gdb.newest_frame |
| 22767 | @defun newest_frame |
| 22768 | Return the newest frame object for the selected thread. |
| 22769 | @end defun |
| 22770 | |
| 22771 | @defun frame_stop_reason_string reason |
| 22772 | Return a string explaining the reason why @value{GDBN} stopped unwinding |
| 22773 | frames, as expressed by the given @var{reason} code (an integer, see the |
| 22774 | @code{unwind_stop_reason} method further down in this section). |
| 22775 | @end defun |
| 22776 | |
| 22777 | A @code{gdb.Frame} object has the following methods: |
| 22778 | |
| 22779 | @table @code |
| 22780 | @defmethod Frame is_valid |
| 22781 | Returns true if the @code{gdb.Frame} object is valid, false if not. |
| 22782 | A frame object can become invalid if the frame it refers to doesn't |
| 22783 | exist anymore in the inferior. All @code{gdb.Frame} methods will throw |
| 22784 | an exception if it is invalid at the time the method is called. |
| 22785 | @end defmethod |
| 22786 | |
| 22787 | @defmethod Frame name |
| 22788 | Returns the function name of the frame, or @code{None} if it can't be |
| 22789 | obtained. |
| 22790 | @end defmethod |
| 22791 | |
| 22792 | @defmethod Frame type |
| 22793 | Returns the type of the frame. The value can be one of: |
| 22794 | @table @code |
| 22795 | @item gdb.NORMAL_FRAME |
| 22796 | An ordinary stack frame. |
| 22797 | |
| 22798 | @item gdb.DUMMY_FRAME |
| 22799 | A fake stack frame that was created by @value{GDBN} when performing an |
| 22800 | inferior function call. |
| 22801 | |
| 22802 | @item gdb.INLINE_FRAME |
| 22803 | A frame representing an inlined function. The function was inlined |
| 22804 | into a @code{gdb.NORMAL_FRAME} that is older than this one. |
| 22805 | |
| 22806 | @item gdb.SIGTRAMP_FRAME |
| 22807 | A signal trampoline frame. This is the frame created by the OS when |
| 22808 | it calls into a signal handler. |
| 22809 | |
| 22810 | @item gdb.ARCH_FRAME |
| 22811 | A fake stack frame representing a cross-architecture call. |
| 22812 | |
| 22813 | @item gdb.SENTINEL_FRAME |
| 22814 | This is like @code{gdb.NORMAL_FRAME}, but it is only used for the |
| 22815 | newest frame. |
| 22816 | @end table |
| 22817 | @end defmethod |
| 22818 | |
| 22819 | @defmethod Frame unwind_stop_reason |
| 22820 | Return an integer representing the reason why it's not possible to find |
| 22821 | more frames toward the outermost frame. Use |
| 22822 | @code{gdb.frame_stop_reason_string} to convert the value returned by this |
| 22823 | function to a string. |
| 22824 | @end defmethod |
| 22825 | |
| 22826 | @defmethod Frame pc |
| 22827 | Returns the frame's resume address. |
| 22828 | @end defmethod |
| 22829 | |
| 22830 | @defmethod Frame block |
| 22831 | Return the frame's code block. @xref{Blocks In Python}. |
| 22832 | @end defmethod |
| 22833 | |
| 22834 | @defmethod Frame function |
| 22835 | Return the symbol for the function corresponding to this frame. |
| 22836 | @xref{Symbols In Python}. |
| 22837 | @end defmethod |
| 22838 | |
| 22839 | @defmethod Frame older |
| 22840 | Return the frame that called this frame. |
| 22841 | @end defmethod |
| 22842 | |
| 22843 | @defmethod Frame newer |
| 22844 | Return the frame called by this frame. |
| 22845 | @end defmethod |
| 22846 | |
| 22847 | @defmethod Frame find_sal |
| 22848 | Return the frame's symtab and line object. |
| 22849 | @xref{Symbol Tables In Python}. |
| 22850 | @end defmethod |
| 22851 | |
| 22852 | @defmethod Frame read_var variable @r{[}block@r{]} |
| 22853 | Return the value of @var{variable} in this frame. If the optional |
| 22854 | argument @var{block} is provided, search for the variable from that |
| 22855 | block; otherwise start at the frame's current block (which is |
| 22856 | determined by the frame's current program counter). @var{variable} |
| 22857 | must be a string or a @code{gdb.Symbol} object. @var{block} must be a |
| 22858 | @code{gdb.Block} object. |
| 22859 | @end defmethod |
| 22860 | |
| 22861 | @defmethod Frame select |
| 22862 | Set this frame to be the selected frame. @xref{Stack, ,Examining the |
| 22863 | Stack}. |
| 22864 | @end defmethod |
| 22865 | @end table |
| 22866 | |
| 22867 | @node Blocks In Python |
| 22868 | @subsubsection Accessing frame blocks from Python. |
| 22869 | |
| 22870 | @cindex blocks in python |
| 22871 | @tindex gdb.Block |
| 22872 | |
| 22873 | Within each frame, @value{GDBN} maintains information on each block |
| 22874 | stored in that frame. These blocks are organized hierarchically, and |
| 22875 | are represented individually in Python as a @code{gdb.Block}. |
| 22876 | Please see @ref{Frames In Python}, for a more in-depth discussion on |
| 22877 | frames. Furthermore, see @ref{Stack, ,Examining the Stack}, for more |
| 22878 | detailed technical information on @value{GDBN}'s book-keeping of the |
| 22879 | stack. |
| 22880 | |
| 22881 | The following block-related functions are available in the @code{gdb} |
| 22882 | module: |
| 22883 | |
| 22884 | @findex gdb.block_for_pc |
| 22885 | @defun block_for_pc pc |
| 22886 | Return the @code{gdb.Block} containing the given @var{pc} value. If the |
| 22887 | block cannot be found for the @var{pc} value specified, the function |
| 22888 | will return @code{None}. |
| 22889 | @end defun |
| 22890 | |
| 22891 | A @code{gdb.Block} object has the following methods: |
| 22892 | |
| 22893 | @table @code |
| 22894 | @defmethod Block is_valid |
| 22895 | Returns @code{True} if the @code{gdb.Block} object is valid, |
| 22896 | @code{False} if not. A block object can become invalid if the block it |
| 22897 | refers to doesn't exist anymore in the inferior. All other |
| 22898 | @code{gdb.Block} methods will throw an exception if it is invalid at |
| 22899 | the time the method is called. This method is also made available to |
| 22900 | the Python iterator object that @code{gdb.Block} provides in an iteration |
| 22901 | context and via the Python @code{iter} built-in function. |
| 22902 | @end defmethod |
| 22903 | @end table |
| 22904 | |
| 22905 | A @code{gdb.Block} object has the following attributes: |
| 22906 | |
| 22907 | @table @code |
| 22908 | @defivar Block start |
| 22909 | The start address of the block. This attribute is not writable. |
| 22910 | @end defivar |
| 22911 | |
| 22912 | @defivar Block end |
| 22913 | The end address of the block. This attribute is not writable. |
| 22914 | @end defivar |
| 22915 | |
| 22916 | @defivar Block function |
| 22917 | The name of the block represented as a @code{gdb.Symbol}. If the |
| 22918 | block is not named, then this attribute holds @code{None}. This |
| 22919 | attribute is not writable. |
| 22920 | @end defivar |
| 22921 | |
| 22922 | @defivar Block superblock |
| 22923 | The block containing this block. If this parent block does not exist, |
| 22924 | this attribute holds @code{None}. This attribute is not writable. |
| 22925 | @end defivar |
| 22926 | @end table |
| 22927 | |
| 22928 | @node Symbols In Python |
| 22929 | @subsubsection Python representation of Symbols. |
| 22930 | |
| 22931 | @cindex symbols in python |
| 22932 | @tindex gdb.Symbol |
| 22933 | |
| 22934 | @value{GDBN} represents every variable, function and type as an |
| 22935 | entry in a symbol table. @xref{Symbols, ,Examining the Symbol Table}. |
| 22936 | Similarly, Python represents these symbols in @value{GDBN} with the |
| 22937 | @code{gdb.Symbol} object. |
| 22938 | |
| 22939 | The following symbol-related functions are available in the @code{gdb} |
| 22940 | module: |
| 22941 | |
| 22942 | @findex gdb.lookup_symbol |
| 22943 | @defun lookup_symbol name @r{[}block@r{]} @r{[}domain@r{]} |
| 22944 | This function searches for a symbol by name. The search scope can be |
| 22945 | restricted to the parameters defined in the optional domain and block |
| 22946 | arguments. |
| 22947 | |
| 22948 | @var{name} is the name of the symbol. It must be a string. The |
| 22949 | optional @var{block} argument restricts the search to symbols visible |
| 22950 | in that @var{block}. The @var{block} argument must be a |
| 22951 | @code{gdb.Block} object. If omitted, the block for the current frame |
| 22952 | is used. The optional @var{domain} argument restricts |
| 22953 | the search to the domain type. The @var{domain} argument must be a |
| 22954 | domain constant defined in the @code{gdb} module and described later |
| 22955 | in this chapter. |
| 22956 | |
| 22957 | The result is a tuple of two elements. |
| 22958 | The first element is a @code{gdb.Symbol} object or @code{None} if the symbol |
| 22959 | is not found. |
| 22960 | If the symbol is found, the second element is @code{True} if the symbol |
| 22961 | is a field of a method's object (e.g., @code{this} in C@t{++}), |
| 22962 | otherwise it is @code{False}. |
| 22963 | If the symbol is not found, the second element is @code{False}. |
| 22964 | @end defun |
| 22965 | |
| 22966 | @findex gdb.lookup_global_symbol |
| 22967 | @defun lookup_global_symbol name @r{[}domain@r{]} |
| 22968 | This function searches for a global symbol by name. |
| 22969 | The search scope can be restricted to by the domain argument. |
| 22970 | |
| 22971 | @var{name} is the name of the symbol. It must be a string. |
| 22972 | The optional @var{domain} argument restricts the search to the domain type. |
| 22973 | The @var{domain} argument must be a domain constant defined in the @code{gdb} |
| 22974 | module and described later in this chapter. |
| 22975 | |
| 22976 | The result is a @code{gdb.Symbol} object or @code{None} if the symbol |
| 22977 | is not found. |
| 22978 | @end defun |
| 22979 | |
| 22980 | A @code{gdb.Symbol} object has the following attributes: |
| 22981 | |
| 22982 | @table @code |
| 22983 | @defivar Symbol symtab |
| 22984 | The symbol table in which the symbol appears. This attribute is |
| 22985 | represented as a @code{gdb.Symtab} object. @xref{Symbol Tables In |
| 22986 | Python}. This attribute is not writable. |
| 22987 | @end defivar |
| 22988 | |
| 22989 | @defivar Symbol name |
| 22990 | The name of the symbol as a string. This attribute is not writable. |
| 22991 | @end defivar |
| 22992 | |
| 22993 | @defivar Symbol linkage_name |
| 22994 | The name of the symbol, as used by the linker (i.e., may be mangled). |
| 22995 | This attribute is not writable. |
| 22996 | @end defivar |
| 22997 | |
| 22998 | @defivar Symbol print_name |
| 22999 | The name of the symbol in a form suitable for output. This is either |
| 23000 | @code{name} or @code{linkage_name}, depending on whether the user |
| 23001 | asked @value{GDBN} to display demangled or mangled names. |
| 23002 | @end defivar |
| 23003 | |
| 23004 | @defivar Symbol addr_class |
| 23005 | The address class of the symbol. This classifies how to find the value |
| 23006 | of a symbol. Each address class is a constant defined in the |
| 23007 | @code{gdb} module and described later in this chapter. |
| 23008 | @end defivar |
| 23009 | |
| 23010 | @defivar Symbol is_argument |
| 23011 | @code{True} if the symbol is an argument of a function. |
| 23012 | @end defivar |
| 23013 | |
| 23014 | @defivar Symbol is_constant |
| 23015 | @code{True} if the symbol is a constant. |
| 23016 | @end defivar |
| 23017 | |
| 23018 | @defivar Symbol is_function |
| 23019 | @code{True} if the symbol is a function or a method. |
| 23020 | @end defivar |
| 23021 | |
| 23022 | @defivar Symbol is_variable |
| 23023 | @code{True} if the symbol is a variable. |
| 23024 | @end defivar |
| 23025 | @end table |
| 23026 | |
| 23027 | A @code{gdb.Symbol} object has the following methods: |
| 23028 | |
| 23029 | @table @code |
| 23030 | @defmethod Symbol is_valid |
| 23031 | Returns @code{True} if the @code{gdb.Symbol} object is valid, |
| 23032 | @code{False} if not. A @code{gdb.Symbol} object can become invalid if |
| 23033 | the symbol it refers to does not exist in @value{GDBN} any longer. |
| 23034 | All other @code{gdb.Symbol} methods will throw an exception if it is |
| 23035 | invalid at the time the method is called. |
| 23036 | @end defmethod |
| 23037 | @end table |
| 23038 | |
| 23039 | The available domain categories in @code{gdb.Symbol} are represented |
| 23040 | as constants in the @code{gdb} module: |
| 23041 | |
| 23042 | @table @code |
| 23043 | @findex SYMBOL_UNDEF_DOMAIN |
| 23044 | @findex gdb.SYMBOL_UNDEF_DOMAIN |
| 23045 | @item SYMBOL_UNDEF_DOMAIN |
| 23046 | This is used when a domain has not been discovered or none of the |
| 23047 | following domains apply. This usually indicates an error either |
| 23048 | in the symbol information or in @value{GDBN}'s handling of symbols. |
| 23049 | @findex SYMBOL_VAR_DOMAIN |
| 23050 | @findex gdb.SYMBOL_VAR_DOMAIN |
| 23051 | @item SYMBOL_VAR_DOMAIN |
| 23052 | This domain contains variables, function names, typedef names and enum |
| 23053 | type values. |
| 23054 | @findex SYMBOL_STRUCT_DOMAIN |
| 23055 | @findex gdb.SYMBOL_STRUCT_DOMAIN |
| 23056 | @item SYMBOL_STRUCT_DOMAIN |
| 23057 | This domain holds struct, union and enum type names. |
| 23058 | @findex SYMBOL_LABEL_DOMAIN |
| 23059 | @findex gdb.SYMBOL_LABEL_DOMAIN |
| 23060 | @item SYMBOL_LABEL_DOMAIN |
| 23061 | This domain contains names of labels (for gotos). |
| 23062 | @findex SYMBOL_VARIABLES_DOMAIN |
| 23063 | @findex gdb.SYMBOL_VARIABLES_DOMAIN |
| 23064 | @item SYMBOL_VARIABLES_DOMAIN |
| 23065 | This domain holds a subset of the @code{SYMBOLS_VAR_DOMAIN}; it |
| 23066 | contains everything minus functions and types. |
| 23067 | @findex SYMBOL_FUNCTIONS_DOMAIN |
| 23068 | @findex gdb.SYMBOL_FUNCTIONS_DOMAIN |
| 23069 | @item SYMBOL_FUNCTION_DOMAIN |
| 23070 | This domain contains all functions. |
| 23071 | @findex SYMBOL_TYPES_DOMAIN |
| 23072 | @findex gdb.SYMBOL_TYPES_DOMAIN |
| 23073 | @item SYMBOL_TYPES_DOMAIN |
| 23074 | This domain contains all types. |
| 23075 | @end table |
| 23076 | |
| 23077 | The available address class categories in @code{gdb.Symbol} are represented |
| 23078 | as constants in the @code{gdb} module: |
| 23079 | |
| 23080 | @table @code |
| 23081 | @findex SYMBOL_LOC_UNDEF |
| 23082 | @findex gdb.SYMBOL_LOC_UNDEF |
| 23083 | @item SYMBOL_LOC_UNDEF |
| 23084 | If this is returned by address class, it indicates an error either in |
| 23085 | the symbol information or in @value{GDBN}'s handling of symbols. |
| 23086 | @findex SYMBOL_LOC_CONST |
| 23087 | @findex gdb.SYMBOL_LOC_CONST |
| 23088 | @item SYMBOL_LOC_CONST |
| 23089 | Value is constant int. |
| 23090 | @findex SYMBOL_LOC_STATIC |
| 23091 | @findex gdb.SYMBOL_LOC_STATIC |
| 23092 | @item SYMBOL_LOC_STATIC |
| 23093 | Value is at a fixed address. |
| 23094 | @findex SYMBOL_LOC_REGISTER |
| 23095 | @findex gdb.SYMBOL_LOC_REGISTER |
| 23096 | @item SYMBOL_LOC_REGISTER |
| 23097 | Value is in a register. |
| 23098 | @findex SYMBOL_LOC_ARG |
| 23099 | @findex gdb.SYMBOL_LOC_ARG |
| 23100 | @item SYMBOL_LOC_ARG |
| 23101 | Value is an argument. This value is at the offset stored within the |
| 23102 | symbol inside the frame's argument list. |
| 23103 | @findex SYMBOL_LOC_REF_ARG |
| 23104 | @findex gdb.SYMBOL_LOC_REF_ARG |
| 23105 | @item SYMBOL_LOC_REF_ARG |
| 23106 | Value address is stored in the frame's argument list. Just like |
| 23107 | @code{LOC_ARG} except that the value's address is stored at the |
| 23108 | offset, not the value itself. |
| 23109 | @findex SYMBOL_LOC_REGPARM_ADDR |
| 23110 | @findex gdb.SYMBOL_LOC_REGPARM_ADDR |
| 23111 | @item SYMBOL_LOC_REGPARM_ADDR |
| 23112 | Value is a specified register. Just like @code{LOC_REGISTER} except |
| 23113 | the register holds the address of the argument instead of the argument |
| 23114 | itself. |
| 23115 | @findex SYMBOL_LOC_LOCAL |
| 23116 | @findex gdb.SYMBOL_LOC_LOCAL |
| 23117 | @item SYMBOL_LOC_LOCAL |
| 23118 | Value is a local variable. |
| 23119 | @findex SYMBOL_LOC_TYPEDEF |
| 23120 | @findex gdb.SYMBOL_LOC_TYPEDEF |
| 23121 | @item SYMBOL_LOC_TYPEDEF |
| 23122 | Value not used. Symbols in the domain @code{SYMBOL_STRUCT_DOMAIN} all |
| 23123 | have this class. |
| 23124 | @findex SYMBOL_LOC_BLOCK |
| 23125 | @findex gdb.SYMBOL_LOC_BLOCK |
| 23126 | @item SYMBOL_LOC_BLOCK |
| 23127 | Value is a block. |
| 23128 | @findex SYMBOL_LOC_CONST_BYTES |
| 23129 | @findex gdb.SYMBOL_LOC_CONST_BYTES |
| 23130 | @item SYMBOL_LOC_CONST_BYTES |
| 23131 | Value is a byte-sequence. |
| 23132 | @findex SYMBOL_LOC_UNRESOLVED |
| 23133 | @findex gdb.SYMBOL_LOC_UNRESOLVED |
| 23134 | @item SYMBOL_LOC_UNRESOLVED |
| 23135 | Value is at a fixed address, but the address of the variable has to be |
| 23136 | determined from the minimal symbol table whenever the variable is |
| 23137 | referenced. |
| 23138 | @findex SYMBOL_LOC_OPTIMIZED_OUT |
| 23139 | @findex gdb.SYMBOL_LOC_OPTIMIZED_OUT |
| 23140 | @item SYMBOL_LOC_OPTIMIZED_OUT |
| 23141 | The value does not actually exist in the program. |
| 23142 | @findex SYMBOL_LOC_COMPUTED |
| 23143 | @findex gdb.SYMBOL_LOC_COMPUTED |
| 23144 | @item SYMBOL_LOC_COMPUTED |
| 23145 | The value's address is a computed location. |
| 23146 | @end table |
| 23147 | |
| 23148 | @node Symbol Tables In Python |
| 23149 | @subsubsection Symbol table representation in Python. |
| 23150 | |
| 23151 | @cindex symbol tables in python |
| 23152 | @tindex gdb.Symtab |
| 23153 | @tindex gdb.Symtab_and_line |
| 23154 | |
| 23155 | Access to symbol table data maintained by @value{GDBN} on the inferior |
| 23156 | is exposed to Python via two objects: @code{gdb.Symtab_and_line} and |
| 23157 | @code{gdb.Symtab}. Symbol table and line data for a frame is returned |
| 23158 | from the @code{find_sal} method in @code{gdb.Frame} object. |
| 23159 | @xref{Frames In Python}. |
| 23160 | |
| 23161 | For more information on @value{GDBN}'s symbol table management, see |
| 23162 | @ref{Symbols, ,Examining the Symbol Table}, for more information. |
| 23163 | |
| 23164 | A @code{gdb.Symtab_and_line} object has the following attributes: |
| 23165 | |
| 23166 | @table @code |
| 23167 | @defivar Symtab_and_line symtab |
| 23168 | The symbol table object (@code{gdb.Symtab}) for this frame. |
| 23169 | This attribute is not writable. |
| 23170 | @end defivar |
| 23171 | |
| 23172 | @defivar Symtab_and_line pc |
| 23173 | Indicates the current program counter address. This attribute is not |
| 23174 | writable. |
| 23175 | @end defivar |
| 23176 | |
| 23177 | @defivar Symtab_and_line line |
| 23178 | Indicates the current line number for this object. This |
| 23179 | attribute is not writable. |
| 23180 | @end defivar |
| 23181 | @end table |
| 23182 | |
| 23183 | A @code{gdb.Symtab_and_line} object has the following methods: |
| 23184 | |
| 23185 | @table @code |
| 23186 | @defmethod Symtab_and_line is_valid |
| 23187 | Returns @code{True} if the @code{gdb.Symtab_and_line} object is valid, |
| 23188 | @code{False} if not. A @code{gdb.Symtab_and_line} object can become |
| 23189 | invalid if the Symbol table and line object it refers to does not |
| 23190 | exist in @value{GDBN} any longer. All other |
| 23191 | @code{gdb.Symtab_and_line} methods will throw an exception if it is |
| 23192 | invalid at the time the method is called. |
| 23193 | @end defmethod |
| 23194 | @end table |
| 23195 | |
| 23196 | A @code{gdb.Symtab} object has the following attributes: |
| 23197 | |
| 23198 | @table @code |
| 23199 | @defivar Symtab filename |
| 23200 | The symbol table's source filename. This attribute is not writable. |
| 23201 | @end defivar |
| 23202 | |
| 23203 | @defivar Symtab objfile |
| 23204 | The symbol table's backing object file. @xref{Objfiles In Python}. |
| 23205 | This attribute is not writable. |
| 23206 | @end defivar |
| 23207 | @end table |
| 23208 | |
| 23209 | A @code{gdb.Symtab} object has the following methods: |
| 23210 | |
| 23211 | @table @code |
| 23212 | @defmethod Symtab is_valid |
| 23213 | Returns @code{True} if the @code{gdb.Symtab} object is valid, |
| 23214 | @code{False} if not. A @code{gdb.Symtab} object can become invalid if |
| 23215 | the symbol table it refers to does not exist in @value{GDBN} any |
| 23216 | longer. All other @code{gdb.Symtab} methods will throw an exception |
| 23217 | if it is invalid at the time the method is called. |
| 23218 | @end defmethod |
| 23219 | |
| 23220 | @defmethod Symtab fullname |
| 23221 | Return the symbol table's source absolute file name. |
| 23222 | @end defmethod |
| 23223 | @end table |
| 23224 | |
| 23225 | @node Breakpoints In Python |
| 23226 | @subsubsection Manipulating breakpoints using Python |
| 23227 | |
| 23228 | @cindex breakpoints in python |
| 23229 | @tindex gdb.Breakpoint |
| 23230 | |
| 23231 | Python code can manipulate breakpoints via the @code{gdb.Breakpoint} |
| 23232 | class. |
| 23233 | |
| 23234 | @defmethod Breakpoint __init__ spec @r{[}type@r{]} @r{[}wp_class@r{]} @r{[}internal@r{]} |
| 23235 | Create a new breakpoint. @var{spec} is a string naming the |
| 23236 | location of the breakpoint, or an expression that defines a |
| 23237 | watchpoint. The contents can be any location recognized by the |
| 23238 | @code{break} command, or in the case of a watchpoint, by the @code{watch} |
| 23239 | command. The optional @var{type} denotes the breakpoint to create |
| 23240 | from the types defined later in this chapter. This argument can be |
| 23241 | either: @code{BP_BREAKPOINT} or @code{BP_WATCHPOINT}. @var{type} |
| 23242 | defaults to @code{BP_BREAKPOINT}. The optional @var{internal} argument |
| 23243 | allows the breakpoint to become invisible to the user. The breakpoint |
| 23244 | will neither be reported when created, nor will it be listed in the |
| 23245 | output from @code{info breakpoints} (but will be listed with the |
| 23246 | @code{maint info breakpoints} command). The optional @var{wp_class} |
| 23247 | argument defines the class of watchpoint to create, if @var{type} is |
| 23248 | @code{BP_WATCHPOINT}. If a watchpoint class is not provided, it is |
| 23249 | assumed to be a @var{WP_WRITE} class. |
| 23250 | @end defmethod |
| 23251 | |
| 23252 | @defop Operation {gdb.Breakpoint} stop (self) |
| 23253 | The @code{gdb.Breakpoint} class can be sub-classed and, in |
| 23254 | particular, you may choose to implement the @code{stop} method. |
| 23255 | If this method is defined as a sub-class of @code{gdb.Breakpoint}, |
| 23256 | it will be called when the inferior reaches any location of a |
| 23257 | breakpoint which instantiates that sub-class. If the method returns |
| 23258 | @code{True}, the inferior will be stopped at the location of the |
| 23259 | breakpoint, otherwise the inferior will continue. |
| 23260 | |
| 23261 | If there are multiple breakpoints at the same location with a |
| 23262 | @code{stop} method, each one will be called regardless of the |
| 23263 | return status of the previous. This ensures that all @code{stop} |
| 23264 | methods have a chance to execute at that location. In this scenario |
| 23265 | if one of the methods returns @code{True} but the others return |
| 23266 | @code{False}, the inferior will still be stopped. |
| 23267 | |
| 23268 | Example @code{stop} implementation: |
| 23269 | |
| 23270 | @smallexample |
| 23271 | class MyBreakpoint (gdb.Breakpoint): |
| 23272 | def stop (self): |
| 23273 | inf_val = gdb.parse_and_eval("foo") |
| 23274 | if inf_val == 3: |
| 23275 | return True |
| 23276 | return False |
| 23277 | @end smallexample |
| 23278 | @end defop |
| 23279 | |
| 23280 | The available watchpoint types represented by constants are defined in the |
| 23281 | @code{gdb} module: |
| 23282 | |
| 23283 | @table @code |
| 23284 | @findex WP_READ |
| 23285 | @findex gdb.WP_READ |
| 23286 | @item WP_READ |
| 23287 | Read only watchpoint. |
| 23288 | |
| 23289 | @findex WP_WRITE |
| 23290 | @findex gdb.WP_WRITE |
| 23291 | @item WP_WRITE |
| 23292 | Write only watchpoint. |
| 23293 | |
| 23294 | @findex WP_ACCESS |
| 23295 | @findex gdb.WP_ACCESS |
| 23296 | @item WP_ACCESS |
| 23297 | Read/Write watchpoint. |
| 23298 | @end table |
| 23299 | |
| 23300 | @defmethod Breakpoint is_valid |
| 23301 | Return @code{True} if this @code{Breakpoint} object is valid, |
| 23302 | @code{False} otherwise. A @code{Breakpoint} object can become invalid |
| 23303 | if the user deletes the breakpoint. In this case, the object still |
| 23304 | exists, but the underlying breakpoint does not. In the cases of |
| 23305 | watchpoint scope, the watchpoint remains valid even if execution of the |
| 23306 | inferior leaves the scope of that watchpoint. |
| 23307 | @end defmethod |
| 23308 | |
| 23309 | @defmethod Breakpoint delete |
| 23310 | Permanently deletes the @value{GDBN} breakpoint. This also |
| 23311 | invalidates the Python @code{Breakpoint} object. Any further access |
| 23312 | to this object's attributes or methods will raise an error. |
| 23313 | @end defmethod |
| 23314 | |
| 23315 | @defivar Breakpoint enabled |
| 23316 | This attribute is @code{True} if the breakpoint is enabled, and |
| 23317 | @code{False} otherwise. This attribute is writable. |
| 23318 | @end defivar |
| 23319 | |
| 23320 | @defivar Breakpoint silent |
| 23321 | This attribute is @code{True} if the breakpoint is silent, and |
| 23322 | @code{False} otherwise. This attribute is writable. |
| 23323 | |
| 23324 | Note that a breakpoint can also be silent if it has commands and the |
| 23325 | first command is @code{silent}. This is not reported by the |
| 23326 | @code{silent} attribute. |
| 23327 | @end defivar |
| 23328 | |
| 23329 | @defivar Breakpoint thread |
| 23330 | If the breakpoint is thread-specific, this attribute holds the thread |
| 23331 | id. If the breakpoint is not thread-specific, this attribute is |
| 23332 | @code{None}. This attribute is writable. |
| 23333 | @end defivar |
| 23334 | |
| 23335 | @defivar Breakpoint task |
| 23336 | If the breakpoint is Ada task-specific, this attribute holds the Ada task |
| 23337 | id. If the breakpoint is not task-specific (or the underlying |
| 23338 | language is not Ada), this attribute is @code{None}. This attribute |
| 23339 | is writable. |
| 23340 | @end defivar |
| 23341 | |
| 23342 | @defivar Breakpoint ignore_count |
| 23343 | This attribute holds the ignore count for the breakpoint, an integer. |
| 23344 | This attribute is writable. |
| 23345 | @end defivar |
| 23346 | |
| 23347 | @defivar Breakpoint number |
| 23348 | This attribute holds the breakpoint's number --- the identifier used by |
| 23349 | the user to manipulate the breakpoint. This attribute is not writable. |
| 23350 | @end defivar |
| 23351 | |
| 23352 | @defivar Breakpoint type |
| 23353 | This attribute holds the breakpoint's type --- the identifier used to |
| 23354 | determine the actual breakpoint type or use-case. This attribute is not |
| 23355 | writable. |
| 23356 | @end defivar |
| 23357 | |
| 23358 | @defivar Breakpoint visible |
| 23359 | This attribute tells whether the breakpoint is visible to the user |
| 23360 | when set, or when the @samp{info breakpoints} command is run. This |
| 23361 | attribute is not writable. |
| 23362 | @end defivar |
| 23363 | |
| 23364 | The available types are represented by constants defined in the @code{gdb} |
| 23365 | module: |
| 23366 | |
| 23367 | @table @code |
| 23368 | @findex BP_BREAKPOINT |
| 23369 | @findex gdb.BP_BREAKPOINT |
| 23370 | @item BP_BREAKPOINT |
| 23371 | Normal code breakpoint. |
| 23372 | |
| 23373 | @findex BP_WATCHPOINT |
| 23374 | @findex gdb.BP_WATCHPOINT |
| 23375 | @item BP_WATCHPOINT |
| 23376 | Watchpoint breakpoint. |
| 23377 | |
| 23378 | @findex BP_HARDWARE_WATCHPOINT |
| 23379 | @findex gdb.BP_HARDWARE_WATCHPOINT |
| 23380 | @item BP_HARDWARE_WATCHPOINT |
| 23381 | Hardware assisted watchpoint. |
| 23382 | |
| 23383 | @findex BP_READ_WATCHPOINT |
| 23384 | @findex gdb.BP_READ_WATCHPOINT |
| 23385 | @item BP_READ_WATCHPOINT |
| 23386 | Hardware assisted read watchpoint. |
| 23387 | |
| 23388 | @findex BP_ACCESS_WATCHPOINT |
| 23389 | @findex gdb.BP_ACCESS_WATCHPOINT |
| 23390 | @item BP_ACCESS_WATCHPOINT |
| 23391 | Hardware assisted access watchpoint. |
| 23392 | @end table |
| 23393 | |
| 23394 | @defivar Breakpoint hit_count |
| 23395 | This attribute holds the hit count for the breakpoint, an integer. |
| 23396 | This attribute is writable, but currently it can only be set to zero. |
| 23397 | @end defivar |
| 23398 | |
| 23399 | @defivar Breakpoint location |
| 23400 | This attribute holds the location of the breakpoint, as specified by |
| 23401 | the user. It is a string. If the breakpoint does not have a location |
| 23402 | (that is, it is a watchpoint) the attribute's value is @code{None}. This |
| 23403 | attribute is not writable. |
| 23404 | @end defivar |
| 23405 | |
| 23406 | @defivar Breakpoint expression |
| 23407 | This attribute holds a breakpoint expression, as specified by |
| 23408 | the user. It is a string. If the breakpoint does not have an |
| 23409 | expression (the breakpoint is not a watchpoint) the attribute's value |
| 23410 | is @code{None}. This attribute is not writable. |
| 23411 | @end defivar |
| 23412 | |
| 23413 | @defivar Breakpoint condition |
| 23414 | This attribute holds the condition of the breakpoint, as specified by |
| 23415 | the user. It is a string. If there is no condition, this attribute's |
| 23416 | value is @code{None}. This attribute is writable. |
| 23417 | @end defivar |
| 23418 | |
| 23419 | @defivar Breakpoint commands |
| 23420 | This attribute holds the commands attached to the breakpoint. If |
| 23421 | there are commands, this attribute's value is a string holding all the |
| 23422 | commands, separated by newlines. If there are no commands, this |
| 23423 | attribute is @code{None}. This attribute is not writable. |
| 23424 | @end defivar |
| 23425 | |
| 23426 | @node Lazy Strings In Python |
| 23427 | @subsubsection Python representation of lazy strings. |
| 23428 | |
| 23429 | @cindex lazy strings in python |
| 23430 | @tindex gdb.LazyString |
| 23431 | |
| 23432 | A @dfn{lazy string} is a string whose contents is not retrieved or |
| 23433 | encoded until it is needed. |
| 23434 | |
| 23435 | A @code{gdb.LazyString} is represented in @value{GDBN} as an |
| 23436 | @code{address} that points to a region of memory, an @code{encoding} |
| 23437 | that will be used to encode that region of memory, and a @code{length} |
| 23438 | to delimit the region of memory that represents the string. The |
| 23439 | difference between a @code{gdb.LazyString} and a string wrapped within |
| 23440 | a @code{gdb.Value} is that a @code{gdb.LazyString} will be treated |
| 23441 | differently by @value{GDBN} when printing. A @code{gdb.LazyString} is |
| 23442 | retrieved and encoded during printing, while a @code{gdb.Value} |
| 23443 | wrapping a string is immediately retrieved and encoded on creation. |
| 23444 | |
| 23445 | A @code{gdb.LazyString} object has the following functions: |
| 23446 | |
| 23447 | @defmethod LazyString value |
| 23448 | Convert the @code{gdb.LazyString} to a @code{gdb.Value}. This value |
| 23449 | will point to the string in memory, but will lose all the delayed |
| 23450 | retrieval, encoding and handling that @value{GDBN} applies to a |
| 23451 | @code{gdb.LazyString}. |
| 23452 | @end defmethod |
| 23453 | |
| 23454 | @defivar LazyString address |
| 23455 | This attribute holds the address of the string. This attribute is not |
| 23456 | writable. |
| 23457 | @end defivar |
| 23458 | |
| 23459 | @defivar LazyString length |
| 23460 | This attribute holds the length of the string in characters. If the |
| 23461 | length is -1, then the string will be fetched and encoded up to the |
| 23462 | first null of appropriate width. This attribute is not writable. |
| 23463 | @end defivar |
| 23464 | |
| 23465 | @defivar LazyString encoding |
| 23466 | This attribute holds the encoding that will be applied to the string |
| 23467 | when the string is printed by @value{GDBN}. If the encoding is not |
| 23468 | set, or contains an empty string, then @value{GDBN} will select the |
| 23469 | most appropriate encoding when the string is printed. This attribute |
| 23470 | is not writable. |
| 23471 | @end defivar |
| 23472 | |
| 23473 | @defivar LazyString type |
| 23474 | This attribute holds the type that is represented by the lazy string's |
| 23475 | type. For a lazy string this will always be a pointer type. To |
| 23476 | resolve this to the lazy string's character type, use the type's |
| 23477 | @code{target} method. @xref{Types In Python}. This attribute is not |
| 23478 | writable. |
| 23479 | @end defivar |
| 23480 | |
| 23481 | @node Auto-loading |
| 23482 | @subsection Auto-loading |
| 23483 | @cindex auto-loading, Python |
| 23484 | |
| 23485 | When a new object file is read (for example, due to the @code{file} |
| 23486 | command, or because the inferior has loaded a shared library), |
| 23487 | @value{GDBN} will look for Python support scripts in several ways: |
| 23488 | @file{@var{objfile}-gdb.py} and @code{.debug_gdb_scripts} section. |
| 23489 | |
| 23490 | @menu |
| 23491 | * objfile-gdb.py file:: The @file{@var{objfile}-gdb.py} file |
| 23492 | * .debug_gdb_scripts section:: The @code{.debug_gdb_scripts} section |
| 23493 | * Which flavor to choose?:: |
| 23494 | @end menu |
| 23495 | |
| 23496 | The auto-loading feature is useful for supplying application-specific |
| 23497 | debugging commands and scripts. |
| 23498 | |
| 23499 | Auto-loading can be enabled or disabled. |
| 23500 | |
| 23501 | @table @code |
| 23502 | @kindex set auto-load-scripts |
| 23503 | @item set auto-load-scripts [yes|no] |
| 23504 | Enable or disable the auto-loading of Python scripts. |
| 23505 | |
| 23506 | @kindex show auto-load-scripts |
| 23507 | @item show auto-load-scripts |
| 23508 | Show whether auto-loading of Python scripts is enabled or disabled. |
| 23509 | @end table |
| 23510 | |
| 23511 | When reading an auto-loaded file, @value{GDBN} sets the |
| 23512 | @dfn{current objfile}. This is available via the @code{gdb.current_objfile} |
| 23513 | function (@pxref{Objfiles In Python}). This can be useful for |
| 23514 | registering objfile-specific pretty-printers. |
| 23515 | |
| 23516 | @node objfile-gdb.py file |
| 23517 | @subsubsection The @file{@var{objfile}-gdb.py} file |
| 23518 | @cindex @file{@var{objfile}-gdb.py} |
| 23519 | |
| 23520 | When a new object file is read, @value{GDBN} looks for |
| 23521 | a file named @file{@var{objfile}-gdb.py}, |
| 23522 | where @var{objfile} is the object file's real name, formed by ensuring |
| 23523 | that the file name is absolute, following all symlinks, and resolving |
| 23524 | @code{.} and @code{..} components. If this file exists and is |
| 23525 | readable, @value{GDBN} will evaluate it as a Python script. |
| 23526 | |
| 23527 | If this file does not exist, and if the parameter |
| 23528 | @code{debug-file-directory} is set (@pxref{Separate Debug Files}), |
| 23529 | then @value{GDBN} will look for @var{real-name} in all of the |
| 23530 | directories mentioned in the value of @code{debug-file-directory}. |
| 23531 | |
| 23532 | Finally, if this file does not exist, then @value{GDBN} will look for |
| 23533 | a file named @file{@var{data-directory}/python/auto-load/@var{real-name}}, where |
| 23534 | @var{data-directory} is @value{GDBN}'s data directory (available via |
| 23535 | @code{show data-directory}, @pxref{Data Files}), and @var{real-name} |
| 23536 | is the object file's real name, as described above. |
| 23537 | |
| 23538 | @value{GDBN} does not track which files it has already auto-loaded this way. |
| 23539 | @value{GDBN} will load the associated script every time the corresponding |
| 23540 | @var{objfile} is opened. |
| 23541 | So your @file{-gdb.py} file should be careful to avoid errors if it |
| 23542 | is evaluated more than once. |
| 23543 | |
| 23544 | @node .debug_gdb_scripts section |
| 23545 | @subsubsection The @code{.debug_gdb_scripts} section |
| 23546 | @cindex @code{.debug_gdb_scripts} section |
| 23547 | |
| 23548 | For systems using file formats like ELF and COFF, |
| 23549 | when @value{GDBN} loads a new object file |
| 23550 | it will look for a special section named @samp{.debug_gdb_scripts}. |
| 23551 | If this section exists, its contents is a list of names of scripts to load. |
| 23552 | |
| 23553 | @value{GDBN} will look for each specified script file first in the |
| 23554 | current directory and then along the source search path |
| 23555 | (@pxref{Source Path, ,Specifying Source Directories}), |
| 23556 | except that @file{$cdir} is not searched, since the compilation |
| 23557 | directory is not relevant to scripts. |
| 23558 | |
| 23559 | Entries can be placed in section @code{.debug_gdb_scripts} with, |
| 23560 | for example, this GCC macro: |
| 23561 | |
| 23562 | @example |
| 23563 | /* Note: The "MS" section flags are to remove duplicates. */ |
| 23564 | #define DEFINE_GDB_SCRIPT(script_name) \ |
| 23565 | asm("\ |
| 23566 | .pushsection \".debug_gdb_scripts\", \"MS\",@@progbits,1\n\ |
| 23567 | .byte 1\n\ |
| 23568 | .asciz \"" script_name "\"\n\ |
| 23569 | .popsection \n\ |
| 23570 | "); |
| 23571 | @end example |
| 23572 | |
| 23573 | @noindent |
| 23574 | Then one can reference the macro in a header or source file like this: |
| 23575 | |
| 23576 | @example |
| 23577 | DEFINE_GDB_SCRIPT ("my-app-scripts.py") |
| 23578 | @end example |
| 23579 | |
| 23580 | The script name may include directories if desired. |
| 23581 | |
| 23582 | If the macro is put in a header, any application or library |
| 23583 | using this header will get a reference to the specified script. |
| 23584 | |
| 23585 | @node Which flavor to choose? |
| 23586 | @subsubsection Which flavor to choose? |
| 23587 | |
| 23588 | Given the multiple ways of auto-loading Python scripts, it might not always |
| 23589 | be clear which one to choose. This section provides some guidance. |
| 23590 | |
| 23591 | Benefits of the @file{-gdb.py} way: |
| 23592 | |
| 23593 | @itemize @bullet |
| 23594 | @item |
| 23595 | Can be used with file formats that don't support multiple sections. |
| 23596 | |
| 23597 | @item |
| 23598 | Ease of finding scripts for public libraries. |
| 23599 | |
| 23600 | Scripts specified in the @code{.debug_gdb_scripts} section are searched for |
| 23601 | in the source search path. |
| 23602 | For publicly installed libraries, e.g., @file{libstdc++}, there typically |
| 23603 | isn't a source directory in which to find the script. |
| 23604 | |
| 23605 | @item |
| 23606 | Doesn't require source code additions. |
| 23607 | @end itemize |
| 23608 | |
| 23609 | Benefits of the @code{.debug_gdb_scripts} way: |
| 23610 | |
| 23611 | @itemize @bullet |
| 23612 | @item |
| 23613 | Works with static linking. |
| 23614 | |
| 23615 | Scripts for libraries done the @file{-gdb.py} way require an objfile to |
| 23616 | trigger their loading. When an application is statically linked the only |
| 23617 | objfile available is the executable, and it is cumbersome to attach all the |
| 23618 | scripts from all the input libraries to the executable's @file{-gdb.py} script. |
| 23619 | |
| 23620 | @item |
| 23621 | Works with classes that are entirely inlined. |
| 23622 | |
| 23623 | Some classes can be entirely inlined, and thus there may not be an associated |
| 23624 | shared library to attach a @file{-gdb.py} script to. |
| 23625 | |
| 23626 | @item |
| 23627 | Scripts needn't be copied out of the source tree. |
| 23628 | |
| 23629 | In some circumstances, apps can be built out of large collections of internal |
| 23630 | libraries, and the build infrastructure necessary to install the |
| 23631 | @file{-gdb.py} scripts in a place where @value{GDBN} can find them is |
| 23632 | cumbersome. It may be easier to specify the scripts in the |
| 23633 | @code{.debug_gdb_scripts} section as relative paths, and add a path to the |
| 23634 | top of the source tree to the source search path. |
| 23635 | @end itemize |
| 23636 | |
| 23637 | @node Python modules |
| 23638 | @subsection Python modules |
| 23639 | @cindex python modules |
| 23640 | |
| 23641 | @value{GDBN} comes with a module to assist writing Python code. |
| 23642 | |
| 23643 | @menu |
| 23644 | * gdb.printing:: Building and registering pretty-printers. |
| 23645 | * gdb.types:: Utilities for working with types. |
| 23646 | @end menu |
| 23647 | |
| 23648 | @node gdb.printing |
| 23649 | @subsubsection gdb.printing |
| 23650 | @cindex gdb.printing |
| 23651 | |
| 23652 | This module provides a collection of utilities for working with |
| 23653 | pretty-printers. |
| 23654 | |
| 23655 | @table @code |
| 23656 | @item PrettyPrinter (@var{name}, @var{subprinters}=None) |
| 23657 | This class specifies the API that makes @samp{info pretty-printer}, |
| 23658 | @samp{enable pretty-printer} and @samp{disable pretty-printer} work. |
| 23659 | Pretty-printers should generally inherit from this class. |
| 23660 | |
| 23661 | @item SubPrettyPrinter (@var{name}) |
| 23662 | For printers that handle multiple types, this class specifies the |
| 23663 | corresponding API for the subprinters. |
| 23664 | |
| 23665 | @item RegexpCollectionPrettyPrinter (@var{name}) |
| 23666 | Utility class for handling multiple printers, all recognized via |
| 23667 | regular expressions. |
| 23668 | @xref{Writing a Pretty-Printer}, for an example. |
| 23669 | |
| 23670 | @item register_pretty_printer (@var{obj}, @var{printer}) |
| 23671 | Register @var{printer} with the pretty-printer list of @var{obj}. |
| 23672 | @end table |
| 23673 | |
| 23674 | @node gdb.types |
| 23675 | @subsubsection gdb.types |
| 23676 | @cindex gdb.types |
| 23677 | |
| 23678 | This module provides a collection of utilities for working with |
| 23679 | @code{gdb.Types} objects. |
| 23680 | |
| 23681 | @table @code |
| 23682 | @item get_basic_type (@var{type}) |
| 23683 | Return @var{type} with const and volatile qualifiers stripped, |
| 23684 | and with typedefs and C@t{++} references converted to the underlying type. |
| 23685 | |
| 23686 | C@t{++} example: |
| 23687 | |
| 23688 | @smallexample |
| 23689 | typedef const int const_int; |
| 23690 | const_int foo (3); |
| 23691 | const_int& foo_ref (foo); |
| 23692 | int main () @{ return 0; @} |
| 23693 | @end smallexample |
| 23694 | |
| 23695 | Then in gdb: |
| 23696 | |
| 23697 | @smallexample |
| 23698 | (gdb) start |
| 23699 | (gdb) python import gdb.types |
| 23700 | (gdb) python foo_ref = gdb.parse_and_eval("foo_ref") |
| 23701 | (gdb) python print gdb.types.get_basic_type(foo_ref.type) |
| 23702 | int |
| 23703 | @end smallexample |
| 23704 | |
| 23705 | @item has_field (@var{type}, @var{field}) |
| 23706 | Return @code{True} if @var{type}, assumed to be a type with fields |
| 23707 | (e.g., a structure or union), has field @var{field}. |
| 23708 | |
| 23709 | @item make_enum_dict (@var{enum_type}) |
| 23710 | Return a Python @code{dictionary} type produced from @var{enum_type}. |
| 23711 | @end table |
| 23712 | |
| 23713 | @node Interpreters |
| 23714 | @chapter Command Interpreters |
| 23715 | @cindex command interpreters |
| 23716 | |
| 23717 | @value{GDBN} supports multiple command interpreters, and some command |
| 23718 | infrastructure to allow users or user interface writers to switch |
| 23719 | between interpreters or run commands in other interpreters. |
| 23720 | |
| 23721 | @value{GDBN} currently supports two command interpreters, the console |
| 23722 | interpreter (sometimes called the command-line interpreter or @sc{cli}) |
| 23723 | and the machine interface interpreter (or @sc{gdb/mi}). This manual |
| 23724 | describes both of these interfaces in great detail. |
| 23725 | |
| 23726 | By default, @value{GDBN} will start with the console interpreter. |
| 23727 | However, the user may choose to start @value{GDBN} with another |
| 23728 | interpreter by specifying the @option{-i} or @option{--interpreter} |
| 23729 | startup options. Defined interpreters include: |
| 23730 | |
| 23731 | @table @code |
| 23732 | @item console |
| 23733 | @cindex console interpreter |
| 23734 | The traditional console or command-line interpreter. This is the most often |
| 23735 | used interpreter with @value{GDBN}. With no interpreter specified at runtime, |
| 23736 | @value{GDBN} will use this interpreter. |
| 23737 | |
| 23738 | @item mi |
| 23739 | @cindex mi interpreter |
| 23740 | The newest @sc{gdb/mi} interface (currently @code{mi2}). Used primarily |
| 23741 | by programs wishing to use @value{GDBN} as a backend for a debugger GUI |
| 23742 | or an IDE. For more information, see @ref{GDB/MI, ,The @sc{gdb/mi} |
| 23743 | Interface}. |
| 23744 | |
| 23745 | @item mi2 |
| 23746 | @cindex mi2 interpreter |
| 23747 | The current @sc{gdb/mi} interface. |
| 23748 | |
| 23749 | @item mi1 |
| 23750 | @cindex mi1 interpreter |
| 23751 | The @sc{gdb/mi} interface included in @value{GDBN} 5.1, 5.2, and 5.3. |
| 23752 | |
| 23753 | @end table |
| 23754 | |
| 23755 | @cindex invoke another interpreter |
| 23756 | The interpreter being used by @value{GDBN} may not be dynamically |
| 23757 | switched at runtime. Although possible, this could lead to a very |
| 23758 | precarious situation. Consider an IDE using @sc{gdb/mi}. If a user |
| 23759 | enters the command "interpreter-set console" in a console view, |
| 23760 | @value{GDBN} would switch to using the console interpreter, rendering |
| 23761 | the IDE inoperable! |
| 23762 | |
| 23763 | @kindex interpreter-exec |
| 23764 | Although you may only choose a single interpreter at startup, you may execute |
| 23765 | commands in any interpreter from the current interpreter using the appropriate |
| 23766 | command. If you are running the console interpreter, simply use the |
| 23767 | @code{interpreter-exec} command: |
| 23768 | |
| 23769 | @smallexample |
| 23770 | interpreter-exec mi "-data-list-register-names" |
| 23771 | @end smallexample |
| 23772 | |
| 23773 | @sc{gdb/mi} has a similar command, although it is only available in versions of |
| 23774 | @value{GDBN} which support @sc{gdb/mi} version 2 (or greater). |
| 23775 | |
| 23776 | @node TUI |
| 23777 | @chapter @value{GDBN} Text User Interface |
| 23778 | @cindex TUI |
| 23779 | @cindex Text User Interface |
| 23780 | |
| 23781 | @menu |
| 23782 | * TUI Overview:: TUI overview |
| 23783 | * TUI Keys:: TUI key bindings |
| 23784 | * TUI Single Key Mode:: TUI single key mode |
| 23785 | * TUI Commands:: TUI-specific commands |
| 23786 | * TUI Configuration:: TUI configuration variables |
| 23787 | @end menu |
| 23788 | |
| 23789 | The @value{GDBN} Text User Interface (TUI) is a terminal |
| 23790 | interface which uses the @code{curses} library to show the source |
| 23791 | file, the assembly output, the program registers and @value{GDBN} |
| 23792 | commands in separate text windows. The TUI mode is supported only |
| 23793 | on platforms where a suitable version of the @code{curses} library |
| 23794 | is available. |
| 23795 | |
| 23796 | @pindex @value{GDBTUI} |
| 23797 | The TUI mode is enabled by default when you invoke @value{GDBN} as |
| 23798 | either @samp{@value{GDBTUI}} or @samp{@value{GDBP} -tui}. |
| 23799 | You can also switch in and out of TUI mode while @value{GDBN} runs by |
| 23800 | using various TUI commands and key bindings, such as @kbd{C-x C-a}. |
| 23801 | @xref{TUI Keys, ,TUI Key Bindings}. |
| 23802 | |
| 23803 | @node TUI Overview |
| 23804 | @section TUI Overview |
| 23805 | |
| 23806 | In TUI mode, @value{GDBN} can display several text windows: |
| 23807 | |
| 23808 | @table @emph |
| 23809 | @item command |
| 23810 | This window is the @value{GDBN} command window with the @value{GDBN} |
| 23811 | prompt and the @value{GDBN} output. The @value{GDBN} input is still |
| 23812 | managed using readline. |
| 23813 | |
| 23814 | @item source |
| 23815 | The source window shows the source file of the program. The current |
| 23816 | line and active breakpoints are displayed in this window. |
| 23817 | |
| 23818 | @item assembly |
| 23819 | The assembly window shows the disassembly output of the program. |
| 23820 | |
| 23821 | @item register |
| 23822 | This window shows the processor registers. Registers are highlighted |
| 23823 | when their values change. |
| 23824 | @end table |
| 23825 | |
| 23826 | The source and assembly windows show the current program position |
| 23827 | by highlighting the current line and marking it with a @samp{>} marker. |
| 23828 | Breakpoints are indicated with two markers. The first marker |
| 23829 | indicates the breakpoint type: |
| 23830 | |
| 23831 | @table @code |
| 23832 | @item B |
| 23833 | Breakpoint which was hit at least once. |
| 23834 | |
| 23835 | @item b |
| 23836 | Breakpoint which was never hit. |
| 23837 | |
| 23838 | @item H |
| 23839 | Hardware breakpoint which was hit at least once. |
| 23840 | |
| 23841 | @item h |
| 23842 | Hardware breakpoint which was never hit. |
| 23843 | @end table |
| 23844 | |
| 23845 | The second marker indicates whether the breakpoint is enabled or not: |
| 23846 | |
| 23847 | @table @code |
| 23848 | @item + |
| 23849 | Breakpoint is enabled. |
| 23850 | |
| 23851 | @item - |
| 23852 | Breakpoint is disabled. |
| 23853 | @end table |
| 23854 | |
| 23855 | The source, assembly and register windows are updated when the current |
| 23856 | thread changes, when the frame changes, or when the program counter |
| 23857 | changes. |
| 23858 | |
| 23859 | These windows are not all visible at the same time. The command |
| 23860 | window is always visible. The others can be arranged in several |
| 23861 | layouts: |
| 23862 | |
| 23863 | @itemize @bullet |
| 23864 | @item |
| 23865 | source only, |
| 23866 | |
| 23867 | @item |
| 23868 | assembly only, |
| 23869 | |
| 23870 | @item |
| 23871 | source and assembly, |
| 23872 | |
| 23873 | @item |
| 23874 | source and registers, or |
| 23875 | |
| 23876 | @item |
| 23877 | assembly and registers. |
| 23878 | @end itemize |
| 23879 | |
| 23880 | A status line above the command window shows the following information: |
| 23881 | |
| 23882 | @table @emph |
| 23883 | @item target |
| 23884 | Indicates the current @value{GDBN} target. |
| 23885 | (@pxref{Targets, ,Specifying a Debugging Target}). |
| 23886 | |
| 23887 | @item process |
| 23888 | Gives the current process or thread number. |
| 23889 | When no process is being debugged, this field is set to @code{No process}. |
| 23890 | |
| 23891 | @item function |
| 23892 | Gives the current function name for the selected frame. |
| 23893 | The name is demangled if demangling is turned on (@pxref{Print Settings}). |
| 23894 | When there is no symbol corresponding to the current program counter, |
| 23895 | the string @code{??} is displayed. |
| 23896 | |
| 23897 | @item line |
| 23898 | Indicates the current line number for the selected frame. |
| 23899 | When the current line number is not known, the string @code{??} is displayed. |
| 23900 | |
| 23901 | @item pc |
| 23902 | Indicates the current program counter address. |
| 23903 | @end table |
| 23904 | |
| 23905 | @node TUI Keys |
| 23906 | @section TUI Key Bindings |
| 23907 | @cindex TUI key bindings |
| 23908 | |
| 23909 | The TUI installs several key bindings in the readline keymaps |
| 23910 | @ifset SYSTEM_READLINE |
| 23911 | (@pxref{Command Line Editing, , , rluserman, GNU Readline Library}). |
| 23912 | @end ifset |
| 23913 | @ifclear SYSTEM_READLINE |
| 23914 | (@pxref{Command Line Editing}). |
| 23915 | @end ifclear |
| 23916 | The following key bindings are installed for both TUI mode and the |
| 23917 | @value{GDBN} standard mode. |
| 23918 | |
| 23919 | @table @kbd |
| 23920 | @kindex C-x C-a |
| 23921 | @item C-x C-a |
| 23922 | @kindex C-x a |
| 23923 | @itemx C-x a |
| 23924 | @kindex C-x A |
| 23925 | @itemx C-x A |
| 23926 | Enter or leave the TUI mode. When leaving the TUI mode, |
| 23927 | the curses window management stops and @value{GDBN} operates using |
| 23928 | its standard mode, writing on the terminal directly. When reentering |
| 23929 | the TUI mode, control is given back to the curses windows. |
| 23930 | The screen is then refreshed. |
| 23931 | |
| 23932 | @kindex C-x 1 |
| 23933 | @item C-x 1 |
| 23934 | Use a TUI layout with only one window. The layout will |
| 23935 | either be @samp{source} or @samp{assembly}. When the TUI mode |
| 23936 | is not active, it will switch to the TUI mode. |
| 23937 | |
| 23938 | Think of this key binding as the Emacs @kbd{C-x 1} binding. |
| 23939 | |
| 23940 | @kindex C-x 2 |
| 23941 | @item C-x 2 |
| 23942 | Use a TUI layout with at least two windows. When the current |
| 23943 | layout already has two windows, the next layout with two windows is used. |
| 23944 | When a new layout is chosen, one window will always be common to the |
| 23945 | previous layout and the new one. |
| 23946 | |
| 23947 | Think of it as the Emacs @kbd{C-x 2} binding. |
| 23948 | |
| 23949 | @kindex C-x o |
| 23950 | @item C-x o |
| 23951 | Change the active window. The TUI associates several key bindings |
| 23952 | (like scrolling and arrow keys) with the active window. This command |
| 23953 | gives the focus to the next TUI window. |
| 23954 | |
| 23955 | Think of it as the Emacs @kbd{C-x o} binding. |
| 23956 | |
| 23957 | @kindex C-x s |
| 23958 | @item C-x s |
| 23959 | Switch in and out of the TUI SingleKey mode that binds single |
| 23960 | keys to @value{GDBN} commands (@pxref{TUI Single Key Mode}). |
| 23961 | @end table |
| 23962 | |
| 23963 | The following key bindings only work in the TUI mode: |
| 23964 | |
| 23965 | @table @asis |
| 23966 | @kindex PgUp |
| 23967 | @item @key{PgUp} |
| 23968 | Scroll the active window one page up. |
| 23969 | |
| 23970 | @kindex PgDn |
| 23971 | @item @key{PgDn} |
| 23972 | Scroll the active window one page down. |
| 23973 | |
| 23974 | @kindex Up |
| 23975 | @item @key{Up} |
| 23976 | Scroll the active window one line up. |
| 23977 | |
| 23978 | @kindex Down |
| 23979 | @item @key{Down} |
| 23980 | Scroll the active window one line down. |
| 23981 | |
| 23982 | @kindex Left |
| 23983 | @item @key{Left} |
| 23984 | Scroll the active window one column left. |
| 23985 | |
| 23986 | @kindex Right |
| 23987 | @item @key{Right} |
| 23988 | Scroll the active window one column right. |
| 23989 | |
| 23990 | @kindex C-L |
| 23991 | @item @kbd{C-L} |
| 23992 | Refresh the screen. |
| 23993 | @end table |
| 23994 | |
| 23995 | Because the arrow keys scroll the active window in the TUI mode, they |
| 23996 | are not available for their normal use by readline unless the command |
| 23997 | window has the focus. When another window is active, you must use |
| 23998 | other readline key bindings such as @kbd{C-p}, @kbd{C-n}, @kbd{C-b} |
| 23999 | and @kbd{C-f} to control the command window. |
| 24000 | |
| 24001 | @node TUI Single Key Mode |
| 24002 | @section TUI Single Key Mode |
| 24003 | @cindex TUI single key mode |
| 24004 | |
| 24005 | The TUI also provides a @dfn{SingleKey} mode, which binds several |
| 24006 | frequently used @value{GDBN} commands to single keys. Type @kbd{C-x s} to |
| 24007 | switch into this mode, where the following key bindings are used: |
| 24008 | |
| 24009 | @table @kbd |
| 24010 | @kindex c @r{(SingleKey TUI key)} |
| 24011 | @item c |
| 24012 | continue |
| 24013 | |
| 24014 | @kindex d @r{(SingleKey TUI key)} |
| 24015 | @item d |
| 24016 | down |
| 24017 | |
| 24018 | @kindex f @r{(SingleKey TUI key)} |
| 24019 | @item f |
| 24020 | finish |
| 24021 | |
| 24022 | @kindex n @r{(SingleKey TUI key)} |
| 24023 | @item n |
| 24024 | next |
| 24025 | |
| 24026 | @kindex q @r{(SingleKey TUI key)} |
| 24027 | @item q |
| 24028 | exit the SingleKey mode. |
| 24029 | |
| 24030 | @kindex r @r{(SingleKey TUI key)} |
| 24031 | @item r |
| 24032 | run |
| 24033 | |
| 24034 | @kindex s @r{(SingleKey TUI key)} |
| 24035 | @item s |
| 24036 | step |
| 24037 | |
| 24038 | @kindex u @r{(SingleKey TUI key)} |
| 24039 | @item u |
| 24040 | up |
| 24041 | |
| 24042 | @kindex v @r{(SingleKey TUI key)} |
| 24043 | @item v |
| 24044 | info locals |
| 24045 | |
| 24046 | @kindex w @r{(SingleKey TUI key)} |
| 24047 | @item w |
| 24048 | where |
| 24049 | @end table |
| 24050 | |
| 24051 | Other keys temporarily switch to the @value{GDBN} command prompt. |
| 24052 | The key that was pressed is inserted in the editing buffer so that |
| 24053 | it is possible to type most @value{GDBN} commands without interaction |
| 24054 | with the TUI SingleKey mode. Once the command is entered the TUI |
| 24055 | SingleKey mode is restored. The only way to permanently leave |
| 24056 | this mode is by typing @kbd{q} or @kbd{C-x s}. |
| 24057 | |
| 24058 | |
| 24059 | @node TUI Commands |
| 24060 | @section TUI-specific Commands |
| 24061 | @cindex TUI commands |
| 24062 | |
| 24063 | The TUI has specific commands to control the text windows. |
| 24064 | These commands are always available, even when @value{GDBN} is not in |
| 24065 | the TUI mode. When @value{GDBN} is in the standard mode, most |
| 24066 | of these commands will automatically switch to the TUI mode. |
| 24067 | |
| 24068 | Note that if @value{GDBN}'s @code{stdout} is not connected to a |
| 24069 | terminal, or @value{GDBN} has been started with the machine interface |
| 24070 | interpreter (@pxref{GDB/MI, ,The @sc{gdb/mi} Interface}), most of |
| 24071 | these commands will fail with an error, because it would not be |
| 24072 | possible or desirable to enable curses window management. |
| 24073 | |
| 24074 | @table @code |
| 24075 | @item info win |
| 24076 | @kindex info win |
| 24077 | List and give the size of all displayed windows. |
| 24078 | |
| 24079 | @item layout next |
| 24080 | @kindex layout |
| 24081 | Display the next layout. |
| 24082 | |
| 24083 | @item layout prev |
| 24084 | Display the previous layout. |
| 24085 | |
| 24086 | @item layout src |
| 24087 | Display the source window only. |
| 24088 | |
| 24089 | @item layout asm |
| 24090 | Display the assembly window only. |
| 24091 | |
| 24092 | @item layout split |
| 24093 | Display the source and assembly window. |
| 24094 | |
| 24095 | @item layout regs |
| 24096 | Display the register window together with the source or assembly window. |
| 24097 | |
| 24098 | @item focus next |
| 24099 | @kindex focus |
| 24100 | Make the next window active for scrolling. |
| 24101 | |
| 24102 | @item focus prev |
| 24103 | Make the previous window active for scrolling. |
| 24104 | |
| 24105 | @item focus src |
| 24106 | Make the source window active for scrolling. |
| 24107 | |
| 24108 | @item focus asm |
| 24109 | Make the assembly window active for scrolling. |
| 24110 | |
| 24111 | @item focus regs |
| 24112 | Make the register window active for scrolling. |
| 24113 | |
| 24114 | @item focus cmd |
| 24115 | Make the command window active for scrolling. |
| 24116 | |
| 24117 | @item refresh |
| 24118 | @kindex refresh |
| 24119 | Refresh the screen. This is similar to typing @kbd{C-L}. |
| 24120 | |
| 24121 | @item tui reg float |
| 24122 | @kindex tui reg |
| 24123 | Show the floating point registers in the register window. |
| 24124 | |
| 24125 | @item tui reg general |
| 24126 | Show the general registers in the register window. |
| 24127 | |
| 24128 | @item tui reg next |
| 24129 | Show the next register group. The list of register groups as well as |
| 24130 | their order is target specific. The predefined register groups are the |
| 24131 | following: @code{general}, @code{float}, @code{system}, @code{vector}, |
| 24132 | @code{all}, @code{save}, @code{restore}. |
| 24133 | |
| 24134 | @item tui reg system |
| 24135 | Show the system registers in the register window. |
| 24136 | |
| 24137 | @item update |
| 24138 | @kindex update |
| 24139 | Update the source window and the current execution point. |
| 24140 | |
| 24141 | @item winheight @var{name} +@var{count} |
| 24142 | @itemx winheight @var{name} -@var{count} |
| 24143 | @kindex winheight |
| 24144 | Change the height of the window @var{name} by @var{count} |
| 24145 | lines. Positive counts increase the height, while negative counts |
| 24146 | decrease it. |
| 24147 | |
| 24148 | @item tabset @var{nchars} |
| 24149 | @kindex tabset |
| 24150 | Set the width of tab stops to be @var{nchars} characters. |
| 24151 | @end table |
| 24152 | |
| 24153 | @node TUI Configuration |
| 24154 | @section TUI Configuration Variables |
| 24155 | @cindex TUI configuration variables |
| 24156 | |
| 24157 | Several configuration variables control the appearance of TUI windows. |
| 24158 | |
| 24159 | @table @code |
| 24160 | @item set tui border-kind @var{kind} |
| 24161 | @kindex set tui border-kind |
| 24162 | Select the border appearance for the source, assembly and register windows. |
| 24163 | The possible values are the following: |
| 24164 | @table @code |
| 24165 | @item space |
| 24166 | Use a space character to draw the border. |
| 24167 | |
| 24168 | @item ascii |
| 24169 | Use @sc{ascii} characters @samp{+}, @samp{-} and @samp{|} to draw the border. |
| 24170 | |
| 24171 | @item acs |
| 24172 | Use the Alternate Character Set to draw the border. The border is |
| 24173 | drawn using character line graphics if the terminal supports them. |
| 24174 | @end table |
| 24175 | |
| 24176 | @item set tui border-mode @var{mode} |
| 24177 | @kindex set tui border-mode |
| 24178 | @itemx set tui active-border-mode @var{mode} |
| 24179 | @kindex set tui active-border-mode |
| 24180 | Select the display attributes for the borders of the inactive windows |
| 24181 | or the active window. The @var{mode} can be one of the following: |
| 24182 | @table @code |
| 24183 | @item normal |
| 24184 | Use normal attributes to display the border. |
| 24185 | |
| 24186 | @item standout |
| 24187 | Use standout mode. |
| 24188 | |
| 24189 | @item reverse |
| 24190 | Use reverse video mode. |
| 24191 | |
| 24192 | @item half |
| 24193 | Use half bright mode. |
| 24194 | |
| 24195 | @item half-standout |
| 24196 | Use half bright and standout mode. |
| 24197 | |
| 24198 | @item bold |
| 24199 | Use extra bright or bold mode. |
| 24200 | |
| 24201 | @item bold-standout |
| 24202 | Use extra bright or bold and standout mode. |
| 24203 | @end table |
| 24204 | @end table |
| 24205 | |
| 24206 | @node Emacs |
| 24207 | @chapter Using @value{GDBN} under @sc{gnu} Emacs |
| 24208 | |
| 24209 | @cindex Emacs |
| 24210 | @cindex @sc{gnu} Emacs |
| 24211 | A special interface allows you to use @sc{gnu} Emacs to view (and |
| 24212 | edit) the source files for the program you are debugging with |
| 24213 | @value{GDBN}. |
| 24214 | |
| 24215 | To use this interface, use the command @kbd{M-x gdb} in Emacs. Give the |
| 24216 | executable file you want to debug as an argument. This command starts |
| 24217 | @value{GDBN} as a subprocess of Emacs, with input and output through a newly |
| 24218 | created Emacs buffer. |
| 24219 | @c (Do not use the @code{-tui} option to run @value{GDBN} from Emacs.) |
| 24220 | |
| 24221 | Running @value{GDBN} under Emacs can be just like running @value{GDBN} normally except for two |
| 24222 | things: |
| 24223 | |
| 24224 | @itemize @bullet |
| 24225 | @item |
| 24226 | All ``terminal'' input and output goes through an Emacs buffer, called |
| 24227 | the GUD buffer. |
| 24228 | |
| 24229 | This applies both to @value{GDBN} commands and their output, and to the input |
| 24230 | and output done by the program you are debugging. |
| 24231 | |
| 24232 | This is useful because it means that you can copy the text of previous |
| 24233 | commands and input them again; you can even use parts of the output |
| 24234 | in this way. |
| 24235 | |
| 24236 | All the facilities of Emacs' Shell mode are available for interacting |
| 24237 | with your program. In particular, you can send signals the usual |
| 24238 | way---for example, @kbd{C-c C-c} for an interrupt, @kbd{C-c C-z} for a |
| 24239 | stop. |
| 24240 | |
| 24241 | @item |
| 24242 | @value{GDBN} displays source code through Emacs. |
| 24243 | |
| 24244 | Each time @value{GDBN} displays a stack frame, Emacs automatically finds the |
| 24245 | source file for that frame and puts an arrow (@samp{=>}) at the |
| 24246 | left margin of the current line. Emacs uses a separate buffer for |
| 24247 | source display, and splits the screen to show both your @value{GDBN} session |
| 24248 | and the source. |
| 24249 | |
| 24250 | Explicit @value{GDBN} @code{list} or search commands still produce output as |
| 24251 | usual, but you probably have no reason to use them from Emacs. |
| 24252 | @end itemize |
| 24253 | |
| 24254 | We call this @dfn{text command mode}. Emacs 22.1, and later, also uses |
| 24255 | a graphical mode, enabled by default, which provides further buffers |
| 24256 | that can control the execution and describe the state of your program. |
| 24257 | @xref{GDB Graphical Interface,,, Emacs, The @sc{gnu} Emacs Manual}. |
| 24258 | |
| 24259 | If you specify an absolute file name when prompted for the @kbd{M-x |
| 24260 | gdb} argument, then Emacs sets your current working directory to where |
| 24261 | your program resides. If you only specify the file name, then Emacs |
| 24262 | sets your current working directory to to the directory associated |
| 24263 | with the previous buffer. In this case, @value{GDBN} may find your |
| 24264 | program by searching your environment's @code{PATH} variable, but on |
| 24265 | some operating systems it might not find the source. So, although the |
| 24266 | @value{GDBN} input and output session proceeds normally, the auxiliary |
| 24267 | buffer does not display the current source and line of execution. |
| 24268 | |
| 24269 | The initial working directory of @value{GDBN} is printed on the top |
| 24270 | line of the GUD buffer and this serves as a default for the commands |
| 24271 | that specify files for @value{GDBN} to operate on. @xref{Files, |
| 24272 | ,Commands to Specify Files}. |
| 24273 | |
| 24274 | By default, @kbd{M-x gdb} calls the program called @file{gdb}. If you |
| 24275 | need to call @value{GDBN} by a different name (for example, if you |
| 24276 | keep several configurations around, with different names) you can |
| 24277 | customize the Emacs variable @code{gud-gdb-command-name} to run the |
| 24278 | one you want. |
| 24279 | |
| 24280 | In the GUD buffer, you can use these special Emacs commands in |
| 24281 | addition to the standard Shell mode commands: |
| 24282 | |
| 24283 | @table @kbd |
| 24284 | @item C-h m |
| 24285 | Describe the features of Emacs' GUD Mode. |
| 24286 | |
| 24287 | @item C-c C-s |
| 24288 | Execute to another source line, like the @value{GDBN} @code{step} command; also |
| 24289 | update the display window to show the current file and location. |
| 24290 | |
| 24291 | @item C-c C-n |
| 24292 | Execute to next source line in this function, skipping all function |
| 24293 | calls, like the @value{GDBN} @code{next} command. Then update the display window |
| 24294 | to show the current file and location. |
| 24295 | |
| 24296 | @item C-c C-i |
| 24297 | Execute one instruction, like the @value{GDBN} @code{stepi} command; update |
| 24298 | display window accordingly. |
| 24299 | |
| 24300 | @item C-c C-f |
| 24301 | Execute until exit from the selected stack frame, like the @value{GDBN} |
| 24302 | @code{finish} command. |
| 24303 | |
| 24304 | @item C-c C-r |
| 24305 | Continue execution of your program, like the @value{GDBN} @code{continue} |
| 24306 | command. |
| 24307 | |
| 24308 | @item C-c < |
| 24309 | Go up the number of frames indicated by the numeric argument |
| 24310 | (@pxref{Arguments, , Numeric Arguments, Emacs, The @sc{gnu} Emacs Manual}), |
| 24311 | like the @value{GDBN} @code{up} command. |
| 24312 | |
| 24313 | @item C-c > |
| 24314 | Go down the number of frames indicated by the numeric argument, like the |
| 24315 | @value{GDBN} @code{down} command. |
| 24316 | @end table |
| 24317 | |
| 24318 | In any source file, the Emacs command @kbd{C-x @key{SPC}} (@code{gud-break}) |
| 24319 | tells @value{GDBN} to set a breakpoint on the source line point is on. |
| 24320 | |
| 24321 | In text command mode, if you type @kbd{M-x speedbar}, Emacs displays a |
| 24322 | separate frame which shows a backtrace when the GUD buffer is current. |
| 24323 | Move point to any frame in the stack and type @key{RET} to make it |
| 24324 | become the current frame and display the associated source in the |
| 24325 | source buffer. Alternatively, click @kbd{Mouse-2} to make the |
| 24326 | selected frame become the current one. In graphical mode, the |
| 24327 | speedbar displays watch expressions. |
| 24328 | |
| 24329 | If you accidentally delete the source-display buffer, an easy way to get |
| 24330 | it back is to type the command @code{f} in the @value{GDBN} buffer, to |
| 24331 | request a frame display; when you run under Emacs, this recreates |
| 24332 | the source buffer if necessary to show you the context of the current |
| 24333 | frame. |
| 24334 | |
| 24335 | The source files displayed in Emacs are in ordinary Emacs buffers |
| 24336 | which are visiting the source files in the usual way. You can edit |
| 24337 | the files with these buffers if you wish; but keep in mind that @value{GDBN} |
| 24338 | communicates with Emacs in terms of line numbers. If you add or |
| 24339 | delete lines from the text, the line numbers that @value{GDBN} knows cease |
| 24340 | to correspond properly with the code. |
| 24341 | |
| 24342 | A more detailed description of Emacs' interaction with @value{GDBN} is |
| 24343 | given in the Emacs manual (@pxref{Debuggers,,, Emacs, The @sc{gnu} |
| 24344 | Emacs Manual}). |
| 24345 | |
| 24346 | @c The following dropped because Epoch is nonstandard. Reactivate |
| 24347 | @c if/when v19 does something similar. ---doc@cygnus.com 19dec1990 |
| 24348 | @ignore |
| 24349 | @kindex Emacs Epoch environment |
| 24350 | @kindex Epoch |
| 24351 | @kindex inspect |
| 24352 | |
| 24353 | Version 18 of @sc{gnu} Emacs has a built-in window system |
| 24354 | called the @code{epoch} |
| 24355 | environment. Users of this environment can use a new command, |
| 24356 | @code{inspect} which performs identically to @code{print} except that |
| 24357 | each value is printed in its own window. |
| 24358 | @end ignore |
| 24359 | |
| 24360 | |
| 24361 | @node GDB/MI |
| 24362 | @chapter The @sc{gdb/mi} Interface |
| 24363 | |
| 24364 | @unnumberedsec Function and Purpose |
| 24365 | |
| 24366 | @cindex @sc{gdb/mi}, its purpose |
| 24367 | @sc{gdb/mi} is a line based machine oriented text interface to |
| 24368 | @value{GDBN} and is activated by specifying using the |
| 24369 | @option{--interpreter} command line option (@pxref{Mode Options}). It |
| 24370 | is specifically intended to support the development of systems which |
| 24371 | use the debugger as just one small component of a larger system. |
| 24372 | |
| 24373 | This chapter is a specification of the @sc{gdb/mi} interface. It is written |
| 24374 | in the form of a reference manual. |
| 24375 | |
| 24376 | Note that @sc{gdb/mi} is still under construction, so some of the |
| 24377 | features described below are incomplete and subject to change |
| 24378 | (@pxref{GDB/MI Development and Front Ends, , @sc{gdb/mi} Development and Front Ends}). |
| 24379 | |
| 24380 | @unnumberedsec Notation and Terminology |
| 24381 | |
| 24382 | @cindex notational conventions, for @sc{gdb/mi} |
| 24383 | This chapter uses the following notation: |
| 24384 | |
| 24385 | @itemize @bullet |
| 24386 | @item |
| 24387 | @code{|} separates two alternatives. |
| 24388 | |
| 24389 | @item |
| 24390 | @code{[ @var{something} ]} indicates that @var{something} is optional: |
| 24391 | it may or may not be given. |
| 24392 | |
| 24393 | @item |
| 24394 | @code{( @var{group} )*} means that @var{group} inside the parentheses |
| 24395 | may repeat zero or more times. |
| 24396 | |
| 24397 | @item |
| 24398 | @code{( @var{group} )+} means that @var{group} inside the parentheses |
| 24399 | may repeat one or more times. |
| 24400 | |
| 24401 | @item |
| 24402 | @code{"@var{string}"} means a literal @var{string}. |
| 24403 | @end itemize |
| 24404 | |
| 24405 | @ignore |
| 24406 | @heading Dependencies |
| 24407 | @end ignore |
| 24408 | |
| 24409 | @menu |
| 24410 | * GDB/MI General Design:: |
| 24411 | * GDB/MI Command Syntax:: |
| 24412 | * GDB/MI Compatibility with CLI:: |
| 24413 | * GDB/MI Development and Front Ends:: |
| 24414 | * GDB/MI Output Records:: |
| 24415 | * GDB/MI Simple Examples:: |
| 24416 | * GDB/MI Command Description Format:: |
| 24417 | * GDB/MI Breakpoint Commands:: |
| 24418 | * GDB/MI Program Context:: |
| 24419 | * GDB/MI Thread Commands:: |
| 24420 | * GDB/MI Program Execution:: |
| 24421 | * GDB/MI Stack Manipulation:: |
| 24422 | * GDB/MI Variable Objects:: |
| 24423 | * GDB/MI Data Manipulation:: |
| 24424 | * GDB/MI Tracepoint Commands:: |
| 24425 | * GDB/MI Symbol Query:: |
| 24426 | * GDB/MI File Commands:: |
| 24427 | @ignore |
| 24428 | * GDB/MI Kod Commands:: |
| 24429 | * GDB/MI Memory Overlay Commands:: |
| 24430 | * GDB/MI Signal Handling Commands:: |
| 24431 | @end ignore |
| 24432 | * GDB/MI Target Manipulation:: |
| 24433 | * GDB/MI File Transfer Commands:: |
| 24434 | * GDB/MI Miscellaneous Commands:: |
| 24435 | @end menu |
| 24436 | |
| 24437 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 24438 | @node GDB/MI General Design |
| 24439 | @section @sc{gdb/mi} General Design |
| 24440 | @cindex GDB/MI General Design |
| 24441 | |
| 24442 | Interaction of a @sc{GDB/MI} frontend with @value{GDBN} involves three |
| 24443 | parts---commands sent to @value{GDBN}, responses to those commands |
| 24444 | and notifications. Each command results in exactly one response, |
| 24445 | indicating either successful completion of the command, or an error. |
| 24446 | For the commands that do not resume the target, the response contains the |
| 24447 | requested information. For the commands that resume the target, the |
| 24448 | response only indicates whether the target was successfully resumed. |
| 24449 | Notifications is the mechanism for reporting changes in the state of the |
| 24450 | target, or in @value{GDBN} state, that cannot conveniently be associated with |
| 24451 | a command and reported as part of that command response. |
| 24452 | |
| 24453 | The important examples of notifications are: |
| 24454 | @itemize @bullet |
| 24455 | |
| 24456 | @item |
| 24457 | Exec notifications. These are used to report changes in |
| 24458 | target state---when a target is resumed, or stopped. It would not |
| 24459 | be feasible to include this information in response of resuming |
| 24460 | commands, because one resume commands can result in multiple events in |
| 24461 | different threads. Also, quite some time may pass before any event |
| 24462 | happens in the target, while a frontend needs to know whether the resuming |
| 24463 | command itself was successfully executed. |
| 24464 | |
| 24465 | @item |
| 24466 | Console output, and status notifications. Console output |
| 24467 | notifications are used to report output of CLI commands, as well as |
| 24468 | diagnostics for other commands. Status notifications are used to |
| 24469 | report the progress of a long-running operation. Naturally, including |
| 24470 | this information in command response would mean no output is produced |
| 24471 | until the command is finished, which is undesirable. |
| 24472 | |
| 24473 | @item |
| 24474 | General notifications. Commands may have various side effects on |
| 24475 | the @value{GDBN} or target state beyond their official purpose. For example, |
| 24476 | a command may change the selected thread. Although such changes can |
| 24477 | be included in command response, using notification allows for more |
| 24478 | orthogonal frontend design. |
| 24479 | |
| 24480 | @end itemize |
| 24481 | |
| 24482 | There's no guarantee that whenever an MI command reports an error, |
| 24483 | @value{GDBN} or the target are in any specific state, and especially, |
| 24484 | the state is not reverted to the state before the MI command was |
| 24485 | processed. Therefore, whenever an MI command results in an error, |
| 24486 | we recommend that the frontend refreshes all the information shown in |
| 24487 | the user interface. |
| 24488 | |
| 24489 | |
| 24490 | @menu |
| 24491 | * Context management:: |
| 24492 | * Asynchronous and non-stop modes:: |
| 24493 | * Thread groups:: |
| 24494 | @end menu |
| 24495 | |
| 24496 | @node Context management |
| 24497 | @subsection Context management |
| 24498 | |
| 24499 | In most cases when @value{GDBN} accesses the target, this access is |
| 24500 | done in context of a specific thread and frame (@pxref{Frames}). |
| 24501 | Often, even when accessing global data, the target requires that a thread |
| 24502 | be specified. The CLI interface maintains the selected thread and frame, |
| 24503 | and supplies them to target on each command. This is convenient, |
| 24504 | because a command line user would not want to specify that information |
| 24505 | explicitly on each command, and because user interacts with |
| 24506 | @value{GDBN} via a single terminal, so no confusion is possible as |
| 24507 | to what thread and frame are the current ones. |
| 24508 | |
| 24509 | In the case of MI, the concept of selected thread and frame is less |
| 24510 | useful. First, a frontend can easily remember this information |
| 24511 | itself. Second, a graphical frontend can have more than one window, |
| 24512 | each one used for debugging a different thread, and the frontend might |
| 24513 | want to access additional threads for internal purposes. This |
| 24514 | increases the risk that by relying on implicitly selected thread, the |
| 24515 | frontend may be operating on a wrong one. Therefore, each MI command |
| 24516 | should explicitly specify which thread and frame to operate on. To |
| 24517 | make it possible, each MI command accepts the @samp{--thread} and |
| 24518 | @samp{--frame} options, the value to each is @value{GDBN} identifier |
| 24519 | for thread and frame to operate on. |
| 24520 | |
| 24521 | Usually, each top-level window in a frontend allows the user to select |
| 24522 | a thread and a frame, and remembers the user selection for further |
| 24523 | operations. However, in some cases @value{GDBN} may suggest that the |
| 24524 | current thread be changed. For example, when stopping on a breakpoint |
| 24525 | it is reasonable to switch to the thread where breakpoint is hit. For |
| 24526 | another example, if the user issues the CLI @samp{thread} command via |
| 24527 | the frontend, it is desirable to change the frontend's selected thread to the |
| 24528 | one specified by user. @value{GDBN} communicates the suggestion to |
| 24529 | change current thread using the @samp{=thread-selected} notification. |
| 24530 | No such notification is available for the selected frame at the moment. |
| 24531 | |
| 24532 | Note that historically, MI shares the selected thread with CLI, so |
| 24533 | frontends used the @code{-thread-select} to execute commands in the |
| 24534 | right context. However, getting this to work right is cumbersome. The |
| 24535 | simplest way is for frontend to emit @code{-thread-select} command |
| 24536 | before every command. This doubles the number of commands that need |
| 24537 | to be sent. The alternative approach is to suppress @code{-thread-select} |
| 24538 | if the selected thread in @value{GDBN} is supposed to be identical to the |
| 24539 | thread the frontend wants to operate on. However, getting this |
| 24540 | optimization right can be tricky. In particular, if the frontend |
| 24541 | sends several commands to @value{GDBN}, and one of the commands changes the |
| 24542 | selected thread, then the behaviour of subsequent commands will |
| 24543 | change. So, a frontend should either wait for response from such |
| 24544 | problematic commands, or explicitly add @code{-thread-select} for |
| 24545 | all subsequent commands. No frontend is known to do this exactly |
| 24546 | right, so it is suggested to just always pass the @samp{--thread} and |
| 24547 | @samp{--frame} options. |
| 24548 | |
| 24549 | @node Asynchronous and non-stop modes |
| 24550 | @subsection Asynchronous command execution and non-stop mode |
| 24551 | |
| 24552 | On some targets, @value{GDBN} is capable of processing MI commands |
| 24553 | even while the target is running. This is called @dfn{asynchronous |
| 24554 | command execution} (@pxref{Background Execution}). The frontend may |
| 24555 | specify a preferrence for asynchronous execution using the |
| 24556 | @code{-gdb-set target-async 1} command, which should be emitted before |
| 24557 | either running the executable or attaching to the target. After the |
| 24558 | frontend has started the executable or attached to the target, it can |
| 24559 | find if asynchronous execution is enabled using the |
| 24560 | @code{-list-target-features} command. |
| 24561 | |
| 24562 | Even if @value{GDBN} can accept a command while target is running, |
| 24563 | many commands that access the target do not work when the target is |
| 24564 | running. Therefore, asynchronous command execution is most useful |
| 24565 | when combined with non-stop mode (@pxref{Non-Stop Mode}). Then, |
| 24566 | it is possible to examine the state of one thread, while other threads |
| 24567 | are running. |
| 24568 | |
| 24569 | When a given thread is running, MI commands that try to access the |
| 24570 | target in the context of that thread may not work, or may work only on |
| 24571 | some targets. In particular, commands that try to operate on thread's |
| 24572 | stack will not work, on any target. Commands that read memory, or |
| 24573 | modify breakpoints, may work or not work, depending on the target. Note |
| 24574 | that even commands that operate on global state, such as @code{print}, |
| 24575 | @code{set}, and breakpoint commands, still access the target in the |
| 24576 | context of a specific thread, so frontend should try to find a |
| 24577 | stopped thread and perform the operation on that thread (using the |
| 24578 | @samp{--thread} option). |
| 24579 | |
| 24580 | Which commands will work in the context of a running thread is |
| 24581 | highly target dependent. However, the two commands |
| 24582 | @code{-exec-interrupt}, to stop a thread, and @code{-thread-info}, |
| 24583 | to find the state of a thread, will always work. |
| 24584 | |
| 24585 | @node Thread groups |
| 24586 | @subsection Thread groups |
| 24587 | @value{GDBN} may be used to debug several processes at the same time. |
| 24588 | On some platfroms, @value{GDBN} may support debugging of several |
| 24589 | hardware systems, each one having several cores with several different |
| 24590 | processes running on each core. This section describes the MI |
| 24591 | mechanism to support such debugging scenarios. |
| 24592 | |
| 24593 | The key observation is that regardless of the structure of the |
| 24594 | target, MI can have a global list of threads, because most commands that |
| 24595 | accept the @samp{--thread} option do not need to know what process that |
| 24596 | thread belongs to. Therefore, it is not necessary to introduce |
| 24597 | neither additional @samp{--process} option, nor an notion of the |
| 24598 | current process in the MI interface. The only strictly new feature |
| 24599 | that is required is the ability to find how the threads are grouped |
| 24600 | into processes. |
| 24601 | |
| 24602 | To allow the user to discover such grouping, and to support arbitrary |
| 24603 | hierarchy of machines/cores/processes, MI introduces the concept of a |
| 24604 | @dfn{thread group}. Thread group is a collection of threads and other |
| 24605 | thread groups. A thread group always has a string identifier, a type, |
| 24606 | and may have additional attributes specific to the type. A new |
| 24607 | command, @code{-list-thread-groups}, returns the list of top-level |
| 24608 | thread groups, which correspond to processes that @value{GDBN} is |
| 24609 | debugging at the moment. By passing an identifier of a thread group |
| 24610 | to the @code{-list-thread-groups} command, it is possible to obtain |
| 24611 | the members of specific thread group. |
| 24612 | |
| 24613 | To allow the user to easily discover processes, and other objects, he |
| 24614 | wishes to debug, a concept of @dfn{available thread group} is |
| 24615 | introduced. Available thread group is an thread group that |
| 24616 | @value{GDBN} is not debugging, but that can be attached to, using the |
| 24617 | @code{-target-attach} command. The list of available top-level thread |
| 24618 | groups can be obtained using @samp{-list-thread-groups --available}. |
| 24619 | In general, the content of a thread group may be only retrieved only |
| 24620 | after attaching to that thread group. |
| 24621 | |
| 24622 | Thread groups are related to inferiors (@pxref{Inferiors and |
| 24623 | Programs}). Each inferior corresponds to a thread group of a special |
| 24624 | type @samp{process}, and some additional operations are permitted on |
| 24625 | such thread groups. |
| 24626 | |
| 24627 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 24628 | @node GDB/MI Command Syntax |
| 24629 | @section @sc{gdb/mi} Command Syntax |
| 24630 | |
| 24631 | @menu |
| 24632 | * GDB/MI Input Syntax:: |
| 24633 | * GDB/MI Output Syntax:: |
| 24634 | @end menu |
| 24635 | |
| 24636 | @node GDB/MI Input Syntax |
| 24637 | @subsection @sc{gdb/mi} Input Syntax |
| 24638 | |
| 24639 | @cindex input syntax for @sc{gdb/mi} |
| 24640 | @cindex @sc{gdb/mi}, input syntax |
| 24641 | @table @code |
| 24642 | @item @var{command} @expansion{} |
| 24643 | @code{@var{cli-command} | @var{mi-command}} |
| 24644 | |
| 24645 | @item @var{cli-command} @expansion{} |
| 24646 | @code{[ @var{token} ] @var{cli-command} @var{nl}}, where |
| 24647 | @var{cli-command} is any existing @value{GDBN} CLI command. |
| 24648 | |
| 24649 | @item @var{mi-command} @expansion{} |
| 24650 | @code{[ @var{token} ] "-" @var{operation} ( " " @var{option} )* |
| 24651 | @code{[} " --" @code{]} ( " " @var{parameter} )* @var{nl}} |
| 24652 | |
| 24653 | @item @var{token} @expansion{} |
| 24654 | "any sequence of digits" |
| 24655 | |
| 24656 | @item @var{option} @expansion{} |
| 24657 | @code{"-" @var{parameter} [ " " @var{parameter} ]} |
| 24658 | |
| 24659 | @item @var{parameter} @expansion{} |
| 24660 | @code{@var{non-blank-sequence} | @var{c-string}} |
| 24661 | |
| 24662 | @item @var{operation} @expansion{} |
| 24663 | @emph{any of the operations described in this chapter} |
| 24664 | |
| 24665 | @item @var{non-blank-sequence} @expansion{} |
| 24666 | @emph{anything, provided it doesn't contain special characters such as |
| 24667 | "-", @var{nl}, """ and of course " "} |
| 24668 | |
| 24669 | @item @var{c-string} @expansion{} |
| 24670 | @code{""" @var{seven-bit-iso-c-string-content} """} |
| 24671 | |
| 24672 | @item @var{nl} @expansion{} |
| 24673 | @code{CR | CR-LF} |
| 24674 | @end table |
| 24675 | |
| 24676 | @noindent |
| 24677 | Notes: |
| 24678 | |
| 24679 | @itemize @bullet |
| 24680 | @item |
| 24681 | The CLI commands are still handled by the @sc{mi} interpreter; their |
| 24682 | output is described below. |
| 24683 | |
| 24684 | @item |
| 24685 | The @code{@var{token}}, when present, is passed back when the command |
| 24686 | finishes. |
| 24687 | |
| 24688 | @item |
| 24689 | Some @sc{mi} commands accept optional arguments as part of the parameter |
| 24690 | list. Each option is identified by a leading @samp{-} (dash) and may be |
| 24691 | followed by an optional argument parameter. Options occur first in the |
| 24692 | parameter list and can be delimited from normal parameters using |
| 24693 | @samp{--} (this is useful when some parameters begin with a dash). |
| 24694 | @end itemize |
| 24695 | |
| 24696 | Pragmatics: |
| 24697 | |
| 24698 | @itemize @bullet |
| 24699 | @item |
| 24700 | We want easy access to the existing CLI syntax (for debugging). |
| 24701 | |
| 24702 | @item |
| 24703 | We want it to be easy to spot a @sc{mi} operation. |
| 24704 | @end itemize |
| 24705 | |
| 24706 | @node GDB/MI Output Syntax |
| 24707 | @subsection @sc{gdb/mi} Output Syntax |
| 24708 | |
| 24709 | @cindex output syntax of @sc{gdb/mi} |
| 24710 | @cindex @sc{gdb/mi}, output syntax |
| 24711 | The output from @sc{gdb/mi} consists of zero or more out-of-band records |
| 24712 | followed, optionally, by a single result record. This result record |
| 24713 | is for the most recent command. The sequence of output records is |
| 24714 | terminated by @samp{(gdb)}. |
| 24715 | |
| 24716 | If an input command was prefixed with a @code{@var{token}} then the |
| 24717 | corresponding output for that command will also be prefixed by that same |
| 24718 | @var{token}. |
| 24719 | |
| 24720 | @table @code |
| 24721 | @item @var{output} @expansion{} |
| 24722 | @code{( @var{out-of-band-record} )* [ @var{result-record} ] "(gdb)" @var{nl}} |
| 24723 | |
| 24724 | @item @var{result-record} @expansion{} |
| 24725 | @code{ [ @var{token} ] "^" @var{result-class} ( "," @var{result} )* @var{nl}} |
| 24726 | |
| 24727 | @item @var{out-of-band-record} @expansion{} |
| 24728 | @code{@var{async-record} | @var{stream-record}} |
| 24729 | |
| 24730 | @item @var{async-record} @expansion{} |
| 24731 | @code{@var{exec-async-output} | @var{status-async-output} | @var{notify-async-output}} |
| 24732 | |
| 24733 | @item @var{exec-async-output} @expansion{} |
| 24734 | @code{[ @var{token} ] "*" @var{async-output}} |
| 24735 | |
| 24736 | @item @var{status-async-output} @expansion{} |
| 24737 | @code{[ @var{token} ] "+" @var{async-output}} |
| 24738 | |
| 24739 | @item @var{notify-async-output} @expansion{} |
| 24740 | @code{[ @var{token} ] "=" @var{async-output}} |
| 24741 | |
| 24742 | @item @var{async-output} @expansion{} |
| 24743 | @code{@var{async-class} ( "," @var{result} )* @var{nl}} |
| 24744 | |
| 24745 | @item @var{result-class} @expansion{} |
| 24746 | @code{"done" | "running" | "connected" | "error" | "exit"} |
| 24747 | |
| 24748 | @item @var{async-class} @expansion{} |
| 24749 | @code{"stopped" | @var{others}} (where @var{others} will be added |
| 24750 | depending on the needs---this is still in development). |
| 24751 | |
| 24752 | @item @var{result} @expansion{} |
| 24753 | @code{ @var{variable} "=" @var{value}} |
| 24754 | |
| 24755 | @item @var{variable} @expansion{} |
| 24756 | @code{ @var{string} } |
| 24757 | |
| 24758 | @item @var{value} @expansion{} |
| 24759 | @code{ @var{const} | @var{tuple} | @var{list} } |
| 24760 | |
| 24761 | @item @var{const} @expansion{} |
| 24762 | @code{@var{c-string}} |
| 24763 | |
| 24764 | @item @var{tuple} @expansion{} |
| 24765 | @code{ "@{@}" | "@{" @var{result} ( "," @var{result} )* "@}" } |
| 24766 | |
| 24767 | @item @var{list} @expansion{} |
| 24768 | @code{ "[]" | "[" @var{value} ( "," @var{value} )* "]" | "[" |
| 24769 | @var{result} ( "," @var{result} )* "]" } |
| 24770 | |
| 24771 | @item @var{stream-record} @expansion{} |
| 24772 | @code{@var{console-stream-output} | @var{target-stream-output} | @var{log-stream-output}} |
| 24773 | |
| 24774 | @item @var{console-stream-output} @expansion{} |
| 24775 | @code{"~" @var{c-string}} |
| 24776 | |
| 24777 | @item @var{target-stream-output} @expansion{} |
| 24778 | @code{"@@" @var{c-string}} |
| 24779 | |
| 24780 | @item @var{log-stream-output} @expansion{} |
| 24781 | @code{"&" @var{c-string}} |
| 24782 | |
| 24783 | @item @var{nl} @expansion{} |
| 24784 | @code{CR | CR-LF} |
| 24785 | |
| 24786 | @item @var{token} @expansion{} |
| 24787 | @emph{any sequence of digits}. |
| 24788 | @end table |
| 24789 | |
| 24790 | @noindent |
| 24791 | Notes: |
| 24792 | |
| 24793 | @itemize @bullet |
| 24794 | @item |
| 24795 | All output sequences end in a single line containing a period. |
| 24796 | |
| 24797 | @item |
| 24798 | The @code{@var{token}} is from the corresponding request. Note that |
| 24799 | for all async output, while the token is allowed by the grammar and |
| 24800 | may be output by future versions of @value{GDBN} for select async |
| 24801 | output messages, it is generally omitted. Frontends should treat |
| 24802 | all async output as reporting general changes in the state of the |
| 24803 | target and there should be no need to associate async output to any |
| 24804 | prior command. |
| 24805 | |
| 24806 | @item |
| 24807 | @cindex status output in @sc{gdb/mi} |
| 24808 | @var{status-async-output} contains on-going status information about the |
| 24809 | progress of a slow operation. It can be discarded. All status output is |
| 24810 | prefixed by @samp{+}. |
| 24811 | |
| 24812 | @item |
| 24813 | @cindex async output in @sc{gdb/mi} |
| 24814 | @var{exec-async-output} contains asynchronous state change on the target |
| 24815 | (stopped, started, disappeared). All async output is prefixed by |
| 24816 | @samp{*}. |
| 24817 | |
| 24818 | @item |
| 24819 | @cindex notify output in @sc{gdb/mi} |
| 24820 | @var{notify-async-output} contains supplementary information that the |
| 24821 | client should handle (e.g., a new breakpoint information). All notify |
| 24822 | output is prefixed by @samp{=}. |
| 24823 | |
| 24824 | @item |
| 24825 | @cindex console output in @sc{gdb/mi} |
| 24826 | @var{console-stream-output} is output that should be displayed as is in the |
| 24827 | console. It is the textual response to a CLI command. All the console |
| 24828 | output is prefixed by @samp{~}. |
| 24829 | |
| 24830 | @item |
| 24831 | @cindex target output in @sc{gdb/mi} |
| 24832 | @var{target-stream-output} is the output produced by the target program. |
| 24833 | All the target output is prefixed by @samp{@@}. |
| 24834 | |
| 24835 | @item |
| 24836 | @cindex log output in @sc{gdb/mi} |
| 24837 | @var{log-stream-output} is output text coming from @value{GDBN}'s internals, for |
| 24838 | instance messages that should be displayed as part of an error log. All |
| 24839 | the log output is prefixed by @samp{&}. |
| 24840 | |
| 24841 | @item |
| 24842 | @cindex list output in @sc{gdb/mi} |
| 24843 | New @sc{gdb/mi} commands should only output @var{lists} containing |
| 24844 | @var{values}. |
| 24845 | |
| 24846 | |
| 24847 | @end itemize |
| 24848 | |
| 24849 | @xref{GDB/MI Stream Records, , @sc{gdb/mi} Stream Records}, for more |
| 24850 | details about the various output records. |
| 24851 | |
| 24852 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 24853 | @node GDB/MI Compatibility with CLI |
| 24854 | @section @sc{gdb/mi} Compatibility with CLI |
| 24855 | |
| 24856 | @cindex compatibility, @sc{gdb/mi} and CLI |
| 24857 | @cindex @sc{gdb/mi}, compatibility with CLI |
| 24858 | |
| 24859 | For the developers convenience CLI commands can be entered directly, |
| 24860 | but there may be some unexpected behaviour. For example, commands |
| 24861 | that query the user will behave as if the user replied yes, breakpoint |
| 24862 | command lists are not executed and some CLI commands, such as |
| 24863 | @code{if}, @code{when} and @code{define}, prompt for further input with |
| 24864 | @samp{>}, which is not valid MI output. |
| 24865 | |
| 24866 | This feature may be removed at some stage in the future and it is |
| 24867 | recommended that front ends use the @code{-interpreter-exec} command |
| 24868 | (@pxref{-interpreter-exec}). |
| 24869 | |
| 24870 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 24871 | @node GDB/MI Development and Front Ends |
| 24872 | @section @sc{gdb/mi} Development and Front Ends |
| 24873 | @cindex @sc{gdb/mi} development |
| 24874 | |
| 24875 | The application which takes the MI output and presents the state of the |
| 24876 | program being debugged to the user is called a @dfn{front end}. |
| 24877 | |
| 24878 | Although @sc{gdb/mi} is still incomplete, it is currently being used |
| 24879 | by a variety of front ends to @value{GDBN}. This makes it difficult |
| 24880 | to introduce new functionality without breaking existing usage. This |
| 24881 | section tries to minimize the problems by describing how the protocol |
| 24882 | might change. |
| 24883 | |
| 24884 | Some changes in MI need not break a carefully designed front end, and |
| 24885 | for these the MI version will remain unchanged. The following is a |
| 24886 | list of changes that may occur within one level, so front ends should |
| 24887 | parse MI output in a way that can handle them: |
| 24888 | |
| 24889 | @itemize @bullet |
| 24890 | @item |
| 24891 | New MI commands may be added. |
| 24892 | |
| 24893 | @item |
| 24894 | New fields may be added to the output of any MI command. |
| 24895 | |
| 24896 | @item |
| 24897 | The range of values for fields with specified values, e.g., |
| 24898 | @code{in_scope} (@pxref{-var-update}) may be extended. |
| 24899 | |
| 24900 | @c The format of field's content e.g type prefix, may change so parse it |
| 24901 | @c at your own risk. Yes, in general? |
| 24902 | |
| 24903 | @c The order of fields may change? Shouldn't really matter but it might |
| 24904 | @c resolve inconsistencies. |
| 24905 | @end itemize |
| 24906 | |
| 24907 | If the changes are likely to break front ends, the MI version level |
| 24908 | will be increased by one. This will allow the front end to parse the |
| 24909 | output according to the MI version. Apart from mi0, new versions of |
| 24910 | @value{GDBN} will not support old versions of MI and it will be the |
| 24911 | responsibility of the front end to work with the new one. |
| 24912 | |
| 24913 | @c Starting with mi3, add a new command -mi-version that prints the MI |
| 24914 | @c version? |
| 24915 | |
| 24916 | The best way to avoid unexpected changes in MI that might break your front |
| 24917 | end is to make your project known to @value{GDBN} developers and |
| 24918 | follow development on @email{gdb@@sourceware.org} and |
| 24919 | @email{gdb-patches@@sourceware.org}. |
| 24920 | @cindex mailing lists |
| 24921 | |
| 24922 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 24923 | @node GDB/MI Output Records |
| 24924 | @section @sc{gdb/mi} Output Records |
| 24925 | |
| 24926 | @menu |
| 24927 | * GDB/MI Result Records:: |
| 24928 | * GDB/MI Stream Records:: |
| 24929 | * GDB/MI Async Records:: |
| 24930 | * GDB/MI Frame Information:: |
| 24931 | * GDB/MI Thread Information:: |
| 24932 | @end menu |
| 24933 | |
| 24934 | @node GDB/MI Result Records |
| 24935 | @subsection @sc{gdb/mi} Result Records |
| 24936 | |
| 24937 | @cindex result records in @sc{gdb/mi} |
| 24938 | @cindex @sc{gdb/mi}, result records |
| 24939 | In addition to a number of out-of-band notifications, the response to a |
| 24940 | @sc{gdb/mi} command includes one of the following result indications: |
| 24941 | |
| 24942 | @table @code |
| 24943 | @findex ^done |
| 24944 | @item "^done" [ "," @var{results} ] |
| 24945 | The synchronous operation was successful, @code{@var{results}} are the return |
| 24946 | values. |
| 24947 | |
| 24948 | @item "^running" |
| 24949 | @findex ^running |
| 24950 | This result record is equivalent to @samp{^done}. Historically, it |
| 24951 | was output instead of @samp{^done} if the command has resumed the |
| 24952 | target. This behaviour is maintained for backward compatibility, but |
| 24953 | all frontends should treat @samp{^done} and @samp{^running} |
| 24954 | identically and rely on the @samp{*running} output record to determine |
| 24955 | which threads are resumed. |
| 24956 | |
| 24957 | @item "^connected" |
| 24958 | @findex ^connected |
| 24959 | @value{GDBN} has connected to a remote target. |
| 24960 | |
| 24961 | @item "^error" "," @var{c-string} |
| 24962 | @findex ^error |
| 24963 | The operation failed. The @code{@var{c-string}} contains the corresponding |
| 24964 | error message. |
| 24965 | |
| 24966 | @item "^exit" |
| 24967 | @findex ^exit |
| 24968 | @value{GDBN} has terminated. |
| 24969 | |
| 24970 | @end table |
| 24971 | |
| 24972 | @node GDB/MI Stream Records |
| 24973 | @subsection @sc{gdb/mi} Stream Records |
| 24974 | |
| 24975 | @cindex @sc{gdb/mi}, stream records |
| 24976 | @cindex stream records in @sc{gdb/mi} |
| 24977 | @value{GDBN} internally maintains a number of output streams: the console, the |
| 24978 | target, and the log. The output intended for each of these streams is |
| 24979 | funneled through the @sc{gdb/mi} interface using @dfn{stream records}. |
| 24980 | |
| 24981 | Each stream record begins with a unique @dfn{prefix character} which |
| 24982 | identifies its stream (@pxref{GDB/MI Output Syntax, , @sc{gdb/mi} Output |
| 24983 | Syntax}). In addition to the prefix, each stream record contains a |
| 24984 | @code{@var{string-output}}. This is either raw text (with an implicit new |
| 24985 | line) or a quoted C string (which does not contain an implicit newline). |
| 24986 | |
| 24987 | @table @code |
| 24988 | @item "~" @var{string-output} |
| 24989 | The console output stream contains text that should be displayed in the |
| 24990 | CLI console window. It contains the textual responses to CLI commands. |
| 24991 | |
| 24992 | @item "@@" @var{string-output} |
| 24993 | The target output stream contains any textual output from the running |
| 24994 | target. This is only present when GDB's event loop is truly |
| 24995 | asynchronous, which is currently only the case for remote targets. |
| 24996 | |
| 24997 | @item "&" @var{string-output} |
| 24998 | The log stream contains debugging messages being produced by @value{GDBN}'s |
| 24999 | internals. |
| 25000 | @end table |
| 25001 | |
| 25002 | @node GDB/MI Async Records |
| 25003 | @subsection @sc{gdb/mi} Async Records |
| 25004 | |
| 25005 | @cindex async records in @sc{gdb/mi} |
| 25006 | @cindex @sc{gdb/mi}, async records |
| 25007 | @dfn{Async} records are used to notify the @sc{gdb/mi} client of |
| 25008 | additional changes that have occurred. Those changes can either be a |
| 25009 | consequence of @sc{gdb/mi} commands (e.g., a breakpoint modified) or a result of |
| 25010 | target activity (e.g., target stopped). |
| 25011 | |
| 25012 | The following is the list of possible async records: |
| 25013 | |
| 25014 | @table @code |
| 25015 | |
| 25016 | @item *running,thread-id="@var{thread}" |
| 25017 | The target is now running. The @var{thread} field tells which |
| 25018 | specific thread is now running, and can be @samp{all} if all threads |
| 25019 | are running. The frontend should assume that no interaction with a |
| 25020 | running thread is possible after this notification is produced. |
| 25021 | The frontend should not assume that this notification is output |
| 25022 | only once for any command. @value{GDBN} may emit this notification |
| 25023 | several times, either for different threads, because it cannot resume |
| 25024 | all threads together, or even for a single thread, if the thread must |
| 25025 | be stepped though some code before letting it run freely. |
| 25026 | |
| 25027 | @item *stopped,reason="@var{reason}",thread-id="@var{id}",stopped-threads="@var{stopped}",core="@var{core}" |
| 25028 | The target has stopped. The @var{reason} field can have one of the |
| 25029 | following values: |
| 25030 | |
| 25031 | @table @code |
| 25032 | @item breakpoint-hit |
| 25033 | A breakpoint was reached. |
| 25034 | @item watchpoint-trigger |
| 25035 | A watchpoint was triggered. |
| 25036 | @item read-watchpoint-trigger |
| 25037 | A read watchpoint was triggered. |
| 25038 | @item access-watchpoint-trigger |
| 25039 | An access watchpoint was triggered. |
| 25040 | @item function-finished |
| 25041 | An -exec-finish or similar CLI command was accomplished. |
| 25042 | @item location-reached |
| 25043 | An -exec-until or similar CLI command was accomplished. |
| 25044 | @item watchpoint-scope |
| 25045 | A watchpoint has gone out of scope. |
| 25046 | @item end-stepping-range |
| 25047 | An -exec-next, -exec-next-instruction, -exec-step, -exec-step-instruction or |
| 25048 | similar CLI command was accomplished. |
| 25049 | @item exited-signalled |
| 25050 | The inferior exited because of a signal. |
| 25051 | @item exited |
| 25052 | The inferior exited. |
| 25053 | @item exited-normally |
| 25054 | The inferior exited normally. |
| 25055 | @item signal-received |
| 25056 | A signal was received by the inferior. |
| 25057 | @end table |
| 25058 | |
| 25059 | The @var{id} field identifies the thread that directly caused the stop |
| 25060 | -- for example by hitting a breakpoint. Depending on whether all-stop |
| 25061 | mode is in effect (@pxref{All-Stop Mode}), @value{GDBN} may either |
| 25062 | stop all threads, or only the thread that directly triggered the stop. |
| 25063 | If all threads are stopped, the @var{stopped} field will have the |
| 25064 | value of @code{"all"}. Otherwise, the value of the @var{stopped} |
| 25065 | field will be a list of thread identifiers. Presently, this list will |
| 25066 | always include a single thread, but frontend should be prepared to see |
| 25067 | several threads in the list. The @var{core} field reports the |
| 25068 | processor core on which the stop event has happened. This field may be absent |
| 25069 | if such information is not available. |
| 25070 | |
| 25071 | @item =thread-group-added,id="@var{id}" |
| 25072 | @itemx =thread-group-removed,id="@var{id}" |
| 25073 | A thread group was either added or removed. The @var{id} field |
| 25074 | contains the @value{GDBN} identifier of the thread group. When a thread |
| 25075 | group is added, it generally might not be associated with a running |
| 25076 | process. When a thread group is removed, its id becomes invalid and |
| 25077 | cannot be used in any way. |
| 25078 | |
| 25079 | @item =thread-group-started,id="@var{id}",pid="@var{pid}" |
| 25080 | A thread group became associated with a running program, |
| 25081 | either because the program was just started or the thread group |
| 25082 | was attached to a program. The @var{id} field contains the |
| 25083 | @value{GDBN} identifier of the thread group. The @var{pid} field |
| 25084 | contains process identifier, specific to the operating system. |
| 25085 | |
| 25086 | @itemx =thread-group-exited,id="@var{id}" |
| 25087 | A thread group is no longer associated with a running program, |
| 25088 | either because the program has exited, or because it was detached |
| 25089 | from. The @var{id} field contains the @value{GDBN} identifier of the |
| 25090 | thread group. |
| 25091 | |
| 25092 | @item =thread-created,id="@var{id}",group-id="@var{gid}" |
| 25093 | @itemx =thread-exited,id="@var{id}",group-id="@var{gid}" |
| 25094 | A thread either was created, or has exited. The @var{id} field |
| 25095 | contains the @value{GDBN} identifier of the thread. The @var{gid} |
| 25096 | field identifies the thread group this thread belongs to. |
| 25097 | |
| 25098 | @item =thread-selected,id="@var{id}" |
| 25099 | Informs that the selected thread was changed as result of the last |
| 25100 | command. This notification is not emitted as result of @code{-thread-select} |
| 25101 | command but is emitted whenever an MI command that is not documented |
| 25102 | to change the selected thread actually changes it. In particular, |
| 25103 | invoking, directly or indirectly (via user-defined command), the CLI |
| 25104 | @code{thread} command, will generate this notification. |
| 25105 | |
| 25106 | We suggest that in response to this notification, front ends |
| 25107 | highlight the selected thread and cause subsequent commands to apply to |
| 25108 | that thread. |
| 25109 | |
| 25110 | @item =library-loaded,... |
| 25111 | Reports that a new library file was loaded by the program. This |
| 25112 | notification has 4 fields---@var{id}, @var{target-name}, |
| 25113 | @var{host-name}, and @var{symbols-loaded}. The @var{id} field is an |
| 25114 | opaque identifier of the library. For remote debugging case, |
| 25115 | @var{target-name} and @var{host-name} fields give the name of the |
| 25116 | library file on the target, and on the host respectively. For native |
| 25117 | debugging, both those fields have the same value. The |
| 25118 | @var{symbols-loaded} field is emitted only for backward compatibility |
| 25119 | and should not be relied on to convey any useful information. The |
| 25120 | @var{thread-group} field, if present, specifies the id of the thread |
| 25121 | group in whose context the library was loaded. If the field is |
| 25122 | absent, it means the library was loaded in the context of all present |
| 25123 | thread groups. |
| 25124 | |
| 25125 | @item =library-unloaded,... |
| 25126 | Reports that a library was unloaded by the program. This notification |
| 25127 | has 3 fields---@var{id}, @var{target-name} and @var{host-name} with |
| 25128 | the same meaning as for the @code{=library-loaded} notification. |
| 25129 | The @var{thread-group} field, if present, specifies the id of the |
| 25130 | thread group in whose context the library was unloaded. If the field is |
| 25131 | absent, it means the library was unloaded in the context of all present |
| 25132 | thread groups. |
| 25133 | |
| 25134 | @end table |
| 25135 | |
| 25136 | @node GDB/MI Frame Information |
| 25137 | @subsection @sc{gdb/mi} Frame Information |
| 25138 | |
| 25139 | Response from many MI commands includes an information about stack |
| 25140 | frame. This information is a tuple that may have the following |
| 25141 | fields: |
| 25142 | |
| 25143 | @table @code |
| 25144 | @item level |
| 25145 | The level of the stack frame. The innermost frame has the level of |
| 25146 | zero. This field is always present. |
| 25147 | |
| 25148 | @item func |
| 25149 | The name of the function corresponding to the frame. This field may |
| 25150 | be absent if @value{GDBN} is unable to determine the function name. |
| 25151 | |
| 25152 | @item addr |
| 25153 | The code address for the frame. This field is always present. |
| 25154 | |
| 25155 | @item file |
| 25156 | The name of the source files that correspond to the frame's code |
| 25157 | address. This field may be absent. |
| 25158 | |
| 25159 | @item line |
| 25160 | The source line corresponding to the frames' code address. This field |
| 25161 | may be absent. |
| 25162 | |
| 25163 | @item from |
| 25164 | The name of the binary file (either executable or shared library) the |
| 25165 | corresponds to the frame's code address. This field may be absent. |
| 25166 | |
| 25167 | @end table |
| 25168 | |
| 25169 | @node GDB/MI Thread Information |
| 25170 | @subsection @sc{gdb/mi} Thread Information |
| 25171 | |
| 25172 | Whenever @value{GDBN} has to report an information about a thread, it |
| 25173 | uses a tuple with the following fields: |
| 25174 | |
| 25175 | @table @code |
| 25176 | @item id |
| 25177 | The numeric id assigned to the thread by @value{GDBN}. This field is |
| 25178 | always present. |
| 25179 | |
| 25180 | @item target-id |
| 25181 | Target-specific string identifying the thread. This field is always present. |
| 25182 | |
| 25183 | @item details |
| 25184 | Additional information about the thread provided by the target. |
| 25185 | It is supposed to be human-readable and not interpreted by the |
| 25186 | frontend. This field is optional. |
| 25187 | |
| 25188 | @item state |
| 25189 | Either @samp{stopped} or @samp{running}, depending on whether the |
| 25190 | thread is presently running. This field is always present. |
| 25191 | |
| 25192 | @item core |
| 25193 | The value of this field is an integer number of the processor core the |
| 25194 | thread was last seen on. This field is optional. |
| 25195 | @end table |
| 25196 | |
| 25197 | |
| 25198 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 25199 | @node GDB/MI Simple Examples |
| 25200 | @section Simple Examples of @sc{gdb/mi} Interaction |
| 25201 | @cindex @sc{gdb/mi}, simple examples |
| 25202 | |
| 25203 | This subsection presents several simple examples of interaction using |
| 25204 | the @sc{gdb/mi} interface. In these examples, @samp{->} means that the |
| 25205 | following line is passed to @sc{gdb/mi} as input, while @samp{<-} means |
| 25206 | the output received from @sc{gdb/mi}. |
| 25207 | |
| 25208 | Note the line breaks shown in the examples are here only for |
| 25209 | readability, they don't appear in the real output. |
| 25210 | |
| 25211 | @subheading Setting a Breakpoint |
| 25212 | |
| 25213 | Setting a breakpoint generates synchronous output which contains detailed |
| 25214 | information of the breakpoint. |
| 25215 | |
| 25216 | @smallexample |
| 25217 | -> -break-insert main |
| 25218 | <- ^done,bkpt=@{number="1",type="breakpoint",disp="keep", |
| 25219 | enabled="y",addr="0x08048564",func="main",file="myprog.c", |
| 25220 | fullname="/home/nickrob/myprog.c",line="68",times="0"@} |
| 25221 | <- (gdb) |
| 25222 | @end smallexample |
| 25223 | |
| 25224 | @subheading Program Execution |
| 25225 | |
| 25226 | Program execution generates asynchronous records and MI gives the |
| 25227 | reason that execution stopped. |
| 25228 | |
| 25229 | @smallexample |
| 25230 | -> -exec-run |
| 25231 | <- ^running |
| 25232 | <- (gdb) |
| 25233 | <- *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0", |
| 25234 | frame=@{addr="0x08048564",func="main", |
| 25235 | args=[@{name="argc",value="1"@},@{name="argv",value="0xbfc4d4d4"@}], |
| 25236 | file="myprog.c",fullname="/home/nickrob/myprog.c",line="68"@} |
| 25237 | <- (gdb) |
| 25238 | -> -exec-continue |
| 25239 | <- ^running |
| 25240 | <- (gdb) |
| 25241 | <- *stopped,reason="exited-normally" |
| 25242 | <- (gdb) |
| 25243 | @end smallexample |
| 25244 | |
| 25245 | @subheading Quitting @value{GDBN} |
| 25246 | |
| 25247 | Quitting @value{GDBN} just prints the result class @samp{^exit}. |
| 25248 | |
| 25249 | @smallexample |
| 25250 | -> (gdb) |
| 25251 | <- -gdb-exit |
| 25252 | <- ^exit |
| 25253 | @end smallexample |
| 25254 | |
| 25255 | Please note that @samp{^exit} is printed immediately, but it might |
| 25256 | take some time for @value{GDBN} to actually exit. During that time, @value{GDBN} |
| 25257 | performs necessary cleanups, including killing programs being debugged |
| 25258 | or disconnecting from debug hardware, so the frontend should wait till |
| 25259 | @value{GDBN} exits and should only forcibly kill @value{GDBN} if it |
| 25260 | fails to exit in reasonable time. |
| 25261 | |
| 25262 | @subheading A Bad Command |
| 25263 | |
| 25264 | Here's what happens if you pass a non-existent command: |
| 25265 | |
| 25266 | @smallexample |
| 25267 | -> -rubbish |
| 25268 | <- ^error,msg="Undefined MI command: rubbish" |
| 25269 | <- (gdb) |
| 25270 | @end smallexample |
| 25271 | |
| 25272 | |
| 25273 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 25274 | @node GDB/MI Command Description Format |
| 25275 | @section @sc{gdb/mi} Command Description Format |
| 25276 | |
| 25277 | The remaining sections describe blocks of commands. Each block of |
| 25278 | commands is laid out in a fashion similar to this section. |
| 25279 | |
| 25280 | @subheading Motivation |
| 25281 | |
| 25282 | The motivation for this collection of commands. |
| 25283 | |
| 25284 | @subheading Introduction |
| 25285 | |
| 25286 | A brief introduction to this collection of commands as a whole. |
| 25287 | |
| 25288 | @subheading Commands |
| 25289 | |
| 25290 | For each command in the block, the following is described: |
| 25291 | |
| 25292 | @subsubheading Synopsis |
| 25293 | |
| 25294 | @smallexample |
| 25295 | -command @var{args}@dots{} |
| 25296 | @end smallexample |
| 25297 | |
| 25298 | @subsubheading Result |
| 25299 | |
| 25300 | @subsubheading @value{GDBN} Command |
| 25301 | |
| 25302 | The corresponding @value{GDBN} CLI command(s), if any. |
| 25303 | |
| 25304 | @subsubheading Example |
| 25305 | |
| 25306 | Example(s) formatted for readability. Some of the described commands have |
| 25307 | not been implemented yet and these are labeled N.A.@: (not available). |
| 25308 | |
| 25309 | |
| 25310 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 25311 | @node GDB/MI Breakpoint Commands |
| 25312 | @section @sc{gdb/mi} Breakpoint Commands |
| 25313 | |
| 25314 | @cindex breakpoint commands for @sc{gdb/mi} |
| 25315 | @cindex @sc{gdb/mi}, breakpoint commands |
| 25316 | This section documents @sc{gdb/mi} commands for manipulating |
| 25317 | breakpoints. |
| 25318 | |
| 25319 | @subheading The @code{-break-after} Command |
| 25320 | @findex -break-after |
| 25321 | |
| 25322 | @subsubheading Synopsis |
| 25323 | |
| 25324 | @smallexample |
| 25325 | -break-after @var{number} @var{count} |
| 25326 | @end smallexample |
| 25327 | |
| 25328 | The breakpoint number @var{number} is not in effect until it has been |
| 25329 | hit @var{count} times. To see how this is reflected in the output of |
| 25330 | the @samp{-break-list} command, see the description of the |
| 25331 | @samp{-break-list} command below. |
| 25332 | |
| 25333 | @subsubheading @value{GDBN} Command |
| 25334 | |
| 25335 | The corresponding @value{GDBN} command is @samp{ignore}. |
| 25336 | |
| 25337 | @subsubheading Example |
| 25338 | |
| 25339 | @smallexample |
| 25340 | (gdb) |
| 25341 | -break-insert main |
| 25342 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep", |
| 25343 | enabled="y",addr="0x000100d0",func="main",file="hello.c", |
| 25344 | fullname="/home/foo/hello.c",line="5",times="0"@} |
| 25345 | (gdb) |
| 25346 | -break-after 1 3 |
| 25347 | ~ |
| 25348 | ^done |
| 25349 | (gdb) |
| 25350 | -break-list |
| 25351 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", |
| 25352 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25353 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25354 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25355 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25356 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25357 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25358 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25359 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
| 25360 | line="5",times="0",ignore="3"@}]@} |
| 25361 | (gdb) |
| 25362 | @end smallexample |
| 25363 | |
| 25364 | @ignore |
| 25365 | @subheading The @code{-break-catch} Command |
| 25366 | @findex -break-catch |
| 25367 | @end ignore |
| 25368 | |
| 25369 | @subheading The @code{-break-commands} Command |
| 25370 | @findex -break-commands |
| 25371 | |
| 25372 | @subsubheading Synopsis |
| 25373 | |
| 25374 | @smallexample |
| 25375 | -break-commands @var{number} [ @var{command1} ... @var{commandN} ] |
| 25376 | @end smallexample |
| 25377 | |
| 25378 | Specifies the CLI commands that should be executed when breakpoint |
| 25379 | @var{number} is hit. The parameters @var{command1} to @var{commandN} |
| 25380 | are the commands. If no command is specified, any previously-set |
| 25381 | commands are cleared. @xref{Break Commands}. Typical use of this |
| 25382 | functionality is tracing a program, that is, printing of values of |
| 25383 | some variables whenever breakpoint is hit and then continuing. |
| 25384 | |
| 25385 | @subsubheading @value{GDBN} Command |
| 25386 | |
| 25387 | The corresponding @value{GDBN} command is @samp{commands}. |
| 25388 | |
| 25389 | @subsubheading Example |
| 25390 | |
| 25391 | @smallexample |
| 25392 | (gdb) |
| 25393 | -break-insert main |
| 25394 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep", |
| 25395 | enabled="y",addr="0x000100d0",func="main",file="hello.c", |
| 25396 | fullname="/home/foo/hello.c",line="5",times="0"@} |
| 25397 | (gdb) |
| 25398 | -break-commands 1 "print v" "continue" |
| 25399 | ^done |
| 25400 | (gdb) |
| 25401 | @end smallexample |
| 25402 | |
| 25403 | @subheading The @code{-break-condition} Command |
| 25404 | @findex -break-condition |
| 25405 | |
| 25406 | @subsubheading Synopsis |
| 25407 | |
| 25408 | @smallexample |
| 25409 | -break-condition @var{number} @var{expr} |
| 25410 | @end smallexample |
| 25411 | |
| 25412 | Breakpoint @var{number} will stop the program only if the condition in |
| 25413 | @var{expr} is true. The condition becomes part of the |
| 25414 | @samp{-break-list} output (see the description of the @samp{-break-list} |
| 25415 | command below). |
| 25416 | |
| 25417 | @subsubheading @value{GDBN} Command |
| 25418 | |
| 25419 | The corresponding @value{GDBN} command is @samp{condition}. |
| 25420 | |
| 25421 | @subsubheading Example |
| 25422 | |
| 25423 | @smallexample |
| 25424 | (gdb) |
| 25425 | -break-condition 1 1 |
| 25426 | ^done |
| 25427 | (gdb) |
| 25428 | -break-list |
| 25429 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", |
| 25430 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25431 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25432 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25433 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25434 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25435 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25436 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25437 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
| 25438 | line="5",cond="1",times="0",ignore="3"@}]@} |
| 25439 | (gdb) |
| 25440 | @end smallexample |
| 25441 | |
| 25442 | @subheading The @code{-break-delete} Command |
| 25443 | @findex -break-delete |
| 25444 | |
| 25445 | @subsubheading Synopsis |
| 25446 | |
| 25447 | @smallexample |
| 25448 | -break-delete ( @var{breakpoint} )+ |
| 25449 | @end smallexample |
| 25450 | |
| 25451 | Delete the breakpoint(s) whose number(s) are specified in the argument |
| 25452 | list. This is obviously reflected in the breakpoint list. |
| 25453 | |
| 25454 | @subsubheading @value{GDBN} Command |
| 25455 | |
| 25456 | The corresponding @value{GDBN} command is @samp{delete}. |
| 25457 | |
| 25458 | @subsubheading Example |
| 25459 | |
| 25460 | @smallexample |
| 25461 | (gdb) |
| 25462 | -break-delete 1 |
| 25463 | ^done |
| 25464 | (gdb) |
| 25465 | -break-list |
| 25466 | ^done,BreakpointTable=@{nr_rows="0",nr_cols="6", |
| 25467 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25468 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25469 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25470 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25471 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25472 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25473 | body=[]@} |
| 25474 | (gdb) |
| 25475 | @end smallexample |
| 25476 | |
| 25477 | @subheading The @code{-break-disable} Command |
| 25478 | @findex -break-disable |
| 25479 | |
| 25480 | @subsubheading Synopsis |
| 25481 | |
| 25482 | @smallexample |
| 25483 | -break-disable ( @var{breakpoint} )+ |
| 25484 | @end smallexample |
| 25485 | |
| 25486 | Disable the named @var{breakpoint}(s). The field @samp{enabled} in the |
| 25487 | break list is now set to @samp{n} for the named @var{breakpoint}(s). |
| 25488 | |
| 25489 | @subsubheading @value{GDBN} Command |
| 25490 | |
| 25491 | The corresponding @value{GDBN} command is @samp{disable}. |
| 25492 | |
| 25493 | @subsubheading Example |
| 25494 | |
| 25495 | @smallexample |
| 25496 | (gdb) |
| 25497 | -break-disable 2 |
| 25498 | ^done |
| 25499 | (gdb) |
| 25500 | -break-list |
| 25501 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", |
| 25502 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25503 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25504 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25505 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25506 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25507 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25508 | body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="n", |
| 25509 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
| 25510 | line="5",times="0"@}]@} |
| 25511 | (gdb) |
| 25512 | @end smallexample |
| 25513 | |
| 25514 | @subheading The @code{-break-enable} Command |
| 25515 | @findex -break-enable |
| 25516 | |
| 25517 | @subsubheading Synopsis |
| 25518 | |
| 25519 | @smallexample |
| 25520 | -break-enable ( @var{breakpoint} )+ |
| 25521 | @end smallexample |
| 25522 | |
| 25523 | Enable (previously disabled) @var{breakpoint}(s). |
| 25524 | |
| 25525 | @subsubheading @value{GDBN} Command |
| 25526 | |
| 25527 | The corresponding @value{GDBN} command is @samp{enable}. |
| 25528 | |
| 25529 | @subsubheading Example |
| 25530 | |
| 25531 | @smallexample |
| 25532 | (gdb) |
| 25533 | -break-enable 2 |
| 25534 | ^done |
| 25535 | (gdb) |
| 25536 | -break-list |
| 25537 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", |
| 25538 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25539 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25540 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25541 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25542 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25543 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25544 | body=[bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y", |
| 25545 | addr="0x000100d0",func="main",file="hello.c",fullname="/home/foo/hello.c", |
| 25546 | line="5",times="0"@}]@} |
| 25547 | (gdb) |
| 25548 | @end smallexample |
| 25549 | |
| 25550 | @subheading The @code{-break-info} Command |
| 25551 | @findex -break-info |
| 25552 | |
| 25553 | @subsubheading Synopsis |
| 25554 | |
| 25555 | @smallexample |
| 25556 | -break-info @var{breakpoint} |
| 25557 | @end smallexample |
| 25558 | |
| 25559 | @c REDUNDANT??? |
| 25560 | Get information about a single breakpoint. |
| 25561 | |
| 25562 | @subsubheading @value{GDBN} Command |
| 25563 | |
| 25564 | The corresponding @value{GDBN} command is @samp{info break @var{breakpoint}}. |
| 25565 | |
| 25566 | @subsubheading Example |
| 25567 | N.A. |
| 25568 | |
| 25569 | @subheading The @code{-break-insert} Command |
| 25570 | @findex -break-insert |
| 25571 | |
| 25572 | @subsubheading Synopsis |
| 25573 | |
| 25574 | @smallexample |
| 25575 | -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ] |
| 25576 | [ -c @var{condition} ] [ -i @var{ignore-count} ] |
| 25577 | [ -p @var{thread} ] [ @var{location} ] |
| 25578 | @end smallexample |
| 25579 | |
| 25580 | @noindent |
| 25581 | If specified, @var{location}, can be one of: |
| 25582 | |
| 25583 | @itemize @bullet |
| 25584 | @item function |
| 25585 | @c @item +offset |
| 25586 | @c @item -offset |
| 25587 | @c @item linenum |
| 25588 | @item filename:linenum |
| 25589 | @item filename:function |
| 25590 | @item *address |
| 25591 | @end itemize |
| 25592 | |
| 25593 | The possible optional parameters of this command are: |
| 25594 | |
| 25595 | @table @samp |
| 25596 | @item -t |
| 25597 | Insert a temporary breakpoint. |
| 25598 | @item -h |
| 25599 | Insert a hardware breakpoint. |
| 25600 | @item -c @var{condition} |
| 25601 | Make the breakpoint conditional on @var{condition}. |
| 25602 | @item -i @var{ignore-count} |
| 25603 | Initialize the @var{ignore-count}. |
| 25604 | @item -f |
| 25605 | If @var{location} cannot be parsed (for example if it |
| 25606 | refers to unknown files or functions), create a pending |
| 25607 | breakpoint. Without this flag, @value{GDBN} will report |
| 25608 | an error, and won't create a breakpoint, if @var{location} |
| 25609 | cannot be parsed. |
| 25610 | @item -d |
| 25611 | Create a disabled breakpoint. |
| 25612 | @item -a |
| 25613 | Create a tracepoint. @xref{Tracepoints}. When this parameter |
| 25614 | is used together with @samp{-h}, a fast tracepoint is created. |
| 25615 | @end table |
| 25616 | |
| 25617 | @subsubheading Result |
| 25618 | |
| 25619 | The result is in the form: |
| 25620 | |
| 25621 | @smallexample |
| 25622 | ^done,bkpt=@{number="@var{number}",type="@var{type}",disp="del"|"keep", |
| 25623 | enabled="y"|"n",addr="@var{hex}",func="@var{funcname}",file="@var{filename}", |
| 25624 | fullname="@var{full_filename}",line="@var{lineno}",[thread="@var{threadno},] |
| 25625 | times="@var{times}"@} |
| 25626 | @end smallexample |
| 25627 | |
| 25628 | @noindent |
| 25629 | where @var{number} is the @value{GDBN} number for this breakpoint, |
| 25630 | @var{funcname} is the name of the function where the breakpoint was |
| 25631 | inserted, @var{filename} is the name of the source file which contains |
| 25632 | this function, @var{lineno} is the source line number within that file |
| 25633 | and @var{times} the number of times that the breakpoint has been hit |
| 25634 | (always 0 for -break-insert but may be greater for -break-info or -break-list |
| 25635 | which use the same output). |
| 25636 | |
| 25637 | Note: this format is open to change. |
| 25638 | @c An out-of-band breakpoint instead of part of the result? |
| 25639 | |
| 25640 | @subsubheading @value{GDBN} Command |
| 25641 | |
| 25642 | The corresponding @value{GDBN} commands are @samp{break}, @samp{tbreak}, |
| 25643 | @samp{hbreak}, @samp{thbreak}, and @samp{rbreak}. |
| 25644 | |
| 25645 | @subsubheading Example |
| 25646 | |
| 25647 | @smallexample |
| 25648 | (gdb) |
| 25649 | -break-insert main |
| 25650 | ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c", |
| 25651 | fullname="/home/foo/recursive2.c,line="4",times="0"@} |
| 25652 | (gdb) |
| 25653 | -break-insert -t foo |
| 25654 | ^done,bkpt=@{number="2",addr="0x00010774",file="recursive2.c", |
| 25655 | fullname="/home/foo/recursive2.c,line="11",times="0"@} |
| 25656 | (gdb) |
| 25657 | -break-list |
| 25658 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", |
| 25659 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25660 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25661 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25662 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25663 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25664 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25665 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25666 | addr="0x0001072c", func="main",file="recursive2.c", |
| 25667 | fullname="/home/foo/recursive2.c,"line="4",times="0"@}, |
| 25668 | bkpt=@{number="2",type="breakpoint",disp="del",enabled="y", |
| 25669 | addr="0x00010774",func="foo",file="recursive2.c", |
| 25670 | fullname="/home/foo/recursive2.c",line="11",times="0"@}]@} |
| 25671 | (gdb) |
| 25672 | -break-insert -r foo.* |
| 25673 | ~int foo(int, int); |
| 25674 | ^done,bkpt=@{number="3",addr="0x00010774",file="recursive2.c, |
| 25675 | "fullname="/home/foo/recursive2.c",line="11",times="0"@} |
| 25676 | (gdb) |
| 25677 | @end smallexample |
| 25678 | |
| 25679 | @subheading The @code{-break-list} Command |
| 25680 | @findex -break-list |
| 25681 | |
| 25682 | @subsubheading Synopsis |
| 25683 | |
| 25684 | @smallexample |
| 25685 | -break-list |
| 25686 | @end smallexample |
| 25687 | |
| 25688 | Displays the list of inserted breakpoints, showing the following fields: |
| 25689 | |
| 25690 | @table @samp |
| 25691 | @item Number |
| 25692 | number of the breakpoint |
| 25693 | @item Type |
| 25694 | type of the breakpoint: @samp{breakpoint} or @samp{watchpoint} |
| 25695 | @item Disposition |
| 25696 | should the breakpoint be deleted or disabled when it is hit: @samp{keep} |
| 25697 | or @samp{nokeep} |
| 25698 | @item Enabled |
| 25699 | is the breakpoint enabled or no: @samp{y} or @samp{n} |
| 25700 | @item Address |
| 25701 | memory location at which the breakpoint is set |
| 25702 | @item What |
| 25703 | logical location of the breakpoint, expressed by function name, file |
| 25704 | name, line number |
| 25705 | @item Times |
| 25706 | number of times the breakpoint has been hit |
| 25707 | @end table |
| 25708 | |
| 25709 | If there are no breakpoints or watchpoints, the @code{BreakpointTable} |
| 25710 | @code{body} field is an empty list. |
| 25711 | |
| 25712 | @subsubheading @value{GDBN} Command |
| 25713 | |
| 25714 | The corresponding @value{GDBN} command is @samp{info break}. |
| 25715 | |
| 25716 | @subsubheading Example |
| 25717 | |
| 25718 | @smallexample |
| 25719 | (gdb) |
| 25720 | -break-list |
| 25721 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", |
| 25722 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25723 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25724 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25725 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25726 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25727 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25728 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25729 | addr="0x000100d0",func="main",file="hello.c",line="5",times="0"@}, |
| 25730 | bkpt=@{number="2",type="breakpoint",disp="keep",enabled="y", |
| 25731 | addr="0x00010114",func="foo",file="hello.c",fullname="/home/foo/hello.c", |
| 25732 | line="13",times="0"@}]@} |
| 25733 | (gdb) |
| 25734 | @end smallexample |
| 25735 | |
| 25736 | Here's an example of the result when there are no breakpoints: |
| 25737 | |
| 25738 | @smallexample |
| 25739 | (gdb) |
| 25740 | -break-list |
| 25741 | ^done,BreakpointTable=@{nr_rows="0",nr_cols="6", |
| 25742 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25743 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25744 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25745 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25746 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25747 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25748 | body=[]@} |
| 25749 | (gdb) |
| 25750 | @end smallexample |
| 25751 | |
| 25752 | @subheading The @code{-break-passcount} Command |
| 25753 | @findex -break-passcount |
| 25754 | |
| 25755 | @subsubheading Synopsis |
| 25756 | |
| 25757 | @smallexample |
| 25758 | -break-passcount @var{tracepoint-number} @var{passcount} |
| 25759 | @end smallexample |
| 25760 | |
| 25761 | Set the passcount for tracepoint @var{tracepoint-number} to |
| 25762 | @var{passcount}. If the breakpoint referred to by @var{tracepoint-number} |
| 25763 | is not a tracepoint, error is emitted. This corresponds to CLI |
| 25764 | command @samp{passcount}. |
| 25765 | |
| 25766 | @subheading The @code{-break-watch} Command |
| 25767 | @findex -break-watch |
| 25768 | |
| 25769 | @subsubheading Synopsis |
| 25770 | |
| 25771 | @smallexample |
| 25772 | -break-watch [ -a | -r ] |
| 25773 | @end smallexample |
| 25774 | |
| 25775 | Create a watchpoint. With the @samp{-a} option it will create an |
| 25776 | @dfn{access} watchpoint, i.e., a watchpoint that triggers either on a |
| 25777 | read from or on a write to the memory location. With the @samp{-r} |
| 25778 | option, the watchpoint created is a @dfn{read} watchpoint, i.e., it will |
| 25779 | trigger only when the memory location is accessed for reading. Without |
| 25780 | either of the options, the watchpoint created is a regular watchpoint, |
| 25781 | i.e., it will trigger when the memory location is accessed for writing. |
| 25782 | @xref{Set Watchpoints, , Setting Watchpoints}. |
| 25783 | |
| 25784 | Note that @samp{-break-list} will report a single list of watchpoints and |
| 25785 | breakpoints inserted. |
| 25786 | |
| 25787 | @subsubheading @value{GDBN} Command |
| 25788 | |
| 25789 | The corresponding @value{GDBN} commands are @samp{watch}, @samp{awatch}, and |
| 25790 | @samp{rwatch}. |
| 25791 | |
| 25792 | @subsubheading Example |
| 25793 | |
| 25794 | Setting a watchpoint on a variable in the @code{main} function: |
| 25795 | |
| 25796 | @smallexample |
| 25797 | (gdb) |
| 25798 | -break-watch x |
| 25799 | ^done,wpt=@{number="2",exp="x"@} |
| 25800 | (gdb) |
| 25801 | -exec-continue |
| 25802 | ^running |
| 25803 | (gdb) |
| 25804 | *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="x"@}, |
| 25805 | value=@{old="-268439212",new="55"@}, |
| 25806 | frame=@{func="main",args=[],file="recursive2.c", |
| 25807 | fullname="/home/foo/bar/recursive2.c",line="5"@} |
| 25808 | (gdb) |
| 25809 | @end smallexample |
| 25810 | |
| 25811 | Setting a watchpoint on a variable local to a function. @value{GDBN} will stop |
| 25812 | the program execution twice: first for the variable changing value, then |
| 25813 | for the watchpoint going out of scope. |
| 25814 | |
| 25815 | @smallexample |
| 25816 | (gdb) |
| 25817 | -break-watch C |
| 25818 | ^done,wpt=@{number="5",exp="C"@} |
| 25819 | (gdb) |
| 25820 | -exec-continue |
| 25821 | ^running |
| 25822 | (gdb) |
| 25823 | *stopped,reason="watchpoint-trigger", |
| 25824 | wpt=@{number="5",exp="C"@},value=@{old="-276895068",new="3"@}, |
| 25825 | frame=@{func="callee4",args=[], |
| 25826 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25827 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@} |
| 25828 | (gdb) |
| 25829 | -exec-continue |
| 25830 | ^running |
| 25831 | (gdb) |
| 25832 | *stopped,reason="watchpoint-scope",wpnum="5", |
| 25833 | frame=@{func="callee3",args=[@{name="strarg", |
| 25834 | value="0x11940 \"A string argument.\""@}], |
| 25835 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25836 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} |
| 25837 | (gdb) |
| 25838 | @end smallexample |
| 25839 | |
| 25840 | Listing breakpoints and watchpoints, at different points in the program |
| 25841 | execution. Note that once the watchpoint goes out of scope, it is |
| 25842 | deleted. |
| 25843 | |
| 25844 | @smallexample |
| 25845 | (gdb) |
| 25846 | -break-watch C |
| 25847 | ^done,wpt=@{number="2",exp="C"@} |
| 25848 | (gdb) |
| 25849 | -break-list |
| 25850 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", |
| 25851 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25852 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25853 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25854 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25855 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25856 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25857 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25858 | addr="0x00010734",func="callee4", |
| 25859 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25860 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c"line="8",times="1"@}, |
| 25861 | bkpt=@{number="2",type="watchpoint",disp="keep", |
| 25862 | enabled="y",addr="",what="C",times="0"@}]@} |
| 25863 | (gdb) |
| 25864 | -exec-continue |
| 25865 | ^running |
| 25866 | (gdb) |
| 25867 | *stopped,reason="watchpoint-trigger",wpt=@{number="2",exp="C"@}, |
| 25868 | value=@{old="-276895068",new="3"@}, |
| 25869 | frame=@{func="callee4",args=[], |
| 25870 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25871 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="13"@} |
| 25872 | (gdb) |
| 25873 | -break-list |
| 25874 | ^done,BreakpointTable=@{nr_rows="2",nr_cols="6", |
| 25875 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25876 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25877 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25878 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25879 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25880 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25881 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25882 | addr="0x00010734",func="callee4", |
| 25883 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25884 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8",times="1"@}, |
| 25885 | bkpt=@{number="2",type="watchpoint",disp="keep", |
| 25886 | enabled="y",addr="",what="C",times="-5"@}]@} |
| 25887 | (gdb) |
| 25888 | -exec-continue |
| 25889 | ^running |
| 25890 | ^done,reason="watchpoint-scope",wpnum="2", |
| 25891 | frame=@{func="callee3",args=[@{name="strarg", |
| 25892 | value="0x11940 \"A string argument.\""@}], |
| 25893 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25894 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} |
| 25895 | (gdb) |
| 25896 | -break-list |
| 25897 | ^done,BreakpointTable=@{nr_rows="1",nr_cols="6", |
| 25898 | hdr=[@{width="3",alignment="-1",col_name="number",colhdr="Num"@}, |
| 25899 | @{width="14",alignment="-1",col_name="type",colhdr="Type"@}, |
| 25900 | @{width="4",alignment="-1",col_name="disp",colhdr="Disp"@}, |
| 25901 | @{width="3",alignment="-1",col_name="enabled",colhdr="Enb"@}, |
| 25902 | @{width="10",alignment="-1",col_name="addr",colhdr="Address"@}, |
| 25903 | @{width="40",alignment="2",col_name="what",colhdr="What"@}], |
| 25904 | body=[bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 25905 | addr="0x00010734",func="callee4", |
| 25906 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 25907 | fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics.c",line="8", |
| 25908 | times="1"@}]@} |
| 25909 | (gdb) |
| 25910 | @end smallexample |
| 25911 | |
| 25912 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 25913 | @node GDB/MI Program Context |
| 25914 | @section @sc{gdb/mi} Program Context |
| 25915 | |
| 25916 | @subheading The @code{-exec-arguments} Command |
| 25917 | @findex -exec-arguments |
| 25918 | |
| 25919 | |
| 25920 | @subsubheading Synopsis |
| 25921 | |
| 25922 | @smallexample |
| 25923 | -exec-arguments @var{args} |
| 25924 | @end smallexample |
| 25925 | |
| 25926 | Set the inferior program arguments, to be used in the next |
| 25927 | @samp{-exec-run}. |
| 25928 | |
| 25929 | @subsubheading @value{GDBN} Command |
| 25930 | |
| 25931 | The corresponding @value{GDBN} command is @samp{set args}. |
| 25932 | |
| 25933 | @subsubheading Example |
| 25934 | |
| 25935 | @smallexample |
| 25936 | (gdb) |
| 25937 | -exec-arguments -v word |
| 25938 | ^done |
| 25939 | (gdb) |
| 25940 | @end smallexample |
| 25941 | |
| 25942 | |
| 25943 | @ignore |
| 25944 | @subheading The @code{-exec-show-arguments} Command |
| 25945 | @findex -exec-show-arguments |
| 25946 | |
| 25947 | @subsubheading Synopsis |
| 25948 | |
| 25949 | @smallexample |
| 25950 | -exec-show-arguments |
| 25951 | @end smallexample |
| 25952 | |
| 25953 | Print the arguments of the program. |
| 25954 | |
| 25955 | @subsubheading @value{GDBN} Command |
| 25956 | |
| 25957 | The corresponding @value{GDBN} command is @samp{show args}. |
| 25958 | |
| 25959 | @subsubheading Example |
| 25960 | N.A. |
| 25961 | @end ignore |
| 25962 | |
| 25963 | |
| 25964 | @subheading The @code{-environment-cd} Command |
| 25965 | @findex -environment-cd |
| 25966 | |
| 25967 | @subsubheading Synopsis |
| 25968 | |
| 25969 | @smallexample |
| 25970 | -environment-cd @var{pathdir} |
| 25971 | @end smallexample |
| 25972 | |
| 25973 | Set @value{GDBN}'s working directory. |
| 25974 | |
| 25975 | @subsubheading @value{GDBN} Command |
| 25976 | |
| 25977 | The corresponding @value{GDBN} command is @samp{cd}. |
| 25978 | |
| 25979 | @subsubheading Example |
| 25980 | |
| 25981 | @smallexample |
| 25982 | (gdb) |
| 25983 | -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb |
| 25984 | ^done |
| 25985 | (gdb) |
| 25986 | @end smallexample |
| 25987 | |
| 25988 | |
| 25989 | @subheading The @code{-environment-directory} Command |
| 25990 | @findex -environment-directory |
| 25991 | |
| 25992 | @subsubheading Synopsis |
| 25993 | |
| 25994 | @smallexample |
| 25995 | -environment-directory [ -r ] [ @var{pathdir} ]+ |
| 25996 | @end smallexample |
| 25997 | |
| 25998 | Add directories @var{pathdir} to beginning of search path for source files. |
| 25999 | If the @samp{-r} option is used, the search path is reset to the default |
| 26000 | search path. If directories @var{pathdir} are supplied in addition to the |
| 26001 | @samp{-r} option, the search path is first reset and then addition |
| 26002 | occurs as normal. |
| 26003 | Multiple directories may be specified, separated by blanks. Specifying |
| 26004 | multiple directories in a single command |
| 26005 | results in the directories added to the beginning of the |
| 26006 | search path in the same order they were presented in the command. |
| 26007 | If blanks are needed as |
| 26008 | part of a directory name, double-quotes should be used around |
| 26009 | the name. In the command output, the path will show up separated |
| 26010 | by the system directory-separator character. The directory-separator |
| 26011 | character must not be used |
| 26012 | in any directory name. |
| 26013 | If no directories are specified, the current search path is displayed. |
| 26014 | |
| 26015 | @subsubheading @value{GDBN} Command |
| 26016 | |
| 26017 | The corresponding @value{GDBN} command is @samp{dir}. |
| 26018 | |
| 26019 | @subsubheading Example |
| 26020 | |
| 26021 | @smallexample |
| 26022 | (gdb) |
| 26023 | -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb |
| 26024 | ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" |
| 26025 | (gdb) |
| 26026 | -environment-directory "" |
| 26027 | ^done,source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" |
| 26028 | (gdb) |
| 26029 | -environment-directory -r /home/jjohnstn/src/gdb /usr/src |
| 26030 | ^done,source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd" |
| 26031 | (gdb) |
| 26032 | -environment-directory -r |
| 26033 | ^done,source-path="$cdir:$cwd" |
| 26034 | (gdb) |
| 26035 | @end smallexample |
| 26036 | |
| 26037 | |
| 26038 | @subheading The @code{-environment-path} Command |
| 26039 | @findex -environment-path |
| 26040 | |
| 26041 | @subsubheading Synopsis |
| 26042 | |
| 26043 | @smallexample |
| 26044 | -environment-path [ -r ] [ @var{pathdir} ]+ |
| 26045 | @end smallexample |
| 26046 | |
| 26047 | Add directories @var{pathdir} to beginning of search path for object files. |
| 26048 | If the @samp{-r} option is used, the search path is reset to the original |
| 26049 | search path that existed at gdb start-up. If directories @var{pathdir} are |
| 26050 | supplied in addition to the |
| 26051 | @samp{-r} option, the search path is first reset and then addition |
| 26052 | occurs as normal. |
| 26053 | Multiple directories may be specified, separated by blanks. Specifying |
| 26054 | multiple directories in a single command |
| 26055 | results in the directories added to the beginning of the |
| 26056 | search path in the same order they were presented in the command. |
| 26057 | If blanks are needed as |
| 26058 | part of a directory name, double-quotes should be used around |
| 26059 | the name. In the command output, the path will show up separated |
| 26060 | by the system directory-separator character. The directory-separator |
| 26061 | character must not be used |
| 26062 | in any directory name. |
| 26063 | If no directories are specified, the current path is displayed. |
| 26064 | |
| 26065 | |
| 26066 | @subsubheading @value{GDBN} Command |
| 26067 | |
| 26068 | The corresponding @value{GDBN} command is @samp{path}. |
| 26069 | |
| 26070 | @subsubheading Example |
| 26071 | |
| 26072 | @smallexample |
| 26073 | (gdb) |
| 26074 | -environment-path |
| 26075 | ^done,path="/usr/bin" |
| 26076 | (gdb) |
| 26077 | -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin |
| 26078 | ^done,path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin" |
| 26079 | (gdb) |
| 26080 | -environment-path -r /usr/local/bin |
| 26081 | ^done,path="/usr/local/bin:/usr/bin" |
| 26082 | (gdb) |
| 26083 | @end smallexample |
| 26084 | |
| 26085 | |
| 26086 | @subheading The @code{-environment-pwd} Command |
| 26087 | @findex -environment-pwd |
| 26088 | |
| 26089 | @subsubheading Synopsis |
| 26090 | |
| 26091 | @smallexample |
| 26092 | -environment-pwd |
| 26093 | @end smallexample |
| 26094 | |
| 26095 | Show the current working directory. |
| 26096 | |
| 26097 | @subsubheading @value{GDBN} Command |
| 26098 | |
| 26099 | The corresponding @value{GDBN} command is @samp{pwd}. |
| 26100 | |
| 26101 | @subsubheading Example |
| 26102 | |
| 26103 | @smallexample |
| 26104 | (gdb) |
| 26105 | -environment-pwd |
| 26106 | ^done,cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb" |
| 26107 | (gdb) |
| 26108 | @end smallexample |
| 26109 | |
| 26110 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 26111 | @node GDB/MI Thread Commands |
| 26112 | @section @sc{gdb/mi} Thread Commands |
| 26113 | |
| 26114 | |
| 26115 | @subheading The @code{-thread-info} Command |
| 26116 | @findex -thread-info |
| 26117 | |
| 26118 | @subsubheading Synopsis |
| 26119 | |
| 26120 | @smallexample |
| 26121 | -thread-info [ @var{thread-id} ] |
| 26122 | @end smallexample |
| 26123 | |
| 26124 | Reports information about either a specific thread, if |
| 26125 | the @var{thread-id} parameter is present, or about all |
| 26126 | threads. When printing information about all threads, |
| 26127 | also reports the current thread. |
| 26128 | |
| 26129 | @subsubheading @value{GDBN} Command |
| 26130 | |
| 26131 | The @samp{info thread} command prints the same information |
| 26132 | about all threads. |
| 26133 | |
| 26134 | @subsubheading Result |
| 26135 | |
| 26136 | The result is a list of threads. The following attributes are |
| 26137 | defined for a given thread: |
| 26138 | |
| 26139 | @table @samp |
| 26140 | @item current |
| 26141 | This field exists only for the current thread. It has the value @samp{*}. |
| 26142 | |
| 26143 | @item id |
| 26144 | The identifier that @value{GDBN} uses to refer to the thread. |
| 26145 | |
| 26146 | @item target-id |
| 26147 | The identifier that the target uses to refer to the thread. |
| 26148 | |
| 26149 | @item details |
| 26150 | Extra information about the thread, in a target-specific format. This |
| 26151 | field is optional. |
| 26152 | |
| 26153 | @item name |
| 26154 | The name of the thread. If the user specified a name using the |
| 26155 | @code{thread name} command, then this name is given. Otherwise, if |
| 26156 | @value{GDBN} can extract the thread name from the target, then that |
| 26157 | name is given. If @value{GDBN} cannot find the thread name, then this |
| 26158 | field is omitted. |
| 26159 | |
| 26160 | @item frame |
| 26161 | The stack frame currently executing in the thread. |
| 26162 | |
| 26163 | @item state |
| 26164 | The thread's state. The @samp{state} field may have the following |
| 26165 | values: |
| 26166 | |
| 26167 | @table @code |
| 26168 | @item stopped |
| 26169 | The thread is stopped. Frame information is available for stopped |
| 26170 | threads. |
| 26171 | |
| 26172 | @item running |
| 26173 | The thread is running. There's no frame information for running |
| 26174 | threads. |
| 26175 | |
| 26176 | @end table |
| 26177 | |
| 26178 | @item core |
| 26179 | If @value{GDBN} can find the CPU core on which this thread is running, |
| 26180 | then this field is the core identifier. This field is optional. |
| 26181 | |
| 26182 | @end table |
| 26183 | |
| 26184 | @subsubheading Example |
| 26185 | |
| 26186 | @smallexample |
| 26187 | -thread-info |
| 26188 | ^done,threads=[ |
| 26189 | @{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)", |
| 26190 | frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall", |
| 26191 | args=[]@},state="running"@}, |
| 26192 | @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)", |
| 26193 | frame=@{level="0",addr="0x0804891f",func="foo", |
| 26194 | args=[@{name="i",value="10"@}], |
| 26195 | file="/tmp/a.c",fullname="/tmp/a.c",line="158"@}, |
| 26196 | state="running"@}], |
| 26197 | current-thread-id="1" |
| 26198 | (gdb) |
| 26199 | @end smallexample |
| 26200 | |
| 26201 | @subheading The @code{-thread-list-ids} Command |
| 26202 | @findex -thread-list-ids |
| 26203 | |
| 26204 | @subsubheading Synopsis |
| 26205 | |
| 26206 | @smallexample |
| 26207 | -thread-list-ids |
| 26208 | @end smallexample |
| 26209 | |
| 26210 | Produces a list of the currently known @value{GDBN} thread ids. At the |
| 26211 | end of the list it also prints the total number of such threads. |
| 26212 | |
| 26213 | This command is retained for historical reasons, the |
| 26214 | @code{-thread-info} command should be used instead. |
| 26215 | |
| 26216 | @subsubheading @value{GDBN} Command |
| 26217 | |
| 26218 | Part of @samp{info threads} supplies the same information. |
| 26219 | |
| 26220 | @subsubheading Example |
| 26221 | |
| 26222 | @smallexample |
| 26223 | (gdb) |
| 26224 | -thread-list-ids |
| 26225 | ^done,thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@}, |
| 26226 | current-thread-id="1",number-of-threads="3" |
| 26227 | (gdb) |
| 26228 | @end smallexample |
| 26229 | |
| 26230 | |
| 26231 | @subheading The @code{-thread-select} Command |
| 26232 | @findex -thread-select |
| 26233 | |
| 26234 | @subsubheading Synopsis |
| 26235 | |
| 26236 | @smallexample |
| 26237 | -thread-select @var{threadnum} |
| 26238 | @end smallexample |
| 26239 | |
| 26240 | Make @var{threadnum} the current thread. It prints the number of the new |
| 26241 | current thread, and the topmost frame for that thread. |
| 26242 | |
| 26243 | This command is deprecated in favor of explicitly using the |
| 26244 | @samp{--thread} option to each command. |
| 26245 | |
| 26246 | @subsubheading @value{GDBN} Command |
| 26247 | |
| 26248 | The corresponding @value{GDBN} command is @samp{thread}. |
| 26249 | |
| 26250 | @subsubheading Example |
| 26251 | |
| 26252 | @smallexample |
| 26253 | (gdb) |
| 26254 | -exec-next |
| 26255 | ^running |
| 26256 | (gdb) |
| 26257 | *stopped,reason="end-stepping-range",thread-id="2",line="187", |
| 26258 | file="../../../devo/gdb/testsuite/gdb.threads/linux-dp.c" |
| 26259 | (gdb) |
| 26260 | -thread-list-ids |
| 26261 | ^done, |
| 26262 | thread-ids=@{thread-id="3",thread-id="2",thread-id="1"@}, |
| 26263 | number-of-threads="3" |
| 26264 | (gdb) |
| 26265 | -thread-select 3 |
| 26266 | ^done,new-thread-id="3", |
| 26267 | frame=@{level="0",func="vprintf", |
| 26268 | args=[@{name="format",value="0x8048e9c \"%*s%c %d %c\\n\""@}, |
| 26269 | @{name="arg",value="0x2"@}],file="vprintf.c",line="31"@} |
| 26270 | (gdb) |
| 26271 | @end smallexample |
| 26272 | |
| 26273 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 26274 | @node GDB/MI Program Execution |
| 26275 | @section @sc{gdb/mi} Program Execution |
| 26276 | |
| 26277 | These are the asynchronous commands which generate the out-of-band |
| 26278 | record @samp{*stopped}. Currently @value{GDBN} only really executes |
| 26279 | asynchronously with remote targets and this interaction is mimicked in |
| 26280 | other cases. |
| 26281 | |
| 26282 | @subheading The @code{-exec-continue} Command |
| 26283 | @findex -exec-continue |
| 26284 | |
| 26285 | @subsubheading Synopsis |
| 26286 | |
| 26287 | @smallexample |
| 26288 | -exec-continue [--reverse] [--all|--thread-group N] |
| 26289 | @end smallexample |
| 26290 | |
| 26291 | Resumes the execution of the inferior program, which will continue |
| 26292 | to execute until it reaches a debugger stop event. If the |
| 26293 | @samp{--reverse} option is specified, execution resumes in reverse until |
| 26294 | it reaches a stop event. Stop events may include |
| 26295 | @itemize @bullet |
| 26296 | @item |
| 26297 | breakpoints or watchpoints |
| 26298 | @item |
| 26299 | signals or exceptions |
| 26300 | @item |
| 26301 | the end of the process (or its beginning under @samp{--reverse}) |
| 26302 | @item |
| 26303 | the end or beginning of a replay log if one is being used. |
| 26304 | @end itemize |
| 26305 | In all-stop mode (@pxref{All-Stop |
| 26306 | Mode}), may resume only one thread, or all threads, depending on the |
| 26307 | value of the @samp{scheduler-locking} variable. If @samp{--all} is |
| 26308 | specified, all threads (in all inferiors) will be resumed. The @samp{--all} option is |
| 26309 | ignored in all-stop mode. If the @samp{--thread-group} options is |
| 26310 | specified, then all threads in that thread group are resumed. |
| 26311 | |
| 26312 | @subsubheading @value{GDBN} Command |
| 26313 | |
| 26314 | The corresponding @value{GDBN} corresponding is @samp{continue}. |
| 26315 | |
| 26316 | @subsubheading Example |
| 26317 | |
| 26318 | @smallexample |
| 26319 | -exec-continue |
| 26320 | ^running |
| 26321 | (gdb) |
| 26322 | @@Hello world |
| 26323 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="2",frame=@{ |
| 26324 | func="foo",args=[],file="hello.c",fullname="/home/foo/bar/hello.c", |
| 26325 | line="13"@} |
| 26326 | (gdb) |
| 26327 | @end smallexample |
| 26328 | |
| 26329 | |
| 26330 | @subheading The @code{-exec-finish} Command |
| 26331 | @findex -exec-finish |
| 26332 | |
| 26333 | @subsubheading Synopsis |
| 26334 | |
| 26335 | @smallexample |
| 26336 | -exec-finish [--reverse] |
| 26337 | @end smallexample |
| 26338 | |
| 26339 | Resumes the execution of the inferior program until the current |
| 26340 | function is exited. Displays the results returned by the function. |
| 26341 | If the @samp{--reverse} option is specified, resumes the reverse |
| 26342 | execution of the inferior program until the point where current |
| 26343 | function was called. |
| 26344 | |
| 26345 | @subsubheading @value{GDBN} Command |
| 26346 | |
| 26347 | The corresponding @value{GDBN} command is @samp{finish}. |
| 26348 | |
| 26349 | @subsubheading Example |
| 26350 | |
| 26351 | Function returning @code{void}. |
| 26352 | |
| 26353 | @smallexample |
| 26354 | -exec-finish |
| 26355 | ^running |
| 26356 | (gdb) |
| 26357 | @@hello from foo |
| 26358 | *stopped,reason="function-finished",frame=@{func="main",args=[], |
| 26359 | file="hello.c",fullname="/home/foo/bar/hello.c",line="7"@} |
| 26360 | (gdb) |
| 26361 | @end smallexample |
| 26362 | |
| 26363 | Function returning other than @code{void}. The name of the internal |
| 26364 | @value{GDBN} variable storing the result is printed, together with the |
| 26365 | value itself. |
| 26366 | |
| 26367 | @smallexample |
| 26368 | -exec-finish |
| 26369 | ^running |
| 26370 | (gdb) |
| 26371 | *stopped,reason="function-finished",frame=@{addr="0x000107b0",func="foo", |
| 26372 | args=[@{name="a",value="1"],@{name="b",value="9"@}@}, |
| 26373 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 26374 | gdb-result-var="$1",return-value="0" |
| 26375 | (gdb) |
| 26376 | @end smallexample |
| 26377 | |
| 26378 | |
| 26379 | @subheading The @code{-exec-interrupt} Command |
| 26380 | @findex -exec-interrupt |
| 26381 | |
| 26382 | @subsubheading Synopsis |
| 26383 | |
| 26384 | @smallexample |
| 26385 | -exec-interrupt [--all|--thread-group N] |
| 26386 | @end smallexample |
| 26387 | |
| 26388 | Interrupts the background execution of the target. Note how the token |
| 26389 | associated with the stop message is the one for the execution command |
| 26390 | that has been interrupted. The token for the interrupt itself only |
| 26391 | appears in the @samp{^done} output. If the user is trying to |
| 26392 | interrupt a non-running program, an error message will be printed. |
| 26393 | |
| 26394 | Note that when asynchronous execution is enabled, this command is |
| 26395 | asynchronous just like other execution commands. That is, first the |
| 26396 | @samp{^done} response will be printed, and the target stop will be |
| 26397 | reported after that using the @samp{*stopped} notification. |
| 26398 | |
| 26399 | In non-stop mode, only the context thread is interrupted by default. |
| 26400 | All threads (in all inferiors) will be interrupted if the |
| 26401 | @samp{--all} option is specified. If the @samp{--thread-group} |
| 26402 | option is specified, all threads in that group will be interrupted. |
| 26403 | |
| 26404 | @subsubheading @value{GDBN} Command |
| 26405 | |
| 26406 | The corresponding @value{GDBN} command is @samp{interrupt}. |
| 26407 | |
| 26408 | @subsubheading Example |
| 26409 | |
| 26410 | @smallexample |
| 26411 | (gdb) |
| 26412 | 111-exec-continue |
| 26413 | 111^running |
| 26414 | |
| 26415 | (gdb) |
| 26416 | 222-exec-interrupt |
| 26417 | 222^done |
| 26418 | (gdb) |
| 26419 | 111*stopped,signal-name="SIGINT",signal-meaning="Interrupt", |
| 26420 | frame=@{addr="0x00010140",func="foo",args=[],file="try.c", |
| 26421 | fullname="/home/foo/bar/try.c",line="13"@} |
| 26422 | (gdb) |
| 26423 | |
| 26424 | (gdb) |
| 26425 | -exec-interrupt |
| 26426 | ^error,msg="mi_cmd_exec_interrupt: Inferior not executing." |
| 26427 | (gdb) |
| 26428 | @end smallexample |
| 26429 | |
| 26430 | @subheading The @code{-exec-jump} Command |
| 26431 | @findex -exec-jump |
| 26432 | |
| 26433 | @subsubheading Synopsis |
| 26434 | |
| 26435 | @smallexample |
| 26436 | -exec-jump @var{location} |
| 26437 | @end smallexample |
| 26438 | |
| 26439 | Resumes execution of the inferior program at the location specified by |
| 26440 | parameter. @xref{Specify Location}, for a description of the |
| 26441 | different forms of @var{location}. |
| 26442 | |
| 26443 | @subsubheading @value{GDBN} Command |
| 26444 | |
| 26445 | The corresponding @value{GDBN} command is @samp{jump}. |
| 26446 | |
| 26447 | @subsubheading Example |
| 26448 | |
| 26449 | @smallexample |
| 26450 | -exec-jump foo.c:10 |
| 26451 | *running,thread-id="all" |
| 26452 | ^running |
| 26453 | @end smallexample |
| 26454 | |
| 26455 | |
| 26456 | @subheading The @code{-exec-next} Command |
| 26457 | @findex -exec-next |
| 26458 | |
| 26459 | @subsubheading Synopsis |
| 26460 | |
| 26461 | @smallexample |
| 26462 | -exec-next [--reverse] |
| 26463 | @end smallexample |
| 26464 | |
| 26465 | Resumes execution of the inferior program, stopping when the beginning |
| 26466 | of the next source line is reached. |
| 26467 | |
| 26468 | If the @samp{--reverse} option is specified, resumes reverse execution |
| 26469 | of the inferior program, stopping at the beginning of the previous |
| 26470 | source line. If you issue this command on the first line of a |
| 26471 | function, it will take you back to the caller of that function, to the |
| 26472 | source line where the function was called. |
| 26473 | |
| 26474 | |
| 26475 | @subsubheading @value{GDBN} Command |
| 26476 | |
| 26477 | The corresponding @value{GDBN} command is @samp{next}. |
| 26478 | |
| 26479 | @subsubheading Example |
| 26480 | |
| 26481 | @smallexample |
| 26482 | -exec-next |
| 26483 | ^running |
| 26484 | (gdb) |
| 26485 | *stopped,reason="end-stepping-range",line="8",file="hello.c" |
| 26486 | (gdb) |
| 26487 | @end smallexample |
| 26488 | |
| 26489 | |
| 26490 | @subheading The @code{-exec-next-instruction} Command |
| 26491 | @findex -exec-next-instruction |
| 26492 | |
| 26493 | @subsubheading Synopsis |
| 26494 | |
| 26495 | @smallexample |
| 26496 | -exec-next-instruction [--reverse] |
| 26497 | @end smallexample |
| 26498 | |
| 26499 | Executes one machine instruction. If the instruction is a function |
| 26500 | call, continues until the function returns. If the program stops at an |
| 26501 | instruction in the middle of a source line, the address will be |
| 26502 | printed as well. |
| 26503 | |
| 26504 | If the @samp{--reverse} option is specified, resumes reverse execution |
| 26505 | of the inferior program, stopping at the previous instruction. If the |
| 26506 | previously executed instruction was a return from another function, |
| 26507 | it will continue to execute in reverse until the call to that function |
| 26508 | (from the current stack frame) is reached. |
| 26509 | |
| 26510 | @subsubheading @value{GDBN} Command |
| 26511 | |
| 26512 | The corresponding @value{GDBN} command is @samp{nexti}. |
| 26513 | |
| 26514 | @subsubheading Example |
| 26515 | |
| 26516 | @smallexample |
| 26517 | (gdb) |
| 26518 | -exec-next-instruction |
| 26519 | ^running |
| 26520 | |
| 26521 | (gdb) |
| 26522 | *stopped,reason="end-stepping-range", |
| 26523 | addr="0x000100d4",line="5",file="hello.c" |
| 26524 | (gdb) |
| 26525 | @end smallexample |
| 26526 | |
| 26527 | |
| 26528 | @subheading The @code{-exec-return} Command |
| 26529 | @findex -exec-return |
| 26530 | |
| 26531 | @subsubheading Synopsis |
| 26532 | |
| 26533 | @smallexample |
| 26534 | -exec-return |
| 26535 | @end smallexample |
| 26536 | |
| 26537 | Makes current function return immediately. Doesn't execute the inferior. |
| 26538 | Displays the new current frame. |
| 26539 | |
| 26540 | @subsubheading @value{GDBN} Command |
| 26541 | |
| 26542 | The corresponding @value{GDBN} command is @samp{return}. |
| 26543 | |
| 26544 | @subsubheading Example |
| 26545 | |
| 26546 | @smallexample |
| 26547 | (gdb) |
| 26548 | 200-break-insert callee4 |
| 26549 | 200^done,bkpt=@{number="1",addr="0x00010734", |
| 26550 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c",line="8"@} |
| 26551 | (gdb) |
| 26552 | 000-exec-run |
| 26553 | 000^running |
| 26554 | (gdb) |
| 26555 | 000*stopped,reason="breakpoint-hit",disp="keep",bkptno="1", |
| 26556 | frame=@{func="callee4",args=[], |
| 26557 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26558 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@} |
| 26559 | (gdb) |
| 26560 | 205-break-delete |
| 26561 | 205^done |
| 26562 | (gdb) |
| 26563 | 111-exec-return |
| 26564 | 111^done,frame=@{level="0",func="callee3", |
| 26565 | args=[@{name="strarg", |
| 26566 | value="0x11940 \"A string argument.\""@}], |
| 26567 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26568 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="18"@} |
| 26569 | (gdb) |
| 26570 | @end smallexample |
| 26571 | |
| 26572 | |
| 26573 | @subheading The @code{-exec-run} Command |
| 26574 | @findex -exec-run |
| 26575 | |
| 26576 | @subsubheading Synopsis |
| 26577 | |
| 26578 | @smallexample |
| 26579 | -exec-run [--all | --thread-group N] |
| 26580 | @end smallexample |
| 26581 | |
| 26582 | Starts execution of the inferior from the beginning. The inferior |
| 26583 | executes until either a breakpoint is encountered or the program |
| 26584 | exits. In the latter case the output will include an exit code, if |
| 26585 | the program has exited exceptionally. |
| 26586 | |
| 26587 | When no option is specified, the current inferior is started. If the |
| 26588 | @samp{--thread-group} option is specified, it should refer to a thread |
| 26589 | group of type @samp{process}, and that thread group will be started. |
| 26590 | If the @samp{--all} option is specified, then all inferiors will be started. |
| 26591 | |
| 26592 | @subsubheading @value{GDBN} Command |
| 26593 | |
| 26594 | The corresponding @value{GDBN} command is @samp{run}. |
| 26595 | |
| 26596 | @subsubheading Examples |
| 26597 | |
| 26598 | @smallexample |
| 26599 | (gdb) |
| 26600 | -break-insert main |
| 26601 | ^done,bkpt=@{number="1",addr="0x0001072c",file="recursive2.c",line="4"@} |
| 26602 | (gdb) |
| 26603 | -exec-run |
| 26604 | ^running |
| 26605 | (gdb) |
| 26606 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1", |
| 26607 | frame=@{func="main",args=[],file="recursive2.c", |
| 26608 | fullname="/home/foo/bar/recursive2.c",line="4"@} |
| 26609 | (gdb) |
| 26610 | @end smallexample |
| 26611 | |
| 26612 | @noindent |
| 26613 | Program exited normally: |
| 26614 | |
| 26615 | @smallexample |
| 26616 | (gdb) |
| 26617 | -exec-run |
| 26618 | ^running |
| 26619 | (gdb) |
| 26620 | x = 55 |
| 26621 | *stopped,reason="exited-normally" |
| 26622 | (gdb) |
| 26623 | @end smallexample |
| 26624 | |
| 26625 | @noindent |
| 26626 | Program exited exceptionally: |
| 26627 | |
| 26628 | @smallexample |
| 26629 | (gdb) |
| 26630 | -exec-run |
| 26631 | ^running |
| 26632 | (gdb) |
| 26633 | x = 55 |
| 26634 | *stopped,reason="exited",exit-code="01" |
| 26635 | (gdb) |
| 26636 | @end smallexample |
| 26637 | |
| 26638 | Another way the program can terminate is if it receives a signal such as |
| 26639 | @code{SIGINT}. In this case, @sc{gdb/mi} displays this: |
| 26640 | |
| 26641 | @smallexample |
| 26642 | (gdb) |
| 26643 | *stopped,reason="exited-signalled",signal-name="SIGINT", |
| 26644 | signal-meaning="Interrupt" |
| 26645 | @end smallexample |
| 26646 | |
| 26647 | |
| 26648 | @c @subheading -exec-signal |
| 26649 | |
| 26650 | |
| 26651 | @subheading The @code{-exec-step} Command |
| 26652 | @findex -exec-step |
| 26653 | |
| 26654 | @subsubheading Synopsis |
| 26655 | |
| 26656 | @smallexample |
| 26657 | -exec-step [--reverse] |
| 26658 | @end smallexample |
| 26659 | |
| 26660 | Resumes execution of the inferior program, stopping when the beginning |
| 26661 | of the next source line is reached, if the next source line is not a |
| 26662 | function call. If it is, stop at the first instruction of the called |
| 26663 | function. If the @samp{--reverse} option is specified, resumes reverse |
| 26664 | execution of the inferior program, stopping at the beginning of the |
| 26665 | previously executed source line. |
| 26666 | |
| 26667 | @subsubheading @value{GDBN} Command |
| 26668 | |
| 26669 | The corresponding @value{GDBN} command is @samp{step}. |
| 26670 | |
| 26671 | @subsubheading Example |
| 26672 | |
| 26673 | Stepping into a function: |
| 26674 | |
| 26675 | @smallexample |
| 26676 | -exec-step |
| 26677 | ^running |
| 26678 | (gdb) |
| 26679 | *stopped,reason="end-stepping-range", |
| 26680 | frame=@{func="foo",args=[@{name="a",value="10"@}, |
| 26681 | @{name="b",value="0"@}],file="recursive2.c", |
| 26682 | fullname="/home/foo/bar/recursive2.c",line="11"@} |
| 26683 | (gdb) |
| 26684 | @end smallexample |
| 26685 | |
| 26686 | Regular stepping: |
| 26687 | |
| 26688 | @smallexample |
| 26689 | -exec-step |
| 26690 | ^running |
| 26691 | (gdb) |
| 26692 | *stopped,reason="end-stepping-range",line="14",file="recursive2.c" |
| 26693 | (gdb) |
| 26694 | @end smallexample |
| 26695 | |
| 26696 | |
| 26697 | @subheading The @code{-exec-step-instruction} Command |
| 26698 | @findex -exec-step-instruction |
| 26699 | |
| 26700 | @subsubheading Synopsis |
| 26701 | |
| 26702 | @smallexample |
| 26703 | -exec-step-instruction [--reverse] |
| 26704 | @end smallexample |
| 26705 | |
| 26706 | Resumes the inferior which executes one machine instruction. If the |
| 26707 | @samp{--reverse} option is specified, resumes reverse execution of the |
| 26708 | inferior program, stopping at the previously executed instruction. |
| 26709 | The output, once @value{GDBN} has stopped, will vary depending on |
| 26710 | whether we have stopped in the middle of a source line or not. In the |
| 26711 | former case, the address at which the program stopped will be printed |
| 26712 | as well. |
| 26713 | |
| 26714 | @subsubheading @value{GDBN} Command |
| 26715 | |
| 26716 | The corresponding @value{GDBN} command is @samp{stepi}. |
| 26717 | |
| 26718 | @subsubheading Example |
| 26719 | |
| 26720 | @smallexample |
| 26721 | (gdb) |
| 26722 | -exec-step-instruction |
| 26723 | ^running |
| 26724 | |
| 26725 | (gdb) |
| 26726 | *stopped,reason="end-stepping-range", |
| 26727 | frame=@{func="foo",args=[],file="try.c", |
| 26728 | fullname="/home/foo/bar/try.c",line="10"@} |
| 26729 | (gdb) |
| 26730 | -exec-step-instruction |
| 26731 | ^running |
| 26732 | |
| 26733 | (gdb) |
| 26734 | *stopped,reason="end-stepping-range", |
| 26735 | frame=@{addr="0x000100f4",func="foo",args=[],file="try.c", |
| 26736 | fullname="/home/foo/bar/try.c",line="10"@} |
| 26737 | (gdb) |
| 26738 | @end smallexample |
| 26739 | |
| 26740 | |
| 26741 | @subheading The @code{-exec-until} Command |
| 26742 | @findex -exec-until |
| 26743 | |
| 26744 | @subsubheading Synopsis |
| 26745 | |
| 26746 | @smallexample |
| 26747 | -exec-until [ @var{location} ] |
| 26748 | @end smallexample |
| 26749 | |
| 26750 | Executes the inferior until the @var{location} specified in the |
| 26751 | argument is reached. If there is no argument, the inferior executes |
| 26752 | until a source line greater than the current one is reached. The |
| 26753 | reason for stopping in this case will be @samp{location-reached}. |
| 26754 | |
| 26755 | @subsubheading @value{GDBN} Command |
| 26756 | |
| 26757 | The corresponding @value{GDBN} command is @samp{until}. |
| 26758 | |
| 26759 | @subsubheading Example |
| 26760 | |
| 26761 | @smallexample |
| 26762 | (gdb) |
| 26763 | -exec-until recursive2.c:6 |
| 26764 | ^running |
| 26765 | (gdb) |
| 26766 | x = 55 |
| 26767 | *stopped,reason="location-reached",frame=@{func="main",args=[], |
| 26768 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="6"@} |
| 26769 | (gdb) |
| 26770 | @end smallexample |
| 26771 | |
| 26772 | @ignore |
| 26773 | @subheading -file-clear |
| 26774 | Is this going away???? |
| 26775 | @end ignore |
| 26776 | |
| 26777 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 26778 | @node GDB/MI Stack Manipulation |
| 26779 | @section @sc{gdb/mi} Stack Manipulation Commands |
| 26780 | |
| 26781 | |
| 26782 | @subheading The @code{-stack-info-frame} Command |
| 26783 | @findex -stack-info-frame |
| 26784 | |
| 26785 | @subsubheading Synopsis |
| 26786 | |
| 26787 | @smallexample |
| 26788 | -stack-info-frame |
| 26789 | @end smallexample |
| 26790 | |
| 26791 | Get info on the selected frame. |
| 26792 | |
| 26793 | @subsubheading @value{GDBN} Command |
| 26794 | |
| 26795 | The corresponding @value{GDBN} command is @samp{info frame} or @samp{frame} |
| 26796 | (without arguments). |
| 26797 | |
| 26798 | @subsubheading Example |
| 26799 | |
| 26800 | @smallexample |
| 26801 | (gdb) |
| 26802 | -stack-info-frame |
| 26803 | ^done,frame=@{level="1",addr="0x0001076c",func="callee3", |
| 26804 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26805 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@} |
| 26806 | (gdb) |
| 26807 | @end smallexample |
| 26808 | |
| 26809 | @subheading The @code{-stack-info-depth} Command |
| 26810 | @findex -stack-info-depth |
| 26811 | |
| 26812 | @subsubheading Synopsis |
| 26813 | |
| 26814 | @smallexample |
| 26815 | -stack-info-depth [ @var{max-depth} ] |
| 26816 | @end smallexample |
| 26817 | |
| 26818 | Return the depth of the stack. If the integer argument @var{max-depth} |
| 26819 | is specified, do not count beyond @var{max-depth} frames. |
| 26820 | |
| 26821 | @subsubheading @value{GDBN} Command |
| 26822 | |
| 26823 | There's no equivalent @value{GDBN} command. |
| 26824 | |
| 26825 | @subsubheading Example |
| 26826 | |
| 26827 | For a stack with frame levels 0 through 11: |
| 26828 | |
| 26829 | @smallexample |
| 26830 | (gdb) |
| 26831 | -stack-info-depth |
| 26832 | ^done,depth="12" |
| 26833 | (gdb) |
| 26834 | -stack-info-depth 4 |
| 26835 | ^done,depth="4" |
| 26836 | (gdb) |
| 26837 | -stack-info-depth 12 |
| 26838 | ^done,depth="12" |
| 26839 | (gdb) |
| 26840 | -stack-info-depth 11 |
| 26841 | ^done,depth="11" |
| 26842 | (gdb) |
| 26843 | -stack-info-depth 13 |
| 26844 | ^done,depth="12" |
| 26845 | (gdb) |
| 26846 | @end smallexample |
| 26847 | |
| 26848 | @subheading The @code{-stack-list-arguments} Command |
| 26849 | @findex -stack-list-arguments |
| 26850 | |
| 26851 | @subsubheading Synopsis |
| 26852 | |
| 26853 | @smallexample |
| 26854 | -stack-list-arguments @var{print-values} |
| 26855 | [ @var{low-frame} @var{high-frame} ] |
| 26856 | @end smallexample |
| 26857 | |
| 26858 | Display a list of the arguments for the frames between @var{low-frame} |
| 26859 | and @var{high-frame} (inclusive). If @var{low-frame} and |
| 26860 | @var{high-frame} are not provided, list the arguments for the whole |
| 26861 | call stack. If the two arguments are equal, show the single frame |
| 26862 | at the corresponding level. It is an error if @var{low-frame} is |
| 26863 | larger than the actual number of frames. On the other hand, |
| 26864 | @var{high-frame} may be larger than the actual number of frames, in |
| 26865 | which case only existing frames will be returned. |
| 26866 | |
| 26867 | If @var{print-values} is 0 or @code{--no-values}, print only the names of |
| 26868 | the variables; if it is 1 or @code{--all-values}, print also their |
| 26869 | values; and if it is 2 or @code{--simple-values}, print the name, |
| 26870 | type and value for simple data types, and the name and type for arrays, |
| 26871 | structures and unions. |
| 26872 | |
| 26873 | Use of this command to obtain arguments in a single frame is |
| 26874 | deprecated in favor of the @samp{-stack-list-variables} command. |
| 26875 | |
| 26876 | @subsubheading @value{GDBN} Command |
| 26877 | |
| 26878 | @value{GDBN} does not have an equivalent command. @code{gdbtk} has a |
| 26879 | @samp{gdb_get_args} command which partially overlaps with the |
| 26880 | functionality of @samp{-stack-list-arguments}. |
| 26881 | |
| 26882 | @subsubheading Example |
| 26883 | |
| 26884 | @smallexample |
| 26885 | (gdb) |
| 26886 | -stack-list-frames |
| 26887 | ^done, |
| 26888 | stack=[ |
| 26889 | frame=@{level="0",addr="0x00010734",func="callee4", |
| 26890 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26891 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="8"@}, |
| 26892 | frame=@{level="1",addr="0x0001076c",func="callee3", |
| 26893 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26894 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="17"@}, |
| 26895 | frame=@{level="2",addr="0x0001078c",func="callee2", |
| 26896 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26897 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="22"@}, |
| 26898 | frame=@{level="3",addr="0x000107b4",func="callee1", |
| 26899 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26900 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="27"@}, |
| 26901 | frame=@{level="4",addr="0x000107e0",func="main", |
| 26902 | file="../../../devo/gdb/testsuite/gdb.mi/basics.c", |
| 26903 | fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.c",line="32"@}] |
| 26904 | (gdb) |
| 26905 | -stack-list-arguments 0 |
| 26906 | ^done, |
| 26907 | stack-args=[ |
| 26908 | frame=@{level="0",args=[]@}, |
| 26909 | frame=@{level="1",args=[name="strarg"]@}, |
| 26910 | frame=@{level="2",args=[name="intarg",name="strarg"]@}, |
| 26911 | frame=@{level="3",args=[name="intarg",name="strarg",name="fltarg"]@}, |
| 26912 | frame=@{level="4",args=[]@}] |
| 26913 | (gdb) |
| 26914 | -stack-list-arguments 1 |
| 26915 | ^done, |
| 26916 | stack-args=[ |
| 26917 | frame=@{level="0",args=[]@}, |
| 26918 | frame=@{level="1", |
| 26919 | args=[@{name="strarg",value="0x11940 \"A string argument.\""@}]@}, |
| 26920 | frame=@{level="2",args=[ |
| 26921 | @{name="intarg",value="2"@}, |
| 26922 | @{name="strarg",value="0x11940 \"A string argument.\""@}]@}, |
| 26923 | @{frame=@{level="3",args=[ |
| 26924 | @{name="intarg",value="2"@}, |
| 26925 | @{name="strarg",value="0x11940 \"A string argument.\""@}, |
| 26926 | @{name="fltarg",value="3.5"@}]@}, |
| 26927 | frame=@{level="4",args=[]@}] |
| 26928 | (gdb) |
| 26929 | -stack-list-arguments 0 2 2 |
| 26930 | ^done,stack-args=[frame=@{level="2",args=[name="intarg",name="strarg"]@}] |
| 26931 | (gdb) |
| 26932 | -stack-list-arguments 1 2 2 |
| 26933 | ^done,stack-args=[frame=@{level="2", |
| 26934 | args=[@{name="intarg",value="2"@}, |
| 26935 | @{name="strarg",value="0x11940 \"A string argument.\""@}]@}] |
| 26936 | (gdb) |
| 26937 | @end smallexample |
| 26938 | |
| 26939 | @c @subheading -stack-list-exception-handlers |
| 26940 | |
| 26941 | |
| 26942 | @subheading The @code{-stack-list-frames} Command |
| 26943 | @findex -stack-list-frames |
| 26944 | |
| 26945 | @subsubheading Synopsis |
| 26946 | |
| 26947 | @smallexample |
| 26948 | -stack-list-frames [ @var{low-frame} @var{high-frame} ] |
| 26949 | @end smallexample |
| 26950 | |
| 26951 | List the frames currently on the stack. For each frame it displays the |
| 26952 | following info: |
| 26953 | |
| 26954 | @table @samp |
| 26955 | @item @var{level} |
| 26956 | The frame number, 0 being the topmost frame, i.e., the innermost function. |
| 26957 | @item @var{addr} |
| 26958 | The @code{$pc} value for that frame. |
| 26959 | @item @var{func} |
| 26960 | Function name. |
| 26961 | @item @var{file} |
| 26962 | File name of the source file where the function lives. |
| 26963 | @item @var{fullname} |
| 26964 | The full file name of the source file where the function lives. |
| 26965 | @item @var{line} |
| 26966 | Line number corresponding to the @code{$pc}. |
| 26967 | @item @var{from} |
| 26968 | The shared library where this function is defined. This is only given |
| 26969 | if the frame's function is not known. |
| 26970 | @end table |
| 26971 | |
| 26972 | If invoked without arguments, this command prints a backtrace for the |
| 26973 | whole stack. If given two integer arguments, it shows the frames whose |
| 26974 | levels are between the two arguments (inclusive). If the two arguments |
| 26975 | are equal, it shows the single frame at the corresponding level. It is |
| 26976 | an error if @var{low-frame} is larger than the actual number of |
| 26977 | frames. On the other hand, @var{high-frame} may be larger than the |
| 26978 | actual number of frames, in which case only existing frames will be returned. |
| 26979 | |
| 26980 | @subsubheading @value{GDBN} Command |
| 26981 | |
| 26982 | The corresponding @value{GDBN} commands are @samp{backtrace} and @samp{where}. |
| 26983 | |
| 26984 | @subsubheading Example |
| 26985 | |
| 26986 | Full stack backtrace: |
| 26987 | |
| 26988 | @smallexample |
| 26989 | (gdb) |
| 26990 | -stack-list-frames |
| 26991 | ^done,stack= |
| 26992 | [frame=@{level="0",addr="0x0001076c",func="foo", |
| 26993 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="11"@}, |
| 26994 | frame=@{level="1",addr="0x000107a4",func="foo", |
| 26995 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 26996 | frame=@{level="2",addr="0x000107a4",func="foo", |
| 26997 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 26998 | frame=@{level="3",addr="0x000107a4",func="foo", |
| 26999 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27000 | frame=@{level="4",addr="0x000107a4",func="foo", |
| 27001 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27002 | frame=@{level="5",addr="0x000107a4",func="foo", |
| 27003 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27004 | frame=@{level="6",addr="0x000107a4",func="foo", |
| 27005 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27006 | frame=@{level="7",addr="0x000107a4",func="foo", |
| 27007 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27008 | frame=@{level="8",addr="0x000107a4",func="foo", |
| 27009 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27010 | frame=@{level="9",addr="0x000107a4",func="foo", |
| 27011 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27012 | frame=@{level="10",addr="0x000107a4",func="foo", |
| 27013 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27014 | frame=@{level="11",addr="0x00010738",func="main", |
| 27015 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="4"@}] |
| 27016 | (gdb) |
| 27017 | @end smallexample |
| 27018 | |
| 27019 | Show frames between @var{low_frame} and @var{high_frame}: |
| 27020 | |
| 27021 | @smallexample |
| 27022 | (gdb) |
| 27023 | -stack-list-frames 3 5 |
| 27024 | ^done,stack= |
| 27025 | [frame=@{level="3",addr="0x000107a4",func="foo", |
| 27026 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27027 | frame=@{level="4",addr="0x000107a4",func="foo", |
| 27028 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}, |
| 27029 | frame=@{level="5",addr="0x000107a4",func="foo", |
| 27030 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}] |
| 27031 | (gdb) |
| 27032 | @end smallexample |
| 27033 | |
| 27034 | Show a single frame: |
| 27035 | |
| 27036 | @smallexample |
| 27037 | (gdb) |
| 27038 | -stack-list-frames 3 3 |
| 27039 | ^done,stack= |
| 27040 | [frame=@{level="3",addr="0x000107a4",func="foo", |
| 27041 | file="recursive2.c",fullname="/home/foo/bar/recursive2.c",line="14"@}] |
| 27042 | (gdb) |
| 27043 | @end smallexample |
| 27044 | |
| 27045 | |
| 27046 | @subheading The @code{-stack-list-locals} Command |
| 27047 | @findex -stack-list-locals |
| 27048 | |
| 27049 | @subsubheading Synopsis |
| 27050 | |
| 27051 | @smallexample |
| 27052 | -stack-list-locals @var{print-values} |
| 27053 | @end smallexample |
| 27054 | |
| 27055 | Display the local variable names for the selected frame. If |
| 27056 | @var{print-values} is 0 or @code{--no-values}, print only the names of |
| 27057 | the variables; if it is 1 or @code{--all-values}, print also their |
| 27058 | values; and if it is 2 or @code{--simple-values}, print the name, |
| 27059 | type and value for simple data types, and the name and type for arrays, |
| 27060 | structures and unions. In this last case, a frontend can immediately |
| 27061 | display the value of simple data types and create variable objects for |
| 27062 | other data types when the user wishes to explore their values in |
| 27063 | more detail. |
| 27064 | |
| 27065 | This command is deprecated in favor of the |
| 27066 | @samp{-stack-list-variables} command. |
| 27067 | |
| 27068 | @subsubheading @value{GDBN} Command |
| 27069 | |
| 27070 | @samp{info locals} in @value{GDBN}, @samp{gdb_get_locals} in @code{gdbtk}. |
| 27071 | |
| 27072 | @subsubheading Example |
| 27073 | |
| 27074 | @smallexample |
| 27075 | (gdb) |
| 27076 | -stack-list-locals 0 |
| 27077 | ^done,locals=[name="A",name="B",name="C"] |
| 27078 | (gdb) |
| 27079 | -stack-list-locals --all-values |
| 27080 | ^done,locals=[@{name="A",value="1"@},@{name="B",value="2"@}, |
| 27081 | @{name="C",value="@{1, 2, 3@}"@}] |
| 27082 | -stack-list-locals --simple-values |
| 27083 | ^done,locals=[@{name="A",type="int",value="1"@}, |
| 27084 | @{name="B",type="int",value="2"@},@{name="C",type="int [3]"@}] |
| 27085 | (gdb) |
| 27086 | @end smallexample |
| 27087 | |
| 27088 | @subheading The @code{-stack-list-variables} Command |
| 27089 | @findex -stack-list-variables |
| 27090 | |
| 27091 | @subsubheading Synopsis |
| 27092 | |
| 27093 | @smallexample |
| 27094 | -stack-list-variables @var{print-values} |
| 27095 | @end smallexample |
| 27096 | |
| 27097 | Display the names of local variables and function arguments for the selected frame. If |
| 27098 | @var{print-values} is 0 or @code{--no-values}, print only the names of |
| 27099 | the variables; if it is 1 or @code{--all-values}, print also their |
| 27100 | values; and if it is 2 or @code{--simple-values}, print the name, |
| 27101 | type and value for simple data types, and the name and type for arrays, |
| 27102 | structures and unions. |
| 27103 | |
| 27104 | @subsubheading Example |
| 27105 | |
| 27106 | @smallexample |
| 27107 | (gdb) |
| 27108 | -stack-list-variables --thread 1 --frame 0 --all-values |
| 27109 | ^done,variables=[@{name="x",value="11"@},@{name="s",value="@{a = 1, b = 2@}"@}] |
| 27110 | (gdb) |
| 27111 | @end smallexample |
| 27112 | |
| 27113 | |
| 27114 | @subheading The @code{-stack-select-frame} Command |
| 27115 | @findex -stack-select-frame |
| 27116 | |
| 27117 | @subsubheading Synopsis |
| 27118 | |
| 27119 | @smallexample |
| 27120 | -stack-select-frame @var{framenum} |
| 27121 | @end smallexample |
| 27122 | |
| 27123 | Change the selected frame. Select a different frame @var{framenum} on |
| 27124 | the stack. |
| 27125 | |
| 27126 | This command in deprecated in favor of passing the @samp{--frame} |
| 27127 | option to every command. |
| 27128 | |
| 27129 | @subsubheading @value{GDBN} Command |
| 27130 | |
| 27131 | The corresponding @value{GDBN} commands are @samp{frame}, @samp{up}, |
| 27132 | @samp{down}, @samp{select-frame}, @samp{up-silent}, and @samp{down-silent}. |
| 27133 | |
| 27134 | @subsubheading Example |
| 27135 | |
| 27136 | @smallexample |
| 27137 | (gdb) |
| 27138 | -stack-select-frame 2 |
| 27139 | ^done |
| 27140 | (gdb) |
| 27141 | @end smallexample |
| 27142 | |
| 27143 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 27144 | @node GDB/MI Variable Objects |
| 27145 | @section @sc{gdb/mi} Variable Objects |
| 27146 | |
| 27147 | @ignore |
| 27148 | |
| 27149 | @subheading Motivation for Variable Objects in @sc{gdb/mi} |
| 27150 | |
| 27151 | For the implementation of a variable debugger window (locals, watched |
| 27152 | expressions, etc.), we are proposing the adaptation of the existing code |
| 27153 | used by @code{Insight}. |
| 27154 | |
| 27155 | The two main reasons for that are: |
| 27156 | |
| 27157 | @enumerate 1 |
| 27158 | @item |
| 27159 | It has been proven in practice (it is already on its second generation). |
| 27160 | |
| 27161 | @item |
| 27162 | It will shorten development time (needless to say how important it is |
| 27163 | now). |
| 27164 | @end enumerate |
| 27165 | |
| 27166 | The original interface was designed to be used by Tcl code, so it was |
| 27167 | slightly changed so it could be used through @sc{gdb/mi}. This section |
| 27168 | describes the @sc{gdb/mi} operations that will be available and gives some |
| 27169 | hints about their use. |
| 27170 | |
| 27171 | @emph{Note}: In addition to the set of operations described here, we |
| 27172 | expect the @sc{gui} implementation of a variable window to require, at |
| 27173 | least, the following operations: |
| 27174 | |
| 27175 | @itemize @bullet |
| 27176 | @item @code{-gdb-show} @code{output-radix} |
| 27177 | @item @code{-stack-list-arguments} |
| 27178 | @item @code{-stack-list-locals} |
| 27179 | @item @code{-stack-select-frame} |
| 27180 | @end itemize |
| 27181 | |
| 27182 | @end ignore |
| 27183 | |
| 27184 | @subheading Introduction to Variable Objects |
| 27185 | |
| 27186 | @cindex variable objects in @sc{gdb/mi} |
| 27187 | |
| 27188 | Variable objects are "object-oriented" MI interface for examining and |
| 27189 | changing values of expressions. Unlike some other MI interfaces that |
| 27190 | work with expressions, variable objects are specifically designed for |
| 27191 | simple and efficient presentation in the frontend. A variable object |
| 27192 | is identified by string name. When a variable object is created, the |
| 27193 | frontend specifies the expression for that variable object. The |
| 27194 | expression can be a simple variable, or it can be an arbitrary complex |
| 27195 | expression, and can even involve CPU registers. After creating a |
| 27196 | variable object, the frontend can invoke other variable object |
| 27197 | operations---for example to obtain or change the value of a variable |
| 27198 | object, or to change display format. |
| 27199 | |
| 27200 | Variable objects have hierarchical tree structure. Any variable object |
| 27201 | that corresponds to a composite type, such as structure in C, has |
| 27202 | a number of child variable objects, for example corresponding to each |
| 27203 | element of a structure. A child variable object can itself have |
| 27204 | children, recursively. Recursion ends when we reach |
| 27205 | leaf variable objects, which always have built-in types. Child variable |
| 27206 | objects are created only by explicit request, so if a frontend |
| 27207 | is not interested in the children of a particular variable object, no |
| 27208 | child will be created. |
| 27209 | |
| 27210 | For a leaf variable object it is possible to obtain its value as a |
| 27211 | string, or set the value from a string. String value can be also |
| 27212 | obtained for a non-leaf variable object, but it's generally a string |
| 27213 | that only indicates the type of the object, and does not list its |
| 27214 | contents. Assignment to a non-leaf variable object is not allowed. |
| 27215 | |
| 27216 | A frontend does not need to read the values of all variable objects each time |
| 27217 | the program stops. Instead, MI provides an update command that lists all |
| 27218 | variable objects whose values has changed since the last update |
| 27219 | operation. This considerably reduces the amount of data that must |
| 27220 | be transferred to the frontend. As noted above, children variable |
| 27221 | objects are created on demand, and only leaf variable objects have a |
| 27222 | real value. As result, gdb will read target memory only for leaf |
| 27223 | variables that frontend has created. |
| 27224 | |
| 27225 | The automatic update is not always desirable. For example, a frontend |
| 27226 | might want to keep a value of some expression for future reference, |
| 27227 | and never update it. For another example, fetching memory is |
| 27228 | relatively slow for embedded targets, so a frontend might want |
| 27229 | to disable automatic update for the variables that are either not |
| 27230 | visible on the screen, or ``closed''. This is possible using so |
| 27231 | called ``frozen variable objects''. Such variable objects are never |
| 27232 | implicitly updated. |
| 27233 | |
| 27234 | Variable objects can be either @dfn{fixed} or @dfn{floating}. For the |
| 27235 | fixed variable object, the expression is parsed when the variable |
| 27236 | object is created, including associating identifiers to specific |
| 27237 | variables. The meaning of expression never changes. For a floating |
| 27238 | variable object the values of variables whose names appear in the |
| 27239 | expressions are re-evaluated every time in the context of the current |
| 27240 | frame. Consider this example: |
| 27241 | |
| 27242 | @smallexample |
| 27243 | void do_work(...) |
| 27244 | @{ |
| 27245 | struct work_state state; |
| 27246 | |
| 27247 | if (...) |
| 27248 | do_work(...); |
| 27249 | @} |
| 27250 | @end smallexample |
| 27251 | |
| 27252 | If a fixed variable object for the @code{state} variable is created in |
| 27253 | this function, and we enter the recursive call, the the variable |
| 27254 | object will report the value of @code{state} in the top-level |
| 27255 | @code{do_work} invocation. On the other hand, a floating variable |
| 27256 | object will report the value of @code{state} in the current frame. |
| 27257 | |
| 27258 | If an expression specified when creating a fixed variable object |
| 27259 | refers to a local variable, the variable object becomes bound to the |
| 27260 | thread and frame in which the variable object is created. When such |
| 27261 | variable object is updated, @value{GDBN} makes sure that the |
| 27262 | thread/frame combination the variable object is bound to still exists, |
| 27263 | and re-evaluates the variable object in context of that thread/frame. |
| 27264 | |
| 27265 | The following is the complete set of @sc{gdb/mi} operations defined to |
| 27266 | access this functionality: |
| 27267 | |
| 27268 | @multitable @columnfractions .4 .6 |
| 27269 | @item @strong{Operation} |
| 27270 | @tab @strong{Description} |
| 27271 | |
| 27272 | @item @code{-enable-pretty-printing} |
| 27273 | @tab enable Python-based pretty-printing |
| 27274 | @item @code{-var-create} |
| 27275 | @tab create a variable object |
| 27276 | @item @code{-var-delete} |
| 27277 | @tab delete the variable object and/or its children |
| 27278 | @item @code{-var-set-format} |
| 27279 | @tab set the display format of this variable |
| 27280 | @item @code{-var-show-format} |
| 27281 | @tab show the display format of this variable |
| 27282 | @item @code{-var-info-num-children} |
| 27283 | @tab tells how many children this object has |
| 27284 | @item @code{-var-list-children} |
| 27285 | @tab return a list of the object's children |
| 27286 | @item @code{-var-info-type} |
| 27287 | @tab show the type of this variable object |
| 27288 | @item @code{-var-info-expression} |
| 27289 | @tab print parent-relative expression that this variable object represents |
| 27290 | @item @code{-var-info-path-expression} |
| 27291 | @tab print full expression that this variable object represents |
| 27292 | @item @code{-var-show-attributes} |
| 27293 | @tab is this variable editable? does it exist here? |
| 27294 | @item @code{-var-evaluate-expression} |
| 27295 | @tab get the value of this variable |
| 27296 | @item @code{-var-assign} |
| 27297 | @tab set the value of this variable |
| 27298 | @item @code{-var-update} |
| 27299 | @tab update the variable and its children |
| 27300 | @item @code{-var-set-frozen} |
| 27301 | @tab set frozeness attribute |
| 27302 | @item @code{-var-set-update-range} |
| 27303 | @tab set range of children to display on update |
| 27304 | @end multitable |
| 27305 | |
| 27306 | In the next subsection we describe each operation in detail and suggest |
| 27307 | how it can be used. |
| 27308 | |
| 27309 | @subheading Description And Use of Operations on Variable Objects |
| 27310 | |
| 27311 | @subheading The @code{-enable-pretty-printing} Command |
| 27312 | @findex -enable-pretty-printing |
| 27313 | |
| 27314 | @smallexample |
| 27315 | -enable-pretty-printing |
| 27316 | @end smallexample |
| 27317 | |
| 27318 | @value{GDBN} allows Python-based visualizers to affect the output of the |
| 27319 | MI variable object commands. However, because there was no way to |
| 27320 | implement this in a fully backward-compatible way, a front end must |
| 27321 | request that this functionality be enabled. |
| 27322 | |
| 27323 | Once enabled, this feature cannot be disabled. |
| 27324 | |
| 27325 | Note that if Python support has not been compiled into @value{GDBN}, |
| 27326 | this command will still succeed (and do nothing). |
| 27327 | |
| 27328 | This feature is currently (as of @value{GDBN} 7.0) experimental, and |
| 27329 | may work differently in future versions of @value{GDBN}. |
| 27330 | |
| 27331 | @subheading The @code{-var-create} Command |
| 27332 | @findex -var-create |
| 27333 | |
| 27334 | @subsubheading Synopsis |
| 27335 | |
| 27336 | @smallexample |
| 27337 | -var-create @{@var{name} | "-"@} |
| 27338 | @{@var{frame-addr} | "*" | "@@"@} @var{expression} |
| 27339 | @end smallexample |
| 27340 | |
| 27341 | This operation creates a variable object, which allows the monitoring of |
| 27342 | a variable, the result of an expression, a memory cell or a CPU |
| 27343 | register. |
| 27344 | |
| 27345 | The @var{name} parameter is the string by which the object can be |
| 27346 | referenced. It must be unique. If @samp{-} is specified, the varobj |
| 27347 | system will generate a string ``varNNNNNN'' automatically. It will be |
| 27348 | unique provided that one does not specify @var{name} of that format. |
| 27349 | The command fails if a duplicate name is found. |
| 27350 | |
| 27351 | The frame under which the expression should be evaluated can be |
| 27352 | specified by @var{frame-addr}. A @samp{*} indicates that the current |
| 27353 | frame should be used. A @samp{@@} indicates that a floating variable |
| 27354 | object must be created. |
| 27355 | |
| 27356 | @var{expression} is any expression valid on the current language set (must not |
| 27357 | begin with a @samp{*}), or one of the following: |
| 27358 | |
| 27359 | @itemize @bullet |
| 27360 | @item |
| 27361 | @samp{*@var{addr}}, where @var{addr} is the address of a memory cell |
| 27362 | |
| 27363 | @item |
| 27364 | @samp{*@var{addr}-@var{addr}} --- a memory address range (TBD) |
| 27365 | |
| 27366 | @item |
| 27367 | @samp{$@var{regname}} --- a CPU register name |
| 27368 | @end itemize |
| 27369 | |
| 27370 | @cindex dynamic varobj |
| 27371 | A varobj's contents may be provided by a Python-based pretty-printer. In this |
| 27372 | case the varobj is known as a @dfn{dynamic varobj}. Dynamic varobjs |
| 27373 | have slightly different semantics in some cases. If the |
| 27374 | @code{-enable-pretty-printing} command is not sent, then @value{GDBN} |
| 27375 | will never create a dynamic varobj. This ensures backward |
| 27376 | compatibility for existing clients. |
| 27377 | |
| 27378 | @subsubheading Result |
| 27379 | |
| 27380 | This operation returns attributes of the newly-created varobj. These |
| 27381 | are: |
| 27382 | |
| 27383 | @table @samp |
| 27384 | @item name |
| 27385 | The name of the varobj. |
| 27386 | |
| 27387 | @item numchild |
| 27388 | The number of children of the varobj. This number is not necessarily |
| 27389 | reliable for a dynamic varobj. Instead, you must examine the |
| 27390 | @samp{has_more} attribute. |
| 27391 | |
| 27392 | @item value |
| 27393 | The varobj's scalar value. For a varobj whose type is some sort of |
| 27394 | aggregate (e.g., a @code{struct}), or for a dynamic varobj, this value |
| 27395 | will not be interesting. |
| 27396 | |
| 27397 | @item type |
| 27398 | The varobj's type. This is a string representation of the type, as |
| 27399 | would be printed by the @value{GDBN} CLI. |
| 27400 | |
| 27401 | @item thread-id |
| 27402 | If a variable object is bound to a specific thread, then this is the |
| 27403 | thread's identifier. |
| 27404 | |
| 27405 | @item has_more |
| 27406 | For a dynamic varobj, this indicates whether there appear to be any |
| 27407 | children available. For a non-dynamic varobj, this will be 0. |
| 27408 | |
| 27409 | @item dynamic |
| 27410 | This attribute will be present and have the value @samp{1} if the |
| 27411 | varobj is a dynamic varobj. If the varobj is not a dynamic varobj, |
| 27412 | then this attribute will not be present. |
| 27413 | |
| 27414 | @item displayhint |
| 27415 | A dynamic varobj can supply a display hint to the front end. The |
| 27416 | value comes directly from the Python pretty-printer object's |
| 27417 | @code{display_hint} method. @xref{Pretty Printing API}. |
| 27418 | @end table |
| 27419 | |
| 27420 | Typical output will look like this: |
| 27421 | |
| 27422 | @smallexample |
| 27423 | name="@var{name}",numchild="@var{N}",type="@var{type}",thread-id="@var{M}", |
| 27424 | has_more="@var{has_more}" |
| 27425 | @end smallexample |
| 27426 | |
| 27427 | |
| 27428 | @subheading The @code{-var-delete} Command |
| 27429 | @findex -var-delete |
| 27430 | |
| 27431 | @subsubheading Synopsis |
| 27432 | |
| 27433 | @smallexample |
| 27434 | -var-delete [ -c ] @var{name} |
| 27435 | @end smallexample |
| 27436 | |
| 27437 | Deletes a previously created variable object and all of its children. |
| 27438 | With the @samp{-c} option, just deletes the children. |
| 27439 | |
| 27440 | Returns an error if the object @var{name} is not found. |
| 27441 | |
| 27442 | |
| 27443 | @subheading The @code{-var-set-format} Command |
| 27444 | @findex -var-set-format |
| 27445 | |
| 27446 | @subsubheading Synopsis |
| 27447 | |
| 27448 | @smallexample |
| 27449 | -var-set-format @var{name} @var{format-spec} |
| 27450 | @end smallexample |
| 27451 | |
| 27452 | Sets the output format for the value of the object @var{name} to be |
| 27453 | @var{format-spec}. |
| 27454 | |
| 27455 | @anchor{-var-set-format} |
| 27456 | The syntax for the @var{format-spec} is as follows: |
| 27457 | |
| 27458 | @smallexample |
| 27459 | @var{format-spec} @expansion{} |
| 27460 | @{binary | decimal | hexadecimal | octal | natural@} |
| 27461 | @end smallexample |
| 27462 | |
| 27463 | The natural format is the default format choosen automatically |
| 27464 | based on the variable type (like decimal for an @code{int}, hex |
| 27465 | for pointers, etc.). |
| 27466 | |
| 27467 | For a variable with children, the format is set only on the |
| 27468 | variable itself, and the children are not affected. |
| 27469 | |
| 27470 | @subheading The @code{-var-show-format} Command |
| 27471 | @findex -var-show-format |
| 27472 | |
| 27473 | @subsubheading Synopsis |
| 27474 | |
| 27475 | @smallexample |
| 27476 | -var-show-format @var{name} |
| 27477 | @end smallexample |
| 27478 | |
| 27479 | Returns the format used to display the value of the object @var{name}. |
| 27480 | |
| 27481 | @smallexample |
| 27482 | @var{format} @expansion{} |
| 27483 | @var{format-spec} |
| 27484 | @end smallexample |
| 27485 | |
| 27486 | |
| 27487 | @subheading The @code{-var-info-num-children} Command |
| 27488 | @findex -var-info-num-children |
| 27489 | |
| 27490 | @subsubheading Synopsis |
| 27491 | |
| 27492 | @smallexample |
| 27493 | -var-info-num-children @var{name} |
| 27494 | @end smallexample |
| 27495 | |
| 27496 | Returns the number of children of a variable object @var{name}: |
| 27497 | |
| 27498 | @smallexample |
| 27499 | numchild=@var{n} |
| 27500 | @end smallexample |
| 27501 | |
| 27502 | Note that this number is not completely reliable for a dynamic varobj. |
| 27503 | It will return the current number of children, but more children may |
| 27504 | be available. |
| 27505 | |
| 27506 | |
| 27507 | @subheading The @code{-var-list-children} Command |
| 27508 | @findex -var-list-children |
| 27509 | |
| 27510 | @subsubheading Synopsis |
| 27511 | |
| 27512 | @smallexample |
| 27513 | -var-list-children [@var{print-values}] @var{name} [@var{from} @var{to}] |
| 27514 | @end smallexample |
| 27515 | @anchor{-var-list-children} |
| 27516 | |
| 27517 | Return a list of the children of the specified variable object and |
| 27518 | create variable objects for them, if they do not already exist. With |
| 27519 | a single argument or if @var{print-values} has a value of 0 or |
| 27520 | @code{--no-values}, print only the names of the variables; if |
| 27521 | @var{print-values} is 1 or @code{--all-values}, also print their |
| 27522 | values; and if it is 2 or @code{--simple-values} print the name and |
| 27523 | value for simple data types and just the name for arrays, structures |
| 27524 | and unions. |
| 27525 | |
| 27526 | @var{from} and @var{to}, if specified, indicate the range of children |
| 27527 | to report. If @var{from} or @var{to} is less than zero, the range is |
| 27528 | reset and all children will be reported. Otherwise, children starting |
| 27529 | at @var{from} (zero-based) and up to and excluding @var{to} will be |
| 27530 | reported. |
| 27531 | |
| 27532 | If a child range is requested, it will only affect the current call to |
| 27533 | @code{-var-list-children}, but not future calls to @code{-var-update}. |
| 27534 | For this, you must instead use @code{-var-set-update-range}. The |
| 27535 | intent of this approach is to enable a front end to implement any |
| 27536 | update approach it likes; for example, scrolling a view may cause the |
| 27537 | front end to request more children with @code{-var-list-children}, and |
| 27538 | then the front end could call @code{-var-set-update-range} with a |
| 27539 | different range to ensure that future updates are restricted to just |
| 27540 | the visible items. |
| 27541 | |
| 27542 | For each child the following results are returned: |
| 27543 | |
| 27544 | @table @var |
| 27545 | |
| 27546 | @item name |
| 27547 | Name of the variable object created for this child. |
| 27548 | |
| 27549 | @item exp |
| 27550 | The expression to be shown to the user by the front end to designate this child. |
| 27551 | For example this may be the name of a structure member. |
| 27552 | |
| 27553 | For a dynamic varobj, this value cannot be used to form an |
| 27554 | expression. There is no way to do this at all with a dynamic varobj. |
| 27555 | |
| 27556 | For C/C@t{++} structures there are several pseudo children returned to |
| 27557 | designate access qualifiers. For these pseudo children @var{exp} is |
| 27558 | @samp{public}, @samp{private}, or @samp{protected}. In this case the |
| 27559 | type and value are not present. |
| 27560 | |
| 27561 | A dynamic varobj will not report the access qualifying |
| 27562 | pseudo-children, regardless of the language. This information is not |
| 27563 | available at all with a dynamic varobj. |
| 27564 | |
| 27565 | @item numchild |
| 27566 | Number of children this child has. For a dynamic varobj, this will be |
| 27567 | 0. |
| 27568 | |
| 27569 | @item type |
| 27570 | The type of the child. |
| 27571 | |
| 27572 | @item value |
| 27573 | If values were requested, this is the value. |
| 27574 | |
| 27575 | @item thread-id |
| 27576 | If this variable object is associated with a thread, this is the thread id. |
| 27577 | Otherwise this result is not present. |
| 27578 | |
| 27579 | @item frozen |
| 27580 | If the variable object is frozen, this variable will be present with a value of 1. |
| 27581 | @end table |
| 27582 | |
| 27583 | The result may have its own attributes: |
| 27584 | |
| 27585 | @table @samp |
| 27586 | @item displayhint |
| 27587 | A dynamic varobj can supply a display hint to the front end. The |
| 27588 | value comes directly from the Python pretty-printer object's |
| 27589 | @code{display_hint} method. @xref{Pretty Printing API}. |
| 27590 | |
| 27591 | @item has_more |
| 27592 | This is an integer attribute which is nonzero if there are children |
| 27593 | remaining after the end of the selected range. |
| 27594 | @end table |
| 27595 | |
| 27596 | @subsubheading Example |
| 27597 | |
| 27598 | @smallexample |
| 27599 | (gdb) |
| 27600 | -var-list-children n |
| 27601 | ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp}, |
| 27602 | numchild=@var{n},type=@var{type}@},@r{(repeats N times)}] |
| 27603 | (gdb) |
| 27604 | -var-list-children --all-values n |
| 27605 | ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp}, |
| 27606 | numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}] |
| 27607 | @end smallexample |
| 27608 | |
| 27609 | |
| 27610 | @subheading The @code{-var-info-type} Command |
| 27611 | @findex -var-info-type |
| 27612 | |
| 27613 | @subsubheading Synopsis |
| 27614 | |
| 27615 | @smallexample |
| 27616 | -var-info-type @var{name} |
| 27617 | @end smallexample |
| 27618 | |
| 27619 | Returns the type of the specified variable @var{name}. The type is |
| 27620 | returned as a string in the same format as it is output by the |
| 27621 | @value{GDBN} CLI: |
| 27622 | |
| 27623 | @smallexample |
| 27624 | type=@var{typename} |
| 27625 | @end smallexample |
| 27626 | |
| 27627 | |
| 27628 | @subheading The @code{-var-info-expression} Command |
| 27629 | @findex -var-info-expression |
| 27630 | |
| 27631 | @subsubheading Synopsis |
| 27632 | |
| 27633 | @smallexample |
| 27634 | -var-info-expression @var{name} |
| 27635 | @end smallexample |
| 27636 | |
| 27637 | Returns a string that is suitable for presenting this |
| 27638 | variable object in user interface. The string is generally |
| 27639 | not valid expression in the current language, and cannot be evaluated. |
| 27640 | |
| 27641 | For example, if @code{a} is an array, and variable object |
| 27642 | @code{A} was created for @code{a}, then we'll get this output: |
| 27643 | |
| 27644 | @smallexample |
| 27645 | (gdb) -var-info-expression A.1 |
| 27646 | ^done,lang="C",exp="1" |
| 27647 | @end smallexample |
| 27648 | |
| 27649 | @noindent |
| 27650 | Here, the values of @code{lang} can be @code{@{"C" | "C++" | "Java"@}}. |
| 27651 | |
| 27652 | Note that the output of the @code{-var-list-children} command also |
| 27653 | includes those expressions, so the @code{-var-info-expression} command |
| 27654 | is of limited use. |
| 27655 | |
| 27656 | @subheading The @code{-var-info-path-expression} Command |
| 27657 | @findex -var-info-path-expression |
| 27658 | |
| 27659 | @subsubheading Synopsis |
| 27660 | |
| 27661 | @smallexample |
| 27662 | -var-info-path-expression @var{name} |
| 27663 | @end smallexample |
| 27664 | |
| 27665 | Returns an expression that can be evaluated in the current |
| 27666 | context and will yield the same value that a variable object has. |
| 27667 | Compare this with the @code{-var-info-expression} command, which |
| 27668 | result can be used only for UI presentation. Typical use of |
| 27669 | the @code{-var-info-path-expression} command is creating a |
| 27670 | watchpoint from a variable object. |
| 27671 | |
| 27672 | This command is currently not valid for children of a dynamic varobj, |
| 27673 | and will give an error when invoked on one. |
| 27674 | |
| 27675 | For example, suppose @code{C} is a C@t{++} class, derived from class |
| 27676 | @code{Base}, and that the @code{Base} class has a member called |
| 27677 | @code{m_size}. Assume a variable @code{c} is has the type of |
| 27678 | @code{C} and a variable object @code{C} was created for variable |
| 27679 | @code{c}. Then, we'll get this output: |
| 27680 | @smallexample |
| 27681 | (gdb) -var-info-path-expression C.Base.public.m_size |
| 27682 | ^done,path_expr=((Base)c).m_size) |
| 27683 | @end smallexample |
| 27684 | |
| 27685 | @subheading The @code{-var-show-attributes} Command |
| 27686 | @findex -var-show-attributes |
| 27687 | |
| 27688 | @subsubheading Synopsis |
| 27689 | |
| 27690 | @smallexample |
| 27691 | -var-show-attributes @var{name} |
| 27692 | @end smallexample |
| 27693 | |
| 27694 | List attributes of the specified variable object @var{name}: |
| 27695 | |
| 27696 | @smallexample |
| 27697 | status=@var{attr} [ ( ,@var{attr} )* ] |
| 27698 | @end smallexample |
| 27699 | |
| 27700 | @noindent |
| 27701 | where @var{attr} is @code{@{ @{ editable | noneditable @} | TBD @}}. |
| 27702 | |
| 27703 | @subheading The @code{-var-evaluate-expression} Command |
| 27704 | @findex -var-evaluate-expression |
| 27705 | |
| 27706 | @subsubheading Synopsis |
| 27707 | |
| 27708 | @smallexample |
| 27709 | -var-evaluate-expression [-f @var{format-spec}] @var{name} |
| 27710 | @end smallexample |
| 27711 | |
| 27712 | Evaluates the expression that is represented by the specified variable |
| 27713 | object and returns its value as a string. The format of the string |
| 27714 | can be specified with the @samp{-f} option. The possible values of |
| 27715 | this option are the same as for @code{-var-set-format} |
| 27716 | (@pxref{-var-set-format}). If the @samp{-f} option is not specified, |
| 27717 | the current display format will be used. The current display format |
| 27718 | can be changed using the @code{-var-set-format} command. |
| 27719 | |
| 27720 | @smallexample |
| 27721 | value=@var{value} |
| 27722 | @end smallexample |
| 27723 | |
| 27724 | Note that one must invoke @code{-var-list-children} for a variable |
| 27725 | before the value of a child variable can be evaluated. |
| 27726 | |
| 27727 | @subheading The @code{-var-assign} Command |
| 27728 | @findex -var-assign |
| 27729 | |
| 27730 | @subsubheading Synopsis |
| 27731 | |
| 27732 | @smallexample |
| 27733 | -var-assign @var{name} @var{expression} |
| 27734 | @end smallexample |
| 27735 | |
| 27736 | Assigns the value of @var{expression} to the variable object specified |
| 27737 | by @var{name}. The object must be @samp{editable}. If the variable's |
| 27738 | value is altered by the assign, the variable will show up in any |
| 27739 | subsequent @code{-var-update} list. |
| 27740 | |
| 27741 | @subsubheading Example |
| 27742 | |
| 27743 | @smallexample |
| 27744 | (gdb) |
| 27745 | -var-assign var1 3 |
| 27746 | ^done,value="3" |
| 27747 | (gdb) |
| 27748 | -var-update * |
| 27749 | ^done,changelist=[@{name="var1",in_scope="true",type_changed="false"@}] |
| 27750 | (gdb) |
| 27751 | @end smallexample |
| 27752 | |
| 27753 | @subheading The @code{-var-update} Command |
| 27754 | @findex -var-update |
| 27755 | |
| 27756 | @subsubheading Synopsis |
| 27757 | |
| 27758 | @smallexample |
| 27759 | -var-update [@var{print-values}] @{@var{name} | "*"@} |
| 27760 | @end smallexample |
| 27761 | |
| 27762 | Reevaluate the expressions corresponding to the variable object |
| 27763 | @var{name} and all its direct and indirect children, and return the |
| 27764 | list of variable objects whose values have changed; @var{name} must |
| 27765 | be a root variable object. Here, ``changed'' means that the result of |
| 27766 | @code{-var-evaluate-expression} before and after the |
| 27767 | @code{-var-update} is different. If @samp{*} is used as the variable |
| 27768 | object names, all existing variable objects are updated, except |
| 27769 | for frozen ones (@pxref{-var-set-frozen}). The option |
| 27770 | @var{print-values} determines whether both names and values, or just |
| 27771 | names are printed. The possible values of this option are the same |
| 27772 | as for @code{-var-list-children} (@pxref{-var-list-children}). It is |
| 27773 | recommended to use the @samp{--all-values} option, to reduce the |
| 27774 | number of MI commands needed on each program stop. |
| 27775 | |
| 27776 | With the @samp{*} parameter, if a variable object is bound to a |
| 27777 | currently running thread, it will not be updated, without any |
| 27778 | diagnostic. |
| 27779 | |
| 27780 | If @code{-var-set-update-range} was previously used on a varobj, then |
| 27781 | only the selected range of children will be reported. |
| 27782 | |
| 27783 | @code{-var-update} reports all the changed varobjs in a tuple named |
| 27784 | @samp{changelist}. |
| 27785 | |
| 27786 | Each item in the change list is itself a tuple holding: |
| 27787 | |
| 27788 | @table @samp |
| 27789 | @item name |
| 27790 | The name of the varobj. |
| 27791 | |
| 27792 | @item value |
| 27793 | If values were requested for this update, then this field will be |
| 27794 | present and will hold the value of the varobj. |
| 27795 | |
| 27796 | @item in_scope |
| 27797 | @anchor{-var-update} |
| 27798 | This field is a string which may take one of three values: |
| 27799 | |
| 27800 | @table @code |
| 27801 | @item "true" |
| 27802 | The variable object's current value is valid. |
| 27803 | |
| 27804 | @item "false" |
| 27805 | The variable object does not currently hold a valid value but it may |
| 27806 | hold one in the future if its associated expression comes back into |
| 27807 | scope. |
| 27808 | |
| 27809 | @item "invalid" |
| 27810 | The variable object no longer holds a valid value. |
| 27811 | This can occur when the executable file being debugged has changed, |
| 27812 | either through recompilation or by using the @value{GDBN} @code{file} |
| 27813 | command. The front end should normally choose to delete these variable |
| 27814 | objects. |
| 27815 | @end table |
| 27816 | |
| 27817 | In the future new values may be added to this list so the front should |
| 27818 | be prepared for this possibility. @xref{GDB/MI Development and Front Ends, ,@sc{GDB/MI} Development and Front Ends}. |
| 27819 | |
| 27820 | @item type_changed |
| 27821 | This is only present if the varobj is still valid. If the type |
| 27822 | changed, then this will be the string @samp{true}; otherwise it will |
| 27823 | be @samp{false}. |
| 27824 | |
| 27825 | @item new_type |
| 27826 | If the varobj's type changed, then this field will be present and will |
| 27827 | hold the new type. |
| 27828 | |
| 27829 | @item new_num_children |
| 27830 | For a dynamic varobj, if the number of children changed, or if the |
| 27831 | type changed, this will be the new number of children. |
| 27832 | |
| 27833 | The @samp{numchild} field in other varobj responses is generally not |
| 27834 | valid for a dynamic varobj -- it will show the number of children that |
| 27835 | @value{GDBN} knows about, but because dynamic varobjs lazily |
| 27836 | instantiate their children, this will not reflect the number of |
| 27837 | children which may be available. |
| 27838 | |
| 27839 | The @samp{new_num_children} attribute only reports changes to the |
| 27840 | number of children known by @value{GDBN}. This is the only way to |
| 27841 | detect whether an update has removed children (which necessarily can |
| 27842 | only happen at the end of the update range). |
| 27843 | |
| 27844 | @item displayhint |
| 27845 | The display hint, if any. |
| 27846 | |
| 27847 | @item has_more |
| 27848 | This is an integer value, which will be 1 if there are more children |
| 27849 | available outside the varobj's update range. |
| 27850 | |
| 27851 | @item dynamic |
| 27852 | This attribute will be present and have the value @samp{1} if the |
| 27853 | varobj is a dynamic varobj. If the varobj is not a dynamic varobj, |
| 27854 | then this attribute will not be present. |
| 27855 | |
| 27856 | @item new_children |
| 27857 | If new children were added to a dynamic varobj within the selected |
| 27858 | update range (as set by @code{-var-set-update-range}), then they will |
| 27859 | be listed in this attribute. |
| 27860 | @end table |
| 27861 | |
| 27862 | @subsubheading Example |
| 27863 | |
| 27864 | @smallexample |
| 27865 | (gdb) |
| 27866 | -var-assign var1 3 |
| 27867 | ^done,value="3" |
| 27868 | (gdb) |
| 27869 | -var-update --all-values var1 |
| 27870 | ^done,changelist=[@{name="var1",value="3",in_scope="true", |
| 27871 | type_changed="false"@}] |
| 27872 | (gdb) |
| 27873 | @end smallexample |
| 27874 | |
| 27875 | @subheading The @code{-var-set-frozen} Command |
| 27876 | @findex -var-set-frozen |
| 27877 | @anchor{-var-set-frozen} |
| 27878 | |
| 27879 | @subsubheading Synopsis |
| 27880 | |
| 27881 | @smallexample |
| 27882 | -var-set-frozen @var{name} @var{flag} |
| 27883 | @end smallexample |
| 27884 | |
| 27885 | Set the frozenness flag on the variable object @var{name}. The |
| 27886 | @var{flag} parameter should be either @samp{1} to make the variable |
| 27887 | frozen or @samp{0} to make it unfrozen. If a variable object is |
| 27888 | frozen, then neither itself, nor any of its children, are |
| 27889 | implicitly updated by @code{-var-update} of |
| 27890 | a parent variable or by @code{-var-update *}. Only |
| 27891 | @code{-var-update} of the variable itself will update its value and |
| 27892 | values of its children. After a variable object is unfrozen, it is |
| 27893 | implicitly updated by all subsequent @code{-var-update} operations. |
| 27894 | Unfreezing a variable does not update it, only subsequent |
| 27895 | @code{-var-update} does. |
| 27896 | |
| 27897 | @subsubheading Example |
| 27898 | |
| 27899 | @smallexample |
| 27900 | (gdb) |
| 27901 | -var-set-frozen V 1 |
| 27902 | ^done |
| 27903 | (gdb) |
| 27904 | @end smallexample |
| 27905 | |
| 27906 | @subheading The @code{-var-set-update-range} command |
| 27907 | @findex -var-set-update-range |
| 27908 | @anchor{-var-set-update-range} |
| 27909 | |
| 27910 | @subsubheading Synopsis |
| 27911 | |
| 27912 | @smallexample |
| 27913 | -var-set-update-range @var{name} @var{from} @var{to} |
| 27914 | @end smallexample |
| 27915 | |
| 27916 | Set the range of children to be returned by future invocations of |
| 27917 | @code{-var-update}. |
| 27918 | |
| 27919 | @var{from} and @var{to} indicate the range of children to report. If |
| 27920 | @var{from} or @var{to} is less than zero, the range is reset and all |
| 27921 | children will be reported. Otherwise, children starting at @var{from} |
| 27922 | (zero-based) and up to and excluding @var{to} will be reported. |
| 27923 | |
| 27924 | @subsubheading Example |
| 27925 | |
| 27926 | @smallexample |
| 27927 | (gdb) |
| 27928 | -var-set-update-range V 1 2 |
| 27929 | ^done |
| 27930 | @end smallexample |
| 27931 | |
| 27932 | @subheading The @code{-var-set-visualizer} command |
| 27933 | @findex -var-set-visualizer |
| 27934 | @anchor{-var-set-visualizer} |
| 27935 | |
| 27936 | @subsubheading Synopsis |
| 27937 | |
| 27938 | @smallexample |
| 27939 | -var-set-visualizer @var{name} @var{visualizer} |
| 27940 | @end smallexample |
| 27941 | |
| 27942 | Set a visualizer for the variable object @var{name}. |
| 27943 | |
| 27944 | @var{visualizer} is the visualizer to use. The special value |
| 27945 | @samp{None} means to disable any visualizer in use. |
| 27946 | |
| 27947 | If not @samp{None}, @var{visualizer} must be a Python expression. |
| 27948 | This expression must evaluate to a callable object which accepts a |
| 27949 | single argument. @value{GDBN} will call this object with the value of |
| 27950 | the varobj @var{name} as an argument (this is done so that the same |
| 27951 | Python pretty-printing code can be used for both the CLI and MI). |
| 27952 | When called, this object must return an object which conforms to the |
| 27953 | pretty-printing interface (@pxref{Pretty Printing API}). |
| 27954 | |
| 27955 | The pre-defined function @code{gdb.default_visualizer} may be used to |
| 27956 | select a visualizer by following the built-in process |
| 27957 | (@pxref{Selecting Pretty-Printers}). This is done automatically when |
| 27958 | a varobj is created, and so ordinarily is not needed. |
| 27959 | |
| 27960 | This feature is only available if Python support is enabled. The MI |
| 27961 | command @code{-list-features} (@pxref{GDB/MI Miscellaneous Commands}) |
| 27962 | can be used to check this. |
| 27963 | |
| 27964 | @subsubheading Example |
| 27965 | |
| 27966 | Resetting the visualizer: |
| 27967 | |
| 27968 | @smallexample |
| 27969 | (gdb) |
| 27970 | -var-set-visualizer V None |
| 27971 | ^done |
| 27972 | @end smallexample |
| 27973 | |
| 27974 | Reselecting the default (type-based) visualizer: |
| 27975 | |
| 27976 | @smallexample |
| 27977 | (gdb) |
| 27978 | -var-set-visualizer V gdb.default_visualizer |
| 27979 | ^done |
| 27980 | @end smallexample |
| 27981 | |
| 27982 | Suppose @code{SomeClass} is a visualizer class. A lambda expression |
| 27983 | can be used to instantiate this class for a varobj: |
| 27984 | |
| 27985 | @smallexample |
| 27986 | (gdb) |
| 27987 | -var-set-visualizer V "lambda val: SomeClass()" |
| 27988 | ^done |
| 27989 | @end smallexample |
| 27990 | |
| 27991 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 27992 | @node GDB/MI Data Manipulation |
| 27993 | @section @sc{gdb/mi} Data Manipulation |
| 27994 | |
| 27995 | @cindex data manipulation, in @sc{gdb/mi} |
| 27996 | @cindex @sc{gdb/mi}, data manipulation |
| 27997 | This section describes the @sc{gdb/mi} commands that manipulate data: |
| 27998 | examine memory and registers, evaluate expressions, etc. |
| 27999 | |
| 28000 | @c REMOVED FROM THE INTERFACE. |
| 28001 | @c @subheading -data-assign |
| 28002 | @c Change the value of a program variable. Plenty of side effects. |
| 28003 | @c @subsubheading GDB Command |
| 28004 | @c set variable |
| 28005 | @c @subsubheading Example |
| 28006 | @c N.A. |
| 28007 | |
| 28008 | @subheading The @code{-data-disassemble} Command |
| 28009 | @findex -data-disassemble |
| 28010 | |
| 28011 | @subsubheading Synopsis |
| 28012 | |
| 28013 | @smallexample |
| 28014 | -data-disassemble |
| 28015 | [ -s @var{start-addr} -e @var{end-addr} ] |
| 28016 | | [ -f @var{filename} -l @var{linenum} [ -n @var{lines} ] ] |
| 28017 | -- @var{mode} |
| 28018 | @end smallexample |
| 28019 | |
| 28020 | @noindent |
| 28021 | Where: |
| 28022 | |
| 28023 | @table @samp |
| 28024 | @item @var{start-addr} |
| 28025 | is the beginning address (or @code{$pc}) |
| 28026 | @item @var{end-addr} |
| 28027 | is the end address |
| 28028 | @item @var{filename} |
| 28029 | is the name of the file to disassemble |
| 28030 | @item @var{linenum} |
| 28031 | is the line number to disassemble around |
| 28032 | @item @var{lines} |
| 28033 | is the number of disassembly lines to be produced. If it is -1, |
| 28034 | the whole function will be disassembled, in case no @var{end-addr} is |
| 28035 | specified. If @var{end-addr} is specified as a non-zero value, and |
| 28036 | @var{lines} is lower than the number of disassembly lines between |
| 28037 | @var{start-addr} and @var{end-addr}, only @var{lines} lines are |
| 28038 | displayed; if @var{lines} is higher than the number of lines between |
| 28039 | @var{start-addr} and @var{end-addr}, only the lines up to @var{end-addr} |
| 28040 | are displayed. |
| 28041 | @item @var{mode} |
| 28042 | is either 0 (meaning only disassembly), 1 (meaning mixed source and |
| 28043 | disassembly), 2 (meaning disassembly with raw opcodes), or 3 (meaning |
| 28044 | mixed source and disassembly with raw opcodes). |
| 28045 | @end table |
| 28046 | |
| 28047 | @subsubheading Result |
| 28048 | |
| 28049 | The output for each instruction is composed of four fields: |
| 28050 | |
| 28051 | @itemize @bullet |
| 28052 | @item Address |
| 28053 | @item Func-name |
| 28054 | @item Offset |
| 28055 | @item Instruction |
| 28056 | @end itemize |
| 28057 | |
| 28058 | Note that whatever included in the instruction field, is not manipulated |
| 28059 | directly by @sc{gdb/mi}, i.e., it is not possible to adjust its format. |
| 28060 | |
| 28061 | @subsubheading @value{GDBN} Command |
| 28062 | |
| 28063 | There's no direct mapping from this command to the CLI. |
| 28064 | |
| 28065 | @subsubheading Example |
| 28066 | |
| 28067 | Disassemble from the current value of @code{$pc} to @code{$pc + 20}: |
| 28068 | |
| 28069 | @smallexample |
| 28070 | (gdb) |
| 28071 | -data-disassemble -s $pc -e "$pc + 20" -- 0 |
| 28072 | ^done, |
| 28073 | asm_insns=[ |
| 28074 | @{address="0x000107c0",func-name="main",offset="4", |
| 28075 | inst="mov 2, %o0"@}, |
| 28076 | @{address="0x000107c4",func-name="main",offset="8", |
| 28077 | inst="sethi %hi(0x11800), %o2"@}, |
| 28078 | @{address="0x000107c8",func-name="main",offset="12", |
| 28079 | inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"@}, |
| 28080 | @{address="0x000107cc",func-name="main",offset="16", |
| 28081 | inst="sethi %hi(0x11800), %o2"@}, |
| 28082 | @{address="0x000107d0",func-name="main",offset="20", |
| 28083 | inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"@}] |
| 28084 | (gdb) |
| 28085 | @end smallexample |
| 28086 | |
| 28087 | Disassemble the whole @code{main} function. Line 32 is part of |
| 28088 | @code{main}. |
| 28089 | |
| 28090 | @smallexample |
| 28091 | -data-disassemble -f basics.c -l 32 -- 0 |
| 28092 | ^done,asm_insns=[ |
| 28093 | @{address="0x000107bc",func-name="main",offset="0", |
| 28094 | inst="save %sp, -112, %sp"@}, |
| 28095 | @{address="0x000107c0",func-name="main",offset="4", |
| 28096 | inst="mov 2, %o0"@}, |
| 28097 | @{address="0x000107c4",func-name="main",offset="8", |
| 28098 | inst="sethi %hi(0x11800), %o2"@}, |
| 28099 | [@dots{}] |
| 28100 | @{address="0x0001081c",func-name="main",offset="96",inst="ret "@}, |
| 28101 | @{address="0x00010820",func-name="main",offset="100",inst="restore "@}] |
| 28102 | (gdb) |
| 28103 | @end smallexample |
| 28104 | |
| 28105 | Disassemble 3 instructions from the start of @code{main}: |
| 28106 | |
| 28107 | @smallexample |
| 28108 | (gdb) |
| 28109 | -data-disassemble -f basics.c -l 32 -n 3 -- 0 |
| 28110 | ^done,asm_insns=[ |
| 28111 | @{address="0x000107bc",func-name="main",offset="0", |
| 28112 | inst="save %sp, -112, %sp"@}, |
| 28113 | @{address="0x000107c0",func-name="main",offset="4", |
| 28114 | inst="mov 2, %o0"@}, |
| 28115 | @{address="0x000107c4",func-name="main",offset="8", |
| 28116 | inst="sethi %hi(0x11800), %o2"@}] |
| 28117 | (gdb) |
| 28118 | @end smallexample |
| 28119 | |
| 28120 | Disassemble 3 instructions from the start of @code{main} in mixed mode: |
| 28121 | |
| 28122 | @smallexample |
| 28123 | (gdb) |
| 28124 | -data-disassemble -f basics.c -l 32 -n 3 -- 1 |
| 28125 | ^done,asm_insns=[ |
| 28126 | src_and_asm_line=@{line="31", |
| 28127 | file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ |
| 28128 | testsuite/gdb.mi/basics.c",line_asm_insn=[ |
| 28129 | @{address="0x000107bc",func-name="main",offset="0", |
| 28130 | inst="save %sp, -112, %sp"@}]@}, |
| 28131 | src_and_asm_line=@{line="32", |
| 28132 | file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ |
| 28133 | testsuite/gdb.mi/basics.c",line_asm_insn=[ |
| 28134 | @{address="0x000107c0",func-name="main",offset="4", |
| 28135 | inst="mov 2, %o0"@}, |
| 28136 | @{address="0x000107c4",func-name="main",offset="8", |
| 28137 | inst="sethi %hi(0x11800), %o2"@}]@}] |
| 28138 | (gdb) |
| 28139 | @end smallexample |
| 28140 | |
| 28141 | |
| 28142 | @subheading The @code{-data-evaluate-expression} Command |
| 28143 | @findex -data-evaluate-expression |
| 28144 | |
| 28145 | @subsubheading Synopsis |
| 28146 | |
| 28147 | @smallexample |
| 28148 | -data-evaluate-expression @var{expr} |
| 28149 | @end smallexample |
| 28150 | |
| 28151 | Evaluate @var{expr} as an expression. The expression could contain an |
| 28152 | inferior function call. The function call will execute synchronously. |
| 28153 | If the expression contains spaces, it must be enclosed in double quotes. |
| 28154 | |
| 28155 | @subsubheading @value{GDBN} Command |
| 28156 | |
| 28157 | The corresponding @value{GDBN} commands are @samp{print}, @samp{output}, and |
| 28158 | @samp{call}. In @code{gdbtk} only, there's a corresponding |
| 28159 | @samp{gdb_eval} command. |
| 28160 | |
| 28161 | @subsubheading Example |
| 28162 | |
| 28163 | In the following example, the numbers that precede the commands are the |
| 28164 | @dfn{tokens} described in @ref{GDB/MI Command Syntax, ,@sc{gdb/mi} |
| 28165 | Command Syntax}. Notice how @sc{gdb/mi} returns the same tokens in its |
| 28166 | output. |
| 28167 | |
| 28168 | @smallexample |
| 28169 | 211-data-evaluate-expression A |
| 28170 | 211^done,value="1" |
| 28171 | (gdb) |
| 28172 | 311-data-evaluate-expression &A |
| 28173 | 311^done,value="0xefffeb7c" |
| 28174 | (gdb) |
| 28175 | 411-data-evaluate-expression A+3 |
| 28176 | 411^done,value="4" |
| 28177 | (gdb) |
| 28178 | 511-data-evaluate-expression "A + 3" |
| 28179 | 511^done,value="4" |
| 28180 | (gdb) |
| 28181 | @end smallexample |
| 28182 | |
| 28183 | |
| 28184 | @subheading The @code{-data-list-changed-registers} Command |
| 28185 | @findex -data-list-changed-registers |
| 28186 | |
| 28187 | @subsubheading Synopsis |
| 28188 | |
| 28189 | @smallexample |
| 28190 | -data-list-changed-registers |
| 28191 | @end smallexample |
| 28192 | |
| 28193 | Display a list of the registers that have changed. |
| 28194 | |
| 28195 | @subsubheading @value{GDBN} Command |
| 28196 | |
| 28197 | @value{GDBN} doesn't have a direct analog for this command; @code{gdbtk} |
| 28198 | has the corresponding command @samp{gdb_changed_register_list}. |
| 28199 | |
| 28200 | @subsubheading Example |
| 28201 | |
| 28202 | On a PPC MBX board: |
| 28203 | |
| 28204 | @smallexample |
| 28205 | (gdb) |
| 28206 | -exec-continue |
| 28207 | ^running |
| 28208 | |
| 28209 | (gdb) |
| 28210 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame=@{ |
| 28211 | func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c", |
| 28212 | line="5"@} |
| 28213 | (gdb) |
| 28214 | -data-list-changed-registers |
| 28215 | ^done,changed-registers=["0","1","2","4","5","6","7","8","9", |
| 28216 | "10","11","13","14","15","16","17","18","19","20","21","22","23", |
| 28217 | "24","25","26","27","28","30","31","64","65","66","67","69"] |
| 28218 | (gdb) |
| 28219 | @end smallexample |
| 28220 | |
| 28221 | |
| 28222 | @subheading The @code{-data-list-register-names} Command |
| 28223 | @findex -data-list-register-names |
| 28224 | |
| 28225 | @subsubheading Synopsis |
| 28226 | |
| 28227 | @smallexample |
| 28228 | -data-list-register-names [ ( @var{regno} )+ ] |
| 28229 | @end smallexample |
| 28230 | |
| 28231 | Show a list of register names for the current target. If no arguments |
| 28232 | are given, it shows a list of the names of all the registers. If |
| 28233 | integer numbers are given as arguments, it will print a list of the |
| 28234 | names of the registers corresponding to the arguments. To ensure |
| 28235 | consistency between a register name and its number, the output list may |
| 28236 | include empty register names. |
| 28237 | |
| 28238 | @subsubheading @value{GDBN} Command |
| 28239 | |
| 28240 | @value{GDBN} does not have a command which corresponds to |
| 28241 | @samp{-data-list-register-names}. In @code{gdbtk} there is a |
| 28242 | corresponding command @samp{gdb_regnames}. |
| 28243 | |
| 28244 | @subsubheading Example |
| 28245 | |
| 28246 | For the PPC MBX board: |
| 28247 | @smallexample |
| 28248 | (gdb) |
| 28249 | -data-list-register-names |
| 28250 | ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7", |
| 28251 | "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18", |
| 28252 | "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29", |
| 28253 | "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9", |
| 28254 | "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20", |
| 28255 | "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31", |
| 28256 | "", "pc","ps","cr","lr","ctr","xer"] |
| 28257 | (gdb) |
| 28258 | -data-list-register-names 1 2 3 |
| 28259 | ^done,register-names=["r1","r2","r3"] |
| 28260 | (gdb) |
| 28261 | @end smallexample |
| 28262 | |
| 28263 | @subheading The @code{-data-list-register-values} Command |
| 28264 | @findex -data-list-register-values |
| 28265 | |
| 28266 | @subsubheading Synopsis |
| 28267 | |
| 28268 | @smallexample |
| 28269 | -data-list-register-values @var{fmt} [ ( @var{regno} )*] |
| 28270 | @end smallexample |
| 28271 | |
| 28272 | Display the registers' contents. @var{fmt} is the format according to |
| 28273 | which the registers' contents are to be returned, followed by an optional |
| 28274 | list of numbers specifying the registers to display. A missing list of |
| 28275 | numbers indicates that the contents of all the registers must be returned. |
| 28276 | |
| 28277 | Allowed formats for @var{fmt} are: |
| 28278 | |
| 28279 | @table @code |
| 28280 | @item x |
| 28281 | Hexadecimal |
| 28282 | @item o |
| 28283 | Octal |
| 28284 | @item t |
| 28285 | Binary |
| 28286 | @item d |
| 28287 | Decimal |
| 28288 | @item r |
| 28289 | Raw |
| 28290 | @item N |
| 28291 | Natural |
| 28292 | @end table |
| 28293 | |
| 28294 | @subsubheading @value{GDBN} Command |
| 28295 | |
| 28296 | The corresponding @value{GDBN} commands are @samp{info reg}, @samp{info |
| 28297 | all-reg}, and (in @code{gdbtk}) @samp{gdb_fetch_registers}. |
| 28298 | |
| 28299 | @subsubheading Example |
| 28300 | |
| 28301 | For a PPC MBX board (note: line breaks are for readability only, they |
| 28302 | don't appear in the actual output): |
| 28303 | |
| 28304 | @smallexample |
| 28305 | (gdb) |
| 28306 | -data-list-register-values r 64 65 |
| 28307 | ^done,register-values=[@{number="64",value="0xfe00a300"@}, |
| 28308 | @{number="65",value="0x00029002"@}] |
| 28309 | (gdb) |
| 28310 | -data-list-register-values x |
| 28311 | ^done,register-values=[@{number="0",value="0xfe0043c8"@}, |
| 28312 | @{number="1",value="0x3fff88"@},@{number="2",value="0xfffffffe"@}, |
| 28313 | @{number="3",value="0x0"@},@{number="4",value="0xa"@}, |
| 28314 | @{number="5",value="0x3fff68"@},@{number="6",value="0x3fff58"@}, |
| 28315 | @{number="7",value="0xfe011e98"@},@{number="8",value="0x2"@}, |
| 28316 | @{number="9",value="0xfa202820"@},@{number="10",value="0xfa202808"@}, |
| 28317 | @{number="11",value="0x1"@},@{number="12",value="0x0"@}, |
| 28318 | @{number="13",value="0x4544"@},@{number="14",value="0xffdfffff"@}, |
| 28319 | @{number="15",value="0xffffffff"@},@{number="16",value="0xfffffeff"@}, |
| 28320 | @{number="17",value="0xefffffed"@},@{number="18",value="0xfffffffe"@}, |
| 28321 | @{number="19",value="0xffffffff"@},@{number="20",value="0xffffffff"@}, |
| 28322 | @{number="21",value="0xffffffff"@},@{number="22",value="0xfffffff7"@}, |
| 28323 | @{number="23",value="0xffffffff"@},@{number="24",value="0xffffffff"@}, |
| 28324 | @{number="25",value="0xffffffff"@},@{number="26",value="0xfffffffb"@}, |
| 28325 | @{number="27",value="0xffffffff"@},@{number="28",value="0xf7bfffff"@}, |
| 28326 | @{number="29",value="0x0"@},@{number="30",value="0xfe010000"@}, |
| 28327 | @{number="31",value="0x0"@},@{number="32",value="0x0"@}, |
| 28328 | @{number="33",value="0x0"@},@{number="34",value="0x0"@}, |
| 28329 | @{number="35",value="0x0"@},@{number="36",value="0x0"@}, |
| 28330 | @{number="37",value="0x0"@},@{number="38",value="0x0"@}, |
| 28331 | @{number="39",value="0x0"@},@{number="40",value="0x0"@}, |
| 28332 | @{number="41",value="0x0"@},@{number="42",value="0x0"@}, |
| 28333 | @{number="43",value="0x0"@},@{number="44",value="0x0"@}, |
| 28334 | @{number="45",value="0x0"@},@{number="46",value="0x0"@}, |
| 28335 | @{number="47",value="0x0"@},@{number="48",value="0x0"@}, |
| 28336 | @{number="49",value="0x0"@},@{number="50",value="0x0"@}, |
| 28337 | @{number="51",value="0x0"@},@{number="52",value="0x0"@}, |
| 28338 | @{number="53",value="0x0"@},@{number="54",value="0x0"@}, |
| 28339 | @{number="55",value="0x0"@},@{number="56",value="0x0"@}, |
| 28340 | @{number="57",value="0x0"@},@{number="58",value="0x0"@}, |
| 28341 | @{number="59",value="0x0"@},@{number="60",value="0x0"@}, |
| 28342 | @{number="61",value="0x0"@},@{number="62",value="0x0"@}, |
| 28343 | @{number="63",value="0x0"@},@{number="64",value="0xfe00a300"@}, |
| 28344 | @{number="65",value="0x29002"@},@{number="66",value="0x202f04b5"@}, |
| 28345 | @{number="67",value="0xfe0043b0"@},@{number="68",value="0xfe00b3e4"@}, |
| 28346 | @{number="69",value="0x20002b03"@}] |
| 28347 | (gdb) |
| 28348 | @end smallexample |
| 28349 | |
| 28350 | |
| 28351 | @subheading The @code{-data-read-memory} Command |
| 28352 | @findex -data-read-memory |
| 28353 | |
| 28354 | This command is deprecated, use @code{-data-read-memory-bytes} instead. |
| 28355 | |
| 28356 | @subsubheading Synopsis |
| 28357 | |
| 28358 | @smallexample |
| 28359 | -data-read-memory [ -o @var{byte-offset} ] |
| 28360 | @var{address} @var{word-format} @var{word-size} |
| 28361 | @var{nr-rows} @var{nr-cols} [ @var{aschar} ] |
| 28362 | @end smallexample |
| 28363 | |
| 28364 | @noindent |
| 28365 | where: |
| 28366 | |
| 28367 | @table @samp |
| 28368 | @item @var{address} |
| 28369 | An expression specifying the address of the first memory word to be |
| 28370 | read. Complex expressions containing embedded white space should be |
| 28371 | quoted using the C convention. |
| 28372 | |
| 28373 | @item @var{word-format} |
| 28374 | The format to be used to print the memory words. The notation is the |
| 28375 | same as for @value{GDBN}'s @code{print} command (@pxref{Output Formats, |
| 28376 | ,Output Formats}). |
| 28377 | |
| 28378 | @item @var{word-size} |
| 28379 | The size of each memory word in bytes. |
| 28380 | |
| 28381 | @item @var{nr-rows} |
| 28382 | The number of rows in the output table. |
| 28383 | |
| 28384 | @item @var{nr-cols} |
| 28385 | The number of columns in the output table. |
| 28386 | |
| 28387 | @item @var{aschar} |
| 28388 | If present, indicates that each row should include an @sc{ascii} dump. The |
| 28389 | value of @var{aschar} is used as a padding character when a byte is not a |
| 28390 | member of the printable @sc{ascii} character set (printable @sc{ascii} |
| 28391 | characters are those whose code is between 32 and 126, inclusively). |
| 28392 | |
| 28393 | @item @var{byte-offset} |
| 28394 | An offset to add to the @var{address} before fetching memory. |
| 28395 | @end table |
| 28396 | |
| 28397 | This command displays memory contents as a table of @var{nr-rows} by |
| 28398 | @var{nr-cols} words, each word being @var{word-size} bytes. In total, |
| 28399 | @code{@var{nr-rows} * @var{nr-cols} * @var{word-size}} bytes are read |
| 28400 | (returned as @samp{total-bytes}). Should less than the requested number |
| 28401 | of bytes be returned by the target, the missing words are identified |
| 28402 | using @samp{N/A}. The number of bytes read from the target is returned |
| 28403 | in @samp{nr-bytes} and the starting address used to read memory in |
| 28404 | @samp{addr}. |
| 28405 | |
| 28406 | The address of the next/previous row or page is available in |
| 28407 | @samp{next-row} and @samp{prev-row}, @samp{next-page} and |
| 28408 | @samp{prev-page}. |
| 28409 | |
| 28410 | @subsubheading @value{GDBN} Command |
| 28411 | |
| 28412 | The corresponding @value{GDBN} command is @samp{x}. @code{gdbtk} has |
| 28413 | @samp{gdb_get_mem} memory read command. |
| 28414 | |
| 28415 | @subsubheading Example |
| 28416 | |
| 28417 | Read six bytes of memory starting at @code{bytes+6} but then offset by |
| 28418 | @code{-6} bytes. Format as three rows of two columns. One byte per |
| 28419 | word. Display each word in hex. |
| 28420 | |
| 28421 | @smallexample |
| 28422 | (gdb) |
| 28423 | 9-data-read-memory -o -6 -- bytes+6 x 1 3 2 |
| 28424 | 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6", |
| 28425 | next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396", |
| 28426 | prev-page="0x0000138a",memory=[ |
| 28427 | @{addr="0x00001390",data=["0x00","0x01"]@}, |
| 28428 | @{addr="0x00001392",data=["0x02","0x03"]@}, |
| 28429 | @{addr="0x00001394",data=["0x04","0x05"]@}] |
| 28430 | (gdb) |
| 28431 | @end smallexample |
| 28432 | |
| 28433 | Read two bytes of memory starting at address @code{shorts + 64} and |
| 28434 | display as a single word formatted in decimal. |
| 28435 | |
| 28436 | @smallexample |
| 28437 | (gdb) |
| 28438 | 5-data-read-memory shorts+64 d 2 1 1 |
| 28439 | 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2", |
| 28440 | next-row="0x00001512",prev-row="0x0000150e", |
| 28441 | next-page="0x00001512",prev-page="0x0000150e",memory=[ |
| 28442 | @{addr="0x00001510",data=["128"]@}] |
| 28443 | (gdb) |
| 28444 | @end smallexample |
| 28445 | |
| 28446 | Read thirty two bytes of memory starting at @code{bytes+16} and format |
| 28447 | as eight rows of four columns. Include a string encoding with @samp{x} |
| 28448 | used as the non-printable character. |
| 28449 | |
| 28450 | @smallexample |
| 28451 | (gdb) |
| 28452 | 4-data-read-memory bytes+16 x 1 8 4 x |
| 28453 | 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32", |
| 28454 | next-row="0x000013c0",prev-row="0x0000139c", |
| 28455 | next-page="0x000013c0",prev-page="0x00001380",memory=[ |
| 28456 | @{addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"@}, |
| 28457 | @{addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"@}, |
| 28458 | @{addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"@}, |
| 28459 | @{addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"@}, |
| 28460 | @{addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"@}, |
| 28461 | @{addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&'"@}, |
| 28462 | @{addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"@}, |
| 28463 | @{addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"@}] |
| 28464 | (gdb) |
| 28465 | @end smallexample |
| 28466 | |
| 28467 | @subheading The @code{-data-read-memory-bytes} Command |
| 28468 | @findex -data-read-memory-bytes |
| 28469 | |
| 28470 | @subsubheading Synopsis |
| 28471 | |
| 28472 | @smallexample |
| 28473 | -data-read-memory-bytes [ -o @var{byte-offset} ] |
| 28474 | @var{address} @var{count} |
| 28475 | @end smallexample |
| 28476 | |
| 28477 | @noindent |
| 28478 | where: |
| 28479 | |
| 28480 | @table @samp |
| 28481 | @item @var{address} |
| 28482 | An expression specifying the address of the first memory word to be |
| 28483 | read. Complex expressions containing embedded white space should be |
| 28484 | quoted using the C convention. |
| 28485 | |
| 28486 | @item @var{count} |
| 28487 | The number of bytes to read. This should be an integer literal. |
| 28488 | |
| 28489 | @item @var{byte-offset} |
| 28490 | The offsets in bytes relative to @var{address} at which to start |
| 28491 | reading. This should be an integer literal. This option is provided |
| 28492 | so that a frontend is not required to first evaluate address and then |
| 28493 | perform address arithmetics itself. |
| 28494 | |
| 28495 | @end table |
| 28496 | |
| 28497 | This command attempts to read all accessible memory regions in the |
| 28498 | specified range. First, all regions marked as unreadable in the memory |
| 28499 | map (if one is defined) will be skipped. @xref{Memory Region |
| 28500 | Attributes}. Second, @value{GDBN} will attempt to read the remaining |
| 28501 | regions. For each one, if reading full region results in an errors, |
| 28502 | @value{GDBN} will try to read a subset of the region. |
| 28503 | |
| 28504 | In general, every single byte in the region may be readable or not, |
| 28505 | and the only way to read every readable byte is to try a read at |
| 28506 | every address, which is not practical. Therefore, @value{GDBN} will |
| 28507 | attempt to read all accessible bytes at either beginning or the end |
| 28508 | of the region, using a binary division scheme. This heuristic works |
| 28509 | well for reading accross a memory map boundary. Note that if a region |
| 28510 | has a readable range that is neither at the beginning or the end, |
| 28511 | @value{GDBN} will not read it. |
| 28512 | |
| 28513 | The result record (@pxref{GDB/MI Result Records}) that is output of |
| 28514 | the command includes a field named @samp{memory} whose content is a |
| 28515 | list of tuples. Each tuple represent a successfully read memory block |
| 28516 | and has the following fields: |
| 28517 | |
| 28518 | @table @code |
| 28519 | @item begin |
| 28520 | The start address of the memory block, as hexadecimal literal. |
| 28521 | |
| 28522 | @item end |
| 28523 | The end address of the memory block, as hexadecimal literal. |
| 28524 | |
| 28525 | @item offset |
| 28526 | The offset of the memory block, as hexadecimal literal, relative to |
| 28527 | the start address passed to @code{-data-read-memory-bytes}. |
| 28528 | |
| 28529 | @item contents |
| 28530 | The contents of the memory block, in hex. |
| 28531 | |
| 28532 | @end table |
| 28533 | |
| 28534 | |
| 28535 | |
| 28536 | @subsubheading @value{GDBN} Command |
| 28537 | |
| 28538 | The corresponding @value{GDBN} command is @samp{x}. |
| 28539 | |
| 28540 | @subsubheading Example |
| 28541 | |
| 28542 | @smallexample |
| 28543 | (gdb) |
| 28544 | -data-read-memory-bytes &a 10 |
| 28545 | ^done,memory=[@{begin="0xbffff154",offset="0x00000000", |
| 28546 | end="0xbffff15e", |
| 28547 | contents="01000000020000000300"@}] |
| 28548 | (gdb) |
| 28549 | @end smallexample |
| 28550 | |
| 28551 | |
| 28552 | @subheading The @code{-data-write-memory-bytes} Command |
| 28553 | @findex -data-write-memory-bytes |
| 28554 | |
| 28555 | @subsubheading Synopsis |
| 28556 | |
| 28557 | @smallexample |
| 28558 | -data-write-memory-bytes @var{address} @var{contents} |
| 28559 | @end smallexample |
| 28560 | |
| 28561 | @noindent |
| 28562 | where: |
| 28563 | |
| 28564 | @table @samp |
| 28565 | @item @var{address} |
| 28566 | An expression specifying the address of the first memory word to be |
| 28567 | read. Complex expressions containing embedded white space should be |
| 28568 | quoted using the C convention. |
| 28569 | |
| 28570 | @item @var{contents} |
| 28571 | The hex-encoded bytes to write. |
| 28572 | |
| 28573 | @end table |
| 28574 | |
| 28575 | @subsubheading @value{GDBN} Command |
| 28576 | |
| 28577 | There's no corresponding @value{GDBN} command. |
| 28578 | |
| 28579 | @subsubheading Example |
| 28580 | |
| 28581 | @smallexample |
| 28582 | (gdb) |
| 28583 | -data-write-memory-bytes &a "aabbccdd" |
| 28584 | ^done |
| 28585 | (gdb) |
| 28586 | @end smallexample |
| 28587 | |
| 28588 | |
| 28589 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 28590 | @node GDB/MI Tracepoint Commands |
| 28591 | @section @sc{gdb/mi} Tracepoint Commands |
| 28592 | |
| 28593 | The commands defined in this section implement MI support for |
| 28594 | tracepoints. For detailed introduction, see @ref{Tracepoints}. |
| 28595 | |
| 28596 | @subheading The @code{-trace-find} Command |
| 28597 | @findex -trace-find |
| 28598 | |
| 28599 | @subsubheading Synopsis |
| 28600 | |
| 28601 | @smallexample |
| 28602 | -trace-find @var{mode} [@var{parameters}@dots{}] |
| 28603 | @end smallexample |
| 28604 | |
| 28605 | Find a trace frame using criteria defined by @var{mode} and |
| 28606 | @var{parameters}. The following table lists permissible |
| 28607 | modes and their parameters. For details of operation, see @ref{tfind}. |
| 28608 | |
| 28609 | @table @samp |
| 28610 | |
| 28611 | @item none |
| 28612 | No parameters are required. Stops examining trace frames. |
| 28613 | |
| 28614 | @item frame-number |
| 28615 | An integer is required as parameter. Selects tracepoint frame with |
| 28616 | that index. |
| 28617 | |
| 28618 | @item tracepoint-number |
| 28619 | An integer is required as parameter. Finds next |
| 28620 | trace frame that corresponds to tracepoint with the specified number. |
| 28621 | |
| 28622 | @item pc |
| 28623 | An address is required as parameter. Finds |
| 28624 | next trace frame that corresponds to any tracepoint at the specified |
| 28625 | address. |
| 28626 | |
| 28627 | @item pc-inside-range |
| 28628 | Two addresses are required as parameters. Finds next trace |
| 28629 | frame that corresponds to a tracepoint at an address inside the |
| 28630 | specified range. Both bounds are considered to be inside the range. |
| 28631 | |
| 28632 | @item pc-outside-range |
| 28633 | Two addresses are required as parameters. Finds |
| 28634 | next trace frame that corresponds to a tracepoint at an address outside |
| 28635 | the specified range. Both bounds are considered to be inside the range. |
| 28636 | |
| 28637 | @item line |
| 28638 | Line specification is required as parameter. @xref{Specify Location}. |
| 28639 | Finds next trace frame that corresponds to a tracepoint at |
| 28640 | the specified location. |
| 28641 | |
| 28642 | @end table |
| 28643 | |
| 28644 | If @samp{none} was passed as @var{mode}, the response does not |
| 28645 | have fields. Otherwise, the response may have the following fields: |
| 28646 | |
| 28647 | @table @samp |
| 28648 | @item found |
| 28649 | This field has either @samp{0} or @samp{1} as the value, depending |
| 28650 | on whether a matching tracepoint was found. |
| 28651 | |
| 28652 | @item traceframe |
| 28653 | The index of the found traceframe. This field is present iff |
| 28654 | the @samp{found} field has value of @samp{1}. |
| 28655 | |
| 28656 | @item tracepoint |
| 28657 | The index of the found tracepoint. This field is present iff |
| 28658 | the @samp{found} field has value of @samp{1}. |
| 28659 | |
| 28660 | @item frame |
| 28661 | The information about the frame corresponding to the found trace |
| 28662 | frame. This field is present only if a trace frame was found. |
| 28663 | @xref{GDB/MI Frame Information}, for description of this field. |
| 28664 | |
| 28665 | @end table |
| 28666 | |
| 28667 | @subsubheading @value{GDBN} Command |
| 28668 | |
| 28669 | The corresponding @value{GDBN} command is @samp{tfind}. |
| 28670 | |
| 28671 | @subheading -trace-define-variable |
| 28672 | @findex -trace-define-variable |
| 28673 | |
| 28674 | @subsubheading Synopsis |
| 28675 | |
| 28676 | @smallexample |
| 28677 | -trace-define-variable @var{name} [ @var{value} ] |
| 28678 | @end smallexample |
| 28679 | |
| 28680 | Create trace variable @var{name} if it does not exist. If |
| 28681 | @var{value} is specified, sets the initial value of the specified |
| 28682 | trace variable to that value. Note that the @var{name} should start |
| 28683 | with the @samp{$} character. |
| 28684 | |
| 28685 | @subsubheading @value{GDBN} Command |
| 28686 | |
| 28687 | The corresponding @value{GDBN} command is @samp{tvariable}. |
| 28688 | |
| 28689 | @subheading -trace-list-variables |
| 28690 | @findex -trace-list-variables |
| 28691 | |
| 28692 | @subsubheading Synopsis |
| 28693 | |
| 28694 | @smallexample |
| 28695 | -trace-list-variables |
| 28696 | @end smallexample |
| 28697 | |
| 28698 | Return a table of all defined trace variables. Each element of the |
| 28699 | table has the following fields: |
| 28700 | |
| 28701 | @table @samp |
| 28702 | @item name |
| 28703 | The name of the trace variable. This field is always present. |
| 28704 | |
| 28705 | @item initial |
| 28706 | The initial value. This is a 64-bit signed integer. This |
| 28707 | field is always present. |
| 28708 | |
| 28709 | @item current |
| 28710 | The value the trace variable has at the moment. This is a 64-bit |
| 28711 | signed integer. This field is absent iff current value is |
| 28712 | not defined, for example if the trace was never run, or is |
| 28713 | presently running. |
| 28714 | |
| 28715 | @end table |
| 28716 | |
| 28717 | @subsubheading @value{GDBN} Command |
| 28718 | |
| 28719 | The corresponding @value{GDBN} command is @samp{tvariables}. |
| 28720 | |
| 28721 | @subsubheading Example |
| 28722 | |
| 28723 | @smallexample |
| 28724 | (gdb) |
| 28725 | -trace-list-variables |
| 28726 | ^done,trace-variables=@{nr_rows="1",nr_cols="3", |
| 28727 | hdr=[@{width="15",alignment="-1",col_name="name",colhdr="Name"@}, |
| 28728 | @{width="11",alignment="-1",col_name="initial",colhdr="Initial"@}, |
| 28729 | @{width="11",alignment="-1",col_name="current",colhdr="Current"@}], |
| 28730 | body=[variable=@{name="$trace_timestamp",initial="0"@} |
| 28731 | variable=@{name="$foo",initial="10",current="15"@}]@} |
| 28732 | (gdb) |
| 28733 | @end smallexample |
| 28734 | |
| 28735 | @subheading -trace-save |
| 28736 | @findex -trace-save |
| 28737 | |
| 28738 | @subsubheading Synopsis |
| 28739 | |
| 28740 | @smallexample |
| 28741 | -trace-save [-r ] @var{filename} |
| 28742 | @end smallexample |
| 28743 | |
| 28744 | Saves the collected trace data to @var{filename}. Without the |
| 28745 | @samp{-r} option, the data is downloaded from the target and saved |
| 28746 | in a local file. With the @samp{-r} option the target is asked |
| 28747 | to perform the save. |
| 28748 | |
| 28749 | @subsubheading @value{GDBN} Command |
| 28750 | |
| 28751 | The corresponding @value{GDBN} command is @samp{tsave}. |
| 28752 | |
| 28753 | |
| 28754 | @subheading -trace-start |
| 28755 | @findex -trace-start |
| 28756 | |
| 28757 | @subsubheading Synopsis |
| 28758 | |
| 28759 | @smallexample |
| 28760 | -trace-start |
| 28761 | @end smallexample |
| 28762 | |
| 28763 | Starts a tracing experiments. The result of this command does not |
| 28764 | have any fields. |
| 28765 | |
| 28766 | @subsubheading @value{GDBN} Command |
| 28767 | |
| 28768 | The corresponding @value{GDBN} command is @samp{tstart}. |
| 28769 | |
| 28770 | @subheading -trace-status |
| 28771 | @findex -trace-status |
| 28772 | |
| 28773 | @subsubheading Synopsis |
| 28774 | |
| 28775 | @smallexample |
| 28776 | -trace-status |
| 28777 | @end smallexample |
| 28778 | |
| 28779 | Obtains the status of a tracing experiment. The result may include |
| 28780 | the following fields: |
| 28781 | |
| 28782 | @table @samp |
| 28783 | |
| 28784 | @item supported |
| 28785 | May have a value of either @samp{0}, when no tracing operations are |
| 28786 | supported, @samp{1}, when all tracing operations are supported, or |
| 28787 | @samp{file} when examining trace file. In the latter case, examining |
| 28788 | of trace frame is possible but new tracing experiement cannot be |
| 28789 | started. This field is always present. |
| 28790 | |
| 28791 | @item running |
| 28792 | May have a value of either @samp{0} or @samp{1} depending on whether |
| 28793 | tracing experiement is in progress on target. This field is present |
| 28794 | if @samp{supported} field is not @samp{0}. |
| 28795 | |
| 28796 | @item stop-reason |
| 28797 | Report the reason why the tracing was stopped last time. This field |
| 28798 | may be absent iff tracing was never stopped on target yet. The |
| 28799 | value of @samp{request} means the tracing was stopped as result of |
| 28800 | the @code{-trace-stop} command. The value of @samp{overflow} means |
| 28801 | the tracing buffer is full. The value of @samp{disconnection} means |
| 28802 | tracing was automatically stopped when @value{GDBN} has disconnected. |
| 28803 | The value of @samp{passcount} means tracing was stopped when a |
| 28804 | tracepoint was passed a maximal number of times for that tracepoint. |
| 28805 | This field is present if @samp{supported} field is not @samp{0}. |
| 28806 | |
| 28807 | @item stopping-tracepoint |
| 28808 | The number of tracepoint whose passcount as exceeded. This field is |
| 28809 | present iff the @samp{stop-reason} field has the value of |
| 28810 | @samp{passcount}. |
| 28811 | |
| 28812 | @item frames |
| 28813 | @itemx frames-created |
| 28814 | The @samp{frames} field is a count of the total number of trace frames |
| 28815 | in the trace buffer, while @samp{frames-created} is the total created |
| 28816 | during the run, including ones that were discarded, such as when a |
| 28817 | circular trace buffer filled up. Both fields are optional. |
| 28818 | |
| 28819 | @item buffer-size |
| 28820 | @itemx buffer-free |
| 28821 | These fields tell the current size of the tracing buffer and the |
| 28822 | remaining space. These fields are optional. |
| 28823 | |
| 28824 | @item circular |
| 28825 | The value of the circular trace buffer flag. @code{1} means that the |
| 28826 | trace buffer is circular and old trace frames will be discarded if |
| 28827 | necessary to make room, @code{0} means that the trace buffer is linear |
| 28828 | and may fill up. |
| 28829 | |
| 28830 | @item disconnected |
| 28831 | The value of the disconnected tracing flag. @code{1} means that |
| 28832 | tracing will continue after @value{GDBN} disconnects, @code{0} means |
| 28833 | that the trace run will stop. |
| 28834 | |
| 28835 | @end table |
| 28836 | |
| 28837 | @subsubheading @value{GDBN} Command |
| 28838 | |
| 28839 | The corresponding @value{GDBN} command is @samp{tstatus}. |
| 28840 | |
| 28841 | @subheading -trace-stop |
| 28842 | @findex -trace-stop |
| 28843 | |
| 28844 | @subsubheading Synopsis |
| 28845 | |
| 28846 | @smallexample |
| 28847 | -trace-stop |
| 28848 | @end smallexample |
| 28849 | |
| 28850 | Stops a tracing experiment. The result of this command has the same |
| 28851 | fields as @code{-trace-status}, except that the @samp{supported} and |
| 28852 | @samp{running} fields are not output. |
| 28853 | |
| 28854 | @subsubheading @value{GDBN} Command |
| 28855 | |
| 28856 | The corresponding @value{GDBN} command is @samp{tstop}. |
| 28857 | |
| 28858 | |
| 28859 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 28860 | @node GDB/MI Symbol Query |
| 28861 | @section @sc{gdb/mi} Symbol Query Commands |
| 28862 | |
| 28863 | |
| 28864 | @ignore |
| 28865 | @subheading The @code{-symbol-info-address} Command |
| 28866 | @findex -symbol-info-address |
| 28867 | |
| 28868 | @subsubheading Synopsis |
| 28869 | |
| 28870 | @smallexample |
| 28871 | -symbol-info-address @var{symbol} |
| 28872 | @end smallexample |
| 28873 | |
| 28874 | Describe where @var{symbol} is stored. |
| 28875 | |
| 28876 | @subsubheading @value{GDBN} Command |
| 28877 | |
| 28878 | The corresponding @value{GDBN} command is @samp{info address}. |
| 28879 | |
| 28880 | @subsubheading Example |
| 28881 | N.A. |
| 28882 | |
| 28883 | |
| 28884 | @subheading The @code{-symbol-info-file} Command |
| 28885 | @findex -symbol-info-file |
| 28886 | |
| 28887 | @subsubheading Synopsis |
| 28888 | |
| 28889 | @smallexample |
| 28890 | -symbol-info-file |
| 28891 | @end smallexample |
| 28892 | |
| 28893 | Show the file for the symbol. |
| 28894 | |
| 28895 | @subsubheading @value{GDBN} Command |
| 28896 | |
| 28897 | There's no equivalent @value{GDBN} command. @code{gdbtk} has |
| 28898 | @samp{gdb_find_file}. |
| 28899 | |
| 28900 | @subsubheading Example |
| 28901 | N.A. |
| 28902 | |
| 28903 | |
| 28904 | @subheading The @code{-symbol-info-function} Command |
| 28905 | @findex -symbol-info-function |
| 28906 | |
| 28907 | @subsubheading Synopsis |
| 28908 | |
| 28909 | @smallexample |
| 28910 | -symbol-info-function |
| 28911 | @end smallexample |
| 28912 | |
| 28913 | Show which function the symbol lives in. |
| 28914 | |
| 28915 | @subsubheading @value{GDBN} Command |
| 28916 | |
| 28917 | @samp{gdb_get_function} in @code{gdbtk}. |
| 28918 | |
| 28919 | @subsubheading Example |
| 28920 | N.A. |
| 28921 | |
| 28922 | |
| 28923 | @subheading The @code{-symbol-info-line} Command |
| 28924 | @findex -symbol-info-line |
| 28925 | |
| 28926 | @subsubheading Synopsis |
| 28927 | |
| 28928 | @smallexample |
| 28929 | -symbol-info-line |
| 28930 | @end smallexample |
| 28931 | |
| 28932 | Show the core addresses of the code for a source line. |
| 28933 | |
| 28934 | @subsubheading @value{GDBN} Command |
| 28935 | |
| 28936 | The corresponding @value{GDBN} command is @samp{info line}. |
| 28937 | @code{gdbtk} has the @samp{gdb_get_line} and @samp{gdb_get_file} commands. |
| 28938 | |
| 28939 | @subsubheading Example |
| 28940 | N.A. |
| 28941 | |
| 28942 | |
| 28943 | @subheading The @code{-symbol-info-symbol} Command |
| 28944 | @findex -symbol-info-symbol |
| 28945 | |
| 28946 | @subsubheading Synopsis |
| 28947 | |
| 28948 | @smallexample |
| 28949 | -symbol-info-symbol @var{addr} |
| 28950 | @end smallexample |
| 28951 | |
| 28952 | Describe what symbol is at location @var{addr}. |
| 28953 | |
| 28954 | @subsubheading @value{GDBN} Command |
| 28955 | |
| 28956 | The corresponding @value{GDBN} command is @samp{info symbol}. |
| 28957 | |
| 28958 | @subsubheading Example |
| 28959 | N.A. |
| 28960 | |
| 28961 | |
| 28962 | @subheading The @code{-symbol-list-functions} Command |
| 28963 | @findex -symbol-list-functions |
| 28964 | |
| 28965 | @subsubheading Synopsis |
| 28966 | |
| 28967 | @smallexample |
| 28968 | -symbol-list-functions |
| 28969 | @end smallexample |
| 28970 | |
| 28971 | List the functions in the executable. |
| 28972 | |
| 28973 | @subsubheading @value{GDBN} Command |
| 28974 | |
| 28975 | @samp{info functions} in @value{GDBN}, @samp{gdb_listfunc} and |
| 28976 | @samp{gdb_search} in @code{gdbtk}. |
| 28977 | |
| 28978 | @subsubheading Example |
| 28979 | N.A. |
| 28980 | @end ignore |
| 28981 | |
| 28982 | |
| 28983 | @subheading The @code{-symbol-list-lines} Command |
| 28984 | @findex -symbol-list-lines |
| 28985 | |
| 28986 | @subsubheading Synopsis |
| 28987 | |
| 28988 | @smallexample |
| 28989 | -symbol-list-lines @var{filename} |
| 28990 | @end smallexample |
| 28991 | |
| 28992 | Print the list of lines that contain code and their associated program |
| 28993 | addresses for the given source filename. The entries are sorted in |
| 28994 | ascending PC order. |
| 28995 | |
| 28996 | @subsubheading @value{GDBN} Command |
| 28997 | |
| 28998 | There is no corresponding @value{GDBN} command. |
| 28999 | |
| 29000 | @subsubheading Example |
| 29001 | @smallexample |
| 29002 | (gdb) |
| 29003 | -symbol-list-lines basics.c |
| 29004 | ^done,lines=[@{pc="0x08048554",line="7"@},@{pc="0x0804855a",line="8"@}] |
| 29005 | (gdb) |
| 29006 | @end smallexample |
| 29007 | |
| 29008 | |
| 29009 | @ignore |
| 29010 | @subheading The @code{-symbol-list-types} Command |
| 29011 | @findex -symbol-list-types |
| 29012 | |
| 29013 | @subsubheading Synopsis |
| 29014 | |
| 29015 | @smallexample |
| 29016 | -symbol-list-types |
| 29017 | @end smallexample |
| 29018 | |
| 29019 | List all the type names. |
| 29020 | |
| 29021 | @subsubheading @value{GDBN} Command |
| 29022 | |
| 29023 | The corresponding commands are @samp{info types} in @value{GDBN}, |
| 29024 | @samp{gdb_search} in @code{gdbtk}. |
| 29025 | |
| 29026 | @subsubheading Example |
| 29027 | N.A. |
| 29028 | |
| 29029 | |
| 29030 | @subheading The @code{-symbol-list-variables} Command |
| 29031 | @findex -symbol-list-variables |
| 29032 | |
| 29033 | @subsubheading Synopsis |
| 29034 | |
| 29035 | @smallexample |
| 29036 | -symbol-list-variables |
| 29037 | @end smallexample |
| 29038 | |
| 29039 | List all the global and static variable names. |
| 29040 | |
| 29041 | @subsubheading @value{GDBN} Command |
| 29042 | |
| 29043 | @samp{info variables} in @value{GDBN}, @samp{gdb_search} in @code{gdbtk}. |
| 29044 | |
| 29045 | @subsubheading Example |
| 29046 | N.A. |
| 29047 | |
| 29048 | |
| 29049 | @subheading The @code{-symbol-locate} Command |
| 29050 | @findex -symbol-locate |
| 29051 | |
| 29052 | @subsubheading Synopsis |
| 29053 | |
| 29054 | @smallexample |
| 29055 | -symbol-locate |
| 29056 | @end smallexample |
| 29057 | |
| 29058 | @subsubheading @value{GDBN} Command |
| 29059 | |
| 29060 | @samp{gdb_loc} in @code{gdbtk}. |
| 29061 | |
| 29062 | @subsubheading Example |
| 29063 | N.A. |
| 29064 | |
| 29065 | |
| 29066 | @subheading The @code{-symbol-type} Command |
| 29067 | @findex -symbol-type |
| 29068 | |
| 29069 | @subsubheading Synopsis |
| 29070 | |
| 29071 | @smallexample |
| 29072 | -symbol-type @var{variable} |
| 29073 | @end smallexample |
| 29074 | |
| 29075 | Show type of @var{variable}. |
| 29076 | |
| 29077 | @subsubheading @value{GDBN} Command |
| 29078 | |
| 29079 | The corresponding @value{GDBN} command is @samp{ptype}, @code{gdbtk} has |
| 29080 | @samp{gdb_obj_variable}. |
| 29081 | |
| 29082 | @subsubheading Example |
| 29083 | N.A. |
| 29084 | @end ignore |
| 29085 | |
| 29086 | |
| 29087 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 29088 | @node GDB/MI File Commands |
| 29089 | @section @sc{gdb/mi} File Commands |
| 29090 | |
| 29091 | This section describes the GDB/MI commands to specify executable file names |
| 29092 | and to read in and obtain symbol table information. |
| 29093 | |
| 29094 | @subheading The @code{-file-exec-and-symbols} Command |
| 29095 | @findex -file-exec-and-symbols |
| 29096 | |
| 29097 | @subsubheading Synopsis |
| 29098 | |
| 29099 | @smallexample |
| 29100 | -file-exec-and-symbols @var{file} |
| 29101 | @end smallexample |
| 29102 | |
| 29103 | Specify the executable file to be debugged. This file is the one from |
| 29104 | which the symbol table is also read. If no file is specified, the |
| 29105 | command clears the executable and symbol information. If breakpoints |
| 29106 | are set when using this command with no arguments, @value{GDBN} will produce |
| 29107 | error messages. Otherwise, no output is produced, except a completion |
| 29108 | notification. |
| 29109 | |
| 29110 | @subsubheading @value{GDBN} Command |
| 29111 | |
| 29112 | The corresponding @value{GDBN} command is @samp{file}. |
| 29113 | |
| 29114 | @subsubheading Example |
| 29115 | |
| 29116 | @smallexample |
| 29117 | (gdb) |
| 29118 | -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
| 29119 | ^done |
| 29120 | (gdb) |
| 29121 | @end smallexample |
| 29122 | |
| 29123 | |
| 29124 | @subheading The @code{-file-exec-file} Command |
| 29125 | @findex -file-exec-file |
| 29126 | |
| 29127 | @subsubheading Synopsis |
| 29128 | |
| 29129 | @smallexample |
| 29130 | -file-exec-file @var{file} |
| 29131 | @end smallexample |
| 29132 | |
| 29133 | Specify the executable file to be debugged. Unlike |
| 29134 | @samp{-file-exec-and-symbols}, the symbol table is @emph{not} read |
| 29135 | from this file. If used without argument, @value{GDBN} clears the information |
| 29136 | about the executable file. No output is produced, except a completion |
| 29137 | notification. |
| 29138 | |
| 29139 | @subsubheading @value{GDBN} Command |
| 29140 | |
| 29141 | The corresponding @value{GDBN} command is @samp{exec-file}. |
| 29142 | |
| 29143 | @subsubheading Example |
| 29144 | |
| 29145 | @smallexample |
| 29146 | (gdb) |
| 29147 | -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
| 29148 | ^done |
| 29149 | (gdb) |
| 29150 | @end smallexample |
| 29151 | |
| 29152 | |
| 29153 | @ignore |
| 29154 | @subheading The @code{-file-list-exec-sections} Command |
| 29155 | @findex -file-list-exec-sections |
| 29156 | |
| 29157 | @subsubheading Synopsis |
| 29158 | |
| 29159 | @smallexample |
| 29160 | -file-list-exec-sections |
| 29161 | @end smallexample |
| 29162 | |
| 29163 | List the sections of the current executable file. |
| 29164 | |
| 29165 | @subsubheading @value{GDBN} Command |
| 29166 | |
| 29167 | The @value{GDBN} command @samp{info file} shows, among the rest, the same |
| 29168 | information as this command. @code{gdbtk} has a corresponding command |
| 29169 | @samp{gdb_load_info}. |
| 29170 | |
| 29171 | @subsubheading Example |
| 29172 | N.A. |
| 29173 | @end ignore |
| 29174 | |
| 29175 | |
| 29176 | @subheading The @code{-file-list-exec-source-file} Command |
| 29177 | @findex -file-list-exec-source-file |
| 29178 | |
| 29179 | @subsubheading Synopsis |
| 29180 | |
| 29181 | @smallexample |
| 29182 | -file-list-exec-source-file |
| 29183 | @end smallexample |
| 29184 | |
| 29185 | List the line number, the current source file, and the absolute path |
| 29186 | to the current source file for the current executable. The macro |
| 29187 | information field has a value of @samp{1} or @samp{0} depending on |
| 29188 | whether or not the file includes preprocessor macro information. |
| 29189 | |
| 29190 | @subsubheading @value{GDBN} Command |
| 29191 | |
| 29192 | The @value{GDBN} equivalent is @samp{info source} |
| 29193 | |
| 29194 | @subsubheading Example |
| 29195 | |
| 29196 | @smallexample |
| 29197 | (gdb) |
| 29198 | 123-file-list-exec-source-file |
| 29199 | 123^done,line="1",file="foo.c",fullname="/home/bar/foo.c,macro-info="1" |
| 29200 | (gdb) |
| 29201 | @end smallexample |
| 29202 | |
| 29203 | |
| 29204 | @subheading The @code{-file-list-exec-source-files} Command |
| 29205 | @findex -file-list-exec-source-files |
| 29206 | |
| 29207 | @subsubheading Synopsis |
| 29208 | |
| 29209 | @smallexample |
| 29210 | -file-list-exec-source-files |
| 29211 | @end smallexample |
| 29212 | |
| 29213 | List the source files for the current executable. |
| 29214 | |
| 29215 | It will always output the filename, but only when @value{GDBN} can find |
| 29216 | the absolute file name of a source file, will it output the fullname. |
| 29217 | |
| 29218 | @subsubheading @value{GDBN} Command |
| 29219 | |
| 29220 | The @value{GDBN} equivalent is @samp{info sources}. |
| 29221 | @code{gdbtk} has an analogous command @samp{gdb_listfiles}. |
| 29222 | |
| 29223 | @subsubheading Example |
| 29224 | @smallexample |
| 29225 | (gdb) |
| 29226 | -file-list-exec-source-files |
| 29227 | ^done,files=[ |
| 29228 | @{file=foo.c,fullname=/home/foo.c@}, |
| 29229 | @{file=/home/bar.c,fullname=/home/bar.c@}, |
| 29230 | @{file=gdb_could_not_find_fullpath.c@}] |
| 29231 | (gdb) |
| 29232 | @end smallexample |
| 29233 | |
| 29234 | @ignore |
| 29235 | @subheading The @code{-file-list-shared-libraries} Command |
| 29236 | @findex -file-list-shared-libraries |
| 29237 | |
| 29238 | @subsubheading Synopsis |
| 29239 | |
| 29240 | @smallexample |
| 29241 | -file-list-shared-libraries |
| 29242 | @end smallexample |
| 29243 | |
| 29244 | List the shared libraries in the program. |
| 29245 | |
| 29246 | @subsubheading @value{GDBN} Command |
| 29247 | |
| 29248 | The corresponding @value{GDBN} command is @samp{info shared}. |
| 29249 | |
| 29250 | @subsubheading Example |
| 29251 | N.A. |
| 29252 | |
| 29253 | |
| 29254 | @subheading The @code{-file-list-symbol-files} Command |
| 29255 | @findex -file-list-symbol-files |
| 29256 | |
| 29257 | @subsubheading Synopsis |
| 29258 | |
| 29259 | @smallexample |
| 29260 | -file-list-symbol-files |
| 29261 | @end smallexample |
| 29262 | |
| 29263 | List symbol files. |
| 29264 | |
| 29265 | @subsubheading @value{GDBN} Command |
| 29266 | |
| 29267 | The corresponding @value{GDBN} command is @samp{info file} (part of it). |
| 29268 | |
| 29269 | @subsubheading Example |
| 29270 | N.A. |
| 29271 | @end ignore |
| 29272 | |
| 29273 | |
| 29274 | @subheading The @code{-file-symbol-file} Command |
| 29275 | @findex -file-symbol-file |
| 29276 | |
| 29277 | @subsubheading Synopsis |
| 29278 | |
| 29279 | @smallexample |
| 29280 | -file-symbol-file @var{file} |
| 29281 | @end smallexample |
| 29282 | |
| 29283 | Read symbol table info from the specified @var{file} argument. When |
| 29284 | used without arguments, clears @value{GDBN}'s symbol table info. No output is |
| 29285 | produced, except for a completion notification. |
| 29286 | |
| 29287 | @subsubheading @value{GDBN} Command |
| 29288 | |
| 29289 | The corresponding @value{GDBN} command is @samp{symbol-file}. |
| 29290 | |
| 29291 | @subsubheading Example |
| 29292 | |
| 29293 | @smallexample |
| 29294 | (gdb) |
| 29295 | -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.mbx |
| 29296 | ^done |
| 29297 | (gdb) |
| 29298 | @end smallexample |
| 29299 | |
| 29300 | @ignore |
| 29301 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 29302 | @node GDB/MI Memory Overlay Commands |
| 29303 | @section @sc{gdb/mi} Memory Overlay Commands |
| 29304 | |
| 29305 | The memory overlay commands are not implemented. |
| 29306 | |
| 29307 | @c @subheading -overlay-auto |
| 29308 | |
| 29309 | @c @subheading -overlay-list-mapping-state |
| 29310 | |
| 29311 | @c @subheading -overlay-list-overlays |
| 29312 | |
| 29313 | @c @subheading -overlay-map |
| 29314 | |
| 29315 | @c @subheading -overlay-off |
| 29316 | |
| 29317 | @c @subheading -overlay-on |
| 29318 | |
| 29319 | @c @subheading -overlay-unmap |
| 29320 | |
| 29321 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 29322 | @node GDB/MI Signal Handling Commands |
| 29323 | @section @sc{gdb/mi} Signal Handling Commands |
| 29324 | |
| 29325 | Signal handling commands are not implemented. |
| 29326 | |
| 29327 | @c @subheading -signal-handle |
| 29328 | |
| 29329 | @c @subheading -signal-list-handle-actions |
| 29330 | |
| 29331 | @c @subheading -signal-list-signal-types |
| 29332 | @end ignore |
| 29333 | |
| 29334 | |
| 29335 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 29336 | @node GDB/MI Target Manipulation |
| 29337 | @section @sc{gdb/mi} Target Manipulation Commands |
| 29338 | |
| 29339 | |
| 29340 | @subheading The @code{-target-attach} Command |
| 29341 | @findex -target-attach |
| 29342 | |
| 29343 | @subsubheading Synopsis |
| 29344 | |
| 29345 | @smallexample |
| 29346 | -target-attach @var{pid} | @var{gid} | @var{file} |
| 29347 | @end smallexample |
| 29348 | |
| 29349 | Attach to a process @var{pid} or a file @var{file} outside of |
| 29350 | @value{GDBN}, or a thread group @var{gid}. If attaching to a thread |
| 29351 | group, the id previously returned by |
| 29352 | @samp{-list-thread-groups --available} must be used. |
| 29353 | |
| 29354 | @subsubheading @value{GDBN} Command |
| 29355 | |
| 29356 | The corresponding @value{GDBN} command is @samp{attach}. |
| 29357 | |
| 29358 | @subsubheading Example |
| 29359 | @smallexample |
| 29360 | (gdb) |
| 29361 | -target-attach 34 |
| 29362 | =thread-created,id="1" |
| 29363 | *stopped,thread-id="1",frame=@{addr="0xb7f7e410",func="bar",args=[]@} |
| 29364 | ^done |
| 29365 | (gdb) |
| 29366 | @end smallexample |
| 29367 | |
| 29368 | @ignore |
| 29369 | @subheading The @code{-target-compare-sections} Command |
| 29370 | @findex -target-compare-sections |
| 29371 | |
| 29372 | @subsubheading Synopsis |
| 29373 | |
| 29374 | @smallexample |
| 29375 | -target-compare-sections [ @var{section} ] |
| 29376 | @end smallexample |
| 29377 | |
| 29378 | Compare data of section @var{section} on target to the exec file. |
| 29379 | Without the argument, all sections are compared. |
| 29380 | |
| 29381 | @subsubheading @value{GDBN} Command |
| 29382 | |
| 29383 | The @value{GDBN} equivalent is @samp{compare-sections}. |
| 29384 | |
| 29385 | @subsubheading Example |
| 29386 | N.A. |
| 29387 | @end ignore |
| 29388 | |
| 29389 | |
| 29390 | @subheading The @code{-target-detach} Command |
| 29391 | @findex -target-detach |
| 29392 | |
| 29393 | @subsubheading Synopsis |
| 29394 | |
| 29395 | @smallexample |
| 29396 | -target-detach [ @var{pid} | @var{gid} ] |
| 29397 | @end smallexample |
| 29398 | |
| 29399 | Detach from the remote target which normally resumes its execution. |
| 29400 | If either @var{pid} or @var{gid} is specified, detaches from either |
| 29401 | the specified process, or specified thread group. There's no output. |
| 29402 | |
| 29403 | @subsubheading @value{GDBN} Command |
| 29404 | |
| 29405 | The corresponding @value{GDBN} command is @samp{detach}. |
| 29406 | |
| 29407 | @subsubheading Example |
| 29408 | |
| 29409 | @smallexample |
| 29410 | (gdb) |
| 29411 | -target-detach |
| 29412 | ^done |
| 29413 | (gdb) |
| 29414 | @end smallexample |
| 29415 | |
| 29416 | |
| 29417 | @subheading The @code{-target-disconnect} Command |
| 29418 | @findex -target-disconnect |
| 29419 | |
| 29420 | @subsubheading Synopsis |
| 29421 | |
| 29422 | @smallexample |
| 29423 | -target-disconnect |
| 29424 | @end smallexample |
| 29425 | |
| 29426 | Disconnect from the remote target. There's no output and the target is |
| 29427 | generally not resumed. |
| 29428 | |
| 29429 | @subsubheading @value{GDBN} Command |
| 29430 | |
| 29431 | The corresponding @value{GDBN} command is @samp{disconnect}. |
| 29432 | |
| 29433 | @subsubheading Example |
| 29434 | |
| 29435 | @smallexample |
| 29436 | (gdb) |
| 29437 | -target-disconnect |
| 29438 | ^done |
| 29439 | (gdb) |
| 29440 | @end smallexample |
| 29441 | |
| 29442 | |
| 29443 | @subheading The @code{-target-download} Command |
| 29444 | @findex -target-download |
| 29445 | |
| 29446 | @subsubheading Synopsis |
| 29447 | |
| 29448 | @smallexample |
| 29449 | -target-download |
| 29450 | @end smallexample |
| 29451 | |
| 29452 | Loads the executable onto the remote target. |
| 29453 | It prints out an update message every half second, which includes the fields: |
| 29454 | |
| 29455 | @table @samp |
| 29456 | @item section |
| 29457 | The name of the section. |
| 29458 | @item section-sent |
| 29459 | The size of what has been sent so far for that section. |
| 29460 | @item section-size |
| 29461 | The size of the section. |
| 29462 | @item total-sent |
| 29463 | The total size of what was sent so far (the current and the previous sections). |
| 29464 | @item total-size |
| 29465 | The size of the overall executable to download. |
| 29466 | @end table |
| 29467 | |
| 29468 | @noindent |
| 29469 | Each message is sent as status record (@pxref{GDB/MI Output Syntax, , |
| 29470 | @sc{gdb/mi} Output Syntax}). |
| 29471 | |
| 29472 | In addition, it prints the name and size of the sections, as they are |
| 29473 | downloaded. These messages include the following fields: |
| 29474 | |
| 29475 | @table @samp |
| 29476 | @item section |
| 29477 | The name of the section. |
| 29478 | @item section-size |
| 29479 | The size of the section. |
| 29480 | @item total-size |
| 29481 | The size of the overall executable to download. |
| 29482 | @end table |
| 29483 | |
| 29484 | @noindent |
| 29485 | At the end, a summary is printed. |
| 29486 | |
| 29487 | @subsubheading @value{GDBN} Command |
| 29488 | |
| 29489 | The corresponding @value{GDBN} command is @samp{load}. |
| 29490 | |
| 29491 | @subsubheading Example |
| 29492 | |
| 29493 | Note: each status message appears on a single line. Here the messages |
| 29494 | have been broken down so that they can fit onto a page. |
| 29495 | |
| 29496 | @smallexample |
| 29497 | (gdb) |
| 29498 | -target-download |
| 29499 | +download,@{section=".text",section-size="6668",total-size="9880"@} |
| 29500 | +download,@{section=".text",section-sent="512",section-size="6668", |
| 29501 | total-sent="512",total-size="9880"@} |
| 29502 | +download,@{section=".text",section-sent="1024",section-size="6668", |
| 29503 | total-sent="1024",total-size="9880"@} |
| 29504 | +download,@{section=".text",section-sent="1536",section-size="6668", |
| 29505 | total-sent="1536",total-size="9880"@} |
| 29506 | +download,@{section=".text",section-sent="2048",section-size="6668", |
| 29507 | total-sent="2048",total-size="9880"@} |
| 29508 | +download,@{section=".text",section-sent="2560",section-size="6668", |
| 29509 | total-sent="2560",total-size="9880"@} |
| 29510 | +download,@{section=".text",section-sent="3072",section-size="6668", |
| 29511 | total-sent="3072",total-size="9880"@} |
| 29512 | +download,@{section=".text",section-sent="3584",section-size="6668", |
| 29513 | total-sent="3584",total-size="9880"@} |
| 29514 | +download,@{section=".text",section-sent="4096",section-size="6668", |
| 29515 | total-sent="4096",total-size="9880"@} |
| 29516 | +download,@{section=".text",section-sent="4608",section-size="6668", |
| 29517 | total-sent="4608",total-size="9880"@} |
| 29518 | +download,@{section=".text",section-sent="5120",section-size="6668", |
| 29519 | total-sent="5120",total-size="9880"@} |
| 29520 | +download,@{section=".text",section-sent="5632",section-size="6668", |
| 29521 | total-sent="5632",total-size="9880"@} |
| 29522 | +download,@{section=".text",section-sent="6144",section-size="6668", |
| 29523 | total-sent="6144",total-size="9880"@} |
| 29524 | +download,@{section=".text",section-sent="6656",section-size="6668", |
| 29525 | total-sent="6656",total-size="9880"@} |
| 29526 | +download,@{section=".init",section-size="28",total-size="9880"@} |
| 29527 | +download,@{section=".fini",section-size="28",total-size="9880"@} |
| 29528 | +download,@{section=".data",section-size="3156",total-size="9880"@} |
| 29529 | +download,@{section=".data",section-sent="512",section-size="3156", |
| 29530 | total-sent="7236",total-size="9880"@} |
| 29531 | +download,@{section=".data",section-sent="1024",section-size="3156", |
| 29532 | total-sent="7748",total-size="9880"@} |
| 29533 | +download,@{section=".data",section-sent="1536",section-size="3156", |
| 29534 | total-sent="8260",total-size="9880"@} |
| 29535 | +download,@{section=".data",section-sent="2048",section-size="3156", |
| 29536 | total-sent="8772",total-size="9880"@} |
| 29537 | +download,@{section=".data",section-sent="2560",section-size="3156", |
| 29538 | total-sent="9284",total-size="9880"@} |
| 29539 | +download,@{section=".data",section-sent="3072",section-size="3156", |
| 29540 | total-sent="9796",total-size="9880"@} |
| 29541 | ^done,address="0x10004",load-size="9880",transfer-rate="6586", |
| 29542 | write-rate="429" |
| 29543 | (gdb) |
| 29544 | @end smallexample |
| 29545 | |
| 29546 | |
| 29547 | @ignore |
| 29548 | @subheading The @code{-target-exec-status} Command |
| 29549 | @findex -target-exec-status |
| 29550 | |
| 29551 | @subsubheading Synopsis |
| 29552 | |
| 29553 | @smallexample |
| 29554 | -target-exec-status |
| 29555 | @end smallexample |
| 29556 | |
| 29557 | Provide information on the state of the target (whether it is running or |
| 29558 | not, for instance). |
| 29559 | |
| 29560 | @subsubheading @value{GDBN} Command |
| 29561 | |
| 29562 | There's no equivalent @value{GDBN} command. |
| 29563 | |
| 29564 | @subsubheading Example |
| 29565 | N.A. |
| 29566 | |
| 29567 | |
| 29568 | @subheading The @code{-target-list-available-targets} Command |
| 29569 | @findex -target-list-available-targets |
| 29570 | |
| 29571 | @subsubheading Synopsis |
| 29572 | |
| 29573 | @smallexample |
| 29574 | -target-list-available-targets |
| 29575 | @end smallexample |
| 29576 | |
| 29577 | List the possible targets to connect to. |
| 29578 | |
| 29579 | @subsubheading @value{GDBN} Command |
| 29580 | |
| 29581 | The corresponding @value{GDBN} command is @samp{help target}. |
| 29582 | |
| 29583 | @subsubheading Example |
| 29584 | N.A. |
| 29585 | |
| 29586 | |
| 29587 | @subheading The @code{-target-list-current-targets} Command |
| 29588 | @findex -target-list-current-targets |
| 29589 | |
| 29590 | @subsubheading Synopsis |
| 29591 | |
| 29592 | @smallexample |
| 29593 | -target-list-current-targets |
| 29594 | @end smallexample |
| 29595 | |
| 29596 | Describe the current target. |
| 29597 | |
| 29598 | @subsubheading @value{GDBN} Command |
| 29599 | |
| 29600 | The corresponding information is printed by @samp{info file} (among |
| 29601 | other things). |
| 29602 | |
| 29603 | @subsubheading Example |
| 29604 | N.A. |
| 29605 | |
| 29606 | |
| 29607 | @subheading The @code{-target-list-parameters} Command |
| 29608 | @findex -target-list-parameters |
| 29609 | |
| 29610 | @subsubheading Synopsis |
| 29611 | |
| 29612 | @smallexample |
| 29613 | -target-list-parameters |
| 29614 | @end smallexample |
| 29615 | |
| 29616 | @c ???? |
| 29617 | @end ignore |
| 29618 | |
| 29619 | @subsubheading @value{GDBN} Command |
| 29620 | |
| 29621 | No equivalent. |
| 29622 | |
| 29623 | @subsubheading Example |
| 29624 | N.A. |
| 29625 | |
| 29626 | |
| 29627 | @subheading The @code{-target-select} Command |
| 29628 | @findex -target-select |
| 29629 | |
| 29630 | @subsubheading Synopsis |
| 29631 | |
| 29632 | @smallexample |
| 29633 | -target-select @var{type} @var{parameters @dots{}} |
| 29634 | @end smallexample |
| 29635 | |
| 29636 | Connect @value{GDBN} to the remote target. This command takes two args: |
| 29637 | |
| 29638 | @table @samp |
| 29639 | @item @var{type} |
| 29640 | The type of target, for instance @samp{remote}, etc. |
| 29641 | @item @var{parameters} |
| 29642 | Device names, host names and the like. @xref{Target Commands, , |
| 29643 | Commands for Managing Targets}, for more details. |
| 29644 | @end table |
| 29645 | |
| 29646 | The output is a connection notification, followed by the address at |
| 29647 | which the target program is, in the following form: |
| 29648 | |
| 29649 | @smallexample |
| 29650 | ^connected,addr="@var{address}",func="@var{function name}", |
| 29651 | args=[@var{arg list}] |
| 29652 | @end smallexample |
| 29653 | |
| 29654 | @subsubheading @value{GDBN} Command |
| 29655 | |
| 29656 | The corresponding @value{GDBN} command is @samp{target}. |
| 29657 | |
| 29658 | @subsubheading Example |
| 29659 | |
| 29660 | @smallexample |
| 29661 | (gdb) |
| 29662 | -target-select remote /dev/ttya |
| 29663 | ^connected,addr="0xfe00a300",func="??",args=[] |
| 29664 | (gdb) |
| 29665 | @end smallexample |
| 29666 | |
| 29667 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 29668 | @node GDB/MI File Transfer Commands |
| 29669 | @section @sc{gdb/mi} File Transfer Commands |
| 29670 | |
| 29671 | |
| 29672 | @subheading The @code{-target-file-put} Command |
| 29673 | @findex -target-file-put |
| 29674 | |
| 29675 | @subsubheading Synopsis |
| 29676 | |
| 29677 | @smallexample |
| 29678 | -target-file-put @var{hostfile} @var{targetfile} |
| 29679 | @end smallexample |
| 29680 | |
| 29681 | Copy file @var{hostfile} from the host system (the machine running |
| 29682 | @value{GDBN}) to @var{targetfile} on the target system. |
| 29683 | |
| 29684 | @subsubheading @value{GDBN} Command |
| 29685 | |
| 29686 | The corresponding @value{GDBN} command is @samp{remote put}. |
| 29687 | |
| 29688 | @subsubheading Example |
| 29689 | |
| 29690 | @smallexample |
| 29691 | (gdb) |
| 29692 | -target-file-put localfile remotefile |
| 29693 | ^done |
| 29694 | (gdb) |
| 29695 | @end smallexample |
| 29696 | |
| 29697 | |
| 29698 | @subheading The @code{-target-file-get} Command |
| 29699 | @findex -target-file-get |
| 29700 | |
| 29701 | @subsubheading Synopsis |
| 29702 | |
| 29703 | @smallexample |
| 29704 | -target-file-get @var{targetfile} @var{hostfile} |
| 29705 | @end smallexample |
| 29706 | |
| 29707 | Copy file @var{targetfile} from the target system to @var{hostfile} |
| 29708 | on the host system. |
| 29709 | |
| 29710 | @subsubheading @value{GDBN} Command |
| 29711 | |
| 29712 | The corresponding @value{GDBN} command is @samp{remote get}. |
| 29713 | |
| 29714 | @subsubheading Example |
| 29715 | |
| 29716 | @smallexample |
| 29717 | (gdb) |
| 29718 | -target-file-get remotefile localfile |
| 29719 | ^done |
| 29720 | (gdb) |
| 29721 | @end smallexample |
| 29722 | |
| 29723 | |
| 29724 | @subheading The @code{-target-file-delete} Command |
| 29725 | @findex -target-file-delete |
| 29726 | |
| 29727 | @subsubheading Synopsis |
| 29728 | |
| 29729 | @smallexample |
| 29730 | -target-file-delete @var{targetfile} |
| 29731 | @end smallexample |
| 29732 | |
| 29733 | Delete @var{targetfile} from the target system. |
| 29734 | |
| 29735 | @subsubheading @value{GDBN} Command |
| 29736 | |
| 29737 | The corresponding @value{GDBN} command is @samp{remote delete}. |
| 29738 | |
| 29739 | @subsubheading Example |
| 29740 | |
| 29741 | @smallexample |
| 29742 | (gdb) |
| 29743 | -target-file-delete remotefile |
| 29744 | ^done |
| 29745 | (gdb) |
| 29746 | @end smallexample |
| 29747 | |
| 29748 | |
| 29749 | @c %%%%%%%%%%%%%%%%%%%%%%%%%%%% SECTION %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 29750 | @node GDB/MI Miscellaneous Commands |
| 29751 | @section Miscellaneous @sc{gdb/mi} Commands |
| 29752 | |
| 29753 | @c @subheading -gdb-complete |
| 29754 | |
| 29755 | @subheading The @code{-gdb-exit} Command |
| 29756 | @findex -gdb-exit |
| 29757 | |
| 29758 | @subsubheading Synopsis |
| 29759 | |
| 29760 | @smallexample |
| 29761 | -gdb-exit |
| 29762 | @end smallexample |
| 29763 | |
| 29764 | Exit @value{GDBN} immediately. |
| 29765 | |
| 29766 | @subsubheading @value{GDBN} Command |
| 29767 | |
| 29768 | Approximately corresponds to @samp{quit}. |
| 29769 | |
| 29770 | @subsubheading Example |
| 29771 | |
| 29772 | @smallexample |
| 29773 | (gdb) |
| 29774 | -gdb-exit |
| 29775 | ^exit |
| 29776 | @end smallexample |
| 29777 | |
| 29778 | |
| 29779 | @ignore |
| 29780 | @subheading The @code{-exec-abort} Command |
| 29781 | @findex -exec-abort |
| 29782 | |
| 29783 | @subsubheading Synopsis |
| 29784 | |
| 29785 | @smallexample |
| 29786 | -exec-abort |
| 29787 | @end smallexample |
| 29788 | |
| 29789 | Kill the inferior running program. |
| 29790 | |
| 29791 | @subsubheading @value{GDBN} Command |
| 29792 | |
| 29793 | The corresponding @value{GDBN} command is @samp{kill}. |
| 29794 | |
| 29795 | @subsubheading Example |
| 29796 | N.A. |
| 29797 | @end ignore |
| 29798 | |
| 29799 | |
| 29800 | @subheading The @code{-gdb-set} Command |
| 29801 | @findex -gdb-set |
| 29802 | |
| 29803 | @subsubheading Synopsis |
| 29804 | |
| 29805 | @smallexample |
| 29806 | -gdb-set |
| 29807 | @end smallexample |
| 29808 | |
| 29809 | Set an internal @value{GDBN} variable. |
| 29810 | @c IS THIS A DOLLAR VARIABLE? OR SOMETHING LIKE ANNOTATE ????? |
| 29811 | |
| 29812 | @subsubheading @value{GDBN} Command |
| 29813 | |
| 29814 | The corresponding @value{GDBN} command is @samp{set}. |
| 29815 | |
| 29816 | @subsubheading Example |
| 29817 | |
| 29818 | @smallexample |
| 29819 | (gdb) |
| 29820 | -gdb-set $foo=3 |
| 29821 | ^done |
| 29822 | (gdb) |
| 29823 | @end smallexample |
| 29824 | |
| 29825 | |
| 29826 | @subheading The @code{-gdb-show} Command |
| 29827 | @findex -gdb-show |
| 29828 | |
| 29829 | @subsubheading Synopsis |
| 29830 | |
| 29831 | @smallexample |
| 29832 | -gdb-show |
| 29833 | @end smallexample |
| 29834 | |
| 29835 | Show the current value of a @value{GDBN} variable. |
| 29836 | |
| 29837 | @subsubheading @value{GDBN} Command |
| 29838 | |
| 29839 | The corresponding @value{GDBN} command is @samp{show}. |
| 29840 | |
| 29841 | @subsubheading Example |
| 29842 | |
| 29843 | @smallexample |
| 29844 | (gdb) |
| 29845 | -gdb-show annotate |
| 29846 | ^done,value="0" |
| 29847 | (gdb) |
| 29848 | @end smallexample |
| 29849 | |
| 29850 | @c @subheading -gdb-source |
| 29851 | |
| 29852 | |
| 29853 | @subheading The @code{-gdb-version} Command |
| 29854 | @findex -gdb-version |
| 29855 | |
| 29856 | @subsubheading Synopsis |
| 29857 | |
| 29858 | @smallexample |
| 29859 | -gdb-version |
| 29860 | @end smallexample |
| 29861 | |
| 29862 | Show version information for @value{GDBN}. Used mostly in testing. |
| 29863 | |
| 29864 | @subsubheading @value{GDBN} Command |
| 29865 | |
| 29866 | The @value{GDBN} equivalent is @samp{show version}. @value{GDBN} by |
| 29867 | default shows this information when you start an interactive session. |
| 29868 | |
| 29869 | @subsubheading Example |
| 29870 | |
| 29871 | @c This example modifies the actual output from GDB to avoid overfull |
| 29872 | @c box in TeX. |
| 29873 | @smallexample |
| 29874 | (gdb) |
| 29875 | -gdb-version |
| 29876 | ~GNU gdb 5.2.1 |
| 29877 | ~Copyright 2000 Free Software Foundation, Inc. |
| 29878 | ~GDB is free software, covered by the GNU General Public License, and |
| 29879 | ~you are welcome to change it and/or distribute copies of it under |
| 29880 | ~ certain conditions. |
| 29881 | ~Type "show copying" to see the conditions. |
| 29882 | ~There is absolutely no warranty for GDB. Type "show warranty" for |
| 29883 | ~ details. |
| 29884 | ~This GDB was configured as |
| 29885 | "--host=sparc-sun-solaris2.5.1 --target=ppc-eabi". |
| 29886 | ^done |
| 29887 | (gdb) |
| 29888 | @end smallexample |
| 29889 | |
| 29890 | @subheading The @code{-list-features} Command |
| 29891 | @findex -list-features |
| 29892 | |
| 29893 | Returns a list of particular features of the MI protocol that |
| 29894 | this version of gdb implements. A feature can be a command, |
| 29895 | or a new field in an output of some command, or even an |
| 29896 | important bugfix. While a frontend can sometimes detect presence |
| 29897 | of a feature at runtime, it is easier to perform detection at debugger |
| 29898 | startup. |
| 29899 | |
| 29900 | The command returns a list of strings, with each string naming an |
| 29901 | available feature. Each returned string is just a name, it does not |
| 29902 | have any internal structure. The list of possible feature names |
| 29903 | is given below. |
| 29904 | |
| 29905 | Example output: |
| 29906 | |
| 29907 | @smallexample |
| 29908 | (gdb) -list-features |
| 29909 | ^done,result=["feature1","feature2"] |
| 29910 | @end smallexample |
| 29911 | |
| 29912 | The current list of features is: |
| 29913 | |
| 29914 | @table @samp |
| 29915 | @item frozen-varobjs |
| 29916 | Indicates presence of the @code{-var-set-frozen} command, as well |
| 29917 | as possible presense of the @code{frozen} field in the output |
| 29918 | of @code{-varobj-create}. |
| 29919 | @item pending-breakpoints |
| 29920 | Indicates presence of the @option{-f} option to the @code{-break-insert} command. |
| 29921 | @item python |
| 29922 | Indicates presence of Python scripting support, Python-based |
| 29923 | pretty-printing commands, and possible presence of the |
| 29924 | @samp{display_hint} field in the output of @code{-var-list-children} |
| 29925 | @item thread-info |
| 29926 | Indicates presence of the @code{-thread-info} command. |
| 29927 | @item data-read-memory-bytes |
| 29928 | Indicates presense of the @code{-data-read-memory-bytes} and the |
| 29929 | @code{-data-write-memory-bytes} commands. |
| 29930 | |
| 29931 | @end table |
| 29932 | |
| 29933 | @subheading The @code{-list-target-features} Command |
| 29934 | @findex -list-target-features |
| 29935 | |
| 29936 | Returns a list of particular features that are supported by the |
| 29937 | target. Those features affect the permitted MI commands, but |
| 29938 | unlike the features reported by the @code{-list-features} command, the |
| 29939 | features depend on which target GDB is using at the moment. Whenever |
| 29940 | a target can change, due to commands such as @code{-target-select}, |
| 29941 | @code{-target-attach} or @code{-exec-run}, the list of target features |
| 29942 | may change, and the frontend should obtain it again. |
| 29943 | Example output: |
| 29944 | |
| 29945 | @smallexample |
| 29946 | (gdb) -list-features |
| 29947 | ^done,result=["async"] |
| 29948 | @end smallexample |
| 29949 | |
| 29950 | The current list of features is: |
| 29951 | |
| 29952 | @table @samp |
| 29953 | @item async |
| 29954 | Indicates that the target is capable of asynchronous command |
| 29955 | execution, which means that @value{GDBN} will accept further commands |
| 29956 | while the target is running. |
| 29957 | |
| 29958 | @item reverse |
| 29959 | Indicates that the target is capable of reverse execution. |
| 29960 | @xref{Reverse Execution}, for more information. |
| 29961 | |
| 29962 | @end table |
| 29963 | |
| 29964 | @subheading The @code{-list-thread-groups} Command |
| 29965 | @findex -list-thread-groups |
| 29966 | |
| 29967 | @subheading Synopsis |
| 29968 | |
| 29969 | @smallexample |
| 29970 | -list-thread-groups [ --available ] [ --recurse 1 ] [ @var{group} ... ] |
| 29971 | @end smallexample |
| 29972 | |
| 29973 | Lists thread groups (@pxref{Thread groups}). When a single thread |
| 29974 | group is passed as the argument, lists the children of that group. |
| 29975 | When several thread group are passed, lists information about those |
| 29976 | thread groups. Without any parameters, lists information about all |
| 29977 | top-level thread groups. |
| 29978 | |
| 29979 | Normally, thread groups that are being debugged are reported. |
| 29980 | With the @samp{--available} option, @value{GDBN} reports thread groups |
| 29981 | available on the target. |
| 29982 | |
| 29983 | The output of this command may have either a @samp{threads} result or |
| 29984 | a @samp{groups} result. The @samp{thread} result has a list of tuples |
| 29985 | as value, with each tuple describing a thread (@pxref{GDB/MI Thread |
| 29986 | Information}). The @samp{groups} result has a list of tuples as value, |
| 29987 | each tuple describing a thread group. If top-level groups are |
| 29988 | requested (that is, no parameter is passed), or when several groups |
| 29989 | are passed, the output always has a @samp{groups} result. The format |
| 29990 | of the @samp{group} result is described below. |
| 29991 | |
| 29992 | To reduce the number of roundtrips it's possible to list thread groups |
| 29993 | together with their children, by passing the @samp{--recurse} option |
| 29994 | and the recursion depth. Presently, only recursion depth of 1 is |
| 29995 | permitted. If this option is present, then every reported thread group |
| 29996 | will also include its children, either as @samp{group} or |
| 29997 | @samp{threads} field. |
| 29998 | |
| 29999 | In general, any combination of option and parameters is permitted, with |
| 30000 | the following caveats: |
| 30001 | |
| 30002 | @itemize @bullet |
| 30003 | @item |
| 30004 | When a single thread group is passed, the output will typically |
| 30005 | be the @samp{threads} result. Because threads may not contain |
| 30006 | anything, the @samp{recurse} option will be ignored. |
| 30007 | |
| 30008 | @item |
| 30009 | When the @samp{--available} option is passed, limited information may |
| 30010 | be available. In particular, the list of threads of a process might |
| 30011 | be inaccessible. Further, specifying specific thread groups might |
| 30012 | not give any performance advantage over listing all thread groups. |
| 30013 | The frontend should assume that @samp{-list-thread-groups --available} |
| 30014 | is always an expensive operation and cache the results. |
| 30015 | |
| 30016 | @end itemize |
| 30017 | |
| 30018 | The @samp{groups} result is a list of tuples, where each tuple may |
| 30019 | have the following fields: |
| 30020 | |
| 30021 | @table @code |
| 30022 | @item id |
| 30023 | Identifier of the thread group. This field is always present. |
| 30024 | The identifier is an opaque string; frontends should not try to |
| 30025 | convert it to an integer, even though it might look like one. |
| 30026 | |
| 30027 | @item type |
| 30028 | The type of the thread group. At present, only @samp{process} is a |
| 30029 | valid type. |
| 30030 | |
| 30031 | @item pid |
| 30032 | The target-specific process identifier. This field is only present |
| 30033 | for thread groups of type @samp{process} and only if the process exists. |
| 30034 | |
| 30035 | @item num_children |
| 30036 | The number of children this thread group has. This field may be |
| 30037 | absent for an available thread group. |
| 30038 | |
| 30039 | @item threads |
| 30040 | This field has a list of tuples as value, each tuple describing a |
| 30041 | thread. It may be present if the @samp{--recurse} option is |
| 30042 | specified, and it's actually possible to obtain the threads. |
| 30043 | |
| 30044 | @item cores |
| 30045 | This field is a list of integers, each identifying a core that one |
| 30046 | thread of the group is running on. This field may be absent if |
| 30047 | such information is not available. |
| 30048 | |
| 30049 | @item executable |
| 30050 | The name of the executable file that corresponds to this thread group. |
| 30051 | The field is only present for thread groups of type @samp{process}, |
| 30052 | and only if there is a corresponding executable file. |
| 30053 | |
| 30054 | @end table |
| 30055 | |
| 30056 | @subheading Example |
| 30057 | |
| 30058 | @smallexample |
| 30059 | @value{GDBP} |
| 30060 | -list-thread-groups |
| 30061 | ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2"@}] |
| 30062 | -list-thread-groups 17 |
| 30063 | ^done,threads=[@{id="2",target-id="Thread 0xb7e14b90 (LWP 21257)", |
| 30064 | frame=@{level="0",addr="0xffffe410",func="__kernel_vsyscall",args=[]@},state="running"@}, |
| 30065 | @{id="1",target-id="Thread 0xb7e156b0 (LWP 21254)", |
| 30066 | frame=@{level="0",addr="0x0804891f",func="foo",args=[@{name="i",value="10"@}], |
| 30067 | file="/tmp/a.c",fullname="/tmp/a.c",line="158"@},state="running"@}]] |
| 30068 | -list-thread-groups --available |
| 30069 | ^done,groups=[@{id="17",type="process",pid="yyy",num_children="2",cores=[1,2]@}] |
| 30070 | -list-thread-groups --available --recurse 1 |
| 30071 | ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2], |
| 30072 | threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@}, |
| 30073 | @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},..] |
| 30074 | -list-thread-groups --available --recurse 1 17 18 |
| 30075 | ^done,groups=[@{id="17", types="process",pid="yyy",num_children="2",cores=[1,2], |
| 30076 | threads=[@{id="1",target-id="Thread 0xb7e14b90",cores=[1]@}, |
| 30077 | @{id="2",target-id="Thread 0xb7e14b90",cores=[2]@}]@},...] |
| 30078 | @end smallexample |
| 30079 | |
| 30080 | |
| 30081 | @subheading The @code{-add-inferior} Command |
| 30082 | @findex -add-inferior |
| 30083 | |
| 30084 | @subheading Synopsis |
| 30085 | |
| 30086 | @smallexample |
| 30087 | -add-inferior |
| 30088 | @end smallexample |
| 30089 | |
| 30090 | Creates a new inferior (@pxref{Inferiors and Programs}). The created |
| 30091 | inferior is not associated with any executable. Such association may |
| 30092 | be established with the @samp{-file-exec-and-symbols} command |
| 30093 | (@pxref{GDB/MI File Commands}). The command response has a single |
| 30094 | field, @samp{thread-group}, whose value is the identifier of the |
| 30095 | thread group corresponding to the new inferior. |
| 30096 | |
| 30097 | @subheading Example |
| 30098 | |
| 30099 | @smallexample |
| 30100 | @value{GDBP} |
| 30101 | -add-inferior |
| 30102 | ^done,thread-group="i3" |
| 30103 | @end smallexample |
| 30104 | |
| 30105 | @subheading The @code{-interpreter-exec} Command |
| 30106 | @findex -interpreter-exec |
| 30107 | |
| 30108 | @subheading Synopsis |
| 30109 | |
| 30110 | @smallexample |
| 30111 | -interpreter-exec @var{interpreter} @var{command} |
| 30112 | @end smallexample |
| 30113 | @anchor{-interpreter-exec} |
| 30114 | |
| 30115 | Execute the specified @var{command} in the given @var{interpreter}. |
| 30116 | |
| 30117 | @subheading @value{GDBN} Command |
| 30118 | |
| 30119 | The corresponding @value{GDBN} command is @samp{interpreter-exec}. |
| 30120 | |
| 30121 | @subheading Example |
| 30122 | |
| 30123 | @smallexample |
| 30124 | (gdb) |
| 30125 | -interpreter-exec console "break main" |
| 30126 | &"During symbol reading, couldn't parse type; debugger out of date?.\n" |
| 30127 | &"During symbol reading, bad structure-type format.\n" |
| 30128 | ~"Breakpoint 1 at 0x8074fc6: file ../../src/gdb/main.c, line 743.\n" |
| 30129 | ^done |
| 30130 | (gdb) |
| 30131 | @end smallexample |
| 30132 | |
| 30133 | @subheading The @code{-inferior-tty-set} Command |
| 30134 | @findex -inferior-tty-set |
| 30135 | |
| 30136 | @subheading Synopsis |
| 30137 | |
| 30138 | @smallexample |
| 30139 | -inferior-tty-set /dev/pts/1 |
| 30140 | @end smallexample |
| 30141 | |
| 30142 | Set terminal for future runs of the program being debugged. |
| 30143 | |
| 30144 | @subheading @value{GDBN} Command |
| 30145 | |
| 30146 | The corresponding @value{GDBN} command is @samp{set inferior-tty} /dev/pts/1. |
| 30147 | |
| 30148 | @subheading Example |
| 30149 | |
| 30150 | @smallexample |
| 30151 | (gdb) |
| 30152 | -inferior-tty-set /dev/pts/1 |
| 30153 | ^done |
| 30154 | (gdb) |
| 30155 | @end smallexample |
| 30156 | |
| 30157 | @subheading The @code{-inferior-tty-show} Command |
| 30158 | @findex -inferior-tty-show |
| 30159 | |
| 30160 | @subheading Synopsis |
| 30161 | |
| 30162 | @smallexample |
| 30163 | -inferior-tty-show |
| 30164 | @end smallexample |
| 30165 | |
| 30166 | Show terminal for future runs of program being debugged. |
| 30167 | |
| 30168 | @subheading @value{GDBN} Command |
| 30169 | |
| 30170 | The corresponding @value{GDBN} command is @samp{show inferior-tty}. |
| 30171 | |
| 30172 | @subheading Example |
| 30173 | |
| 30174 | @smallexample |
| 30175 | (gdb) |
| 30176 | -inferior-tty-set /dev/pts/1 |
| 30177 | ^done |
| 30178 | (gdb) |
| 30179 | -inferior-tty-show |
| 30180 | ^done,inferior_tty_terminal="/dev/pts/1" |
| 30181 | (gdb) |
| 30182 | @end smallexample |
| 30183 | |
| 30184 | @subheading The @code{-enable-timings} Command |
| 30185 | @findex -enable-timings |
| 30186 | |
| 30187 | @subheading Synopsis |
| 30188 | |
| 30189 | @smallexample |
| 30190 | -enable-timings [yes | no] |
| 30191 | @end smallexample |
| 30192 | |
| 30193 | Toggle the printing of the wallclock, user and system times for an MI |
| 30194 | command as a field in its output. This command is to help frontend |
| 30195 | developers optimize the performance of their code. No argument is |
| 30196 | equivalent to @samp{yes}. |
| 30197 | |
| 30198 | @subheading @value{GDBN} Command |
| 30199 | |
| 30200 | No equivalent. |
| 30201 | |
| 30202 | @subheading Example |
| 30203 | |
| 30204 | @smallexample |
| 30205 | (gdb) |
| 30206 | -enable-timings |
| 30207 | ^done |
| 30208 | (gdb) |
| 30209 | -break-insert main |
| 30210 | ^done,bkpt=@{number="1",type="breakpoint",disp="keep",enabled="y", |
| 30211 | addr="0x080484ed",func="main",file="myprog.c", |
| 30212 | fullname="/home/nickrob/myprog.c",line="73",times="0"@}, |
| 30213 | time=@{wallclock="0.05185",user="0.00800",system="0.00000"@} |
| 30214 | (gdb) |
| 30215 | -enable-timings no |
| 30216 | ^done |
| 30217 | (gdb) |
| 30218 | -exec-run |
| 30219 | ^running |
| 30220 | (gdb) |
| 30221 | *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",thread-id="0", |
| 30222 | frame=@{addr="0x080484ed",func="main",args=[@{name="argc",value="1"@}, |
| 30223 | @{name="argv",value="0xbfb60364"@}],file="myprog.c", |
| 30224 | fullname="/home/nickrob/myprog.c",line="73"@} |
| 30225 | (gdb) |
| 30226 | @end smallexample |
| 30227 | |
| 30228 | @node Annotations |
| 30229 | @chapter @value{GDBN} Annotations |
| 30230 | |
| 30231 | This chapter describes annotations in @value{GDBN}. Annotations were |
| 30232 | designed to interface @value{GDBN} to graphical user interfaces or other |
| 30233 | similar programs which want to interact with @value{GDBN} at a |
| 30234 | relatively high level. |
| 30235 | |
| 30236 | The annotation mechanism has largely been superseded by @sc{gdb/mi} |
| 30237 | (@pxref{GDB/MI}). |
| 30238 | |
| 30239 | @ignore |
| 30240 | This is Edition @value{EDITION}, @value{DATE}. |
| 30241 | @end ignore |
| 30242 | |
| 30243 | @menu |
| 30244 | * Annotations Overview:: What annotations are; the general syntax. |
| 30245 | * Server Prefix:: Issuing a command without affecting user state. |
| 30246 | * Prompting:: Annotations marking @value{GDBN}'s need for input. |
| 30247 | * Errors:: Annotations for error messages. |
| 30248 | * Invalidation:: Some annotations describe things now invalid. |
| 30249 | * Annotations for Running:: |
| 30250 | Whether the program is running, how it stopped, etc. |
| 30251 | * Source Annotations:: Annotations describing source code. |
| 30252 | @end menu |
| 30253 | |
| 30254 | @node Annotations Overview |
| 30255 | @section What is an Annotation? |
| 30256 | @cindex annotations |
| 30257 | |
| 30258 | Annotations start with a newline character, two @samp{control-z} |
| 30259 | characters, and the name of the annotation. If there is no additional |
| 30260 | information associated with this annotation, the name of the annotation |
| 30261 | is followed immediately by a newline. If there is additional |
| 30262 | information, the name of the annotation is followed by a space, the |
| 30263 | additional information, and a newline. The additional information |
| 30264 | cannot contain newline characters. |
| 30265 | |
| 30266 | Any output not beginning with a newline and two @samp{control-z} |
| 30267 | characters denotes literal output from @value{GDBN}. Currently there is |
| 30268 | no need for @value{GDBN} to output a newline followed by two |
| 30269 | @samp{control-z} characters, but if there was such a need, the |
| 30270 | annotations could be extended with an @samp{escape} annotation which |
| 30271 | means those three characters as output. |
| 30272 | |
| 30273 | The annotation @var{level}, which is specified using the |
| 30274 | @option{--annotate} command line option (@pxref{Mode Options}), controls |
| 30275 | how much information @value{GDBN} prints together with its prompt, |
| 30276 | values of expressions, source lines, and other types of output. Level 0 |
| 30277 | is for no annotations, level 1 is for use when @value{GDBN} is run as a |
| 30278 | subprocess of @sc{gnu} Emacs, level 3 is the maximum annotation suitable |
| 30279 | for programs that control @value{GDBN}, and level 2 annotations have |
| 30280 | been made obsolete (@pxref{Limitations, , Limitations of the Annotation |
| 30281 | Interface, annotate, GDB's Obsolete Annotations}). |
| 30282 | |
| 30283 | @table @code |
| 30284 | @kindex set annotate |
| 30285 | @item set annotate @var{level} |
| 30286 | The @value{GDBN} command @code{set annotate} sets the level of |
| 30287 | annotations to the specified @var{level}. |
| 30288 | |
| 30289 | @item show annotate |
| 30290 | @kindex show annotate |
| 30291 | Show the current annotation level. |
| 30292 | @end table |
| 30293 | |
| 30294 | This chapter describes level 3 annotations. |
| 30295 | |
| 30296 | A simple example of starting up @value{GDBN} with annotations is: |
| 30297 | |
| 30298 | @smallexample |
| 30299 | $ @kbd{gdb --annotate=3} |
| 30300 | GNU gdb 6.0 |
| 30301 | Copyright 2003 Free Software Foundation, Inc. |
| 30302 | GDB is free software, covered by the GNU General Public License, |
| 30303 | and you are welcome to change it and/or distribute copies of it |
| 30304 | under certain conditions. |
| 30305 | Type "show copying" to see the conditions. |
| 30306 | There is absolutely no warranty for GDB. Type "show warranty" |
| 30307 | for details. |
| 30308 | This GDB was configured as "i386-pc-linux-gnu" |
| 30309 | |
| 30310 | ^Z^Zpre-prompt |
| 30311 | (@value{GDBP}) |
| 30312 | ^Z^Zprompt |
| 30313 | @kbd{quit} |
| 30314 | |
| 30315 | ^Z^Zpost-prompt |
| 30316 | $ |
| 30317 | @end smallexample |
| 30318 | |
| 30319 | Here @samp{quit} is input to @value{GDBN}; the rest is output from |
| 30320 | @value{GDBN}. The three lines beginning @samp{^Z^Z} (where @samp{^Z} |
| 30321 | denotes a @samp{control-z} character) are annotations; the rest is |
| 30322 | output from @value{GDBN}. |
| 30323 | |
| 30324 | @node Server Prefix |
| 30325 | @section The Server Prefix |
| 30326 | @cindex server prefix |
| 30327 | |
| 30328 | If you prefix a command with @samp{server } then it will not affect |
| 30329 | the command history, nor will it affect @value{GDBN}'s notion of which |
| 30330 | command to repeat if @key{RET} is pressed on a line by itself. This |
| 30331 | means that commands can be run behind a user's back by a front-end in |
| 30332 | a transparent manner. |
| 30333 | |
| 30334 | The @code{server } prefix does not affect the recording of values into |
| 30335 | the value history; to print a value without recording it into the |
| 30336 | value history, use the @code{output} command instead of the |
| 30337 | @code{print} command. |
| 30338 | |
| 30339 | Using this prefix also disables confirmation requests |
| 30340 | (@pxref{confirmation requests}). |
| 30341 | |
| 30342 | @node Prompting |
| 30343 | @section Annotation for @value{GDBN} Input |
| 30344 | |
| 30345 | @cindex annotations for prompts |
| 30346 | When @value{GDBN} prompts for input, it annotates this fact so it is possible |
| 30347 | to know when to send output, when the output from a given command is |
| 30348 | over, etc. |
| 30349 | |
| 30350 | Different kinds of input each have a different @dfn{input type}. Each |
| 30351 | input type has three annotations: a @code{pre-} annotation, which |
| 30352 | denotes the beginning of any prompt which is being output, a plain |
| 30353 | annotation, which denotes the end of the prompt, and then a @code{post-} |
| 30354 | annotation which denotes the end of any echo which may (or may not) be |
| 30355 | associated with the input. For example, the @code{prompt} input type |
| 30356 | features the following annotations: |
| 30357 | |
| 30358 | @smallexample |
| 30359 | ^Z^Zpre-prompt |
| 30360 | ^Z^Zprompt |
| 30361 | ^Z^Zpost-prompt |
| 30362 | @end smallexample |
| 30363 | |
| 30364 | The input types are |
| 30365 | |
| 30366 | @table @code |
| 30367 | @findex pre-prompt annotation |
| 30368 | @findex prompt annotation |
| 30369 | @findex post-prompt annotation |
| 30370 | @item prompt |
| 30371 | When @value{GDBN} is prompting for a command (the main @value{GDBN} prompt). |
| 30372 | |
| 30373 | @findex pre-commands annotation |
| 30374 | @findex commands annotation |
| 30375 | @findex post-commands annotation |
| 30376 | @item commands |
| 30377 | When @value{GDBN} prompts for a set of commands, like in the @code{commands} |
| 30378 | command. The annotations are repeated for each command which is input. |
| 30379 | |
| 30380 | @findex pre-overload-choice annotation |
| 30381 | @findex overload-choice annotation |
| 30382 | @findex post-overload-choice annotation |
| 30383 | @item overload-choice |
| 30384 | When @value{GDBN} wants the user to select between various overloaded functions. |
| 30385 | |
| 30386 | @findex pre-query annotation |
| 30387 | @findex query annotation |
| 30388 | @findex post-query annotation |
| 30389 | @item query |
| 30390 | When @value{GDBN} wants the user to confirm a potentially dangerous operation. |
| 30391 | |
| 30392 | @findex pre-prompt-for-continue annotation |
| 30393 | @findex prompt-for-continue annotation |
| 30394 | @findex post-prompt-for-continue annotation |
| 30395 | @item prompt-for-continue |
| 30396 | When @value{GDBN} is asking the user to press return to continue. Note: Don't |
| 30397 | expect this to work well; instead use @code{set height 0} to disable |
| 30398 | prompting. This is because the counting of lines is buggy in the |
| 30399 | presence of annotations. |
| 30400 | @end table |
| 30401 | |
| 30402 | @node Errors |
| 30403 | @section Errors |
| 30404 | @cindex annotations for errors, warnings and interrupts |
| 30405 | |
| 30406 | @findex quit annotation |
| 30407 | @smallexample |
| 30408 | ^Z^Zquit |
| 30409 | @end smallexample |
| 30410 | |
| 30411 | This annotation occurs right before @value{GDBN} responds to an interrupt. |
| 30412 | |
| 30413 | @findex error annotation |
| 30414 | @smallexample |
| 30415 | ^Z^Zerror |
| 30416 | @end smallexample |
| 30417 | |
| 30418 | This annotation occurs right before @value{GDBN} responds to an error. |
| 30419 | |
| 30420 | Quit and error annotations indicate that any annotations which @value{GDBN} was |
| 30421 | in the middle of may end abruptly. For example, if a |
| 30422 | @code{value-history-begin} annotation is followed by a @code{error}, one |
| 30423 | cannot expect to receive the matching @code{value-history-end}. One |
| 30424 | cannot expect not to receive it either, however; an error annotation |
| 30425 | does not necessarily mean that @value{GDBN} is immediately returning all the way |
| 30426 | to the top level. |
| 30427 | |
| 30428 | @findex error-begin annotation |
| 30429 | A quit or error annotation may be preceded by |
| 30430 | |
| 30431 | @smallexample |
| 30432 | ^Z^Zerror-begin |
| 30433 | @end smallexample |
| 30434 | |
| 30435 | Any output between that and the quit or error annotation is the error |
| 30436 | message. |
| 30437 | |
| 30438 | Warning messages are not yet annotated. |
| 30439 | @c If we want to change that, need to fix warning(), type_error(), |
| 30440 | @c range_error(), and possibly other places. |
| 30441 | |
| 30442 | @node Invalidation |
| 30443 | @section Invalidation Notices |
| 30444 | |
| 30445 | @cindex annotations for invalidation messages |
| 30446 | The following annotations say that certain pieces of state may have |
| 30447 | changed. |
| 30448 | |
| 30449 | @table @code |
| 30450 | @findex frames-invalid annotation |
| 30451 | @item ^Z^Zframes-invalid |
| 30452 | |
| 30453 | The frames (for example, output from the @code{backtrace} command) may |
| 30454 | have changed. |
| 30455 | |
| 30456 | @findex breakpoints-invalid annotation |
| 30457 | @item ^Z^Zbreakpoints-invalid |
| 30458 | |
| 30459 | The breakpoints may have changed. For example, the user just added or |
| 30460 | deleted a breakpoint. |
| 30461 | @end table |
| 30462 | |
| 30463 | @node Annotations for Running |
| 30464 | @section Running the Program |
| 30465 | @cindex annotations for running programs |
| 30466 | |
| 30467 | @findex starting annotation |
| 30468 | @findex stopping annotation |
| 30469 | When the program starts executing due to a @value{GDBN} command such as |
| 30470 | @code{step} or @code{continue}, |
| 30471 | |
| 30472 | @smallexample |
| 30473 | ^Z^Zstarting |
| 30474 | @end smallexample |
| 30475 | |
| 30476 | is output. When the program stops, |
| 30477 | |
| 30478 | @smallexample |
| 30479 | ^Z^Zstopped |
| 30480 | @end smallexample |
| 30481 | |
| 30482 | is output. Before the @code{stopped} annotation, a variety of |
| 30483 | annotations describe how the program stopped. |
| 30484 | |
| 30485 | @table @code |
| 30486 | @findex exited annotation |
| 30487 | @item ^Z^Zexited @var{exit-status} |
| 30488 | The program exited, and @var{exit-status} is the exit status (zero for |
| 30489 | successful exit, otherwise nonzero). |
| 30490 | |
| 30491 | @findex signalled annotation |
| 30492 | @findex signal-name annotation |
| 30493 | @findex signal-name-end annotation |
| 30494 | @findex signal-string annotation |
| 30495 | @findex signal-string-end annotation |
| 30496 | @item ^Z^Zsignalled |
| 30497 | The program exited with a signal. After the @code{^Z^Zsignalled}, the |
| 30498 | annotation continues: |
| 30499 | |
| 30500 | @smallexample |
| 30501 | @var{intro-text} |
| 30502 | ^Z^Zsignal-name |
| 30503 | @var{name} |
| 30504 | ^Z^Zsignal-name-end |
| 30505 | @var{middle-text} |
| 30506 | ^Z^Zsignal-string |
| 30507 | @var{string} |
| 30508 | ^Z^Zsignal-string-end |
| 30509 | @var{end-text} |
| 30510 | @end smallexample |
| 30511 | |
| 30512 | @noindent |
| 30513 | where @var{name} is the name of the signal, such as @code{SIGILL} or |
| 30514 | @code{SIGSEGV}, and @var{string} is the explanation of the signal, such |
| 30515 | as @code{Illegal Instruction} or @code{Segmentation fault}. |
| 30516 | @var{intro-text}, @var{middle-text}, and @var{end-text} are for the |
| 30517 | user's benefit and have no particular format. |
| 30518 | |
| 30519 | @findex signal annotation |
| 30520 | @item ^Z^Zsignal |
| 30521 | The syntax of this annotation is just like @code{signalled}, but @value{GDBN} is |
| 30522 | just saying that the program received the signal, not that it was |
| 30523 | terminated with it. |
| 30524 | |
| 30525 | @findex breakpoint annotation |
| 30526 | @item ^Z^Zbreakpoint @var{number} |
| 30527 | The program hit breakpoint number @var{number}. |
| 30528 | |
| 30529 | @findex watchpoint annotation |
| 30530 | @item ^Z^Zwatchpoint @var{number} |
| 30531 | The program hit watchpoint number @var{number}. |
| 30532 | @end table |
| 30533 | |
| 30534 | @node Source Annotations |
| 30535 | @section Displaying Source |
| 30536 | @cindex annotations for source display |
| 30537 | |
| 30538 | @findex source annotation |
| 30539 | The following annotation is used instead of displaying source code: |
| 30540 | |
| 30541 | @smallexample |
| 30542 | ^Z^Zsource @var{filename}:@var{line}:@var{character}:@var{middle}:@var{addr} |
| 30543 | @end smallexample |
| 30544 | |
| 30545 | where @var{filename} is an absolute file name indicating which source |
| 30546 | file, @var{line} is the line number within that file (where 1 is the |
| 30547 | first line in the file), @var{character} is the character position |
| 30548 | within the file (where 0 is the first character in the file) (for most |
| 30549 | debug formats this will necessarily point to the beginning of a line), |
| 30550 | @var{middle} is @samp{middle} if @var{addr} is in the middle of the |
| 30551 | line, or @samp{beg} if @var{addr} is at the beginning of the line, and |
| 30552 | @var{addr} is the address in the target program associated with the |
| 30553 | source which is being displayed. @var{addr} is in the form @samp{0x} |
| 30554 | followed by one or more lowercase hex digits (note that this does not |
| 30555 | depend on the language). |
| 30556 | |
| 30557 | @node JIT Interface |
| 30558 | @chapter JIT Compilation Interface |
| 30559 | @cindex just-in-time compilation |
| 30560 | @cindex JIT compilation interface |
| 30561 | |
| 30562 | This chapter documents @value{GDBN}'s @dfn{just-in-time} (JIT) compilation |
| 30563 | interface. A JIT compiler is a program or library that generates native |
| 30564 | executable code at runtime and executes it, usually in order to achieve good |
| 30565 | performance while maintaining platform independence. |
| 30566 | |
| 30567 | Programs that use JIT compilation are normally difficult to debug because |
| 30568 | portions of their code are generated at runtime, instead of being loaded from |
| 30569 | object files, which is where @value{GDBN} normally finds the program's symbols |
| 30570 | and debug information. In order to debug programs that use JIT compilation, |
| 30571 | @value{GDBN} has an interface that allows the program to register in-memory |
| 30572 | symbol files with @value{GDBN} at runtime. |
| 30573 | |
| 30574 | If you are using @value{GDBN} to debug a program that uses this interface, then |
| 30575 | it should work transparently so long as you have not stripped the binary. If |
| 30576 | you are developing a JIT compiler, then the interface is documented in the rest |
| 30577 | of this chapter. At this time, the only known client of this interface is the |
| 30578 | LLVM JIT. |
| 30579 | |
| 30580 | Broadly speaking, the JIT interface mirrors the dynamic loader interface. The |
| 30581 | JIT compiler communicates with @value{GDBN} by writing data into a global |
| 30582 | variable and calling a fuction at a well-known symbol. When @value{GDBN} |
| 30583 | attaches, it reads a linked list of symbol files from the global variable to |
| 30584 | find existing code, and puts a breakpoint in the function so that it can find |
| 30585 | out about additional code. |
| 30586 | |
| 30587 | @menu |
| 30588 | * Declarations:: Relevant C struct declarations |
| 30589 | * Registering Code:: Steps to register code |
| 30590 | * Unregistering Code:: Steps to unregister code |
| 30591 | @end menu |
| 30592 | |
| 30593 | @node Declarations |
| 30594 | @section JIT Declarations |
| 30595 | |
| 30596 | These are the relevant struct declarations that a C program should include to |
| 30597 | implement the interface: |
| 30598 | |
| 30599 | @smallexample |
| 30600 | typedef enum |
| 30601 | @{ |
| 30602 | JIT_NOACTION = 0, |
| 30603 | JIT_REGISTER_FN, |
| 30604 | JIT_UNREGISTER_FN |
| 30605 | @} jit_actions_t; |
| 30606 | |
| 30607 | struct jit_code_entry |
| 30608 | @{ |
| 30609 | struct jit_code_entry *next_entry; |
| 30610 | struct jit_code_entry *prev_entry; |
| 30611 | const char *symfile_addr; |
| 30612 | uint64_t symfile_size; |
| 30613 | @}; |
| 30614 | |
| 30615 | struct jit_descriptor |
| 30616 | @{ |
| 30617 | uint32_t version; |
| 30618 | /* This type should be jit_actions_t, but we use uint32_t |
| 30619 | to be explicit about the bitwidth. */ |
| 30620 | uint32_t action_flag; |
| 30621 | struct jit_code_entry *relevant_entry; |
| 30622 | struct jit_code_entry *first_entry; |
| 30623 | @}; |
| 30624 | |
| 30625 | /* GDB puts a breakpoint in this function. */ |
| 30626 | void __attribute__((noinline)) __jit_debug_register_code() @{ @}; |
| 30627 | |
| 30628 | /* Make sure to specify the version statically, because the |
| 30629 | debugger may check the version before we can set it. */ |
| 30630 | struct jit_descriptor __jit_debug_descriptor = @{ 1, 0, 0, 0 @}; |
| 30631 | @end smallexample |
| 30632 | |
| 30633 | If the JIT is multi-threaded, then it is important that the JIT synchronize any |
| 30634 | modifications to this global data properly, which can easily be done by putting |
| 30635 | a global mutex around modifications to these structures. |
| 30636 | |
| 30637 | @node Registering Code |
| 30638 | @section Registering Code |
| 30639 | |
| 30640 | To register code with @value{GDBN}, the JIT should follow this protocol: |
| 30641 | |
| 30642 | @itemize @bullet |
| 30643 | @item |
| 30644 | Generate an object file in memory with symbols and other desired debug |
| 30645 | information. The file must include the virtual addresses of the sections. |
| 30646 | |
| 30647 | @item |
| 30648 | Create a code entry for the file, which gives the start and size of the symbol |
| 30649 | file. |
| 30650 | |
| 30651 | @item |
| 30652 | Add it to the linked list in the JIT descriptor. |
| 30653 | |
| 30654 | @item |
| 30655 | Point the relevant_entry field of the descriptor at the entry. |
| 30656 | |
| 30657 | @item |
| 30658 | Set @code{action_flag} to @code{JIT_REGISTER} and call |
| 30659 | @code{__jit_debug_register_code}. |
| 30660 | @end itemize |
| 30661 | |
| 30662 | When @value{GDBN} is attached and the breakpoint fires, @value{GDBN} uses the |
| 30663 | @code{relevant_entry} pointer so it doesn't have to walk the list looking for |
| 30664 | new code. However, the linked list must still be maintained in order to allow |
| 30665 | @value{GDBN} to attach to a running process and still find the symbol files. |
| 30666 | |
| 30667 | @node Unregistering Code |
| 30668 | @section Unregistering Code |
| 30669 | |
| 30670 | If code is freed, then the JIT should use the following protocol: |
| 30671 | |
| 30672 | @itemize @bullet |
| 30673 | @item |
| 30674 | Remove the code entry corresponding to the code from the linked list. |
| 30675 | |
| 30676 | @item |
| 30677 | Point the @code{relevant_entry} field of the descriptor at the code entry. |
| 30678 | |
| 30679 | @item |
| 30680 | Set @code{action_flag} to @code{JIT_UNREGISTER} and call |
| 30681 | @code{__jit_debug_register_code}. |
| 30682 | @end itemize |
| 30683 | |
| 30684 | If the JIT frees or recompiles code without unregistering it, then @value{GDBN} |
| 30685 | and the JIT will leak the memory used for the associated symbol files. |
| 30686 | |
| 30687 | @node GDB Bugs |
| 30688 | @chapter Reporting Bugs in @value{GDBN} |
| 30689 | @cindex bugs in @value{GDBN} |
| 30690 | @cindex reporting bugs in @value{GDBN} |
| 30691 | |
| 30692 | Your bug reports play an essential role in making @value{GDBN} reliable. |
| 30693 | |
| 30694 | Reporting a bug may help you by bringing a solution to your problem, or it |
| 30695 | may not. But in any case the principal function of a bug report is to help |
| 30696 | the entire community by making the next version of @value{GDBN} work better. Bug |
| 30697 | reports are your contribution to the maintenance of @value{GDBN}. |
| 30698 | |
| 30699 | In order for a bug report to serve its purpose, you must include the |
| 30700 | information that enables us to fix the bug. |
| 30701 | |
| 30702 | @menu |
| 30703 | * Bug Criteria:: Have you found a bug? |
| 30704 | * Bug Reporting:: How to report bugs |
| 30705 | @end menu |
| 30706 | |
| 30707 | @node Bug Criteria |
| 30708 | @section Have You Found a Bug? |
| 30709 | @cindex bug criteria |
| 30710 | |
| 30711 | If you are not sure whether you have found a bug, here are some guidelines: |
| 30712 | |
| 30713 | @itemize @bullet |
| 30714 | @cindex fatal signal |
| 30715 | @cindex debugger crash |
| 30716 | @cindex crash of debugger |
| 30717 | @item |
| 30718 | If the debugger gets a fatal signal, for any input whatever, that is a |
| 30719 | @value{GDBN} bug. Reliable debuggers never crash. |
| 30720 | |
| 30721 | @cindex error on valid input |
| 30722 | @item |
| 30723 | If @value{GDBN} produces an error message for valid input, that is a |
| 30724 | bug. (Note that if you're cross debugging, the problem may also be |
| 30725 | somewhere in the connection to the target.) |
| 30726 | |
| 30727 | @cindex invalid input |
| 30728 | @item |
| 30729 | If @value{GDBN} does not produce an error message for invalid input, |
| 30730 | that is a bug. However, you should note that your idea of |
| 30731 | ``invalid input'' might be our idea of ``an extension'' or ``support |
| 30732 | for traditional practice''. |
| 30733 | |
| 30734 | @item |
| 30735 | If you are an experienced user of debugging tools, your suggestions |
| 30736 | for improvement of @value{GDBN} are welcome in any case. |
| 30737 | @end itemize |
| 30738 | |
| 30739 | @node Bug Reporting |
| 30740 | @section How to Report Bugs |
| 30741 | @cindex bug reports |
| 30742 | @cindex @value{GDBN} bugs, reporting |
| 30743 | |
| 30744 | A number of companies and individuals offer support for @sc{gnu} products. |
| 30745 | If you obtained @value{GDBN} from a support organization, we recommend you |
| 30746 | contact that organization first. |
| 30747 | |
| 30748 | You can find contact information for many support companies and |
| 30749 | individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs |
| 30750 | distribution. |
| 30751 | @c should add a web page ref... |
| 30752 | |
| 30753 | @ifset BUGURL |
| 30754 | @ifset BUGURL_DEFAULT |
| 30755 | In any event, we also recommend that you submit bug reports for |
| 30756 | @value{GDBN}. The preferred method is to submit them directly using |
| 30757 | @uref{http://www.gnu.org/software/gdb/bugs/, @value{GDBN}'s Bugs web |
| 30758 | page}. Alternatively, the @email{bug-gdb@@gnu.org, e-mail gateway} can |
| 30759 | be used. |
| 30760 | |
| 30761 | @strong{Do not send bug reports to @samp{info-gdb}, or to |
| 30762 | @samp{help-gdb}, or to any newsgroups.} Most users of @value{GDBN} do |
| 30763 | not want to receive bug reports. Those that do have arranged to receive |
| 30764 | @samp{bug-gdb}. |
| 30765 | |
| 30766 | The mailing list @samp{bug-gdb} has a newsgroup @samp{gnu.gdb.bug} which |
| 30767 | serves as a repeater. The mailing list and the newsgroup carry exactly |
| 30768 | the same messages. Often people think of posting bug reports to the |
| 30769 | newsgroup instead of mailing them. This appears to work, but it has one |
| 30770 | problem which can be crucial: a newsgroup posting often lacks a mail |
| 30771 | path back to the sender. Thus, if we need to ask for more information, |
| 30772 | we may be unable to reach you. For this reason, it is better to send |
| 30773 | bug reports to the mailing list. |
| 30774 | @end ifset |
| 30775 | @ifclear BUGURL_DEFAULT |
| 30776 | In any event, we also recommend that you submit bug reports for |
| 30777 | @value{GDBN} to @value{BUGURL}. |
| 30778 | @end ifclear |
| 30779 | @end ifset |
| 30780 | |
| 30781 | The fundamental principle of reporting bugs usefully is this: |
| 30782 | @strong{report all the facts}. If you are not sure whether to state a |
| 30783 | fact or leave it out, state it! |
| 30784 | |
| 30785 | Often people omit facts because they think they know what causes the |
| 30786 | problem and assume that some details do not matter. Thus, you might |
| 30787 | assume that the name of the variable you use in an example does not matter. |
| 30788 | Well, probably it does not, but one cannot be sure. Perhaps the bug is a |
| 30789 | stray memory reference which happens to fetch from the location where that |
| 30790 | name is stored in memory; perhaps, if the name were different, the contents |
| 30791 | of that location would fool the debugger into doing the right thing despite |
| 30792 | the bug. Play it safe and give a specific, complete example. That is the |
| 30793 | easiest thing for you to do, and the most helpful. |
| 30794 | |
| 30795 | Keep in mind that the purpose of a bug report is to enable us to fix the |
| 30796 | bug. It may be that the bug has been reported previously, but neither |
| 30797 | you nor we can know that unless your bug report is complete and |
| 30798 | self-contained. |
| 30799 | |
| 30800 | Sometimes people give a few sketchy facts and ask, ``Does this ring a |
| 30801 | bell?'' Those bug reports are useless, and we urge everyone to |
| 30802 | @emph{refuse to respond to them} except to chide the sender to report |
| 30803 | bugs properly. |
| 30804 | |
| 30805 | To enable us to fix the bug, you should include all these things: |
| 30806 | |
| 30807 | @itemize @bullet |
| 30808 | @item |
| 30809 | The version of @value{GDBN}. @value{GDBN} announces it if you start |
| 30810 | with no arguments; you can also print it at any time using @code{show |
| 30811 | version}. |
| 30812 | |
| 30813 | Without this, we will not know whether there is any point in looking for |
| 30814 | the bug in the current version of @value{GDBN}. |
| 30815 | |
| 30816 | @item |
| 30817 | The type of machine you are using, and the operating system name and |
| 30818 | version number. |
| 30819 | |
| 30820 | @item |
| 30821 | What compiler (and its version) was used to compile @value{GDBN}---e.g.@: |
| 30822 | ``@value{GCC}--2.8.1''. |
| 30823 | |
| 30824 | @item |
| 30825 | What compiler (and its version) was used to compile the program you are |
| 30826 | debugging---e.g.@: ``@value{GCC}--2.8.1'', or ``HP92453-01 A.10.32.03 HP |
| 30827 | C Compiler''. For @value{NGCC}, you can say @kbd{@value{GCC} --version} |
| 30828 | to get this information; for other compilers, see the documentation for |
| 30829 | those compilers. |
| 30830 | |
| 30831 | @item |
| 30832 | The command arguments you gave the compiler to compile your example and |
| 30833 | observe the bug. For example, did you use @samp{-O}? To guarantee |
| 30834 | you will not omit something important, list them all. A copy of the |
| 30835 | Makefile (or the output from make) is sufficient. |
| 30836 | |
| 30837 | If we were to try to guess the arguments, we would probably guess wrong |
| 30838 | and then we might not encounter the bug. |
| 30839 | |
| 30840 | @item |
| 30841 | A complete input script, and all necessary source files, that will |
| 30842 | reproduce the bug. |
| 30843 | |
| 30844 | @item |
| 30845 | A description of what behavior you observe that you believe is |
| 30846 | incorrect. For example, ``It gets a fatal signal.'' |
| 30847 | |
| 30848 | Of course, if the bug is that @value{GDBN} gets a fatal signal, then we |
| 30849 | will certainly notice it. But if the bug is incorrect output, we might |
| 30850 | not notice unless it is glaringly wrong. You might as well not give us |
| 30851 | a chance to make a mistake. |
| 30852 | |
| 30853 | Even if the problem you experience is a fatal signal, you should still |
| 30854 | say so explicitly. Suppose something strange is going on, such as, your |
| 30855 | copy of @value{GDBN} is out of synch, or you have encountered a bug in |
| 30856 | the C library on your system. (This has happened!) Your copy might |
| 30857 | crash and ours would not. If you told us to expect a crash, then when |
| 30858 | ours fails to crash, we would know that the bug was not happening for |
| 30859 | us. If you had not told us to expect a crash, then we would not be able |
| 30860 | to draw any conclusion from our observations. |
| 30861 | |
| 30862 | @pindex script |
| 30863 | @cindex recording a session script |
| 30864 | To collect all this information, you can use a session recording program |
| 30865 | such as @command{script}, which is available on many Unix systems. |
| 30866 | Just run your @value{GDBN} session inside @command{script} and then |
| 30867 | include the @file{typescript} file with your bug report. |
| 30868 | |
| 30869 | Another way to record a @value{GDBN} session is to run @value{GDBN} |
| 30870 | inside Emacs and then save the entire buffer to a file. |
| 30871 | |
| 30872 | @item |
| 30873 | If you wish to suggest changes to the @value{GDBN} source, send us context |
| 30874 | diffs. If you even discuss something in the @value{GDBN} source, refer to |
| 30875 | it by context, not by line number. |
| 30876 | |
| 30877 | The line numbers in our development sources will not match those in your |
| 30878 | sources. Your line numbers would convey no useful information to us. |
| 30879 | |
| 30880 | @end itemize |
| 30881 | |
| 30882 | Here are some things that are not necessary: |
| 30883 | |
| 30884 | @itemize @bullet |
| 30885 | @item |
| 30886 | A description of the envelope of the bug. |
| 30887 | |
| 30888 | Often people who encounter a bug spend a lot of time investigating |
| 30889 | which changes to the input file will make the bug go away and which |
| 30890 | changes will not affect it. |
| 30891 | |
| 30892 | This is often time consuming and not very useful, because the way we |
| 30893 | will find the bug is by running a single example under the debugger |
| 30894 | with breakpoints, not by pure deduction from a series of examples. |
| 30895 | We recommend that you save your time for something else. |
| 30896 | |
| 30897 | Of course, if you can find a simpler example to report @emph{instead} |
| 30898 | of the original one, that is a convenience for us. Errors in the |
| 30899 | output will be easier to spot, running under the debugger will take |
| 30900 | less time, and so on. |
| 30901 | |
| 30902 | However, simplification is not vital; if you do not want to do this, |
| 30903 | report the bug anyway and send us the entire test case you used. |
| 30904 | |
| 30905 | @item |
| 30906 | A patch for the bug. |
| 30907 | |
| 30908 | A patch for the bug does help us if it is a good one. But do not omit |
| 30909 | the necessary information, such as the test case, on the assumption that |
| 30910 | a patch is all we need. We might see problems with your patch and decide |
| 30911 | to fix the problem another way, or we might not understand it at all. |
| 30912 | |
| 30913 | Sometimes with a program as complicated as @value{GDBN} it is very hard to |
| 30914 | construct an example that will make the program follow a certain path |
| 30915 | through the code. If you do not send us the example, we will not be able |
| 30916 | to construct one, so we will not be able to verify that the bug is fixed. |
| 30917 | |
| 30918 | And if we cannot understand what bug you are trying to fix, or why your |
| 30919 | patch should be an improvement, we will not install it. A test case will |
| 30920 | help us to understand. |
| 30921 | |
| 30922 | @item |
| 30923 | A guess about what the bug is or what it depends on. |
| 30924 | |
| 30925 | Such guesses are usually wrong. Even we cannot guess right about such |
| 30926 | things without first using the debugger to find the facts. |
| 30927 | @end itemize |
| 30928 | |
| 30929 | @c The readline documentation is distributed with the readline code |
| 30930 | @c and consists of the two following files: |
| 30931 | @c rluser.texinfo |
| 30932 | @c inc-hist.texinfo |
| 30933 | @c Use -I with makeinfo to point to the appropriate directory, |
| 30934 | @c environment var TEXINPUTS with TeX. |
| 30935 | @ifclear SYSTEM_READLINE |
| 30936 | @include rluser.texi |
| 30937 | @include inc-hist.texinfo |
| 30938 | @end ifclear |
| 30939 | |
| 30940 | |
| 30941 | @node Formatting Documentation |
| 30942 | @appendix Formatting Documentation |
| 30943 | |
| 30944 | @cindex @value{GDBN} reference card |
| 30945 | @cindex reference card |
| 30946 | The @value{GDBN} 4 release includes an already-formatted reference card, ready |
| 30947 | for printing with PostScript or Ghostscript, in the @file{gdb} |
| 30948 | subdirectory of the main source directory@footnote{In |
| 30949 | @file{gdb-@value{GDBVN}/gdb/refcard.ps} of the version @value{GDBVN} |
| 30950 | release.}. If you can use PostScript or Ghostscript with your printer, |
| 30951 | you can print the reference card immediately with @file{refcard.ps}. |
| 30952 | |
| 30953 | The release also includes the source for the reference card. You |
| 30954 | can format it, using @TeX{}, by typing: |
| 30955 | |
| 30956 | @smallexample |
| 30957 | make refcard.dvi |
| 30958 | @end smallexample |
| 30959 | |
| 30960 | The @value{GDBN} reference card is designed to print in @dfn{landscape} |
| 30961 | mode on US ``letter'' size paper; |
| 30962 | that is, on a sheet 11 inches wide by 8.5 inches |
| 30963 | high. You will need to specify this form of printing as an option to |
| 30964 | your @sc{dvi} output program. |
| 30965 | |
| 30966 | @cindex documentation |
| 30967 | |
| 30968 | All the documentation for @value{GDBN} comes as part of the machine-readable |
| 30969 | distribution. The documentation is written in Texinfo format, which is |
| 30970 | a documentation system that uses a single source file to produce both |
| 30971 | on-line information and a printed manual. You can use one of the Info |
| 30972 | formatting commands to create the on-line version of the documentation |
| 30973 | and @TeX{} (or @code{texi2roff}) to typeset the printed version. |
| 30974 | |
| 30975 | @value{GDBN} includes an already formatted copy of the on-line Info |
| 30976 | version of this manual in the @file{gdb} subdirectory. The main Info |
| 30977 | file is @file{gdb-@value{GDBVN}/gdb/gdb.info}, and it refers to |
| 30978 | subordinate files matching @samp{gdb.info*} in the same directory. If |
| 30979 | necessary, you can print out these files, or read them with any editor; |
| 30980 | but they are easier to read using the @code{info} subsystem in @sc{gnu} |
| 30981 | Emacs or the standalone @code{info} program, available as part of the |
| 30982 | @sc{gnu} Texinfo distribution. |
| 30983 | |
| 30984 | If you want to format these Info files yourself, you need one of the |
| 30985 | Info formatting programs, such as @code{texinfo-format-buffer} or |
| 30986 | @code{makeinfo}. |
| 30987 | |
| 30988 | If you have @code{makeinfo} installed, and are in the top level |
| 30989 | @value{GDBN} source directory (@file{gdb-@value{GDBVN}}, in the case of |
| 30990 | version @value{GDBVN}), you can make the Info file by typing: |
| 30991 | |
| 30992 | @smallexample |
| 30993 | cd gdb |
| 30994 | make gdb.info |
| 30995 | @end smallexample |
| 30996 | |
| 30997 | If you want to typeset and print copies of this manual, you need @TeX{}, |
| 30998 | a program to print its @sc{dvi} output files, and @file{texinfo.tex}, the |
| 30999 | Texinfo definitions file. |
| 31000 | |
| 31001 | @TeX{} is a typesetting program; it does not print files directly, but |
| 31002 | produces output files called @sc{dvi} files. To print a typeset |
| 31003 | document, you need a program to print @sc{dvi} files. If your system |
| 31004 | has @TeX{} installed, chances are it has such a program. The precise |
| 31005 | command to use depends on your system; @kbd{lpr -d} is common; another |
| 31006 | (for PostScript devices) is @kbd{dvips}. The @sc{dvi} print command may |
| 31007 | require a file name without any extension or a @samp{.dvi} extension. |
| 31008 | |
| 31009 | @TeX{} also requires a macro definitions file called |
| 31010 | @file{texinfo.tex}. This file tells @TeX{} how to typeset a document |
| 31011 | written in Texinfo format. On its own, @TeX{} cannot either read or |
| 31012 | typeset a Texinfo file. @file{texinfo.tex} is distributed with GDB |
| 31013 | and is located in the @file{gdb-@var{version-number}/texinfo} |
| 31014 | directory. |
| 31015 | |
| 31016 | If you have @TeX{} and a @sc{dvi} printer program installed, you can |
| 31017 | typeset and print this manual. First switch to the @file{gdb} |
| 31018 | subdirectory of the main source directory (for example, to |
| 31019 | @file{gdb-@value{GDBVN}/gdb}) and type: |
| 31020 | |
| 31021 | @smallexample |
| 31022 | make gdb.dvi |
| 31023 | @end smallexample |
| 31024 | |
| 31025 | Then give @file{gdb.dvi} to your @sc{dvi} printing program. |
| 31026 | |
| 31027 | @node Installing GDB |
| 31028 | @appendix Installing @value{GDBN} |
| 31029 | @cindex installation |
| 31030 | |
| 31031 | @menu |
| 31032 | * Requirements:: Requirements for building @value{GDBN} |
| 31033 | * Running Configure:: Invoking the @value{GDBN} @file{configure} script |
| 31034 | * Separate Objdir:: Compiling @value{GDBN} in another directory |
| 31035 | * Config Names:: Specifying names for hosts and targets |
| 31036 | * Configure Options:: Summary of options for configure |
| 31037 | * System-wide configuration:: Having a system-wide init file |
| 31038 | @end menu |
| 31039 | |
| 31040 | @node Requirements |
| 31041 | @section Requirements for Building @value{GDBN} |
| 31042 | @cindex building @value{GDBN}, requirements for |
| 31043 | |
| 31044 | Building @value{GDBN} requires various tools and packages to be available. |
| 31045 | Other packages will be used only if they are found. |
| 31046 | |
| 31047 | @heading Tools/Packages Necessary for Building @value{GDBN} |
| 31048 | @table @asis |
| 31049 | @item ISO C90 compiler |
| 31050 | @value{GDBN} is written in ISO C90. It should be buildable with any |
| 31051 | working C90 compiler, e.g.@: GCC. |
| 31052 | |
| 31053 | @end table |
| 31054 | |
| 31055 | @heading Tools/Packages Optional for Building @value{GDBN} |
| 31056 | @table @asis |
| 31057 | @item Expat |
| 31058 | @anchor{Expat} |
| 31059 | @value{GDBN} can use the Expat XML parsing library. This library may be |
| 31060 | included with your operating system distribution; if it is not, you |
| 31061 | can get the latest version from @url{http://expat.sourceforge.net}. |
| 31062 | The @file{configure} script will search for this library in several |
| 31063 | standard locations; if it is installed in an unusual path, you can |
| 31064 | use the @option{--with-libexpat-prefix} option to specify its location. |
| 31065 | |
| 31066 | Expat is used for: |
| 31067 | |
| 31068 | @itemize @bullet |
| 31069 | @item |
| 31070 | Remote protocol memory maps (@pxref{Memory Map Format}) |
| 31071 | @item |
| 31072 | Target descriptions (@pxref{Target Descriptions}) |
| 31073 | @item |
| 31074 | Remote shared library lists (@pxref{Library List Format}) |
| 31075 | @item |
| 31076 | MS-Windows shared libraries (@pxref{Shared Libraries}) |
| 31077 | @item |
| 31078 | Traceframe info (@pxref{Traceframe Info Format}) |
| 31079 | @end itemize |
| 31080 | |
| 31081 | @item zlib |
| 31082 | @cindex compressed debug sections |
| 31083 | @value{GDBN} will use the @samp{zlib} library, if available, to read |
| 31084 | compressed debug sections. Some linkers, such as GNU gold, are capable |
| 31085 | of producing binaries with compressed debug sections. If @value{GDBN} |
| 31086 | is compiled with @samp{zlib}, it will be able to read the debug |
| 31087 | information in such binaries. |
| 31088 | |
| 31089 | The @samp{zlib} library is likely included with your operating system |
| 31090 | distribution; if it is not, you can get the latest version from |
| 31091 | @url{http://zlib.net}. |
| 31092 | |
| 31093 | @item iconv |
| 31094 | @value{GDBN}'s features related to character sets (@pxref{Character |
| 31095 | Sets}) require a functioning @code{iconv} implementation. If you are |
| 31096 | on a GNU system, then this is provided by the GNU C Library. Some |
| 31097 | other systems also provide a working @code{iconv}. |
| 31098 | |
| 31099 | On systems with @code{iconv}, you can install GNU Libiconv. If you |
| 31100 | have previously installed Libiconv, you can use the |
| 31101 | @option{--with-libiconv-prefix} option to configure. |
| 31102 | |
| 31103 | @value{GDBN}'s top-level @file{configure} and @file{Makefile} will |
| 31104 | arrange to build Libiconv if a directory named @file{libiconv} appears |
| 31105 | in the top-most source directory. If Libiconv is built this way, and |
| 31106 | if the operating system does not provide a suitable @code{iconv} |
| 31107 | implementation, then the just-built library will automatically be used |
| 31108 | by @value{GDBN}. One easy way to set this up is to download GNU |
| 31109 | Libiconv, unpack it, and then rename the directory holding the |
| 31110 | Libiconv source code to @samp{libiconv}. |
| 31111 | @end table |
| 31112 | |
| 31113 | @node Running Configure |
| 31114 | @section Invoking the @value{GDBN} @file{configure} Script |
| 31115 | @cindex configuring @value{GDBN} |
| 31116 | @value{GDBN} comes with a @file{configure} script that automates the process |
| 31117 | of preparing @value{GDBN} for installation; you can then use @code{make} to |
| 31118 | build the @code{gdb} program. |
| 31119 | @iftex |
| 31120 | @c irrelevant in info file; it's as current as the code it lives with. |
| 31121 | @footnote{If you have a more recent version of @value{GDBN} than @value{GDBVN}, |
| 31122 | look at the @file{README} file in the sources; we may have improved the |
| 31123 | installation procedures since publishing this manual.} |
| 31124 | @end iftex |
| 31125 | |
| 31126 | The @value{GDBN} distribution includes all the source code you need for |
| 31127 | @value{GDBN} in a single directory, whose name is usually composed by |
| 31128 | appending the version number to @samp{gdb}. |
| 31129 | |
| 31130 | For example, the @value{GDBN} version @value{GDBVN} distribution is in the |
| 31131 | @file{gdb-@value{GDBVN}} directory. That directory contains: |
| 31132 | |
| 31133 | @table @code |
| 31134 | @item gdb-@value{GDBVN}/configure @r{(and supporting files)} |
| 31135 | script for configuring @value{GDBN} and all its supporting libraries |
| 31136 | |
| 31137 | @item gdb-@value{GDBVN}/gdb |
| 31138 | the source specific to @value{GDBN} itself |
| 31139 | |
| 31140 | @item gdb-@value{GDBVN}/bfd |
| 31141 | source for the Binary File Descriptor library |
| 31142 | |
| 31143 | @item gdb-@value{GDBVN}/include |
| 31144 | @sc{gnu} include files |
| 31145 | |
| 31146 | @item gdb-@value{GDBVN}/libiberty |
| 31147 | source for the @samp{-liberty} free software library |
| 31148 | |
| 31149 | @item gdb-@value{GDBVN}/opcodes |
| 31150 | source for the library of opcode tables and disassemblers |
| 31151 | |
| 31152 | @item gdb-@value{GDBVN}/readline |
| 31153 | source for the @sc{gnu} command-line interface |
| 31154 | |
| 31155 | @item gdb-@value{GDBVN}/glob |
| 31156 | source for the @sc{gnu} filename pattern-matching subroutine |
| 31157 | |
| 31158 | @item gdb-@value{GDBVN}/mmalloc |
| 31159 | source for the @sc{gnu} memory-mapped malloc package |
| 31160 | @end table |
| 31161 | |
| 31162 | The simplest way to configure and build @value{GDBN} is to run @file{configure} |
| 31163 | from the @file{gdb-@var{version-number}} source directory, which in |
| 31164 | this example is the @file{gdb-@value{GDBVN}} directory. |
| 31165 | |
| 31166 | First switch to the @file{gdb-@var{version-number}} source directory |
| 31167 | if you are not already in it; then run @file{configure}. Pass the |
| 31168 | identifier for the platform on which @value{GDBN} will run as an |
| 31169 | argument. |
| 31170 | |
| 31171 | For example: |
| 31172 | |
| 31173 | @smallexample |
| 31174 | cd gdb-@value{GDBVN} |
| 31175 | ./configure @var{host} |
| 31176 | make |
| 31177 | @end smallexample |
| 31178 | |
| 31179 | @noindent |
| 31180 | where @var{host} is an identifier such as @samp{sun4} or |
| 31181 | @samp{decstation}, that identifies the platform where @value{GDBN} will run. |
| 31182 | (You can often leave off @var{host}; @file{configure} tries to guess the |
| 31183 | correct value by examining your system.) |
| 31184 | |
| 31185 | Running @samp{configure @var{host}} and then running @code{make} builds the |
| 31186 | @file{bfd}, @file{readline}, @file{mmalloc}, and @file{libiberty} |
| 31187 | libraries, then @code{gdb} itself. The configured source files, and the |
| 31188 | binaries, are left in the corresponding source directories. |
| 31189 | |
| 31190 | @need 750 |
| 31191 | @file{configure} is a Bourne-shell (@code{/bin/sh}) script; if your |
| 31192 | system does not recognize this automatically when you run a different |
| 31193 | shell, you may need to run @code{sh} on it explicitly: |
| 31194 | |
| 31195 | @smallexample |
| 31196 | sh configure @var{host} |
| 31197 | @end smallexample |
| 31198 | |
| 31199 | If you run @file{configure} from a directory that contains source |
| 31200 | directories for multiple libraries or programs, such as the |
| 31201 | @file{gdb-@value{GDBVN}} source directory for version @value{GDBVN}, |
| 31202 | @file{configure} |
| 31203 | creates configuration files for every directory level underneath (unless |
| 31204 | you tell it not to, with the @samp{--norecursion} option). |
| 31205 | |
| 31206 | You should run the @file{configure} script from the top directory in the |
| 31207 | source tree, the @file{gdb-@var{version-number}} directory. If you run |
| 31208 | @file{configure} from one of the subdirectories, you will configure only |
| 31209 | that subdirectory. That is usually not what you want. In particular, |
| 31210 | if you run the first @file{configure} from the @file{gdb} subdirectory |
| 31211 | of the @file{gdb-@var{version-number}} directory, you will omit the |
| 31212 | configuration of @file{bfd}, @file{readline}, and other sibling |
| 31213 | directories of the @file{gdb} subdirectory. This leads to build errors |
| 31214 | about missing include files such as @file{bfd/bfd.h}. |
| 31215 | |
| 31216 | You can install @code{@value{GDBP}} anywhere; it has no hardwired paths. |
| 31217 | However, you should make sure that the shell on your path (named by |
| 31218 | the @samp{SHELL} environment variable) is publicly readable. Remember |
| 31219 | that @value{GDBN} uses the shell to start your program---some systems refuse to |
| 31220 | let @value{GDBN} debug child processes whose programs are not readable. |
| 31221 | |
| 31222 | @node Separate Objdir |
| 31223 | @section Compiling @value{GDBN} in Another Directory |
| 31224 | |
| 31225 | If you want to run @value{GDBN} versions for several host or target machines, |
| 31226 | you need a different @code{gdb} compiled for each combination of |
| 31227 | host and target. @file{configure} is designed to make this easy by |
| 31228 | allowing you to generate each configuration in a separate subdirectory, |
| 31229 | rather than in the source directory. If your @code{make} program |
| 31230 | handles the @samp{VPATH} feature (@sc{gnu} @code{make} does), running |
| 31231 | @code{make} in each of these directories builds the @code{gdb} |
| 31232 | program specified there. |
| 31233 | |
| 31234 | To build @code{gdb} in a separate directory, run @file{configure} |
| 31235 | with the @samp{--srcdir} option to specify where to find the source. |
| 31236 | (You also need to specify a path to find @file{configure} |
| 31237 | itself from your working directory. If the path to @file{configure} |
| 31238 | would be the same as the argument to @samp{--srcdir}, you can leave out |
| 31239 | the @samp{--srcdir} option; it is assumed.) |
| 31240 | |
| 31241 | For example, with version @value{GDBVN}, you can build @value{GDBN} in a |
| 31242 | separate directory for a Sun 4 like this: |
| 31243 | |
| 31244 | @smallexample |
| 31245 | @group |
| 31246 | cd gdb-@value{GDBVN} |
| 31247 | mkdir ../gdb-sun4 |
| 31248 | cd ../gdb-sun4 |
| 31249 | ../gdb-@value{GDBVN}/configure sun4 |
| 31250 | make |
| 31251 | @end group |
| 31252 | @end smallexample |
| 31253 | |
| 31254 | When @file{configure} builds a configuration using a remote source |
| 31255 | directory, it creates a tree for the binaries with the same structure |
| 31256 | (and using the same names) as the tree under the source directory. In |
| 31257 | the example, you'd find the Sun 4 library @file{libiberty.a} in the |
| 31258 | directory @file{gdb-sun4/libiberty}, and @value{GDBN} itself in |
| 31259 | @file{gdb-sun4/gdb}. |
| 31260 | |
| 31261 | Make sure that your path to the @file{configure} script has just one |
| 31262 | instance of @file{gdb} in it. If your path to @file{configure} looks |
| 31263 | like @file{../gdb-@value{GDBVN}/gdb/configure}, you are configuring only |
| 31264 | one subdirectory of @value{GDBN}, not the whole package. This leads to |
| 31265 | build errors about missing include files such as @file{bfd/bfd.h}. |
| 31266 | |
| 31267 | One popular reason to build several @value{GDBN} configurations in separate |
| 31268 | directories is to configure @value{GDBN} for cross-compiling (where |
| 31269 | @value{GDBN} runs on one machine---the @dfn{host}---while debugging |
| 31270 | programs that run on another machine---the @dfn{target}). |
| 31271 | You specify a cross-debugging target by |
| 31272 | giving the @samp{--target=@var{target}} option to @file{configure}. |
| 31273 | |
| 31274 | When you run @code{make} to build a program or library, you must run |
| 31275 | it in a configured directory---whatever directory you were in when you |
| 31276 | called @file{configure} (or one of its subdirectories). |
| 31277 | |
| 31278 | The @code{Makefile} that @file{configure} generates in each source |
| 31279 | directory also runs recursively. If you type @code{make} in a source |
| 31280 | directory such as @file{gdb-@value{GDBVN}} (or in a separate configured |
| 31281 | directory configured with @samp{--srcdir=@var{dirname}/gdb-@value{GDBVN}}), you |
| 31282 | will build all the required libraries, and then build GDB. |
| 31283 | |
| 31284 | When you have multiple hosts or targets configured in separate |
| 31285 | directories, you can run @code{make} on them in parallel (for example, |
| 31286 | if they are NFS-mounted on each of the hosts); they will not interfere |
| 31287 | with each other. |
| 31288 | |
| 31289 | @node Config Names |
| 31290 | @section Specifying Names for Hosts and Targets |
| 31291 | |
| 31292 | The specifications used for hosts and targets in the @file{configure} |
| 31293 | script are based on a three-part naming scheme, but some short predefined |
| 31294 | aliases are also supported. The full naming scheme encodes three pieces |
| 31295 | of information in the following pattern: |
| 31296 | |
| 31297 | @smallexample |
| 31298 | @var{architecture}-@var{vendor}-@var{os} |
| 31299 | @end smallexample |
| 31300 | |
| 31301 | For example, you can use the alias @code{sun4} as a @var{host} argument, |
| 31302 | or as the value for @var{target} in a @code{--target=@var{target}} |
| 31303 | option. The equivalent full name is @samp{sparc-sun-sunos4}. |
| 31304 | |
| 31305 | The @file{configure} script accompanying @value{GDBN} does not provide |
| 31306 | any query facility to list all supported host and target names or |
| 31307 | aliases. @file{configure} calls the Bourne shell script |
| 31308 | @code{config.sub} to map abbreviations to full names; you can read the |
| 31309 | script, if you wish, or you can use it to test your guesses on |
| 31310 | abbreviations---for example: |
| 31311 | |
| 31312 | @smallexample |
| 31313 | % sh config.sub i386-linux |
| 31314 | i386-pc-linux-gnu |
| 31315 | % sh config.sub alpha-linux |
| 31316 | alpha-unknown-linux-gnu |
| 31317 | % sh config.sub hp9k700 |
| 31318 | hppa1.1-hp-hpux |
| 31319 | % sh config.sub sun4 |
| 31320 | sparc-sun-sunos4.1.1 |
| 31321 | % sh config.sub sun3 |
| 31322 | m68k-sun-sunos4.1.1 |
| 31323 | % sh config.sub i986v |
| 31324 | Invalid configuration `i986v': machine `i986v' not recognized |
| 31325 | @end smallexample |
| 31326 | |
| 31327 | @noindent |
| 31328 | @code{config.sub} is also distributed in the @value{GDBN} source |
| 31329 | directory (@file{gdb-@value{GDBVN}}, for version @value{GDBVN}). |
| 31330 | |
| 31331 | @node Configure Options |
| 31332 | @section @file{configure} Options |
| 31333 | |
| 31334 | Here is a summary of the @file{configure} options and arguments that |
| 31335 | are most often useful for building @value{GDBN}. @file{configure} also has |
| 31336 | several other options not listed here. @inforef{What Configure |
| 31337 | Does,,configure.info}, for a full explanation of @file{configure}. |
| 31338 | |
| 31339 | @smallexample |
| 31340 | configure @r{[}--help@r{]} |
| 31341 | @r{[}--prefix=@var{dir}@r{]} |
| 31342 | @r{[}--exec-prefix=@var{dir}@r{]} |
| 31343 | @r{[}--srcdir=@var{dirname}@r{]} |
| 31344 | @r{[}--norecursion@r{]} @r{[}--rm@r{]} |
| 31345 | @r{[}--target=@var{target}@r{]} |
| 31346 | @var{host} |
| 31347 | @end smallexample |
| 31348 | |
| 31349 | @noindent |
| 31350 | You may introduce options with a single @samp{-} rather than |
| 31351 | @samp{--} if you prefer; but you may abbreviate option names if you use |
| 31352 | @samp{--}. |
| 31353 | |
| 31354 | @table @code |
| 31355 | @item --help |
| 31356 | Display a quick summary of how to invoke @file{configure}. |
| 31357 | |
| 31358 | @item --prefix=@var{dir} |
| 31359 | Configure the source to install programs and files under directory |
| 31360 | @file{@var{dir}}. |
| 31361 | |
| 31362 | @item --exec-prefix=@var{dir} |
| 31363 | Configure the source to install programs under directory |
| 31364 | @file{@var{dir}}. |
| 31365 | |
| 31366 | @c avoid splitting the warning from the explanation: |
| 31367 | @need 2000 |
| 31368 | @item --srcdir=@var{dirname} |
| 31369 | @strong{Warning: using this option requires @sc{gnu} @code{make}, or another |
| 31370 | @code{make} that implements the @code{VPATH} feature.}@* |
| 31371 | Use this option to make configurations in directories separate from the |
| 31372 | @value{GDBN} source directories. Among other things, you can use this to |
| 31373 | build (or maintain) several configurations simultaneously, in separate |
| 31374 | directories. @file{configure} writes configuration-specific files in |
| 31375 | the current directory, but arranges for them to use the source in the |
| 31376 | directory @var{dirname}. @file{configure} creates directories under |
| 31377 | the working directory in parallel to the source directories below |
| 31378 | @var{dirname}. |
| 31379 | |
| 31380 | @item --norecursion |
| 31381 | Configure only the directory level where @file{configure} is executed; do not |
| 31382 | propagate configuration to subdirectories. |
| 31383 | |
| 31384 | @item --target=@var{target} |
| 31385 | Configure @value{GDBN} for cross-debugging programs running on the specified |
| 31386 | @var{target}. Without this option, @value{GDBN} is configured to debug |
| 31387 | programs that run on the same machine (@var{host}) as @value{GDBN} itself. |
| 31388 | |
| 31389 | There is no convenient way to generate a list of all available targets. |
| 31390 | |
| 31391 | @item @var{host} @dots{} |
| 31392 | Configure @value{GDBN} to run on the specified @var{host}. |
| 31393 | |
| 31394 | There is no convenient way to generate a list of all available hosts. |
| 31395 | @end table |
| 31396 | |
| 31397 | There are many other options available as well, but they are generally |
| 31398 | needed for special purposes only. |
| 31399 | |
| 31400 | @node System-wide configuration |
| 31401 | @section System-wide configuration and settings |
| 31402 | @cindex system-wide init file |
| 31403 | |
| 31404 | @value{GDBN} can be configured to have a system-wide init file; |
| 31405 | this file will be read and executed at startup (@pxref{Startup, , What |
| 31406 | @value{GDBN} does during startup}). |
| 31407 | |
| 31408 | Here is the corresponding configure option: |
| 31409 | |
| 31410 | @table @code |
| 31411 | @item --with-system-gdbinit=@var{file} |
| 31412 | Specify that the default location of the system-wide init file is |
| 31413 | @var{file}. |
| 31414 | @end table |
| 31415 | |
| 31416 | If @value{GDBN} has been configured with the option @option{--prefix=$prefix}, |
| 31417 | it may be subject to relocation. Two possible cases: |
| 31418 | |
| 31419 | @itemize @bullet |
| 31420 | @item |
| 31421 | If the default location of this init file contains @file{$prefix}, |
| 31422 | it will be subject to relocation. Suppose that the configure options |
| 31423 | are @option{--prefix=$prefix --with-system-gdbinit=$prefix/etc/gdbinit}; |
| 31424 | if @value{GDBN} is moved from @file{$prefix} to @file{$install}, the system |
| 31425 | init file is looked for as @file{$install/etc/gdbinit} instead of |
| 31426 | @file{$prefix/etc/gdbinit}. |
| 31427 | |
| 31428 | @item |
| 31429 | By contrast, if the default location does not contain the prefix, |
| 31430 | it will not be relocated. E.g.@: if @value{GDBN} has been configured with |
| 31431 | @option{--prefix=/usr/local --with-system-gdbinit=/usr/share/gdb/gdbinit}, |
| 31432 | then @value{GDBN} will always look for @file{/usr/share/gdb/gdbinit}, |
| 31433 | wherever @value{GDBN} is installed. |
| 31434 | @end itemize |
| 31435 | |
| 31436 | @node Maintenance Commands |
| 31437 | @appendix Maintenance Commands |
| 31438 | @cindex maintenance commands |
| 31439 | @cindex internal commands |
| 31440 | |
| 31441 | In addition to commands intended for @value{GDBN} users, @value{GDBN} |
| 31442 | includes a number of commands intended for @value{GDBN} developers, |
| 31443 | that are not documented elsewhere in this manual. These commands are |
| 31444 | provided here for reference. (For commands that turn on debugging |
| 31445 | messages, see @ref{Debugging Output}.) |
| 31446 | |
| 31447 | @table @code |
| 31448 | @kindex maint agent |
| 31449 | @kindex maint agent-eval |
| 31450 | @item maint agent @var{expression} |
| 31451 | @itemx maint agent-eval @var{expression} |
| 31452 | Translate the given @var{expression} into remote agent bytecodes. |
| 31453 | This command is useful for debugging the Agent Expression mechanism |
| 31454 | (@pxref{Agent Expressions}). The @samp{agent} version produces an |
| 31455 | expression useful for data collection, such as by tracepoints, while |
| 31456 | @samp{maint agent-eval} produces an expression that evaluates directly |
| 31457 | to a result. For instance, a collection expression for @code{globa + |
| 31458 | globb} will include bytecodes to record four bytes of memory at each |
| 31459 | of the addresses of @code{globa} and @code{globb}, while discarding |
| 31460 | the result of the addition, while an evaluation expression will do the |
| 31461 | addition and return the sum. |
| 31462 | |
| 31463 | @kindex maint info breakpoints |
| 31464 | @item @anchor{maint info breakpoints}maint info breakpoints |
| 31465 | Using the same format as @samp{info breakpoints}, display both the |
| 31466 | breakpoints you've set explicitly, and those @value{GDBN} is using for |
| 31467 | internal purposes. Internal breakpoints are shown with negative |
| 31468 | breakpoint numbers. The type column identifies what kind of breakpoint |
| 31469 | is shown: |
| 31470 | |
| 31471 | @table @code |
| 31472 | @item breakpoint |
| 31473 | Normal, explicitly set breakpoint. |
| 31474 | |
| 31475 | @item watchpoint |
| 31476 | Normal, explicitly set watchpoint. |
| 31477 | |
| 31478 | @item longjmp |
| 31479 | Internal breakpoint, used to handle correctly stepping through |
| 31480 | @code{longjmp} calls. |
| 31481 | |
| 31482 | @item longjmp resume |
| 31483 | Internal breakpoint at the target of a @code{longjmp}. |
| 31484 | |
| 31485 | @item until |
| 31486 | Temporary internal breakpoint used by the @value{GDBN} @code{until} command. |
| 31487 | |
| 31488 | @item finish |
| 31489 | Temporary internal breakpoint used by the @value{GDBN} @code{finish} command. |
| 31490 | |
| 31491 | @item shlib events |
| 31492 | Shared library events. |
| 31493 | |
| 31494 | @end table |
| 31495 | |
| 31496 | @kindex set displaced-stepping |
| 31497 | @kindex show displaced-stepping |
| 31498 | @cindex displaced stepping support |
| 31499 | @cindex out-of-line single-stepping |
| 31500 | @item set displaced-stepping |
| 31501 | @itemx show displaced-stepping |
| 31502 | Control whether or not @value{GDBN} will do @dfn{displaced stepping} |
| 31503 | if the target supports it. Displaced stepping is a way to single-step |
| 31504 | over breakpoints without removing them from the inferior, by executing |
| 31505 | an out-of-line copy of the instruction that was originally at the |
| 31506 | breakpoint location. It is also known as out-of-line single-stepping. |
| 31507 | |
| 31508 | @table @code |
| 31509 | @item set displaced-stepping on |
| 31510 | If the target architecture supports it, @value{GDBN} will use |
| 31511 | displaced stepping to step over breakpoints. |
| 31512 | |
| 31513 | @item set displaced-stepping off |
| 31514 | @value{GDBN} will not use displaced stepping to step over breakpoints, |
| 31515 | even if such is supported by the target architecture. |
| 31516 | |
| 31517 | @cindex non-stop mode, and @samp{set displaced-stepping} |
| 31518 | @item set displaced-stepping auto |
| 31519 | This is the default mode. @value{GDBN} will use displaced stepping |
| 31520 | only if non-stop mode is active (@pxref{Non-Stop Mode}) and the target |
| 31521 | architecture supports displaced stepping. |
| 31522 | @end table |
| 31523 | |
| 31524 | @kindex maint check-symtabs |
| 31525 | @item maint check-symtabs |
| 31526 | Check the consistency of psymtabs and symtabs. |
| 31527 | |
| 31528 | @kindex maint cplus first_component |
| 31529 | @item maint cplus first_component @var{name} |
| 31530 | Print the first C@t{++} class/namespace component of @var{name}. |
| 31531 | |
| 31532 | @kindex maint cplus namespace |
| 31533 | @item maint cplus namespace |
| 31534 | Print the list of possible C@t{++} namespaces. |
| 31535 | |
| 31536 | @kindex maint demangle |
| 31537 | @item maint demangle @var{name} |
| 31538 | Demangle a C@t{++} or Objective-C mangled @var{name}. |
| 31539 | |
| 31540 | @kindex maint deprecate |
| 31541 | @kindex maint undeprecate |
| 31542 | @cindex deprecated commands |
| 31543 | @item maint deprecate @var{command} @r{[}@var{replacement}@r{]} |
| 31544 | @itemx maint undeprecate @var{command} |
| 31545 | Deprecate or undeprecate the named @var{command}. Deprecated commands |
| 31546 | cause @value{GDBN} to issue a warning when you use them. The optional |
| 31547 | argument @var{replacement} says which newer command should be used in |
| 31548 | favor of the deprecated one; if it is given, @value{GDBN} will mention |
| 31549 | the replacement as part of the warning. |
| 31550 | |
| 31551 | @kindex maint dump-me |
| 31552 | @item maint dump-me |
| 31553 | @cindex @code{SIGQUIT} signal, dump core of @value{GDBN} |
| 31554 | Cause a fatal signal in the debugger and force it to dump its core. |
| 31555 | This is supported only on systems which support aborting a program |
| 31556 | with the @code{SIGQUIT} signal. |
| 31557 | |
| 31558 | @kindex maint internal-error |
| 31559 | @kindex maint internal-warning |
| 31560 | @item maint internal-error @r{[}@var{message-text}@r{]} |
| 31561 | @itemx maint internal-warning @r{[}@var{message-text}@r{]} |
| 31562 | Cause @value{GDBN} to call the internal function @code{internal_error} |
| 31563 | or @code{internal_warning} and hence behave as though an internal error |
| 31564 | or internal warning has been detected. In addition to reporting the |
| 31565 | internal problem, these functions give the user the opportunity to |
| 31566 | either quit @value{GDBN} or create a core file of the current |
| 31567 | @value{GDBN} session. |
| 31568 | |
| 31569 | These commands take an optional parameter @var{message-text} that is |
| 31570 | used as the text of the error or warning message. |
| 31571 | |
| 31572 | Here's an example of using @code{internal-error}: |
| 31573 | |
| 31574 | @smallexample |
| 31575 | (@value{GDBP}) @kbd{maint internal-error testing, 1, 2} |
| 31576 | @dots{}/maint.c:121: internal-error: testing, 1, 2 |
| 31577 | A problem internal to GDB has been detected. Further |
| 31578 | debugging may prove unreliable. |
| 31579 | Quit this debugging session? (y or n) @kbd{n} |
| 31580 | Create a core file? (y or n) @kbd{n} |
| 31581 | (@value{GDBP}) |
| 31582 | @end smallexample |
| 31583 | |
| 31584 | @cindex @value{GDBN} internal error |
| 31585 | @cindex internal errors, control of @value{GDBN} behavior |
| 31586 | |
| 31587 | @kindex maint set internal-error |
| 31588 | @kindex maint show internal-error |
| 31589 | @kindex maint set internal-warning |
| 31590 | @kindex maint show internal-warning |
| 31591 | @item maint set internal-error @var{action} [ask|yes|no] |
| 31592 | @itemx maint show internal-error @var{action} |
| 31593 | @itemx maint set internal-warning @var{action} [ask|yes|no] |
| 31594 | @itemx maint show internal-warning @var{action} |
| 31595 | When @value{GDBN} reports an internal problem (error or warning) it |
| 31596 | gives the user the opportunity to both quit @value{GDBN} and create a |
| 31597 | core file of the current @value{GDBN} session. These commands let you |
| 31598 | override the default behaviour for each particular @var{action}, |
| 31599 | described in the table below. |
| 31600 | |
| 31601 | @table @samp |
| 31602 | @item quit |
| 31603 | You can specify that @value{GDBN} should always (yes) or never (no) |
| 31604 | quit. The default is to ask the user what to do. |
| 31605 | |
| 31606 | @item corefile |
| 31607 | You can specify that @value{GDBN} should always (yes) or never (no) |
| 31608 | create a core file. The default is to ask the user what to do. |
| 31609 | @end table |
| 31610 | |
| 31611 | @kindex maint packet |
| 31612 | @item maint packet @var{text} |
| 31613 | If @value{GDBN} is talking to an inferior via the serial protocol, |
| 31614 | then this command sends the string @var{text} to the inferior, and |
| 31615 | displays the response packet. @value{GDBN} supplies the initial |
| 31616 | @samp{$} character, the terminating @samp{#} character, and the |
| 31617 | checksum. |
| 31618 | |
| 31619 | @kindex maint print architecture |
| 31620 | @item maint print architecture @r{[}@var{file}@r{]} |
| 31621 | Print the entire architecture configuration. The optional argument |
| 31622 | @var{file} names the file where the output goes. |
| 31623 | |
| 31624 | @kindex maint print c-tdesc |
| 31625 | @item maint print c-tdesc |
| 31626 | Print the current target description (@pxref{Target Descriptions}) as |
| 31627 | a C source file. The created source file can be used in @value{GDBN} |
| 31628 | when an XML parser is not available to parse the description. |
| 31629 | |
| 31630 | @kindex maint print dummy-frames |
| 31631 | @item maint print dummy-frames |
| 31632 | Prints the contents of @value{GDBN}'s internal dummy-frame stack. |
| 31633 | |
| 31634 | @smallexample |
| 31635 | (@value{GDBP}) @kbd{b add} |
| 31636 | @dots{} |
| 31637 | (@value{GDBP}) @kbd{print add(2,3)} |
| 31638 | Breakpoint 2, add (a=2, b=3) at @dots{} |
| 31639 | 58 return (a + b); |
| 31640 | The program being debugged stopped while in a function called from GDB. |
| 31641 | @dots{} |
| 31642 | (@value{GDBP}) @kbd{maint print dummy-frames} |
| 31643 | 0x1a57c80: pc=0x01014068 fp=0x0200bddc sp=0x0200bdd6 |
| 31644 | top=0x0200bdd4 id=@{stack=0x200bddc,code=0x101405c@} |
| 31645 | call_lo=0x01014000 call_hi=0x01014001 |
| 31646 | (@value{GDBP}) |
| 31647 | @end smallexample |
| 31648 | |
| 31649 | Takes an optional file parameter. |
| 31650 | |
| 31651 | @kindex maint print registers |
| 31652 | @kindex maint print raw-registers |
| 31653 | @kindex maint print cooked-registers |
| 31654 | @kindex maint print register-groups |
| 31655 | @item maint print registers @r{[}@var{file}@r{]} |
| 31656 | @itemx maint print raw-registers @r{[}@var{file}@r{]} |
| 31657 | @itemx maint print cooked-registers @r{[}@var{file}@r{]} |
| 31658 | @itemx maint print register-groups @r{[}@var{file}@r{]} |
| 31659 | Print @value{GDBN}'s internal register data structures. |
| 31660 | |
| 31661 | The command @code{maint print raw-registers} includes the contents of |
| 31662 | the raw register cache; the command @code{maint print cooked-registers} |
| 31663 | includes the (cooked) value of all registers, including registers which |
| 31664 | aren't available on the target nor visible to user; and the |
| 31665 | command @code{maint print register-groups} includes the groups that each |
| 31666 | register is a member of. @xref{Registers,, Registers, gdbint, |
| 31667 | @value{GDBN} Internals}. |
| 31668 | |
| 31669 | These commands take an optional parameter, a file name to which to |
| 31670 | write the information. |
| 31671 | |
| 31672 | @kindex maint print reggroups |
| 31673 | @item maint print reggroups @r{[}@var{file}@r{]} |
| 31674 | Print @value{GDBN}'s internal register group data structures. The |
| 31675 | optional argument @var{file} tells to what file to write the |
| 31676 | information. |
| 31677 | |
| 31678 | The register groups info looks like this: |
| 31679 | |
| 31680 | @smallexample |
| 31681 | (@value{GDBP}) @kbd{maint print reggroups} |
| 31682 | Group Type |
| 31683 | general user |
| 31684 | float user |
| 31685 | all user |
| 31686 | vector user |
| 31687 | system user |
| 31688 | save internal |
| 31689 | restore internal |
| 31690 | @end smallexample |
| 31691 | |
| 31692 | @kindex flushregs |
| 31693 | @item flushregs |
| 31694 | This command forces @value{GDBN} to flush its internal register cache. |
| 31695 | |
| 31696 | @kindex maint print objfiles |
| 31697 | @cindex info for known object files |
| 31698 | @item maint print objfiles |
| 31699 | Print a dump of all known object files. For each object file, this |
| 31700 | command prints its name, address in memory, and all of its psymtabs |
| 31701 | and symtabs. |
| 31702 | |
| 31703 | @kindex maint print section-scripts |
| 31704 | @cindex info for known .debug_gdb_scripts-loaded scripts |
| 31705 | @item maint print section-scripts [@var{regexp}] |
| 31706 | Print a dump of scripts specified in the @code{.debug_gdb_section} section. |
| 31707 | If @var{regexp} is specified, only print scripts loaded by object files |
| 31708 | matching @var{regexp}. |
| 31709 | For each script, this command prints its name as specified in the objfile, |
| 31710 | and the full path if known. |
| 31711 | @xref{.debug_gdb_scripts section}. |
| 31712 | |
| 31713 | @kindex maint print statistics |
| 31714 | @cindex bcache statistics |
| 31715 | @item maint print statistics |
| 31716 | This command prints, for each object file in the program, various data |
| 31717 | about that object file followed by the byte cache (@dfn{bcache}) |
| 31718 | statistics for the object file. The objfile data includes the number |
| 31719 | of minimal, partial, full, and stabs symbols, the number of types |
| 31720 | defined by the objfile, the number of as yet unexpanded psym tables, |
| 31721 | the number of line tables and string tables, and the amount of memory |
| 31722 | used by the various tables. The bcache statistics include the counts, |
| 31723 | sizes, and counts of duplicates of all and unique objects, max, |
| 31724 | average, and median entry size, total memory used and its overhead and |
| 31725 | savings, and various measures of the hash table size and chain |
| 31726 | lengths. |
| 31727 | |
| 31728 | @kindex maint print target-stack |
| 31729 | @cindex target stack description |
| 31730 | @item maint print target-stack |
| 31731 | A @dfn{target} is an interface between the debugger and a particular |
| 31732 | kind of file or process. Targets can be stacked in @dfn{strata}, |
| 31733 | so that more than one target can potentially respond to a request. |
| 31734 | In particular, memory accesses will walk down the stack of targets |
| 31735 | until they find a target that is interested in handling that particular |
| 31736 | address. |
| 31737 | |
| 31738 | This command prints a short description of each layer that was pushed on |
| 31739 | the @dfn{target stack}, starting from the top layer down to the bottom one. |
| 31740 | |
| 31741 | @kindex maint print type |
| 31742 | @cindex type chain of a data type |
| 31743 | @item maint print type @var{expr} |
| 31744 | Print the type chain for a type specified by @var{expr}. The argument |
| 31745 | can be either a type name or a symbol. If it is a symbol, the type of |
| 31746 | that symbol is described. The type chain produced by this command is |
| 31747 | a recursive definition of the data type as stored in @value{GDBN}'s |
| 31748 | data structures, including its flags and contained types. |
| 31749 | |
| 31750 | @kindex maint set dwarf2 always-disassemble |
| 31751 | @kindex maint show dwarf2 always-disassemble |
| 31752 | @item maint set dwarf2 always-disassemble |
| 31753 | @item maint show dwarf2 always-disassemble |
| 31754 | Control the behavior of @code{info address} when using DWARF debugging |
| 31755 | information. |
| 31756 | |
| 31757 | The default is @code{off}, which means that @value{GDBN} should try to |
| 31758 | describe a variable's location in an easily readable format. When |
| 31759 | @code{on}, @value{GDBN} will instead display the DWARF location |
| 31760 | expression in an assembly-like format. Note that some locations are |
| 31761 | too complex for @value{GDBN} to describe simply; in this case you will |
| 31762 | always see the disassembly form. |
| 31763 | |
| 31764 | Here is an example of the resulting disassembly: |
| 31765 | |
| 31766 | @smallexample |
| 31767 | (gdb) info addr argc |
| 31768 | Symbol "argc" is a complex DWARF expression: |
| 31769 | 1: DW_OP_fbreg 0 |
| 31770 | @end smallexample |
| 31771 | |
| 31772 | For more information on these expressions, see |
| 31773 | @uref{http://www.dwarfstd.org/, the DWARF standard}. |
| 31774 | |
| 31775 | @kindex maint set dwarf2 max-cache-age |
| 31776 | @kindex maint show dwarf2 max-cache-age |
| 31777 | @item maint set dwarf2 max-cache-age |
| 31778 | @itemx maint show dwarf2 max-cache-age |
| 31779 | Control the DWARF 2 compilation unit cache. |
| 31780 | |
| 31781 | @cindex DWARF 2 compilation units cache |
| 31782 | In object files with inter-compilation-unit references, such as those |
| 31783 | produced by the GCC option @samp{-feliminate-dwarf2-dups}, the DWARF 2 |
| 31784 | reader needs to frequently refer to previously read compilation units. |
| 31785 | This setting controls how long a compilation unit will remain in the |
| 31786 | cache if it is not referenced. A higher limit means that cached |
| 31787 | compilation units will be stored in memory longer, and more total |
| 31788 | memory will be used. Setting it to zero disables caching, which will |
| 31789 | slow down @value{GDBN} startup, but reduce memory consumption. |
| 31790 | |
| 31791 | @kindex maint set profile |
| 31792 | @kindex maint show profile |
| 31793 | @cindex profiling GDB |
| 31794 | @item maint set profile |
| 31795 | @itemx maint show profile |
| 31796 | Control profiling of @value{GDBN}. |
| 31797 | |
| 31798 | Profiling will be disabled until you use the @samp{maint set profile} |
| 31799 | command to enable it. When you enable profiling, the system will begin |
| 31800 | collecting timing and execution count data; when you disable profiling or |
| 31801 | exit @value{GDBN}, the results will be written to a log file. Remember that |
| 31802 | if you use profiling, @value{GDBN} will overwrite the profiling log file |
| 31803 | (often called @file{gmon.out}). If you have a record of important profiling |
| 31804 | data in a @file{gmon.out} file, be sure to move it to a safe location. |
| 31805 | |
| 31806 | Configuring with @samp{--enable-profiling} arranges for @value{GDBN} to be |
| 31807 | compiled with the @samp{-pg} compiler option. |
| 31808 | |
| 31809 | @kindex maint set show-debug-regs |
| 31810 | @kindex maint show show-debug-regs |
| 31811 | @cindex hardware debug registers |
| 31812 | @item maint set show-debug-regs |
| 31813 | @itemx maint show show-debug-regs |
| 31814 | Control whether to show variables that mirror the hardware debug |
| 31815 | registers. Use @code{ON} to enable, @code{OFF} to disable. If |
| 31816 | enabled, the debug registers values are shown when @value{GDBN} inserts or |
| 31817 | removes a hardware breakpoint or watchpoint, and when the inferior |
| 31818 | triggers a hardware-assisted breakpoint or watchpoint. |
| 31819 | |
| 31820 | @kindex maint set show-all-tib |
| 31821 | @kindex maint show show-all-tib |
| 31822 | @item maint set show-all-tib |
| 31823 | @itemx maint show show-all-tib |
| 31824 | Control whether to show all non zero areas within a 1k block starting |
| 31825 | at thread local base, when using the @samp{info w32 thread-information-block} |
| 31826 | command. |
| 31827 | |
| 31828 | @kindex maint space |
| 31829 | @cindex memory used by commands |
| 31830 | @item maint space |
| 31831 | Control whether to display memory usage for each command. If set to a |
| 31832 | nonzero value, @value{GDBN} will display how much memory each command |
| 31833 | took, following the command's own output. This can also be requested |
| 31834 | by invoking @value{GDBN} with the @option{--statistics} command-line |
| 31835 | switch (@pxref{Mode Options}). |
| 31836 | |
| 31837 | @kindex maint time |
| 31838 | @cindex time of command execution |
| 31839 | @item maint time |
| 31840 | Control whether to display the execution time for each command. If |
| 31841 | set to a nonzero value, @value{GDBN} will display how much time it |
| 31842 | took to execute each command, following the command's own output. |
| 31843 | The time is not printed for the commands that run the target, since |
| 31844 | there's no mechanism currently to compute how much time was spend |
| 31845 | by @value{GDBN} and how much time was spend by the program been debugged. |
| 31846 | it's not possibly currently |
| 31847 | This can also be requested by invoking @value{GDBN} with the |
| 31848 | @option{--statistics} command-line switch (@pxref{Mode Options}). |
| 31849 | |
| 31850 | @kindex maint translate-address |
| 31851 | @item maint translate-address @r{[}@var{section}@r{]} @var{addr} |
| 31852 | Find the symbol stored at the location specified by the address |
| 31853 | @var{addr} and an optional section name @var{section}. If found, |
| 31854 | @value{GDBN} prints the name of the closest symbol and an offset from |
| 31855 | the symbol's location to the specified address. This is similar to |
| 31856 | the @code{info address} command (@pxref{Symbols}), except that this |
| 31857 | command also allows to find symbols in other sections. |
| 31858 | |
| 31859 | If section was not specified, the section in which the symbol was found |
| 31860 | is also printed. For dynamically linked executables, the name of |
| 31861 | executable or shared library containing the symbol is printed as well. |
| 31862 | |
| 31863 | @end table |
| 31864 | |
| 31865 | The following command is useful for non-interactive invocations of |
| 31866 | @value{GDBN}, such as in the test suite. |
| 31867 | |
| 31868 | @table @code |
| 31869 | @item set watchdog @var{nsec} |
| 31870 | @kindex set watchdog |
| 31871 | @cindex watchdog timer |
| 31872 | @cindex timeout for commands |
| 31873 | Set the maximum number of seconds @value{GDBN} will wait for the |
| 31874 | target operation to finish. If this time expires, @value{GDBN} |
| 31875 | reports and error and the command is aborted. |
| 31876 | |
| 31877 | @item show watchdog |
| 31878 | Show the current setting of the target wait timeout. |
| 31879 | @end table |
| 31880 | |
| 31881 | @node Remote Protocol |
| 31882 | @appendix @value{GDBN} Remote Serial Protocol |
| 31883 | |
| 31884 | @menu |
| 31885 | * Overview:: |
| 31886 | * Packets:: |
| 31887 | * Stop Reply Packets:: |
| 31888 | * General Query Packets:: |
| 31889 | * Architecture-Specific Protocol Details:: |
| 31890 | * Tracepoint Packets:: |
| 31891 | * Host I/O Packets:: |
| 31892 | * Interrupts:: |
| 31893 | * Notification Packets:: |
| 31894 | * Remote Non-Stop:: |
| 31895 | * Packet Acknowledgment:: |
| 31896 | * Examples:: |
| 31897 | * File-I/O Remote Protocol Extension:: |
| 31898 | * Library List Format:: |
| 31899 | * Memory Map Format:: |
| 31900 | * Thread List Format:: |
| 31901 | * Traceframe Info Format:: |
| 31902 | @end menu |
| 31903 | |
| 31904 | @node Overview |
| 31905 | @section Overview |
| 31906 | |
| 31907 | There may be occasions when you need to know something about the |
| 31908 | protocol---for example, if there is only one serial port to your target |
| 31909 | machine, you might want your program to do something special if it |
| 31910 | recognizes a packet meant for @value{GDBN}. |
| 31911 | |
| 31912 | In the examples below, @samp{->} and @samp{<-} are used to indicate |
| 31913 | transmitted and received data, respectively. |
| 31914 | |
| 31915 | @cindex protocol, @value{GDBN} remote serial |
| 31916 | @cindex serial protocol, @value{GDBN} remote |
| 31917 | @cindex remote serial protocol |
| 31918 | All @value{GDBN} commands and responses (other than acknowledgments |
| 31919 | and notifications, see @ref{Notification Packets}) are sent as a |
| 31920 | @var{packet}. A @var{packet} is introduced with the character |
| 31921 | @samp{$}, the actual @var{packet-data}, and the terminating character |
| 31922 | @samp{#} followed by a two-digit @var{checksum}: |
| 31923 | |
| 31924 | @smallexample |
| 31925 | @code{$}@var{packet-data}@code{#}@var{checksum} |
| 31926 | @end smallexample |
| 31927 | @noindent |
| 31928 | |
| 31929 | @cindex checksum, for @value{GDBN} remote |
| 31930 | @noindent |
| 31931 | The two-digit @var{checksum} is computed as the modulo 256 sum of all |
| 31932 | characters between the leading @samp{$} and the trailing @samp{#} (an |
| 31933 | eight bit unsigned checksum). |
| 31934 | |
| 31935 | Implementors should note that prior to @value{GDBN} 5.0 the protocol |
| 31936 | specification also included an optional two-digit @var{sequence-id}: |
| 31937 | |
| 31938 | @smallexample |
| 31939 | @code{$}@var{sequence-id}@code{:}@var{packet-data}@code{#}@var{checksum} |
| 31940 | @end smallexample |
| 31941 | |
| 31942 | @cindex sequence-id, for @value{GDBN} remote |
| 31943 | @noindent |
| 31944 | That @var{sequence-id} was appended to the acknowledgment. @value{GDBN} |
| 31945 | has never output @var{sequence-id}s. Stubs that handle packets added |
| 31946 | since @value{GDBN} 5.0 must not accept @var{sequence-id}. |
| 31947 | |
| 31948 | When either the host or the target machine receives a packet, the first |
| 31949 | response expected is an acknowledgment: either @samp{+} (to indicate |
| 31950 | the package was received correctly) or @samp{-} (to request |
| 31951 | retransmission): |
| 31952 | |
| 31953 | @smallexample |
| 31954 | -> @code{$}@var{packet-data}@code{#}@var{checksum} |
| 31955 | <- @code{+} |
| 31956 | @end smallexample |
| 31957 | @noindent |
| 31958 | |
| 31959 | The @samp{+}/@samp{-} acknowledgments can be disabled |
| 31960 | once a connection is established. |
| 31961 | @xref{Packet Acknowledgment}, for details. |
| 31962 | |
| 31963 | The host (@value{GDBN}) sends @var{command}s, and the target (the |
| 31964 | debugging stub incorporated in your program) sends a @var{response}. In |
| 31965 | the case of step and continue @var{command}s, the response is only sent |
| 31966 | when the operation has completed, and the target has again stopped all |
| 31967 | threads in all attached processes. This is the default all-stop mode |
| 31968 | behavior, but the remote protocol also supports @value{GDBN}'s non-stop |
| 31969 | execution mode; see @ref{Remote Non-Stop}, for details. |
| 31970 | |
| 31971 | @var{packet-data} consists of a sequence of characters with the |
| 31972 | exception of @samp{#} and @samp{$} (see @samp{X} packet for additional |
| 31973 | exceptions). |
| 31974 | |
| 31975 | @cindex remote protocol, field separator |
| 31976 | Fields within the packet should be separated using @samp{,} @samp{;} or |
| 31977 | @samp{:}. Except where otherwise noted all numbers are represented in |
| 31978 | @sc{hex} with leading zeros suppressed. |
| 31979 | |
| 31980 | Implementors should note that prior to @value{GDBN} 5.0, the character |
| 31981 | @samp{:} could not appear as the third character in a packet (as it |
| 31982 | would potentially conflict with the @var{sequence-id}). |
| 31983 | |
| 31984 | @cindex remote protocol, binary data |
| 31985 | @anchor{Binary Data} |
| 31986 | Binary data in most packets is encoded either as two hexadecimal |
| 31987 | digits per byte of binary data. This allowed the traditional remote |
| 31988 | protocol to work over connections which were only seven-bit clean. |
| 31989 | Some packets designed more recently assume an eight-bit clean |
| 31990 | connection, and use a more efficient encoding to send and receive |
| 31991 | binary data. |
| 31992 | |
| 31993 | The binary data representation uses @code{7d} (@sc{ascii} @samp{@}}) |
| 31994 | as an escape character. Any escaped byte is transmitted as the escape |
| 31995 | character followed by the original character XORed with @code{0x20}. |
| 31996 | For example, the byte @code{0x7d} would be transmitted as the two |
| 31997 | bytes @code{0x7d 0x5d}. The bytes @code{0x23} (@sc{ascii} @samp{#}), |
| 31998 | @code{0x24} (@sc{ascii} @samp{$}), and @code{0x7d} (@sc{ascii} |
| 31999 | @samp{@}}) must always be escaped. Responses sent by the stub |
| 32000 | must also escape @code{0x2a} (@sc{ascii} @samp{*}), so that it |
| 32001 | is not interpreted as the start of a run-length encoded sequence |
| 32002 | (described next). |
| 32003 | |
| 32004 | Response @var{data} can be run-length encoded to save space. |
| 32005 | Run-length encoding replaces runs of identical characters with one |
| 32006 | instance of the repeated character, followed by a @samp{*} and a |
| 32007 | repeat count. The repeat count is itself sent encoded, to avoid |
| 32008 | binary characters in @var{data}: a value of @var{n} is sent as |
| 32009 | @code{@var{n}+29}. For a repeat count greater or equal to 3, this |
| 32010 | produces a printable @sc{ascii} character, e.g.@: a space (@sc{ascii} |
| 32011 | code 32) for a repeat count of 3. (This is because run-length |
| 32012 | encoding starts to win for counts 3 or more.) Thus, for example, |
| 32013 | @samp{0* } is a run-length encoding of ``0000'': the space character |
| 32014 | after @samp{*} means repeat the leading @code{0} @w{@code{32 - 29 = |
| 32015 | 3}} more times. |
| 32016 | |
| 32017 | The printable characters @samp{#} and @samp{$} or with a numeric value |
| 32018 | greater than 126 must not be used. Runs of six repeats (@samp{#}) or |
| 32019 | seven repeats (@samp{$}) can be expanded using a repeat count of only |
| 32020 | five (@samp{"}). For example, @samp{00000000} can be encoded as |
| 32021 | @samp{0*"00}. |
| 32022 | |
| 32023 | The error response returned for some packets includes a two character |
| 32024 | error number. That number is not well defined. |
| 32025 | |
| 32026 | @cindex empty response, for unsupported packets |
| 32027 | For any @var{command} not supported by the stub, an empty response |
| 32028 | (@samp{$#00}) should be returned. That way it is possible to extend the |
| 32029 | protocol. A newer @value{GDBN} can tell if a packet is supported based |
| 32030 | on that response. |
| 32031 | |
| 32032 | A stub is required to support the @samp{g}, @samp{G}, @samp{m}, @samp{M}, |
| 32033 | @samp{c}, and @samp{s} @var{command}s. All other @var{command}s are |
| 32034 | optional. |
| 32035 | |
| 32036 | @node Packets |
| 32037 | @section Packets |
| 32038 | |
| 32039 | The following table provides a complete list of all currently defined |
| 32040 | @var{command}s and their corresponding response @var{data}. |
| 32041 | @xref{File-I/O Remote Protocol Extension}, for details about the File |
| 32042 | I/O extension of the remote protocol. |
| 32043 | |
| 32044 | Each packet's description has a template showing the packet's overall |
| 32045 | syntax, followed by an explanation of the packet's meaning. We |
| 32046 | include spaces in some of the templates for clarity; these are not |
| 32047 | part of the packet's syntax. No @value{GDBN} packet uses spaces to |
| 32048 | separate its components. For example, a template like @samp{foo |
| 32049 | @var{bar} @var{baz}} describes a packet beginning with the three ASCII |
| 32050 | bytes @samp{foo}, followed by a @var{bar}, followed directly by a |
| 32051 | @var{baz}. @value{GDBN} does not transmit a space character between the |
| 32052 | @samp{foo} and the @var{bar}, or between the @var{bar} and the |
| 32053 | @var{baz}. |
| 32054 | |
| 32055 | @cindex @var{thread-id}, in remote protocol |
| 32056 | @anchor{thread-id syntax} |
| 32057 | Several packets and replies include a @var{thread-id} field to identify |
| 32058 | a thread. Normally these are positive numbers with a target-specific |
| 32059 | interpretation, formatted as big-endian hex strings. A @var{thread-id} |
| 32060 | can also be a literal @samp{-1} to indicate all threads, or @samp{0} to |
| 32061 | pick any thread. |
| 32062 | |
| 32063 | In addition, the remote protocol supports a multiprocess feature in |
| 32064 | which the @var{thread-id} syntax is extended to optionally include both |
| 32065 | process and thread ID fields, as @samp{p@var{pid}.@var{tid}}. |
| 32066 | The @var{pid} (process) and @var{tid} (thread) components each have the |
| 32067 | format described above: a positive number with target-specific |
| 32068 | interpretation formatted as a big-endian hex string, literal @samp{-1} |
| 32069 | to indicate all processes or threads (respectively), or @samp{0} to |
| 32070 | indicate an arbitrary process or thread. Specifying just a process, as |
| 32071 | @samp{p@var{pid}}, is equivalent to @samp{p@var{pid}.-1}. It is an |
| 32072 | error to specify all processes but a specific thread, such as |
| 32073 | @samp{p-1.@var{tid}}. Note that the @samp{p} prefix is @emph{not} used |
| 32074 | for those packets and replies explicitly documented to include a process |
| 32075 | ID, rather than a @var{thread-id}. |
| 32076 | |
| 32077 | The multiprocess @var{thread-id} syntax extensions are only used if both |
| 32078 | @value{GDBN} and the stub report support for the @samp{multiprocess} |
| 32079 | feature using @samp{qSupported}. @xref{multiprocess extensions}, for |
| 32080 | more information. |
| 32081 | |
| 32082 | Note that all packet forms beginning with an upper- or lower-case |
| 32083 | letter, other than those described here, are reserved for future use. |
| 32084 | |
| 32085 | Here are the packet descriptions. |
| 32086 | |
| 32087 | @table @samp |
| 32088 | |
| 32089 | @item ! |
| 32090 | @cindex @samp{!} packet |
| 32091 | @anchor{extended mode} |
| 32092 | Enable extended mode. In extended mode, the remote server is made |
| 32093 | persistent. The @samp{R} packet is used to restart the program being |
| 32094 | debugged. |
| 32095 | |
| 32096 | Reply: |
| 32097 | @table @samp |
| 32098 | @item OK |
| 32099 | The remote target both supports and has enabled extended mode. |
| 32100 | @end table |
| 32101 | |
| 32102 | @item ? |
| 32103 | @cindex @samp{?} packet |
| 32104 | Indicate the reason the target halted. The reply is the same as for |
| 32105 | step and continue. This packet has a special interpretation when the |
| 32106 | target is in non-stop mode; see @ref{Remote Non-Stop}. |
| 32107 | |
| 32108 | Reply: |
| 32109 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32110 | |
| 32111 | @item A @var{arglen},@var{argnum},@var{arg},@dots{} |
| 32112 | @cindex @samp{A} packet |
| 32113 | Initialized @code{argv[]} array passed into program. @var{arglen} |
| 32114 | specifies the number of bytes in the hex encoded byte stream |
| 32115 | @var{arg}. See @code{gdbserver} for more details. |
| 32116 | |
| 32117 | Reply: |
| 32118 | @table @samp |
| 32119 | @item OK |
| 32120 | The arguments were set. |
| 32121 | @item E @var{NN} |
| 32122 | An error occurred. |
| 32123 | @end table |
| 32124 | |
| 32125 | @item b @var{baud} |
| 32126 | @cindex @samp{b} packet |
| 32127 | (Don't use this packet; its behavior is not well-defined.) |
| 32128 | Change the serial line speed to @var{baud}. |
| 32129 | |
| 32130 | JTC: @emph{When does the transport layer state change? When it's |
| 32131 | received, or after the ACK is transmitted. In either case, there are |
| 32132 | problems if the command or the acknowledgment packet is dropped.} |
| 32133 | |
| 32134 | Stan: @emph{If people really wanted to add something like this, and get |
| 32135 | it working for the first time, they ought to modify ser-unix.c to send |
| 32136 | some kind of out-of-band message to a specially-setup stub and have the |
| 32137 | switch happen "in between" packets, so that from remote protocol's point |
| 32138 | of view, nothing actually happened.} |
| 32139 | |
| 32140 | @item B @var{addr},@var{mode} |
| 32141 | @cindex @samp{B} packet |
| 32142 | Set (@var{mode} is @samp{S}) or clear (@var{mode} is @samp{C}) a |
| 32143 | breakpoint at @var{addr}. |
| 32144 | |
| 32145 | Don't use this packet. Use the @samp{Z} and @samp{z} packets instead |
| 32146 | (@pxref{insert breakpoint or watchpoint packet}). |
| 32147 | |
| 32148 | @cindex @samp{bc} packet |
| 32149 | @anchor{bc} |
| 32150 | @item bc |
| 32151 | Backward continue. Execute the target system in reverse. No parameter. |
| 32152 | @xref{Reverse Execution}, for more information. |
| 32153 | |
| 32154 | Reply: |
| 32155 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32156 | |
| 32157 | @cindex @samp{bs} packet |
| 32158 | @anchor{bs} |
| 32159 | @item bs |
| 32160 | Backward single step. Execute one instruction in reverse. No parameter. |
| 32161 | @xref{Reverse Execution}, for more information. |
| 32162 | |
| 32163 | Reply: |
| 32164 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32165 | |
| 32166 | @item c @r{[}@var{addr}@r{]} |
| 32167 | @cindex @samp{c} packet |
| 32168 | Continue. @var{addr} is address to resume. If @var{addr} is omitted, |
| 32169 | resume at current address. |
| 32170 | |
| 32171 | Reply: |
| 32172 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32173 | |
| 32174 | @item C @var{sig}@r{[};@var{addr}@r{]} |
| 32175 | @cindex @samp{C} packet |
| 32176 | Continue with signal @var{sig} (hex signal number). If |
| 32177 | @samp{;@var{addr}} is omitted, resume at same address. |
| 32178 | |
| 32179 | Reply: |
| 32180 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32181 | |
| 32182 | @item d |
| 32183 | @cindex @samp{d} packet |
| 32184 | Toggle debug flag. |
| 32185 | |
| 32186 | Don't use this packet; instead, define a general set packet |
| 32187 | (@pxref{General Query Packets}). |
| 32188 | |
| 32189 | @item D |
| 32190 | @itemx D;@var{pid} |
| 32191 | @cindex @samp{D} packet |
| 32192 | The first form of the packet is used to detach @value{GDBN} from the |
| 32193 | remote system. It is sent to the remote target |
| 32194 | before @value{GDBN} disconnects via the @code{detach} command. |
| 32195 | |
| 32196 | The second form, including a process ID, is used when multiprocess |
| 32197 | protocol extensions are enabled (@pxref{multiprocess extensions}), to |
| 32198 | detach only a specific process. The @var{pid} is specified as a |
| 32199 | big-endian hex string. |
| 32200 | |
| 32201 | Reply: |
| 32202 | @table @samp |
| 32203 | @item OK |
| 32204 | for success |
| 32205 | @item E @var{NN} |
| 32206 | for an error |
| 32207 | @end table |
| 32208 | |
| 32209 | @item F @var{RC},@var{EE},@var{CF};@var{XX} |
| 32210 | @cindex @samp{F} packet |
| 32211 | A reply from @value{GDBN} to an @samp{F} packet sent by the target. |
| 32212 | This is part of the File-I/O protocol extension. @xref{File-I/O |
| 32213 | Remote Protocol Extension}, for the specification. |
| 32214 | |
| 32215 | @item g |
| 32216 | @anchor{read registers packet} |
| 32217 | @cindex @samp{g} packet |
| 32218 | Read general registers. |
| 32219 | |
| 32220 | Reply: |
| 32221 | @table @samp |
| 32222 | @item @var{XX@dots{}} |
| 32223 | Each byte of register data is described by two hex digits. The bytes |
| 32224 | with the register are transmitted in target byte order. The size of |
| 32225 | each register and their position within the @samp{g} packet are |
| 32226 | determined by the @value{GDBN} internal gdbarch functions |
| 32227 | @code{DEPRECATED_REGISTER_RAW_SIZE} and @code{gdbarch_register_name}. The |
| 32228 | specification of several standard @samp{g} packets is specified below. |
| 32229 | |
| 32230 | When reading registers from a trace frame (@pxref{Analyze Collected |
| 32231 | Data,,Using the Collected Data}), the stub may also return a string of |
| 32232 | literal @samp{x}'s in place of the register data digits, to indicate |
| 32233 | that the corresponding register has not been collected, thus its value |
| 32234 | is unavailable. For example, for an architecture with 4 registers of |
| 32235 | 4 bytes each, the following reply indicates to @value{GDBN} that |
| 32236 | registers 0 and 2 have not been collected, while registers 1 and 3 |
| 32237 | have been collected, and both have zero value: |
| 32238 | |
| 32239 | @smallexample |
| 32240 | -> @code{g} |
| 32241 | <- @code{xxxxxxxx00000000xxxxxxxx00000000} |
| 32242 | @end smallexample |
| 32243 | |
| 32244 | @item E @var{NN} |
| 32245 | for an error. |
| 32246 | @end table |
| 32247 | |
| 32248 | @item G @var{XX@dots{}} |
| 32249 | @cindex @samp{G} packet |
| 32250 | Write general registers. @xref{read registers packet}, for a |
| 32251 | description of the @var{XX@dots{}} data. |
| 32252 | |
| 32253 | Reply: |
| 32254 | @table @samp |
| 32255 | @item OK |
| 32256 | for success |
| 32257 | @item E @var{NN} |
| 32258 | for an error |
| 32259 | @end table |
| 32260 | |
| 32261 | @item H @var{c} @var{thread-id} |
| 32262 | @cindex @samp{H} packet |
| 32263 | Set thread for subsequent operations (@samp{m}, @samp{M}, @samp{g}, |
| 32264 | @samp{G}, et.al.). @var{c} depends on the operation to be performed: it |
| 32265 | should be @samp{c} for step and continue operations, @samp{g} for other |
| 32266 | operations. The thread designator @var{thread-id} has the format and |
| 32267 | interpretation described in @ref{thread-id syntax}. |
| 32268 | |
| 32269 | Reply: |
| 32270 | @table @samp |
| 32271 | @item OK |
| 32272 | for success |
| 32273 | @item E @var{NN} |
| 32274 | for an error |
| 32275 | @end table |
| 32276 | |
| 32277 | @c FIXME: JTC: |
| 32278 | @c 'H': How restrictive (or permissive) is the thread model. If a |
| 32279 | @c thread is selected and stopped, are other threads allowed |
| 32280 | @c to continue to execute? As I mentioned above, I think the |
| 32281 | @c semantics of each command when a thread is selected must be |
| 32282 | @c described. For example: |
| 32283 | @c |
| 32284 | @c 'g': If the stub supports threads and a specific thread is |
| 32285 | @c selected, returns the register block from that thread; |
| 32286 | @c otherwise returns current registers. |
| 32287 | @c |
| 32288 | @c 'G' If the stub supports threads and a specific thread is |
| 32289 | @c selected, sets the registers of the register block of |
| 32290 | @c that thread; otherwise sets current registers. |
| 32291 | |
| 32292 | @item i @r{[}@var{addr}@r{[},@var{nnn}@r{]]} |
| 32293 | @anchor{cycle step packet} |
| 32294 | @cindex @samp{i} packet |
| 32295 | Step the remote target by a single clock cycle. If @samp{,@var{nnn}} is |
| 32296 | present, cycle step @var{nnn} cycles. If @var{addr} is present, cycle |
| 32297 | step starting at that address. |
| 32298 | |
| 32299 | @item I |
| 32300 | @cindex @samp{I} packet |
| 32301 | Signal, then cycle step. @xref{step with signal packet}. @xref{cycle |
| 32302 | step packet}. |
| 32303 | |
| 32304 | @item k |
| 32305 | @cindex @samp{k} packet |
| 32306 | Kill request. |
| 32307 | |
| 32308 | FIXME: @emph{There is no description of how to operate when a specific |
| 32309 | thread context has been selected (i.e.@: does 'k' kill only that |
| 32310 | thread?)}. |
| 32311 | |
| 32312 | @item m @var{addr},@var{length} |
| 32313 | @cindex @samp{m} packet |
| 32314 | Read @var{length} bytes of memory starting at address @var{addr}. |
| 32315 | Note that @var{addr} may not be aligned to any particular boundary. |
| 32316 | |
| 32317 | The stub need not use any particular size or alignment when gathering |
| 32318 | data from memory for the response; even if @var{addr} is word-aligned |
| 32319 | and @var{length} is a multiple of the word size, the stub is free to |
| 32320 | use byte accesses, or not. For this reason, this packet may not be |
| 32321 | suitable for accessing memory-mapped I/O devices. |
| 32322 | @cindex alignment of remote memory accesses |
| 32323 | @cindex size of remote memory accesses |
| 32324 | @cindex memory, alignment and size of remote accesses |
| 32325 | |
| 32326 | Reply: |
| 32327 | @table @samp |
| 32328 | @item @var{XX@dots{}} |
| 32329 | Memory contents; each byte is transmitted as a two-digit hexadecimal |
| 32330 | number. The reply may contain fewer bytes than requested if the |
| 32331 | server was able to read only part of the region of memory. |
| 32332 | @item E @var{NN} |
| 32333 | @var{NN} is errno |
| 32334 | @end table |
| 32335 | |
| 32336 | @item M @var{addr},@var{length}:@var{XX@dots{}} |
| 32337 | @cindex @samp{M} packet |
| 32338 | Write @var{length} bytes of memory starting at address @var{addr}. |
| 32339 | @var{XX@dots{}} is the data; each byte is transmitted as a two-digit |
| 32340 | hexadecimal number. |
| 32341 | |
| 32342 | Reply: |
| 32343 | @table @samp |
| 32344 | @item OK |
| 32345 | for success |
| 32346 | @item E @var{NN} |
| 32347 | for an error (this includes the case where only part of the data was |
| 32348 | written). |
| 32349 | @end table |
| 32350 | |
| 32351 | @item p @var{n} |
| 32352 | @cindex @samp{p} packet |
| 32353 | Read the value of register @var{n}; @var{n} is in hex. |
| 32354 | @xref{read registers packet}, for a description of how the returned |
| 32355 | register value is encoded. |
| 32356 | |
| 32357 | Reply: |
| 32358 | @table @samp |
| 32359 | @item @var{XX@dots{}} |
| 32360 | the register's value |
| 32361 | @item E @var{NN} |
| 32362 | for an error |
| 32363 | @item |
| 32364 | Indicating an unrecognized @var{query}. |
| 32365 | @end table |
| 32366 | |
| 32367 | @item P @var{n@dots{}}=@var{r@dots{}} |
| 32368 | @anchor{write register packet} |
| 32369 | @cindex @samp{P} packet |
| 32370 | Write register @var{n@dots{}} with value @var{r@dots{}}. The register |
| 32371 | number @var{n} is in hexadecimal, and @var{r@dots{}} contains two hex |
| 32372 | digits for each byte in the register (target byte order). |
| 32373 | |
| 32374 | Reply: |
| 32375 | @table @samp |
| 32376 | @item OK |
| 32377 | for success |
| 32378 | @item E @var{NN} |
| 32379 | for an error |
| 32380 | @end table |
| 32381 | |
| 32382 | @item q @var{name} @var{params}@dots{} |
| 32383 | @itemx Q @var{name} @var{params}@dots{} |
| 32384 | @cindex @samp{q} packet |
| 32385 | @cindex @samp{Q} packet |
| 32386 | General query (@samp{q}) and set (@samp{Q}). These packets are |
| 32387 | described fully in @ref{General Query Packets}. |
| 32388 | |
| 32389 | @item r |
| 32390 | @cindex @samp{r} packet |
| 32391 | Reset the entire system. |
| 32392 | |
| 32393 | Don't use this packet; use the @samp{R} packet instead. |
| 32394 | |
| 32395 | @item R @var{XX} |
| 32396 | @cindex @samp{R} packet |
| 32397 | Restart the program being debugged. @var{XX}, while needed, is ignored. |
| 32398 | This packet is only available in extended mode (@pxref{extended mode}). |
| 32399 | |
| 32400 | The @samp{R} packet has no reply. |
| 32401 | |
| 32402 | @item s @r{[}@var{addr}@r{]} |
| 32403 | @cindex @samp{s} packet |
| 32404 | Single step. @var{addr} is the address at which to resume. If |
| 32405 | @var{addr} is omitted, resume at same address. |
| 32406 | |
| 32407 | Reply: |
| 32408 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32409 | |
| 32410 | @item S @var{sig}@r{[};@var{addr}@r{]} |
| 32411 | @anchor{step with signal packet} |
| 32412 | @cindex @samp{S} packet |
| 32413 | Step with signal. This is analogous to the @samp{C} packet, but |
| 32414 | requests a single-step, rather than a normal resumption of execution. |
| 32415 | |
| 32416 | Reply: |
| 32417 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32418 | |
| 32419 | @item t @var{addr}:@var{PP},@var{MM} |
| 32420 | @cindex @samp{t} packet |
| 32421 | Search backwards starting at address @var{addr} for a match with pattern |
| 32422 | @var{PP} and mask @var{MM}. @var{PP} and @var{MM} are 4 bytes. |
| 32423 | @var{addr} must be at least 3 digits. |
| 32424 | |
| 32425 | @item T @var{thread-id} |
| 32426 | @cindex @samp{T} packet |
| 32427 | Find out if the thread @var{thread-id} is alive. @xref{thread-id syntax}. |
| 32428 | |
| 32429 | Reply: |
| 32430 | @table @samp |
| 32431 | @item OK |
| 32432 | thread is still alive |
| 32433 | @item E @var{NN} |
| 32434 | thread is dead |
| 32435 | @end table |
| 32436 | |
| 32437 | @item v |
| 32438 | Packets starting with @samp{v} are identified by a multi-letter name, |
| 32439 | up to the first @samp{;} or @samp{?} (or the end of the packet). |
| 32440 | |
| 32441 | @item vAttach;@var{pid} |
| 32442 | @cindex @samp{vAttach} packet |
| 32443 | Attach to a new process with the specified process ID @var{pid}. |
| 32444 | The process ID is a |
| 32445 | hexadecimal integer identifying the process. In all-stop mode, all |
| 32446 | threads in the attached process are stopped; in non-stop mode, it may be |
| 32447 | attached without being stopped if that is supported by the target. |
| 32448 | |
| 32449 | @c In non-stop mode, on a successful vAttach, the stub should set the |
| 32450 | @c current thread to a thread of the newly-attached process. After |
| 32451 | @c attaching, GDB queries for the attached process's thread ID with qC. |
| 32452 | @c Also note that, from a user perspective, whether or not the |
| 32453 | @c target is stopped on attach in non-stop mode depends on whether you |
| 32454 | @c use the foreground or background version of the attach command, not |
| 32455 | @c on what vAttach does; GDB does the right thing with respect to either |
| 32456 | @c stopping or restarting threads. |
| 32457 | |
| 32458 | This packet is only available in extended mode (@pxref{extended mode}). |
| 32459 | |
| 32460 | Reply: |
| 32461 | @table @samp |
| 32462 | @item E @var{nn} |
| 32463 | for an error |
| 32464 | @item @r{Any stop packet} |
| 32465 | for success in all-stop mode (@pxref{Stop Reply Packets}) |
| 32466 | @item OK |
| 32467 | for success in non-stop mode (@pxref{Remote Non-Stop}) |
| 32468 | @end table |
| 32469 | |
| 32470 | @item vCont@r{[};@var{action}@r{[}:@var{thread-id}@r{]]}@dots{} |
| 32471 | @cindex @samp{vCont} packet |
| 32472 | Resume the inferior, specifying different actions for each thread. |
| 32473 | If an action is specified with no @var{thread-id}, then it is applied to any |
| 32474 | threads that don't have a specific action specified; if no default action is |
| 32475 | specified then other threads should remain stopped in all-stop mode and |
| 32476 | in their current state in non-stop mode. |
| 32477 | Specifying multiple |
| 32478 | default actions is an error; specifying no actions is also an error. |
| 32479 | Thread IDs are specified using the syntax described in @ref{thread-id syntax}. |
| 32480 | |
| 32481 | Currently supported actions are: |
| 32482 | |
| 32483 | @table @samp |
| 32484 | @item c |
| 32485 | Continue. |
| 32486 | @item C @var{sig} |
| 32487 | Continue with signal @var{sig}. The signal @var{sig} should be two hex digits. |
| 32488 | @item s |
| 32489 | Step. |
| 32490 | @item S @var{sig} |
| 32491 | Step with signal @var{sig}. The signal @var{sig} should be two hex digits. |
| 32492 | @item t |
| 32493 | Stop. |
| 32494 | @end table |
| 32495 | |
| 32496 | The optional argument @var{addr} normally associated with the |
| 32497 | @samp{c}, @samp{C}, @samp{s}, and @samp{S} packets is |
| 32498 | not supported in @samp{vCont}. |
| 32499 | |
| 32500 | The @samp{t} action is only relevant in non-stop mode |
| 32501 | (@pxref{Remote Non-Stop}) and may be ignored by the stub otherwise. |
| 32502 | A stop reply should be generated for any affected thread not already stopped. |
| 32503 | When a thread is stopped by means of a @samp{t} action, |
| 32504 | the corresponding stop reply should indicate that the thread has stopped with |
| 32505 | signal @samp{0}, regardless of whether the target uses some other signal |
| 32506 | as an implementation detail. |
| 32507 | |
| 32508 | Reply: |
| 32509 | @xref{Stop Reply Packets}, for the reply specifications. |
| 32510 | |
| 32511 | @item vCont? |
| 32512 | @cindex @samp{vCont?} packet |
| 32513 | Request a list of actions supported by the @samp{vCont} packet. |
| 32514 | |
| 32515 | Reply: |
| 32516 | @table @samp |
| 32517 | @item vCont@r{[};@var{action}@dots{}@r{]} |
| 32518 | The @samp{vCont} packet is supported. Each @var{action} is a supported |
| 32519 | command in the @samp{vCont} packet. |
| 32520 | @item |
| 32521 | The @samp{vCont} packet is not supported. |
| 32522 | @end table |
| 32523 | |
| 32524 | @item vFile:@var{operation}:@var{parameter}@dots{} |
| 32525 | @cindex @samp{vFile} packet |
| 32526 | Perform a file operation on the target system. For details, |
| 32527 | see @ref{Host I/O Packets}. |
| 32528 | |
| 32529 | @item vFlashErase:@var{addr},@var{length} |
| 32530 | @cindex @samp{vFlashErase} packet |
| 32531 | Direct the stub to erase @var{length} bytes of flash starting at |
| 32532 | @var{addr}. The region may enclose any number of flash blocks, but |
| 32533 | its start and end must fall on block boundaries, as indicated by the |
| 32534 | flash block size appearing in the memory map (@pxref{Memory Map |
| 32535 | Format}). @value{GDBN} groups flash memory programming operations |
| 32536 | together, and sends a @samp{vFlashDone} request after each group; the |
| 32537 | stub is allowed to delay erase operation until the @samp{vFlashDone} |
| 32538 | packet is received. |
| 32539 | |
| 32540 | The stub must support @samp{vCont} if it reports support for |
| 32541 | multiprocess extensions (@pxref{multiprocess extensions}). Note that in |
| 32542 | this case @samp{vCont} actions can be specified to apply to all threads |
| 32543 | in a process by using the @samp{p@var{pid}.-1} form of the |
| 32544 | @var{thread-id}. |
| 32545 | |
| 32546 | Reply: |
| 32547 | @table @samp |
| 32548 | @item OK |
| 32549 | for success |
| 32550 | @item E @var{NN} |
| 32551 | for an error |
| 32552 | @end table |
| 32553 | |
| 32554 | @item vFlashWrite:@var{addr}:@var{XX@dots{}} |
| 32555 | @cindex @samp{vFlashWrite} packet |
| 32556 | Direct the stub to write data to flash address @var{addr}. The data |
| 32557 | is passed in binary form using the same encoding as for the @samp{X} |
| 32558 | packet (@pxref{Binary Data}). The memory ranges specified by |
| 32559 | @samp{vFlashWrite} packets preceding a @samp{vFlashDone} packet must |
| 32560 | not overlap, and must appear in order of increasing addresses |
| 32561 | (although @samp{vFlashErase} packets for higher addresses may already |
| 32562 | have been received; the ordering is guaranteed only between |
| 32563 | @samp{vFlashWrite} packets). If a packet writes to an address that was |
| 32564 | neither erased by a preceding @samp{vFlashErase} packet nor by some other |
| 32565 | target-specific method, the results are unpredictable. |
| 32566 | |
| 32567 | |
| 32568 | Reply: |
| 32569 | @table @samp |
| 32570 | @item OK |
| 32571 | for success |
| 32572 | @item E.memtype |
| 32573 | for vFlashWrite addressing non-flash memory |
| 32574 | @item E @var{NN} |
| 32575 | for an error |
| 32576 | @end table |
| 32577 | |
| 32578 | @item vFlashDone |
| 32579 | @cindex @samp{vFlashDone} packet |
| 32580 | Indicate to the stub that flash programming operation is finished. |
| 32581 | The stub is permitted to delay or batch the effects of a group of |
| 32582 | @samp{vFlashErase} and @samp{vFlashWrite} packets until a |
| 32583 | @samp{vFlashDone} packet is received. The contents of the affected |
| 32584 | regions of flash memory are unpredictable until the @samp{vFlashDone} |
| 32585 | request is completed. |
| 32586 | |
| 32587 | @item vKill;@var{pid} |
| 32588 | @cindex @samp{vKill} packet |
| 32589 | Kill the process with the specified process ID. @var{pid} is a |
| 32590 | hexadecimal integer identifying the process. This packet is used in |
| 32591 | preference to @samp{k} when multiprocess protocol extensions are |
| 32592 | supported; see @ref{multiprocess extensions}. |
| 32593 | |
| 32594 | Reply: |
| 32595 | @table @samp |
| 32596 | @item E @var{nn} |
| 32597 | for an error |
| 32598 | @item OK |
| 32599 | for success |
| 32600 | @end table |
| 32601 | |
| 32602 | @item vRun;@var{filename}@r{[};@var{argument}@r{]}@dots{} |
| 32603 | @cindex @samp{vRun} packet |
| 32604 | Run the program @var{filename}, passing it each @var{argument} on its |
| 32605 | command line. The file and arguments are hex-encoded strings. If |
| 32606 | @var{filename} is an empty string, the stub may use a default program |
| 32607 | (e.g.@: the last program run). The program is created in the stopped |
| 32608 | state. |
| 32609 | |
| 32610 | @c FIXME: What about non-stop mode? |
| 32611 | |
| 32612 | This packet is only available in extended mode (@pxref{extended mode}). |
| 32613 | |
| 32614 | Reply: |
| 32615 | @table @samp |
| 32616 | @item E @var{nn} |
| 32617 | for an error |
| 32618 | @item @r{Any stop packet} |
| 32619 | for success (@pxref{Stop Reply Packets}) |
| 32620 | @end table |
| 32621 | |
| 32622 | @item vStopped |
| 32623 | @anchor{vStopped packet} |
| 32624 | @cindex @samp{vStopped} packet |
| 32625 | |
| 32626 | In non-stop mode (@pxref{Remote Non-Stop}), acknowledge a previous stop |
| 32627 | reply and prompt for the stub to report another one. |
| 32628 | |
| 32629 | Reply: |
| 32630 | @table @samp |
| 32631 | @item @r{Any stop packet} |
| 32632 | if there is another unreported stop event (@pxref{Stop Reply Packets}) |
| 32633 | @item OK |
| 32634 | if there are no unreported stop events |
| 32635 | @end table |
| 32636 | |
| 32637 | @item X @var{addr},@var{length}:@var{XX@dots{}} |
| 32638 | @anchor{X packet} |
| 32639 | @cindex @samp{X} packet |
| 32640 | Write data to memory, where the data is transmitted in binary. |
| 32641 | @var{addr} is address, @var{length} is number of bytes, |
| 32642 | @samp{@var{XX}@dots{}} is binary data (@pxref{Binary Data}). |
| 32643 | |
| 32644 | Reply: |
| 32645 | @table @samp |
| 32646 | @item OK |
| 32647 | for success |
| 32648 | @item E @var{NN} |
| 32649 | for an error |
| 32650 | @end table |
| 32651 | |
| 32652 | @item z @var{type},@var{addr},@var{kind} |
| 32653 | @itemx Z @var{type},@var{addr},@var{kind} |
| 32654 | @anchor{insert breakpoint or watchpoint packet} |
| 32655 | @cindex @samp{z} packet |
| 32656 | @cindex @samp{Z} packets |
| 32657 | Insert (@samp{Z}) or remove (@samp{z}) a @var{type} breakpoint or |
| 32658 | watchpoint starting at address @var{address} of kind @var{kind}. |
| 32659 | |
| 32660 | Each breakpoint and watchpoint packet @var{type} is documented |
| 32661 | separately. |
| 32662 | |
| 32663 | @emph{Implementation notes: A remote target shall return an empty string |
| 32664 | for an unrecognized breakpoint or watchpoint packet @var{type}. A |
| 32665 | remote target shall support either both or neither of a given |
| 32666 | @samp{Z@var{type}@dots{}} and @samp{z@var{type}@dots{}} packet pair. To |
| 32667 | avoid potential problems with duplicate packets, the operations should |
| 32668 | be implemented in an idempotent way.} |
| 32669 | |
| 32670 | @item z0,@var{addr},@var{kind} |
| 32671 | @itemx Z0,@var{addr},@var{kind} |
| 32672 | @cindex @samp{z0} packet |
| 32673 | @cindex @samp{Z0} packet |
| 32674 | Insert (@samp{Z0}) or remove (@samp{z0}) a memory breakpoint at address |
| 32675 | @var{addr} of type @var{kind}. |
| 32676 | |
| 32677 | A memory breakpoint is implemented by replacing the instruction at |
| 32678 | @var{addr} with a software breakpoint or trap instruction. The |
| 32679 | @var{kind} is target-specific and typically indicates the size of |
| 32680 | the breakpoint in bytes that should be inserted. E.g., the @sc{arm} |
| 32681 | and @sc{mips} can insert either a 2 or 4 byte breakpoint. Some |
| 32682 | architectures have additional meanings for @var{kind}; |
| 32683 | see @ref{Architecture-Specific Protocol Details}. |
| 32684 | |
| 32685 | @emph{Implementation note: It is possible for a target to copy or move |
| 32686 | code that contains memory breakpoints (e.g., when implementing |
| 32687 | overlays). The behavior of this packet, in the presence of such a |
| 32688 | target, is not defined.} |
| 32689 | |
| 32690 | Reply: |
| 32691 | @table @samp |
| 32692 | @item OK |
| 32693 | success |
| 32694 | @item |
| 32695 | not supported |
| 32696 | @item E @var{NN} |
| 32697 | for an error |
| 32698 | @end table |
| 32699 | |
| 32700 | @item z1,@var{addr},@var{kind} |
| 32701 | @itemx Z1,@var{addr},@var{kind} |
| 32702 | @cindex @samp{z1} packet |
| 32703 | @cindex @samp{Z1} packet |
| 32704 | Insert (@samp{Z1}) or remove (@samp{z1}) a hardware breakpoint at |
| 32705 | address @var{addr}. |
| 32706 | |
| 32707 | A hardware breakpoint is implemented using a mechanism that is not |
| 32708 | dependant on being able to modify the target's memory. @var{kind} |
| 32709 | has the same meaning as in @samp{Z0} packets. |
| 32710 | |
| 32711 | @emph{Implementation note: A hardware breakpoint is not affected by code |
| 32712 | movement.} |
| 32713 | |
| 32714 | Reply: |
| 32715 | @table @samp |
| 32716 | @item OK |
| 32717 | success |
| 32718 | @item |
| 32719 | not supported |
| 32720 | @item E @var{NN} |
| 32721 | for an error |
| 32722 | @end table |
| 32723 | |
| 32724 | @item z2,@var{addr},@var{kind} |
| 32725 | @itemx Z2,@var{addr},@var{kind} |
| 32726 | @cindex @samp{z2} packet |
| 32727 | @cindex @samp{Z2} packet |
| 32728 | Insert (@samp{Z2}) or remove (@samp{z2}) a write watchpoint at @var{addr}. |
| 32729 | @var{kind} is interpreted as the number of bytes to watch. |
| 32730 | |
| 32731 | Reply: |
| 32732 | @table @samp |
| 32733 | @item OK |
| 32734 | success |
| 32735 | @item |
| 32736 | not supported |
| 32737 | @item E @var{NN} |
| 32738 | for an error |
| 32739 | @end table |
| 32740 | |
| 32741 | @item z3,@var{addr},@var{kind} |
| 32742 | @itemx Z3,@var{addr},@var{kind} |
| 32743 | @cindex @samp{z3} packet |
| 32744 | @cindex @samp{Z3} packet |
| 32745 | Insert (@samp{Z3}) or remove (@samp{z3}) a read watchpoint at @var{addr}. |
| 32746 | @var{kind} is interpreted as the number of bytes to watch. |
| 32747 | |
| 32748 | Reply: |
| 32749 | @table @samp |
| 32750 | @item OK |
| 32751 | success |
| 32752 | @item |
| 32753 | not supported |
| 32754 | @item E @var{NN} |
| 32755 | for an error |
| 32756 | @end table |
| 32757 | |
| 32758 | @item z4,@var{addr},@var{kind} |
| 32759 | @itemx Z4,@var{addr},@var{kind} |
| 32760 | @cindex @samp{z4} packet |
| 32761 | @cindex @samp{Z4} packet |
| 32762 | Insert (@samp{Z4}) or remove (@samp{z4}) an access watchpoint at @var{addr}. |
| 32763 | @var{kind} is interpreted as the number of bytes to watch. |
| 32764 | |
| 32765 | Reply: |
| 32766 | @table @samp |
| 32767 | @item OK |
| 32768 | success |
| 32769 | @item |
| 32770 | not supported |
| 32771 | @item E @var{NN} |
| 32772 | for an error |
| 32773 | @end table |
| 32774 | |
| 32775 | @end table |
| 32776 | |
| 32777 | @node Stop Reply Packets |
| 32778 | @section Stop Reply Packets |
| 32779 | @cindex stop reply packets |
| 32780 | |
| 32781 | The @samp{C}, @samp{c}, @samp{S}, @samp{s}, @samp{vCont}, |
| 32782 | @samp{vAttach}, @samp{vRun}, @samp{vStopped}, and @samp{?} packets can |
| 32783 | receive any of the below as a reply. Except for @samp{?} |
| 32784 | and @samp{vStopped}, that reply is only returned |
| 32785 | when the target halts. In the below the exact meaning of @dfn{signal |
| 32786 | number} is defined by the header @file{include/gdb/signals.h} in the |
| 32787 | @value{GDBN} source code. |
| 32788 | |
| 32789 | As in the description of request packets, we include spaces in the |
| 32790 | reply templates for clarity; these are not part of the reply packet's |
| 32791 | syntax. No @value{GDBN} stop reply packet uses spaces to separate its |
| 32792 | components. |
| 32793 | |
| 32794 | @table @samp |
| 32795 | |
| 32796 | @item S @var{AA} |
| 32797 | The program received signal number @var{AA} (a two-digit hexadecimal |
| 32798 | number). This is equivalent to a @samp{T} response with no |
| 32799 | @var{n}:@var{r} pairs. |
| 32800 | |
| 32801 | @item T @var{AA} @var{n1}:@var{r1};@var{n2}:@var{r2};@dots{} |
| 32802 | @cindex @samp{T} packet reply |
| 32803 | The program received signal number @var{AA} (a two-digit hexadecimal |
| 32804 | number). This is equivalent to an @samp{S} response, except that the |
| 32805 | @samp{@var{n}:@var{r}} pairs can carry values of important registers |
| 32806 | and other information directly in the stop reply packet, reducing |
| 32807 | round-trip latency. Single-step and breakpoint traps are reported |
| 32808 | this way. Each @samp{@var{n}:@var{r}} pair is interpreted as follows: |
| 32809 | |
| 32810 | @itemize @bullet |
| 32811 | @item |
| 32812 | If @var{n} is a hexadecimal number, it is a register number, and the |
| 32813 | corresponding @var{r} gives that register's value. @var{r} is a |
| 32814 | series of bytes in target byte order, with each byte given by a |
| 32815 | two-digit hex number. |
| 32816 | |
| 32817 | @item |
| 32818 | If @var{n} is @samp{thread}, then @var{r} is the @var{thread-id} of |
| 32819 | the stopped thread, as specified in @ref{thread-id syntax}. |
| 32820 | |
| 32821 | @item |
| 32822 | If @var{n} is @samp{core}, then @var{r} is the hexadecimal number of |
| 32823 | the core on which the stop event was detected. |
| 32824 | |
| 32825 | @item |
| 32826 | If @var{n} is a recognized @dfn{stop reason}, it describes a more |
| 32827 | specific event that stopped the target. The currently defined stop |
| 32828 | reasons are listed below. @var{aa} should be @samp{05}, the trap |
| 32829 | signal. At most one stop reason should be present. |
| 32830 | |
| 32831 | @item |
| 32832 | Otherwise, @value{GDBN} should ignore this @samp{@var{n}:@var{r}} pair |
| 32833 | and go on to the next; this allows us to extend the protocol in the |
| 32834 | future. |
| 32835 | @end itemize |
| 32836 | |
| 32837 | The currently defined stop reasons are: |
| 32838 | |
| 32839 | @table @samp |
| 32840 | @item watch |
| 32841 | @itemx rwatch |
| 32842 | @itemx awatch |
| 32843 | The packet indicates a watchpoint hit, and @var{r} is the data address, in |
| 32844 | hex. |
| 32845 | |
| 32846 | @cindex shared library events, remote reply |
| 32847 | @item library |
| 32848 | The packet indicates that the loaded libraries have changed. |
| 32849 | @value{GDBN} should use @samp{qXfer:libraries:read} to fetch a new |
| 32850 | list of loaded libraries. @var{r} is ignored. |
| 32851 | |
| 32852 | @cindex replay log events, remote reply |
| 32853 | @item replaylog |
| 32854 | The packet indicates that the target cannot continue replaying |
| 32855 | logged execution events, because it has reached the end (or the |
| 32856 | beginning when executing backward) of the log. The value of @var{r} |
| 32857 | will be either @samp{begin} or @samp{end}. @xref{Reverse Execution}, |
| 32858 | for more information. |
| 32859 | @end table |
| 32860 | |
| 32861 | @item W @var{AA} |
| 32862 | @itemx W @var{AA} ; process:@var{pid} |
| 32863 | The process exited, and @var{AA} is the exit status. This is only |
| 32864 | applicable to certain targets. |
| 32865 | |
| 32866 | The second form of the response, including the process ID of the exited |
| 32867 | process, can be used only when @value{GDBN} has reported support for |
| 32868 | multiprocess protocol extensions; see @ref{multiprocess extensions}. |
| 32869 | The @var{pid} is formatted as a big-endian hex string. |
| 32870 | |
| 32871 | @item X @var{AA} |
| 32872 | @itemx X @var{AA} ; process:@var{pid} |
| 32873 | The process terminated with signal @var{AA}. |
| 32874 | |
| 32875 | The second form of the response, including the process ID of the |
| 32876 | terminated process, can be used only when @value{GDBN} has reported |
| 32877 | support for multiprocess protocol extensions; see @ref{multiprocess |
| 32878 | extensions}. The @var{pid} is formatted as a big-endian hex string. |
| 32879 | |
| 32880 | @item O @var{XX}@dots{} |
| 32881 | @samp{@var{XX}@dots{}} is hex encoding of @sc{ascii} data, to be |
| 32882 | written as the program's console output. This can happen at any time |
| 32883 | while the program is running and the debugger should continue to wait |
| 32884 | for @samp{W}, @samp{T}, etc. This reply is not permitted in non-stop mode. |
| 32885 | |
| 32886 | @item F @var{call-id},@var{parameter}@dots{} |
| 32887 | @var{call-id} is the identifier which says which host system call should |
| 32888 | be called. This is just the name of the function. Translation into the |
| 32889 | correct system call is only applicable as it's defined in @value{GDBN}. |
| 32890 | @xref{File-I/O Remote Protocol Extension}, for a list of implemented |
| 32891 | system calls. |
| 32892 | |
| 32893 | @samp{@var{parameter}@dots{}} is a list of parameters as defined for |
| 32894 | this very system call. |
| 32895 | |
| 32896 | The target replies with this packet when it expects @value{GDBN} to |
| 32897 | call a host system call on behalf of the target. @value{GDBN} replies |
| 32898 | with an appropriate @samp{F} packet and keeps up waiting for the next |
| 32899 | reply packet from the target. The latest @samp{C}, @samp{c}, @samp{S} |
| 32900 | or @samp{s} action is expected to be continued. @xref{File-I/O Remote |
| 32901 | Protocol Extension}, for more details. |
| 32902 | |
| 32903 | @end table |
| 32904 | |
| 32905 | @node General Query Packets |
| 32906 | @section General Query Packets |
| 32907 | @cindex remote query requests |
| 32908 | |
| 32909 | Packets starting with @samp{q} are @dfn{general query packets}; |
| 32910 | packets starting with @samp{Q} are @dfn{general set packets}. General |
| 32911 | query and set packets are a semi-unified form for retrieving and |
| 32912 | sending information to and from the stub. |
| 32913 | |
| 32914 | The initial letter of a query or set packet is followed by a name |
| 32915 | indicating what sort of thing the packet applies to. For example, |
| 32916 | @value{GDBN} may use a @samp{qSymbol} packet to exchange symbol |
| 32917 | definitions with the stub. These packet names follow some |
| 32918 | conventions: |
| 32919 | |
| 32920 | @itemize @bullet |
| 32921 | @item |
| 32922 | The name must not contain commas, colons or semicolons. |
| 32923 | @item |
| 32924 | Most @value{GDBN} query and set packets have a leading upper case |
| 32925 | letter. |
| 32926 | @item |
| 32927 | The names of custom vendor packets should use a company prefix, in |
| 32928 | lower case, followed by a period. For example, packets designed at |
| 32929 | the Acme Corporation might begin with @samp{qacme.foo} (for querying |
| 32930 | foos) or @samp{Qacme.bar} (for setting bars). |
| 32931 | @end itemize |
| 32932 | |
| 32933 | The name of a query or set packet should be separated from any |
| 32934 | parameters by a @samp{:}; the parameters themselves should be |
| 32935 | separated by @samp{,} or @samp{;}. Stubs must be careful to match the |
| 32936 | full packet name, and check for a separator or the end of the packet, |
| 32937 | in case two packet names share a common prefix. New packets should not begin |
| 32938 | with @samp{qC}, @samp{qP}, or @samp{qL}@footnote{The @samp{qP} and @samp{qL} |
| 32939 | packets predate these conventions, and have arguments without any terminator |
| 32940 | for the packet name; we suspect they are in widespread use in places that |
| 32941 | are difficult to upgrade. The @samp{qC} packet has no arguments, but some |
| 32942 | existing stubs (e.g.@: RedBoot) are known to not check for the end of the |
| 32943 | packet.}. |
| 32944 | |
| 32945 | Like the descriptions of the other packets, each description here |
| 32946 | has a template showing the packet's overall syntax, followed by an |
| 32947 | explanation of the packet's meaning. We include spaces in some of the |
| 32948 | templates for clarity; these are not part of the packet's syntax. No |
| 32949 | @value{GDBN} packet uses spaces to separate its components. |
| 32950 | |
| 32951 | Here are the currently defined query and set packets: |
| 32952 | |
| 32953 | @table @samp |
| 32954 | |
| 32955 | @item QAllow:@var{op}:@var{val}@dots{} |
| 32956 | @cindex @samp{QAllow} packet |
| 32957 | Specify which operations @value{GDBN} expects to request of the |
| 32958 | target, as a semicolon-separated list of operation name and value |
| 32959 | pairs. Possible values for @var{op} include @samp{WriteReg}, |
| 32960 | @samp{WriteMem}, @samp{InsertBreak}, @samp{InsertTrace}, |
| 32961 | @samp{InsertFastTrace}, and @samp{Stop}. @var{val} is either 0, |
| 32962 | indicating that @value{GDBN} will not request the operation, or 1, |
| 32963 | indicating that it may. (The target can then use this to set up its |
| 32964 | own internals optimally, for instance if the debugger never expects to |
| 32965 | insert breakpoints, it may not need to install its own trap handler.) |
| 32966 | |
| 32967 | @item qC |
| 32968 | @cindex current thread, remote request |
| 32969 | @cindex @samp{qC} packet |
| 32970 | Return the current thread ID. |
| 32971 | |
| 32972 | Reply: |
| 32973 | @table @samp |
| 32974 | @item QC @var{thread-id} |
| 32975 | Where @var{thread-id} is a thread ID as documented in |
| 32976 | @ref{thread-id syntax}. |
| 32977 | @item @r{(anything else)} |
| 32978 | Any other reply implies the old thread ID. |
| 32979 | @end table |
| 32980 | |
| 32981 | @item qCRC:@var{addr},@var{length} |
| 32982 | @cindex CRC of memory block, remote request |
| 32983 | @cindex @samp{qCRC} packet |
| 32984 | Compute the CRC checksum of a block of memory using CRC-32 defined in |
| 32985 | IEEE 802.3. The CRC is computed byte at a time, taking the most |
| 32986 | significant bit of each byte first. The initial pattern code |
| 32987 | @code{0xffffffff} is used to ensure leading zeros affect the CRC. |
| 32988 | |
| 32989 | @emph{Note:} This is the same CRC used in validating separate debug |
| 32990 | files (@pxref{Separate Debug Files, , Debugging Information in Separate |
| 32991 | Files}). However the algorithm is slightly different. When validating |
| 32992 | separate debug files, the CRC is computed taking the @emph{least} |
| 32993 | significant bit of each byte first, and the final result is inverted to |
| 32994 | detect trailing zeros. |
| 32995 | |
| 32996 | Reply: |
| 32997 | @table @samp |
| 32998 | @item E @var{NN} |
| 32999 | An error (such as memory fault) |
| 33000 | @item C @var{crc32} |
| 33001 | The specified memory region's checksum is @var{crc32}. |
| 33002 | @end table |
| 33003 | |
| 33004 | @item qfThreadInfo |
| 33005 | @itemx qsThreadInfo |
| 33006 | @cindex list active threads, remote request |
| 33007 | @cindex @samp{qfThreadInfo} packet |
| 33008 | @cindex @samp{qsThreadInfo} packet |
| 33009 | Obtain a list of all active thread IDs from the target (OS). Since there |
| 33010 | may be too many active threads to fit into one reply packet, this query |
| 33011 | works iteratively: it may require more than one query/reply sequence to |
| 33012 | obtain the entire list of threads. The first query of the sequence will |
| 33013 | be the @samp{qfThreadInfo} query; subsequent queries in the |
| 33014 | sequence will be the @samp{qsThreadInfo} query. |
| 33015 | |
| 33016 | NOTE: This packet replaces the @samp{qL} query (see below). |
| 33017 | |
| 33018 | Reply: |
| 33019 | @table @samp |
| 33020 | @item m @var{thread-id} |
| 33021 | A single thread ID |
| 33022 | @item m @var{thread-id},@var{thread-id}@dots{} |
| 33023 | a comma-separated list of thread IDs |
| 33024 | @item l |
| 33025 | (lower case letter @samp{L}) denotes end of list. |
| 33026 | @end table |
| 33027 | |
| 33028 | In response to each query, the target will reply with a list of one or |
| 33029 | more thread IDs, separated by commas. |
| 33030 | @value{GDBN} will respond to each reply with a request for more thread |
| 33031 | ids (using the @samp{qs} form of the query), until the target responds |
| 33032 | with @samp{l} (lower-case ell, for @dfn{last}). |
| 33033 | Refer to @ref{thread-id syntax}, for the format of the @var{thread-id} |
| 33034 | fields. |
| 33035 | |
| 33036 | @item qGetTLSAddr:@var{thread-id},@var{offset},@var{lm} |
| 33037 | @cindex get thread-local storage address, remote request |
| 33038 | @cindex @samp{qGetTLSAddr} packet |
| 33039 | Fetch the address associated with thread local storage specified |
| 33040 | by @var{thread-id}, @var{offset}, and @var{lm}. |
| 33041 | |
| 33042 | @var{thread-id} is the thread ID associated with the |
| 33043 | thread for which to fetch the TLS address. @xref{thread-id syntax}. |
| 33044 | |
| 33045 | @var{offset} is the (big endian, hex encoded) offset associated with the |
| 33046 | thread local variable. (This offset is obtained from the debug |
| 33047 | information associated with the variable.) |
| 33048 | |
| 33049 | @var{lm} is the (big endian, hex encoded) OS/ABI-specific encoding of the |
| 33050 | the load module associated with the thread local storage. For example, |
| 33051 | a @sc{gnu}/Linux system will pass the link map address of the shared |
| 33052 | object associated with the thread local storage under consideration. |
| 33053 | Other operating environments may choose to represent the load module |
| 33054 | differently, so the precise meaning of this parameter will vary. |
| 33055 | |
| 33056 | Reply: |
| 33057 | @table @samp |
| 33058 | @item @var{XX}@dots{} |
| 33059 | Hex encoded (big endian) bytes representing the address of the thread |
| 33060 | local storage requested. |
| 33061 | |
| 33062 | @item E @var{nn} |
| 33063 | An error occurred. @var{nn} are hex digits. |
| 33064 | |
| 33065 | @item |
| 33066 | An empty reply indicates that @samp{qGetTLSAddr} is not supported by the stub. |
| 33067 | @end table |
| 33068 | |
| 33069 | @item qGetTIBAddr:@var{thread-id} |
| 33070 | @cindex get thread information block address |
| 33071 | @cindex @samp{qGetTIBAddr} packet |
| 33072 | Fetch address of the Windows OS specific Thread Information Block. |
| 33073 | |
| 33074 | @var{thread-id} is the thread ID associated with the thread. |
| 33075 | |
| 33076 | Reply: |
| 33077 | @table @samp |
| 33078 | @item @var{XX}@dots{} |
| 33079 | Hex encoded (big endian) bytes representing the linear address of the |
| 33080 | thread information block. |
| 33081 | |
| 33082 | @item E @var{nn} |
| 33083 | An error occured. This means that either the thread was not found, or the |
| 33084 | address could not be retrieved. |
| 33085 | |
| 33086 | @item |
| 33087 | An empty reply indicates that @samp{qGetTIBAddr} is not supported by the stub. |
| 33088 | @end table |
| 33089 | |
| 33090 | @item qL @var{startflag} @var{threadcount} @var{nextthread} |
| 33091 | Obtain thread information from RTOS. Where: @var{startflag} (one hex |
| 33092 | digit) is one to indicate the first query and zero to indicate a |
| 33093 | subsequent query; @var{threadcount} (two hex digits) is the maximum |
| 33094 | number of threads the response packet can contain; and @var{nextthread} |
| 33095 | (eight hex digits), for subsequent queries (@var{startflag} is zero), is |
| 33096 | returned in the response as @var{argthread}. |
| 33097 | |
| 33098 | Don't use this packet; use the @samp{qfThreadInfo} query instead (see above). |
| 33099 | |
| 33100 | Reply: |
| 33101 | @table @samp |
| 33102 | @item qM @var{count} @var{done} @var{argthread} @var{thread}@dots{} |
| 33103 | Where: @var{count} (two hex digits) is the number of threads being |
| 33104 | returned; @var{done} (one hex digit) is zero to indicate more threads |
| 33105 | and one indicates no further threads; @var{argthreadid} (eight hex |
| 33106 | digits) is @var{nextthread} from the request packet; @var{thread}@dots{} |
| 33107 | is a sequence of thread IDs from the target. @var{threadid} (eight hex |
| 33108 | digits). See @code{remote.c:parse_threadlist_response()}. |
| 33109 | @end table |
| 33110 | |
| 33111 | @item qOffsets |
| 33112 | @cindex section offsets, remote request |
| 33113 | @cindex @samp{qOffsets} packet |
| 33114 | Get section offsets that the target used when relocating the downloaded |
| 33115 | image. |
| 33116 | |
| 33117 | Reply: |
| 33118 | @table @samp |
| 33119 | @item Text=@var{xxx};Data=@var{yyy}@r{[};Bss=@var{zzz}@r{]} |
| 33120 | Relocate the @code{Text} section by @var{xxx} from its original address. |
| 33121 | Relocate the @code{Data} section by @var{yyy} from its original address. |
| 33122 | If the object file format provides segment information (e.g.@: @sc{elf} |
| 33123 | @samp{PT_LOAD} program headers), @value{GDBN} will relocate entire |
| 33124 | segments by the supplied offsets. |
| 33125 | |
| 33126 | @emph{Note: while a @code{Bss} offset may be included in the response, |
| 33127 | @value{GDBN} ignores this and instead applies the @code{Data} offset |
| 33128 | to the @code{Bss} section.} |
| 33129 | |
| 33130 | @item TextSeg=@var{xxx}@r{[};DataSeg=@var{yyy}@r{]} |
| 33131 | Relocate the first segment of the object file, which conventionally |
| 33132 | contains program code, to a starting address of @var{xxx}. If |
| 33133 | @samp{DataSeg} is specified, relocate the second segment, which |
| 33134 | conventionally contains modifiable data, to a starting address of |
| 33135 | @var{yyy}. @value{GDBN} will report an error if the object file |
| 33136 | does not contain segment information, or does not contain at least |
| 33137 | as many segments as mentioned in the reply. Extra segments are |
| 33138 | kept at fixed offsets relative to the last relocated segment. |
| 33139 | @end table |
| 33140 | |
| 33141 | @item qP @var{mode} @var{thread-id} |
| 33142 | @cindex thread information, remote request |
| 33143 | @cindex @samp{qP} packet |
| 33144 | Returns information on @var{thread-id}. Where: @var{mode} is a hex |
| 33145 | encoded 32 bit mode; @var{thread-id} is a thread ID |
| 33146 | (@pxref{thread-id syntax}). |
| 33147 | |
| 33148 | Don't use this packet; use the @samp{qThreadExtraInfo} query instead |
| 33149 | (see below). |
| 33150 | |
| 33151 | Reply: see @code{remote.c:remote_unpack_thread_info_response()}. |
| 33152 | |
| 33153 | @item QNonStop:1 |
| 33154 | @item QNonStop:0 |
| 33155 | @cindex non-stop mode, remote request |
| 33156 | @cindex @samp{QNonStop} packet |
| 33157 | @anchor{QNonStop} |
| 33158 | Enter non-stop (@samp{QNonStop:1}) or all-stop (@samp{QNonStop:0}) mode. |
| 33159 | @xref{Remote Non-Stop}, for more information. |
| 33160 | |
| 33161 | Reply: |
| 33162 | @table @samp |
| 33163 | @item OK |
| 33164 | The request succeeded. |
| 33165 | |
| 33166 | @item E @var{nn} |
| 33167 | An error occurred. @var{nn} are hex digits. |
| 33168 | |
| 33169 | @item |
| 33170 | An empty reply indicates that @samp{QNonStop} is not supported by |
| 33171 | the stub. |
| 33172 | @end table |
| 33173 | |
| 33174 | This packet is not probed by default; the remote stub must request it, |
| 33175 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33176 | Use of this packet is controlled by the @code{set non-stop} command; |
| 33177 | @pxref{Non-Stop Mode}. |
| 33178 | |
| 33179 | @item QPassSignals: @var{signal} @r{[};@var{signal}@r{]}@dots{} |
| 33180 | @cindex pass signals to inferior, remote request |
| 33181 | @cindex @samp{QPassSignals} packet |
| 33182 | @anchor{QPassSignals} |
| 33183 | Each listed @var{signal} should be passed directly to the inferior process. |
| 33184 | Signals are numbered identically to continue packets and stop replies |
| 33185 | (@pxref{Stop Reply Packets}). Each @var{signal} list item should be |
| 33186 | strictly greater than the previous item. These signals do not need to stop |
| 33187 | the inferior, or be reported to @value{GDBN}. All other signals should be |
| 33188 | reported to @value{GDBN}. Multiple @samp{QPassSignals} packets do not |
| 33189 | combine; any earlier @samp{QPassSignals} list is completely replaced by the |
| 33190 | new list. This packet improves performance when using @samp{handle |
| 33191 | @var{signal} nostop noprint pass}. |
| 33192 | |
| 33193 | Reply: |
| 33194 | @table @samp |
| 33195 | @item OK |
| 33196 | The request succeeded. |
| 33197 | |
| 33198 | @item E @var{nn} |
| 33199 | An error occurred. @var{nn} are hex digits. |
| 33200 | |
| 33201 | @item |
| 33202 | An empty reply indicates that @samp{QPassSignals} is not supported by |
| 33203 | the stub. |
| 33204 | @end table |
| 33205 | |
| 33206 | Use of this packet is controlled by the @code{set remote pass-signals} |
| 33207 | command (@pxref{Remote Configuration, set remote pass-signals}). |
| 33208 | This packet is not probed by default; the remote stub must request it, |
| 33209 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33210 | |
| 33211 | @item qRcmd,@var{command} |
| 33212 | @cindex execute remote command, remote request |
| 33213 | @cindex @samp{qRcmd} packet |
| 33214 | @var{command} (hex encoded) is passed to the local interpreter for |
| 33215 | execution. Invalid commands should be reported using the output |
| 33216 | string. Before the final result packet, the target may also respond |
| 33217 | with a number of intermediate @samp{O@var{output}} console output |
| 33218 | packets. @emph{Implementors should note that providing access to a |
| 33219 | stubs's interpreter may have security implications}. |
| 33220 | |
| 33221 | Reply: |
| 33222 | @table @samp |
| 33223 | @item OK |
| 33224 | A command response with no output. |
| 33225 | @item @var{OUTPUT} |
| 33226 | A command response with the hex encoded output string @var{OUTPUT}. |
| 33227 | @item E @var{NN} |
| 33228 | Indicate a badly formed request. |
| 33229 | @item |
| 33230 | An empty reply indicates that @samp{qRcmd} is not recognized. |
| 33231 | @end table |
| 33232 | |
| 33233 | (Note that the @code{qRcmd} packet's name is separated from the |
| 33234 | command by a @samp{,}, not a @samp{:}, contrary to the naming |
| 33235 | conventions above. Please don't use this packet as a model for new |
| 33236 | packets.) |
| 33237 | |
| 33238 | @item qSearch:memory:@var{address};@var{length};@var{search-pattern} |
| 33239 | @cindex searching memory, in remote debugging |
| 33240 | @cindex @samp{qSearch:memory} packet |
| 33241 | @anchor{qSearch memory} |
| 33242 | Search @var{length} bytes at @var{address} for @var{search-pattern}. |
| 33243 | @var{address} and @var{length} are encoded in hex. |
| 33244 | @var{search-pattern} is a sequence of bytes, hex encoded. |
| 33245 | |
| 33246 | Reply: |
| 33247 | @table @samp |
| 33248 | @item 0 |
| 33249 | The pattern was not found. |
| 33250 | @item 1,address |
| 33251 | The pattern was found at @var{address}. |
| 33252 | @item E @var{NN} |
| 33253 | A badly formed request or an error was encountered while searching memory. |
| 33254 | @item |
| 33255 | An empty reply indicates that @samp{qSearch:memory} is not recognized. |
| 33256 | @end table |
| 33257 | |
| 33258 | @item QStartNoAckMode |
| 33259 | @cindex @samp{QStartNoAckMode} packet |
| 33260 | @anchor{QStartNoAckMode} |
| 33261 | Request that the remote stub disable the normal @samp{+}/@samp{-} |
| 33262 | protocol acknowledgments (@pxref{Packet Acknowledgment}). |
| 33263 | |
| 33264 | Reply: |
| 33265 | @table @samp |
| 33266 | @item OK |
| 33267 | The stub has switched to no-acknowledgment mode. |
| 33268 | @value{GDBN} acknowledges this reponse, |
| 33269 | but neither the stub nor @value{GDBN} shall send or expect further |
| 33270 | @samp{+}/@samp{-} acknowledgments in the current connection. |
| 33271 | @item |
| 33272 | An empty reply indicates that the stub does not support no-acknowledgment mode. |
| 33273 | @end table |
| 33274 | |
| 33275 | @item qSupported @r{[}:@var{gdbfeature} @r{[};@var{gdbfeature}@r{]}@dots{} @r{]} |
| 33276 | @cindex supported packets, remote query |
| 33277 | @cindex features of the remote protocol |
| 33278 | @cindex @samp{qSupported} packet |
| 33279 | @anchor{qSupported} |
| 33280 | Tell the remote stub about features supported by @value{GDBN}, and |
| 33281 | query the stub for features it supports. This packet allows |
| 33282 | @value{GDBN} and the remote stub to take advantage of each others' |
| 33283 | features. @samp{qSupported} also consolidates multiple feature probes |
| 33284 | at startup, to improve @value{GDBN} performance---a single larger |
| 33285 | packet performs better than multiple smaller probe packets on |
| 33286 | high-latency links. Some features may enable behavior which must not |
| 33287 | be on by default, e.g.@: because it would confuse older clients or |
| 33288 | stubs. Other features may describe packets which could be |
| 33289 | automatically probed for, but are not. These features must be |
| 33290 | reported before @value{GDBN} will use them. This ``default |
| 33291 | unsupported'' behavior is not appropriate for all packets, but it |
| 33292 | helps to keep the initial connection time under control with new |
| 33293 | versions of @value{GDBN} which support increasing numbers of packets. |
| 33294 | |
| 33295 | Reply: |
| 33296 | @table @samp |
| 33297 | @item @var{stubfeature} @r{[};@var{stubfeature}@r{]}@dots{} |
| 33298 | The stub supports or does not support each returned @var{stubfeature}, |
| 33299 | depending on the form of each @var{stubfeature} (see below for the |
| 33300 | possible forms). |
| 33301 | @item |
| 33302 | An empty reply indicates that @samp{qSupported} is not recognized, |
| 33303 | or that no features needed to be reported to @value{GDBN}. |
| 33304 | @end table |
| 33305 | |
| 33306 | The allowed forms for each feature (either a @var{gdbfeature} in the |
| 33307 | @samp{qSupported} packet, or a @var{stubfeature} in the response) |
| 33308 | are: |
| 33309 | |
| 33310 | @table @samp |
| 33311 | @item @var{name}=@var{value} |
| 33312 | The remote protocol feature @var{name} is supported, and associated |
| 33313 | with the specified @var{value}. The format of @var{value} depends |
| 33314 | on the feature, but it must not include a semicolon. |
| 33315 | @item @var{name}+ |
| 33316 | The remote protocol feature @var{name} is supported, and does not |
| 33317 | need an associated value. |
| 33318 | @item @var{name}- |
| 33319 | The remote protocol feature @var{name} is not supported. |
| 33320 | @item @var{name}? |
| 33321 | The remote protocol feature @var{name} may be supported, and |
| 33322 | @value{GDBN} should auto-detect support in some other way when it is |
| 33323 | needed. This form will not be used for @var{gdbfeature} notifications, |
| 33324 | but may be used for @var{stubfeature} responses. |
| 33325 | @end table |
| 33326 | |
| 33327 | Whenever the stub receives a @samp{qSupported} request, the |
| 33328 | supplied set of @value{GDBN} features should override any previous |
| 33329 | request. This allows @value{GDBN} to put the stub in a known |
| 33330 | state, even if the stub had previously been communicating with |
| 33331 | a different version of @value{GDBN}. |
| 33332 | |
| 33333 | The following values of @var{gdbfeature} (for the packet sent by @value{GDBN}) |
| 33334 | are defined: |
| 33335 | |
| 33336 | @table @samp |
| 33337 | @item multiprocess |
| 33338 | This feature indicates whether @value{GDBN} supports multiprocess |
| 33339 | extensions to the remote protocol. @value{GDBN} does not use such |
| 33340 | extensions unless the stub also reports that it supports them by |
| 33341 | including @samp{multiprocess+} in its @samp{qSupported} reply. |
| 33342 | @xref{multiprocess extensions}, for details. |
| 33343 | |
| 33344 | @item xmlRegisters |
| 33345 | This feature indicates that @value{GDBN} supports the XML target |
| 33346 | description. If the stub sees @samp{xmlRegisters=} with target |
| 33347 | specific strings separated by a comma, it will report register |
| 33348 | description. |
| 33349 | |
| 33350 | @item qRelocInsn |
| 33351 | This feature indicates whether @value{GDBN} supports the |
| 33352 | @samp{qRelocInsn} packet (@pxref{Tracepoint Packets,,Relocate |
| 33353 | instruction reply packet}). |
| 33354 | @end table |
| 33355 | |
| 33356 | Stubs should ignore any unknown values for |
| 33357 | @var{gdbfeature}. Any @value{GDBN} which sends a @samp{qSupported} |
| 33358 | packet supports receiving packets of unlimited length (earlier |
| 33359 | versions of @value{GDBN} may reject overly long responses). Additional values |
| 33360 | for @var{gdbfeature} may be defined in the future to let the stub take |
| 33361 | advantage of new features in @value{GDBN}, e.g.@: incompatible |
| 33362 | improvements in the remote protocol---the @samp{multiprocess} feature is |
| 33363 | an example of such a feature. The stub's reply should be independent |
| 33364 | of the @var{gdbfeature} entries sent by @value{GDBN}; first @value{GDBN} |
| 33365 | describes all the features it supports, and then the stub replies with |
| 33366 | all the features it supports. |
| 33367 | |
| 33368 | Similarly, @value{GDBN} will silently ignore unrecognized stub feature |
| 33369 | responses, as long as each response uses one of the standard forms. |
| 33370 | |
| 33371 | Some features are flags. A stub which supports a flag feature |
| 33372 | should respond with a @samp{+} form response. Other features |
| 33373 | require values, and the stub should respond with an @samp{=} |
| 33374 | form response. |
| 33375 | |
| 33376 | Each feature has a default value, which @value{GDBN} will use if |
| 33377 | @samp{qSupported} is not available or if the feature is not mentioned |
| 33378 | in the @samp{qSupported} response. The default values are fixed; a |
| 33379 | stub is free to omit any feature responses that match the defaults. |
| 33380 | |
| 33381 | Not all features can be probed, but for those which can, the probing |
| 33382 | mechanism is useful: in some cases, a stub's internal |
| 33383 | architecture may not allow the protocol layer to know some information |
| 33384 | about the underlying target in advance. This is especially common in |
| 33385 | stubs which may be configured for multiple targets. |
| 33386 | |
| 33387 | These are the currently defined stub features and their properties: |
| 33388 | |
| 33389 | @multitable @columnfractions 0.35 0.2 0.12 0.2 |
| 33390 | @c NOTE: The first row should be @headitem, but we do not yet require |
| 33391 | @c a new enough version of Texinfo (4.7) to use @headitem. |
| 33392 | @item Feature Name |
| 33393 | @tab Value Required |
| 33394 | @tab Default |
| 33395 | @tab Probe Allowed |
| 33396 | |
| 33397 | @item @samp{PacketSize} |
| 33398 | @tab Yes |
| 33399 | @tab @samp{-} |
| 33400 | @tab No |
| 33401 | |
| 33402 | @item @samp{qXfer:auxv:read} |
| 33403 | @tab No |
| 33404 | @tab @samp{-} |
| 33405 | @tab Yes |
| 33406 | |
| 33407 | @item @samp{qXfer:features:read} |
| 33408 | @tab No |
| 33409 | @tab @samp{-} |
| 33410 | @tab Yes |
| 33411 | |
| 33412 | @item @samp{qXfer:libraries:read} |
| 33413 | @tab No |
| 33414 | @tab @samp{-} |
| 33415 | @tab Yes |
| 33416 | |
| 33417 | @item @samp{qXfer:memory-map:read} |
| 33418 | @tab No |
| 33419 | @tab @samp{-} |
| 33420 | @tab Yes |
| 33421 | |
| 33422 | @item @samp{qXfer:sdata:read} |
| 33423 | @tab No |
| 33424 | @tab @samp{-} |
| 33425 | @tab Yes |
| 33426 | |
| 33427 | @item @samp{qXfer:spu:read} |
| 33428 | @tab No |
| 33429 | @tab @samp{-} |
| 33430 | @tab Yes |
| 33431 | |
| 33432 | @item @samp{qXfer:spu:write} |
| 33433 | @tab No |
| 33434 | @tab @samp{-} |
| 33435 | @tab Yes |
| 33436 | |
| 33437 | @item @samp{qXfer:siginfo:read} |
| 33438 | @tab No |
| 33439 | @tab @samp{-} |
| 33440 | @tab Yes |
| 33441 | |
| 33442 | @item @samp{qXfer:siginfo:write} |
| 33443 | @tab No |
| 33444 | @tab @samp{-} |
| 33445 | @tab Yes |
| 33446 | |
| 33447 | @item @samp{qXfer:threads:read} |
| 33448 | @tab No |
| 33449 | @tab @samp{-} |
| 33450 | @tab Yes |
| 33451 | |
| 33452 | @item @samp{qXfer:traceframe-info:read} |
| 33453 | @tab No |
| 33454 | @tab @samp{-} |
| 33455 | @tab Yes |
| 33456 | |
| 33457 | |
| 33458 | @item @samp{QNonStop} |
| 33459 | @tab No |
| 33460 | @tab @samp{-} |
| 33461 | @tab Yes |
| 33462 | |
| 33463 | @item @samp{QPassSignals} |
| 33464 | @tab No |
| 33465 | @tab @samp{-} |
| 33466 | @tab Yes |
| 33467 | |
| 33468 | @item @samp{QStartNoAckMode} |
| 33469 | @tab No |
| 33470 | @tab @samp{-} |
| 33471 | @tab Yes |
| 33472 | |
| 33473 | @item @samp{multiprocess} |
| 33474 | @tab No |
| 33475 | @tab @samp{-} |
| 33476 | @tab No |
| 33477 | |
| 33478 | @item @samp{ConditionalTracepoints} |
| 33479 | @tab No |
| 33480 | @tab @samp{-} |
| 33481 | @tab No |
| 33482 | |
| 33483 | @item @samp{ReverseContinue} |
| 33484 | @tab No |
| 33485 | @tab @samp{-} |
| 33486 | @tab No |
| 33487 | |
| 33488 | @item @samp{ReverseStep} |
| 33489 | @tab No |
| 33490 | @tab @samp{-} |
| 33491 | @tab No |
| 33492 | |
| 33493 | @item @samp{TracepointSource} |
| 33494 | @tab No |
| 33495 | @tab @samp{-} |
| 33496 | @tab No |
| 33497 | |
| 33498 | @item @samp{QAllow} |
| 33499 | @tab No |
| 33500 | @tab @samp{-} |
| 33501 | @tab No |
| 33502 | |
| 33503 | @end multitable |
| 33504 | |
| 33505 | These are the currently defined stub features, in more detail: |
| 33506 | |
| 33507 | @table @samp |
| 33508 | @cindex packet size, remote protocol |
| 33509 | @item PacketSize=@var{bytes} |
| 33510 | The remote stub can accept packets up to at least @var{bytes} in |
| 33511 | length. @value{GDBN} will send packets up to this size for bulk |
| 33512 | transfers, and will never send larger packets. This is a limit on the |
| 33513 | data characters in the packet, including the frame and checksum. |
| 33514 | There is no trailing NUL byte in a remote protocol packet; if the stub |
| 33515 | stores packets in a NUL-terminated format, it should allow an extra |
| 33516 | byte in its buffer for the NUL. If this stub feature is not supported, |
| 33517 | @value{GDBN} guesses based on the size of the @samp{g} packet response. |
| 33518 | |
| 33519 | @item qXfer:auxv:read |
| 33520 | The remote stub understands the @samp{qXfer:auxv:read} packet |
| 33521 | (@pxref{qXfer auxiliary vector read}). |
| 33522 | |
| 33523 | @item qXfer:features:read |
| 33524 | The remote stub understands the @samp{qXfer:features:read} packet |
| 33525 | (@pxref{qXfer target description read}). |
| 33526 | |
| 33527 | @item qXfer:libraries:read |
| 33528 | The remote stub understands the @samp{qXfer:libraries:read} packet |
| 33529 | (@pxref{qXfer library list read}). |
| 33530 | |
| 33531 | @item qXfer:memory-map:read |
| 33532 | The remote stub understands the @samp{qXfer:memory-map:read} packet |
| 33533 | (@pxref{qXfer memory map read}). |
| 33534 | |
| 33535 | @item qXfer:sdata:read |
| 33536 | The remote stub understands the @samp{qXfer:sdata:read} packet |
| 33537 | (@pxref{qXfer sdata read}). |
| 33538 | |
| 33539 | @item qXfer:spu:read |
| 33540 | The remote stub understands the @samp{qXfer:spu:read} packet |
| 33541 | (@pxref{qXfer spu read}). |
| 33542 | |
| 33543 | @item qXfer:spu:write |
| 33544 | The remote stub understands the @samp{qXfer:spu:write} packet |
| 33545 | (@pxref{qXfer spu write}). |
| 33546 | |
| 33547 | @item qXfer:siginfo:read |
| 33548 | The remote stub understands the @samp{qXfer:siginfo:read} packet |
| 33549 | (@pxref{qXfer siginfo read}). |
| 33550 | |
| 33551 | @item qXfer:siginfo:write |
| 33552 | The remote stub understands the @samp{qXfer:siginfo:write} packet |
| 33553 | (@pxref{qXfer siginfo write}). |
| 33554 | |
| 33555 | @item qXfer:threads:read |
| 33556 | The remote stub understands the @samp{qXfer:threads:read} packet |
| 33557 | (@pxref{qXfer threads read}). |
| 33558 | |
| 33559 | @item qXfer:traceframe-info:read |
| 33560 | The remote stub understands the @samp{qXfer:traceframe-info:read} |
| 33561 | packet (@pxref{qXfer traceframe info read}). |
| 33562 | |
| 33563 | @item QNonStop |
| 33564 | The remote stub understands the @samp{QNonStop} packet |
| 33565 | (@pxref{QNonStop}). |
| 33566 | |
| 33567 | @item QPassSignals |
| 33568 | The remote stub understands the @samp{QPassSignals} packet |
| 33569 | (@pxref{QPassSignals}). |
| 33570 | |
| 33571 | @item QStartNoAckMode |
| 33572 | The remote stub understands the @samp{QStartNoAckMode} packet and |
| 33573 | prefers to operate in no-acknowledgment mode. @xref{Packet Acknowledgment}. |
| 33574 | |
| 33575 | @item multiprocess |
| 33576 | @anchor{multiprocess extensions} |
| 33577 | @cindex multiprocess extensions, in remote protocol |
| 33578 | The remote stub understands the multiprocess extensions to the remote |
| 33579 | protocol syntax. The multiprocess extensions affect the syntax of |
| 33580 | thread IDs in both packets and replies (@pxref{thread-id syntax}), and |
| 33581 | add process IDs to the @samp{D} packet and @samp{W} and @samp{X} |
| 33582 | replies. Note that reporting this feature indicates support for the |
| 33583 | syntactic extensions only, not that the stub necessarily supports |
| 33584 | debugging of more than one process at a time. The stub must not use |
| 33585 | multiprocess extensions in packet replies unless @value{GDBN} has also |
| 33586 | indicated it supports them in its @samp{qSupported} request. |
| 33587 | |
| 33588 | @item qXfer:osdata:read |
| 33589 | The remote stub understands the @samp{qXfer:osdata:read} packet |
| 33590 | ((@pxref{qXfer osdata read}). |
| 33591 | |
| 33592 | @item ConditionalTracepoints |
| 33593 | The remote stub accepts and implements conditional expressions defined |
| 33594 | for tracepoints (@pxref{Tracepoint Conditions}). |
| 33595 | |
| 33596 | @item ReverseContinue |
| 33597 | The remote stub accepts and implements the reverse continue packet |
| 33598 | (@pxref{bc}). |
| 33599 | |
| 33600 | @item ReverseStep |
| 33601 | The remote stub accepts and implements the reverse step packet |
| 33602 | (@pxref{bs}). |
| 33603 | |
| 33604 | @item TracepointSource |
| 33605 | The remote stub understands the @samp{QTDPsrc} packet that supplies |
| 33606 | the source form of tracepoint definitions. |
| 33607 | |
| 33608 | @item QAllow |
| 33609 | The remote stub understands the @samp{QAllow} packet. |
| 33610 | |
| 33611 | @item StaticTracepoint |
| 33612 | @cindex static tracepoints, in remote protocol |
| 33613 | The remote stub supports static tracepoints. |
| 33614 | |
| 33615 | @end table |
| 33616 | |
| 33617 | @item qSymbol:: |
| 33618 | @cindex symbol lookup, remote request |
| 33619 | @cindex @samp{qSymbol} packet |
| 33620 | Notify the target that @value{GDBN} is prepared to serve symbol lookup |
| 33621 | requests. Accept requests from the target for the values of symbols. |
| 33622 | |
| 33623 | Reply: |
| 33624 | @table @samp |
| 33625 | @item OK |
| 33626 | The target does not need to look up any (more) symbols. |
| 33627 | @item qSymbol:@var{sym_name} |
| 33628 | The target requests the value of symbol @var{sym_name} (hex encoded). |
| 33629 | @value{GDBN} may provide the value by using the |
| 33630 | @samp{qSymbol:@var{sym_value}:@var{sym_name}} message, described |
| 33631 | below. |
| 33632 | @end table |
| 33633 | |
| 33634 | @item qSymbol:@var{sym_value}:@var{sym_name} |
| 33635 | Set the value of @var{sym_name} to @var{sym_value}. |
| 33636 | |
| 33637 | @var{sym_name} (hex encoded) is the name of a symbol whose value the |
| 33638 | target has previously requested. |
| 33639 | |
| 33640 | @var{sym_value} (hex) is the value for symbol @var{sym_name}. If |
| 33641 | @value{GDBN} cannot supply a value for @var{sym_name}, then this field |
| 33642 | will be empty. |
| 33643 | |
| 33644 | Reply: |
| 33645 | @table @samp |
| 33646 | @item OK |
| 33647 | The target does not need to look up any (more) symbols. |
| 33648 | @item qSymbol:@var{sym_name} |
| 33649 | The target requests the value of a new symbol @var{sym_name} (hex |
| 33650 | encoded). @value{GDBN} will continue to supply the values of symbols |
| 33651 | (if available), until the target ceases to request them. |
| 33652 | @end table |
| 33653 | |
| 33654 | @item qTBuffer |
| 33655 | @item QTBuffer |
| 33656 | @item QTDisconnected |
| 33657 | @itemx QTDP |
| 33658 | @itemx QTDPsrc |
| 33659 | @itemx QTDV |
| 33660 | @itemx qTfP |
| 33661 | @itemx qTfV |
| 33662 | @itemx QTFrame |
| 33663 | @xref{Tracepoint Packets}. |
| 33664 | |
| 33665 | @item qThreadExtraInfo,@var{thread-id} |
| 33666 | @cindex thread attributes info, remote request |
| 33667 | @cindex @samp{qThreadExtraInfo} packet |
| 33668 | Obtain a printable string description of a thread's attributes from |
| 33669 | the target OS. @var{thread-id} is a thread ID; |
| 33670 | see @ref{thread-id syntax}. This |
| 33671 | string may contain anything that the target OS thinks is interesting |
| 33672 | for @value{GDBN} to tell the user about the thread. The string is |
| 33673 | displayed in @value{GDBN}'s @code{info threads} display. Some |
| 33674 | examples of possible thread extra info strings are @samp{Runnable}, or |
| 33675 | @samp{Blocked on Mutex}. |
| 33676 | |
| 33677 | Reply: |
| 33678 | @table @samp |
| 33679 | @item @var{XX}@dots{} |
| 33680 | Where @samp{@var{XX}@dots{}} is a hex encoding of @sc{ascii} data, |
| 33681 | comprising the printable string containing the extra information about |
| 33682 | the thread's attributes. |
| 33683 | @end table |
| 33684 | |
| 33685 | (Note that the @code{qThreadExtraInfo} packet's name is separated from |
| 33686 | the command by a @samp{,}, not a @samp{:}, contrary to the naming |
| 33687 | conventions above. Please don't use this packet as a model for new |
| 33688 | packets.) |
| 33689 | |
| 33690 | @item QTSave |
| 33691 | @item qTsP |
| 33692 | @item qTsV |
| 33693 | @itemx QTStart |
| 33694 | @itemx QTStop |
| 33695 | @itemx QTinit |
| 33696 | @itemx QTro |
| 33697 | @itemx qTStatus |
| 33698 | @itemx qTV |
| 33699 | @itemx qTfSTM |
| 33700 | @itemx qTsSTM |
| 33701 | @itemx qTSTMat |
| 33702 | @xref{Tracepoint Packets}. |
| 33703 | |
| 33704 | @item qXfer:@var{object}:read:@var{annex}:@var{offset},@var{length} |
| 33705 | @cindex read special object, remote request |
| 33706 | @cindex @samp{qXfer} packet |
| 33707 | @anchor{qXfer read} |
| 33708 | Read uninterpreted bytes from the target's special data area |
| 33709 | identified by the keyword @var{object}. Request @var{length} bytes |
| 33710 | starting at @var{offset} bytes into the data. The content and |
| 33711 | encoding of @var{annex} is specific to @var{object}; it can supply |
| 33712 | additional details about what data to access. |
| 33713 | |
| 33714 | Here are the specific requests of this form defined so far. All |
| 33715 | @samp{qXfer:@var{object}:read:@dots{}} requests use the same reply |
| 33716 | formats, listed below. |
| 33717 | |
| 33718 | @table @samp |
| 33719 | @item qXfer:auxv:read::@var{offset},@var{length} |
| 33720 | @anchor{qXfer auxiliary vector read} |
| 33721 | Access the target's @dfn{auxiliary vector}. @xref{OS Information, |
| 33722 | auxiliary vector}. Note @var{annex} must be empty. |
| 33723 | |
| 33724 | This packet is not probed by default; the remote stub must request it, |
| 33725 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33726 | |
| 33727 | @item qXfer:features:read:@var{annex}:@var{offset},@var{length} |
| 33728 | @anchor{qXfer target description read} |
| 33729 | Access the @dfn{target description}. @xref{Target Descriptions}. The |
| 33730 | annex specifies which XML document to access. The main description is |
| 33731 | always loaded from the @samp{target.xml} annex. |
| 33732 | |
| 33733 | This packet is not probed by default; the remote stub must request it, |
| 33734 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33735 | |
| 33736 | @item qXfer:libraries:read:@var{annex}:@var{offset},@var{length} |
| 33737 | @anchor{qXfer library list read} |
| 33738 | Access the target's list of loaded libraries. @xref{Library List Format}. |
| 33739 | The annex part of the generic @samp{qXfer} packet must be empty |
| 33740 | (@pxref{qXfer read}). |
| 33741 | |
| 33742 | Targets which maintain a list of libraries in the program's memory do |
| 33743 | not need to implement this packet; it is designed for platforms where |
| 33744 | the operating system manages the list of loaded libraries. |
| 33745 | |
| 33746 | This packet is not probed by default; the remote stub must request it, |
| 33747 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33748 | |
| 33749 | @item qXfer:memory-map:read::@var{offset},@var{length} |
| 33750 | @anchor{qXfer memory map read} |
| 33751 | Access the target's @dfn{memory-map}. @xref{Memory Map Format}. The |
| 33752 | annex part of the generic @samp{qXfer} packet must be empty |
| 33753 | (@pxref{qXfer read}). |
| 33754 | |
| 33755 | This packet is not probed by default; the remote stub must request it, |
| 33756 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33757 | |
| 33758 | @item qXfer:sdata:read::@var{offset},@var{length} |
| 33759 | @anchor{qXfer sdata read} |
| 33760 | |
| 33761 | Read contents of the extra collected static tracepoint marker |
| 33762 | information. The annex part of the generic @samp{qXfer} packet must |
| 33763 | be empty (@pxref{qXfer read}). @xref{Tracepoint Actions,,Tracepoint |
| 33764 | Action Lists}. |
| 33765 | |
| 33766 | This packet is not probed by default; the remote stub must request it, |
| 33767 | by supplying an appropriate @samp{qSupported} response |
| 33768 | (@pxref{qSupported}). |
| 33769 | |
| 33770 | @item qXfer:siginfo:read::@var{offset},@var{length} |
| 33771 | @anchor{qXfer siginfo read} |
| 33772 | Read contents of the extra signal information on the target |
| 33773 | system. The annex part of the generic @samp{qXfer} packet must be |
| 33774 | empty (@pxref{qXfer read}). |
| 33775 | |
| 33776 | This packet is not probed by default; the remote stub must request it, |
| 33777 | by supplying an appropriate @samp{qSupported} response |
| 33778 | (@pxref{qSupported}). |
| 33779 | |
| 33780 | @item qXfer:spu:read:@var{annex}:@var{offset},@var{length} |
| 33781 | @anchor{qXfer spu read} |
| 33782 | Read contents of an @code{spufs} file on the target system. The |
| 33783 | annex specifies which file to read; it must be of the form |
| 33784 | @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID |
| 33785 | in the target process, and @var{name} identifes the @code{spufs} file |
| 33786 | in that context to be accessed. |
| 33787 | |
| 33788 | This packet is not probed by default; the remote stub must request it, |
| 33789 | by supplying an appropriate @samp{qSupported} response |
| 33790 | (@pxref{qSupported}). |
| 33791 | |
| 33792 | @item qXfer:threads:read::@var{offset},@var{length} |
| 33793 | @anchor{qXfer threads read} |
| 33794 | Access the list of threads on target. @xref{Thread List Format}. The |
| 33795 | annex part of the generic @samp{qXfer} packet must be empty |
| 33796 | (@pxref{qXfer read}). |
| 33797 | |
| 33798 | This packet is not probed by default; the remote stub must request it, |
| 33799 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33800 | |
| 33801 | @item qXfer:traceframe-info:read::@var{offset},@var{length} |
| 33802 | @anchor{qXfer traceframe info read} |
| 33803 | |
| 33804 | Return a description of the current traceframe's contents. |
| 33805 | @xref{Traceframe Info Format}. The annex part of the generic |
| 33806 | @samp{qXfer} packet must be empty (@pxref{qXfer read}). |
| 33807 | |
| 33808 | This packet is not probed by default; the remote stub must request it, |
| 33809 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33810 | |
| 33811 | @item qXfer:osdata:read::@var{offset},@var{length} |
| 33812 | @anchor{qXfer osdata read} |
| 33813 | Access the target's @dfn{operating system information}. |
| 33814 | @xref{Operating System Information}. |
| 33815 | |
| 33816 | @end table |
| 33817 | |
| 33818 | Reply: |
| 33819 | @table @samp |
| 33820 | @item m @var{data} |
| 33821 | Data @var{data} (@pxref{Binary Data}) has been read from the |
| 33822 | target. There may be more data at a higher address (although |
| 33823 | it is permitted to return @samp{m} even for the last valid |
| 33824 | block of data, as long as at least one byte of data was read). |
| 33825 | @var{data} may have fewer bytes than the @var{length} in the |
| 33826 | request. |
| 33827 | |
| 33828 | @item l @var{data} |
| 33829 | Data @var{data} (@pxref{Binary Data}) has been read from the target. |
| 33830 | There is no more data to be read. @var{data} may have fewer bytes |
| 33831 | than the @var{length} in the request. |
| 33832 | |
| 33833 | @item l |
| 33834 | The @var{offset} in the request is at the end of the data. |
| 33835 | There is no more data to be read. |
| 33836 | |
| 33837 | @item E00 |
| 33838 | The request was malformed, or @var{annex} was invalid. |
| 33839 | |
| 33840 | @item E @var{nn} |
| 33841 | The offset was invalid, or there was an error encountered reading the data. |
| 33842 | @var{nn} is a hex-encoded @code{errno} value. |
| 33843 | |
| 33844 | @item |
| 33845 | An empty reply indicates the @var{object} string was not recognized by |
| 33846 | the stub, or that the object does not support reading. |
| 33847 | @end table |
| 33848 | |
| 33849 | @item qXfer:@var{object}:write:@var{annex}:@var{offset}:@var{data}@dots{} |
| 33850 | @cindex write data into object, remote request |
| 33851 | @anchor{qXfer write} |
| 33852 | Write uninterpreted bytes into the target's special data area |
| 33853 | identified by the keyword @var{object}, starting at @var{offset} bytes |
| 33854 | into the data. @var{data}@dots{} is the binary-encoded data |
| 33855 | (@pxref{Binary Data}) to be written. The content and encoding of @var{annex} |
| 33856 | is specific to @var{object}; it can supply additional details about what data |
| 33857 | to access. |
| 33858 | |
| 33859 | Here are the specific requests of this form defined so far. All |
| 33860 | @samp{qXfer:@var{object}:write:@dots{}} requests use the same reply |
| 33861 | formats, listed below. |
| 33862 | |
| 33863 | @table @samp |
| 33864 | @item qXfer:siginfo:write::@var{offset}:@var{data}@dots{} |
| 33865 | @anchor{qXfer siginfo write} |
| 33866 | Write @var{data} to the extra signal information on the target system. |
| 33867 | The annex part of the generic @samp{qXfer} packet must be |
| 33868 | empty (@pxref{qXfer write}). |
| 33869 | |
| 33870 | This packet is not probed by default; the remote stub must request it, |
| 33871 | by supplying an appropriate @samp{qSupported} response |
| 33872 | (@pxref{qSupported}). |
| 33873 | |
| 33874 | @item qXfer:spu:write:@var{annex}:@var{offset}:@var{data}@dots{} |
| 33875 | @anchor{qXfer spu write} |
| 33876 | Write @var{data} to an @code{spufs} file on the target system. The |
| 33877 | annex specifies which file to write; it must be of the form |
| 33878 | @file{@var{id}/@var{name}}, where @var{id} specifies an SPU context ID |
| 33879 | in the target process, and @var{name} identifes the @code{spufs} file |
| 33880 | in that context to be accessed. |
| 33881 | |
| 33882 | This packet is not probed by default; the remote stub must request it, |
| 33883 | by supplying an appropriate @samp{qSupported} response (@pxref{qSupported}). |
| 33884 | @end table |
| 33885 | |
| 33886 | Reply: |
| 33887 | @table @samp |
| 33888 | @item @var{nn} |
| 33889 | @var{nn} (hex encoded) is the number of bytes written. |
| 33890 | This may be fewer bytes than supplied in the request. |
| 33891 | |
| 33892 | @item E00 |
| 33893 | The request was malformed, or @var{annex} was invalid. |
| 33894 | |
| 33895 | @item E @var{nn} |
| 33896 | The offset was invalid, or there was an error encountered writing the data. |
| 33897 | @var{nn} is a hex-encoded @code{errno} value. |
| 33898 | |
| 33899 | @item |
| 33900 | An empty reply indicates the @var{object} string was not |
| 33901 | recognized by the stub, or that the object does not support writing. |
| 33902 | @end table |
| 33903 | |
| 33904 | @item qXfer:@var{object}:@var{operation}:@dots{} |
| 33905 | Requests of this form may be added in the future. When a stub does |
| 33906 | not recognize the @var{object} keyword, or its support for |
| 33907 | @var{object} does not recognize the @var{operation} keyword, the stub |
| 33908 | must respond with an empty packet. |
| 33909 | |
| 33910 | @item qAttached:@var{pid} |
| 33911 | @cindex query attached, remote request |
| 33912 | @cindex @samp{qAttached} packet |
| 33913 | Return an indication of whether the remote server attached to an |
| 33914 | existing process or created a new process. When the multiprocess |
| 33915 | protocol extensions are supported (@pxref{multiprocess extensions}), |
| 33916 | @var{pid} is an integer in hexadecimal format identifying the target |
| 33917 | process. Otherwise, @value{GDBN} will omit the @var{pid} field and |
| 33918 | the query packet will be simplified as @samp{qAttached}. |
| 33919 | |
| 33920 | This query is used, for example, to know whether the remote process |
| 33921 | should be detached or killed when a @value{GDBN} session is ended with |
| 33922 | the @code{quit} command. |
| 33923 | |
| 33924 | Reply: |
| 33925 | @table @samp |
| 33926 | @item 1 |
| 33927 | The remote server attached to an existing process. |
| 33928 | @item 0 |
| 33929 | The remote server created a new process. |
| 33930 | @item E @var{NN} |
| 33931 | A badly formed request or an error was encountered. |
| 33932 | @end table |
| 33933 | |
| 33934 | @end table |
| 33935 | |
| 33936 | @node Architecture-Specific Protocol Details |
| 33937 | @section Architecture-Specific Protocol Details |
| 33938 | |
| 33939 | This section describes how the remote protocol is applied to specific |
| 33940 | target architectures. Also see @ref{Standard Target Features}, for |
| 33941 | details of XML target descriptions for each architecture. |
| 33942 | |
| 33943 | @subsection ARM |
| 33944 | |
| 33945 | @subsubsection Breakpoint Kinds |
| 33946 | |
| 33947 | These breakpoint kinds are defined for the @samp{Z0} and @samp{Z1} packets. |
| 33948 | |
| 33949 | @table @r |
| 33950 | |
| 33951 | @item 2 |
| 33952 | 16-bit Thumb mode breakpoint. |
| 33953 | |
| 33954 | @item 3 |
| 33955 | 32-bit Thumb mode (Thumb-2) breakpoint. |
| 33956 | |
| 33957 | @item 4 |
| 33958 | 32-bit ARM mode breakpoint. |
| 33959 | |
| 33960 | @end table |
| 33961 | |
| 33962 | @subsection MIPS |
| 33963 | |
| 33964 | @subsubsection Register Packet Format |
| 33965 | |
| 33966 | The following @code{g}/@code{G} packets have previously been defined. |
| 33967 | In the below, some thirty-two bit registers are transferred as |
| 33968 | sixty-four bits. Those registers should be zero/sign extended (which?) |
| 33969 | to fill the space allocated. Register bytes are transferred in target |
| 33970 | byte order. The two nibbles within a register byte are transferred |
| 33971 | most-significant - least-significant. |
| 33972 | |
| 33973 | @table @r |
| 33974 | |
| 33975 | @item MIPS32 |
| 33976 | |
| 33977 | All registers are transferred as thirty-two bit quantities in the order: |
| 33978 | 32 general-purpose; sr; lo; hi; bad; cause; pc; 32 floating-point |
| 33979 | registers; fsr; fir; fp. |
| 33980 | |
| 33981 | @item MIPS64 |
| 33982 | |
| 33983 | All registers are transferred as sixty-four bit quantities (including |
| 33984 | thirty-two bit registers such as @code{sr}). The ordering is the same |
| 33985 | as @code{MIPS32}. |
| 33986 | |
| 33987 | @end table |
| 33988 | |
| 33989 | @node Tracepoint Packets |
| 33990 | @section Tracepoint Packets |
| 33991 | @cindex tracepoint packets |
| 33992 | @cindex packets, tracepoint |
| 33993 | |
| 33994 | Here we describe the packets @value{GDBN} uses to implement |
| 33995 | tracepoints (@pxref{Tracepoints}). |
| 33996 | |
| 33997 | @table @samp |
| 33998 | |
| 33999 | @item QTDP:@var{n}:@var{addr}:@var{ena}:@var{step}:@var{pass}[:F@var{flen}][:X@var{len},@var{bytes}]@r{[}-@r{]} |
| 34000 | Create a new tracepoint, number @var{n}, at @var{addr}. If @var{ena} |
| 34001 | is @samp{E}, then the tracepoint is enabled; if it is @samp{D}, then |
| 34002 | the tracepoint is disabled. @var{step} is the tracepoint's step |
| 34003 | count, and @var{pass} is its pass count. If an @samp{F} is present, |
| 34004 | then the tracepoint is to be a fast tracepoint, and the @var{flen} is |
| 34005 | the number of bytes that the target should copy elsewhere to make room |
| 34006 | for the tracepoint. If an @samp{X} is present, it introduces a |
| 34007 | tracepoint condition, which consists of a hexadecimal length, followed |
| 34008 | by a comma and hex-encoded bytes, in a manner similar to action |
| 34009 | encodings as described below. If the trailing @samp{-} is present, |
| 34010 | further @samp{QTDP} packets will follow to specify this tracepoint's |
| 34011 | actions. |
| 34012 | |
| 34013 | Replies: |
| 34014 | @table @samp |
| 34015 | @item OK |
| 34016 | The packet was understood and carried out. |
| 34017 | @item qRelocInsn |
| 34018 | @xref{Tracepoint Packets,,Relocate instruction reply packet}. |
| 34019 | @item |
| 34020 | The packet was not recognized. |
| 34021 | @end table |
| 34022 | |
| 34023 | @item QTDP:-@var{n}:@var{addr}:@r{[}S@r{]}@var{action}@dots{}@r{[}-@r{]} |
| 34024 | Define actions to be taken when a tracepoint is hit. @var{n} and |
| 34025 | @var{addr} must be the same as in the initial @samp{QTDP} packet for |
| 34026 | this tracepoint. This packet may only be sent immediately after |
| 34027 | another @samp{QTDP} packet that ended with a @samp{-}. If the |
| 34028 | trailing @samp{-} is present, further @samp{QTDP} packets will follow, |
| 34029 | specifying more actions for this tracepoint. |
| 34030 | |
| 34031 | In the series of action packets for a given tracepoint, at most one |
| 34032 | can have an @samp{S} before its first @var{action}. If such a packet |
| 34033 | is sent, it and the following packets define ``while-stepping'' |
| 34034 | actions. Any prior packets define ordinary actions --- that is, those |
| 34035 | taken when the tracepoint is first hit. If no action packet has an |
| 34036 | @samp{S}, then all the packets in the series specify ordinary |
| 34037 | tracepoint actions. |
| 34038 | |
| 34039 | The @samp{@var{action}@dots{}} portion of the packet is a series of |
| 34040 | actions, concatenated without separators. Each action has one of the |
| 34041 | following forms: |
| 34042 | |
| 34043 | @table @samp |
| 34044 | |
| 34045 | @item R @var{mask} |
| 34046 | Collect the registers whose bits are set in @var{mask}. @var{mask} is |
| 34047 | a hexadecimal number whose @var{i}'th bit is set if register number |
| 34048 | @var{i} should be collected. (The least significant bit is numbered |
| 34049 | zero.) Note that @var{mask} may be any number of digits long; it may |
| 34050 | not fit in a 32-bit word. |
| 34051 | |
| 34052 | @item M @var{basereg},@var{offset},@var{len} |
| 34053 | Collect @var{len} bytes of memory starting at the address in register |
| 34054 | number @var{basereg}, plus @var{offset}. If @var{basereg} is |
| 34055 | @samp{-1}, then the range has a fixed address: @var{offset} is the |
| 34056 | address of the lowest byte to collect. The @var{basereg}, |
| 34057 | @var{offset}, and @var{len} parameters are all unsigned hexadecimal |
| 34058 | values (the @samp{-1} value for @var{basereg} is a special case). |
| 34059 | |
| 34060 | @item X @var{len},@var{expr} |
| 34061 | Evaluate @var{expr}, whose length is @var{len}, and collect memory as |
| 34062 | it directs. @var{expr} is an agent expression, as described in |
| 34063 | @ref{Agent Expressions}. Each byte of the expression is encoded as a |
| 34064 | two-digit hex number in the packet; @var{len} is the number of bytes |
| 34065 | in the expression (and thus one-half the number of hex digits in the |
| 34066 | packet). |
| 34067 | |
| 34068 | @end table |
| 34069 | |
| 34070 | Any number of actions may be packed together in a single @samp{QTDP} |
| 34071 | packet, as long as the packet does not exceed the maximum packet |
| 34072 | length (400 bytes, for many stubs). There may be only one @samp{R} |
| 34073 | action per tracepoint, and it must precede any @samp{M} or @samp{X} |
| 34074 | actions. Any registers referred to by @samp{M} and @samp{X} actions |
| 34075 | must be collected by a preceding @samp{R} action. (The |
| 34076 | ``while-stepping'' actions are treated as if they were attached to a |
| 34077 | separate tracepoint, as far as these restrictions are concerned.) |
| 34078 | |
| 34079 | Replies: |
| 34080 | @table @samp |
| 34081 | @item OK |
| 34082 | The packet was understood and carried out. |
| 34083 | @item qRelocInsn |
| 34084 | @xref{Tracepoint Packets,,Relocate instruction reply packet}. |
| 34085 | @item |
| 34086 | The packet was not recognized. |
| 34087 | @end table |
| 34088 | |
| 34089 | @item QTDPsrc:@var{n}:@var{addr}:@var{type}:@var{start}:@var{slen}:@var{bytes} |
| 34090 | @cindex @samp{QTDPsrc} packet |
| 34091 | Specify a source string of tracepoint @var{n} at address @var{addr}. |
| 34092 | This is useful to get accurate reproduction of the tracepoints |
| 34093 | originally downloaded at the beginning of the trace run. @var{type} |
| 34094 | is the name of the tracepoint part, such as @samp{cond} for the |
| 34095 | tracepoint's conditional expression (see below for a list of types), while |
| 34096 | @var{bytes} is the string, encoded in hexadecimal. |
| 34097 | |
| 34098 | @var{start} is the offset of the @var{bytes} within the overall source |
| 34099 | string, while @var{slen} is the total length of the source string. |
| 34100 | This is intended for handling source strings that are longer than will |
| 34101 | fit in a single packet. |
| 34102 | @c Add detailed example when this info is moved into a dedicated |
| 34103 | @c tracepoint descriptions section. |
| 34104 | |
| 34105 | The available string types are @samp{at} for the location, |
| 34106 | @samp{cond} for the conditional, and @samp{cmd} for an action command. |
| 34107 | @value{GDBN} sends a separate packet for each command in the action |
| 34108 | list, in the same order in which the commands are stored in the list. |
| 34109 | |
| 34110 | The target does not need to do anything with source strings except |
| 34111 | report them back as part of the replies to the @samp{qTfP}/@samp{qTsP} |
| 34112 | query packets. |
| 34113 | |
| 34114 | Although this packet is optional, and @value{GDBN} will only send it |
| 34115 | if the target replies with @samp{TracepointSource} @xref{General |
| 34116 | Query Packets}, it makes both disconnected tracing and trace files |
| 34117 | much easier to use. Otherwise the user must be careful that the |
| 34118 | tracepoints in effect while looking at trace frames are identical to |
| 34119 | the ones in effect during the trace run; even a small discrepancy |
| 34120 | could cause @samp{tdump} not to work, or a particular trace frame not |
| 34121 | be found. |
| 34122 | |
| 34123 | @item QTDV:@var{n}:@var{value} |
| 34124 | @cindex define trace state variable, remote request |
| 34125 | @cindex @samp{QTDV} packet |
| 34126 | Create a new trace state variable, number @var{n}, with an initial |
| 34127 | value of @var{value}, which is a 64-bit signed integer. Both @var{n} |
| 34128 | and @var{value} are encoded as hexadecimal values. @value{GDBN} has |
| 34129 | the option of not using this packet for initial values of zero; the |
| 34130 | target should simply create the trace state variables as they are |
| 34131 | mentioned in expressions. |
| 34132 | |
| 34133 | @item QTFrame:@var{n} |
| 34134 | Select the @var{n}'th tracepoint frame from the buffer, and use the |
| 34135 | register and memory contents recorded there to answer subsequent |
| 34136 | request packets from @value{GDBN}. |
| 34137 | |
| 34138 | A successful reply from the stub indicates that the stub has found the |
| 34139 | requested frame. The response is a series of parts, concatenated |
| 34140 | without separators, describing the frame we selected. Each part has |
| 34141 | one of the following forms: |
| 34142 | |
| 34143 | @table @samp |
| 34144 | @item F @var{f} |
| 34145 | The selected frame is number @var{n} in the trace frame buffer; |
| 34146 | @var{f} is a hexadecimal number. If @var{f} is @samp{-1}, then there |
| 34147 | was no frame matching the criteria in the request packet. |
| 34148 | |
| 34149 | @item T @var{t} |
| 34150 | The selected trace frame records a hit of tracepoint number @var{t}; |
| 34151 | @var{t} is a hexadecimal number. |
| 34152 | |
| 34153 | @end table |
| 34154 | |
| 34155 | @item QTFrame:pc:@var{addr} |
| 34156 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the |
| 34157 | currently selected frame whose PC is @var{addr}; |
| 34158 | @var{addr} is a hexadecimal number. |
| 34159 | |
| 34160 | @item QTFrame:tdp:@var{t} |
| 34161 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the |
| 34162 | currently selected frame that is a hit of tracepoint @var{t}; @var{t} |
| 34163 | is a hexadecimal number. |
| 34164 | |
| 34165 | @item QTFrame:range:@var{start}:@var{end} |
| 34166 | Like @samp{QTFrame:@var{n}}, but select the first tracepoint frame after the |
| 34167 | currently selected frame whose PC is between @var{start} (inclusive) |
| 34168 | and @var{end} (inclusive); @var{start} and @var{end} are hexadecimal |
| 34169 | numbers. |
| 34170 | |
| 34171 | @item QTFrame:outside:@var{start}:@var{end} |
| 34172 | Like @samp{QTFrame:range:@var{start}:@var{end}}, but select the first |
| 34173 | frame @emph{outside} the given range of addresses (exclusive). |
| 34174 | |
| 34175 | @item QTStart |
| 34176 | Begin the tracepoint experiment. Begin collecting data from |
| 34177 | tracepoint hits in the trace frame buffer. This packet supports the |
| 34178 | @samp{qRelocInsn} reply (@pxref{Tracepoint Packets,,Relocate |
| 34179 | instruction reply packet}). |
| 34180 | |
| 34181 | @item QTStop |
| 34182 | End the tracepoint experiment. Stop collecting trace frames. |
| 34183 | |
| 34184 | @item QTinit |
| 34185 | Clear the table of tracepoints, and empty the trace frame buffer. |
| 34186 | |
| 34187 | @item QTro:@var{start1},@var{end1}:@var{start2},@var{end2}:@dots{} |
| 34188 | Establish the given ranges of memory as ``transparent''. The stub |
| 34189 | will answer requests for these ranges from memory's current contents, |
| 34190 | if they were not collected as part of the tracepoint hit. |
| 34191 | |
| 34192 | @value{GDBN} uses this to mark read-only regions of memory, like those |
| 34193 | containing program code. Since these areas never change, they should |
| 34194 | still have the same contents they did when the tracepoint was hit, so |
| 34195 | there's no reason for the stub to refuse to provide their contents. |
| 34196 | |
| 34197 | @item QTDisconnected:@var{value} |
| 34198 | Set the choice to what to do with the tracing run when @value{GDBN} |
| 34199 | disconnects from the target. A @var{value} of 1 directs the target to |
| 34200 | continue the tracing run, while 0 tells the target to stop tracing if |
| 34201 | @value{GDBN} is no longer in the picture. |
| 34202 | |
| 34203 | @item qTStatus |
| 34204 | Ask the stub if there is a trace experiment running right now. |
| 34205 | |
| 34206 | The reply has the form: |
| 34207 | |
| 34208 | @table @samp |
| 34209 | |
| 34210 | @item T@var{running}@r{[};@var{field}@r{]}@dots{} |
| 34211 | @var{running} is a single digit @code{1} if the trace is presently |
| 34212 | running, or @code{0} if not. It is followed by semicolon-separated |
| 34213 | optional fields that an agent may use to report additional status. |
| 34214 | |
| 34215 | @end table |
| 34216 | |
| 34217 | If the trace is not running, the agent may report any of several |
| 34218 | explanations as one of the optional fields: |
| 34219 | |
| 34220 | @table @samp |
| 34221 | |
| 34222 | @item tnotrun:0 |
| 34223 | No trace has been run yet. |
| 34224 | |
| 34225 | @item tstop:0 |
| 34226 | The trace was stopped by a user-originated stop command. |
| 34227 | |
| 34228 | @item tfull:0 |
| 34229 | The trace stopped because the trace buffer filled up. |
| 34230 | |
| 34231 | @item tdisconnected:0 |
| 34232 | The trace stopped because @value{GDBN} disconnected from the target. |
| 34233 | |
| 34234 | @item tpasscount:@var{tpnum} |
| 34235 | The trace stopped because tracepoint @var{tpnum} exceeded its pass count. |
| 34236 | |
| 34237 | @item terror:@var{text}:@var{tpnum} |
| 34238 | The trace stopped because tracepoint @var{tpnum} had an error. The |
| 34239 | string @var{text} is available to describe the nature of the error |
| 34240 | (for instance, a divide by zero in the condition expression). |
| 34241 | @var{text} is hex encoded. |
| 34242 | |
| 34243 | @item tunknown:0 |
| 34244 | The trace stopped for some other reason. |
| 34245 | |
| 34246 | @end table |
| 34247 | |
| 34248 | Additional optional fields supply statistical and other information. |
| 34249 | Although not required, they are extremely useful for users monitoring |
| 34250 | the progress of a trace run. If a trace has stopped, and these |
| 34251 | numbers are reported, they must reflect the state of the just-stopped |
| 34252 | trace. |
| 34253 | |
| 34254 | @table @samp |
| 34255 | |
| 34256 | @item tframes:@var{n} |
| 34257 | The number of trace frames in the buffer. |
| 34258 | |
| 34259 | @item tcreated:@var{n} |
| 34260 | The total number of trace frames created during the run. This may |
| 34261 | be larger than the trace frame count, if the buffer is circular. |
| 34262 | |
| 34263 | @item tsize:@var{n} |
| 34264 | The total size of the trace buffer, in bytes. |
| 34265 | |
| 34266 | @item tfree:@var{n} |
| 34267 | The number of bytes still unused in the buffer. |
| 34268 | |
| 34269 | @item circular:@var{n} |
| 34270 | The value of the circular trace buffer flag. @code{1} means that the |
| 34271 | trace buffer is circular and old trace frames will be discarded if |
| 34272 | necessary to make room, @code{0} means that the trace buffer is linear |
| 34273 | and may fill up. |
| 34274 | |
| 34275 | @item disconn:@var{n} |
| 34276 | The value of the disconnected tracing flag. @code{1} means that |
| 34277 | tracing will continue after @value{GDBN} disconnects, @code{0} means |
| 34278 | that the trace run will stop. |
| 34279 | |
| 34280 | @end table |
| 34281 | |
| 34282 | @item qTV:@var{var} |
| 34283 | @cindex trace state variable value, remote request |
| 34284 | @cindex @samp{qTV} packet |
| 34285 | Ask the stub for the value of the trace state variable number @var{var}. |
| 34286 | |
| 34287 | Replies: |
| 34288 | @table @samp |
| 34289 | @item V@var{value} |
| 34290 | The value of the variable is @var{value}. This will be the current |
| 34291 | value of the variable if the user is examining a running target, or a |
| 34292 | saved value if the variable was collected in the trace frame that the |
| 34293 | user is looking at. Note that multiple requests may result in |
| 34294 | different reply values, such as when requesting values while the |
| 34295 | program is running. |
| 34296 | |
| 34297 | @item U |
| 34298 | The value of the variable is unknown. This would occur, for example, |
| 34299 | if the user is examining a trace frame in which the requested variable |
| 34300 | was not collected. |
| 34301 | @end table |
| 34302 | |
| 34303 | @item qTfP |
| 34304 | @itemx qTsP |
| 34305 | These packets request data about tracepoints that are being used by |
| 34306 | the target. @value{GDBN} sends @code{qTfP} to get the first piece |
| 34307 | of data, and multiple @code{qTsP} to get additional pieces. Replies |
| 34308 | to these packets generally take the form of the @code{QTDP} packets |
| 34309 | that define tracepoints. (FIXME add detailed syntax) |
| 34310 | |
| 34311 | @item qTfV |
| 34312 | @itemx qTsV |
| 34313 | These packets request data about trace state variables that are on the |
| 34314 | target. @value{GDBN} sends @code{qTfV} to get the first vari of data, |
| 34315 | and multiple @code{qTsV} to get additional variables. Replies to |
| 34316 | these packets follow the syntax of the @code{QTDV} packets that define |
| 34317 | trace state variables. |
| 34318 | |
| 34319 | @item qTfSTM |
| 34320 | @itemx qTsSTM |
| 34321 | These packets request data about static tracepoint markers that exist |
| 34322 | in the target program. @value{GDBN} sends @code{qTfSTM} to get the |
| 34323 | first piece of data, and multiple @code{qTsSTM} to get additional |
| 34324 | pieces. Replies to these packets take the following form: |
| 34325 | |
| 34326 | Reply: |
| 34327 | @table @samp |
| 34328 | @item m @var{address}:@var{id}:@var{extra} |
| 34329 | A single marker |
| 34330 | @item m @var{address}:@var{id}:@var{extra},@var{address}:@var{id}:@var{extra}@dots{} |
| 34331 | a comma-separated list of markers |
| 34332 | @item l |
| 34333 | (lower case letter @samp{L}) denotes end of list. |
| 34334 | @item E @var{nn} |
| 34335 | An error occurred. @var{nn} are hex digits. |
| 34336 | @item |
| 34337 | An empty reply indicates that the request is not supported by the |
| 34338 | stub. |
| 34339 | @end table |
| 34340 | |
| 34341 | @var{address} is encoded in hex. |
| 34342 | @var{id} and @var{extra} are strings encoded in hex. |
| 34343 | |
| 34344 | In response to each query, the target will reply with a list of one or |
| 34345 | more markers, separated by commas. @value{GDBN} will respond to each |
| 34346 | reply with a request for more markers (using the @samp{qs} form of the |
| 34347 | query), until the target responds with @samp{l} (lower-case ell, for |
| 34348 | @dfn{last}). |
| 34349 | |
| 34350 | @item qTSTMat:@var{address} |
| 34351 | This packets requests data about static tracepoint markers in the |
| 34352 | target program at @var{address}. Replies to this packet follow the |
| 34353 | syntax of the @samp{qTfSTM} and @code{qTsSTM} packets that list static |
| 34354 | tracepoint markers. |
| 34355 | |
| 34356 | @item QTSave:@var{filename} |
| 34357 | This packet directs the target to save trace data to the file name |
| 34358 | @var{filename} in the target's filesystem. @var{filename} is encoded |
| 34359 | as a hex string; the interpretation of the file name (relative vs |
| 34360 | absolute, wild cards, etc) is up to the target. |
| 34361 | |
| 34362 | @item qTBuffer:@var{offset},@var{len} |
| 34363 | Return up to @var{len} bytes of the current contents of trace buffer, |
| 34364 | starting at @var{offset}. The trace buffer is treated as if it were |
| 34365 | a contiguous collection of traceframes, as per the trace file format. |
| 34366 | The reply consists as many hex-encoded bytes as the target can deliver |
| 34367 | in a packet; it is not an error to return fewer than were asked for. |
| 34368 | A reply consisting of just @code{l} indicates that no bytes are |
| 34369 | available. |
| 34370 | |
| 34371 | @item QTBuffer:circular:@var{value} |
| 34372 | This packet directs the target to use a circular trace buffer if |
| 34373 | @var{value} is 1, or a linear buffer if the value is 0. |
| 34374 | |
| 34375 | @end table |
| 34376 | |
| 34377 | @subsection Relocate instruction reply packet |
| 34378 | When installing fast tracepoints in memory, the target may need to |
| 34379 | relocate the instruction currently at the tracepoint address to a |
| 34380 | different address in memory. For most instructions, a simple copy is |
| 34381 | enough, but, for example, call instructions that implicitly push the |
| 34382 | return address on the stack, and relative branches or other |
| 34383 | PC-relative instructions require offset adjustment, so that the effect |
| 34384 | of executing the instruction at a different address is the same as if |
| 34385 | it had executed in the original location. |
| 34386 | |
| 34387 | In response to several of the tracepoint packets, the target may also |
| 34388 | respond with a number of intermediate @samp{qRelocInsn} request |
| 34389 | packets before the final result packet, to have @value{GDBN} handle |
| 34390 | this relocation operation. If a packet supports this mechanism, its |
| 34391 | documentation will explicitly say so. See for example the above |
| 34392 | descriptions for the @samp{QTStart} and @samp{QTDP} packets. The |
| 34393 | format of the request is: |
| 34394 | |
| 34395 | @table @samp |
| 34396 | @item qRelocInsn:@var{from};@var{to} |
| 34397 | |
| 34398 | This requests @value{GDBN} to copy instruction at address @var{from} |
| 34399 | to address @var{to}, possibly adjusted so that executing the |
| 34400 | instruction at @var{to} has the same effect as executing it at |
| 34401 | @var{from}. @value{GDBN} writes the adjusted instruction to target |
| 34402 | memory starting at @var{to}. |
| 34403 | @end table |
| 34404 | |
| 34405 | Replies: |
| 34406 | @table @samp |
| 34407 | @item qRelocInsn:@var{adjusted_size} |
| 34408 | Informs the stub the relocation is complete. @var{adjusted_size} is |
| 34409 | the length in bytes of resulting relocated instruction sequence. |
| 34410 | @item E @var{NN} |
| 34411 | A badly formed request was detected, or an error was encountered while |
| 34412 | relocating the instruction. |
| 34413 | @end table |
| 34414 | |
| 34415 | @node Host I/O Packets |
| 34416 | @section Host I/O Packets |
| 34417 | @cindex Host I/O, remote protocol |
| 34418 | @cindex file transfer, remote protocol |
| 34419 | |
| 34420 | The @dfn{Host I/O} packets allow @value{GDBN} to perform I/O |
| 34421 | operations on the far side of a remote link. For example, Host I/O is |
| 34422 | used to upload and download files to a remote target with its own |
| 34423 | filesystem. Host I/O uses the same constant values and data structure |
| 34424 | layout as the target-initiated File-I/O protocol. However, the |
| 34425 | Host I/O packets are structured differently. The target-initiated |
| 34426 | protocol relies on target memory to store parameters and buffers. |
| 34427 | Host I/O requests are initiated by @value{GDBN}, and the |
| 34428 | target's memory is not involved. @xref{File-I/O Remote Protocol |
| 34429 | Extension}, for more details on the target-initiated protocol. |
| 34430 | |
| 34431 | The Host I/O request packets all encode a single operation along with |
| 34432 | its arguments. They have this format: |
| 34433 | |
| 34434 | @table @samp |
| 34435 | |
| 34436 | @item vFile:@var{operation}: @var{parameter}@dots{} |
| 34437 | @var{operation} is the name of the particular request; the target |
| 34438 | should compare the entire packet name up to the second colon when checking |
| 34439 | for a supported operation. The format of @var{parameter} depends on |
| 34440 | the operation. Numbers are always passed in hexadecimal. Negative |
| 34441 | numbers have an explicit minus sign (i.e.@: two's complement is not |
| 34442 | used). Strings (e.g.@: filenames) are encoded as a series of |
| 34443 | hexadecimal bytes. The last argument to a system call may be a |
| 34444 | buffer of escaped binary data (@pxref{Binary Data}). |
| 34445 | |
| 34446 | @end table |
| 34447 | |
| 34448 | The valid responses to Host I/O packets are: |
| 34449 | |
| 34450 | @table @samp |
| 34451 | |
| 34452 | @item F @var{result} [, @var{errno}] [; @var{attachment}] |
| 34453 | @var{result} is the integer value returned by this operation, usually |
| 34454 | non-negative for success and -1 for errors. If an error has occured, |
| 34455 | @var{errno} will be included in the result. @var{errno} will have a |
| 34456 | value defined by the File-I/O protocol (@pxref{Errno Values}). For |
| 34457 | operations which return data, @var{attachment} supplies the data as a |
| 34458 | binary buffer. Binary buffers in response packets are escaped in the |
| 34459 | normal way (@pxref{Binary Data}). See the individual packet |
| 34460 | documentation for the interpretation of @var{result} and |
| 34461 | @var{attachment}. |
| 34462 | |
| 34463 | @item |
| 34464 | An empty response indicates that this operation is not recognized. |
| 34465 | |
| 34466 | @end table |
| 34467 | |
| 34468 | These are the supported Host I/O operations: |
| 34469 | |
| 34470 | @table @samp |
| 34471 | @item vFile:open: @var{pathname}, @var{flags}, @var{mode} |
| 34472 | Open a file at @var{pathname} and return a file descriptor for it, or |
| 34473 | return -1 if an error occurs. @var{pathname} is a string, |
| 34474 | @var{flags} is an integer indicating a mask of open flags |
| 34475 | (@pxref{Open Flags}), and @var{mode} is an integer indicating a mask |
| 34476 | of mode bits to use if the file is created (@pxref{mode_t Values}). |
| 34477 | @xref{open}, for details of the open flags and mode values. |
| 34478 | |
| 34479 | @item vFile:close: @var{fd} |
| 34480 | Close the open file corresponding to @var{fd} and return 0, or |
| 34481 | -1 if an error occurs. |
| 34482 | |
| 34483 | @item vFile:pread: @var{fd}, @var{count}, @var{offset} |
| 34484 | Read data from the open file corresponding to @var{fd}. Up to |
| 34485 | @var{count} bytes will be read from the file, starting at @var{offset} |
| 34486 | relative to the start of the file. The target may read fewer bytes; |
| 34487 | common reasons include packet size limits and an end-of-file |
| 34488 | condition. The number of bytes read is returned. Zero should only be |
| 34489 | returned for a successful read at the end of the file, or if |
| 34490 | @var{count} was zero. |
| 34491 | |
| 34492 | The data read should be returned as a binary attachment on success. |
| 34493 | If zero bytes were read, the response should include an empty binary |
| 34494 | attachment (i.e.@: a trailing semicolon). The return value is the |
| 34495 | number of target bytes read; the binary attachment may be longer if |
| 34496 | some characters were escaped. |
| 34497 | |
| 34498 | @item vFile:pwrite: @var{fd}, @var{offset}, @var{data} |
| 34499 | Write @var{data} (a binary buffer) to the open file corresponding |
| 34500 | to @var{fd}. Start the write at @var{offset} from the start of the |
| 34501 | file. Unlike many @code{write} system calls, there is no |
| 34502 | separate @var{count} argument; the length of @var{data} in the |
| 34503 | packet is used. @samp{vFile:write} returns the number of bytes written, |
| 34504 | which may be shorter than the length of @var{data}, or -1 if an |
| 34505 | error occurred. |
| 34506 | |
| 34507 | @item vFile:unlink: @var{pathname} |
| 34508 | Delete the file at @var{pathname} on the target. Return 0, |
| 34509 | or -1 if an error occurs. @var{pathname} is a string. |
| 34510 | |
| 34511 | @end table |
| 34512 | |
| 34513 | @node Interrupts |
| 34514 | @section Interrupts |
| 34515 | @cindex interrupts (remote protocol) |
| 34516 | |
| 34517 | When a program on the remote target is running, @value{GDBN} may |
| 34518 | attempt to interrupt it by sending a @samp{Ctrl-C}, @code{BREAK} or |
| 34519 | a @code{BREAK} followed by @code{g}, |
| 34520 | control of which is specified via @value{GDBN}'s @samp{interrupt-sequence}. |
| 34521 | |
| 34522 | The precise meaning of @code{BREAK} is defined by the transport |
| 34523 | mechanism and may, in fact, be undefined. @value{GDBN} does not |
| 34524 | currently define a @code{BREAK} mechanism for any of the network |
| 34525 | interfaces except for TCP, in which case @value{GDBN} sends the |
| 34526 | @code{telnet} BREAK sequence. |
| 34527 | |
| 34528 | @samp{Ctrl-C}, on the other hand, is defined and implemented for all |
| 34529 | transport mechanisms. It is represented by sending the single byte |
| 34530 | @code{0x03} without any of the usual packet overhead described in |
| 34531 | the Overview section (@pxref{Overview}). When a @code{0x03} byte is |
| 34532 | transmitted as part of a packet, it is considered to be packet data |
| 34533 | and does @emph{not} represent an interrupt. E.g., an @samp{X} packet |
| 34534 | (@pxref{X packet}), used for binary downloads, may include an unescaped |
| 34535 | @code{0x03} as part of its packet. |
| 34536 | |
| 34537 | @code{BREAK} followed by @code{g} is also known as Magic SysRq g. |
| 34538 | When Linux kernel receives this sequence from serial port, |
| 34539 | it stops execution and connects to gdb. |
| 34540 | |
| 34541 | Stubs are not required to recognize these interrupt mechanisms and the |
| 34542 | precise meaning associated with receipt of the interrupt is |
| 34543 | implementation defined. If the target supports debugging of multiple |
| 34544 | threads and/or processes, it should attempt to interrupt all |
| 34545 | currently-executing threads and processes. |
| 34546 | If the stub is successful at interrupting the |
| 34547 | running program, it should send one of the stop |
| 34548 | reply packets (@pxref{Stop Reply Packets}) to @value{GDBN} as a result |
| 34549 | of successfully stopping the program in all-stop mode, and a stop reply |
| 34550 | for each stopped thread in non-stop mode. |
| 34551 | Interrupts received while the |
| 34552 | program is stopped are discarded. |
| 34553 | |
| 34554 | @node Notification Packets |
| 34555 | @section Notification Packets |
| 34556 | @cindex notification packets |
| 34557 | @cindex packets, notification |
| 34558 | |
| 34559 | The @value{GDBN} remote serial protocol includes @dfn{notifications}, |
| 34560 | packets that require no acknowledgment. Both the GDB and the stub |
| 34561 | may send notifications (although the only notifications defined at |
| 34562 | present are sent by the stub). Notifications carry information |
| 34563 | without incurring the round-trip latency of an acknowledgment, and so |
| 34564 | are useful for low-impact communications where occasional packet loss |
| 34565 | is not a problem. |
| 34566 | |
| 34567 | A notification packet has the form @samp{% @var{data} # |
| 34568 | @var{checksum}}, where @var{data} is the content of the notification, |
| 34569 | and @var{checksum} is a checksum of @var{data}, computed and formatted |
| 34570 | as for ordinary @value{GDBN} packets. A notification's @var{data} |
| 34571 | never contains @samp{$}, @samp{%} or @samp{#} characters. Upon |
| 34572 | receiving a notification, the recipient sends no @samp{+} or @samp{-} |
| 34573 | to acknowledge the notification's receipt or to report its corruption. |
| 34574 | |
| 34575 | Every notification's @var{data} begins with a name, which contains no |
| 34576 | colon characters, followed by a colon character. |
| 34577 | |
| 34578 | Recipients should silently ignore corrupted notifications and |
| 34579 | notifications they do not understand. Recipients should restart |
| 34580 | timeout periods on receipt of a well-formed notification, whether or |
| 34581 | not they understand it. |
| 34582 | |
| 34583 | Senders should only send the notifications described here when this |
| 34584 | protocol description specifies that they are permitted. In the |
| 34585 | future, we may extend the protocol to permit existing notifications in |
| 34586 | new contexts; this rule helps older senders avoid confusing newer |
| 34587 | recipients. |
| 34588 | |
| 34589 | (Older versions of @value{GDBN} ignore bytes received until they see |
| 34590 | the @samp{$} byte that begins an ordinary packet, so new stubs may |
| 34591 | transmit notifications without fear of confusing older clients. There |
| 34592 | are no notifications defined for @value{GDBN} to send at the moment, but we |
| 34593 | assume that most older stubs would ignore them, as well.) |
| 34594 | |
| 34595 | The following notification packets from the stub to @value{GDBN} are |
| 34596 | defined: |
| 34597 | |
| 34598 | @table @samp |
| 34599 | @item Stop: @var{reply} |
| 34600 | Report an asynchronous stop event in non-stop mode. |
| 34601 | The @var{reply} has the form of a stop reply, as |
| 34602 | described in @ref{Stop Reply Packets}. Refer to @ref{Remote Non-Stop}, |
| 34603 | for information on how these notifications are acknowledged by |
| 34604 | @value{GDBN}. |
| 34605 | @end table |
| 34606 | |
| 34607 | @node Remote Non-Stop |
| 34608 | @section Remote Protocol Support for Non-Stop Mode |
| 34609 | |
| 34610 | @value{GDBN}'s remote protocol supports non-stop debugging of |
| 34611 | multi-threaded programs, as described in @ref{Non-Stop Mode}. If the stub |
| 34612 | supports non-stop mode, it should report that to @value{GDBN} by including |
| 34613 | @samp{QNonStop+} in its @samp{qSupported} response (@pxref{qSupported}). |
| 34614 | |
| 34615 | @value{GDBN} typically sends a @samp{QNonStop} packet only when |
| 34616 | establishing a new connection with the stub. Entering non-stop mode |
| 34617 | does not alter the state of any currently-running threads, but targets |
| 34618 | must stop all threads in any already-attached processes when entering |
| 34619 | all-stop mode. @value{GDBN} uses the @samp{?} packet as necessary to |
| 34620 | probe the target state after a mode change. |
| 34621 | |
| 34622 | In non-stop mode, when an attached process encounters an event that |
| 34623 | would otherwise be reported with a stop reply, it uses the |
| 34624 | asynchronous notification mechanism (@pxref{Notification Packets}) to |
| 34625 | inform @value{GDBN}. In contrast to all-stop mode, where all threads |
| 34626 | in all processes are stopped when a stop reply is sent, in non-stop |
| 34627 | mode only the thread reporting the stop event is stopped. That is, |
| 34628 | when reporting a @samp{S} or @samp{T} response to indicate completion |
| 34629 | of a step operation, hitting a breakpoint, or a fault, only the |
| 34630 | affected thread is stopped; any other still-running threads continue |
| 34631 | to run. When reporting a @samp{W} or @samp{X} response, all running |
| 34632 | threads belonging to other attached processes continue to run. |
| 34633 | |
| 34634 | Only one stop reply notification at a time may be pending; if |
| 34635 | additional stop events occur before @value{GDBN} has acknowledged the |
| 34636 | previous notification, they must be queued by the stub for later |
| 34637 | synchronous transmission in response to @samp{vStopped} packets from |
| 34638 | @value{GDBN}. Because the notification mechanism is unreliable, |
| 34639 | the stub is permitted to resend a stop reply notification |
| 34640 | if it believes @value{GDBN} may not have received it. @value{GDBN} |
| 34641 | ignores additional stop reply notifications received before it has |
| 34642 | finished processing a previous notification and the stub has completed |
| 34643 | sending any queued stop events. |
| 34644 | |
| 34645 | Otherwise, @value{GDBN} must be prepared to receive a stop reply |
| 34646 | notification at any time. Specifically, they may appear when |
| 34647 | @value{GDBN} is not otherwise reading input from the stub, or when |
| 34648 | @value{GDBN} is expecting to read a normal synchronous response or a |
| 34649 | @samp{+}/@samp{-} acknowledgment to a packet it has sent. |
| 34650 | Notification packets are distinct from any other communication from |
| 34651 | the stub so there is no ambiguity. |
| 34652 | |
| 34653 | After receiving a stop reply notification, @value{GDBN} shall |
| 34654 | acknowledge it by sending a @samp{vStopped} packet (@pxref{vStopped packet}) |
| 34655 | as a regular, synchronous request to the stub. Such acknowledgment |
| 34656 | is not required to happen immediately, as @value{GDBN} is permitted to |
| 34657 | send other, unrelated packets to the stub first, which the stub should |
| 34658 | process normally. |
| 34659 | |
| 34660 | Upon receiving a @samp{vStopped} packet, if the stub has other queued |
| 34661 | stop events to report to @value{GDBN}, it shall respond by sending a |
| 34662 | normal stop reply response. @value{GDBN} shall then send another |
| 34663 | @samp{vStopped} packet to solicit further responses; again, it is |
| 34664 | permitted to send other, unrelated packets as well which the stub |
| 34665 | should process normally. |
| 34666 | |
| 34667 | If the stub receives a @samp{vStopped} packet and there are no |
| 34668 | additional stop events to report, the stub shall return an @samp{OK} |
| 34669 | response. At this point, if further stop events occur, the stub shall |
| 34670 | send a new stop reply notification, @value{GDBN} shall accept the |
| 34671 | notification, and the process shall be repeated. |
| 34672 | |
| 34673 | In non-stop mode, the target shall respond to the @samp{?} packet as |
| 34674 | follows. First, any incomplete stop reply notification/@samp{vStopped} |
| 34675 | sequence in progress is abandoned. The target must begin a new |
| 34676 | sequence reporting stop events for all stopped threads, whether or not |
| 34677 | it has previously reported those events to @value{GDBN}. The first |
| 34678 | stop reply is sent as a synchronous reply to the @samp{?} packet, and |
| 34679 | subsequent stop replies are sent as responses to @samp{vStopped} packets |
| 34680 | using the mechanism described above. The target must not send |
| 34681 | asynchronous stop reply notifications until the sequence is complete. |
| 34682 | If all threads are running when the target receives the @samp{?} packet, |
| 34683 | or if the target is not attached to any process, it shall respond |
| 34684 | @samp{OK}. |
| 34685 | |
| 34686 | @node Packet Acknowledgment |
| 34687 | @section Packet Acknowledgment |
| 34688 | |
| 34689 | @cindex acknowledgment, for @value{GDBN} remote |
| 34690 | @cindex packet acknowledgment, for @value{GDBN} remote |
| 34691 | By default, when either the host or the target machine receives a packet, |
| 34692 | the first response expected is an acknowledgment: either @samp{+} (to indicate |
| 34693 | the package was received correctly) or @samp{-} (to request retransmission). |
| 34694 | This mechanism allows the @value{GDBN} remote protocol to operate over |
| 34695 | unreliable transport mechanisms, such as a serial line. |
| 34696 | |
| 34697 | In cases where the transport mechanism is itself reliable (such as a pipe or |
| 34698 | TCP connection), the @samp{+}/@samp{-} acknowledgments are redundant. |
| 34699 | It may be desirable to disable them in that case to reduce communication |
| 34700 | overhead, or for other reasons. This can be accomplished by means of the |
| 34701 | @samp{QStartNoAckMode} packet; @pxref{QStartNoAckMode}. |
| 34702 | |
| 34703 | When in no-acknowledgment mode, neither the stub nor @value{GDBN} shall send or |
| 34704 | expect @samp{+}/@samp{-} protocol acknowledgments. The packet |
| 34705 | and response format still includes the normal checksum, as described in |
| 34706 | @ref{Overview}, but the checksum may be ignored by the receiver. |
| 34707 | |
| 34708 | If the stub supports @samp{QStartNoAckMode} and prefers to operate in |
| 34709 | no-acknowledgment mode, it should report that to @value{GDBN} |
| 34710 | by including @samp{QStartNoAckMode+} in its response to @samp{qSupported}; |
| 34711 | @pxref{qSupported}. |
| 34712 | If @value{GDBN} also supports @samp{QStartNoAckMode} and it has not been |
| 34713 | disabled via the @code{set remote noack-packet off} command |
| 34714 | (@pxref{Remote Configuration}), |
| 34715 | @value{GDBN} may then send a @samp{QStartNoAckMode} packet to the stub. |
| 34716 | Only then may the stub actually turn off packet acknowledgments. |
| 34717 | @value{GDBN} sends a final @samp{+} acknowledgment of the stub's @samp{OK} |
| 34718 | response, which can be safely ignored by the stub. |
| 34719 | |
| 34720 | Note that @code{set remote noack-packet} command only affects negotiation |
| 34721 | between @value{GDBN} and the stub when subsequent connections are made; |
| 34722 | it does not affect the protocol acknowledgment state for any current |
| 34723 | connection. |
| 34724 | Since @samp{+}/@samp{-} acknowledgments are enabled by default when a |
| 34725 | new connection is established, |
| 34726 | there is also no protocol request to re-enable the acknowledgments |
| 34727 | for the current connection, once disabled. |
| 34728 | |
| 34729 | @node Examples |
| 34730 | @section Examples |
| 34731 | |
| 34732 | Example sequence of a target being re-started. Notice how the restart |
| 34733 | does not get any direct output: |
| 34734 | |
| 34735 | @smallexample |
| 34736 | -> @code{R00} |
| 34737 | <- @code{+} |
| 34738 | @emph{target restarts} |
| 34739 | -> @code{?} |
| 34740 | <- @code{+} |
| 34741 | <- @code{T001:1234123412341234} |
| 34742 | -> @code{+} |
| 34743 | @end smallexample |
| 34744 | |
| 34745 | Example sequence of a target being stepped by a single instruction: |
| 34746 | |
| 34747 | @smallexample |
| 34748 | -> @code{G1445@dots{}} |
| 34749 | <- @code{+} |
| 34750 | -> @code{s} |
| 34751 | <- @code{+} |
| 34752 | @emph{time passes} |
| 34753 | <- @code{T001:1234123412341234} |
| 34754 | -> @code{+} |
| 34755 | -> @code{g} |
| 34756 | <- @code{+} |
| 34757 | <- @code{1455@dots{}} |
| 34758 | -> @code{+} |
| 34759 | @end smallexample |
| 34760 | |
| 34761 | @node File-I/O Remote Protocol Extension |
| 34762 | @section File-I/O Remote Protocol Extension |
| 34763 | @cindex File-I/O remote protocol extension |
| 34764 | |
| 34765 | @menu |
| 34766 | * File-I/O Overview:: |
| 34767 | * Protocol Basics:: |
| 34768 | * The F Request Packet:: |
| 34769 | * The F Reply Packet:: |
| 34770 | * The Ctrl-C Message:: |
| 34771 | * Console I/O:: |
| 34772 | * List of Supported Calls:: |
| 34773 | * Protocol-specific Representation of Datatypes:: |
| 34774 | * Constants:: |
| 34775 | * File-I/O Examples:: |
| 34776 | @end menu |
| 34777 | |
| 34778 | @node File-I/O Overview |
| 34779 | @subsection File-I/O Overview |
| 34780 | @cindex file-i/o overview |
| 34781 | |
| 34782 | The @dfn{File I/O remote protocol extension} (short: File-I/O) allows the |
| 34783 | target to use the host's file system and console I/O to perform various |
| 34784 | system calls. System calls on the target system are translated into a |
| 34785 | remote protocol packet to the host system, which then performs the needed |
| 34786 | actions and returns a response packet to the target system. |
| 34787 | This simulates file system operations even on targets that lack file systems. |
| 34788 | |
| 34789 | The protocol is defined to be independent of both the host and target systems. |
| 34790 | It uses its own internal representation of datatypes and values. Both |
| 34791 | @value{GDBN} and the target's @value{GDBN} stub are responsible for |
| 34792 | translating the system-dependent value representations into the internal |
| 34793 | protocol representations when data is transmitted. |
| 34794 | |
| 34795 | The communication is synchronous. A system call is possible only when |
| 34796 | @value{GDBN} is waiting for a response from the @samp{C}, @samp{c}, @samp{S} |
| 34797 | or @samp{s} packets. While @value{GDBN} handles the request for a system call, |
| 34798 | the target is stopped to allow deterministic access to the target's |
| 34799 | memory. Therefore File-I/O is not interruptible by target signals. On |
| 34800 | the other hand, it is possible to interrupt File-I/O by a user interrupt |
| 34801 | (@samp{Ctrl-C}) within @value{GDBN}. |
| 34802 | |
| 34803 | The target's request to perform a host system call does not finish |
| 34804 | the latest @samp{C}, @samp{c}, @samp{S} or @samp{s} action. That means, |
| 34805 | after finishing the system call, the target returns to continuing the |
| 34806 | previous activity (continue, step). No additional continue or step |
| 34807 | request from @value{GDBN} is required. |
| 34808 | |
| 34809 | @smallexample |
| 34810 | (@value{GDBP}) continue |
| 34811 | <- target requests 'system call X' |
| 34812 | target is stopped, @value{GDBN} executes system call |
| 34813 | -> @value{GDBN} returns result |
| 34814 | ... target continues, @value{GDBN} returns to wait for the target |
| 34815 | <- target hits breakpoint and sends a Txx packet |
| 34816 | @end smallexample |
| 34817 | |
| 34818 | The protocol only supports I/O on the console and to regular files on |
| 34819 | the host file system. Character or block special devices, pipes, |
| 34820 | named pipes, sockets or any other communication method on the host |
| 34821 | system are not supported by this protocol. |
| 34822 | |
| 34823 | File I/O is not supported in non-stop mode. |
| 34824 | |
| 34825 | @node Protocol Basics |
| 34826 | @subsection Protocol Basics |
| 34827 | @cindex protocol basics, file-i/o |
| 34828 | |
| 34829 | The File-I/O protocol uses the @code{F} packet as the request as well |
| 34830 | as reply packet. Since a File-I/O system call can only occur when |
| 34831 | @value{GDBN} is waiting for a response from the continuing or stepping target, |
| 34832 | the File-I/O request is a reply that @value{GDBN} has to expect as a result |
| 34833 | of a previous @samp{C}, @samp{c}, @samp{S} or @samp{s} packet. |
| 34834 | This @code{F} packet contains all information needed to allow @value{GDBN} |
| 34835 | to call the appropriate host system call: |
| 34836 | |
| 34837 | @itemize @bullet |
| 34838 | @item |
| 34839 | A unique identifier for the requested system call. |
| 34840 | |
| 34841 | @item |
| 34842 | All parameters to the system call. Pointers are given as addresses |
| 34843 | in the target memory address space. Pointers to strings are given as |
| 34844 | pointer/length pair. Numerical values are given as they are. |
| 34845 | Numerical control flags are given in a protocol-specific representation. |
| 34846 | |
| 34847 | @end itemize |
| 34848 | |
| 34849 | At this point, @value{GDBN} has to perform the following actions. |
| 34850 | |
| 34851 | @itemize @bullet |
| 34852 | @item |
| 34853 | If the parameters include pointer values to data needed as input to a |
| 34854 | system call, @value{GDBN} requests this data from the target with a |
| 34855 | standard @code{m} packet request. This additional communication has to be |
| 34856 | expected by the target implementation and is handled as any other @code{m} |
| 34857 | packet. |
| 34858 | |
| 34859 | @item |
| 34860 | @value{GDBN} translates all value from protocol representation to host |
| 34861 | representation as needed. Datatypes are coerced into the host types. |
| 34862 | |
| 34863 | @item |
| 34864 | @value{GDBN} calls the system call. |
| 34865 | |
| 34866 | @item |
| 34867 | It then coerces datatypes back to protocol representation. |
| 34868 | |
| 34869 | @item |
| 34870 | If the system call is expected to return data in buffer space specified |
| 34871 | by pointer parameters to the call, the data is transmitted to the |
| 34872 | target using a @code{M} or @code{X} packet. This packet has to be expected |
| 34873 | by the target implementation and is handled as any other @code{M} or @code{X} |
| 34874 | packet. |
| 34875 | |
| 34876 | @end itemize |
| 34877 | |
| 34878 | Eventually @value{GDBN} replies with another @code{F} packet which contains all |
| 34879 | necessary information for the target to continue. This at least contains |
| 34880 | |
| 34881 | @itemize @bullet |
| 34882 | @item |
| 34883 | Return value. |
| 34884 | |
| 34885 | @item |
| 34886 | @code{errno}, if has been changed by the system call. |
| 34887 | |
| 34888 | @item |
| 34889 | ``Ctrl-C'' flag. |
| 34890 | |
| 34891 | @end itemize |
| 34892 | |
| 34893 | After having done the needed type and value coercion, the target continues |
| 34894 | the latest continue or step action. |
| 34895 | |
| 34896 | @node The F Request Packet |
| 34897 | @subsection The @code{F} Request Packet |
| 34898 | @cindex file-i/o request packet |
| 34899 | @cindex @code{F} request packet |
| 34900 | |
| 34901 | The @code{F} request packet has the following format: |
| 34902 | |
| 34903 | @table @samp |
| 34904 | @item F@var{call-id},@var{parameter@dots{}} |
| 34905 | |
| 34906 | @var{call-id} is the identifier to indicate the host system call to be called. |
| 34907 | This is just the name of the function. |
| 34908 | |
| 34909 | @var{parameter@dots{}} are the parameters to the system call. |
| 34910 | Parameters are hexadecimal integer values, either the actual values in case |
| 34911 | of scalar datatypes, pointers to target buffer space in case of compound |
| 34912 | datatypes and unspecified memory areas, or pointer/length pairs in case |
| 34913 | of string parameters. These are appended to the @var{call-id} as a |
| 34914 | comma-delimited list. All values are transmitted in ASCII |
| 34915 | string representation, pointer/length pairs separated by a slash. |
| 34916 | |
| 34917 | @end table |
| 34918 | |
| 34919 | |
| 34920 | |
| 34921 | @node The F Reply Packet |
| 34922 | @subsection The @code{F} Reply Packet |
| 34923 | @cindex file-i/o reply packet |
| 34924 | @cindex @code{F} reply packet |
| 34925 | |
| 34926 | The @code{F} reply packet has the following format: |
| 34927 | |
| 34928 | @table @samp |
| 34929 | |
| 34930 | @item F@var{retcode},@var{errno},@var{Ctrl-C flag};@var{call-specific attachment} |
| 34931 | |
| 34932 | @var{retcode} is the return code of the system call as hexadecimal value. |
| 34933 | |
| 34934 | @var{errno} is the @code{errno} set by the call, in protocol-specific |
| 34935 | representation. |
| 34936 | This parameter can be omitted if the call was successful. |
| 34937 | |
| 34938 | @var{Ctrl-C flag} is only sent if the user requested a break. In this |
| 34939 | case, @var{errno} must be sent as well, even if the call was successful. |
| 34940 | The @var{Ctrl-C flag} itself consists of the character @samp{C}: |
| 34941 | |
| 34942 | @smallexample |
| 34943 | F0,0,C |
| 34944 | @end smallexample |
| 34945 | |
| 34946 | @noindent |
| 34947 | or, if the call was interrupted before the host call has been performed: |
| 34948 | |
| 34949 | @smallexample |
| 34950 | F-1,4,C |
| 34951 | @end smallexample |
| 34952 | |
| 34953 | @noindent |
| 34954 | assuming 4 is the protocol-specific representation of @code{EINTR}. |
| 34955 | |
| 34956 | @end table |
| 34957 | |
| 34958 | |
| 34959 | @node The Ctrl-C Message |
| 34960 | @subsection The @samp{Ctrl-C} Message |
| 34961 | @cindex ctrl-c message, in file-i/o protocol |
| 34962 | |
| 34963 | If the @samp{Ctrl-C} flag is set in the @value{GDBN} |
| 34964 | reply packet (@pxref{The F Reply Packet}), |
| 34965 | the target should behave as if it had |
| 34966 | gotten a break message. The meaning for the target is ``system call |
| 34967 | interrupted by @code{SIGINT}''. Consequentially, the target should actually stop |
| 34968 | (as with a break message) and return to @value{GDBN} with a @code{T02} |
| 34969 | packet. |
| 34970 | |
| 34971 | It's important for the target to know in which |
| 34972 | state the system call was interrupted. There are two possible cases: |
| 34973 | |
| 34974 | @itemize @bullet |
| 34975 | @item |
| 34976 | The system call hasn't been performed on the host yet. |
| 34977 | |
| 34978 | @item |
| 34979 | The system call on the host has been finished. |
| 34980 | |
| 34981 | @end itemize |
| 34982 | |
| 34983 | These two states can be distinguished by the target by the value of the |
| 34984 | returned @code{errno}. If it's the protocol representation of @code{EINTR}, the system |
| 34985 | call hasn't been performed. This is equivalent to the @code{EINTR} handling |
| 34986 | on POSIX systems. In any other case, the target may presume that the |
| 34987 | system call has been finished --- successfully or not --- and should behave |
| 34988 | as if the break message arrived right after the system call. |
| 34989 | |
| 34990 | @value{GDBN} must behave reliably. If the system call has not been called |
| 34991 | yet, @value{GDBN} may send the @code{F} reply immediately, setting @code{EINTR} as |
| 34992 | @code{errno} in the packet. If the system call on the host has been finished |
| 34993 | before the user requests a break, the full action must be finished by |
| 34994 | @value{GDBN}. This requires sending @code{M} or @code{X} packets as necessary. |
| 34995 | The @code{F} packet may only be sent when either nothing has happened |
| 34996 | or the full action has been completed. |
| 34997 | |
| 34998 | @node Console I/O |
| 34999 | @subsection Console I/O |
| 35000 | @cindex console i/o as part of file-i/o |
| 35001 | |
| 35002 | By default and if not explicitly closed by the target system, the file |
| 35003 | descriptors 0, 1 and 2 are connected to the @value{GDBN} console. Output |
| 35004 | on the @value{GDBN} console is handled as any other file output operation |
| 35005 | (@code{write(1, @dots{})} or @code{write(2, @dots{})}). Console input is handled |
| 35006 | by @value{GDBN} so that after the target read request from file descriptor |
| 35007 | 0 all following typing is buffered until either one of the following |
| 35008 | conditions is met: |
| 35009 | |
| 35010 | @itemize @bullet |
| 35011 | @item |
| 35012 | The user types @kbd{Ctrl-c}. The behaviour is as explained above, and the |
| 35013 | @code{read} |
| 35014 | system call is treated as finished. |
| 35015 | |
| 35016 | @item |
| 35017 | The user presses @key{RET}. This is treated as end of input with a trailing |
| 35018 | newline. |
| 35019 | |
| 35020 | @item |
| 35021 | The user types @kbd{Ctrl-d}. This is treated as end of input. No trailing |
| 35022 | character (neither newline nor @samp{Ctrl-D}) is appended to the input. |
| 35023 | |
| 35024 | @end itemize |
| 35025 | |
| 35026 | If the user has typed more characters than fit in the buffer given to |
| 35027 | the @code{read} call, the trailing characters are buffered in @value{GDBN} until |
| 35028 | either another @code{read(0, @dots{})} is requested by the target, or debugging |
| 35029 | is stopped at the user's request. |
| 35030 | |
| 35031 | |
| 35032 | @node List of Supported Calls |
| 35033 | @subsection List of Supported Calls |
| 35034 | @cindex list of supported file-i/o calls |
| 35035 | |
| 35036 | @menu |
| 35037 | * open:: |
| 35038 | * close:: |
| 35039 | * read:: |
| 35040 | * write:: |
| 35041 | * lseek:: |
| 35042 | * rename:: |
| 35043 | * unlink:: |
| 35044 | * stat/fstat:: |
| 35045 | * gettimeofday:: |
| 35046 | * isatty:: |
| 35047 | * system:: |
| 35048 | @end menu |
| 35049 | |
| 35050 | @node open |
| 35051 | @unnumberedsubsubsec open |
| 35052 | @cindex open, file-i/o system call |
| 35053 | |
| 35054 | @table @asis |
| 35055 | @item Synopsis: |
| 35056 | @smallexample |
| 35057 | int open(const char *pathname, int flags); |
| 35058 | int open(const char *pathname, int flags, mode_t mode); |
| 35059 | @end smallexample |
| 35060 | |
| 35061 | @item Request: |
| 35062 | @samp{Fopen,@var{pathptr}/@var{len},@var{flags},@var{mode}} |
| 35063 | |
| 35064 | @noindent |
| 35065 | @var{flags} is the bitwise @code{OR} of the following values: |
| 35066 | |
| 35067 | @table @code |
| 35068 | @item O_CREAT |
| 35069 | If the file does not exist it will be created. The host |
| 35070 | rules apply as far as file ownership and time stamps |
| 35071 | are concerned. |
| 35072 | |
| 35073 | @item O_EXCL |
| 35074 | When used with @code{O_CREAT}, if the file already exists it is |
| 35075 | an error and open() fails. |
| 35076 | |
| 35077 | @item O_TRUNC |
| 35078 | If the file already exists and the open mode allows |
| 35079 | writing (@code{O_RDWR} or @code{O_WRONLY} is given) it will be |
| 35080 | truncated to zero length. |
| 35081 | |
| 35082 | @item O_APPEND |
| 35083 | The file is opened in append mode. |
| 35084 | |
| 35085 | @item O_RDONLY |
| 35086 | The file is opened for reading only. |
| 35087 | |
| 35088 | @item O_WRONLY |
| 35089 | The file is opened for writing only. |
| 35090 | |
| 35091 | @item O_RDWR |
| 35092 | The file is opened for reading and writing. |
| 35093 | @end table |
| 35094 | |
| 35095 | @noindent |
| 35096 | Other bits are silently ignored. |
| 35097 | |
| 35098 | |
| 35099 | @noindent |
| 35100 | @var{mode} is the bitwise @code{OR} of the following values: |
| 35101 | |
| 35102 | @table @code |
| 35103 | @item S_IRUSR |
| 35104 | User has read permission. |
| 35105 | |
| 35106 | @item S_IWUSR |
| 35107 | User has write permission. |
| 35108 | |
| 35109 | @item S_IRGRP |
| 35110 | Group has read permission. |
| 35111 | |
| 35112 | @item S_IWGRP |
| 35113 | Group has write permission. |
| 35114 | |
| 35115 | @item S_IROTH |
| 35116 | Others have read permission. |
| 35117 | |
| 35118 | @item S_IWOTH |
| 35119 | Others have write permission. |
| 35120 | @end table |
| 35121 | |
| 35122 | @noindent |
| 35123 | Other bits are silently ignored. |
| 35124 | |
| 35125 | |
| 35126 | @item Return value: |
| 35127 | @code{open} returns the new file descriptor or -1 if an error |
| 35128 | occurred. |
| 35129 | |
| 35130 | @item Errors: |
| 35131 | |
| 35132 | @table @code |
| 35133 | @item EEXIST |
| 35134 | @var{pathname} already exists and @code{O_CREAT} and @code{O_EXCL} were used. |
| 35135 | |
| 35136 | @item EISDIR |
| 35137 | @var{pathname} refers to a directory. |
| 35138 | |
| 35139 | @item EACCES |
| 35140 | The requested access is not allowed. |
| 35141 | |
| 35142 | @item ENAMETOOLONG |
| 35143 | @var{pathname} was too long. |
| 35144 | |
| 35145 | @item ENOENT |
| 35146 | A directory component in @var{pathname} does not exist. |
| 35147 | |
| 35148 | @item ENODEV |
| 35149 | @var{pathname} refers to a device, pipe, named pipe or socket. |
| 35150 | |
| 35151 | @item EROFS |
| 35152 | @var{pathname} refers to a file on a read-only filesystem and |
| 35153 | write access was requested. |
| 35154 | |
| 35155 | @item EFAULT |
| 35156 | @var{pathname} is an invalid pointer value. |
| 35157 | |
| 35158 | @item ENOSPC |
| 35159 | No space on device to create the file. |
| 35160 | |
| 35161 | @item EMFILE |
| 35162 | The process already has the maximum number of files open. |
| 35163 | |
| 35164 | @item ENFILE |
| 35165 | The limit on the total number of files open on the system |
| 35166 | has been reached. |
| 35167 | |
| 35168 | @item EINTR |
| 35169 | The call was interrupted by the user. |
| 35170 | @end table |
| 35171 | |
| 35172 | @end table |
| 35173 | |
| 35174 | @node close |
| 35175 | @unnumberedsubsubsec close |
| 35176 | @cindex close, file-i/o system call |
| 35177 | |
| 35178 | @table @asis |
| 35179 | @item Synopsis: |
| 35180 | @smallexample |
| 35181 | int close(int fd); |
| 35182 | @end smallexample |
| 35183 | |
| 35184 | @item Request: |
| 35185 | @samp{Fclose,@var{fd}} |
| 35186 | |
| 35187 | @item Return value: |
| 35188 | @code{close} returns zero on success, or -1 if an error occurred. |
| 35189 | |
| 35190 | @item Errors: |
| 35191 | |
| 35192 | @table @code |
| 35193 | @item EBADF |
| 35194 | @var{fd} isn't a valid open file descriptor. |
| 35195 | |
| 35196 | @item EINTR |
| 35197 | The call was interrupted by the user. |
| 35198 | @end table |
| 35199 | |
| 35200 | @end table |
| 35201 | |
| 35202 | @node read |
| 35203 | @unnumberedsubsubsec read |
| 35204 | @cindex read, file-i/o system call |
| 35205 | |
| 35206 | @table @asis |
| 35207 | @item Synopsis: |
| 35208 | @smallexample |
| 35209 | int read(int fd, void *buf, unsigned int count); |
| 35210 | @end smallexample |
| 35211 | |
| 35212 | @item Request: |
| 35213 | @samp{Fread,@var{fd},@var{bufptr},@var{count}} |
| 35214 | |
| 35215 | @item Return value: |
| 35216 | On success, the number of bytes read is returned. |
| 35217 | Zero indicates end of file. If count is zero, read |
| 35218 | returns zero as well. On error, -1 is returned. |
| 35219 | |
| 35220 | @item Errors: |
| 35221 | |
| 35222 | @table @code |
| 35223 | @item EBADF |
| 35224 | @var{fd} is not a valid file descriptor or is not open for |
| 35225 | reading. |
| 35226 | |
| 35227 | @item EFAULT |
| 35228 | @var{bufptr} is an invalid pointer value. |
| 35229 | |
| 35230 | @item EINTR |
| 35231 | The call was interrupted by the user. |
| 35232 | @end table |
| 35233 | |
| 35234 | @end table |
| 35235 | |
| 35236 | @node write |
| 35237 | @unnumberedsubsubsec write |
| 35238 | @cindex write, file-i/o system call |
| 35239 | |
| 35240 | @table @asis |
| 35241 | @item Synopsis: |
| 35242 | @smallexample |
| 35243 | int write(int fd, const void *buf, unsigned int count); |
| 35244 | @end smallexample |
| 35245 | |
| 35246 | @item Request: |
| 35247 | @samp{Fwrite,@var{fd},@var{bufptr},@var{count}} |
| 35248 | |
| 35249 | @item Return value: |
| 35250 | On success, the number of bytes written are returned. |
| 35251 | Zero indicates nothing was written. On error, -1 |
| 35252 | is returned. |
| 35253 | |
| 35254 | @item Errors: |
| 35255 | |
| 35256 | @table @code |
| 35257 | @item EBADF |
| 35258 | @var{fd} is not a valid file descriptor or is not open for |
| 35259 | writing. |
| 35260 | |
| 35261 | @item EFAULT |
| 35262 | @var{bufptr} is an invalid pointer value. |
| 35263 | |
| 35264 | @item EFBIG |
| 35265 | An attempt was made to write a file that exceeds the |
| 35266 | host-specific maximum file size allowed. |
| 35267 | |
| 35268 | @item ENOSPC |
| 35269 | No space on device to write the data. |
| 35270 | |
| 35271 | @item EINTR |
| 35272 | The call was interrupted by the user. |
| 35273 | @end table |
| 35274 | |
| 35275 | @end table |
| 35276 | |
| 35277 | @node lseek |
| 35278 | @unnumberedsubsubsec lseek |
| 35279 | @cindex lseek, file-i/o system call |
| 35280 | |
| 35281 | @table @asis |
| 35282 | @item Synopsis: |
| 35283 | @smallexample |
| 35284 | long lseek (int fd, long offset, int flag); |
| 35285 | @end smallexample |
| 35286 | |
| 35287 | @item Request: |
| 35288 | @samp{Flseek,@var{fd},@var{offset},@var{flag}} |
| 35289 | |
| 35290 | @var{flag} is one of: |
| 35291 | |
| 35292 | @table @code |
| 35293 | @item SEEK_SET |
| 35294 | The offset is set to @var{offset} bytes. |
| 35295 | |
| 35296 | @item SEEK_CUR |
| 35297 | The offset is set to its current location plus @var{offset} |
| 35298 | bytes. |
| 35299 | |
| 35300 | @item SEEK_END |
| 35301 | The offset is set to the size of the file plus @var{offset} |
| 35302 | bytes. |
| 35303 | @end table |
| 35304 | |
| 35305 | @item Return value: |
| 35306 | On success, the resulting unsigned offset in bytes from |
| 35307 | the beginning of the file is returned. Otherwise, a |
| 35308 | value of -1 is returned. |
| 35309 | |
| 35310 | @item Errors: |
| 35311 | |
| 35312 | @table @code |
| 35313 | @item EBADF |
| 35314 | @var{fd} is not a valid open file descriptor. |
| 35315 | |
| 35316 | @item ESPIPE |
| 35317 | @var{fd} is associated with the @value{GDBN} console. |
| 35318 | |
| 35319 | @item EINVAL |
| 35320 | @var{flag} is not a proper value. |
| 35321 | |
| 35322 | @item EINTR |
| 35323 | The call was interrupted by the user. |
| 35324 | @end table |
| 35325 | |
| 35326 | @end table |
| 35327 | |
| 35328 | @node rename |
| 35329 | @unnumberedsubsubsec rename |
| 35330 | @cindex rename, file-i/o system call |
| 35331 | |
| 35332 | @table @asis |
| 35333 | @item Synopsis: |
| 35334 | @smallexample |
| 35335 | int rename(const char *oldpath, const char *newpath); |
| 35336 | @end smallexample |
| 35337 | |
| 35338 | @item Request: |
| 35339 | @samp{Frename,@var{oldpathptr}/@var{len},@var{newpathptr}/@var{len}} |
| 35340 | |
| 35341 | @item Return value: |
| 35342 | On success, zero is returned. On error, -1 is returned. |
| 35343 | |
| 35344 | @item Errors: |
| 35345 | |
| 35346 | @table @code |
| 35347 | @item EISDIR |
| 35348 | @var{newpath} is an existing directory, but @var{oldpath} is not a |
| 35349 | directory. |
| 35350 | |
| 35351 | @item EEXIST |
| 35352 | @var{newpath} is a non-empty directory. |
| 35353 | |
| 35354 | @item EBUSY |
| 35355 | @var{oldpath} or @var{newpath} is a directory that is in use by some |
| 35356 | process. |
| 35357 | |
| 35358 | @item EINVAL |
| 35359 | An attempt was made to make a directory a subdirectory |
| 35360 | of itself. |
| 35361 | |
| 35362 | @item ENOTDIR |
| 35363 | A component used as a directory in @var{oldpath} or new |
| 35364 | path is not a directory. Or @var{oldpath} is a directory |
| 35365 | and @var{newpath} exists but is not a directory. |
| 35366 | |
| 35367 | @item EFAULT |
| 35368 | @var{oldpathptr} or @var{newpathptr} are invalid pointer values. |
| 35369 | |
| 35370 | @item EACCES |
| 35371 | No access to the file or the path of the file. |
| 35372 | |
| 35373 | @item ENAMETOOLONG |
| 35374 | |
| 35375 | @var{oldpath} or @var{newpath} was too long. |
| 35376 | |
| 35377 | @item ENOENT |
| 35378 | A directory component in @var{oldpath} or @var{newpath} does not exist. |
| 35379 | |
| 35380 | @item EROFS |
| 35381 | The file is on a read-only filesystem. |
| 35382 | |
| 35383 | @item ENOSPC |
| 35384 | The device containing the file has no room for the new |
| 35385 | directory entry. |
| 35386 | |
| 35387 | @item EINTR |
| 35388 | The call was interrupted by the user. |
| 35389 | @end table |
| 35390 | |
| 35391 | @end table |
| 35392 | |
| 35393 | @node unlink |
| 35394 | @unnumberedsubsubsec unlink |
| 35395 | @cindex unlink, file-i/o system call |
| 35396 | |
| 35397 | @table @asis |
| 35398 | @item Synopsis: |
| 35399 | @smallexample |
| 35400 | int unlink(const char *pathname); |
| 35401 | @end smallexample |
| 35402 | |
| 35403 | @item Request: |
| 35404 | @samp{Funlink,@var{pathnameptr}/@var{len}} |
| 35405 | |
| 35406 | @item Return value: |
| 35407 | On success, zero is returned. On error, -1 is returned. |
| 35408 | |
| 35409 | @item Errors: |
| 35410 | |
| 35411 | @table @code |
| 35412 | @item EACCES |
| 35413 | No access to the file or the path of the file. |
| 35414 | |
| 35415 | @item EPERM |
| 35416 | The system does not allow unlinking of directories. |
| 35417 | |
| 35418 | @item EBUSY |
| 35419 | The file @var{pathname} cannot be unlinked because it's |
| 35420 | being used by another process. |
| 35421 | |
| 35422 | @item EFAULT |
| 35423 | @var{pathnameptr} is an invalid pointer value. |
| 35424 | |
| 35425 | @item ENAMETOOLONG |
| 35426 | @var{pathname} was too long. |
| 35427 | |
| 35428 | @item ENOENT |
| 35429 | A directory component in @var{pathname} does not exist. |
| 35430 | |
| 35431 | @item ENOTDIR |
| 35432 | A component of the path is not a directory. |
| 35433 | |
| 35434 | @item EROFS |
| 35435 | The file is on a read-only filesystem. |
| 35436 | |
| 35437 | @item EINTR |
| 35438 | The call was interrupted by the user. |
| 35439 | @end table |
| 35440 | |
| 35441 | @end table |
| 35442 | |
| 35443 | @node stat/fstat |
| 35444 | @unnumberedsubsubsec stat/fstat |
| 35445 | @cindex fstat, file-i/o system call |
| 35446 | @cindex stat, file-i/o system call |
| 35447 | |
| 35448 | @table @asis |
| 35449 | @item Synopsis: |
| 35450 | @smallexample |
| 35451 | int stat(const char *pathname, struct stat *buf); |
| 35452 | int fstat(int fd, struct stat *buf); |
| 35453 | @end smallexample |
| 35454 | |
| 35455 | @item Request: |
| 35456 | @samp{Fstat,@var{pathnameptr}/@var{len},@var{bufptr}}@* |
| 35457 | @samp{Ffstat,@var{fd},@var{bufptr}} |
| 35458 | |
| 35459 | @item Return value: |
| 35460 | On success, zero is returned. On error, -1 is returned. |
| 35461 | |
| 35462 | @item Errors: |
| 35463 | |
| 35464 | @table @code |
| 35465 | @item EBADF |
| 35466 | @var{fd} is not a valid open file. |
| 35467 | |
| 35468 | @item ENOENT |
| 35469 | A directory component in @var{pathname} does not exist or the |
| 35470 | path is an empty string. |
| 35471 | |
| 35472 | @item ENOTDIR |
| 35473 | A component of the path is not a directory. |
| 35474 | |
| 35475 | @item EFAULT |
| 35476 | @var{pathnameptr} is an invalid pointer value. |
| 35477 | |
| 35478 | @item EACCES |
| 35479 | No access to the file or the path of the file. |
| 35480 | |
| 35481 | @item ENAMETOOLONG |
| 35482 | @var{pathname} was too long. |
| 35483 | |
| 35484 | @item EINTR |
| 35485 | The call was interrupted by the user. |
| 35486 | @end table |
| 35487 | |
| 35488 | @end table |
| 35489 | |
| 35490 | @node gettimeofday |
| 35491 | @unnumberedsubsubsec gettimeofday |
| 35492 | @cindex gettimeofday, file-i/o system call |
| 35493 | |
| 35494 | @table @asis |
| 35495 | @item Synopsis: |
| 35496 | @smallexample |
| 35497 | int gettimeofday(struct timeval *tv, void *tz); |
| 35498 | @end smallexample |
| 35499 | |
| 35500 | @item Request: |
| 35501 | @samp{Fgettimeofday,@var{tvptr},@var{tzptr}} |
| 35502 | |
| 35503 | @item Return value: |
| 35504 | On success, 0 is returned, -1 otherwise. |
| 35505 | |
| 35506 | @item Errors: |
| 35507 | |
| 35508 | @table @code |
| 35509 | @item EINVAL |
| 35510 | @var{tz} is a non-NULL pointer. |
| 35511 | |
| 35512 | @item EFAULT |
| 35513 | @var{tvptr} and/or @var{tzptr} is an invalid pointer value. |
| 35514 | @end table |
| 35515 | |
| 35516 | @end table |
| 35517 | |
| 35518 | @node isatty |
| 35519 | @unnumberedsubsubsec isatty |
| 35520 | @cindex isatty, file-i/o system call |
| 35521 | |
| 35522 | @table @asis |
| 35523 | @item Synopsis: |
| 35524 | @smallexample |
| 35525 | int isatty(int fd); |
| 35526 | @end smallexample |
| 35527 | |
| 35528 | @item Request: |
| 35529 | @samp{Fisatty,@var{fd}} |
| 35530 | |
| 35531 | @item Return value: |
| 35532 | Returns 1 if @var{fd} refers to the @value{GDBN} console, 0 otherwise. |
| 35533 | |
| 35534 | @item Errors: |
| 35535 | |
| 35536 | @table @code |
| 35537 | @item EINTR |
| 35538 | The call was interrupted by the user. |
| 35539 | @end table |
| 35540 | |
| 35541 | @end table |
| 35542 | |
| 35543 | Note that the @code{isatty} call is treated as a special case: it returns |
| 35544 | 1 to the target if the file descriptor is attached |
| 35545 | to the @value{GDBN} console, 0 otherwise. Implementing through system calls |
| 35546 | would require implementing @code{ioctl} and would be more complex than |
| 35547 | needed. |
| 35548 | |
| 35549 | |
| 35550 | @node system |
| 35551 | @unnumberedsubsubsec system |
| 35552 | @cindex system, file-i/o system call |
| 35553 | |
| 35554 | @table @asis |
| 35555 | @item Synopsis: |
| 35556 | @smallexample |
| 35557 | int system(const char *command); |
| 35558 | @end smallexample |
| 35559 | |
| 35560 | @item Request: |
| 35561 | @samp{Fsystem,@var{commandptr}/@var{len}} |
| 35562 | |
| 35563 | @item Return value: |
| 35564 | If @var{len} is zero, the return value indicates whether a shell is |
| 35565 | available. A zero return value indicates a shell is not available. |
| 35566 | For non-zero @var{len}, the value returned is -1 on error and the |
| 35567 | return status of the command otherwise. Only the exit status of the |
| 35568 | command is returned, which is extracted from the host's @code{system} |
| 35569 | return value by calling @code{WEXITSTATUS(retval)}. In case |
| 35570 | @file{/bin/sh} could not be executed, 127 is returned. |
| 35571 | |
| 35572 | @item Errors: |
| 35573 | |
| 35574 | @table @code |
| 35575 | @item EINTR |
| 35576 | The call was interrupted by the user. |
| 35577 | @end table |
| 35578 | |
| 35579 | @end table |
| 35580 | |
| 35581 | @value{GDBN} takes over the full task of calling the necessary host calls |
| 35582 | to perform the @code{system} call. The return value of @code{system} on |
| 35583 | the host is simplified before it's returned |
| 35584 | to the target. Any termination signal information from the child process |
| 35585 | is discarded, and the return value consists |
| 35586 | entirely of the exit status of the called command. |
| 35587 | |
| 35588 | Due to security concerns, the @code{system} call is by default refused |
| 35589 | by @value{GDBN}. The user has to allow this call explicitly with the |
| 35590 | @code{set remote system-call-allowed 1} command. |
| 35591 | |
| 35592 | @table @code |
| 35593 | @item set remote system-call-allowed |
| 35594 | @kindex set remote system-call-allowed |
| 35595 | Control whether to allow the @code{system} calls in the File I/O |
| 35596 | protocol for the remote target. The default is zero (disabled). |
| 35597 | |
| 35598 | @item show remote system-call-allowed |
| 35599 | @kindex show remote system-call-allowed |
| 35600 | Show whether the @code{system} calls are allowed in the File I/O |
| 35601 | protocol. |
| 35602 | @end table |
| 35603 | |
| 35604 | @node Protocol-specific Representation of Datatypes |
| 35605 | @subsection Protocol-specific Representation of Datatypes |
| 35606 | @cindex protocol-specific representation of datatypes, in file-i/o protocol |
| 35607 | |
| 35608 | @menu |
| 35609 | * Integral Datatypes:: |
| 35610 | * Pointer Values:: |
| 35611 | * Memory Transfer:: |
| 35612 | * struct stat:: |
| 35613 | * struct timeval:: |
| 35614 | @end menu |
| 35615 | |
| 35616 | @node Integral Datatypes |
| 35617 | @unnumberedsubsubsec Integral Datatypes |
| 35618 | @cindex integral datatypes, in file-i/o protocol |
| 35619 | |
| 35620 | The integral datatypes used in the system calls are @code{int}, |
| 35621 | @code{unsigned int}, @code{long}, @code{unsigned long}, |
| 35622 | @code{mode_t}, and @code{time_t}. |
| 35623 | |
| 35624 | @code{int}, @code{unsigned int}, @code{mode_t} and @code{time_t} are |
| 35625 | implemented as 32 bit values in this protocol. |
| 35626 | |
| 35627 | @code{long} and @code{unsigned long} are implemented as 64 bit types. |
| 35628 | |
| 35629 | @xref{Limits}, for corresponding MIN and MAX values (similar to those |
| 35630 | in @file{limits.h}) to allow range checking on host and target. |
| 35631 | |
| 35632 | @code{time_t} datatypes are defined as seconds since the Epoch. |
| 35633 | |
| 35634 | All integral datatypes transferred as part of a memory read or write of a |
| 35635 | structured datatype e.g.@: a @code{struct stat} have to be given in big endian |
| 35636 | byte order. |
| 35637 | |
| 35638 | @node Pointer Values |
| 35639 | @unnumberedsubsubsec Pointer Values |
| 35640 | @cindex pointer values, in file-i/o protocol |
| 35641 | |
| 35642 | Pointers to target data are transmitted as they are. An exception |
| 35643 | is made for pointers to buffers for which the length isn't |
| 35644 | transmitted as part of the function call, namely strings. Strings |
| 35645 | are transmitted as a pointer/length pair, both as hex values, e.g.@: |
| 35646 | |
| 35647 | @smallexample |
| 35648 | @code{1aaf/12} |
| 35649 | @end smallexample |
| 35650 | |
| 35651 | @noindent |
| 35652 | which is a pointer to data of length 18 bytes at position 0x1aaf. |
| 35653 | The length is defined as the full string length in bytes, including |
| 35654 | the trailing null byte. For example, the string @code{"hello world"} |
| 35655 | at address 0x123456 is transmitted as |
| 35656 | |
| 35657 | @smallexample |
| 35658 | @code{123456/d} |
| 35659 | @end smallexample |
| 35660 | |
| 35661 | @node Memory Transfer |
| 35662 | @unnumberedsubsubsec Memory Transfer |
| 35663 | @cindex memory transfer, in file-i/o protocol |
| 35664 | |
| 35665 | Structured data which is transferred using a memory read or write (for |
| 35666 | example, a @code{struct stat}) is expected to be in a protocol-specific format |
| 35667 | with all scalar multibyte datatypes being big endian. Translation to |
| 35668 | this representation needs to be done both by the target before the @code{F} |
| 35669 | packet is sent, and by @value{GDBN} before |
| 35670 | it transfers memory to the target. Transferred pointers to structured |
| 35671 | data should point to the already-coerced data at any time. |
| 35672 | |
| 35673 | |
| 35674 | @node struct stat |
| 35675 | @unnumberedsubsubsec struct stat |
| 35676 | @cindex struct stat, in file-i/o protocol |
| 35677 | |
| 35678 | The buffer of type @code{struct stat} used by the target and @value{GDBN} |
| 35679 | is defined as follows: |
| 35680 | |
| 35681 | @smallexample |
| 35682 | struct stat @{ |
| 35683 | unsigned int st_dev; /* device */ |
| 35684 | unsigned int st_ino; /* inode */ |
| 35685 | mode_t st_mode; /* protection */ |
| 35686 | unsigned int st_nlink; /* number of hard links */ |
| 35687 | unsigned int st_uid; /* user ID of owner */ |
| 35688 | unsigned int st_gid; /* group ID of owner */ |
| 35689 | unsigned int st_rdev; /* device type (if inode device) */ |
| 35690 | unsigned long st_size; /* total size, in bytes */ |
| 35691 | unsigned long st_blksize; /* blocksize for filesystem I/O */ |
| 35692 | unsigned long st_blocks; /* number of blocks allocated */ |
| 35693 | time_t st_atime; /* time of last access */ |
| 35694 | time_t st_mtime; /* time of last modification */ |
| 35695 | time_t st_ctime; /* time of last change */ |
| 35696 | @}; |
| 35697 | @end smallexample |
| 35698 | |
| 35699 | The integral datatypes conform to the definitions given in the |
| 35700 | appropriate section (see @ref{Integral Datatypes}, for details) so this |
| 35701 | structure is of size 64 bytes. |
| 35702 | |
| 35703 | The values of several fields have a restricted meaning and/or |
| 35704 | range of values. |
| 35705 | |
| 35706 | @table @code |
| 35707 | |
| 35708 | @item st_dev |
| 35709 | A value of 0 represents a file, 1 the console. |
| 35710 | |
| 35711 | @item st_ino |
| 35712 | No valid meaning for the target. Transmitted unchanged. |
| 35713 | |
| 35714 | @item st_mode |
| 35715 | Valid mode bits are described in @ref{Constants}. Any other |
| 35716 | bits have currently no meaning for the target. |
| 35717 | |
| 35718 | @item st_uid |
| 35719 | @itemx st_gid |
| 35720 | @itemx st_rdev |
| 35721 | No valid meaning for the target. Transmitted unchanged. |
| 35722 | |
| 35723 | @item st_atime |
| 35724 | @itemx st_mtime |
| 35725 | @itemx st_ctime |
| 35726 | These values have a host and file system dependent |
| 35727 | accuracy. Especially on Windows hosts, the file system may not |
| 35728 | support exact timing values. |
| 35729 | @end table |
| 35730 | |
| 35731 | The target gets a @code{struct stat} of the above representation and is |
| 35732 | responsible for coercing it to the target representation before |
| 35733 | continuing. |
| 35734 | |
| 35735 | Note that due to size differences between the host, target, and protocol |
| 35736 | representations of @code{struct stat} members, these members could eventually |
| 35737 | get truncated on the target. |
| 35738 | |
| 35739 | @node struct timeval |
| 35740 | @unnumberedsubsubsec struct timeval |
| 35741 | @cindex struct timeval, in file-i/o protocol |
| 35742 | |
| 35743 | The buffer of type @code{struct timeval} used by the File-I/O protocol |
| 35744 | is defined as follows: |
| 35745 | |
| 35746 | @smallexample |
| 35747 | struct timeval @{ |
| 35748 | time_t tv_sec; /* second */ |
| 35749 | long tv_usec; /* microsecond */ |
| 35750 | @}; |
| 35751 | @end smallexample |
| 35752 | |
| 35753 | The integral datatypes conform to the definitions given in the |
| 35754 | appropriate section (see @ref{Integral Datatypes}, for details) so this |
| 35755 | structure is of size 8 bytes. |
| 35756 | |
| 35757 | @node Constants |
| 35758 | @subsection Constants |
| 35759 | @cindex constants, in file-i/o protocol |
| 35760 | |
| 35761 | The following values are used for the constants inside of the |
| 35762 | protocol. @value{GDBN} and target are responsible for translating these |
| 35763 | values before and after the call as needed. |
| 35764 | |
| 35765 | @menu |
| 35766 | * Open Flags:: |
| 35767 | * mode_t Values:: |
| 35768 | * Errno Values:: |
| 35769 | * Lseek Flags:: |
| 35770 | * Limits:: |
| 35771 | @end menu |
| 35772 | |
| 35773 | @node Open Flags |
| 35774 | @unnumberedsubsubsec Open Flags |
| 35775 | @cindex open flags, in file-i/o protocol |
| 35776 | |
| 35777 | All values are given in hexadecimal representation. |
| 35778 | |
| 35779 | @smallexample |
| 35780 | O_RDONLY 0x0 |
| 35781 | O_WRONLY 0x1 |
| 35782 | O_RDWR 0x2 |
| 35783 | O_APPEND 0x8 |
| 35784 | O_CREAT 0x200 |
| 35785 | O_TRUNC 0x400 |
| 35786 | O_EXCL 0x800 |
| 35787 | @end smallexample |
| 35788 | |
| 35789 | @node mode_t Values |
| 35790 | @unnumberedsubsubsec mode_t Values |
| 35791 | @cindex mode_t values, in file-i/o protocol |
| 35792 | |
| 35793 | All values are given in octal representation. |
| 35794 | |
| 35795 | @smallexample |
| 35796 | S_IFREG 0100000 |
| 35797 | S_IFDIR 040000 |
| 35798 | S_IRUSR 0400 |
| 35799 | S_IWUSR 0200 |
| 35800 | S_IXUSR 0100 |
| 35801 | S_IRGRP 040 |
| 35802 | S_IWGRP 020 |
| 35803 | S_IXGRP 010 |
| 35804 | S_IROTH 04 |
| 35805 | S_IWOTH 02 |
| 35806 | S_IXOTH 01 |
| 35807 | @end smallexample |
| 35808 | |
| 35809 | @node Errno Values |
| 35810 | @unnumberedsubsubsec Errno Values |
| 35811 | @cindex errno values, in file-i/o protocol |
| 35812 | |
| 35813 | All values are given in decimal representation. |
| 35814 | |
| 35815 | @smallexample |
| 35816 | EPERM 1 |
| 35817 | ENOENT 2 |
| 35818 | EINTR 4 |
| 35819 | EBADF 9 |
| 35820 | EACCES 13 |
| 35821 | EFAULT 14 |
| 35822 | EBUSY 16 |
| 35823 | EEXIST 17 |
| 35824 | ENODEV 19 |
| 35825 | ENOTDIR 20 |
| 35826 | EISDIR 21 |
| 35827 | EINVAL 22 |
| 35828 | ENFILE 23 |
| 35829 | EMFILE 24 |
| 35830 | EFBIG 27 |
| 35831 | ENOSPC 28 |
| 35832 | ESPIPE 29 |
| 35833 | EROFS 30 |
| 35834 | ENAMETOOLONG 91 |
| 35835 | EUNKNOWN 9999 |
| 35836 | @end smallexample |
| 35837 | |
| 35838 | @code{EUNKNOWN} is used as a fallback error value if a host system returns |
| 35839 | any error value not in the list of supported error numbers. |
| 35840 | |
| 35841 | @node Lseek Flags |
| 35842 | @unnumberedsubsubsec Lseek Flags |
| 35843 | @cindex lseek flags, in file-i/o protocol |
| 35844 | |
| 35845 | @smallexample |
| 35846 | SEEK_SET 0 |
| 35847 | SEEK_CUR 1 |
| 35848 | SEEK_END 2 |
| 35849 | @end smallexample |
| 35850 | |
| 35851 | @node Limits |
| 35852 | @unnumberedsubsubsec Limits |
| 35853 | @cindex limits, in file-i/o protocol |
| 35854 | |
| 35855 | All values are given in decimal representation. |
| 35856 | |
| 35857 | @smallexample |
| 35858 | INT_MIN -2147483648 |
| 35859 | INT_MAX 2147483647 |
| 35860 | UINT_MAX 4294967295 |
| 35861 | LONG_MIN -9223372036854775808 |
| 35862 | LONG_MAX 9223372036854775807 |
| 35863 | ULONG_MAX 18446744073709551615 |
| 35864 | @end smallexample |
| 35865 | |
| 35866 | @node File-I/O Examples |
| 35867 | @subsection File-I/O Examples |
| 35868 | @cindex file-i/o examples |
| 35869 | |
| 35870 | Example sequence of a write call, file descriptor 3, buffer is at target |
| 35871 | address 0x1234, 6 bytes should be written: |
| 35872 | |
| 35873 | @smallexample |
| 35874 | <- @code{Fwrite,3,1234,6} |
| 35875 | @emph{request memory read from target} |
| 35876 | -> @code{m1234,6} |
| 35877 | <- XXXXXX |
| 35878 | @emph{return "6 bytes written"} |
| 35879 | -> @code{F6} |
| 35880 | @end smallexample |
| 35881 | |
| 35882 | Example sequence of a read call, file descriptor 3, buffer is at target |
| 35883 | address 0x1234, 6 bytes should be read: |
| 35884 | |
| 35885 | @smallexample |
| 35886 | <- @code{Fread,3,1234,6} |
| 35887 | @emph{request memory write to target} |
| 35888 | -> @code{X1234,6:XXXXXX} |
| 35889 | @emph{return "6 bytes read"} |
| 35890 | -> @code{F6} |
| 35891 | @end smallexample |
| 35892 | |
| 35893 | Example sequence of a read call, call fails on the host due to invalid |
| 35894 | file descriptor (@code{EBADF}): |
| 35895 | |
| 35896 | @smallexample |
| 35897 | <- @code{Fread,3,1234,6} |
| 35898 | -> @code{F-1,9} |
| 35899 | @end smallexample |
| 35900 | |
| 35901 | Example sequence of a read call, user presses @kbd{Ctrl-c} before syscall on |
| 35902 | host is called: |
| 35903 | |
| 35904 | @smallexample |
| 35905 | <- @code{Fread,3,1234,6} |
| 35906 | -> @code{F-1,4,C} |
| 35907 | <- @code{T02} |
| 35908 | @end smallexample |
| 35909 | |
| 35910 | Example sequence of a read call, user presses @kbd{Ctrl-c} after syscall on |
| 35911 | host is called: |
| 35912 | |
| 35913 | @smallexample |
| 35914 | <- @code{Fread,3,1234,6} |
| 35915 | -> @code{X1234,6:XXXXXX} |
| 35916 | <- @code{T02} |
| 35917 | @end smallexample |
| 35918 | |
| 35919 | @node Library List Format |
| 35920 | @section Library List Format |
| 35921 | @cindex library list format, remote protocol |
| 35922 | |
| 35923 | On some platforms, a dynamic loader (e.g.@: @file{ld.so}) runs in the |
| 35924 | same process as your application to manage libraries. In this case, |
| 35925 | @value{GDBN} can use the loader's symbol table and normal memory |
| 35926 | operations to maintain a list of shared libraries. On other |
| 35927 | platforms, the operating system manages loaded libraries. |
| 35928 | @value{GDBN} can not retrieve the list of currently loaded libraries |
| 35929 | through memory operations, so it uses the @samp{qXfer:libraries:read} |
| 35930 | packet (@pxref{qXfer library list read}) instead. The remote stub |
| 35931 | queries the target's operating system and reports which libraries |
| 35932 | are loaded. |
| 35933 | |
| 35934 | The @samp{qXfer:libraries:read} packet returns an XML document which |
| 35935 | lists loaded libraries and their offsets. Each library has an |
| 35936 | associated name and one or more segment or section base addresses, |
| 35937 | which report where the library was loaded in memory. |
| 35938 | |
| 35939 | For the common case of libraries that are fully linked binaries, the |
| 35940 | library should have a list of segments. If the target supports |
| 35941 | dynamic linking of a relocatable object file, its library XML element |
| 35942 | should instead include a list of allocated sections. The segment or |
| 35943 | section bases are start addresses, not relocation offsets; they do not |
| 35944 | depend on the library's link-time base addresses. |
| 35945 | |
| 35946 | @value{GDBN} must be linked with the Expat library to support XML |
| 35947 | library lists. @xref{Expat}. |
| 35948 | |
| 35949 | A simple memory map, with one loaded library relocated by a single |
| 35950 | offset, looks like this: |
| 35951 | |
| 35952 | @smallexample |
| 35953 | <library-list> |
| 35954 | <library name="/lib/libc.so.6"> |
| 35955 | <segment address="0x10000000"/> |
| 35956 | </library> |
| 35957 | </library-list> |
| 35958 | @end smallexample |
| 35959 | |
| 35960 | Another simple memory map, with one loaded library with three |
| 35961 | allocated sections (.text, .data, .bss), looks like this: |
| 35962 | |
| 35963 | @smallexample |
| 35964 | <library-list> |
| 35965 | <library name="sharedlib.o"> |
| 35966 | <section address="0x10000000"/> |
| 35967 | <section address="0x20000000"/> |
| 35968 | <section address="0x30000000"/> |
| 35969 | </library> |
| 35970 | </library-list> |
| 35971 | @end smallexample |
| 35972 | |
| 35973 | The format of a library list is described by this DTD: |
| 35974 | |
| 35975 | @smallexample |
| 35976 | <!-- library-list: Root element with versioning --> |
| 35977 | <!ELEMENT library-list (library)*> |
| 35978 | <!ATTLIST library-list version CDATA #FIXED "1.0"> |
| 35979 | <!ELEMENT library (segment*, section*)> |
| 35980 | <!ATTLIST library name CDATA #REQUIRED> |
| 35981 | <!ELEMENT segment EMPTY> |
| 35982 | <!ATTLIST segment address CDATA #REQUIRED> |
| 35983 | <!ELEMENT section EMPTY> |
| 35984 | <!ATTLIST section address CDATA #REQUIRED> |
| 35985 | @end smallexample |
| 35986 | |
| 35987 | In addition, segments and section descriptors cannot be mixed within a |
| 35988 | single library element, and you must supply at least one segment or |
| 35989 | section for each library. |
| 35990 | |
| 35991 | @node Memory Map Format |
| 35992 | @section Memory Map Format |
| 35993 | @cindex memory map format |
| 35994 | |
| 35995 | To be able to write into flash memory, @value{GDBN} needs to obtain a |
| 35996 | memory map from the target. This section describes the format of the |
| 35997 | memory map. |
| 35998 | |
| 35999 | The memory map is obtained using the @samp{qXfer:memory-map:read} |
| 36000 | (@pxref{qXfer memory map read}) packet and is an XML document that |
| 36001 | lists memory regions. |
| 36002 | |
| 36003 | @value{GDBN} must be linked with the Expat library to support XML |
| 36004 | memory maps. @xref{Expat}. |
| 36005 | |
| 36006 | The top-level structure of the document is shown below: |
| 36007 | |
| 36008 | @smallexample |
| 36009 | <?xml version="1.0"?> |
| 36010 | <!DOCTYPE memory-map |
| 36011 | PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN" |
| 36012 | "http://sourceware.org/gdb/gdb-memory-map.dtd"> |
| 36013 | <memory-map> |
| 36014 | region... |
| 36015 | </memory-map> |
| 36016 | @end smallexample |
| 36017 | |
| 36018 | Each region can be either: |
| 36019 | |
| 36020 | @itemize |
| 36021 | |
| 36022 | @item |
| 36023 | A region of RAM starting at @var{addr} and extending for @var{length} |
| 36024 | bytes from there: |
| 36025 | |
| 36026 | @smallexample |
| 36027 | <memory type="ram" start="@var{addr}" length="@var{length}"/> |
| 36028 | @end smallexample |
| 36029 | |
| 36030 | |
| 36031 | @item |
| 36032 | A region of read-only memory: |
| 36033 | |
| 36034 | @smallexample |
| 36035 | <memory type="rom" start="@var{addr}" length="@var{length}"/> |
| 36036 | @end smallexample |
| 36037 | |
| 36038 | |
| 36039 | @item |
| 36040 | A region of flash memory, with erasure blocks @var{blocksize} |
| 36041 | bytes in length: |
| 36042 | |
| 36043 | @smallexample |
| 36044 | <memory type="flash" start="@var{addr}" length="@var{length}"> |
| 36045 | <property name="blocksize">@var{blocksize}</property> |
| 36046 | </memory> |
| 36047 | @end smallexample |
| 36048 | |
| 36049 | @end itemize |
| 36050 | |
| 36051 | Regions must not overlap. @value{GDBN} assumes that areas of memory not covered |
| 36052 | by the memory map are RAM, and uses the ordinary @samp{M} and @samp{X} |
| 36053 | packets to write to addresses in such ranges. |
| 36054 | |
| 36055 | The formal DTD for memory map format is given below: |
| 36056 | |
| 36057 | @smallexample |
| 36058 | <!-- ................................................... --> |
| 36059 | <!-- Memory Map XML DTD ................................ --> |
| 36060 | <!-- File: memory-map.dtd .............................. --> |
| 36061 | <!-- .................................... .............. --> |
| 36062 | <!-- memory-map.dtd --> |
| 36063 | <!-- memory-map: Root element with versioning --> |
| 36064 | <!ELEMENT memory-map (memory | property)> |
| 36065 | <!ATTLIST memory-map version CDATA #FIXED "1.0.0"> |
| 36066 | <!ELEMENT memory (property)> |
| 36067 | <!-- memory: Specifies a memory region, |
| 36068 | and its type, or device. --> |
| 36069 | <!ATTLIST memory type CDATA #REQUIRED |
| 36070 | start CDATA #REQUIRED |
| 36071 | length CDATA #REQUIRED |
| 36072 | device CDATA #IMPLIED> |
| 36073 | <!-- property: Generic attribute tag --> |
| 36074 | <!ELEMENT property (#PCDATA | property)*> |
| 36075 | <!ATTLIST property name CDATA #REQUIRED> |
| 36076 | @end smallexample |
| 36077 | |
| 36078 | @node Thread List Format |
| 36079 | @section Thread List Format |
| 36080 | @cindex thread list format |
| 36081 | |
| 36082 | To efficiently update the list of threads and their attributes, |
| 36083 | @value{GDBN} issues the @samp{qXfer:threads:read} packet |
| 36084 | (@pxref{qXfer threads read}) and obtains the XML document with |
| 36085 | the following structure: |
| 36086 | |
| 36087 | @smallexample |
| 36088 | <?xml version="1.0"?> |
| 36089 | <threads> |
| 36090 | <thread id="id" core="0"> |
| 36091 | ... description ... |
| 36092 | </thread> |
| 36093 | </threads> |
| 36094 | @end smallexample |
| 36095 | |
| 36096 | Each @samp{thread} element must have the @samp{id} attribute that |
| 36097 | identifies the thread (@pxref{thread-id syntax}). The |
| 36098 | @samp{core} attribute, if present, specifies which processor core |
| 36099 | the thread was last executing on. The content of the of @samp{thread} |
| 36100 | element is interpreted as human-readable auxilliary information. |
| 36101 | |
| 36102 | @node Traceframe Info Format |
| 36103 | @section Traceframe Info Format |
| 36104 | @cindex traceframe info format |
| 36105 | |
| 36106 | To be able to know which objects in the inferior can be examined when |
| 36107 | inspecting a tracepoint hit, @value{GDBN} needs to obtain the list of |
| 36108 | memory ranges, registers and trace state variables that have been |
| 36109 | collected in a traceframe. |
| 36110 | |
| 36111 | This list is obtained using the @samp{qXfer:traceframe-info:read} |
| 36112 | (@pxref{qXfer traceframe info read}) packet and is an XML document. |
| 36113 | |
| 36114 | @value{GDBN} must be linked with the Expat library to support XML |
| 36115 | traceframe info discovery. @xref{Expat}. |
| 36116 | |
| 36117 | The top-level structure of the document is shown below: |
| 36118 | |
| 36119 | @smallexample |
| 36120 | <?xml version="1.0"?> |
| 36121 | <!DOCTYPE traceframe-info |
| 36122 | PUBLIC "+//IDN gnu.org//DTD GDB Memory Map V1.0//EN" |
| 36123 | "http://sourceware.org/gdb/gdb-traceframe-info.dtd"> |
| 36124 | <traceframe-info> |
| 36125 | block... |
| 36126 | </traceframe-info> |
| 36127 | @end smallexample |
| 36128 | |
| 36129 | Each traceframe block can be either: |
| 36130 | |
| 36131 | @itemize |
| 36132 | |
| 36133 | @item |
| 36134 | A region of collected memory starting at @var{addr} and extending for |
| 36135 | @var{length} bytes from there: |
| 36136 | |
| 36137 | @smallexample |
| 36138 | <memory start="@var{addr}" length="@var{length}"/> |
| 36139 | @end smallexample |
| 36140 | |
| 36141 | @end itemize |
| 36142 | |
| 36143 | The formal DTD for the traceframe info format is given below: |
| 36144 | |
| 36145 | @smallexample |
| 36146 | <!ELEMENT traceframe-info (memory)* > |
| 36147 | <!ATTLIST traceframe-info version CDATA #FIXED "1.0"> |
| 36148 | |
| 36149 | <!ELEMENT memory EMPTY> |
| 36150 | <!ATTLIST memory start CDATA #REQUIRED |
| 36151 | length CDATA #REQUIRED> |
| 36152 | @end smallexample |
| 36153 | |
| 36154 | @include agentexpr.texi |
| 36155 | |
| 36156 | @node Trace File Format |
| 36157 | @appendix Trace File Format |
| 36158 | @cindex trace file format |
| 36159 | |
| 36160 | The trace file comes in three parts: a header, a textual description |
| 36161 | section, and a trace frame section with binary data. |
| 36162 | |
| 36163 | The header has the form @code{\x7fTRACE0\n}. The first byte is |
| 36164 | @code{0x7f} so as to indicate that the file contains binary data, |
| 36165 | while the @code{0} is a version number that may have different values |
| 36166 | in the future. |
| 36167 | |
| 36168 | The description section consists of multiple lines of @sc{ascii} text |
| 36169 | separated by newline characters (@code{0xa}). The lines may include a |
| 36170 | variety of optional descriptive or context-setting information, such |
| 36171 | as tracepoint definitions or register set size. @value{GDBN} will |
| 36172 | ignore any line that it does not recognize. An empty line marks the end |
| 36173 | of this section. |
| 36174 | |
| 36175 | @c FIXME add some specific types of data |
| 36176 | |
| 36177 | The trace frame section consists of a number of consecutive frames. |
| 36178 | Each frame begins with a two-byte tracepoint number, followed by a |
| 36179 | four-byte size giving the amount of data in the frame. The data in |
| 36180 | the frame consists of a number of blocks, each introduced by a |
| 36181 | character indicating its type (at least register, memory, and trace |
| 36182 | state variable). The data in this section is raw binary, not a |
| 36183 | hexadecimal or other encoding; its endianness matches the target's |
| 36184 | endianness. |
| 36185 | |
| 36186 | @c FIXME bi-arch may require endianness/arch info in description section |
| 36187 | |
| 36188 | @table @code |
| 36189 | @item R @var{bytes} |
| 36190 | Register block. The number and ordering of bytes matches that of a |
| 36191 | @code{g} packet in the remote protocol. Note that these are the |
| 36192 | actual bytes, in target order and @value{GDBN} register order, not a |
| 36193 | hexadecimal encoding. |
| 36194 | |
| 36195 | @item M @var{address} @var{length} @var{bytes}... |
| 36196 | Memory block. This is a contiguous block of memory, at the 8-byte |
| 36197 | address @var{address}, with a 2-byte length @var{length}, followed by |
| 36198 | @var{length} bytes. |
| 36199 | |
| 36200 | @item V @var{number} @var{value} |
| 36201 | Trace state variable block. This records the 8-byte signed value |
| 36202 | @var{value} of trace state variable numbered @var{number}. |
| 36203 | |
| 36204 | @end table |
| 36205 | |
| 36206 | Future enhancements of the trace file format may include additional types |
| 36207 | of blocks. |
| 36208 | |
| 36209 | @node Target Descriptions |
| 36210 | @appendix Target Descriptions |
| 36211 | @cindex target descriptions |
| 36212 | |
| 36213 | @strong{Warning:} target descriptions are still under active development, |
| 36214 | and the contents and format may change between @value{GDBN} releases. |
| 36215 | The format is expected to stabilize in the future. |
| 36216 | |
| 36217 | One of the challenges of using @value{GDBN} to debug embedded systems |
| 36218 | is that there are so many minor variants of each processor |
| 36219 | architecture in use. It is common practice for vendors to start with |
| 36220 | a standard processor core --- ARM, PowerPC, or MIPS, for example --- |
| 36221 | and then make changes to adapt it to a particular market niche. Some |
| 36222 | architectures have hundreds of variants, available from dozens of |
| 36223 | vendors. This leads to a number of problems: |
| 36224 | |
| 36225 | @itemize @bullet |
| 36226 | @item |
| 36227 | With so many different customized processors, it is difficult for |
| 36228 | the @value{GDBN} maintainers to keep up with the changes. |
| 36229 | @item |
| 36230 | Since individual variants may have short lifetimes or limited |
| 36231 | audiences, it may not be worthwhile to carry information about every |
| 36232 | variant in the @value{GDBN} source tree. |
| 36233 | @item |
| 36234 | When @value{GDBN} does support the architecture of the embedded system |
| 36235 | at hand, the task of finding the correct architecture name to give the |
| 36236 | @command{set architecture} command can be error-prone. |
| 36237 | @end itemize |
| 36238 | |
| 36239 | To address these problems, the @value{GDBN} remote protocol allows a |
| 36240 | target system to not only identify itself to @value{GDBN}, but to |
| 36241 | actually describe its own features. This lets @value{GDBN} support |
| 36242 | processor variants it has never seen before --- to the extent that the |
| 36243 | descriptions are accurate, and that @value{GDBN} understands them. |
| 36244 | |
| 36245 | @value{GDBN} must be linked with the Expat library to support XML |
| 36246 | target descriptions. @xref{Expat}. |
| 36247 | |
| 36248 | @menu |
| 36249 | * Retrieving Descriptions:: How descriptions are fetched from a target. |
| 36250 | * Target Description Format:: The contents of a target description. |
| 36251 | * Predefined Target Types:: Standard types available for target |
| 36252 | descriptions. |
| 36253 | * Standard Target Features:: Features @value{GDBN} knows about. |
| 36254 | @end menu |
| 36255 | |
| 36256 | @node Retrieving Descriptions |
| 36257 | @section Retrieving Descriptions |
| 36258 | |
| 36259 | Target descriptions can be read from the target automatically, or |
| 36260 | specified by the user manually. The default behavior is to read the |
| 36261 | description from the target. @value{GDBN} retrieves it via the remote |
| 36262 | protocol using @samp{qXfer} requests (@pxref{General Query Packets, |
| 36263 | qXfer}). The @var{annex} in the @samp{qXfer} packet will be |
| 36264 | @samp{target.xml}. The contents of the @samp{target.xml} annex are an |
| 36265 | XML document, of the form described in @ref{Target Description |
| 36266 | Format}. |
| 36267 | |
| 36268 | Alternatively, you can specify a file to read for the target description. |
| 36269 | If a file is set, the target will not be queried. The commands to |
| 36270 | specify a file are: |
| 36271 | |
| 36272 | @table @code |
| 36273 | @cindex set tdesc filename |
| 36274 | @item set tdesc filename @var{path} |
| 36275 | Read the target description from @var{path}. |
| 36276 | |
| 36277 | @cindex unset tdesc filename |
| 36278 | @item unset tdesc filename |
| 36279 | Do not read the XML target description from a file. @value{GDBN} |
| 36280 | will use the description supplied by the current target. |
| 36281 | |
| 36282 | @cindex show tdesc filename |
| 36283 | @item show tdesc filename |
| 36284 | Show the filename to read for a target description, if any. |
| 36285 | @end table |
| 36286 | |
| 36287 | |
| 36288 | @node Target Description Format |
| 36289 | @section Target Description Format |
| 36290 | @cindex target descriptions, XML format |
| 36291 | |
| 36292 | A target description annex is an @uref{http://www.w3.org/XML/, XML} |
| 36293 | document which complies with the Document Type Definition provided in |
| 36294 | the @value{GDBN} sources in @file{gdb/features/gdb-target.dtd}. This |
| 36295 | means you can use generally available tools like @command{xmllint} to |
| 36296 | check that your feature descriptions are well-formed and valid. |
| 36297 | However, to help people unfamiliar with XML write descriptions for |
| 36298 | their targets, we also describe the grammar here. |
| 36299 | |
| 36300 | Target descriptions can identify the architecture of the remote target |
| 36301 | and (for some architectures) provide information about custom register |
| 36302 | sets. They can also identify the OS ABI of the remote target. |
| 36303 | @value{GDBN} can use this information to autoconfigure for your |
| 36304 | target, or to warn you if you connect to an unsupported target. |
| 36305 | |
| 36306 | Here is a simple target description: |
| 36307 | |
| 36308 | @smallexample |
| 36309 | <target version="1.0"> |
| 36310 | <architecture>i386:x86-64</architecture> |
| 36311 | </target> |
| 36312 | @end smallexample |
| 36313 | |
| 36314 | @noindent |
| 36315 | This minimal description only says that the target uses |
| 36316 | the x86-64 architecture. |
| 36317 | |
| 36318 | A target description has the following overall form, with [ ] marking |
| 36319 | optional elements and @dots{} marking repeatable elements. The elements |
| 36320 | are explained further below. |
| 36321 | |
| 36322 | @smallexample |
| 36323 | <?xml version="1.0"?> |
| 36324 | <!DOCTYPE target SYSTEM "gdb-target.dtd"> |
| 36325 | <target version="1.0"> |
| 36326 | @r{[}@var{architecture}@r{]} |
| 36327 | @r{[}@var{osabi}@r{]} |
| 36328 | @r{[}@var{compatible}@r{]} |
| 36329 | @r{[}@var{feature}@dots{}@r{]} |
| 36330 | </target> |
| 36331 | @end smallexample |
| 36332 | |
| 36333 | @noindent |
| 36334 | The description is generally insensitive to whitespace and line |
| 36335 | breaks, under the usual common-sense rules. The XML version |
| 36336 | declaration and document type declaration can generally be omitted |
| 36337 | (@value{GDBN} does not require them), but specifying them may be |
| 36338 | useful for XML validation tools. The @samp{version} attribute for |
| 36339 | @samp{<target>} may also be omitted, but we recommend |
| 36340 | including it; if future versions of @value{GDBN} use an incompatible |
| 36341 | revision of @file{gdb-target.dtd}, they will detect and report |
| 36342 | the version mismatch. |
| 36343 | |
| 36344 | @subsection Inclusion |
| 36345 | @cindex target descriptions, inclusion |
| 36346 | @cindex XInclude |
| 36347 | @ifnotinfo |
| 36348 | @cindex <xi:include> |
| 36349 | @end ifnotinfo |
| 36350 | |
| 36351 | It can sometimes be valuable to split a target description up into |
| 36352 | several different annexes, either for organizational purposes, or to |
| 36353 | share files between different possible target descriptions. You can |
| 36354 | divide a description into multiple files by replacing any element of |
| 36355 | the target description with an inclusion directive of the form: |
| 36356 | |
| 36357 | @smallexample |
| 36358 | <xi:include href="@var{document}"/> |
| 36359 | @end smallexample |
| 36360 | |
| 36361 | @noindent |
| 36362 | When @value{GDBN} encounters an element of this form, it will retrieve |
| 36363 | the named XML @var{document}, and replace the inclusion directive with |
| 36364 | the contents of that document. If the current description was read |
| 36365 | using @samp{qXfer}, then so will be the included document; |
| 36366 | @var{document} will be interpreted as the name of an annex. If the |
| 36367 | current description was read from a file, @value{GDBN} will look for |
| 36368 | @var{document} as a file in the same directory where it found the |
| 36369 | original description. |
| 36370 | |
| 36371 | @subsection Architecture |
| 36372 | @cindex <architecture> |
| 36373 | |
| 36374 | An @samp{<architecture>} element has this form: |
| 36375 | |
| 36376 | @smallexample |
| 36377 | <architecture>@var{arch}</architecture> |
| 36378 | @end smallexample |
| 36379 | |
| 36380 | @var{arch} is one of the architectures from the set accepted by |
| 36381 | @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}). |
| 36382 | |
| 36383 | @subsection OS ABI |
| 36384 | @cindex @code{<osabi>} |
| 36385 | |
| 36386 | This optional field was introduced in @value{GDBN} version 7.0. |
| 36387 | Previous versions of @value{GDBN} ignore it. |
| 36388 | |
| 36389 | An @samp{<osabi>} element has this form: |
| 36390 | |
| 36391 | @smallexample |
| 36392 | <osabi>@var{abi-name}</osabi> |
| 36393 | @end smallexample |
| 36394 | |
| 36395 | @var{abi-name} is an OS ABI name from the same selection accepted by |
| 36396 | @w{@code{set osabi}} (@pxref{ABI, ,Configuring the Current ABI}). |
| 36397 | |
| 36398 | @subsection Compatible Architecture |
| 36399 | @cindex @code{<compatible>} |
| 36400 | |
| 36401 | This optional field was introduced in @value{GDBN} version 7.0. |
| 36402 | Previous versions of @value{GDBN} ignore it. |
| 36403 | |
| 36404 | A @samp{<compatible>} element has this form: |
| 36405 | |
| 36406 | @smallexample |
| 36407 | <compatible>@var{arch}</compatible> |
| 36408 | @end smallexample |
| 36409 | |
| 36410 | @var{arch} is one of the architectures from the set accepted by |
| 36411 | @code{set architecture} (@pxref{Targets, ,Specifying a Debugging Target}). |
| 36412 | |
| 36413 | A @samp{<compatible>} element is used to specify that the target |
| 36414 | is able to run binaries in some other than the main target architecture |
| 36415 | given by the @samp{<architecture>} element. For example, on the |
| 36416 | Cell Broadband Engine, the main architecture is @code{powerpc:common} |
| 36417 | or @code{powerpc:common64}, but the system is able to run binaries |
| 36418 | in the @code{spu} architecture as well. The way to describe this |
| 36419 | capability with @samp{<compatible>} is as follows: |
| 36420 | |
| 36421 | @smallexample |
| 36422 | <architecture>powerpc:common</architecture> |
| 36423 | <compatible>spu</compatible> |
| 36424 | @end smallexample |
| 36425 | |
| 36426 | @subsection Features |
| 36427 | @cindex <feature> |
| 36428 | |
| 36429 | Each @samp{<feature>} describes some logical portion of the target |
| 36430 | system. Features are currently used to describe available CPU |
| 36431 | registers and the types of their contents. A @samp{<feature>} element |
| 36432 | has this form: |
| 36433 | |
| 36434 | @smallexample |
| 36435 | <feature name="@var{name}"> |
| 36436 | @r{[}@var{type}@dots{}@r{]} |
| 36437 | @var{reg}@dots{} |
| 36438 | </feature> |
| 36439 | @end smallexample |
| 36440 | |
| 36441 | @noindent |
| 36442 | Each feature's name should be unique within the description. The name |
| 36443 | of a feature does not matter unless @value{GDBN} has some special |
| 36444 | knowledge of the contents of that feature; if it does, the feature |
| 36445 | should have its standard name. @xref{Standard Target Features}. |
| 36446 | |
| 36447 | @subsection Types |
| 36448 | |
| 36449 | Any register's value is a collection of bits which @value{GDBN} must |
| 36450 | interpret. The default interpretation is a two's complement integer, |
| 36451 | but other types can be requested by name in the register description. |
| 36452 | Some predefined types are provided by @value{GDBN} (@pxref{Predefined |
| 36453 | Target Types}), and the description can define additional composite types. |
| 36454 | |
| 36455 | Each type element must have an @samp{id} attribute, which gives |
| 36456 | a unique (within the containing @samp{<feature>}) name to the type. |
| 36457 | Types must be defined before they are used. |
| 36458 | |
| 36459 | @cindex <vector> |
| 36460 | Some targets offer vector registers, which can be treated as arrays |
| 36461 | of scalar elements. These types are written as @samp{<vector>} elements, |
| 36462 | specifying the array element type, @var{type}, and the number of elements, |
| 36463 | @var{count}: |
| 36464 | |
| 36465 | @smallexample |
| 36466 | <vector id="@var{id}" type="@var{type}" count="@var{count}"/> |
| 36467 | @end smallexample |
| 36468 | |
| 36469 | @cindex <union> |
| 36470 | If a register's value is usefully viewed in multiple ways, define it |
| 36471 | with a union type containing the useful representations. The |
| 36472 | @samp{<union>} element contains one or more @samp{<field>} elements, |
| 36473 | each of which has a @var{name} and a @var{type}: |
| 36474 | |
| 36475 | @smallexample |
| 36476 | <union id="@var{id}"> |
| 36477 | <field name="@var{name}" type="@var{type}"/> |
| 36478 | @dots{} |
| 36479 | </union> |
| 36480 | @end smallexample |
| 36481 | |
| 36482 | @cindex <struct> |
| 36483 | If a register's value is composed from several separate values, define |
| 36484 | it with a structure type. There are two forms of the @samp{<struct>} |
| 36485 | element; a @samp{<struct>} element must either contain only bitfields |
| 36486 | or contain no bitfields. If the structure contains only bitfields, |
| 36487 | its total size in bytes must be specified, each bitfield must have an |
| 36488 | explicit start and end, and bitfields are automatically assigned an |
| 36489 | integer type. The field's @var{start} should be less than or |
| 36490 | equal to its @var{end}, and zero represents the least significant bit. |
| 36491 | |
| 36492 | @smallexample |
| 36493 | <struct id="@var{id}" size="@var{size}"> |
| 36494 | <field name="@var{name}" start="@var{start}" end="@var{end}"/> |
| 36495 | @dots{} |
| 36496 | </struct> |
| 36497 | @end smallexample |
| 36498 | |
| 36499 | If the structure contains no bitfields, then each field has an |
| 36500 | explicit type, and no implicit padding is added. |
| 36501 | |
| 36502 | @smallexample |
| 36503 | <struct id="@var{id}"> |
| 36504 | <field name="@var{name}" type="@var{type}"/> |
| 36505 | @dots{} |
| 36506 | </struct> |
| 36507 | @end smallexample |
| 36508 | |
| 36509 | @cindex <flags> |
| 36510 | If a register's value is a series of single-bit flags, define it with |
| 36511 | a flags type. The @samp{<flags>} element has an explicit @var{size} |
| 36512 | and contains one or more @samp{<field>} elements. Each field has a |
| 36513 | @var{name}, a @var{start}, and an @var{end}. Only single-bit flags |
| 36514 | are supported. |
| 36515 | |
| 36516 | @smallexample |
| 36517 | <flags id="@var{id}" size="@var{size}"> |
| 36518 | <field name="@var{name}" start="@var{start}" end="@var{end}"/> |
| 36519 | @dots{} |
| 36520 | </flags> |
| 36521 | @end smallexample |
| 36522 | |
| 36523 | @subsection Registers |
| 36524 | @cindex <reg> |
| 36525 | |
| 36526 | Each register is represented as an element with this form: |
| 36527 | |
| 36528 | @smallexample |
| 36529 | <reg name="@var{name}" |
| 36530 | bitsize="@var{size}" |
| 36531 | @r{[}regnum="@var{num}"@r{]} |
| 36532 | @r{[}save-restore="@var{save-restore}"@r{]} |
| 36533 | @r{[}type="@var{type}"@r{]} |
| 36534 | @r{[}group="@var{group}"@r{]}/> |
| 36535 | @end smallexample |
| 36536 | |
| 36537 | @noindent |
| 36538 | The components are as follows: |
| 36539 | |
| 36540 | @table @var |
| 36541 | |
| 36542 | @item name |
| 36543 | The register's name; it must be unique within the target description. |
| 36544 | |
| 36545 | @item bitsize |
| 36546 | The register's size, in bits. |
| 36547 | |
| 36548 | @item regnum |
| 36549 | The register's number. If omitted, a register's number is one greater |
| 36550 | than that of the previous register (either in the current feature or in |
| 36551 | a preceeding feature); the first register in the target description |
| 36552 | defaults to zero. This register number is used to read or write |
| 36553 | the register; e.g.@: it is used in the remote @code{p} and @code{P} |
| 36554 | packets, and registers appear in the @code{g} and @code{G} packets |
| 36555 | in order of increasing register number. |
| 36556 | |
| 36557 | @item save-restore |
| 36558 | Whether the register should be preserved across inferior function |
| 36559 | calls; this must be either @code{yes} or @code{no}. The default is |
| 36560 | @code{yes}, which is appropriate for most registers except for |
| 36561 | some system control registers; this is not related to the target's |
| 36562 | ABI. |
| 36563 | |
| 36564 | @item type |
| 36565 | The type of the register. @var{type} may be a predefined type, a type |
| 36566 | defined in the current feature, or one of the special types @code{int} |
| 36567 | and @code{float}. @code{int} is an integer type of the correct size |
| 36568 | for @var{bitsize}, and @code{float} is a floating point type (in the |
| 36569 | architecture's normal floating point format) of the correct size for |
| 36570 | @var{bitsize}. The default is @code{int}. |
| 36571 | |
| 36572 | @item group |
| 36573 | The register group to which this register belongs. @var{group} must |
| 36574 | be either @code{general}, @code{float}, or @code{vector}. If no |
| 36575 | @var{group} is specified, @value{GDBN} will not display the register |
| 36576 | in @code{info registers}. |
| 36577 | |
| 36578 | @end table |
| 36579 | |
| 36580 | @node Predefined Target Types |
| 36581 | @section Predefined Target Types |
| 36582 | @cindex target descriptions, predefined types |
| 36583 | |
| 36584 | Type definitions in the self-description can build up composite types |
| 36585 | from basic building blocks, but can not define fundamental types. Instead, |
| 36586 | standard identifiers are provided by @value{GDBN} for the fundamental |
| 36587 | types. The currently supported types are: |
| 36588 | |
| 36589 | @table @code |
| 36590 | |
| 36591 | @item int8 |
| 36592 | @itemx int16 |
| 36593 | @itemx int32 |
| 36594 | @itemx int64 |
| 36595 | @itemx int128 |
| 36596 | Signed integer types holding the specified number of bits. |
| 36597 | |
| 36598 | @item uint8 |
| 36599 | @itemx uint16 |
| 36600 | @itemx uint32 |
| 36601 | @itemx uint64 |
| 36602 | @itemx uint128 |
| 36603 | Unsigned integer types holding the specified number of bits. |
| 36604 | |
| 36605 | @item code_ptr |
| 36606 | @itemx data_ptr |
| 36607 | Pointers to unspecified code and data. The program counter and |
| 36608 | any dedicated return address register may be marked as code |
| 36609 | pointers; printing a code pointer converts it into a symbolic |
| 36610 | address. The stack pointer and any dedicated address registers |
| 36611 | may be marked as data pointers. |
| 36612 | |
| 36613 | @item ieee_single |
| 36614 | Single precision IEEE floating point. |
| 36615 | |
| 36616 | @item ieee_double |
| 36617 | Double precision IEEE floating point. |
| 36618 | |
| 36619 | @item arm_fpa_ext |
| 36620 | The 12-byte extended precision format used by ARM FPA registers. |
| 36621 | |
| 36622 | @item i387_ext |
| 36623 | The 10-byte extended precision format used by x87 registers. |
| 36624 | |
| 36625 | @item i386_eflags |
| 36626 | 32bit @sc{eflags} register used by x86. |
| 36627 | |
| 36628 | @item i386_mxcsr |
| 36629 | 32bit @sc{mxcsr} register used by x86. |
| 36630 | |
| 36631 | @end table |
| 36632 | |
| 36633 | @node Standard Target Features |
| 36634 | @section Standard Target Features |
| 36635 | @cindex target descriptions, standard features |
| 36636 | |
| 36637 | A target description must contain either no registers or all the |
| 36638 | target's registers. If the description contains no registers, then |
| 36639 | @value{GDBN} will assume a default register layout, selected based on |
| 36640 | the architecture. If the description contains any registers, the |
| 36641 | default layout will not be used; the standard registers must be |
| 36642 | described in the target description, in such a way that @value{GDBN} |
| 36643 | can recognize them. |
| 36644 | |
| 36645 | This is accomplished by giving specific names to feature elements |
| 36646 | which contain standard registers. @value{GDBN} will look for features |
| 36647 | with those names and verify that they contain the expected registers; |
| 36648 | if any known feature is missing required registers, or if any required |
| 36649 | feature is missing, @value{GDBN} will reject the target |
| 36650 | description. You can add additional registers to any of the |
| 36651 | standard features --- @value{GDBN} will display them just as if |
| 36652 | they were added to an unrecognized feature. |
| 36653 | |
| 36654 | This section lists the known features and their expected contents. |
| 36655 | Sample XML documents for these features are included in the |
| 36656 | @value{GDBN} source tree, in the directory @file{gdb/features}. |
| 36657 | |
| 36658 | Names recognized by @value{GDBN} should include the name of the |
| 36659 | company or organization which selected the name, and the overall |
| 36660 | architecture to which the feature applies; so e.g.@: the feature |
| 36661 | containing ARM core registers is named @samp{org.gnu.gdb.arm.core}. |
| 36662 | |
| 36663 | The names of registers are not case sensitive for the purpose |
| 36664 | of recognizing standard features, but @value{GDBN} will only display |
| 36665 | registers using the capitalization used in the description. |
| 36666 | |
| 36667 | @menu |
| 36668 | * ARM Features:: |
| 36669 | * i386 Features:: |
| 36670 | * MIPS Features:: |
| 36671 | * M68K Features:: |
| 36672 | * PowerPC Features:: |
| 36673 | @end menu |
| 36674 | |
| 36675 | |
| 36676 | @node ARM Features |
| 36677 | @subsection ARM Features |
| 36678 | @cindex target descriptions, ARM features |
| 36679 | |
| 36680 | The @samp{org.gnu.gdb.arm.core} feature is required for non-M-profile |
| 36681 | ARM targets. |
| 36682 | It should contain registers @samp{r0} through @samp{r13}, @samp{sp}, |
| 36683 | @samp{lr}, @samp{pc}, and @samp{cpsr}. |
| 36684 | |
| 36685 | For M-profile targets (e.g. Cortex-M3), the @samp{org.gnu.gdb.arm.core} |
| 36686 | feature is replaced by @samp{org.gnu.gdb.arm.m-profile}. It should contain |
| 36687 | registers @samp{r0} through @samp{r13}, @samp{sp}, @samp{lr}, @samp{pc}, |
| 36688 | and @samp{xpsr}. |
| 36689 | |
| 36690 | The @samp{org.gnu.gdb.arm.fpa} feature is optional. If present, it |
| 36691 | should contain registers @samp{f0} through @samp{f7} and @samp{fps}. |
| 36692 | |
| 36693 | The @samp{org.gnu.gdb.xscale.iwmmxt} feature is optional. If present, |
| 36694 | it should contain at least registers @samp{wR0} through @samp{wR15} and |
| 36695 | @samp{wCGR0} through @samp{wCGR3}. The @samp{wCID}, @samp{wCon}, |
| 36696 | @samp{wCSSF}, and @samp{wCASF} registers are optional. |
| 36697 | |
| 36698 | The @samp{org.gnu.gdb.arm.vfp} feature is optional. If present, it |
| 36699 | should contain at least registers @samp{d0} through @samp{d15}. If |
| 36700 | they are present, @samp{d16} through @samp{d31} should also be included. |
| 36701 | @value{GDBN} will synthesize the single-precision registers from |
| 36702 | halves of the double-precision registers. |
| 36703 | |
| 36704 | The @samp{org.gnu.gdb.arm.neon} feature is optional. It does not |
| 36705 | need to contain registers; it instructs @value{GDBN} to display the |
| 36706 | VFP double-precision registers as vectors and to synthesize the |
| 36707 | quad-precision registers from pairs of double-precision registers. |
| 36708 | If this feature is present, @samp{org.gnu.gdb.arm.vfp} must also |
| 36709 | be present and include 32 double-precision registers. |
| 36710 | |
| 36711 | @node i386 Features |
| 36712 | @subsection i386 Features |
| 36713 | @cindex target descriptions, i386 features |
| 36714 | |
| 36715 | The @samp{org.gnu.gdb.i386.core} feature is required for i386/amd64 |
| 36716 | targets. It should describe the following registers: |
| 36717 | |
| 36718 | @itemize @minus |
| 36719 | @item |
| 36720 | @samp{eax} through @samp{edi} plus @samp{eip} for i386 |
| 36721 | @item |
| 36722 | @samp{rax} through @samp{r15} plus @samp{rip} for amd64 |
| 36723 | @item |
| 36724 | @samp{eflags}, @samp{cs}, @samp{ss}, @samp{ds}, @samp{es}, |
| 36725 | @samp{fs}, @samp{gs} |
| 36726 | @item |
| 36727 | @samp{st0} through @samp{st7} |
| 36728 | @item |
| 36729 | @samp{fctrl}, @samp{fstat}, @samp{ftag}, @samp{fiseg}, @samp{fioff}, |
| 36730 | @samp{foseg}, @samp{fooff} and @samp{fop} |
| 36731 | @end itemize |
| 36732 | |
| 36733 | The register sets may be different, depending on the target. |
| 36734 | |
| 36735 | The @samp{org.gnu.gdb.i386.sse} feature is optional. It should |
| 36736 | describe registers: |
| 36737 | |
| 36738 | @itemize @minus |
| 36739 | @item |
| 36740 | @samp{xmm0} through @samp{xmm7} for i386 |
| 36741 | @item |
| 36742 | @samp{xmm0} through @samp{xmm15} for amd64 |
| 36743 | @item |
| 36744 | @samp{mxcsr} |
| 36745 | @end itemize |
| 36746 | |
| 36747 | The @samp{org.gnu.gdb.i386.avx} feature is optional and requires the |
| 36748 | @samp{org.gnu.gdb.i386.sse} feature. It should |
| 36749 | describe the upper 128 bits of @sc{ymm} registers: |
| 36750 | |
| 36751 | @itemize @minus |
| 36752 | @item |
| 36753 | @samp{ymm0h} through @samp{ymm7h} for i386 |
| 36754 | @item |
| 36755 | @samp{ymm0h} through @samp{ymm15h} for amd64 |
| 36756 | @end itemize |
| 36757 | |
| 36758 | The @samp{org.gnu.gdb.i386.linux} feature is optional. It should |
| 36759 | describe a single register, @samp{orig_eax}. |
| 36760 | |
| 36761 | @node MIPS Features |
| 36762 | @subsection MIPS Features |
| 36763 | @cindex target descriptions, MIPS features |
| 36764 | |
| 36765 | The @samp{org.gnu.gdb.mips.cpu} feature is required for MIPS targets. |
| 36766 | It should contain registers @samp{r0} through @samp{r31}, @samp{lo}, |
| 36767 | @samp{hi}, and @samp{pc}. They may be 32-bit or 64-bit depending |
| 36768 | on the target. |
| 36769 | |
| 36770 | The @samp{org.gnu.gdb.mips.cp0} feature is also required. It should |
| 36771 | contain at least the @samp{status}, @samp{badvaddr}, and @samp{cause} |
| 36772 | registers. They may be 32-bit or 64-bit depending on the target. |
| 36773 | |
| 36774 | The @samp{org.gnu.gdb.mips.fpu} feature is currently required, though |
| 36775 | it may be optional in a future version of @value{GDBN}. It should |
| 36776 | contain registers @samp{f0} through @samp{f31}, @samp{fcsr}, and |
| 36777 | @samp{fir}. They may be 32-bit or 64-bit depending on the target. |
| 36778 | |
| 36779 | The @samp{org.gnu.gdb.mips.linux} feature is optional. It should |
| 36780 | contain a single register, @samp{restart}, which is used by the |
| 36781 | Linux kernel to control restartable syscalls. |
| 36782 | |
| 36783 | @node M68K Features |
| 36784 | @subsection M68K Features |
| 36785 | @cindex target descriptions, M68K features |
| 36786 | |
| 36787 | @table @code |
| 36788 | @item @samp{org.gnu.gdb.m68k.core} |
| 36789 | @itemx @samp{org.gnu.gdb.coldfire.core} |
| 36790 | @itemx @samp{org.gnu.gdb.fido.core} |
| 36791 | One of those features must be always present. |
| 36792 | The feature that is present determines which flavor of m68k is |
| 36793 | used. The feature that is present should contain registers |
| 36794 | @samp{d0} through @samp{d7}, @samp{a0} through @samp{a5}, @samp{fp}, |
| 36795 | @samp{sp}, @samp{ps} and @samp{pc}. |
| 36796 | |
| 36797 | @item @samp{org.gnu.gdb.coldfire.fp} |
| 36798 | This feature is optional. If present, it should contain registers |
| 36799 | @samp{fp0} through @samp{fp7}, @samp{fpcontrol}, @samp{fpstatus} and |
| 36800 | @samp{fpiaddr}. |
| 36801 | @end table |
| 36802 | |
| 36803 | @node PowerPC Features |
| 36804 | @subsection PowerPC Features |
| 36805 | @cindex target descriptions, PowerPC features |
| 36806 | |
| 36807 | The @samp{org.gnu.gdb.power.core} feature is required for PowerPC |
| 36808 | targets. It should contain registers @samp{r0} through @samp{r31}, |
| 36809 | @samp{pc}, @samp{msr}, @samp{cr}, @samp{lr}, @samp{ctr}, and |
| 36810 | @samp{xer}. They may be 32-bit or 64-bit depending on the target. |
| 36811 | |
| 36812 | The @samp{org.gnu.gdb.power.fpu} feature is optional. It should |
| 36813 | contain registers @samp{f0} through @samp{f31} and @samp{fpscr}. |
| 36814 | |
| 36815 | The @samp{org.gnu.gdb.power.altivec} feature is optional. It should |
| 36816 | contain registers @samp{vr0} through @samp{vr31}, @samp{vscr}, |
| 36817 | and @samp{vrsave}. |
| 36818 | |
| 36819 | The @samp{org.gnu.gdb.power.vsx} feature is optional. It should |
| 36820 | contain registers @samp{vs0h} through @samp{vs31h}. @value{GDBN} |
| 36821 | will combine these registers with the floating point registers |
| 36822 | (@samp{f0} through @samp{f31}) and the altivec registers (@samp{vr0} |
| 36823 | through @samp{vr31}) to present the 128-bit wide registers @samp{vs0} |
| 36824 | through @samp{vs63}, the set of vector registers for POWER7. |
| 36825 | |
| 36826 | The @samp{org.gnu.gdb.power.spe} feature is optional. It should |
| 36827 | contain registers @samp{ev0h} through @samp{ev31h}, @samp{acc}, and |
| 36828 | @samp{spefscr}. SPE targets should provide 32-bit registers in |
| 36829 | @samp{org.gnu.gdb.power.core} and provide the upper halves in |
| 36830 | @samp{ev0h} through @samp{ev31h}. @value{GDBN} will combine |
| 36831 | these to present registers @samp{ev0} through @samp{ev31} to the |
| 36832 | user. |
| 36833 | |
| 36834 | @node Operating System Information |
| 36835 | @appendix Operating System Information |
| 36836 | @cindex operating system information |
| 36837 | |
| 36838 | @menu |
| 36839 | * Process list:: |
| 36840 | @end menu |
| 36841 | |
| 36842 | Users of @value{GDBN} often wish to obtain information about the state of |
| 36843 | the operating system running on the target---for example the list of |
| 36844 | processes, or the list of open files. This section describes the |
| 36845 | mechanism that makes it possible. This mechanism is similar to the |
| 36846 | target features mechanism (@pxref{Target Descriptions}), but focuses |
| 36847 | on a different aspect of target. |
| 36848 | |
| 36849 | Operating system information is retrived from the target via the |
| 36850 | remote protocol, using @samp{qXfer} requests (@pxref{qXfer osdata |
| 36851 | read}). The object name in the request should be @samp{osdata}, and |
| 36852 | the @var{annex} identifies the data to be fetched. |
| 36853 | |
| 36854 | @node Process list |
| 36855 | @appendixsection Process list |
| 36856 | @cindex operating system information, process list |
| 36857 | |
| 36858 | When requesting the process list, the @var{annex} field in the |
| 36859 | @samp{qXfer} request should be @samp{processes}. The returned data is |
| 36860 | an XML document. The formal syntax of this document is defined in |
| 36861 | @file{gdb/features/osdata.dtd}. |
| 36862 | |
| 36863 | An example document is: |
| 36864 | |
| 36865 | @smallexample |
| 36866 | <?xml version="1.0"?> |
| 36867 | <!DOCTYPE target SYSTEM "osdata.dtd"> |
| 36868 | <osdata type="processes"> |
| 36869 | <item> |
| 36870 | <column name="pid">1</column> |
| 36871 | <column name="user">root</column> |
| 36872 | <column name="command">/sbin/init</column> |
| 36873 | <column name="cores">1,2,3</column> |
| 36874 | </item> |
| 36875 | </osdata> |
| 36876 | @end smallexample |
| 36877 | |
| 36878 | Each item should include a column whose name is @samp{pid}. The value |
| 36879 | of that column should identify the process on the target. The |
| 36880 | @samp{user} and @samp{command} columns are optional, and will be |
| 36881 | displayed by @value{GDBN}. The @samp{cores} column, if present, |
| 36882 | should contain a comma-separated list of cores that this process |
| 36883 | is running on. Target may provide additional columns, |
| 36884 | which @value{GDBN} currently ignores. |
| 36885 | |
| 36886 | @include gpl.texi |
| 36887 | |
| 36888 | @node GNU Free Documentation License |
| 36889 | @appendix GNU Free Documentation License |
| 36890 | @include fdl.texi |
| 36891 | |
| 36892 | @node Index |
| 36893 | @unnumbered Index |
| 36894 | |
| 36895 | @printindex cp |
| 36896 | |
| 36897 | @tex |
| 36898 | % I think something like @colophon should be in texinfo. In the |
| 36899 | % meantime: |
| 36900 | \long\def\colophon{\hbox to0pt{}\vfill |
| 36901 | \centerline{The body of this manual is set in} |
| 36902 | \centerline{\fontname\tenrm,} |
| 36903 | \centerline{with headings in {\bf\fontname\tenbf}} |
| 36904 | \centerline{and examples in {\tt\fontname\tentt}.} |
| 36905 | \centerline{{\it\fontname\tenit\/},} |
| 36906 | \centerline{{\bf\fontname\tenbf}, and} |
| 36907 | \centerline{{\sl\fontname\tensl\/}} |
| 36908 | \centerline{are used for emphasis.}\vfill} |
| 36909 | \page\colophon |
| 36910 | % Blame: doc@cygnus.com, 1991. |
| 36911 | @end tex |
| 36912 | |
| 36913 | @bye |