Debugging with gdb

The gnu Source-Level Debugger Tenth Edition, for gdb version 7.3.50.20111119 (GDB)

Richard Stallman, Roland Pesch, Stan Shebs, et al.

(Send bugs and comments on gdb to http://www.gnu.org/software/gdb/bugs/.) Debugging with gdb TEXinfo 2011-02-14.11

Published by the Free Software Foundation 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA ISBN 978-0-9831592-3-0 Copyright c 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being “Free Software” and “Free Software Needs Free Documentation”, with the Front-Cover Texts being “A GNU Manual,” and with the Back-Cover Texts as in (a) below. (a) The FSF’s Back-Cover Text is: “You are free to copy and modify this GNU Manual. Buying copies from GNU Press supports the FSF in developing GNU and promoting software freedom.”

i

Table of Contents
Summary of gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Free Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Free Software Needs Free Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Contributors to gdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1 2

A Sample gdb Session . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Getting In and Out of gdb . . . . . . . . . . . . . . . . . . . 11
2.1 Invoking gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.1 Choosing Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.2 Choosing Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.1.3 What gdb Does During Startup . . . . . . . . . . . . . . . . . . . . . . . . . . 2.2 Quitting gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.3 Shell Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2.4 Logging Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 12 13 15 16 16 17

3

gdb Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.1 3.2 3.3 Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Command Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

4

Running Programs Under gdb . . . . . . . . . . . . . . . 25
4.1 Compiling for Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2 Starting your Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.3 Your Program’s Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.4 Your Program’s Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.5 Your Program’s Working Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.6 Your Program’s Input and Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.7 Debugging an Already-running Process . . . . . . . . . . . . . . . . . . . . . . . . 4.8 Killing the Child Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.9 Debugging Multiple Inferiors and Programs. . . . . . . . . . . . . . . . . . . . 4.10 Debugging Programs with Multiple Threads . . . . . . . . . . . . . . . . . . 4.11 Debugging Forks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.12 Setting a Bookmark to Return to Later. . . . . . . . . . . . . . . . . . . . . . . 4.12.1 A Non-obvious Benefit of Using Checkpoints . . . . . . . . . . . . . 25 26 28 29 30 30 31 32 32 35 38 40 42

ii

Debugging with gdb

5

Stopping and Continuing . . . . . . . . . . . . . . . . . . . . . 43
5.1 Breakpoints, Watchpoints, and Catchpoints . . . . . . . . . . . . . . . . . . . 5.1.1 Setting Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.2 Setting Watchpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.3 Setting Catchpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.4 Deleting Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.5 Disabling Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.6 Break Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.7 Breakpoint Command Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.8 How to save breakpoints to a file . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.9 “Cannot insert breakpoints” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.1.10 “Breakpoint address adjusted...” . . . . . . . . . . . . . . . . . . . . . . . . 5.2 Continuing and Stepping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.3 Skipping Over Functions and Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.4 Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.5 Stopping and Starting Multi-thread Programs . . . . . . . . . . . . . . . . . 5.5.1 All-Stop Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.5.2 Non-Stop Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.5.3 Background Execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.5.4 Thread-Specific Breakpoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.5.5 Interrupted System Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5.5.6 Observer Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 44 49 52 55 56 57 59 60 60 60 61 64 66 68 68 69 71 72 72 73

6 7 8

Running programs backward . . . . . . . . . . . . . . . . . 75 Recording Inferior’s Execution and Replaying It . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Examining the Stack . . . . . . . . . . . . . . . . . . . . . . . . . . 81
8.1 8.2 8.3 8.4 Stack Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Backtraces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting a Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information About a Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 82 84 85

9

Examining Source Files . . . . . . . . . . . . . . . . . . . . . . . 87
9.1 9.2 9.3 Printing Source Lines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying a Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Source Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.3.1 Choosing your Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.4 Searching Source Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.5 Specifying Source Directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.6 Source and Machine Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 88 89 90 90 90 93

iii

10

Examining Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

10.1 Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 10.2 Ambiguous Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 10.3 Program Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 10.4 Artificial Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 10.5 Output Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 10.6 Examining Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 10.7 Automatic Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 10.8 Print Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 10.9 Pretty Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 10.9.1 Pretty-Printer Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 10.9.2 Pretty-Printer Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 10.9.3 Pretty-Printer Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 10.10 Value History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 10.11 Convenience Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 10.12 Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 10.13 Floating Point Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 10.14 Vector Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 10.15 Operating System Auxiliary Information . . . . . . . . . . . . . . . . . . . 121 10.16 Memory Region Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 10.16.1 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 10.16.1.1 Memory Access Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 10.16.1.2 Memory Access Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 10.16.1.3 Data Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 10.16.2 Memory Access Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 10.17 Copy Between Memory and a File . . . . . . . . . . . . . . . . . . . . . . . . . 124 10.18 How to Produce a Core File from Your Program . . . . . . . . . . . 124 10.19 Character Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 10.20 Caching Data of Remote Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 10.21 Search Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

11

Debugging Optimized Code . . . . . . . . . . . . . . . . 131
Inline Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Tail Call Frames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

11.1 11.2

12 13

C Preprocessor Macros . . . . . . . . . . . . . . . . . . . . . 135 Tracepoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
139 140 142 143 143 143 144 146 147

13.1 Commands to Set Tracepoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.1 Create and Delete Tracepoints . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.2 Enable and Disable Tracepoints . . . . . . . . . . . . . . . . . . . . . . . . 13.1.3 Tracepoint Passcounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.4 Tracepoint Conditions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.5 Trace State Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.6 Tracepoint Action Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.7 Listing Tracepoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.1.8 Listing Static Tracepoint Markers . . . . . . . . . . . . . . . . . . . . . .

iv

Debugging with gdb 13.1.9 Starting and Stopping Trace Experiments . . . . . . . . . . . . . . 13.1.10 Tracepoint Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.2 Using the Collected Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.2.1 tfind n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.2.2 tdump. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.2.3 save tracepoints filename . . . . . . . . . . . . . . . . . . . . . . . . . . . 13.3 Convenience Variables for Tracepoints . . . . . . . . . . . . . . . . . . . . . . . 13.4 Using Trace Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 149 150 150 152 153 153 154

14

Debugging Programs That Use Overlays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
How Overlays Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overlay Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Overlay Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overlay Sample Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 156 158 159

14.1 14.2 14.3 14.4

15

Using gdb with Different Languages . . . . . . 161
161 161 162 162 162 163 163 164 165 165 166 167 168 169 169 169 170 171 171 171 171 172 172 172 173 173 173 173 173 173

15.1 Switching Between Source Languages . . . . . . . . . . . . . . . . . . . . . . . 15.1.1 List of Filename Extensions and Languages . . . . . . . . . . . . . 15.1.2 Setting the Working Language . . . . . . . . . . . . . . . . . . . . . . . . . 15.1.3 Having gdb Infer the Source Language . . . . . . . . . . . . . . . . . 15.2 Displaying the Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.3 Type and Range Checking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.3.1 An Overview of Type Checking . . . . . . . . . . . . . . . . . . . . . . . . 15.3.2 An Overview of Range Checking . . . . . . . . . . . . . . . . . . . . . . . 15.4 Supported Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1 C and C++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.1 C and C++ Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.2 C and C++ Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.3 C++ Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.4 C and C++ Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.5 C and C++ Type and Range Checks . . . . . . . . . . . . . . . 15.4.1.6 gdb and C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.7 gdb Features for C++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.1.8 Decimal Floating Point format . . . . . . . . . . . . . . . . . . . . 15.4.2 D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.3 Objective-C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.3.1 Method Names in Commands . . . . . . . . . . . . . . . . . . . . . 15.4.3.2 The Print Command With Objective-C . . . . . . . . . . . . 15.4.4 OpenCL C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.4.1 OpenCL C Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.4.2 OpenCL C Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.4.3 OpenCL C Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.5 Fortran . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.5.1 Fortran Operators and Expressions . . . . . . . . . . . . . . . . 15.4.5.2 Fortran Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.5.3 Special Fortran Commands . . . . . . . . . . . . . . . . . . . . . . . .

v 15.4.6 Pascal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.7 Modula-2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.7.1 Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.7.2 Built-in Functions and Procedures . . . . . . . . . . . . . . . . . 15.4.7.3 Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.7.4 Modula-2 Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.7.5 Modula-2 Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.7.6 Deviations from Standard Modula-2 . . . . . . . . . . . . . . . 15.4.7.7 Modula-2 Type and Range Checks. . . . . . . . . . . . . . . . . 15.4.7.8 The Scope Operators :: and . . . . . . . . . . . . . . . . . . . . . 15.4.7.9 gdb and Modula-2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.8 Ada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.8.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.8.2 Omissions from Ada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.8.3 Additions to Ada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.8.4 Stopping at the Very Beginning . . . . . . . . . . . . . . . . . . . 15.4.8.5 Extensions for Ada Tasks . . . . . . . . . . . . . . . . . . . . . . . . . 15.4.8.6 Tasking Support when Debugging Core Files . . . . . . 15.4.8.7 Tasking Support when using the Ravenscar Profile ........................................................ 15.4.8.8 Known Peculiarities of Ada Mode . . . . . . . . . . . . . . . . . 15.5 Unsupported Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 174 174 175 176 177 179 179 179 179 180 180 180 181 182 183 183 186 187 187 188

16 17

Examining the Symbol Table . . . . . . . . . . . . . . 189 Altering Execution. . . . . . . . . . . . . . . . . . . . . . . . . . 195
Assignment to Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Continuing at a Different Address . . . . . . . . . . . . . . . . . . . . . . . . . . . Giving your Program a Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Returning from a Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Calling Program Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Patching Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 196 197 197 198 199

17.1 17.2 17.3 17.4 17.5 17.6

18

gdb Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Commands to Specify Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Debugging Information in Separate Files . . . . . . . . . . . . . . . . . . . . Index Files Speed Up gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Errors Reading Symbol Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GDB Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 209 212 213 214

18.1 18.2 18.3 18.4 18.5

19

Specifying a Debugging Target . . . . . . . . . . . . 215
Active Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Commands for Managing Targets . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Choosing Target Byte Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

19.1 19.2 19.3

vi

Debugging with gdb

20

Debugging Remote Programs . . . . . . . . . . . . . . 219
219 221 221 221 222 222 223 223 224 224 224 226 230 231 232 233

20.1 Connecting to a Remote Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.2 Sending files to a remote system . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.3 Using the gdbserver Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.3.1 Running gdbserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.3.1.1 Attaching to a Running Program . . . . . . . . . . . . . . . . . . 20.3.1.2 Multi-Process Mode for gdbserver . . . . . . . . . . . . . . . . 20.3.1.3 TCP port allocation lifecycle of gdbserver . . . . . . . . 20.3.1.4 Other Command-Line Arguments for gdbserver . . . 20.3.2 Connecting to gdbserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.3.3 Monitor Commands for gdbserver . . . . . . . . . . . . . . . . . . . . . 20.3.4 Tracepoints support in gdbserver . . . . . . . . . . . . . . . . . . . . . . 20.4 Remote Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.5 Implementing a Remote Stub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20.5.1 What the Stub Can Do for You . . . . . . . . . . . . . . . . . . . . . . . . 20.5.2 What You Must Do for the Stub . . . . . . . . . . . . . . . . . . . . . . . 20.5.3 Putting it All Together. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

Configuration-Specific Information . . . . . . . . 235
235 235 235 235 237 239 240 241 241 242 244 245 245 245 246 246 247 247 247 249 250 250 251 253 255 256 256 257 257

21.1 Native . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1.1 HP-UX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1.2 BSD libkvm Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1.3 SVR4 Process Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1.4 Features for Debugging djgpp Programs . . . . . . . . . . . . . . . 21.1.5 Features for Debugging MS Windows PE Executables . . 21.1.5.1 Support for DLLs without Debugging Symbols. . . . . 21.1.5.2 DLL Name Prefixes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1.5.3 Working with Minimal Symbols . . . . . . . . . . . . . . . . . . . 21.1.6 Commands Specific to gnu Hurd Systems . . . . . . . . . . . . . . 21.1.7 QNX Neutrino . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.1.8 Darwin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2 Embedded Operating Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2.1 Using gdb with VxWorks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2.1.1 Connecting to VxWorks . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2.1.2 VxWorks Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.2.1.3 Running Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3 Embedded Processors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.1 ARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.2 Renesas M32R/D and M32R/SDI . . . . . . . . . . . . . . . . . . . . . . 21.3.3 M68k . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.4 MicroBlaze . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.5 MIPS Embedded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.6 OpenRISC 1000. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.7 PowerPC Embedded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.8 HP PA Embedded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.9 Tsqware Sparclet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.9.1 Setting File to Debug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.9.2 Connecting to Sparclet . . . . . . . . . . . . . . . . . . . . . . . . . . . .

vii 21.3.9.3 Sparclet Download . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.9.4 Running and Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.10 Fujitsu Sparclite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.11 Zilog Z8000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.12 Atmel AVR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.13 CRIS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3.14 Renesas Super-H . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4 Architectures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4.1 x86 Architecture-specific Issues . . . . . . . . . . . . . . . . . . . . . . . . . 21.4.2 A29K . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4.3 Alpha. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4.4 MIPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4.5 HPPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.4.6 Cell Broadband Engine SPU architecture . . . . . . . . . . . . . . . 21.4.7 PowerPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 258 258 258 259 259 259 260 260 260 260 260 262 262 263

22

Controlling gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Screen Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the Current ABI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Optional Warnings and Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . Optional Messages about Internal Happenings . . . . . . . . . . . . . . . Other Miscellaneous Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265 265 266 267 268 269 270 271 274

22.1 22.2 22.3 22.4 22.5 22.6 22.7 22.8 22.9

23

Extending gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
275 275 277 278 279 281 281 282 282 285 286 290 294 295 296 298 299 301 302 305

23.1 Canned Sequences of Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.1.1 User-defined Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.1.2 User-defined Command Hooks. . . . . . . . . . . . . . . . . . . . . . . . . . 23.1.3 Command Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.1.4 Commands for Controlled Output . . . . . . . . . . . . . . . . . . . . . . 23.2 Scripting gdb using Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.1 Python Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2 Python API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.1 Basic Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.2 Exception Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.3 Values From Inferior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.4 Types In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.5 Pretty Printing API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.6 Selecting Pretty-Printers . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.7 Writing a Pretty-Printer . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.8 Inferiors In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.9 Events In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.10 Threads In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.11 Commands In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.12 Parameters In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . .

viii

Debugging with gdb 23.2.2.13 Writing new convenience functions . . . . . . . . . . . . . . . 23.2.2.14 Program Spaces In Python . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.15 Objfiles In Python . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.2.16 Accessing inferior stack frames from Python. . . . . . 23.2.2.17 Accessing frame blocks from Python. . . . . . . . . . . . . . 23.2.2.18 Python representation of Symbols. . . . . . . . . . . . . . . . 23.2.2.19 Symbol table representation in Python. . . . . . . . . . . . 23.2.2.20 Manipulating breakpoints using Python . . . . . . . . . . 23.2.2.21 Python representation of lazy strings. . . . . . . . . . . . . 23.2.3 Auto-loading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.3.1 The ‘objfile-gdb.py’ file . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.3.2 The .debug_gdb_scripts section . . . . . . . . . . . . . . . . . 23.2.3.3 Which flavor to choose? . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.4 Python modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.4.1 gdb.printing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.4.2 gdb.types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.2.4.3 gdb.prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23.3 Creating new spellings of existing commands . . . . . . . . . . . . . . . . 307 308 309 309 312 313 316 317 320 320 321 321 322 323 323 323 324 325

24 25

Command Interpreters . . . . . . . . . . . . . . . . . . . . . 327 gdb Text User Interface . . . . . . . . . . . . . . . . . . . . 329
TUI Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TUI Key Bindings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TUI Single Key Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TUI-specific Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TUI Configuration Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 330 331 331 333

25.1 25.2 25.3 25.4 25.5

26 27

Using gdb under gnu Emacs . . . . . . . . . . . . . . . 335 The gdb/mi Interface . . . . . . . . . . . . . . . . . . . . . . . 337
337 337 337 338 339 339 340 340 341 342 343 343 343 344 344 346

Function and Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notation and Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.3 gdb/mi General Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.3.1 Context management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.3.2 Asynchronous command execution and non-stop mode . . 27.3.3 Thread groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.4 gdb/mi Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.4.1 gdb/mi Input Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.4.2 gdb/mi Output Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.5 gdb/mi Compatibility with CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.6 gdb/mi Development and Front Ends . . . . . . . . . . . . . . . . . . . . . . . 27.7 gdb/mi Output Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.7.1 gdb/mi Result Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.7.2 gdb/mi Stream Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.7.3 gdb/mi Async Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.7.4 gdb/mi Frame Information . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ix 27.7.5 gdb/mi Thread Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.7.6 gdb/mi Ada Exception Information . . . . . . . . . . . . . . . . . . . . 27.8 Simple Examples of gdb/mi Interaction . . . . . . . . . . . . . . . . . . . . . 27.9 gdb/mi Command Description Format . . . . . . . . . . . . . . . . . . . . . . 27.10 gdb/mi Breakpoint Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.11 gdb/mi Program Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.12 gdb/mi Thread Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.13 gdb/mi Ada Tasking Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 27.14 gdb/mi Program Execution. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.15 gdb/mi Stack Manipulation Commands . . . . . . . . . . . . . . . . . . . . 27.16 gdb/mi Variable Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.17 gdb/mi Data Manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.18 gdb/mi Tracepoint Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.19 gdb/mi Symbol Query Commands . . . . . . . . . . . . . . . . . . . . . . . . . 27.20 gdb/mi File Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27.21 gdb/mi Target Manipulation Commands. . . . . . . . . . . . . . . . . . . 27.22 gdb/mi File Transfer Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 27.23 Miscellaneous gdb/mi Commands . . . . . . . . . . . . . . . . . . . . . . . . . 347 347 347 348 349 357 360 362 363 369 374 385 393 396 397 399 402 403

28

gdb Annotations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
What is an Annotation? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Server Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Annotation for gdb Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Invalidation Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Running the Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Displaying Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411 412 412 413 413 413 414

28.1 28.2 28.3 28.4 28.5 28.6 28.7

29

JIT Compilation Interface . . . . . . . . . . . . . . . . . 415
JIT Declarations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415 Registering Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416 Unregistering Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

29.1 29.2 29.3

30

Reporting Bugs in gdb . . . . . . . . . . . . . . . . . . . . . 417
Have You Found a Bug? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417 How to Report Bugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

30.1 30.2

x

Debugging with gdb

31

Command Line Editing. . . . . . . . . . . . . . . . . . . . . 421
421 421 421 422 422 423 423 424 424 430 431 434 434 434 436 437 438 438 439 439 441

31.1 Introduction to Line Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Readline Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2.1 Readline Bare Essentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2.2 Readline Movement Commands . . . . . . . . . . . . . . . . . . . . . . . . 31.2.3 Readline Killing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2.4 Readline Arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2.5 Searching for Commands in the History . . . . . . . . . . . . . . . . 31.3 Readline Init File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3.1 Readline Init File Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3.2 Conditional Init Constructs . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3.3 Sample Init File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4 Bindable Readline Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.1 Commands For Moving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.2 Commands For Manipulating The History . . . . . . . . . . . . . . 31.4.3 Commands For Changing Text . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.4 Killing And Yanking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.5 Specifying Numeric Arguments . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.6 Letting Readline Type For You. . . . . . . . . . . . . . . . . . . . . . . . . 31.4.7 Keyboard Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.4.8 Some Miscellaneous Commands . . . . . . . . . . . . . . . . . . . . . . . . 31.5 Readline vi Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

32

Using History Interactively . . . . . . . . . . . . . . . . 443
443 443 444 444

32.1 History Expansion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32.1.1 Event Designators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32.1.2 Word Designators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32.1.3 Modifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Appendix A Appendix B Appendix C
C.1 C.2 C.3 C.4 C.5 C.6

In Memoriam . . . . . . . . . . . . . . . . . . . . 447 Formatting Documentation . . . . . 449 Installing gdb . . . . . . . . . . . . . . . . . . . . 451
451 452 453 454 455 456

Requirements for Building gdb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Invoking the gdb ‘configure’ Script . . . . . . . . . . . . . . . . . . . . . . . . Compiling gdb in Another Directory . . . . . . . . . . . . . . . . . . . . . . . . Specifying Names for Hosts and Targets . . . . . . . . . . . . . . . . . . . . . ‘configure’ Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . System-wide configuration and settings . . . . . . . . . . . . . . . . . . . . . .

Appendix D

Maintenance Commands. . . . . . . . 457

. . .13. . . . . . . . . . . . . . . . . . . . . .12 Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Host I/O Packets . . . . . . Memory Transfer . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 Constants . . . . . . . . . . . E. . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . .2. . . . . . . .5 The ‘Ctrl-C’ Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5. . . . . . . . . . . . . . . . . . . . . . .8 Interrupts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . E. . . . . . . . .5. . . . . . . . . . . . . . . . . E. . . . . .2 Packets . . . . . . . . . . . . . . . . . . . .13 File-I/O Remote Protocol Extension . . . . . gettimeofday . . . . . . . . .1. . . . . . . . . . . . . . . . system . . . . . . . . . . . . . . . . . . . .13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Stop Reply Packets . . E. . . . . . . . . . . . . . . . . . . . .4 General Query Packets . . . . . . . . . . . . . . . . . . . . Pointer Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13. .5 Architecture-Specific Protocol Details . . .13. . . . . . . . . . . . . . .4 The F Reply Packet . . . . . . . . . . . . . . .1 ARM . . . . . . . . . . . 465 465 466 476 477 493 493 493 493 493 494 500 500 502 502 503 504 505 505 505 506 507 507 507 508 508 508 509 510 510 510 511 511 512 512 513 513 514 514 514 514 514 515 515 515 515 516 516 E. . . . . open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write . . . . . . . . . . . . . . . . . . . . . . . .6 Tracepoint Packets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 Remote Protocol Support for Non-Stop Mode . . . . . . .9 Notification Packets . . . . . . . . .1 Relocate instruction reply packet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 File-I/O Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . .6. . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Register Packet Format . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . Integral Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 Packet Acknowledgment . . .2 Protocol Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xi Appendix E gdb Remote Serial Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . unlink . . . . . . . . . . . . . . . . . . . . . . . . . . close . . . . . . . lseek . . . . . . . . . . . . Errno Values. E. . . . . . . isatty . . . . . . . . . . . . . . . . . . . . . . . . Open Flags . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . .13. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. E. . . . . . . . . . . . . . . . . . . . . .3 The F Request Packet . . . . . . . . . . . . . E. . . . . . . . . . . . . struct timeval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mode t Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Console I/O . . . . . . . . . . . . . . . . . . .13. . . . . E. .5. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. E. . . . . . . . . . . . . . . . . . . . . . . . stat/fstat . . . . . . . E. . . . . . . . . . . . . . . . . . . .1 Overview . . . Lseek Flags . . . . . . . . . read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13. . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . .5. . . . . . . . . . . .7 List of Supported Calls . . . .8 Protocol-specific Representation of Datatypes . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 Breakpoint Kinds . . . . . . . . . . .13. . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . struct stat .2 MIPS. . . . . . . . .

. . . .1 Inclusion . . . G. . G. . . . . . . . . . . 521 F. . . . . . . . . . . . . . . . . . . G. . . . . . . . . . . . . . . . . .2 Target Description Format . . Using Agent Expressions . . . . . . . 516 516 517 518 519 519 Appendix F The GDB Agent Expression Mechanism . . . . . . . .5 General Bytecode Design . . .4 M68K Features . . . . G. . . . . . . . . . . . . . . . .14 Library List Format .2 i386 Features . . . . .2. .4. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 Types . . . . . . . . . . . . . . . . . G. . . . . . . . . . . G. . . . . . . . . . . . . . . . .4. E. . . . 545 Appendix K GNU GENERAL PUBLIC LICENSE . . . . .3 Predefined Target Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 OS ABI . E. . . . . G. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . . . 541 H. . . . . . . . . . . . . . .1 ARM Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E. . . . . . . . . . . . . . . . . . . .gdb_index section format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 TMS320C6x Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521 523 528 528 529 Appendix G Target Descriptions . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 F. . . . . . . . . . . . . . . . .5 PowerPC Features . . . .10 File-I/O Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Varying Target Capabilities . . . . . . . . . . . . . . . . . G. . . . . . . . . . . . . . . . .4 Compatible Architecture. . . . . . . 541 Appendix I Appendix J Trace File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16 Thread List Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. .1 Process list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533 533 533 534 534 535 535 535 535 536 537 538 538 539 539 539 540 540 G. . . . . . . . . . . . . . . . . . . . . . . . . . G. . .2. . . . . . .4. . . . . . . . .2 Architecture .xii Debugging with gdb Limits . . . . . . . . . . . . . . . . .7 Registers . . . . . . . . . . .4 F. . . . . . . . . . G.1 Retrieving Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Appendix H Operating System Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . G. .3 F. . . . . . . . . . . . . . . . . . . . Rationale . . . E. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . .1 F. . . . . . . . . . .13. . . . . . . . . . . . . . . G. . . . . . . . . . . . . . Bytecode Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G. . . . 547 . . . . . . . . . . . .4.4 Standard Target Features. . . . . . . . . . . . . . . G. .17 Traceframe Info Format . . . . . . . . . .3 MIPS Features . . .15 Memory Map Format . .4.5 Features . . . . . . . . . G. . . . . . . . . . . . . . . . . . . . . . . . .4. . . . . . . . . . . . . . 543 . . . . . . . . . . . . . . . . .

567 . . . . . . . . . . . 559 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii Appendix L GNU Free Documentation License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

.

gdb can do four main kinds of things (plus other things in support of these) to help you catch bugs in the act: • • • • Start your program. gdb does not support entering expressions. see Section 15. page 174. subranges. see Section 15. The GPL gives you the freedom to copy or adapt a licensed program—but every person getting a copy also gets with it the freedom to modify that copy (which means that they must get access to the source code). Fundamentally. Free Software Needs Free Documentation The biggest deficiency in the free software community today is not in the software—it is the lack of good free documentation that we can include with the free software. see Section 15. Change things in your program. For information on D. page 165.7 Support for OpenCL C is partial. page 171.4. when your program has stopped. specifying anything that might affect its behavior.2 [D]. printing values. For more information. see Section 15. file variables.4. Typical software companies use copyrights to limit your freedoms. using either the Apple/NeXT or the GNU Objective-C runtime. For information on OpenCL C. or similar features using Pascal syntax. Support for D is partial. You can use gdb to debug programs written in C and C++. the General Public License is a license which says that you have these freedoms and that you cannot take these freedoms away from anyone else. Debugging Pascal programs which use sets.4. and the freedom to distribute further copies.Summary of gdb 1 Summary of gdb The purpose of a debugger such as gdb is to allow you to see what is going on “inside” another program while it executes—or what another program was doing at the moment it crashed. so you can experiment with correcting the effects of one bug and go on to learn about another. gdb can be used to debug programs written in Fortran. For more information. gdb can be used to debug programs written in Objective-C. Support for Modula-2 is partial. [Modula-2]. the Free Software Foundation uses the GPL to preserve these freedoms. protected by the gnu General Public License (GPL). For information on Modula-2. or nested functions does not currently work. Free Software gdb is free software.1 [C and C++]. page 165.4 [OpenCL C].4 [Supported Languages]. page 172. Many of our most important programs do not come with free reference manuals and free introductory . Make your program stop on specified conditions. see Section 15. Examine what has happened. although it may be necessary to refer to some variables with a trailing underscore.4.

when an important free software package does not come with a free manual and a free tutorial. the restrictions obstruct the use of the manual. Some commercial publishers will use a free license if you insist. like free software. Our community continues to lose manuals to proprietary publishing. For example.) The problem is the restrictions on the use of the manual. please insist on publishing it under the GNU Free Documentation License or another free documentation license. both on-line and on paper. it is not free.2 Debugging with gdb texts. Redistribution (including the normal kinds of commercial redistribution) must be permitted. Permission for modification of the technical content is crucial too. The tutorial manuals that people normally use are non-free. requirements to preserve the original author’s copyright notice. If you are writing documentation. it is up . Free documentation. (The Free Software Foundation sells printed copies of manuals. It is also no problem to require modified versions to include notice that they were modified. if they are conscientious they will change the manual too—so they can provide accurate and clear documentation for the modified program. If we spread the word that free software needs free reference manuals and free tutorials. Some kinds of limits on the way modification is handled are acceptable. Otherwise. Please spread the word about this issue. as long as they deal with nontechnical topics (like this one). Consider Perl. and we need another manual to replace it. Remember that this decision requires your approval—you don’t have to let the publisher decide. Free manuals are available in source code form. too. his intended contribution to the community. These kinds of restrictions are acceptable because they don’t obstruct the community’s normal use of the manual. source files not available—which exclude them from the free software world. Documentation is an essential part of any software package. but they will not propose the option. perhaps the next person who wants to contribute by writing documentation will realize. adding or changing features. The criteria of freedom for a free manual are roughly the same as for free software. so that the manual can accompany every copy of the program. How did this come about? Because the authors of those manuals published them with restrictive terms—no copying. is a matter of freedom. Non-free manuals do not allow this. A manual that leaves you no choice but to write a new manual to document a changed version of the program is not really available to our community. or the list of authors. However. that only free manuals contribute to the free software community. that is a major gap. through all the usual channels. Even entire sections that may not be deleted or changed are acceptable. not price. When people modify the software. before it is too late. That wasn’t the first time this sort of thing happened. and it was far from the last. it must be possible to modify all the technical content of the manual. and give you permission to copy and modify. the distribution terms. and then distribute the result in all the usual media. are ok. only to learn that he had ruined everything by signing a publication contract to make it non-free. The problem with the non-free manual is not that publishers charge a price for printed copies—that in itself is fine. We have many such gaps today. Many times we have heard a GNU user eagerly describe a manual that he is writing. for instance. no modification.

copylefted manuals and tutorials by buying them.4). 3. Adam de Boor and Bradley Davis contributed the ISI Optimum V support.0). and 3. and particularly by buying copies from the publishers that paid for their writing or for major improvements. assisted at various times by Peter TerMaat. and of many other gnu programs. You can encourage commercial publishers to sell more free. This section attempts to credit major contributors. Fred Fish (releases 4. Henkel-Wallace. and Alessandro Forin contributed MIPS support. and 3. 4. to be evenhanded) have been unfairly omitted from this list.fsf.2. The file ‘ChangeLog’ in the gdb distribution approximates a blow-by-blow account. 4. Stan Shebs (release 4. and Richard Mlynarik. 4. with significant additional contributions from Per Bothner and Daniel Berlin.org. 6. 5. and 4.1 and 5. Jean-Daniel Fekete contributed Sun 386i support.13. 4. Jim Kingdon (releases 3. 5. Check the distribution terms of a manual before you buy it. and try to reward the publishers that have paid or pay the authors to work on it.2. Noboyuki Hikichi.9). we particularly thank those who shepherded gdb through major releases: Andrew Cagney (releases 6. Brent Benson of Harris Computer Systems contributed DWARF 2 support.16. If you or your friends (or enemies. Many others have contributed to its development.1.0). 6. Meanwhile.3).18). and 3. Early work on C++ was by Peter TerMaat (who also did much general update work leading to release 3.8. Noboyuki . Jason Molenda (release 4.2. 4. Pace Willison did the original support for encapsulated COFF. Jim Blandy (release 4.17). Check the history of the book. Contributors to gdb Richard Stallman was the original author of gdb. and 4. Steve Chamberlain.8. Chris Hanson improved the HP9000 support. Richard Stallman. Changes much prior to version 2.10. please try other publishers. handled releases through 2. The Free Software Foundation maintains a list of free documentation published by other publishers. Michael Tiemann is the author of most of the gnu C++ support in gdb.3. 4. and Randy Smith (releases 3. If the publisher you are dealing with refuses.0 are lost in the mists of time. BFD was a joint project of David V. 4.0. at http://www.6.15.7.5.3. 5.0).9). gdb uses the BFD subroutine library to examine multiple object-file formats. 6. we would like to add your names! So that they may not regard their many labors as thankless.org/doc/other-free-books.12. and John Gilmore.4. Chris Hanson. James Clark wrote the gnu C++ demangler.1.html. 4. and insist that whoever seeks your business must respect your freedom. 4. Rich Pixley.3. we cannot actually acknowledge everyone here. 3.11.1. Per Bothner. John Gilmore (releases 4.0.Summary of gdb 3 to you to raise the issue and say firmly that this is what you want. with regret. write to licensing@gnu. 4.5. try to avoid buying non-free documentation at all. 4.2. David Johnson wrote the original COFF support. Stu Grossman and John Gilmore (releases 4. If you’re not sure whether a proposed license is free.14). Plea: Additions to this section are particularly welcome. One of the virtues of free software is that everyone is free to contribute to it.

David Johnson contributed Encore Umax support. Vikram Koka and Glenn Engel helped develop remote debugging. VxWorks. Jyrki Kuoppala contributed Altos 3068 support. Jim Kingdon. Peter Schauer. Fred Fish wrote most of the support for Unix System Vr4.0 architecture. Robert Hoehne made significant contributions to the DJGPP port. and M32R/D processors. and Super-H processors. NEC sponsored the support for the v850. Richard Title. Kung Hsu. and Stu Grossman made nearly innumerable bug fixes and cleanups throughout gdb. HP’s implementation of kernel threads. Andreas Schwab contributed M68K gnu/Linux support. Stu Grossman wrote gdbserver. Jonathan Stone contributed Pyramid support. Marko Mlinar contributed OpenRISC 1000 support. Ltd. Kathy Mann. Rich Schaefer and Peter Schauer helped with support of SunOS shared libraries. 10. Keith Packard contributed NS32K support. sponsored the support for H8/300. Jay Vosburgh contributed Symmetry support. John Bishop.20. and contributed the Languages chapter of this manual. and Elena Zannoni. and RDI targets. AMD. Fujitsu sponsored the support for SPARClite and FR30 processors. HP-UX 10. Wind River Systems. Michael Snyder added support for tracepoints. and Vr5xxx processors. Tim Tucker contributed support for the Gould NP1 and Gould Powernode. Satish Pai. and the Text User Interface (nee Terminal User Interface): Ben Krepp. Jeff Law. Pace Willison contributed Intel 386 support.0 (narrow mode). Ian Taylor. . Jeff Law contributed HP PA and SOM support. Chris Smith contributed Convex support (and Fortran debugging). D30V. HP’s aC++ compiler.4 Debugging with gdb Hikichi and Tomoyuki Hasei contributed Sony/News OS 3 support. Steve Rehrauer. H8/500. the Modula-2 support. Susan Macchia. Hitachi America (now Renesas America).30. Toshiba sponsored the support for the TX39 Mips processor. and 11. Brian Fox is the author of the readline libraries providing command-line editing and command history. Kim Haase provided HP-specific information in this manual. Ted Goldstein. respectively. Jay Fenlason and Roland McGrath ensured that gdb and GAS agree about several machine instruction sets. Intel Corporation. Doug Rabson contributed Acorn Risc Machine support. He also enhanced the command-completion support to cover C++ overloaded symbols. Matsushita sponsored the support for the MN10200 and MN10300 processors. and Rick Sladkey added support for hardware watchpoints. and ARM contributed remote debugging modules for the i960. The following people at the Hewlett-Packard Company contributed support for the PARISC 2. DJ Delorie ported gdb to MS-DOS. Bob Rusk contributed Harris Nighthawk CX-UX support. Michael Tiemann contributed SPARC support. Vr4xxx. India Paul. Mitsubishi (now Renesas) sponsored the support for D10V. Andrew Beers of SUNY Buffalo wrote the language-switching code. Patrick Duval. for the DJGPP project. A29K UDI.

JT Conklin. Kei Sakamoto. Sean Fagan. Jim Wilson. Ulrich Weigand. Randolph Chung.. Jim Kingdon. and Maxim Grigoriev from Tensilica. Gavin Romig-Koch. Kevin Buettner. while working for Red Hat. Tom Tromey. and Scott Foehner. Ian Carmichael. Richard Henderson. each involving a complete rewrite of the architecture’s frame code. this consisting of a fresh new design featuring frame IDs. Tom Lord. . Andrew Cagney. helped with the migration of old architectures to this new framework. Mark Kettenis. Stan Shebs. Jim Lemke. Christian Zankel. Ross Morley. Rob Savoye. Corinna Vinschen. Fernando Nasser. Ian Taylor. Jim Blandy added support for preprocessor macros. and Andrew Cagney the dummy. Many people including Andrew Cagney. John Newlin. Chris Faylor. and Elena Zannoni. Orjan Friberg. and Elena Zannoni. Dawn Perchik. Andreas Schwab. DJ Delorie. John Gilmore. and trad unwinders. Ron Unrau. Catherine Moore. Grace Sainsbury. Randolph Chung. Michael Eager and staff of Xilinx. In addition. Kevin Buettner. while working for Cygnus Solutions. Kung Hsu. Inc. and David Zuhn have made contributions both large and small. Fernando Nasser. Michael Snyder. Jeff Holcomb. John Metzler. Rich Pixley. Andrew Cagney designed gdb’s architecture vector. Jim Ingham. Cygnus engineers who have worked on gdb fulltime include Mark Alexander. Ken Raeburn. Jeff Law. Inc. Nick Duffek. tramp. Others who have worked on the Xtensa port of gdb in the past include Steve Tjiang. Doug Evans. sentinel. Keith Seitz. Geoffrey Noer. Bob Manson. Jeff Johnston. Michael Tiemann. Per Bothner. Richard Henderson. Mark Kettenis implemented the dwarf 2 unwinder. Steve Chamberlain. Edith Epstein. Andrew Cagney completely re-designed and re-implemented gdb’s unwinder framework. Theodore A. Jamie Smith. Angela Thomas. Stu Grossman. Yoshinori Sato. Ulrich Drepper. contributed support for Xtensa processors. Drew Moseley. and the sentinel frame. and Ulrich Weigand. Bob Wilson. Kei Sakamoto. and Elena Zannoni. David Henkel-Wallace. Martin Hunt. Stephane Carrez. contributed support for the Xilinx MicroBlaze architecture. Fred Fish. Jason Thorpe. Frank Eigler. implemented the original gdb/mi interface. Michael Meissner. Richard Henderson. Zdenek Radouch. Stan Cox. Mark Kettenis. Nick Clifton. Jason Merrill. Jeff Johnston the libunwind unwinder. David Taylor. Andrew Cagney. Michael Snyder. Joel Brobecker. The architecture-specific changes. Daniel Jacobowitz. were carried out by Jim Blandy. Mike Stump.Summary of gdb 5 Cygnus Solutions has sponsored gdb maintenance and much of its development since 1991. Stephane Carrez. independent frame sniffers. Jim Blandy. Roth. Yoshinori Sato. Dave Brolley. Corinna Vinschen.

.

defn(<QUOTE>foo<UNQUOTE>)) baz Ctrl-d m4: End of input: 0: fatal error: EOF in string Let us use gdb to try to see what is going on. There is absolutely no warranty for gdb.3. we then use the m4 built-in defn to define bar as the same thing. the first prompt comes up very quickly. as long as control does not reach the m4_changequote subroutine. (gdb) gdb reads only enough symbol data to know where to find the rest when needed. the same procedure fails to define a new synonym baz: $ cd gnu/m4 $ . a handful of commands are enough to get started using the debugger. Having looked at the source. so that examples fit in this manual. Inc... $ gdb m4 gdb is free software and you are welcome to distribute copies of it under certain conditions. Using the run command. we define a macro foo which expands to 0000. line 879.20111119. In this sample session.Chapter 1: A Sample gdb Session 7 1 A Sample gdb Session You can use this manual at your leisure to read all about gdb. (gdb) break m4 changequote Breakpoint 1 at 0x62f4: file builtin. when we change the open quote string to <QUOTE> and the close quote string to <UNQUOTE>. In the following short m4 session. when we change its quote strings from the default. the program runs as usual: . we know the relevant subroutine is m4_changequote. (gdb) set width 70 We need to see how the m4 built-in changequote works.defn(‘foo’)) bar 0000 changequote(<QUOTE>. to make it easier to pick out from the surrounding output.0000) foo 0000 define(bar. We now tell gdb to use a narrower display width than usual. the commands used to capture one macro definition within another stop working. However. This chapter illustrates those commands. One of the preliminary versions of gnu m4 (a generic macro processor) exhibits the following bug: sometimes.<UNQUOTE>) define(baz./m4 define(foo. Copyright 1999 Free Software Foundation.c. However. we emphasize user input like this: input. gdb 7. type "show copying" to see the conditions. we start m4 running under gdb control. so we set a breakpoint there with the gdb break command. as a result.50. type "show warranty" for details.

step goes to the next line to be executed in any subroutine.c:195 We step through a few more lines to see what happens. . m4_changequote (argc=3. rq=0x34c88 "<UNQUOTE>") at input. argv=0x33c70) at builtin. (gdb) n 538 len_lquote = strlen(rquote). The first two times.c:71 #4 0x79dc in expand_input () at macro. to see where we are in the stack as a whole: the backtrace command displays a stack frame for each active subroutine. (gdb) s 0x3b5c 532 if (rquote != def_rquote) (gdb) s 0x3b80 535 lquote = (lq == nil || *lq == ’\0’) ? \ def_lquote : xstrdup(lq). we call changequote.<UNQUOTE>) Breakpoint 1. we can use ‘s’.c:530 #1 0x6344 in m4_changequote (argc=3. set_quotes((argc >= 2) ? TOKEN_DATA_TEXT(argv[1])\ set_quotes looks like a promising subroutine. changequote(<QUOTE>. td=0xf7fffa30) at macro. It shows a summary of the stack. We can use the backtrace command (which can also be spelled bt). We can go into it by using the command s (step) instead of next. rq=0x34c88 "<UNQUOTE>") at input. (gdb) n 882 : nil. so it steps into set_quotes.0000) foo 0000 To trigger the breakpoint. (gdb) s set_quotes (lq=0x34c78 "<QUOTE>". t=209696. (gdb) n 536 rquote = (rq == nil || *rq == ’\0’) ? def_rquote\ : xstrdup(rq).c:242 #3 0x7a88 in expand_token (obs=0x0.1.c:530 530 if (lquote != def_lquote) The display that shows the subroutine where m4 is now suspended (and its arguments) is called a stack frame display. (gdb) bt #0 set_quotes (lq=0x34c78 "<QUOTE>".argc.3)) Now we use the command n (next) to advance execution to the next line of the current function.c:879 879 if (bad_argc(TOKEN_DATA_TEXT(argv[0]). argv=0x33c70) at builtin.c:882 #2 0x8174 in expand_macro (sym=0x33320) at macro. argv=0xf7fffb20) at m4. gdb suspends execution of m4.c:40 #5 0x2930 in main (argc=0. displaying information about the context where it stops.8 Debugging with gdb (gdb) run Starting program: /work/Editorial/gdb/gnu/m4/m4 define(foo. the next two times we use n to avoid falling into the xstrdup subroutine.

define(baz. We can set them to better values using the p command. To look at some context. we can display ten lines of source surrounding the current line with the l (list) command.defn(<QUOTE>foo<UNQUOTE>)) baz 0000 . 534 535 lquote = (lq == nil || *lq == ’\0’) ? def_lquote\ : xstrdup (lq). and then try the example that caused trouble initially: (gdb) c Continuing. assuming len_lquote and len_rquote are meant to be the lengths of lquote and rquote respectively. 536 rquote = (rq == nil || *rq == ’\0’) ? def_rquote\ : xstrdup (rq). 537 538 len_lquote = strlen(rquote). we can examine the variables lquote and rquote to see if they are in fact the new left and right quotes we specified. 540 } 541 542 void Let us step past the two lines that set len_lquote and len_rquote. (gdb) p len lquote=strlen(lquote) $5 = 7 (gdb) p len rquote=strlen(rquote) $6 = 9 Is that enough to fix the problem of using the new quotes with the m4 built-in defn? We can allow m4 to continue executing with the c (continue) command. (gdb) n 539 len_rquote = strlen(lquote). and then examine the values of those variables. since it can print the value of any expression—and that expression can include subroutine calls and assignments.Chapter 1: A Sample gdb Session 9 The last line displayed looks a little odd. (gdb) p lquote $1 = 0x35d40 "<QUOTE>" (gdb) p rquote $2 = 0x35d50 "<UNQUOTE>" lquote and rquote are indeed the new left and right quotes. 539 len_rquote = strlen(lquote). (gdb) n 540 } (gdb) p len lquote $3 = 9 (gdb) p len rquote $4 = 7 That certainly looks wrong. We use the command p (print) to see their values. (gdb) l 533 xfree(rquote).

We allow m4 exit by giving it an EOF as input: Ctrl-d Program exited normally. The message ‘Program exited normally. We can end our gdb session with the gdb quit command.10 Debugging with gdb Success! The new quotes now work just as well as the default ones.’ is from gdb. (gdb) quit . it indicates m4 has finished executing. The problem seems to have been just the two typos defining the wrong lengths.

c’. . gdb does check for a core file first). gdb will warn you if it is unable to attach or to read core dumps. Taking advantage of the second command-line argument requires a fairly complete operating system. some of these options may effectively be unavailable. You can optionally have gdb pass any arguments after the executable file to the inferior using --args. You can also run gdb with a variety of arguments and options. 2. This option stops option processing. Once started. by specifying -silent: gdb -silent You can further control how gdb starts up by using command-line options. gdb --args gcc -O2 -c foo. specify a process ID as a second argument. gdb reads commands from the terminal until you tell it to exit. The command-line options described here are designed to cover a variety of situations. there may not be any notion of “process”. page 28) to ‘-O2 -c foo. when you use gdb as a remote debugger attached to a bare board.1 Invoking gdb Invoke gdb by running the program gdb. Type gdb -help to display all available options and briefly describe their use (‘gdb -h’ is a shorter equivalent). All options and command line arguments you give are processed in sequential order.3 [Arguments]. which describes gdb’s non-warranty. if you want to debug a running process: gdb program 1234 would attach gdb to process 1234 (unless you also have a file named ‘1234’. and to set gcc’s command-line arguments (see Section 4. specifying an executable program: gdb program You can also start with both an executable program and a core file specified: gdb program core You can. and there is often no way to get a core dump. The order makes a difference when the ‘-x’ option is used. to specify more of your debugging environment at the outset.c This will cause gdb to debug gcc. You can run gdb without printing the front material.Chapter 2: Getting In and Out of gdb 11 2 Getting In and Out of gdb This chapter discusses how to start gdb. and how to get out of it. in some environments. • type quit or Ctrl-d to exit. instead. gdb itself can remind you of the options available. The essentials are: • type ‘gdb’ to start gdb. The most usual way to start gdb is with one argument.

though we illustrate the more usual convention. This option may be used multiple times to call multiple commands. you can flag option arguments with ‘--’ rather than ‘-’. .) -symbols file -s file Read symbol table from file file. if any. e. and if that fails. which is to read it incrementally as it is needed. If gdb has not been configured to included core file support. you can prevent gdb from treating it as a pid by prefixing it with ‘. -se file Read symbol table from file file and use it as the executable file.1.) If the second argument begins with a decimal digit. -command file -x file Execute commands from file file. (gdb reads the first argument that does not have an associated option flag as equivalent to the ‘-se’ option followed by that argument. This makes startup slower.g. See Section 23. -exec file -e file Use file file as the executable file to execute when appropriate. it reads any arguments other than options as specifying an executable file and core file (or process ID). -eval-command command -ex command Execute a single gdb command. -core file -c file Use file file as a core dump to examine. -r -readnow Read each symbol file’s entire symbol table immediately. then it will complain about a second argument and ignore it. This is the same as if the arguments were specified by the ‘-se’ and ‘-c’ (or ‘-p’) options respectively. and the second argument that does not have an associated option flag. but makes future operations faster. such as for most embedded targets.3 [Command files]. gdb also recognizes the long forms if you truncate them. attempt to open it as a corefile./12345’./’.1 Choosing Files When gdb starts.12 Debugging with gdb 2.1. as with the attach command. The contents of this file is evaluated exactly as the source command would. rather than the default. gdb -ex ’target sim’ -ex ’load’ \ -x setbreakpoints -ex ’run’ a. so long as enough of the option is present to be unambiguous. It may also be interleaved with ‘-command’ as required. If you have a corefile whose name begins with a digit.out -directory directory -d directory Add directory to the path to search for source and script files. Many options have both long and short forms. ‘. both are shown in the following list. (If you prefer. page 278. and for examining pure data in conjunction with a core dump. as equivalent to the ‘-c’/‘-p’ option followed by that argument. gdb will first attempt to attach to it as a process. -pid number -p number Connect to process ID number.

1. page 267. -nx -n Do not execute commands found in any initialization files. ‘quit 1’. in order to make this more useful. for example. in which case the exit code will be -1. sets unlimited terminal width and height see Section 22.2 Choosing Modes You can run gdb in various alternative modes—for example. will also be made silent. Normally. or is not allowed to terminate. Note that targets that give their output via gdb. page 270). Run in batch mode. as opposed to writing directly to stdout... -batch-silent Run in batch mode exactly like ‘-batch’. This is particularly useful when using targets that give ‘Loading section’ messages. . but totally silently.3 [Command Files]. in batch mode or quiet mode. due to an incorrect argument or an internal error. See Section 23.g. Batch mode also disables pagination. for example to download and run a program on another computer. with the following exceptions: • gdb exits abnormally. page 278. if not inhibited with ‘-n’). • The child process never runs. E. the message Program exited normally. -quiet -silent -q -batch “Quiet”. and acts as if set confirm off were in effect (see Section 22.Chapter 2: Getting In and Out of gdb 13 2.7 [Messages/Warnings]. E. when gdb is being used as a remote program loader or simulator interface. All gdb output to stdout is prevented (stderr is unaffected).4 [Screen Size]. Batch mode may be useful for running gdb as a filter. • The user quits with an explicit value. In this case the exit code is the same as it would have been without ‘-return-child-result’.1. This is much quieter than ‘-silent’ and would be useless for an interactive session. These messages are also suppressed in batch mode. -return-child-result The return code from gdb will be the return code from the child process (the process being debugged). (which is ordinarily issued whenever a program running under gdb control terminates) is not issued when running in batch mode. Exit with status 0 after processing all the command files specified with ‘-x’ (and all commands from initialization files. Exit with nonzero status if an error occurs in executing the gdb commands in the command files. This option is useful in conjunction with ‘-batch’ or ‘-batch-silent’.g. Do not print the introductory and copyright messages. gdb executes the commands in these files after all the command options and arguments have been processed.

values of expressions. The data directory is where gdb searches for its auxiliary files. See Section 18. this option has no effect. source lines. line number and character position separated by colons. -cd directory Run gdb using directory as its working directory. -fullname -f gnu Emacs sets this option when it runs gdb as a subprocess. level 1 is for use when gdb is run as a subprocess of gnu Emacs. --args Change interpretation of command line so that arguments following the executable file are passed as command line arguments to the inferior. recognizable fashion each time a stack frame is displayed (which includes each time your program stops). page 337). page 214. -l timeout Set the timeout (in seconds) of any communication used by gdb for remote debugging. Level 0 is the normal. -epoch The Epoch Emacs-gdb interface sets this option when it runs gdb as a subprocess. It tells gdb to modify its print routines so as to allow Epoch to display values of expressions in a separate window. level 3 is the maximum annotation suitable for programs that control gdb. -data-directory directory Run gdb using directory as its data directory. -windows -w If gdb includes a GUI. Its effect is identical to using ‘set annotate level’ (see Chapter 28 [Annotations]. instead of the current directory.14 Debugging with gdb -nowindows -nw “No windows”. and level 2 has been deprecated. It tells gdb to output the full file name and line number in a standard. and other types of output. This option stops option processing. and a newline. This recognizable format looks like two ‘\032’ characters. If no GUI is available. The annotation level controls how much information gdb prints together with its prompt. The annotation mechanism has largely been superseded by gdb/mi (see Chapter 27 [GDB/MI]. followed by the file name. -annotate level This option sets the annotation level inside gdb. then this option requires it to be used if possible. The Emacs-to-gdb interface program uses the two ‘\032’ characters as a signal to display the source code for the frame. then this option tells gdb to only use the command-line interface. If gdb comes with a graphical user interface (GUI) built in. page 411).5 [Data Files]. . -baud bps -b bps Set the line speed (baud rate or bits per second) of any serial interface used by gdb for remote debugging.

registers and gdb command outputs (see Chapter 25 [gdb Text User Interface]. -tui Activate the Text User Interface when starting. See Chapter 24 [Command Interpreters].0.1. one generic in your home directory. Reads and executes the commands from init file (if any) in the current working directory. This option is meant to be set by programs which communicate with gdb using it as a back end. This is equivalent to the ‘set write on’ command inside gdb (see Section 17. This is only done if the current directory is different from your home directory. page 327. page 13). Alternatively.6 [Patching]. The Text User Interface manages several text windows on the terminal. 5. page 329). the Text User Interface can be enabled by invoking the program ‘gdbtui’. ‘--interpreter=mi’ (or ‘--interpreter=mi2’) causes gdb to use the gdb/mi interface (see Chapter 27 [The gdb/mi Interface]. -interpreter interp Use the interpreter interp for interface with the controlling program or device. Reads the system-wide init file (if ‘--with-system-gdbinit’ was used when building gdb.2 [Mode Options]. page 335). -statistics This option causes gdb to print statistics about time and memory usage after it completes each command and returns to the prompt. 3. and exit. 2. The previous gdb/mi interface. Earlier gdb/mi interfaces are no longer supported. page 456) and executes all the commands in that file.3 What gdb Does During Startup Here’s the description of what gdb does during session startup: 1.3 and selected with ‘--interpreter=mi1’. the home directory is the one pointed to by the HOME environment variable. showing source. Processes command line options and operands. included in gdb version 5. page 337) included since gdb version 6. 4.1. -write Open the executable and core files for both reading and writing. Do not use this option if you run gdb from Emacs (see Chapter 26 [Using gdb under gnu Emacs]. Thus. and another. see Section C. in the directory where you invoke gdb. -version This option causes gdb to print its version number and no-warranty blurb. 1 On DOS/Windows systems. Reads the init file (if any) in your home directory1 and executes all the commands in that file. specific to the program you are debugging. is deprecated. assembly.Chapter 2: Getting In and Out of gdb 15 -tty device -t device Run using device for your program’s standard input and output.6 [System-wide configuration and settings]. 2. Sets up the command interpreter as specified by the command line (see Section 2. page 199). . you can have more than one init file.

otherwise it will terminate using the result of expression as the error code. page 266. or a core file.3 Shell Commands If you need to execute occasional shell commands during your debugging session. Init files are not executed if you use the ‘-nx’ option (see Section 2. Init files use the same syntax as command files (see Section 23. but rather terminates the action of any gdb command that is in progress and returns to gdb command level. It is safe to type the interrupt character at any time because gdb does not allow it to take effect until a time when it is safe. page 278. To display the list of init files loaded by gdb at startup.3 [Auto-loading]. See Section 23. you can just use the shell command. there is no need to leave or suspend gdb.2 [Choosing Modes]. . page 278) and are processed by gdb in the same way.3 [Command Files]. If you wish to disable the auto-loading during startup. use the quit command (abbreviated q). you must do something like the following: $ gdb -ex "set auto-load-scripts off" -ex "file myprogram" The following does not work because the auto-loading is turned off too late: $ gdb -ex "set auto-load-scripts off" myprogram 7. but if they find a ‘gdb. gdb loads any auto-loaded scripts provided for the program or for its loaded shared libraries. 2. gdb will terminate normally. Reads the command history recorded in the history file.2 Quitting gdb quit [expression] q To exit gdb. page 13).3 [Command History]. due to the limitations of file names imposed by DOS filesystems. The Windows ports of gdb use the standard name.7 [Debugging an Already-running Process]. or type an end-of-file character (usually Ctrl-d). or a process to attach to. The init file in your home directory can set options (such as ‘set complaints’) that affect subsequent processing of command line options and operands. The DJGPP port of gdb uses the name ‘gdb. If you do not supply expression.ini’ file.gdbinit’. See Section 23.1. you can release it with the detach command (see Section 4.2. Reads command files specified by the ‘-x’ option. If the command line specified a program to debug. for more details about the command history and the files where gdb records it. page 31).ini’.1.1. you can use gdb --help.3 [Command Files]. 2. page 320. See Section 22. An interrupt (often Ctrl-c) does not exit from gdb. 8. for more details about gdb command files. The gdb init files are normally called ‘. they warn you about that and suggest to rename the file to the standard name.16 Debugging with gdb 6. If you have been using gdb to control an attached process or device.

There are several commands to control gdb’s logging.4 Logging Output You may want to save the output of gdb commands to a file. 2. If it exists.). set logging off Disable logging. gdb will append to the logfile. etc.COM’ on MS-DOS.Chapter 2: Getting In and Out of gdb 17 shell command-string !command-string Invoke a standard shell to execute command-string. Note that no space is needed between ! and command-string. Otherwise gdb uses the default shell (‘/bin/sh’ on Unix systems. ‘COMMAND. The default logfile is ‘gdb. set logging file file Change the name of the current logfile. show logging Show the current values of the logging settings.txt’. set logging redirect [on|off] By default. The utility make is often needed in development environments. You do not have to use the shell command for this purpose in gdb: make make-args Execute the make program with the specified arguments. Set overwrite if you want set logging on to overwrite the logfile instead. the environment variable SHELL determines which shell to run. set logging on Enable logging. gdb output will go to both the terminal and the logfile. Set redirect if you want output to go only to the log file. This is equivalent to ‘shell make make-args’. . set logging overwrite [on|off] By default.

.

The list and x commands.1 Command Syntax A gdb command is a single line of input. run) will not repeat this way. You can also use the TAB key to get gdb to fill out the rest of a word in a command (or to show you the alternatives available. This permits easy scanning of source or memory. For example. In some cases. gdb disables command repetition after any command that generates this sort of display. User-defined commands can disable this feature. if there is only one possibility. A blank line as input to gdb (typing just RET) means to repeat the previous command. gdb can also use RET in another way: to partition lengthy output. since that is the only info subcommand beginning with ‘bre’: . Press the TAB key whenever you want gdb to fill out the rest of a word. 3. You can test abbreviations by using them as arguments to the help command. gdb command names may always be truncated if that abbreviation is unambiguous. as in ‘step 5’.2 Command Completion gdb can fill in the rest of a word in a command for you.1. and the names of symbols in your program. This is useful mainly in command files (see Section 23. and you can repeat certain gdb commands by typing just RET. page 275. like RET. Any text from a # to the end of the line is a comment. it does nothing. The Ctrl-o binding is useful for repeating a complex sequence of commands. if there is more than one possibility). when you repeat them with RET. even ambiguous abbreviations are allowed. Certain commands (for example. construct new arguments rather than repeating exactly as typed. It starts with a command name. This works for gdb commands. page 278). gdb subcommands. and waits for you to finish the command (or press RET to enter it). You can also use the step command with no arguments.1.Chapter 3: gdb Commands 19 3 gdb Commands You can abbreviate a gdb command to the first few letters of the command name. at any time. gdb fills in the word.4 [Screen Size]. Other possible command abbreviations are listed in the documentation for individual commands.3 [Command Files]. Since it is easy to press one RET too many in this situation. if that abbreviation is unambiguous. page 267). these are commands whose unintentional repetition might cause trouble and which you are unlikely to want to repeat. If there is only one possibility. the command step accepts an argument which is the number of times to step. if you type (gdb) info bre TAB gdb fills in the rest of the word ‘breakpoints’. There is no limit on how long it can be. which is followed by arguments whose meaning depends on the command name. and then fetches the next line relative to the current line from the history for editing. s is specially defined as equivalent to step even though there are other commands whose names start with s. For example. in a way similar to the common utility more (see Section 22. see Section 23. Some commands do not allow any arguments. for example.1 [Define]. This command accepts the current line. it can also show you what the valid possibilities are for the next word in a command. 3.

or the version that takes a float parameter. Sometimes the string you need. To use the word-completion facilities in this situation. when you want to set a breakpoint you may need to distinguish whether you mean the version of name that takes an int parameter. and rings a bell: (gdb) b ’bubble( . but when you type b make_TAB gdb just sounds the bell. for example: (gdb) b make_ TAB gdb sounds bell. press TAB again. To permit word completion to work in this situation. name(int). gdb inserts the quote for you (while completing as much as it can) if you do not type the quote in the first place: (gdb) b bub TAB gdb alters your input line to the following.int) In some cases.20 Debugging with gdb (gdb) info breakpoints You can either press RET at this point. you might as well just type RET immediately after ‘info bre’. This alerts gdb that it may need to consider more information than usual when you press TAB or M-? to request word completion: (gdb) b ’bubble( M-? bubble(double. gdb copies your partial input (‘b make_’ in the example) so you can finish the command. to see: make_a_section_from_file make_environ make_abs_section make_function_type make_blockvector make_pointer_type make_cleanup make_reference_type make_command make_symbol_completion_list (gdb) b make_ After displaying the available possibilities. may contain parentheses or other characters that gdb normally excludes from its notion of a word. you might want to set a breakpoint on a subroutine whose name begins with ‘make_’. If you just want to see the list of alternatives in the first place. (If you were sure you wanted info breakpoints in the first place. gdb can tell that completing a name requires using quotes. The most likely situation where you might need this is in typing the name of a C++ function. you may enclose words in ’ (single quote marks) in gdb commands. gdb sounds a bell. or backspace and enter something else. or as ESC followed by ?. name(float). If there is more than one possibility for the next word when you press TAB. while logically a “word”. distinguished by argument type). For example. M-? means META ?. gdb displays all the possible completions for that word.double) (gdb) b ’bubble( bubble(int. Typing TAB again displays all the function names in your program that begin with those characters. When this happens. to run the info breakpoints command. you can press M-? rather than pressing TAB twice. You can either supply more characters and try again. if ‘breakpoints’ does not look like the command you expected. to exploit command abbreviations rather than command completion). or just press TAB a second time. This is because C++ allows function overloading (multiple definitions of the same function. You can type this either by holding down a key designated as the META shift on your keyboard (if there is one) while typing ?. For example. type a single quote ’ at the beginning of the function name.

gdb also tries1 to limit completions to the field names available in the type of the left-hand-side: (gdb) p gdb_stdout. see Section 15. You can use the command set overload-resolution off to disable overload resolution. When completing in an expression which looks up a field in a structure.Examining data files -.3 Getting Help You can always ask gdb itself for information on its commands. ui_file_flush_ftype *to_flush.Tracing of program execution without stopping the program 1 The completer can be confused by certain kinds of invalid expressions.Maintenance commands obscure -. page 170.Chapter 3: gdb Commands 21 In general. not the dynamic type. void *to_data. ui_file_write_async_safe_ftype *to_write_async_safe.Running the program stack -.Examining the stack status -. Also. help h You can use help (abbreviated h) with no arguments to display a short list of named classes of commands: (gdb) help List of classes of commands: aliases -. see Section 15.Support facilities tracepoints -. gdb can tell that a quote is needed (and inserts it) if you have not yet started typing the argument list when you ask for completion on an overloaded symbol.Aliases of other commands breakpoints -.7 [gdb Features for C++]. using the command help. ui_file_rewind_ftype *to_rewind. ui_file_delete_ftype *to_delete. ui_file_fputs_ftype *to_fputs.Status inquiries support -.Making program stop at certain points data -.4. . ui_file_read_ftype *to_read. page 168.M-? magic to_fputs to_data to_isatty to_delete to_put to_flush to_read to_rewind to_write to_write_async_safe This is because the gdb_stdout is a variable of the type struct ui_file that is defined in gdb sources as follows: struct ui_file { int *magic.1. it only examines the static type of the expression.3 [C++ Expressions].1.Obscure features running -.Specifying and examining files internals -.4. } 3. ui_file_put_ftype *to_put. ui_file_write_ftype *to_write. ui_file_isatty_ftype *to_isatty. For more information about overloaded functions.

(gdb) help class Using one of the general help classes as an argument. (gdb) help command With a command name as help argument.Set dynamic symbol table reloading multiple times in one run show symbol-reloading -. It prints out all matches found. Command name abbreviations are allowed if unambiguous. Use args to specify the beginning of the command you want completed. . here is the help display for the class status: (gdb) help status Status inquiries.Generic command for showing things about the program being debugged show -. List of commands: info -. for the regular expression specified in args.22 Debugging with gdb user-defined -. For example: complete i results in: if ignore info inspect This is intended for use by gnu Emacs. gdb displays a short paragraph on how to use that command.Show dynamic symbol table reloading multiple times in one run complete args The complete args command lists all the possible completions for the beginning of a command. and their documentation. Type "help" followed by command name for full documentation. For example. Command name abbreviations are allowed if unambiguous.User-defined commands Type "help" followed by a class name for a list of commands in that class. apropos args The apropos command searches through all of the gdb commands.Generic command for showing things about the debugger Type "help" followed by command name for full documentation. For example: apropos reload results in: set symbol-reloading -. you can get a list of the individual commands in that class.

or the state of gdb itself. info This command (abbreviated i) is for describing the state of your program. you can use the gdb commands info and show to inquire about the state of your program. list the registers currently in use with info registers.Chapter 3: gdb Commands 23 In addition to help. . Also. and there are variant versions of gdb in gnu/Linux distributions as well. if your version of gdb comes with one. If multiple versions of gdb are in use at your site. To display all the settable parameters and their current values. In contrast to info. You can change most of the things you can show. you may also use info set. See [Index]. all of which are exceptional in lacking corresponding set commands: show version Show what version of gdb is running. page 567. as gdb evolves. For example. for example. you can use show with no arguments. set show Here are three miscellaneous show subcommands. You should include this information in gdb bug-reports. The listings under info and under show in the Index point to all the sub-commands. For example. Both commands produce the same display. this manual introduces each of them in the appropriate context. show copying info copying Display information about permission for copying gdb. or a warranty. you may need to determine which version of gdb you are running. Each command supports many topics of inquiry. you can set the gdb prompt to a $-sign with set prompt $. many system vendors ship variant versions of gdb. by using the related command set. show warranty info warranty Display the gnu “NO WARRANTY” statement. You can get a complete list of the info sub-commands with help info. The version number is the same as the one announced when you start gdb. show is for describing the state of gdb itself. or list the breakpoints you have set with info breakpoints. or simply inquire which is currently in use with show radix. you can control what number system is used for displays with set radix. you can show the arguments passed to a function with info args. new commands are introduced. and old ones may wither away. You can assign the result of an expression to an environment variable with set.

.

Chapter 4: Running Programs Under gdb 25 4 Running Programs Under gdb When you run a program under gdb. specify the ‘-g’ option when you run the compiler. gcc. for more information on gcc options affecting debug information. you must first generate debugging information when you compile it. you may redirect your program’s input and output. This debugging information is stored in the object file. in an environment of your choice. see Chapter 11 [Optimized Code]. Using those compilers. debug an already running process. However. .1 and later of gcc. DWARF is currently the most expressive and best supported debugging format in gdb. Programs that are to be shipped to your customers are compiled with optimizations. some compilers are unable to handle the ‘-g’ and ‘-O’ options together. page 135). the gnu C compiler. 4. or kill a child process. gdb knows about preprocessor macros and can show you their expansion (see Chapter 12 [Macros]. You may start gdb with its arguments. Version 3. supports ‘-g’ with or without ‘-O’. If you are doing native debugging. Older versions of the gnu C compiler permitted a variant option ‘-gg’ for debugging information. For more information. you need to generate debugging information when you compile it. do not use it. To request debugging information. if any. but there is no sense in pushing your luck. We recommend that you always use ‘-g’ whenever you compile a program. provides macro information if you are using the DWARF debugging format. See Section “Options for Debugging Your Program or GCC” in Using the gnu Compiler Collection (GCC). You will have the best debugging experience if you use the latest version of the DWARF debugging format that your compiler supports. page 131. it describes the data type of each variable or function and the correspondence between source line numbers and addresses in the executable code. you cannot generate optimized executables containing debugging information. making it possible to debug optimized code. gdb no longer supports this format. and specify the option ‘-g3’. You may think your program is correct. using the ‘-O’ compiler option.1 Compiling for Debugging In order to debug a program effectively. the gnu C/C++ compiler. if your gnu C compiler has this option. Most compilers do not include information about preprocessor macros in the debugging information if you specify the ‘-g’ flag alone.

Other targets. page 11).1 [Commands to Specify Files]. page 201). See Section 4. you cannot use pipes to pass the output of the program you are debugging to another program. then use continue to run your program. like ‘remote’. Your program inherits its working directory from gdb. If you are running your program in an execution environment that supports processes. or you can use the tty command to set a different device for your program. The execution of a program is affected by certain information it receives from its superior. You must first specify the program name (except on VxWorks) with an argument to gdb (see Chapter 2 [Getting In and Out of gdb]. gdb provides ways to specify this information. you can control which shell is used with the SHELL environment variable. Your program normally inherits its environment from gdb. are always running. The standard input and output.26 Debugging with gdb 4. the shell is used to pass the arguments. In some environments without processes.6 [Your Program’s Input and Output]. See Section 4. Specify the arguments to give your program as the arguments of the run command. Try "help target" or "continue".) This information may be divided into four categories: The arguments. You can redirect input and output in the run command line. run jumps to the start of your program. You can set the gdb working directory with the cd command in gdb. page 29. The environment. If you get an error message like this one: The "remote" target does not support "run". The working directory. In Unix systems. See Section 4. run creates an inferior process and makes that process run your program. If a shell is available on your target. or by using the file or exec-file command (see Section 18.5 [Your Program’s Working Directory]. but you can use the gdb commands set environment and unset environment to change parts of the environment that affect your program. page 28. which you must do before starting your program.3 [Your Program’s Arguments]. page 217). page 30. but such changes only affect your program the next time you start it. See Section 4. Your program normally uses the same device for standard input and standard output as gdb is using.4 [Your Program’s Environment]. if you attempt this. .2 Starting your Program run r Use the run command to start your program under gdb. Warning: While input and output redirection work. You may need load first (see [load]. gdb is likely to wind up debugging the wrong program. (You can change it after starting your program. page 30. so that you may use normal conventions (such as wildcard expansion or variable substitution) in describing the arguments.

but other languages such as Ada do not require a specific name for their main procedure. you can use env to pass an environment variable to the debugged program. In these cases. env and nohup. It is therefore possible that the debugger stops before reaching the main procedure. depending on the language used. the specified wrapper is used to launch programs for debugging. e. It is sometimes necessary to debug the program during elaboration. using the print or call commands. You can use any program that eventually calls execve with its arguments as a wrapper. The ‘start’ command does the equivalent of setting a temporary breakpoint at the beginning of the main procedure and then invoking the ‘run’ command. the main procedure name is always main. constructors for static and global objects are executed before main is called. The wrapper runs until it executes your program. If the modification time of your symbol file has changed since the last time gdb read its symbols. start The name of the main procedure can vary from language to language. Several standard Unix utilities do this. and then gdb takes control. without setting the variable in your shell’s environment: (gdb) set exec-wrapper env ’LD_PRELOAD=libtest. Any Unix shell script ending with exec "$@" will also work. See Chapter 5 [Stopping and Continuing]. using the start command would stop the execution of your program too late. Some programs contain an elaboration phase where some startup code is executed before the main procedure is called. gdb starts your program with a shell command of the form exec wrapper program. When it does this. Under these circumstances. so you should add quotes if appropriate for your shell. However. but not to wrapper. Once your program has stopped.g. your program begins to execute immediately. the temporary breakpoint will remain to halt execution. as the program would have already completed the elaboration phase.so’ (gdb) run . and reads it again. For example. you may call functions in your program. for instance. This depends on the languages used to write your program. The debugger provides a convenient way to start the execution of the program and to stop at the beginning of the main procedure. See Chapter 10 [Examining Data]. for discussion of how to arrange for your program to stop. In C++. Quoting is added to program and its arguments. page 97. Specify the arguments to give to your program as arguments to the ‘start’ command. With C or C++. gdb discards its symbol table. set exec-wrapper wrapper show exec-wrapper unset exec-wrapper When ‘exec-wrapper’ is set.Chapter 4: Running Programs Under gdb 27 When you issue the run command. page 43. These arguments will be given verbatim to the underlying ‘run’ command. insert breakpoints in your elaboration code before running your program. gdb tries to retain your current breakpoints. Note that the same arguments will be reused if no argument is provided during subsequent calls to ‘start’ or ‘run’.

MS Windows. Reading the shared library binary gives enough information for assembling the malicious code misusing it. Use set disable-randomization off to try to reproduce such elusive bugs. virtual address space randomization protects the programs against certain kinds of security attacks. Randomizing its location makes it impossible to inject jumps misusing a code at its expected addresses. such as gnu/Linux. Cygwin. On gnu/Linux you can get the same behavior using (gdb) set exec-wrapper setarch ‘uname -m‘ -R set disable-randomization off Leave the behavior of the started executable unchanged. This feature is implemented only on certain targets. Heap (malloc storage).3 Your Program’s Arguments The arguments to your program can be specified by the arguments of the run command. which do that for stand-alone programs. On targets where it is available. set disable-randomization set disable-randomization on This option (enabled by default in gdb) will turn off the native randomization of the virtual address space of the started program. Some bugs rear their ugly heads only when the program is loaded at certain addresses. 4. If your bug disappears when you run the program under gdb. stack and custom mmap areas are always placed randomly (as long as the randomization is enabled). that might be because gdb by default disables the address randomization on platforms. Position independent executables (PIE) contain position independent code similar to the shared libraries and therefore such executables get loaded at a randomly chosen address upon startup. which expands wildcard characters and performs redirection of . This option is useful for multiple debugging sessions to make the execution better reproducible and memory addresses reusable across debugging sessions. Still even a prelinked shared library can get loaded at a new random address just requiring the regular relocation process during the startup. and QNX Neutrino. Shared libraries not already prelinked are always loaded at a randomly chosen address. show disable-randomization Show the current setting of the explicit disable of the native randomization of the virtual address space of the started program. PIE executables always load even already prelinked shared libraries at a random address. In these cases the attacker needs to know the exact location of a concrete executable code.28 Debugging with gdb This command is available when debugging locally on most targets. excluding djgpp. Prelinking shared libraries provides a startup performance advantage but it makes addresses in these libraries predictable for privileged processes by having just unprivileged access at the target system. including gnu/Linux. You can build such executable using gcc -fPIE -pie. They are passed to a shell.

so it is searched sooner. show paths Display the list of search paths for executables (the PATH environment variable). If you use ‘. set environment varname [=value] Set environment variable varname to value. The value of PATH used by gdb does not change. it refers to the directory where you executed the path command. and thence to your program. path directory Add directory to the front of the PATH environment variable (the search path for executables) that will be passed to your program. using set args before the next run is the only way to run it again without arguments. which emulates I/O redirection via the appropriate system calls. the values of environment . value may be any string. You can use the string ‘$cwd’ to refer to whatever is the current working directory at the time gdb searches the path. gdb uses the default shell (‘/bin/sh’ on Unix).’ in the directory argument (with the current path) before adding directory to the search path. Environment variables conventionally record such things as your user name. it is moved to the front.4 Your Program’s Environment The environment consists of a set of environment variables and their values. or those set by the set args command. You may specify several directory names. print the names and values of all environment variables to be given to your program. gdb replaces ‘. the program is usually invoked directly by gdb. show environment [varname] Print the value of environment variable varname to be given to your program when it starts. 4. not by the shell. If set args has no arguments. If directory is already in the path. If you do not define SHELL. run executes your program with no arguments. and your search path for programs to run. and the wildcard characters are expanded by the startup code of the program.’ on MS-DOS and MS-Windows).’ instead. On non-Unix systems. run with no arguments uses the same arguments used by the previous run. Your SHELL environment variable (if it exists) specifies what shell gdb uses. You can abbreviate environment as env. show args Show the arguments to give your program when it is started. separated by whitespace or by a system-dependent separator character (‘:’ on Unix. The value changes for your program only. When debugging. Once you have run your program with arguments. your terminal type. your home directory. not for gdb itself. ‘. Usually you set up environment variables with the shell and they are inherited by all the other programs you run. set args Specify the arguments to be used the next time your program is run.Chapter 4: Running Programs Under gdb 29 I/O. If you do not supply varname. it can be useful to try running your program with a modified environment without having to start gdb over again.

4. page 201. you can use the info proc command (see Section 21. this command: set env USER = foo tells the debugged program. For example. 4. rather than assigning it an empty value.3 [SVR4 Process Information]. This is different from ‘set env varname =’.5 Your Program’s Working Directory Each time you start your program with run. If you work on a system where gdb is configured with the ‘/proc’ support. that its user is named ‘foo’. such as ‘. the program you run under gdb does input and output to the same terminal that gdb uses. unset environment removes the variable from the environment. gdb switches the terminal to its own terminal modes to interact with you. gdb runs your program using the shell indicated by your SHELL environment variable if it exists (or /bin/sh if not). when subsequently run. The gdb working directory is initially whatever it inherited from its parent process (typically the shell).) unset environment varname Remove variable varname from the environment to be passed to your program. the variable is set to a null value. but you can specify a new working directory in gdb with the cd command.6 Your Program’s Input and Output By default. Warning: On Unix systems. but it records the terminal modes your program was using and switches back to them when you continue running your program. The gdb working directory also serves as a default for the commands that specify files for gdb to operate on. . You may wish to move setting of environment variables to files that are only run when you sign on.profile’. If your SHELL variable names a shell that runs an initialization file—such as ‘. The value parameter is optional. or ‘. if it is eliminated. they are not actually required. it inherits its working directory from the current working directory of gdb. page 235) to find out the current working directory of the debuggee. pwd Print the gdb working directory. See Section 18. It is generally impossible to find the current working directory of the process being debugged (since a program can change its directory during its run). info terminal Displays information recorded by gdb about the terminal modes your program is using.30 Debugging with gdb variables are just strings. (The spaces around ‘=’ are used for clarity here.bashrc’ for BASH— any variables you set in that file affect your program. and any interpretation is supplied by your program itself.login’ or ‘.1.1 [Commands to Specify Files]. cd directory Set the gdb working directory to directory.cshrc’ for C-shell.

or with the ‘jobs -l’ shell command. This command accepts a file name as argument. your program must be running in an environment which supports processes.Chapter 4: Running Programs Under gdb 31 You can redirect your program’s input and/or output using shell redirection with the run command. For example.7 Debugging an Already-running Process attach process-id This command attaches to a running process—one that was started outside gdb. diverting its output to the file ‘outfile’. but not its effect on the controlling terminal. The input for gdb still comes from your terminal. You can insert breakpoints. set inferior-tty /dev/ttyb Set the tty for the program being debugged to /dev/ttyb. (info files shows your active targets. only the input for your program is affected. then (if the program is not found) by using the source file search path (see Section 9. page 90). page 201. To use attach. tty /dev/ttyb directs that processes started with subsequent run commands default to do input and output on the terminal ‘/dev/ttyb’ and have that as their controlling terminal. and causes this file to be the default for future run commands. You can examine and modify an attached process with all the gdb commands that are ordinarily available when you start processes with run.) The command takes as argument a process ID. tty is an alias for set inferior-tty. the debugger finds the program running in the process first by looking in the current working directory. When you use the tty command or redirect input in the run command. attach does not work for programs on bare-board targets that lack an operating system.1 [Commands to Specify Files]. It also resets the controlling terminal for the child process. See Section 18. attach does not repeat if you press RET a second time after executing the command. You can also use the file command to load the program. The usual way to find out the process-id of a Unix process is with the ps utility. 4. The first thing gdb does after arranging to debug the specified process is to stop it. You can use the show inferior-tty command to tell gdb to display the name of the terminal that will be used for future runs of your program. you can step and .5 [Specifying Source Directories]. An explicit redirection in run overrides the tty command’s effect on the input/output device. for future run commands. You must also have permission to send the process a signal. show inferior-tty Show the current tty for the program being debugged. When you use attach. run > outfile starts your program. For example. Another way to specify where your program should do input and output is with the tty command. for example.

You can use the kill command in this situation to permit running your program outside the debugger. Detaching the process continues its execution. Inferiors have unique identifiers that are different from process ids. you detach that process. although some embedded targets may have several inferiors running in different parts of a single address space. By default. gdb on some systems may let you run several programs simultaneously (otherwise you have to exit from one before starting another). If you exit gdb while you have an attached process. and may be retained after a process exits.9 Debugging Multiple Inferiors and Programs gdb lets you run and debug multiple programs in a single session. After the detach command. gdb displays for each inferior (in this order): 1. gdb notices that the file has changed. page 270). If you would rather the process continue running. you kill that process. a program cannot be executed outside gdb while you have breakpoints set on it inside gdb. you may use the continue command after attaching gdb to the process. you can use the detach command to release it from gdb control. Inferiors may be created before a process runs. detach When you have finished debugging the attached process. gdb asks for confirmation if you try to do either of these things. gdb ignores any core dump file while your program is running. In this case. This command is useful if you wish to debug a core dump instead of a running process. The kill command is also useful if you wish to recompile and relink your program. since on many systems it is impossible to modify an executable file while it is running in a process. In addition. and reads the symbol table again (while trying to preserve your current breakpoint settings). 4. you can have multiple threads of execution in each of multiple processes. the inferior number assigned by gdb . gdb represents the state of each program execution with an object called an inferior. you can control whether or not you need to confirm by using the set confirm command (see Section 22. Each inferior may in turn have multiple threads running in it. and you are ready to attach another process or start one with run. that process and gdb become completely independent once more. detach does not repeat if you press RET again after executing the command.7 [Optional Warnings and Messages]. but is more general and applies also to targets that do not have processes. To find out what inferiors exist at any moment. If you use the run command.32 Debugging with gdb continue. An inferior typically corresponds to a process. when you next type run. In the most general case. On some operating systems. Usually each inferior will also have its own distinct address space.8 Killing the Child Process kill Kill the child process in which your program is running under gdb. 4. use info inferiors: info inferiors Print a list of all inferiors currently being managed by gdb. launched from multiple executables. you can modify storage.

remove-inferiors infno. you can either detach from it by using the detach inferior command (allowing it to run independently). . Removes the inferior or inferiors infno . (gdb) info inferiors Num Description 2 process 2307 * 1 process 3401 Executable hello goodbye To switch focus between inferiors.. the target system’s inferior identifier 3. You can still assign or change the program assigned to the inferior at any time by using the file command with the executable name as its argument. . use the kill or detach command first. (gdb) info inferiors Num Description 2 <null> * 1 process 29964 Executable helloworld Executable helloworld helloworld You can now simply switch focus to inferior 2 and run it. 1 inferiors added.Chapter 4: Running Programs Under gdb 33 2. with no program. the name of the executable the inferior is running. infno defaults to the number of the current inferior. n defaults to 1. clone-inferior [ -copies n ] [ infno ] Adds n inferiors ready to execute the same program as inferior infno. as shown in the first field of the ‘info inferiors’ display. On some systems gdb can add inferiors to the debug session automatically by following calls to fork and exec. An asterisk ‘*’ preceding the gdb inferior number indicates the current inferior. add-inferior [ -copies n ] [ -exec executable ] Adds n inferiors to be run using executable as the executable. use the inferior command: inferior infno Make inferior number infno the current inferior. The argument infno is the inferior number assigned by gdb. For example. For those. (gdb) info inferiors Num Description * 1 process 29964 (gdb) clone-inferior Added inferior 2. . n defaults to 1. or kill it using the kill inferiors command: . This is a convenient command when you want to run another instance of the inferior you are debugging. the inferiors begins empty. It is not possible to remove an inferior that is running with this command. To remove inferiors from the debugging session use the remove-inferiors command.. If no executable is specified. To quit debugging one of the running inferiors that is not the current inferior. You can get multiple executables into a debugging session via the add-inferior and clone-inferior commands.

or after a normal process exit. the inferior is still valid and listed with info inferiors. but its Description will show ‘<null>’. An asterisk ‘*’ preceding the gdb program space number indicates the current program space. Detach from the inferior or inferiors identified by gdb inferior number(s) infno . After the successful completion of a command such as detach. below each program space line..34 Debugging with gdb detach inferior infno. (gdb) maint info program-spaces Id Executable 2 goodbye Bound inferiors: ID 1 (process 21561) . Kill the inferior or inferiors identified by gdb inferior number(s) infno . it may be useful to get more info about the relationship of inferiors. print myglobal will simply display the value of myglobal in the current inferior. exited or have been detached. ready to be restarted.. .. For example.. the list of inferiors bound to the program space. In addition. these messages will not be printed. Note that the inferior’s entry still stays on the list of inferiors shown by info inferiors. By default. kill or kill inferiors.g. address spaces in a debug session. You can do that with the maint info program-spaces command.g. To be notified when inferiors are started or exit under gdb’s control use set print inferior-events: set print inferior-events set print inferior-events on set print inferior-events off The set print inferior-events command allows you to enable or disable printing of messages when gdb notices that new inferiors have started or that inferiors have exited or have been detached. Many commands will work the same with multiple programs as with a single program: e. . . the name of the executable loaded into the program space. detach inferiors. when debugging gdb itself. . the file command. Note that the inferior’s entry still stays on the list of inferiors shown by info inferiors. gdb prints extra information that isn’t suitable to display in tabular form. Occasionaly. kill inferiors infno. with e. .. gdb displays for each program space (in this order): 1. but its Description will show ‘<null>’. programs. .. the program space number assigned by gdb 2. show print inferior-events Show whether messages will be printed when gdb detects that inferiors have started. maint info program-spaces Print a list of all program spaces currently being managed by gdb.

The most common example is that of debugging both the parent and child processes of a vfork call. a command to apply a command to a list of threads • thread-specific breakpoints • ‘set print thread-events’. but in general the threads of a single program are akin to multiple processes—except that they share one address space (that is. it is possible that multiple inferiors are bound to the same program space. such as HP-UX and Solaris. On the other hand. a command to switch among threads • ‘info threads’. while process 21561 is running the program goodbye. Use the "info threads" command to see the IDs of currently known threads. and always rejects the thread command. each thread has its own registers and execution stack. For example. both inferior 2 and inferior 1 are running in the same program space as a result of inferior 1 having executed a vfork call. This thread is called the current thread. which lets the user specify which libthread_ db to use if the default choice isn’t compatible with the program. (gdb) maint info program-spaces Id Executable * 1 vfork-test Bound inferiors: ID 2 (process 18050). On some targets.Chapter 4: Running Programs Under gdb 35 * 1 hello Here we can see that no inferior is running the program hello. For example. Debugging commands show program information from the perspective of the current thread. gdb provides these facilities for debugging multi-thread programs: • automatic notification of new threads • ‘thread threadno’.10 Debugging Programs with Multiple Threads In some operating systems. they can all examine and modify the same variables). one thread in particular is always the focus of debugging. . ID 1 (process 18045) Here. a system without thread support shows no output from ‘info threads’. a single program may have more than one thread of execution. these commands have no effect. like this: (gdb) info threads (gdb) thread 1 Thread ID 1 not known. • ‘set libthread-db-search-path path’. The gdb thread debugging facility allows you to observe all threads while your program runs—but whenever gdb takes control. Warning: These facilities are not yet available on every gdb configuration where the operating system supports threads. If your gdb does not support threads. and perhaps private memory. 4. which controls printing of messages on thread start and exit. The precise semantics of threads differ from one operating system to another. a command to inquire about existing threads • ‘thread apply [threadno] [all] args’.

A thread can either be named by the user (see thread name. the target system’s thread identifier (systag) 3. .c:8 8 printf ("hello\n"). For debugging purposes. Optional argument id. the form of the text after ‘Switching to’ depends on your system’s conventions for identifying threads. You may find this useful in writing breakpoint conditional expressions. For example. as shown in the first field of the ‘info threads’ display.36 Debugging with gdb Whenever gdb detects a new thread in your program. . if one is known. The debugger convenience variable ‘$_thread’ contains the number of the current thread. and so forth.. you can display more information about user threads with a Solaris-specific command: maint info sol-threads Display info on Solaris user threads...11 [Convenience Variables].] Display a summary of all threads currently in your program. command scripts. you might see [New Thread 0x41e02940 (LWP 25582)] when gdb notices a new thread. The command argument threadno is the internal gdb thread number. it displays the target system’s identification for the thread with a message in the form ‘[New systag]’. gdb displays for each thread (in this order): 1.. and its current stack frame summary: (gdb) thread 2 [Switching to thread 2 (Thread 0xb7fdab70 (LWP 12747))] #0 some_function (ignore=0x0) at example. the thread number assigned by gdb 2. and means to print information only about the specified thread or threads. or. As with the ‘[New . on gnu/Linux. For example. systag is a thread identifier whose form varies depending on the particular system. in some cases. info threads [id. the thread’s name. thread threadno Make thread number threadno the current thread. 4. gdb associates its own thread number—always a single integer—with each thread in your program. below). is one or more thread ids separated by spaces. . by the program itself. on an SGI system. In contrast. page 117. gdb responds by displaying the system identifier of the thread you selected. with no further qualifier.c:68 Frame 27 0x34e5 in sigpause () 23 0x34e5 in sigpause () 13 main (argc=1. the systag is simply something like ‘process 368’. See See Section 10. for general information on convenience variables. (gdb) info threads Id Target Id 3 process 35 thread 2 process 35 thread * 1 process 35 thread at threadtest.]’ message. the current stack frame summary for that thread An asterisk ‘*’ to the left of the gdb thread number indicates the current thread. argv=0x7ffffff8) On Solaris.

The thread name appears in the ‘info threads’ display. It can be a single thread number.1. See Section 5. a name specified with ‘thread name’ will override the system-give name. such as gnu/Linux. for more information about how gdb behaves when you stop and start programs with multiple threads. By default. on gnu/Linux. (gdb) thread find 26688 Thread 4 has target id ’Thread 0x41e02940 (LWP 26688)’ (gdb) info thread 4 Id Target Id Frame 4 Thread 0x41e02940 (LWP 26688) 0x00000031ca6cd372 in select () set print thread-events set print thread-events on set print thread-events off The set print thread-events command allows you to enable or disable printing of messages when gdb notices that new threads have started or that threads have exited. See Section 5.5 [Stopping and Starting Multi-thread Programs]. On these systems. If no argument is given. As well as being the complement to the ‘thread name’ command. or it could be a range of thread numbers. On some systems. Note that these messages cannot be disabled on all targets. gdb is able to determine the name of the thread as given by the OS. set libthread-db-search-path [path] If this variable is set. show print thread-events Show whether messages will be printed when gdb detects that threads have started and exited.Chapter 4: Running Programs Under gdb 37 thread apply [threadno | all] command The thread apply command allows you to apply the named command to one or more threads. this command also allows you to identify a thread by its target systag. page 68. the target systag is the LWP id. For instance. for information about watchpoints in programs with multiple threads. and removing the user-specified name will cause gdb to once again display the system-specified name. type thread apply all command. To apply a command to all threads. one of the numbers shown in the first field of the ‘info threads’ display. these messages will be printed if detection of these events is supported by the target. path is a colon-separated list of directories gdb will use to search for libthread_db. thread name [name] This command assigns a name to the current thread. thread find [regexp] Search for and display thread ids whose name or systag matches the supplied regular expression. page 49. ‘libthread-db-search-path’ . Specify the numbers of the threads that you want affected with the command argument threadno. any existing user-specified name is removed.2 [Setting Watchpoints]. as in 2-4. If you omit path.

If none of libthread_db libraries initialize successfully. Internally. gdb provides support for debugging programs that create additional processes using the fork or vfork functions. Then tell gdb (a new invocation of gdb if you are also debugging the parent process) to attach to the child process (see Section 4. gdb will issue a warning and thread debugging will be disabled. show libthread-db-search-path Display current libthread db search path.38 Debugging with gdb will be reset to its default value ($sdir:$pdir on gnu/Linux and Solaris systems). if you want to debug the child process there is a workaround which isn’t too painful. gdb will continue to debug the parent process and the child process will run unimpeded. When a program forks. On some systems. Put a call to sleep in the code which the child process executes after the fork. when a program forks. On gnu/Linux and Solaris systems. gdb will use ‘libthread-db-search-path’ to find libthread_db.5. Use 1 to enable. . so that the delay need not occur when you don’t want to run gdb on the child. A special entry ‘$pdir’ for ‘libthread-db-search-path’ refers to the directory from which libpthread was loaded in the inferior process. and continue with the next directory.x and later only?) and gnu/Linux (kernel version 2. Setting libthread-db-search-path is currently implemented only on some platforms. While the child is sleeping. If this initialization fails (which could happen because of a version mismatch between libthread_db and libpthread). the child will get a SIGTRAP signal which (unless it catches the signal) will cause it to terminate. If you have set a breakpoint in any code which the child then executes. From that point on you can debug the child process just like any other process which you attached to. gdb uses a “helper” libthread_db library to obtain information about threads in the inferior process. 4. A special entry ‘$sdir’ for ‘libthread-db-search-path’ refers to the default system directories that are normally searched for loading shared libraries.7 [Attach]. 0 to disable. gdb will continue to debug the parent process and the child process will run unimpeded. gdb has no special support for debugging programs which create additional processes using the fork function. or a certain file exists. the only platforms with this feature are HP-UX (11. set debug libthread-db show debug libthread-db Turns on or off display of libthread_db-related events. However. Currently. gdb will unload libthread_db. the default value comes from the LIBTHREAD_DB_SEARCH_ PATH macro.60 and later).11 Debugging Forks On most systems. use the ps program to get its process ID. page 31). By default. It may be useful to sleep only if a certain environment variable is set. For any libthread_db library gdb finds in above directories. gdb attempts to initialize it with the current inferior process.

when a child process is spawned by vfork. You can list the forked processes under the control of gdb by using the info inferiors command. you can either detach from it by using the detach inferiors command (allowing it to run independently). if you want to debug both the parent and child processes. On some systems. while the other is held suspended. gdb discards the symbols of the previous executable image. depending on the value of follow-fork-mode) will be detached and allowed to run independently. The new process is debugged after a fork. on The child process (or parent process. If you ask to debug a child process and a vfork is followed by an exec.9 [Debugging Multiple Inferiors and Programs]. depending on the value of follow-fork-mode) is debugged as usual.Chapter 4: Running Programs Under gdb 39 If you want to follow the child process instead of the parent process. or kill it using the kill inferiors command. If you have a breakpoint set on main in your original program. One process (child or parent. If you choose to set ‘detach-on-fork’ mode off. To restart the parent process. the breakpoint will also be set on the child process’s main.9 [Debugging Multiple Inferiors and Programs]. off show detach-on-fork Show whether detach-on-fork mode is on/off. you cannot debug the child or parent until an exec call completes. This is the default. then gdb will retain control of all forked processes (including nested forks). To quit debugging one of the forked processes. page 32). set follow-fork-mode mode Set the debugger response to a program call of fork or vfork. the new target restarts. A call to fork or vfork creates a new process. or retain debugger control over them both. This is the default. show follow-fork-mode Display the current debugger response to a fork or vfork call. On Linux. The child process runs unimpeded. Both processes will be held under the control of gdb. The parent process runs unimpeded. after an exec call executes. use the command set detach-on-fork. . The mode argument can be: parent child The original process is debugged after a fork. You can change this behaviour with the set follow-exec-mode command. page 32. See Section 4. and switch from one fork to another by using the inferior command (see Section 4. set detach-on-fork mode Tells gdb whether to detach one of the processes after a fork. If you issue a run command to gdb after an exec call executes. use the command set follow-fork-mode. By default. use the file command with the parent executable name as its argument. gdb executes the new target up to the first breakpoint in the new target.

For example: (gdb) info inferiors (gdb) info inferior Id Description Executable * 1 <null> prog1 (gdb) run process 12020 is executing new program: prog2 Program exited normally. An exec call replaces the program image of a process. Then. (gdb) info inferiors Id Description Executable * 1 <null> prog2 You can use the catch command to make gdb stop whenever a fork. you can save a checkpoint. and even (within some limits) system state. follow-exec-mode can be: new gdb creates a new inferior and rebinds the process to this new inferior. it is like going back in time to the moment when the checkpoint was saved.1. vfork. This includes changes in memory. page 52. only gnu/Linux. or exec call is made. with e. if you’re stepping thru a program and you think you’re getting close to the point where things go wrong.. Returning to a checkpoint effectively undoes everything that has happened in the program since the checkpoint was saved. For example: (gdb) info inferiors Id Description Executable * 1 <null> prog1 (gdb) run process 12020 is executing new program: prog2 Program exited normally. This is the default mode. Restarting the inferior after the exec call. called a checkpoint. gdb is able to save a snapshot of a program’s state. the run command. and come back to it later. if you accidentally go too far and 1 Currently. See Section 5. The new executable image replaces the previous executable loaded in the inferior. Effectively.40 Debugging with gdb set follow-exec-mode mode Set debugger response to a program call of exec. 4. registers.3 [Setting Catchpoints].g. (gdb) info inferiors Id Description Executable * 2 <null> prog2 1 <null> prog1 same gdb keeps the process bound to the same inferior. The program the process was running before the exec call can be restarted afterwards by restarting the original inferior. . Thus. restarts the executable the process was running after the exec call.12 Setting a Bookmark to Return to Later On certain operating systems1 .

are not affected by restoring a checkpoint. Similarly. All program variables. plus a significant subset of the system (OS) state. but each checkpoint is assigned a small integer id. stack frames etc. . there is one bit of internal program state that will be different when you return to a checkpoint — the program’s process id. delete checkpoint checkpoint-id Delete the previously-saved checkpoint identified by checkpoint-id. It won’t “un-write” data from a file. command history etc. To use the checkpoint/restart method of debugging: checkpoint Save a snapshot of the debugged program’s current execution state. you actually can “rewind” your program to a previously saved point in time. the pointer will also be restored so that the previously read data can be read again. you can just go back to the checkpoint and start again from there. and characters received from eg. registers. instead of having to restart your program from the beginning. ready to be received again. However. will be returned to the values that they had when the checkpoint was saved. the following information will be listed: Checkpoint ID Process ID Code Address Source line. The checkpoint command takes no arguments. For files opened in read mode. This can be especially useful if it takes a lot of time or steps to reach the point where you think the bug occurs. If your program has saved a local copy of its process id. Note that breakpoints. but they cannot be “pushed back” into the serial pipeline. a checkpoint only restores things that reside in the program being debugged. and each will be different from the program’s original pid. Of course. and begin debugging it again — and you can change the course of events so as to debug a different execution path this time.Chapter 4: Running Programs Under gdb 41 miss the critical statement. so that the previously written data can be overwritten. info checkpoints List the checkpoints that have been saved in the current debugging session. or label restart checkpoint-id Restore the program state that was saved as checkpoint number checkpoint-id. For each checkpoint. this could potentially pose a problem. characters that have been sent to a printer (or other external device) cannot be “snatched back”. gdb variables. Finally. not in the debugger. Returning to a previously saved checkpoint will restore the user state of the program being debugged. Each checkpoint will have a unique process id (or pid). including file pointers. In essence. a serial device can be removed from internal program buffers. In general. the actual contents of files that have been changed cannot be restored (at this time). within those constraints. gdb will “wind back the clock” to the point in time when the checkpoint was saved. similar to a breakpoint id. but it will rewind the file pointer to the previous location.

address space randomization is performed on new processes for security reasons. or watchpoint. on an absolute address if you have to restart the program. however.42 Debugging with gdb 4. is an identical copy of a process. Therefore if you create a checkpoint at (eg. and simply return to that checkpoint instead of restarting the process. since the absolute location of a symbol will change from one execution to the next. . This makes it difficult or impossible to set a breakpoint. you can avoid the effects of address randomization and your symbols will all stay in the same place.12.1 A Non-obvious Benefit of Using Checkpoints On some systems such as gnu/Linux.) the start of main. A checkpoint.

if your program runs into trouble. set new breakpoints or remove old ones. but aside from that. or catchpoint when you create it. such as a signal. watchpoint. On some systems. A catchpoint is another special breakpoint that stops your program when a certain kind of event occurs. As with watchpoints. You can set breakpoints with the break command and its variants (see Section 5. and why it stopped. or it could involve values of one or more variables combined by operators.1 Breakpoints. you can manage a watchpoint like any other breakpoint: you enable. You can arrange to have values from your program displayed automatically whenever gdb stops at a breakpoint.Chapter 5: Stopping and Continuing 43 5 Stopping and Continuing The principal purposes of using a debugger are so that you can stop your program before it terminates. Usually. you can manage a catchpoint like any other breakpoint. A watchpoint is a special breakpoint that stops your program when the value of an expression changes. Watchpoints. to specify the place where your program should stop by line number. the messages shown by gdb provide ample explanation of the status of your program—but you can also explicitly request this information at any time. In many of the commands for controlling various features of breakpoints you use the breakpoint number to say which breakpoint you want to change. a breakpoint.2 [Setting Watchpoints]. disable.3 [Setting Catchpoints]. page 49).4 [Signals]. it has no effect on your program until you enable it again. You may then examine and change variables.1.1 [Setting Breakpoints].1. or reaching a new line after a gdb command such as step. but aside from that. and then continue execution. routines that are arguments in a pthread_create call). You must use a different command to set watchpoints (see Section 5. you can set breakpoints in shared libraries before the executable is run. page 66. use the handle command. if disabled. For each breakpoint. . There is a minor limitation on HP-UX systems: you must wait until the executable is run in order to set breakpoints in shared library routines that are not called directly by the program (for example. See Section 10. This is sometimes called data breakpoints.1. page 105. and delete both breakpoints and watchpoints using the same commands. these numbers are successive integers starting with one. your program may stop for any of several reasons. (To stop when your program receives a signal. or so that. info program Display information about the status of your program: whether it is running or not.) gdb assigns a number to each breakpoint. The expression may be a value of a variable. you can investigate and find out why. what process it is. such as the throwing of a C++ exception or the loading of a library. see Section 5. Inside gdb. page 52). you use a different command to set a catchpoint (see Section 5. Each breakpoint may be enabled or disabled. and Catchpoints A breakpoint makes your program stop whenever a certain point in the program is reached. function name or exact address in the program. you can add conditions to control in finer detail whether your program stops. such as ‘a + b’. 5. page 44).7 [Automatic Display].

. for a list of all the possible ways to specify a location.6 [Break Conditions]. It is also possible to insert a breakpoint that will stop the program only if a specific thread (see Section 5. When a breakpoint range is given to a command. (See Section 9. if cond Set a breakpoint with condition cond. gdb stops the next time it reaches the current location. all breakpoints in that range are operated on.44 Debugging with gdb Some gdb commands accept a range of breakpoints on which to operate. See Section 10. and the breakpoint is set in the same way. this may be useful inside loops. or two such numbers. until at least one instruction has been executed.) The breakpoint will stop your program just before it executes any of the code in the specified location.’ stands for one of the possible arguments described above (or no argument) specifying where to break. break location Set a breakpoint at the given location. args are the same as for the break command. separated by a hyphen.4. When using source languages that permit overloading of symbols. evaluate the expression cond each time the breakpoint is reached. a function name may refer to more than one possible place to break. and stop only if the value is nonzero—that is. like ‘5’. or an address of an instruction.. page 98.5. page 117. break . page 183) hits that breakpoint. for a discussion of that situation.5 [Ada Tasks]. The debugger convenience variable ‘$bpnum’ records the number of the breakpoint you’ve set most recently. such as C++. like ‘5-7’. ‘. break sets a breakpoint at the next instruction to be executed in the selected stack frame (see Chapter 8 [Examining the Stack]. page 57. see Section 10.. If you use break without an argument in the innermost frame. you would be unable to proceed past a breakpoint without first disabling the breakpoint.4 [Thread-Specific Breakpoints]. If it did not do this. break When called without any arguments. 5.1. a line number. if cond evaluates as true.2 [Ambiguous Expressions]. See Section 5.11 [Convenience Variables]. This rule applies whether or not the breakpoint already existed when your program stopped.2 [Specify Location]. tbreak args Set a breakpoint enabled only for one stop. which can specify a function name. A breakpoint range is either a single breakpoint number. but the breakpoint is auto- .. page 88. for more information on breakpoint conditions. This is similar to the effect of a finish command in the frame inside the selected frame—except that finish does not leave an active breakpoint. for a discussion of what you can do with convenience variables. gdb normally ignores breakpoints when it resumes execution.1 Setting Breakpoints Breakpoints are set with the break command (abbreviated b). this makes your program stop as soon as control returns to that frame.8. page 81). page 72) or a specific task (see Section 15.1. In any selected frame but the innermost. in increasing order.

The main purpose of this is EPROM/ROM code debugging.5 [Disabling Breakpoints]. printing a list of all breakpoints it set. See Section 5.6 [Break Conditions]. they are treated just like the breakpoints set with the break command. You can delete them. See Section 5.1. There is an implicit . so you can set a breakpoint at an instruction without changing the instruction.1. args are the same as for the hbreak command and the breakpoint is set in the same way. page 227. like this: (gdb) rbreak . like the tbreak command. See Section 5. This command sets an unconditional breakpoint on all matches. This can be used with the new trap-generation provided by SPARClite DSU and most x86-based targets. Delete or disable unused hardware breakpoints before setting new ones (see Section 5. rbreak regex Set breakpoints on all functions matching the regular expression regex. However. so to match only functions that begin with foo.5 [Disabling Breakpoints]. page 57. so for instance foo* matches all functions that include an fo followed by zero or more os. thbreak args Set a hardware-assisted breakpoint enabled only for one stop. . page 57.6 [Break Conditions]. See also Section 5.Chapter 5: Stopping and Continuing 45 matically deleted after the first time your program stops there. rbreak is useful for setting breakpoints on overloaded functions that are not members of any special classes. Once these breakpoints are set. For remote targets. only two data breakpoints can be set at a time. These targets will generate traps when a program accesses some data or instruction address that is assigned to the debug registers. you can restrict the number of hardware breakpoints gdb will use.1. but the breakpoint requires hardware support and some target hardware may not have this support.1. Note that this is different from the syntax used by shells. or make them conditional the same way as any other breakpoint. page 56. like the hbreak command. page 56. The rbreak command can be used to set breakpoints in all the functions in a program. However the hardware breakpoint registers can take a limited number of breakpoints. For example.* leading and trailing the regular expression you supply. The syntax of the regular expression is the standard one used with tools like ‘grep’. args are the same as for the break command and the breakpoint is set in the same way. and gdb will reject this command if more than two are used.1. the breakpoint is automatically deleted after the first time your program stops there. use ^foo. hbreak args Set a hardware-assisted breakpoint. page 56).5 [Disabling Breakpoints]. disable them. Also. on the DSU. the breakpoint requires hardware support and some target hardware may not have this support. see [set remote hardware-breakpoint-limit]. When debugging C++ programs.

info break shows the condition on the line following the affected breakpoint. Such breakpoint won’t fire until a shared library that has the symbol or line referred by breakpoint is loaded. Address Where the breakpoint is in your program.. info breakpoints [n. The colon separating the filename qualifier from the regex may optionally be surrounded by spaces. as a file and line number. watchpoints. for example. Optional argument n means print information only about the specified breakpoint(s) (or watchpoint(s) or catchpoint(s)). following columns are printed: Breakpoint Numbers Type Breakpoint. page 103). to set breakpoints on every function in a given file: (gdb) rbreak file. For a pending breakpoint whose address is not yet known. For each breakpoint... look at the breakpoint info to see . A pending breakpoint is allowed to have a condition specified for it.46 Debugging with gdb rbreak file:regex If rbreak is called with a filename qualification. this field will contain ‘<PENDING>’. watchpoint. What If a breakpoint is conditional. are listed after that. or catchpoint. This can be used. the original string passed to the breakpoint command will be listed as it cannot be resolved until the appropriate shared library is loaded in the future. if any. For a pending breakpoint. A breakpoint with several locations will have ‘<MULTIPLE>’ in this field—see below for details. and catchpoints set and not deleted.. This is especially useful in conjunction with the ignore command. The condition is not parsed for validity until a shared library is loaded that allows the pending breakpoint to resolve to a valid location. Disposition Whether the breakpoint is marked to be disabled or deleted when hit.6 [Examining Memory].] info break [n. See below for details.c:. Where the breakpoint is in the source for your program. Enabled or Disabled Enabled breakpoints are marked with ‘y’. breakpoint commands. info break with a breakpoint number n as argument lists only that breakpoint. You can ignore a large number of breakpoint hits. info break displays a count of the number of times the breakpoint has been hit. as a memory address. The convenience variable $_ and the default examining-address for the x command are set to the address of the last breakpoint listed (see Section 10. it limits the search for functions matching the given regular expression to the specified file.] Print a table of all breakpoints. ‘n’ marks breakpoints that are not enabled.

when the library is not loaded. Typically.location-number as argument to the enable and disable commands.6 [Break Conditions]. gdb will ask you if you want to set a so called pending breakpoint—breakpoint whose address is not yet resolved. you can only delete the entire list of locations that belong to their parent breakpoint (with the delete num command. The number column for a location is of the form breakpoint-number. gdb allows you to set any number of breakpoints at the same place in your program. and possibly repeatedly. Note that you cannot delete the individual locations from the list. • For an inlined function.2 Each location can be individually enabled or disabled by passing breakpointnumber.Chapter 5: Stopping and Continuing 47 how many times the breakpoint was hit. a given line in the function can correspond to any number of instantiations. A breakpoint with multiple locations is displayed in the breakpoint table using several rows—one header row.cc:8 1. 1 in the above example). followed by one row for each breakpoint location. To support this use case. whenever a new shared library is loaded. There is nothing silly or meaningless about this. In all those cases. the gcc compiler generates several instances of the function body. gdb will insert a breakpoint at all the relevant locations1 .location-number. • For a C++ template function. This means that they will generally not work in system libraries. used in different cases. and show the functions to which those locations belong.1 1. gdb reevaluates all the breakpoints. ignoring one less than that number.5 [Disabling]. where num is the number of the parent breakpoint. After the program is run. Disabling or enabling the parent breakpoint (see Section 5. page 56) affects all of the locations that belong to that breakpoint. and when the symbols from the library are not available. a given source line can correspond to several places where that function is inlined. Shared libraries can be loaded and unloaded explicitly. The header row has ‘<MULTIPLE>’ in the address column. Examples of this situation are: • For a C++ constructor. The rows for individual locations contain the actual addresses for locations. you would set a breakpoint in a shared library at the beginning of your debugging session.1. unless you have debug info with line numbers for them. this is even useful (see Section 5. For example: Num 1 Type Disp Enb breakpoint keep y stop only if i==1 breakpoint already hit 1 y y Address What <MULTIPLE> time 0x080486a2 in void foo<int>() at t. When you try to set breakpoint. When the breakpoints are conditional.cc:8 0x080486ca in void foo<double>() at t.1. and then run again. When a newly loaded shared library contains the symbol or line referred to by 1 As of this writing. It’s quite common to have a breakpoint inside a shared library. as the program is executed. It is possible that a breakpoint corresponds to several locations in your program. multiple-location breakpoints work only if there’s line number information for all the locations. page 57). gdb updates breakpoint locations whenever any shared library is loaded or unloaded. This will get you quickly to the last hit of that breakpoint. .

set breakpoint pending on This indicates that an unrecognized breakpoint location should automatically result in a pending breakpoint being created. a new location is added to the list of locations for the breakpoint. the program code is so modified only when the program is resumed. You can control this automatic behaviour with the following commands:: set breakpoint auto-hw on This is the default behavior. set breakpoint pending off This indicates that pending breakpoints are not to be created. set breakpoint auto-hw off This indicates gdb should not automatically select breakpoint type. If the target provides a memory map. You can set conditions or commands. This setting does not affect any pending breakpoints previously created. which. gdb restores the original instructions. all breakpoints that refer to its symbols or source lines become pending again. gdb will warn when trying to set software breakpoint at a read-only address. gdb will always use hardware breakpoints. For breakpoints set with hbreak. too. given control to the debugger. if you have a breakpoint in a C++ template function. Except for having unresolved address. Any unrecognized breakpoint location results in an error. For example. This behaviour guards against . when executed. it will try to use the target memory map to decide if software or hardware breakpoint must be used. When a library is unloaded. it queries you whether a pending breakpoint should be created. pending breakpoints do not differ from regular breakpoints. When gdb cannot find the breakpoint location. When gdb sets a breakpoint. This applies to breakpoints set with the break command as well as to internal breakpoints set by commands like next and finish. By default. For some targets. gdb can automatically decide if hardware or software breakpoints should be used. Once breakpoint is set. it will be automatically updated as shared libraries are loaded and unloaded. This logic works for breakpoints with multiple locations. depending on whether the breakpoint address is read-only or read-write. As soon as the program stops. and a newly loaded shared library has an instantiation of that template. gdb normally implements breakpoints by replacing the program code at the breakpoint address with a special instruction. that breakpoint is resolved and becomes an ordinary breakpoint. gdb provides some additional commands for controlling what happens when the ‘break’ command cannot resolve breakpoint address specification to an address: set breakpoint pending auto This is the default behavior. show breakpoint pending Show the current behavior setting for creating pending breakpoints. enable and disable them and perform other breakpoint operations.48 Debugging with gdb some pending breakpoint. The settings above only affect the break command and its variants.

2 Setting Watchpoints You can use a watchpoint to stop execution whenever the value of an expression changes. or as complex as many variables combined by operators. If gdb is controlling the inferior in non-stop mode (see Section 5. gdb behaves as if breakpoint always-inserted mode is off. gdb behaves as if breakpoint always-inserted mode is on. or changes an existing breakpoint. without having to predict a particular place where this may happen. watchpoints may be implemented in software or hardware. The expression can use any operators valid in the program’s native language (see Chapter 15 [Languages]. including newly added by the user. For example. set breakpoint always-inserted on Causes all breakpoints to be inserted in the target at all times. Depending on your system. are inserted in the target only when the target is resumed. For instance. A breakpoint is removed from the target only when breakpoint itself is removed.2 [Non-Stop Mode].) . gdb will stop when your program sets ‘global_ptr’ and the expression produces a valid value. set breakpoint always-inserted auto This is the default mode. to catch errors where you have no clue what part of your program is the culprit. gdb may not stop until the next time the expression changes.1. If gdb is controlling the inferior in all-stop mode. If the user adds a new breakpoint. page 69). which is hundreds of times slower than normal execution. page 457). (But this may still be worth it. This behavior can be controlled with the following commands:: set breakpoint always-inserted off All breakpoints. with slow remote targets.g. (This is sometimes called a data breakpoint. such as proper handling of longjmp (in C programs). ‘info breakpoints’ does not display them. You can see these breakpoints with the gdb maintenance command ‘maint info breakpoints’ (see [maint info breakpoints]. page 161). All breakpoints are removed from the target when it stops. starting with -1. • An address cast to an appropriate data type.Chapter 5: Stopping and Continuing 49 leaving breakpoints inserted in the target should gdb abrubptly disconnect. Examples include: • A reference to the value of a single variable. You can set a watchpoint on an expression even if the expression can not be evaluated yet. If the expression becomes valid in some other way than changing a variable (e. 5. inserting and removing breakpoint can reduce the performance. gdb does software watchpointing by single-stepping your program and testing the variable’s value each time. you can set a watchpoint on ‘*global_ptr’ before ‘global_ptr’ is initialized. However. gdb itself sometimes sets breakpoints in your program for special purposes. such as ‘a*b + c/d’. These internal breakpoints are assigned negative numbers. • An arbitrarily complex expression.) The expression may be as simple as the value of a single variable.5. the breakpoints in the target are updated immediately. if the memory pointed to by ‘*global_ptr’ becomes readable as the result of a malloc call). ‘*(int *)0x12345678’ will watch a 4-byte region at the specified address (assuming an int occupies 4 bytes).

gdb will not break. The simplest (and the most popular) use of this command is to watch the value of a single variable: (gdb) watch foo If the command includes a [thread threadnum] argument. The type of the result is used to determine the size of the watched memory. PowerPC. If any other threads change the value of expr. Note that watchpoints restricted to a single thread in this way only work with Hardware Watchpoints. gdb refuses to create a watchpoint that watches a never-changing value: (gdb) watch 0x600850 Cannot watch constant value 0x600850. gdb will evaluate expr. info watchpoints [n. gdb breaks only when the thread identified by threadnum changes the value of expr. gnu/Linux and most other x86-based targets. using the same format as info break (see Section 5. then gdb will print an error. Thus..50 Debugging with gdb On some systems. which do not slow down the running of your program. take the address of the result.1 [Set Breaks].. watch [-l|-location] expr [thread threadnum] [mask maskvalue] Set a watchpoint for an expression. Examples: (gdb) watch foo mask 0xffff00ff (gdb) watch *0xdeadbeef mask 0xffffff00 rwatch [-l|-location] expr [thread threadnum] [mask maskvalue] Set a watchpoint that will break when the value of expr is read by the program.7 [PowerPC Embedded]. such as HP-UX. In this case.. page 44). page 255. awatch [-l|-location] expr [thread threadnum] [mask maskvalue] Set a watchpoint that will break when expr is either read from or written into by the program. The mask specifies that some bits of an address (the bits which are reset in the mask) should be ignored when matching the address accessed by the inferior against the watchpoint address. as the address itself is just a constant number which will never change.3. a masked watchpoint watches many addresses simultaneously— those addresses whose unmasked bits are identical to the unmasked bits in the watchpoint address. If you watch for a change in a numerically entered address you need to dereference it. if the current architecture supports this feature (e. The -location argument tells gdb to instead watch the memory referred to by expr. Ordinarily a watchpoint respects the scope of variables in expr (see below).] This command prints a list of watchpoints.) A masked watchpoint specifies a mask in addition to an address to watch. and watch the memory at that address.g. The mask argument implies -location. gdb will break when the expression expr is written into by the program and its value changes. (gdb) watch *(int *) 0x600850 Watchpoint 1: *(int *) 6293584 . gdb includes support for hardware watchpoints. PowerPC Embedded architecture. The [mask maskvalue] argument allows creation of masked watchpoints.1. see Section 21. If the expression’s result does not have an address.

If you set too many hardware watchpoints. the awatch and rwatch commands can only set hardware watchpoints. For example. which executes more slowly and reports the change in value at the next statement. gdb might not be able to warn you about this when you set the watchpoints.) set can-use-hw-watchpoints Set whether or not to use hardware watchpoints. on such systems you cannot set hardware watchpoints for an expression that yields a double-precision floating-point number (which is typically 8 bytes wide). and the warning will be printed only when the program is resumed: Hardware watchpoint num: Could not insert watchpoint If this happens. For remote targets. any watchpoints you have set will be inactive until gdb reaches another kind of breakpoint or the call completes. (Note that hardware-assisted watchpoints that were set before setting can-use-hw-watchpoints to zero will still use the hardware mechanism of watching expression values. after the change occurs. gdb will never try to use hardware watchpoints. and the debugger reports a change in value at the exact instruction where the change occurs. Currently. Hardware watchpoints execute very quickly. If gdb cannot set a hardware watchpoint. Sometimes. When you issue the watch command.Chapter 5: Stopping and Continuing 51 gdb sets a hardware watchpoint if possible. it will print a message like this: Expression cannot be implemented with read/access watchpoint. it might be possible to break the large region into a series of smaller ones and watch them with separate watchpoints. With this variable set to zero. it sets a software watchpoint. show can-use-hw-watchpoints Show the current mode of using hardware watchpoints. you can restrict the number of hardware watchpoints gdb will use. some systems can only watch regions that are up to 4 bytes wide. That’s because gdb needs to watch every variable in the expression with separately allocated resources. If you call a function interactively using print or call. page 227. gdb reports Hardware watchpoint num: expr if it was able to set a hardware watchpoint. not the instruction. see [set remote hardware-breakpoint-limit]. gdb cannot set a hardware watchpoint because the data type of the watched expression is wider than what a hardware watchpoint on the target machine can handle. . If gdb finds that it is unable to set a hardware breakpoint with the awatch or rwatch command. delete or disable some of the watchpoints. even if the underlying system supports them. You can force gdb to use only software watchpoints with the set can-use-hwwatchpoints 0 command. and gdb does not do that currently. because accesses to data that don’t change the value of the watched expression cannot be detected without examining every instruction as it is being executed. Since the precise number of active watchpoints is unknown until such time as the program is about to be resumed. As a work-around. gdb might be unable to insert all of them when you resume the execution of your program. Watching complex expressions that reference many variables can also exhaust the resources available for hardware-assisted watchpoints.

the debugger stops execution when any Ada exception is raised. watchpoints will detect changes to the watched expression from every thread. If you rerun the program. If you are confident that the expression can only change due to the current thread’s activity (and if you are also confident that no other thread can become current). (Hardware watchpoints. The throwing of a C++ exception. software watchpoints have only limited usefulness. . watch an expression in all threads. For instance. all local variables go out of scope. assuming an exception called Constraint_Error is defined in package Pck. then the command to use to catch such exceptions is catch exception Pck. If an exception name is specified at the end of the command (eg catch exception Program_Error). In particular. gdb may not notice when a non-current thread’s activity changes the expression. exception unhandled An exception that was raised but is not handled by the program. such as C++ exceptions or the loading of a shared library. when they go out of scope. In multi-threaded programs. that is. when the execution leaves the block in which these variables were defined. However. When inserting an exception catchpoint on a user-defined exception whose name is identical to one of the exceptions defined by the language. event can be any of the following: throw catch exception An Ada exception being raised. Otherwise. or expressions that involve such variables. Otherwise. set all the watchpoints. Warning: In multi-threaded programs.52 Debugging with gdb gdb automatically deletes watchpoints that watch local (automatic) variables. Use the catch command to set a catchpoint.Constraint_Error. then you can use software watchpoints as usual. in contrast. 5. it can only watch the value of an expression in a single thread. you will need to set all such watchpoints again. One way of doing that would be to set a code breakpoint at the entry to the main function and when it breaks. the debugger will stop only when this specific exception is raised. catch event Stop when event occurs. If gdb creates a software watchpoint. when the program being debugged terminates. the fully qualified name must be used as the exception name.3 Setting Catchpoints You can use catchpoints to cause the debugger to stop for certain kinds of program events.) See [set remote hardware-watchpoint-limit]. gdb will assume that it should stop on the pre-defined exception rather than the user-defined one. page 227. The catching of a C++ exception. and so only watchpoints that watch global variables remain set.1.

A call to exec. syscall. \ . This is currently only available for HP-UX and gnu/Linux.. syscall syscall [name | number] . If no argument is specified. When you specify the syscall by its name.. and show the related information for each syscall. A syscall’s number is the value passed to the OS’s syscall dispatcher to identify the requested service.. A syscall is a mechanism for application programs to request a service from the operating system (OS) or one of the OS system services.a. A call to or return from a system call.2 [command completion]. calls to and returns from all system calls will be caught. name can be any system call name that is valid for the underlying OS.h’. \ 0xffffe424 in __kernel_vsyscall () (gdb) c Continuing. The example below illustrates how this command works if you don’t provide arguments to it: (gdb) catch syscall Catchpoint 1 (syscall) (gdb) r Starting program: /tmp/catch-syscall Catchpoint 1 (call to syscall ’close’). gdb knows in advance which syscalls are valid for each OS. but using the number directly may be useful if gdb’s database does not have the complete list of syscalls on your system (e. page 19) to list the available choices. On GNU and Unix systems.k. because gdb lags behind the OS upgrades). a.g. \ 0xffffe424 in __kernel_vsyscall () (gdb) Here is an example of catching a system call by name: (gdb) catch syscall chroot Catchpoint 1 (syscall ’chroot’ [61]) (gdb) r Starting program: /tmp/catch-syscall Catchpoint 1 (call to syscall ’chroot’). Just what syscalls are valid depends on the OS. so you can use the gdb command-line completion facilities (see Section 3. gdb can catch some or all of the syscalls issued by the debuggee. You may also specify the system call numerically.Chapter 5: Stopping and Continuing 53 assert exec A failed Ada assertion. you can find the full list of valid syscall names on ‘/usr/include/asm/unistd. gdb uses its database of syscalls to convert the name into the corresponding numeric code. Normally. Catchpoint 1 (returned from syscall ’close’).

there can be situations when there is no corresponding name in XML file for that syscall number. Also. \ 0xffffe424 in __kernel_vsyscall () (gdb) c Continuing. you would see something like: (gdb) catch syscall 252 Catchpoint 1 (syscall(s) 252) Again. you will see a warning like this: (gdb) catch syscall warning: Could not open "syscalls/i386-linux. the syscall number has a corresponding entry in the XML file. . the file name will change depending on your architecture and system. In this case. Catchpoint 2 (syscall 764) (gdb) If you configure gdb using the ‘--without-expat’ option. Still using the example above. if your architecture does not have an XML file describing its system calls.xml" warning: Could not load the syscall XML file ’syscalls/i386-linux. gdb prints a warning message saying that it was not able to find the syscall name. See the example below: (gdb) catch syscall 764 warning: The number ’764’ does not represent a known syscall.xml’. In this case. It is important to notice that these two features are used for accessing the syscall name database. GDB will not be able to display syscall names.54 Debugging with gdb 0xffffe424 in __kernel_vsyscall () (gdb) c Continuing. Catchpoint 1 (returned from syscall ’chroot’). In either case. you will not be able to see the syscall names. you can also try to catch a syscall by its number. so gdb finds its name and prints it: (gdb) catch syscall 252 Catchpoint 1 (syscall(s) ’exit_group’) (gdb) r Starting program: /tmp/catch-syscall Catchpoint 1 (call to syscall ’exit_group’). \ 0xffffe424 in __kernel_vsyscall () (gdb) An example of specifying a system call numerically. in this case gdb would not be able to display syscall’s names. (gdb) However. Program exited normally. Catchpoint 1 (syscall) (gdb) Of course. In the case below. it will not be able to display syscall names. but the catchpoint will be set anyway.

With the clear command you can delete breakpoints according to where they are in your program. and Exceptions]. To make the debugger catch all exceptions before any stack unwinding takes place. Sometimes catch is not the best way to debug exception handling: if you need to know exactly where an exception is raised. you need some knowledge of the implementation. There are currently some limitations to C++ exception handling (catch throw and catch catch) in gdb: • If you call a function interactively. You can use multiple conditional breakpoints to stop your program when any of a number of exceptions are raised. tcatch event Set a catchpoint that is enabled only for one stop. or exits. or catchpoint once it has done its job and you no longer want your program to stop there. set a breakpoint on __raise_exception (see Section 5. If the call raises an exception. it may not be easy to find out where the exception was raised. 5. Watchpoints. This is currently only available for HP-UX and gnu/Linux. A breakpoint that has been deleted no longer exists. • You cannot install an exception handler interactively. it is forgotten. the call may bypass the mechanism that returns control to you and cause your program either to abort or to simply continue running until it hits a breakpoint. it is better to stop before the exception handler is called. page 57) that depends on the value of id. To stop just before an exception handler is called. */ void __raise_exception (void **addr. page 43). . watchpoints.1.Chapter 5: Stopping and Continuing 55 fork vfork A call to fork. The catchpoint is automatically deleted after the first time the event is caught. catches a signal that gdb is listening for.1 [Breakpoints. gdb normally returns control to you when the function has finished executing.4 Deleting Breakpoints It is often necessary to eliminate a breakpoint. • You cannot raise an exception interactively. With the delete command you can delete individual breakpoints. id is the exception identifier. void *id). Use the info break command to list the current catchpoints. In the case of gnu C++. exceptions are raised by calling a library function named __raise_exception which has the following ANSI C interface: /* addr is where the exception identifier is stored. With a conditional breakpoint (see Section 5.1. This is currently only available for HP-UX and gnu/Linux. however. watchpoint. since that way you can see the stack before any unwinding takes place. catchpoints on exceptions are disabled within interactive calls. This is called deleting the breakpoint. A call to vfork. or catchpoints by specifying their breakpoint numbers.6 [Break Conditions]. If you set a breakpoint in an exception handler instead. you can stop your program when a specific exception is raised. This is the case even if you set a catchpoint for the exception.

and catchpoints with the enable and disable commands. this is a good way to delete a breakpoint where your program just stopped. watchpoints. page 88. the most useful ones are listed below: clear function clear filename:function Delete any breakpoints set at entry to the named function. but remembers the information on the breakpoint so that you can enable it again later. .3 [Selecting a Frame]. Use info break to print a list of all breakpoints. If no argument is specified. Disabling and enabling a breakpoint that has multiple locations affects all of its locations. optionally specifying one or more breakpoint numbers as arguments. watchpoints. watchpoints. page 84). See Section 9. or catchpoint can have any of four different states of enablement: • Enabled. unless you have set confirm off). for the various forms of location. but then becomes disabled. A breakpoint. The breakpoint stops your program. A breakpoint set with the break command starts out in this state. watchpoint. A breakpoint set with the tbreak command starts out in this state. 5. delete all breakpoints (gdb asks confirmation. watchpoint. and catchpoints if you do not know which numbers to use. You can abbreviate this command as d. This makes the breakpoint inoperative as if it had been deleted. or catchpoints of the breakpoint ranges specified as arguments. You disable and enable breakpoints. but immediately after it does so it is deleted permanently.2 [Specify Location].5 Disabling Breakpoints Rather than deleting a breakpoint.. The breakpoint stops your program. • Enabled once. • Disabled. gdb automatically ignores breakpoints on the first instruction to be executed when you continue execution without changing the execution address.1. you might prefer to disable it. The breakpoint has no effect on your program. • Enabled for deletion.] Delete the breakpoints..56 Debugging with gdb It is not necessary to delete a breakpoint to proceed past it. When the innermost frame is selected. delete [breakpoints] [range. The breakpoint stops your program. clear linenum clear filename:linenum Delete any breakpoints set at or within the code of the specified linenum of the specified filename. clear location Delete any breakpoints set at the specified location. clear Delete any breakpoints at the next instruction to be executed in the selected stack frame (see Section 8. or catchpoint.

6 Break Conditions The simplest sort of breakpoint breaks every time your program reaches a specified place. You can also specify a condition for a breakpoint. then die.) Note that breakpoint commands are usually more convenient and flexible than . page 97).] Enable the specified breakpoints (or all defined breakpoints).. Conditions are also accepted for watchpoints. subsequently. This is the converse of using assertions for program validation.1. and may even call functions in your program.Chapter 5: Stopping and Continuing 57 You can use the following commands to enable or disable breakpoints. see Section 5.1. Breakpoints set by the tbreak command start out in this state.] Disable the specified breakpoints—or all breakpoints. to just set a watchpoint on a variable name. Break conditions can have side effects. A disabled breakpoint has no effect but is not forgotten. you should set the condition ‘! assert’ on the appropriate breakpoint. gdb disables any of these breakpoints immediately after stopping your program. They become effective once again in stopping your program. page 44). you want to stop when the assertion is violated—that is. Enable the specified breakpoints to work once.. in that situation.1 [Setting Breakpoints]. enable [breakpoints] once range. In C.2 [Continuing and Stepping]. gdb might see the other breakpoint first and stop your program without checking the condition of this one. and your program stops only if the condition is true. page 61. A breakpoint with a condition evaluates the expression each time your program reaches it. All options such as ignore-counts.. enable [breakpoints] [range. (In that case.. you may not need them..1 [Expressions].. to activate functions that log program progress. The effects are completely predictable unless there is another enabled breakpoint at the same address. but it does not change the state of your other breakpoints. and catchpoints: disable [breakpoints] [range. if you want to test an assertion expressed by the condition assert. if none are listed. A condition is just a Boolean expression in your programming language (see Section 10.. they become disabled or enabled only when you use one of the commands above. breakpoints that you set are initially enabled. when the condition is false. This can be useful. (The command until can set and delete a breakpoint of its own.) 5. say. Enable the specified breakpoints temporarily. for example. and specify a condition that tests whether the new value is an interesting one. gdb deletes any of these breakpoints as soon as your program stops there. since a watchpoint is inspecting the value of an expression anyhow—but it might be simpler. You may abbreviate disable as dis.. enable [breakpoints] delete range. Except for a breakpoint set with tbreak (see Section 5. watchpoints. or to use your own print functions to format special data structures. conditions and commands are remembered in case the breakpoint is enabled again later.

<= 0’ using a debugger convenience variable that is decremented each time. page 117. The next count times the breakpoint is reached. by using ‘if’ in the arguments to the break command.. it just decrements the ignore count by one and continues. and to determine whether symbols in it have referents in the context of your breakpoint. the condition is not checked.1 [Expressions]. When you use continue to resume execution of your program from a breakpoint. As a result.2 [Continuing and Stepping]. page 97.1.. To make the breakpoint stop the next time it is reached.) is given. They can also be changed at any time with the condition command. breakpoint bnum stops your program only if the value of expression is true (nonzero. your program’s execution does not stop. You can also use the if keyword with the watch command. ignore bnum count Set the ignore count of breakpoint number bnum to count. the breakpoint does not stop the next n times your program reaches it. See Section 10. gdb resumes checking the condition. watchpoint. you can specify an ignore count directly as an argument to continue. page 61. however. But if your program reaches a breakpoint whose ignore count is positive. in C). condition is the only way to impose a further condition on a catchpoint. . specify a count of zero. which is an integer. or catchpoint number bnum. You could achieve the effect of the ignore count with a condition such as ‘$foo-. the ignore count is zero. Break conditions can be specified when a breakpoint is set. if the ignore count value is n. condition bnum expression Specify expression as the break condition for breakpoint. Most of the time. other than to decrement the ignore count. It becomes an ordinary unconditional breakpoint.11 [Convenience Variables]. Once the ignore count reaches zero. gdb checks expression immediately for syntactic correctness. See Section 5. See Section 5. After you set a condition. like break if . This is so useful that there is a special way to do it. gdb prints an error message: No symbol "foo" in current context. A special case of a breakpoint condition is to stop only when the breakpoint has been reached a certain number of times. If expression uses symbols not referenced in the context of the breakpoint. page 59). The catch command does not recognize the if keyword. When you use condition. using the ignore count of the breakpoint. page 44. condition bnum Remove the condition from breakpoint number bnum. Every breakpoint has an ignore count. gdb does not actually evaluate expression at the time the condition command (or a command that sets a breakpoint with a condition. gdb takes no action.1 [Setting Breakpoints].1. See Section 10. and therefore has no effect. If a breakpoint has a positive ignore count and a condition. then instead of stopping.58 Debugging with gdb break conditions for the purpose of performing side effects when a breakpoint is reached (see Section 5.7 [Breakpoint Command Lists]. rather than using ignore.

] .7 Breakpoint Command Lists You can give any breakpoint (or watchpoint or catchpoint) a series of commands to execute when your program stops due to that breakpoint. leading to ambiguities about which list to execute. that is. then the commands will apply to all the breakpoints set by that command. With no argument. Simply use the continue command. The commands echo. This may be desirable for breakpoints that are to print a specific message and then continue.. type commands and follow it immediately with end. To remove all commands from a breakpoint. give it a condition .2 [Ambiguous Expressions]. watchpoints.Chapter 5: Stopping and Continuing 59 Ignore counts apply to breakpoints. If none of the remaining commands print anything.4 [Commands for Controlled Output]. or step. Any other commands in the command list. and also applies when a single break command creates multiple breakpoints (see Section 10. Type a line containing just end to terminate the commands. break foo if x>0 commands silent printf "x is %d\n". Put a breakpoint just after the erroneous line of code. give no commands. If the first command you specify in a command list is silent. you may encounter another breakpoint—which could have its own command list. the usual message about stopping at a breakpoint is not printed. The commands themselves appear on the following lines. watchpoint. This applies to breakpoints set by rbreak. are ignored.. For example. See Section 23. or enable other breakpoints. 5. and catchpoints. commands refers to the last breakpoint. page 279. Pressing RET as a means of repeating the last gdb command is disabled within a command-list. or any other command that resumes execution. or catchpoint set (not to the breakpoint most recently encountered).. here is how you could use breakpoint commands to print the value of x at entry to foo whenever x is positive. and printf allow you to print precisely controlled output. and are often useful in silent breakpoints. you might want to print the values of certain expressions.1.x cont end One application for breakpoint commands is to compensate for one bug so you can test for another. You can use breakpoint commands to start your program up again.. command-list . end Specify a list of commands for the given breakpoints. If the most recent breakpoints were set with a single command. This is because any time you resume execution (even with a simple next or step).. you see no sign that the breakpoint was reached. commands [range.. For example.1. page 98). output. after a command that resumes execution. silent is meaningful only at the beginning of a breakpoint command list.

8 How to save breakpoints to a file To save breakpoint definitions to a file use the save breakpoints command. gdb honors this constraint by adjusting a breakpoint’s address to the first in the bundle. For architectures thus constrained. This includes all types of breakpoints (breakpoints. you can edit the file in your favorite editing program.10 “Breakpoint address adjusted.. The FR-V architecture constrains the location of a breakpoint instruction within such a bundle to the instruction with the lowest address. into a file ‘filename’ suitable for use in a later debugging session. When this message is printed..3 [Command Files]. One example of such an architecture is the Fujitsu FR-V. save breakpoints [filename] This command saves all current breakpoint definitions together with their commands and ignore counts. Here is an example: break 403 commands silent set x = y + 4 cont end 5. The FR-V is a VLIW architecture in which a number of RISC-like instructions may be bundled together for parallel execution.9 “Cannot insert breakpoints” If you request too many active hardware-assisted breakpoints and watchpoints. This message is printed when you attempt to resume the program. catchpoints. and give it commands to assign correct values to any variables that need them.1. thus it may happen that a breakpoint’s address will be adjusted .1. and remove the breakpoint definitions you’re not interested in. you need to disable or remove some of the hardwareassisted breakpoints and watchpoints. 5. cannot insert breakpoints. You may have requested too many hardware breakpoints and watchpoints. you will see this error message: Stopped. and start with the silent command so that no output is produced.60 Debugging with gdb to detect the case in which something erroneous has been done. To read the saved breakpoint definitions. Note that watchpoints with expressions involving local variables may fail to be recreated because it may not be possible to access the context where the watchpoint is valid anymore. use the source command (see Section 23. watchpoints. It is not uncommon for optimized code to have bundles which contain instructions from different source statements. gdb will attempt to adjust the breakpoint’s address to comply with the constraints dictated by the architecture. page 278). since only then gdb knows exactly how many hardware breakpoints and watchpoints it needs to insert. End with the continue command so that your program does not stop.1. 5. Because the saved breakpoint definitions are simply a sequence of gdb commands that recreate the breakpoints. or that can no longer be recreated. and then continue. tracepoints).1.” Some processor architectures place constraints on the addresses at which breakpoints may be placed.

At other times. If not. or jump (see Section 17. 5. page 57). (If it stops due to a signal.4 [Returning from a Function]. Since this adjustment may significantly alter gdb’s breakpoint related behavior from what the user expects. any breakpoints set at that address are bypassed. page 197) to go back to the calling function. or use ‘signal 0’ to resume execution. your program may stop even sooner. A typical technique for using stepping is to set a breakpoint (see Section 5. In contrast. gdb will also issue a warning when stopping at one of these adjusted breakpoints: warning: Breakpoint 1 address previously adjusted from 0x00010414 to 0x00010410. See Section 5. it may be too late to take remedial action except in cases where the breakpoint is hit earlier or more frequently than expected. run your program until it stops at . page 66. Either when continuing or when stepping.2 [Continuing at a Different Address]. you can use return (see Section 17. page 43) at the beginning of the function or the section of your program where a problem is believed to lie. E. page 196) to go to an arbitrary location in your program. and have exactly the same behavior as continue. Such warnings are printed both for user settable and gdb’s internal breakpoints. The synonyms c and fg (for foreground. due to a breakpoint or a signal.g. a warning is printed when the breakpoint is first set and also when the breakpoint is hit. To resume execution at a different place. where “step” may mean either one line of source code. A warning like the one below is printed when setting a breakpoint that’s been subject to address adjustment: warning: Breakpoint address adjusted from 0x00010414 to 0x00010410. A conditional breakpoint may also be useful in some cases to prevent the breakpoint from triggering too often.6 [Break Conditions]. the argument to continue is ignored.2 Continuing and Stepping Continuing means resuming program execution until your program completes normally. Watchpoints. you should verify that a breakpoint set at the adjusted address will have the desired affect. and Catchpoints].1.4 [Signals]. The optional argument ignore-count allows you to specify a further number of times to ignore a breakpoint at this location. it may be sufficient to place the breakpoint at a later instruction. stepping means executing just one more “step” of your program.Chapter 5: Stopping and Continuing 61 from one source statement to another. you may want to use handle. When this warning is encountered.) continue [ignore-count] c [ignore-count] fg [ignore-count] Resume program execution.1 [Breakpoints. as the debugged program is deemed to be the foreground program) are provided purely for convenience. If you see one of these warnings.. the breakpoint in question may be removed and other breakpoints may be set which will have the desired behavior. at the address where your program last stopped. The argument ignore-count is meaningful only when your program stopped due to a breakpoint. its effect is like that of ignore (see Section 5. or one machine instruction (depending on what particular command you use).

described below. This command is abbreviated n. step count Continue running as in step. . but do so count times. To step through functions without debugging information. for loops. If a breakpoint is reached. next [count] Continue to the next source line in the current (innermost) stack frame. Execution stops when control reaches a different line of code at the original stack level that was executing when you gave the next command. etc. Previously.62 Debugging with gdb that breakpoint. The step command only stops at the first instruction of a source line. then stop it and return control to gdb. This command is abbreviated s. as for step. This is similar to step. stepping stops right away. The next command only stops at the first instruction of a source line. examining the variables that are interesting. but function calls that appear within the line of code are executed without stopping. the step command only enters a function if there is line number information for the function. step Continue running your program until control reaches a different source line. etc. set step-mode set step-mode on The set step-mode on command causes the step command to stop at the first instruction of a function which contains no debug line information rather than stepping over it. execution proceeds until control reaches a function that does have debugging information. This is useful in cases where you may be interested in inspecting the machine instructions of a function which has no symbolic info and do not want gdb to automatically skip over this function. Warning: If you use the step command while control is within a function that was compiled without debugging information. Otherwise it acts like the next command. This prevents the multiple stops that could otherwise occur in switch statements. Likewise. Also. In other words. This avoids problems when using cc -gl on MIPS machines. and then step through the suspect area. step steps inside any functions called within the line. use the stepi command. This prevents multiple stops that could otherwise occur in switch statements. step entered subroutines if there was any debugging information about the routine. until you see the problem happen. step continues to stop if a function that has debugging information is called within the line. An argument count is a repeat count. or a signal not related to stepping occurs before count steps. for loops. it will not step into a function which is compiled without debugging information.

Chapter 5: Stopping and Continuing 63 set step-mode off Causes the step command to step over any functions which contains no debug information. the f (frame) command shows that execution is stopped at line 206. Print the returned value (if any). and hence is quicker than until without an argument. argc > 0. It is like the next command. which forces you to step through the next iteration. until always stops your program if it attempts to exit the current stack frame.2 [Specify Location]. until location u location Continue running your program until either the specified location is reached. however. In contrast. NEXTARG) { until u This happened because. until with no argument works by means of single instruction stepping. it automatically continues execution until the program counter is greater than the address of the jump. or the current stack frame returns. For example. This . argv=0xf7fffae8) at m4. Contrast this with the return command (see Section 17. The until command appeared to step back to the beginning of the loop when it advanced to this expression. page 197). until makes your program continue execution until it exits the loop. in the following excerpt from a debugging session. the compiler had generated code for the loop closure test at the end. of the loop— even though the test in a C for-loop is written before the body of the loop. a next command at the end of a loop simply steps back to the beginning of the loop. in the current stack frame. This command can be abbreviated as fin. This command is used to avoid single stepping through a loop more than once. location is any of the forms described in Section 9. (gdb) until 195 for ( . until may produce somewhat counterintuitive results if the order of machine code does not match the order of the source lines. it has not really gone to an earlier statement—not in terms of the actual machine code.c:206 206 expand_input(). for execution efficiency. page 88. The specified location is actually reached only if it is in the current frame. This means that when you reach the end of a loop after single stepping though it. is reached. we get to line 195: (gdb) f #0 main (argc=4. yet when we use until.4 [Returning from a Function]. finish Continue running until just after function in the selected stack frame returns. and hence is slower than until with an argument. show step-mode Show whether gdb will stop in or step over functions without source line debug information. Continue running until a source line past the current line. This form of the command uses temporary breakpoints. This is the default. except that when until encounters a jump. rather than the start.

page 105. For instance in the code below. But this can become tedious if boring is called from many places. after the inner invocations have returned. as in step. you’ll step over both foo and boring! One solution is to step into boring and use the finish command to immediately exit it. bar(boring()). but you are not interested in stepping through boring. issuing until 99 will execute the program up to line 99 in the same invocation of factorial. 5. stepi stepi arg si Execute one machine instruction. See Section 10. } return (value). It is often useful to do ‘display/i $pc’ when stepping by machine instructions.e. you’ll enter boring().3 Skipping Over Functions and Files The program you are debugging may contain some functions which are uninteresting to debug. 94 int 95 { 96 97 98 99 100 factorial (int value) if (value > 1) { value *= factorial (value . Execution will also stop upon exit from the current stack frame. . and the target location doesn’t have to be in the same frame as the current one.1). } advance location Continue running the program up to the given location. nexti nexti arg ni Execute one machine instruction. but if you run next. This command is similar to until. proceed until the function returns. i. consider the following C function: 101 102 103 104 105 int func() { foo(boring()). as in next. The skip comand lets you tell gdb to skip a function or all functions in a file when stepping. An argument is required. page 88. then stop and return to the debugger. For example.64 Debugging with gdb implies that until can be used to skip over recursive function invocations. This makes gdb automatically display the next instruction to be executed. } Suppose you wish to step into the functions foo and bar. which should be of one of the forms described in Section 9. An argument is a repeat count. each time your program stops. If you run step at line 103.7 [Automatic Display]. but if it is a function call.2 [Specify Location].. An argument is a repeat count. if the current location is line 96. but advance will not skip over recursive function calls.

you’ll step over boring and directly into foo. Skips can be listed. If range is not specified. deleted. much like breakpoints. this field will contain ‘<PENDING>’. Once a shared library which has the function is loaded. You can also instruct gdb to skip all functions in a file. info skip will show the function’s address here. This instructs gdb never to step into boring.2 [Specify Location]. If you do not specify filename. If you’ve set a function skip on a function which has not yet been loaded. See Section 9.c. These are the commands for managing your list of skips: info skip [range] Print details about the specified skip(s). Disabled skips are marked with ‘n’. and enabled. either ‘function’ or ‘file’. If range is not specified. enable all skips. Enabled or Disabled Enabled skips are marked with ‘y’. delete all skips. What skip delete [range] Delete the specified skip(s). (If you have a function called file that you want to skip. with. this field contains the filename being skipped. Address For function skips. this column indicates the address in memory of the function being skipped.Chapter 5: Stopping and Continuing 65 A more flexible solution is to execute skip boring. the function named by linespec or the function containing the line named by linespec will be skipped over when stepping. the function you’re currently debugging will be skipped. info skip prints the following information about each skip: Identifier Type A number identifying this skip. skip [linespec] skip function [linespec] After running this command. For functions skips. page 88. print a table with details about all functions and files marked for skipping.) skip file [filename] After running this command. functions whose source lives in the file you’re currently debugging will be skipped. The type of this skip. If range is not specified. For file skips. this field contains the function name and its line number in the file where it is defined. . If you do not specify linespec. for example. disabled. Now when you execute step at line 103. skip enable [range] Enable the specified skip(s). skip file boring. use skip function file. any function whose source lives in filename will be skipped over when stepping.

disable all skips. info handle is an alias for info signals. or the word ‘all’. signal can be the number of a signal or its name (with or without the ‘SIG’ at the beginning). You can use this to see the signal numbers of all the defined types of signals. info signals sig Similar. Optional arguments keywords.] Change the way gdb handles signal signal. It may still print a message telling you that the signal has come in. but it is normally fatal so it can carry out the purpose of the interrupt: to kill the program. You can tell gdb in advance what to do for each kind of signal. The operating system defines the possible kinds of signals. are a normal part of the functioning of your program. If range is not specified.66 Debugging with gdb skip disable [range] Disable the specified skip(s). SIGINT does not indicate an error in your program. meaning all the known signals. SIGSEGV is the signal a program gets from referencing a place in memory far away from all the areas in use.4 Signals A signal is an asynchronous event that can happen in a program. these signals are fatal (they kill your program immediately) if the program has not specified in advance some other way to handle the signal. gdb should stop your program when this signal happens. gdb has the ability to detect any occurrence of a signal in your program. indicate errors. info signals info handle Print a table of all the kinds of signals and how gdb has been told to handle each one. in Unix SIGINT is the signal a program gets when you type an interrupt character (often Ctrl-c). You can change these settings with the handle command. a list of signal numbers of the form ‘low-high’.. The keywords allowed by the handle command can be abbreviated. Normally. such as SIGSEGV. but print information only about the specified signal number. SIGALRM occurs when the alarm clock timer goes off (which happens only if your program has requested an alarm). say what change to make. handle signal [keywords. gdb should print a message when this signal happens. including SIGALRM. and gives each kind a name and a number. For example. 5. This implies the print keyword as well. Others. described below. gdb is set up to let the non-erroneous signals like SIGALRM be silently passed to your program (so as not to interfere with their role in the program’s functioning) but to stop your program immediately whenever an error signal happens. Their full names are: nostop stop print gdb should not stop your program when this signal happens. . Some signals..

on a gnu/Linux system. it typically corresponds to the standard siginfo_t type. as defined in the ‘signal. On Unix systems. This information is exported by the convenience variable $_siginfo. or to give it any signal at any time. nopass and ignore are synonyms. your program can handle the signal. . nopass ignore gdb should not allow your program to see this signal. The data type of the information itself is target dependent. but your program would probably terminate immediately as a result of the fatal signal once it saw the signal. The default is set to nostop. When a signal stops your program. pass for non-erroneous signals such as SIGALRM. pass for the erroneous signals. pass and noignore are synonyms. you can use the handle command with pass or nopass to control whether your program sees that signal when you continue. For example. after gdb reports a signal. printing the stray referenced address that raised a segmentation fault. This implies the nostop keyword as well. SIGWINCH and SIGCHLD. or cause it to see a signal it normally would not see.h’ system header.3 [Giving your Program a Signal]. See Section 17. the signal is not visible to the program until you continue. print. Here’s an example. Your program sees the signal then. before it is actually delivered to the program being debugged. hoping to see more execution.Chapter 5: Stopping and Continuing 67 noprint gdb should not mention the occurrence of the signal at all. you might store correct values into the erroneous variables and continue. if your program stopped due to some sort of memory reference error. You can see the data type using the ptype $_ siginfo command. if pass is in effect for the signal in question at that time. You can also use the signal command to prevent your program from seeing a signal. or else it may terminate if the signal is fatal and not handled. gdb can inspect extra signal information associated with the intercepted signal. In other words. To prevent this. pass noignore gdb should allow your program to see this signal. and to stop. you can continue with ‘signal 0’. noprint. page 197. and consists of data that is passed by the kernel to the signal handler at the time of the receipt of a signal. On some targets.

} _sigfault. union { int _pad[28]. not just the current thread.._sifields. including switching between threads. int si_errno. This is true even when single-stepping with commands like step or next. all threads of execution stop. rather than at a clean statement boundary.} _rt.. Since thread scheduling is up to your debugging target’s operating system (not controlled by gdb)._sifields. page 35).. In particular. struct {..1 All-Stop Mode In all-stop mode. all threads start executing..68 Debugging with gdb (gdb) continue Program received signal SIGSEGV. other threads may execute more than one statement while the current thread completes a single step.} _kill. whenever your program stops under gdb for any reason. struct {.. whenever you restart the program. in which other threads can continue to run freely while you examine the stopped thread in the debugger.. struct {. gdb cannot single-step all threads in lockstep. } _sifields.5.10 [Debugging Programs with Multiple Threads]. Moreover. struct {.. There are two modes of controlling execution of your program within the debugger. (gdb) ptype $_siginfo type = struct { int si_signo. } (gdb) p $_siginfo...si_addr $1 = (void *) 0x7ffff7ff7000 Depending on target support. struct {. Conversely.. gdb also supports non-stop mode. Segmentation fault. . at a breakpoint or while being stepped). struct {. On some targets. 5. when any thread in your program stops (for example. 0x0000000000400766 in main () 69 *(int *)p = 0.. in general other threads stop in the middle of a statement.} _sigpoll. without worrying that things may change underfoot.} _sigchld. } (gdb) ptype $_siginfo. when the program stops.} _timer. int si_code._sigfault. referred to as all-stop mode. all other threads in the program are also stopped by gdb.5 Stopping and Starting Multi-thread Programs gdb supports debugging programs with multiple threads (see Section 4. $_siginfo may also be writable. This allows you to examine the overall state of the program. 5. In the default mode._sigfault type = struct { void *si_addr.

show schedule-multiple Display the current mode for resuming the execution of threads of multiple processes.2 Non-Stop Mode For some multi-threaded targets. show scheduler-locking Display the current scheduler locking mode. when you issue one of the execution commands such as continue. or an exception before the first thread completes whatever you requested. so that the focus of debugging does not change unexpectedly. ‘until’. then only the current thread may run when the inferior is resumed. In the latter case. gdb alerts you to the context switch with a message such as ‘[Switching to Thread n]’ to identify the thread. then there is no locking and any thread may run at any time. for instance. or while you are stepping and set to step. gdb does not change the current thread away from the thread that you are debugging.5. However. a signal. it automatically selects the thread where that breakpoint or signal happened. The step mode optimizes for single-stepping. it prevents other threads from preempting the current thread while you are stepping. In other situations. you may not be interested in inspecting the current state of any of the processes gdb is attached to. On some OSes. you can instruct gdb to allow all threads of all the inferiors to run with the set schedule-multiple command. set schedule-multiple Set the mode for allowing threads of multiple processes to be resumed when an execution command is issued. and you may want to resume them all until some breakpoint is hit. They are more likely to run when you ‘next’ over a function call. The scheduler-locking mode takes precedence when set to on. all threads of all processes are allowed to run. This is useful. or ‘finish’. such as programs . If on. This minimizes intrusion when debugging live systems. the continue command resumes only the two threads of the current inferior. When on. By default. if gdb is attached to two inferiors. due to a breakpoint or a signal.Chapter 5: Stopping and Continuing 69 You might even find your program stopped in another thread after continuing or even single-stepping. unless another thread hits a breakpoint during its timeslice. set scheduler-locking mode Set the scheduler locking mode. This happens whenever some other thread runs into a breakpoint. For example. Whenever gdb stops your program. The default is off. next or step. for example. and they are completely free to run when you use commands like ‘continue’. 5. each with two threads. When off. while you debug the child. If it is off. only the threads of the current process are resumed. gdb supports an optional mode of operation in which you can examine stopped program threads in the debugger while other threads continue to execute freely. when you debug a program that forks and you want to hold the parent stopped (so that. gdb allows only threads of the current inferior to run. it doesn’t run to exit). Other threads only rarely (or never) get a chance to run when you step. you can modify gdb’s default behavior by locking the OS scheduler to allow only a single thread to run.

gdb does not stop other threads as well. This is referred to as non-stop mode. . all execution commands apply only to the current thread by default. continue only continues one thread. pagination breaks non-stop. issue continue -a or c -a. when a thread stops to report a debugging event.5. gdb may still fall back to all-stop operation by default. execution commands such as continue and step apply by default only to the current thread in non-stop mode. in contrast to the all-stop mode behavior. page 363) are always executed asynchronously in non-stop mode. To enter non-stop mode. turn it on! set non-stop on You can use these commands to manipulate the non-stop mode setting: set non-stop on Enable selection of non-stop mode. Furthermore.14 [GDB/MI Program Execution]. rather than all threads as in all-stop mode. show non-stop Show the current non-stop enablement setting. This allows you to control threads explicitly in ways that are not possible in all-stop mode — for example.70 Debugging with gdb where some threads have real-time constraints or must continue to respond to external events. stepping one thread while allowing others to run freely. The MI execution commands (see Section 27. stepping one thread while holding all others stopped. To stop the whole program. since not all targets support non-stop mode. or Ctrl-c during foreground execution. In non-stop mode. set pagination off # Finally. or stepping several threads independently and simultaneously. and it is generally not possible to switch modes once debugging has started. Additionally. To continue all threads. That is. only that thread is stopped. Suspending execution is done with the interrupt command when running in the background. Note these commands only reflect whether non-stop mode is enabled. You can use gdb’s background execution commands (see Section 5. this stops the whole process. In non-stop mode. Other execution commands do not currently support the -a option. use this sequence of commands before you run or attach to your program: # Enable the async interface. not whether the currently-executing program is being run in non-stop mode. set target-async 1 # If using the CLI. even when you have enabled non-stop mode.3 [Background Execution]. use interrupt -a. the set nonstop preference is only consulted when gdb starts or connects to the target program. but in non-stop mode the interrupt applies only to the current thread. In all-stop mode. set non-stop off Disable selection of non-stop mode. In particular. page 71) to run some threads in the background while you continue to examine or step others from gdb.

gdb doesn’t automatically make that thread current.5. show target-async Show the current target-async setting. See Section 5. In foreground execution. In background execution.2 [Continuing and Stepping]. Examples of commands that are valid in all-stop mode while the program is running include help and info break. Background execution is especially useful in conjunction with non-stop mode for debugging programs with multiple threads.2 [Starting your Program].5. and it would be confusing if gdb unexpectedly changed to a different thread just as you entered a command to operate on the previously current thread. If the target doesn’t support async mode.2 [Continuing and Stepping].3 Background Execution gdb’s execution commands have two variants: the normal foreground (synchronous) behavior. as it does in all-stop mode. gdb waits for the program to report that some thread has stopped before prompting for another command. gdb issues an error message if you attempt to use the background execution commands. You need to explicitly enable asynchronous mode before you can use background execution commands. However. or just c&. See Section 4. add a & to the command. See Section 5. when a thread stops. gdb immediately gives a command prompt so that you can issue other commands while your program runs. 5. See Section 5. page 61. see Section 5. .2 [Continuing and Stepping]. The execution commands that accept background execution are: run attach step stepi next nexti continue finish until See Section 4. you can also use these commands in the normal all-stop mode with the restriction that you cannot issue another execution command until the previous one finishes.2 [Continuing and Stepping]. page 31. the background form of the continue command is continue&. page 69. page 61.2 [Continuing and Stepping].Chapter 5: Stopping and Continuing 71 In non-stop mode. page 61. page 61.7 [Debugging an Already-running Process].2 [Non-Stop Mode]. To specify background execution. and a background (asynchronous) behavior. See Section 5. For example.2 [Continuing and Stepping]. page 61. See Section 5.2 [Continuing and Stepping]. page 26. page 61. You can use these commands to manipulate the asynchronous mode setting: set target-async on Enable asynchronous mode. This is because the thread stop notifications are asynchronous with respect to gdb’s command interpreter. See Section 5. page 61. set target-async off Disable asynchronous mode. See Section 5.

then the system call may return prematurely.. 5. If you do not specify ‘thread threadno’ when you set a breakpoint. use interrupt -a. Instead. This is a consequence of the interaction between multiple threads and the signals that gdb uses to implement breakpoints and other events that stop execution. page 88). or for some other reason. but in non-stop mode.72 Debugging with gdb You can interrupt your program while it is running in the background by using the interrupt command. The call to sleep will return early if a different thread stops at a breakpoint or for some other reason.4 Thread-Specific Breakpoints When your program has multiple threads (see Section 4. interrupt stops the whole process. shown in the first column of the ‘info threads’ display. If one thread stops for a breakpoint. For example. To stop the whole program in non-stop mode. while (unslept > 0) unslept = sleep (unslept).10 [Debugging Programs with Multiple Threads]. you can choose whether to set breakpoints on all threads. write this: int unslept = 10. your program should check the return value of each system call and react appropriately. the breakpoint applies to all threads of your program. but the effect is always to specify some source line. threadno is one of the numeric thread identifiers assigned by gdb. break linespec thread threadno break linespec thread threadno if . it stops only the current thread. like this: (gdb) break frik. page 35). and another thread is blocked in a system call..c:13 thread 28 if bartab > lim 5. Use the qualifier ‘thread threadno’ with a breakpoint command to specify that you only want gdb to stop the program when a particular thread reaches this breakpoint. interrupt interrupt -a Suspend execution of the running program.2 [Specify Location]. place ‘thread threadno’ before or after the breakpoint condition.5. . To handle this problem. linespec specifies source lines. do not write code like this: sleep (10).5 Interrupted System Calls There is an unfortunate side effect when using gdb to debug multi-threaded programs. in this case. In all-stop mode. This is good programming style anyways. You can use the thread qualifier on conditional breakpoints as well. or on a particular thread. there are several ways of writing them (see Section 9.5.

But gdb does cause your multi-threaded program to behave differently than it would without gdb. show may-write-memory Show the current permission to write memory. intercepting operations from all commands. Also. set observer on set observer off When set to on. set may-write-registers on set may-write-registers off This controls whether gdb will attempt to alter the values of registers. such as with assignment expressions in print. It defaults to on. though remaining in non-stop mode. plus enables non-stop debugging. including internal breakpoints defined by gdb. These operate at a low level. This affects all breakpoints. When such an event happens.5. etc.6 Observer Mode If you want to build on non-stop mode and observe program behavior without any chance of disruption by gdb. this disables all the permission variables below (except for insert-fast-tracepoints). then gdb is said to be observer mode. show may-write-registers Show the current permission to write registers. you can set variables to disable all of the debugger’s attempts to modify state. It defaults to on. then breakpoints that work by writing trap instructions into the code stream will still not be able to be placed. so the system is still conforming to its specification. Note that gdb will not prevent you from making nonsensical combinations of these settings. the variable observer can be set to disable these. set may-write-memory on set may-write-memory off This controls whether gdb will attempt to alter the contents of memory. plus enable non-stop mode. gdb uses internal breakpoints in the thread library to monitor certain events such as thread creation and thread destruction. It defaults to on. 5. When all of these are set to off. As a convenience. . show observer Show whether observer mode is on or off. or the jump command. such as with assignment expressions in print. whether by writing memory.Chapter 5: Stopping and Continuing 73 A system call is allowed to return early. set may-insert-breakpoints on set may-insert-breakpoints off This controls whether gdb will attempt to insert breakpoints. For instance. even though your program does not appear to stop. if you have enabled may-insert-breakpoints but disabled maywrite-memory. Setting this to off switches back to normal debugging. a system call in another thread may return prematurely. inserting breakpoints.

It affects only fast tracepoints. nor will Ctrl-c. set may-insert-tracepoints on set may-insert-tracepoints off This controls whether gdb will attempt to insert (regular) tracepoints at the beginning of a tracing experiment. It affects only non-fast tracepoints. It defaults to on. set may-insert-fast-tracepoints on set may-insert-fast-tracepoints off This controls whether gdb will attempt to insert fast tracepoints at the beginning of a tracing experiment. It defaults to on. show may-insert-fast-tracepoints Show the current permission to insert fast tracepoints. regular (non-fast) tracepoints being under the control of may-insert-tracepoints. show may-interrupt Show the current permission to interrupt or stop the program. fast tracepoints being under the control of may-insert-fast-tracepoints. set may-interrupt on set may-interrupt off This controls whether gdb will attempt to interrupt or stop program execution. It defaults to on. show may-insert-tracepoints Show the current permission to insert tracepoints. the interrupt command will have no effect.74 Debugging with gdb show may-insert-breakpoints Show the current permission to insert breakpoints. . When this variable is off.

Some targets may be able undo things like device I/O. If you are debugging in a target environment that supports reverse execution. and return control to gdb. but the 1 Note that some side effects are easier to undo than others. reverse-stepi [count] Reverse-execute one machine instruction. For instance. Also. Behavior of asynchronous signals depends on the target environment. It “un-executes” the previously executed source line. and some may not. The contract between gdb and the reverse executing target requires only that the target do something reasonable when gdb tells it to execute backwards. Obviously this requires a great deal of sophistication on the part of the target environment. gdb provides the following commands. reverse-step will step (backward) into the called function. as with the step command. start executing in reverse. Note that the instruction to be reverse-executed is not the one pointed to by the program counter. If the target environment supports it. reverse-continue [ignore-count] rc [ignore-count] Beginning at the point where your program last stopped. but device I/O is hard. it is not unusual to realize that you have gone too far. stopping at the beginning of the last statement in the called function (typically a return statement). if non-debuggable functions are called. gdb can allow you to “rewind” the program by running it backward. As each instruction is “un-executed”. . not all target environments can support reverse execution. and some event of interest has already happened. and all variables should be returned to their prior values1 . Reverse execution will stop for breakpoints and synchronous exceptions (signals). the instructions that have most recently been executed are “un-executed”. should revert to their previous values. just like normal execution.Chapter 6: Running programs backward 75 6 Running programs backward When you are debugging a program. The program counter runs backward. Like the step command. memory and registers are relatively easy. If the previous source line included calls to debuggable functions. When a program is executed in reverse. registers etc. then stop it. Variables. in reverse order. and then report the results back to gdb. gdb will report back to the user. reverse-step will run thru them backward without stopping. gdb assumes that the memory and registers that the target reports are in a consistant state. all side effects of that code should be “undone”. reverse-step [count] Run the program backward until control reaches the start of a different source line. A target environment that supports reverse execution should be able to “undo” the changes in machine state that have taken place as the program was executing normally. but gdb accepts whatever it is given. Whatever the target reports back to gdb. the values of memory and/or registers that were changed by that instruction are reverted to their previous states. After executing a piece of source code in reverse. reverse-step will only stop at the beginning of a source line. following the previous thread of execution in reverse.

The return command cannot be used in reverse mode. you end up at the beginning. . reversenext will take you back to the caller of that function. reverse-stepi will take you back from the destination of the jump to the jump instruction itself. For instance. reverse-next [count] Run backward to the beginning of the previous line executed in the current (innermost) stack frame. reverse-nexti [count] Like nexti. if the previously executed instruction was a return from another function. set exec-direction Set the direction of target execution. set exec-direction reverse gdb will perform all execution commands in reverse. reverse-nexti will continue to execute in reverse until the call to that function (from the current stack frame) is reached. Starting from the first line of a function. continue. stepi. they will be “unexecuted” without stopping. reverse-nexti executes a single instruction in reverse. except that called functions are “un-executed” atomically. Instead of ending up at the end of the current function invocation. set exec-direction forward gdb will perform all execution commands in the normal fashion. just as the normal next command would take you from the last line of a function back to its return to its caller2 . Affected commands include step. If the line contains function calls. reverse-finish Just as the finish command takes you to the point where the current function returns. if the last instruction was a jump. That is. This is the default.76 Debugging with gdb instruction executed prior to that one. nexti. and finish. until the exec-direction mode is changed to “forward”. reverse-finish takes you to the point where it was called. 2 Unless the code is too heavily optimized. next. before the function was called.

If the record for the next instruction is not in the execution log. otherwise. Instead.5. the entire execution log will be deleted and the inferior will either be terminated. Their contents are taken from the execution log. or stop if not. even if the platform on which the inferior runs does not. you need first to start the process with the run or start commands. Therefore. In other words. it will work in record mode.3 [Background Execution]. The process record and replay target supports reverse execution (see Chapter 6 [Reverse Execution]. reverse execution on platforms that don’t support it directly can only be done in the replay mode. However.2 [Non-Stop Mode].Chapter 7: Recording Inferior’s Execution and Replaying It 77 7 Recording Inferior’s Execution and Replaying It On some platforms. Displaced stepping (see Appendix D [displaced stepping]. For architecture environments that support process record and replay. page 457) will be automatically disabled when process record and replay target is started. While code is not really executed in replay mode. gdb provides a special process record and replay target that can record a log of the process execution. In other words. or will remain in its final state. That’s because the process record and replay target doesn’t support displaced stepping. page 75). the inferior executes normally. If the inferior is in the non-stop mode (see Section 5. if the execution log includes the record for the next instruction. all the events that normally happen during code execution are taken from the execution log. the values of registers (including the program counter register) and the memory of the inferior are still changed as they normally would. In the replay mode. gdb will debug in replay mode. gdb provides the following commands: target record This command starts the process record and replay target. Both record and rec are aliases of target record. When debugging in the reverse direction. if you record for a while and . and gdb records the execution log for future replay. page 71). the inferior does not really execute code instructions. if the platform supports reverse execution. the inferior will be stopped at the next instruction that would have been recorded. In this mode. the reverse execution is limited in this case by the range of the instructions recorded in the execution log. When process record and replay target stops.5. The process record and replay target can only debug a process that is already running. When you stop the process record and replay target in record mode (at the end of the execution log). When this target is in use. and then start the recording with the target record command. record stop Stop the process record and replay target. the process record and replay target cannot be started because it doesn’t support these two modes. gdb will work in replay mode as long as the execution log includes the record for the previous instruction. and replay it later with both forward and reverse execution commands. gdb will debug in record mode. page 69) or in the asynchronous execution mode (see Section 5.

When the inferior process exits. If limit is a positive number. show record stop-at-limit Show the current setting of stop-at-limit. not at the end of the execution log.78 Debugging with gdb then stop recording. gdb will delete the earliest recorded instruction to keep the number of recorded instructions at the limit. If ON. record restore filename Restore the execution log from a file ‘filename’. gdb will stop when the limit is reached for the first time and ask you whether you want to stop the inferior or continue running it and recording the execution log. without asking. it . described below. each new recorded instruction will cause the oldest one to be deleted. and it will then be possible to continue the usual “live” debugging of the process from that state. If this option is OFF.process_id’. the inferior process will be left in the same state as if the recording never happened. Default filename is ‘gdb_record. record save filename Save the execution log to a file ‘filename’.) If limit is zero. set record stop-at-limit Control the behavior when the number of recorded instructions reaches the limit. then gdb will start deleting instructions from the log once the number of the record instructions becomes greater than limit. gdb will automatically ignore the effect of such instructions on memory. if the process record and replay target is stopped while in replay mode (that is. when gdb replays this execution log. For every new recorded instruction. If you decide to continue recording. set record insn-number-max limit Set the limit of instructions to be recorded. On the other hand. Later. process record and replay target will automatically stop itself. gdb will automatically delete the oldest record to make room for each new one. If this option is OFF (the default). Default value is 200000. File must have been created with record save. gdb will query whether to stop the inferior in that case. If ON (the default). by means of the stop-at-limit option. gdb will never delete recorded instructions from the execution log. the inferior process will become “live” at that earlier state. where process id is the process ID of the inferior. set record memory-query Control the behavior when gdb is unable to record memory changes caused by an instruction. (Since deleting recorded instructions loses information. but at some earlier point). or gdb detaches from it. show record insn-number-max Show the limit of instructions to be recorded. gdb lets you control what happens when the limit is reached. The number of recorded instructions is unlimited in this case.

• Highest recorded instruction number. • Number of instructions contained in the execution log.Chapter 7: Recording Inferior’s Execution and Replaying It 79 will mark the log of this instruction as not accessible. • Current instruction about to be replayed (if in replay mode). including: • Whether in record mode or replay mode. record delete When record target runs in replay mode (“in the past”). . and it will not affect the replay results. show record memory-query Show the current setting of memory-query. • Lowest recorded instruction number (counting from when the current execution log started recording instructions). info record Show various statistics about the state of process record and its in-memory execution log buffer. • Maximum number of instructions that may be contained in the execution log. delete the subsequent execution log and begin to record a new execution log starting from the current address. This means you will abandon the previously recorded “future” and begin recording a new “future”.

.

one for the frame that called it. There are special gdb commands to select whichever frame you are interested in. In particular. information about the call is generated.3 [Selecting a Frame]. there can be many frames for the same function. starting with zero for the innermost frame. the first thing you need to know is where it stopped and how it got there. When your program stops. gdb automatically selects the currently executing frame and describes it briefly. the frame for that function invocation is eliminated. See Section 8. 8. These numbers do not really exist in your program. similar to the frame command (see Section 8. the function’s local variables. Each time a function returns. each kind of computer has a convention for choosing one byte whose address serves as the address of the frame. the gcc option ‘-fomit-frame-pointer’ generates functions without a frame. gdb has limited facilities for dealing with . a new frame is made. This is called the initial frame or the outermost frame. When your program is started. and so on upward. Each time your program performs a function call. Inside your program. they are assigned by gdb to give you a way of designating stack frames in gdb commands. The frame contains the arguments given to the function. the value is found in the selected frame.1 Stack Frames The call stack is divided up into contiguous pieces called stack frames. or frames for short. each frame is the data associated with one call to one function. The frame for the function in which execution is actually occurring is called the innermost frame. Each time a function is called. Some compilers provide a way to compile functions so that they operate without stack frames. the gdb commands for examining the stack allow you to see all of this information. page 84.) This is occasionally done with heavily used library functions to save the frame setup time. One of the stack frames is selected by gdb and many gdb commands refer implicitly to the selected frame. and the address at which the function is executing.Chapter 8: Examining the Stack 81 8 Examining the Stack When your program has stopped. the arguments of the call. page 119) while execution is going on in that frame. The stack frames are allocated in a region of memory called the call stack. That information includes the location of the call in your program. gdb assigns numbers to all existing stack frames. that of the function main.4 [Information about a Frame]. stack frames are identified by their addresses. page 85).12 [Registers]. whenever you ask gdb for the value of a variable in your program. (For example. When your program stops. each of which has its own address. and the local variables of the function being called. the stack has only one frame. This is the most recently created of all the stack frames that still exist. If a function is recursive. Usually this address is kept in a register called the frame pointer register (see Section 10. The information is saved in a block of data called a stack frame. A stack frame consists of many bytes.

You can stop the backtrace at any time by typing the system interrupt character. normally Ctrl-c. allowing correct tracing of the function call chain. backtrace full bt full bt full n bt full -n Print the values of the local variables also. Each line in the backtrace shows the frame number and the function name. this is handy when you debug a core dump of a multi-threaded program. gdb by default shows the backtrace only for the current thread. The names where and info stack (abbreviated info s) are additional aliases for backtrace. and to print the stack frame you select. which is numbered zero as usual.2 Backtraces A backtrace is a summary of how your program got where it is. args may be either the address of the frame or the stack frame number. as well as the arguments to the function. gdb will display the backtrace for all the threads. However. gdb nevertheless regards it as though it had a separate frame.82 Debugging with gdb these function invocations. for many frames. backtrace bt Print a backtrace of the entire stack: one line per frame for all frames in the stack. Without an argument. gdb has no provision for frameless functions elsewhere in the stack. but print only the innermost n frames. if you type thread apply all backtrace. and on up the stack. To display the backtrace for several or all of the threads. use the command thread apply (see Section 4. The backtrace also shows the source file name and line number. . frame args The frame command allows you to move from one stack frame to another. page 35). If the innermost function invocation has no stack frame. It shows one line per frame. This is the silent version of frame. followed by its caller (frame one). In a multi-threaded program.10 [Threads]. 8. starting with the currently executing frame (frame zero). backtrace -n bt -n Similar. as described above. backtrace n bt n Similar. but print only the outermost n frames. frame prints the current stack frame. select-frame The select-frame command allows you to move from one stack frame to another without printing the frame. n specifies the number of frames to print. For example. The program counter value is omitted if it is at the beginning of the code for that line number. The program counter value is also shown—unless you use set print address off.

to avoid tracing into highly systemspecific (and generally uninteresting) code. If you need to display the values of such optimized-out arguments. argv=0x2b8c8) at builtin. 1 Note that embedded programs (the so-called “free-standing” environment) are not required to have a main function as the entry point.c:993 #1 0x6e38 in expand_macro (sym=<optimized out>) at macro.c:71 (More stack frames follow.c:71 (More stack frames follow. or recompile without optimizations. gdb has no way of displaying such arguments in stack frames other than the innermost one.. td=0xf7fffb08) at macro. If your program was compiled with optimizations.. t=<optimized out>. so it shows the innermost three frames. See command set print frame-arguments in Section 10. Here’s what such a backtrace might look like: m4_traceon (obs=0x24eb0. gdb prints the value of a parameter only if it is a scalar (integer. It was made with the command ‘bt 3’. The value of parameter data in frame 1 has been replaced by .. indicating that your program has stopped at the beginning of the code for line 993 of builtin. If you need to examine the startup code.) #0 The values of arguments that were not saved in their stack frames are shown as ‘<optimized out>’. or limit the number of levels in a backtrace. By default. set backtrace past-main off Backtraces will stop when they encounter the user entry point. some compilers will optimize away arguments passed to functions if those arguments are never used after the call. data=. show backtrace past-main Display the current user entry point backtrace policy..c:242 #2 0x6840 in expand_token (obs=0x0.. argv=0x2b8c8) at builtin. For C this is main1 . you can change this behavior: set backtrace past-main set backtrace past-main on Backtraces will continue past the user entry point. . page 106 for more details on how to configure the way function parameter values are printed. argc=1. but doesn’t store those arguments in the stack frame... t=177664. pointer. This is the default.) at macro.c:242 #2 0x6840 in expand_token (obs=0x0. td=0xf7fffb08) at macro. either deduce that from other variables whose values depend on the one you are interested in...c:993 #1 0x6e38 in expand_macro (sym=0x2b600.8 [Print Settings]. Most programs have a standard user entry point—a place where system libraries and startup code transition into user code.Chapter 8: Examining the Stack 83 Here is an example of a backtrace. m4_traceon (obs=0x24eb0. They could even have multiple entry points.c. Such optimizations generate code that passes arguments through registers.) #0 The display for frame zero does not begin with a program counter value. argc=1. When gdb finds the entry function in a backtrace it will terminate the backtrace. etc). enumeration.

a program counter. it needs two addresses: a stack pointer and a program counter. and so on. n defaults to one. to frames that were created more recently. frame needs two addresses to select an arbitrary frame: a frame pointer and a stack pointer. this can be useful when your program has multiple stacks and switches between them. n defaults to one. The highest-numbered frame is the one for main. to frames that have existed longer. this advances toward the outermost frame.84 Debugging with gdb set backtrace past-entry set backtrace past-entry on Backtraces will continue past the internal entry point of an application. This is the default. For positive numbers n. Here are the commands for selecting a stack frame. to lower frame numbers. On the MIPS and Alpha architecture. Recall that frame zero is the innermost (currently executing) frame. For positive numbers n. On the 29k architecture. and is likely before the user entry point main (or equivalent) is called. set backtrace past-entry off Backtraces will stop when they encounter the internal entry point of an application. In addition. 8. and a memory stack pointer. show backtrace limit Display the current limit on backtrace levels. On the SPARC architecture. A value of zero means unlimited. to higher frame numbers. set backtrace limit n set backtrace limit 0 Limit the backtrace to n levels. show backtrace past-entry Display the current internal entry point backtrace policy. this advances toward the innermost frame. it needs three addresses: a register stack pointer. This is useful mainly if the chaining of stack frames has been damaged by a bug. This entry point is encoded by the linker when the application is built. down n . frame n fn Select frame number n. You may abbreviate down as do. Move n frames down the stack. up n Move n frames up the stack. making it impossible for gdb to assign numbers properly to all frames.3 Selecting a Frame Most commands for examining the stack and other data in your program work on whichever stack frame is selected at the moment. frame addr f addr Select the frame at address addr. all of them finish by printing a brief description of the stack frame just selected. frame one is the frame that called the innermost one.

You can also edit the program at the point of execution with your favorite editing program by typing edit. page 84. for details. this command does not change which frame is selected. info frame info f This command prints a verbose description of the selected stack frame. and the source file and line number of execution in that frame.1 [Printing Source Lines]. respectively. the arguments. After such a printout.4 Information About a Frame There are several other commands to print information about the selected stack frame. up-silently n down-silently n These two commands are variants of up and down. argv=0xf7fffbf4. where the output might be unnecessary and distracting. without causing display of the new frame. including: • the address of the frame • the address of the next frame down (called by this frame) • the address of the next frame up (caller of this frame) • the language in which the source code corresponding to this frame is written • the address of the frame’s arguments • the address of the frame’s local variables • the program counter saved in it (the address of execution in the caller frame) • which registers were saved in the frame The verbose description is useful when something has gone wrong that has made the stack format fail to fit the usual conventions. It can be abbreviated f. this command is used to select a stack frame.Chapter 8: Examining the Stack 85 All of these commands end by printing two lines of output describing the frame. The second line shows the text of that source line. they differ in that they do their work silently. the list command with no arguments prints ten lines centered on the point of execution in the frame. the function name. For example: (gdb) up #1 0x22f0 in main (argc=1. 8. They are intended primarily for use in gdb command scripts. The first line shows the frame number. See Section 8. env=0xf7fffbfc) at env. page 87.3 [Selecting a Frame].c:10 10 read_input_file (argv[i]). frame f When used without any argument. but prints a brief description of the currently selected stack frame. See Section 9. . With an argument.

This requires the same kind of address (more than one for some architectures) that you specify in the frame command. each on a separate line. info locals Print the local variables of the selected frame. info catch Print a list of all the exception handlers that are active in the current stack frame at the current point of execution. down. See Section 8. each on a separate line. page 52. then type info catch.1.3 [Selecting a Frame].3 [Setting Catchpoints]. info args Print the arguments of the selected frame. visit the associated frame (using the up. The selected frame remains unchanged by this command. These are all variables (declared either static or automatic) accessible at the point of execution of the selected frame. page 84. or frame commands). To see other exception handlers. without selecting that frame. See Section 5.86 Debugging with gdb info frame addr info f addr Print a verbose description of the frame at address addr. .

for the full list. list - By default. page 81).2 [Specify Location]. You can print other portions of source files by explicit command. . one or two linespecs. gdb prints ten source lines with any of these forms of the list command. you may prefer to use Emacs facilities to view source. There are several ways to specify what part of the file you want to print. since the debugging information recorded in the program tells gdb what source files were used to build it. Likewise. see Section 9. but the effect is always to specify some source line.3 [Selecting a Frame]. ten lines are printed. Linespecs specify source lines. You can change this using set listsize: set listsize count Make the list command display count source lines (unless the list argument explicitly specifies some other number). show listsize Display the number of lines that list prints.2 [Specify Location]. page 335. When your program stops. if the last line printed was a solitary line printed as part of displaying a stack frame (see Chapter 8 [Examining the Stack]. there are several ways of writing them (see Section 9. gdb prints the line where execution in that frame has stopped. page 88). By default. An exception is made for an argument of ‘-’. list Print more lines. gdb spontaneously prints the line where it stopped. the list command expects you to supply zero. use the list command (abbreviated l). when you select a stack frame (see Section 8. that argument is preserved in repetition so that each repetition moves up in the source file. Repeating a list command with RET discards the argument. list function Print lines centered around the beginning of function function. Here are the forms of the list command most commonly used: list linenum Print lines centered around line number linenum in the current source file. If the last lines printed were printed with a list command. Print lines just before the lines last printed. page 84). In general. however. page 88. this prints lines centered around that line. Here is a complete description of the possible arguments for list: list linespec Print lines centered around the line specified by linespec. If you use gdb through its gnu Emacs interface. 9.Chapter 9: Examining Source Files 87 9 Examining Source Files gdb can print parts of your program’s source. this prints lines following the last lines printed. see Chapter 26 [Using gdb under gnu Emacs].1 Printing Source Lines To print lines from a source file. so it is equivalent to typing just list. This is more useful than listing the same lines again.

Specifies the line offset lines before or after the current line.1 [Frames]. As described in the preceding table.) When used as the second of the two linespecs in a list command. For the list command. Since gdb is a source-level debugger. gdb searches for the label in the function corresponding to the currently selected stack frame. 9. and the source file of the second linespec is omitted.last Print lines ending with last. label Specifies the line at which the label named label appears. if the inferior is not running). list first. When a list command has two linespecs. then gdb will not search for a label. locations are also known as linespecs. function:label Specifies the line where label appears in function. filename:function Specifies the line that begins the body of the function function in the file filename. in C.2 Specifying a Location Several gdb commands accept arguments that specify a location of your program’s code. function Specifies the line that begins the body of the function function. this specifies the line offset lines up or down from the first linespec. page 81. Here are all the different ways of specifying a code location that gdb understands: linenum -offset +offset Specifies the line number linenum of the current source file. You only need the file name with a function name to avoid ambiguity when there are identically named functions in different source files. Both arguments are linespecs. list + list list Print lines just after the lines last printed. filename:linenum Specifies the line linenum in the source file filename. a location usually specifies some line in the source code. Print lines starting with first. the current line is the last one printed.88 Debugging with gdb list first. for the breakpoint commands. For example. . list . this is the line at which execution stopped in the currently selected stack frame (see Section 8. for that reason. Print lines just before the lines last printed. If there is no current selected stack frame (for instance.last Print lines from first to last. this refers to the same source file as the first linespec. this is the line with the open brace. for a description of stack frames.

this can be used to set breakpoints in parts of your program which do not have debugging information or source files.2 [Specify Location]. C++. if there are several functions with identical names in different source files. In Ada. here are the forms of the edit command most commonly used: edit number Edit the current source file with number as the active line number. gdb extends the semantics of expressions used in locations to cover the situations that frequently happen during debugging.. this is &function. e. In Pascal and Modula-2.g. funcaddr An address of a function or procedure derived from its name. page 88. e. 9. The editing program of your choice is invoked with the current line set to the active line in the program. Java. and assembly. For break and other breakpoint oriented commands. but also specifies the name of the source file explicitly. Here address may be any expression valid in the current working language (see Chapter 15 [Languages].. there are several ways to specify what part of the file you want to print if you want to see other parts of the program: edit location Edit the source file specified by location. Editing starts at that location. Here are the various forms of address: expression Any expression valid in the current working language. this specifies a source line that contains address. such as list and edit. as a convenience. ’filename’::funcaddr Like funcaddr above.3 Editing Source Files To edit the lines in a source file. In addition. In C. For line-oriented commands. This form specifies the address of the function’s first instruction. page 161) that specifies a code address. See Section 9. this is function’Address (although the Pascal form also works). this is simply the function’s name function (and actually a special case of a valid expression). Fortran. for all the possible forms of the location argument. at the specified source line of the specified file. minimal.g. This is useful if the name of the function does not specify the function unambiguously. Alternatively. before the stack frame and arguments have been set up. edit function Edit the file containing function at the beginning of its definition. use the edit command.Chapter 9: Examining Source Files 89 *address Specifies the program address address. Objective-C. .

for instance. The file is first looked up literally. For example. such as ‘/mnt/cross/src/foo-1. suppose an executable references the file ‘/usr/src/foo-1. relative file names with leading directories.4 Searching Source Files There are two commands for searching through the current source file for a regular expression. just the names.90 Debugging with gdb 9. By default.c’. for a match for regexp. if this fails. ‘/mnt/cross/foo.0/lib’. setenv EDITOR /usr/bin/vi gdb . recognizes the following command-line syntax: ex +number file The optional numeric value +number specifies the number of the line in the file where to start editing. It lists the line that is found. if this fails. etc.5 Specifying Source Directories Executable programs sometimes do not record the directories of the source files from which they were compiled. but you can change this by setting the environment variable EDITOR before using gdb. it tries all the directories in the list.c’. 9. starting with the one before the last line listed and going backward. are all treated as described above. and our source path is ‘/mnt/cross’. Each time gdb wants a source file. . You can abbreviate this command as rev. reverse-search regexp The command ‘reverse-search regexp’ checks each line. forward-search regexp search regexp The command ‘forward-search regexp’ checks each line. It lists the line that is found. file names containing dots.0/lib/foo. for a match for regexp. gdb does not look up the parts of the source file name. and 1 The only restriction is that your editor (say ex). this is called the source path.. if this fails. or in the csh shell.0/lib/foo..1 Choosing your Editor You can customize gdb to use any editor you want1 .c’ is tried.0/lib/foo. in the order they are present in the list. it is ‘/bin/ex’. the subdirectories of the source path are not searched: if the source path is ‘/mnt/cross’. You can use the synonym ‘search regexp’ or abbreviate the command name as fo..c’.c’ is opened. the directories could be moved between the compilation and your debugging session. ‘/mnt/cross/usr/src/foo-1. and the binary refers to ‘foo. 9.. if the source path is ‘/mnt/cross’. Even when they do. an error message is printed. to configure gdb to use the vi editor. gdb has a list of directories to search for source files. you could use these commands with the sh shell: EDITOR=/usr/bin/vi export EDITOR gdb . Plain file names. gdb would not find it under ‘/mnt/cross/usr/src/foo-1. starting with the one following the last line listed. For example. until it finds a file with the desired name.3. Likewise.

The search path is used to find both program source files and gdb script files (read using the ‘-command’ option and ‘source’ command). If you moved the entire tree while preserving its internal organization. use the set substitute-path command (see [set substitute-path]. use the directory command.Chapter 9: Examining Source Files 91 the source file is recorded as ‘. this rule will not be applied to ‘/root/usr/source/baz.0/lib/foo.0’. set substitute-path can be more efficient in the case where the sources are organized in a complex tree with multiple subdirectories. You can configure a default source path substitution rule by configuring gdb with the ‘--with-relocated-sources=dir’ option. gdb clears out any information it has cached about where source files are found and where each line is in the file. To add other directories. With the directory command. In [set substitute-path]. and the second specifying how it should be rewritten. The dir should be the name of a directory under gdb’s configured prefix (set with ‘--prefix’ or ‘--exec-prefix’). For instance. suppose the ‘foo-1. When you start gdb. then set substitute-path allows you to direct the debugger to all the sources with one single command. a substitution rule is the only method available to point gdb at the new location. page 92.. gdb provides a set of commands that manage a list of source path substitution rules. The first lookup will then be ‘/mnt/cross/foo-1. gdb would first try ‘.0/lib/foo. To define a source path substitution rule. page 92). you need to add each subdirectory of your project. And because the substitution is applied only at the beginning of the directory name. Note that the executable search path is not used to locate the source files.c’ either.c’. However. and directory names in debug information under dir will be adjusted automatically if the installed gdb is moved . a rule is applied only if the from part of the directory name ends at a directory separator. the first specifying what needs to be rewritten in the path.0’ tree has been moved from ‘/usr/src’ to ‘/mnt/cross’.c’. A rule is made of two strings. you can achieve the same result using the directory command. In addition to the source path.c’. The source path is only used if the file at the original location no longer exists. set substitute-path is also more than just a shortcut command. A substitution rule specifies how to rewrite source directories stored in the program’s debug information in case the sources were moved to a different directory between compilation and debugging./lib/foo. a rule substituting ‘/usr/source’ into ‘/mnt/cross’ will be applied to ‘/usr/source/foo-1. in that order.0’ but not to ‘/usr/sourceware/foo-2. So.c’. In many cases. then you can tell gdb to replace ‘/usr/src’ in all source path names with ‘/mnt/cross’. if for any reason a source file that is not relevant to your executable is located at the original location. its source path includes only ‘cdir’ and ‘cwd’.c’. set substitute-path modifies the debugger behavior to look at the rewritten location instead. Whenever you reset or rearrange the source path... we name these two parts from and to respectively. To avoid unexpected substitution results. On the other hand./lib/foo. Using the previous example.c’ in place of the original location of ‘/usr/src/foo-1. and uses that result instead of the original file name to look up the sources. then ‘/mnt/cross/./lib/foo. and after that—‘/mnt/cross/foo. gdb does a simple string replacement of from with to at the start of the directory part of the source file name.

c’ was moved to ‘/mnt/cross/baz.c’ into ‘/mnt/src/lib/foo. This is useful if gdb. then all substitution rules are deleted.’ on MS-DOS and MSWindows. is selected to perform the substitution. set substitute-path from to Define a source path substitution rule. ‘$cwd’ is not the same as ‘.. Several directory names may be given to this command. dir dirname . . ‘$cdir:$cwd’ are added if missing. then the old rule is also deleted. the rules are evaluated one by one in the order where they have been defined. show directories Print the source path: show which directories it contains. this moves it forward..h’ by using the first rule.h’ into ‘/mnt/include/defs. Add directory dirname to the front of the source path. You may specify a directory that is already in the source path. You can use the string ‘$cdir’ to refer to the compilation directory (if one is recorded). separated by ‘:’ (‘. so gdb searches it sooner.c’ even though it was moved. where ‘:’ usually appears as part of absolute file names) or whitespace. Delete that rule if found. then the command (gdb) set substitute-path /usr/src /mnt/cross will tell gdb to replace ‘/usr/src’ with ‘/mnt/cross’.92 Debugging with gdb to a new location. However. it would use the second rule to rewrite ‘/usr/src/lib/foo. if we had entered the following commands: (gdb) set substitute-path /usr/src/include /mnt/include (gdb) set substitute-path /usr/src /mnt/src gdb would then rewrite ‘/usr/src/include/defs.’—the former tracks the current working directory as it changes during your gdb session. and ‘$cwd’ to refer to the current working directory. The first one matching. This requires confirmation. if the file ‘/foo/bar/baz. if any..c’. libraries or executables with debug information and corresponding source code are being moved together. unset substitute-path [path] If a path is specified. If no path is specified. which will allow gdb to find the file ‘baz. In the case when more than one substitution rule have been defined. set directories path-list Set the source path to path-list. and add it at the end of the current list of existing substitution rules.c’. For example. while the latter is immediately expanded to the current directory at the time you add an entry to the source path. A warning is emitted by the debugger if no rule could be found. For instance. directory dirname . If a rule with the same from was already defined. search the current list of substitution rules for a rule that would rewrite that path. directory Reset the source path to its default value (‘$cdir:$cwd’ on Unix systems)..

After info line. For example. 9. A single argument to this command is a program counter value. You can specify source lines in any of the ways documented in Section 9. if any. You can add all the directories in one command. If your source path is cluttered with directories that are no longer of interest. so that ‘x/i’ is sufficient to begin examining the machine code (see Section 10. We can also inquire (using *addr as the form for linespec) what source line covers a particular address: (gdb) info line *0x63ff Line 926 of "builtin. the info line command causes the arrow to point to the line specified.6 [Examining Memory]. info line linespec Print the starting and ending addresses of the compiled code for source line linespec. page 88. page 117). gdb dumps the function surrounding this value.11 [Convenience Variables]. disassemble disassemble /m disassemble /r This specialized command dumps a range of memory as machine instructions. Also. It can also print mixed source+disassembly by specifying the /m modifier and print the raw instructions in hex as well as in symbolic form by specifying the /r.6 Source and Machine Code You can use the command info line to map source lines to program addresses (and vice versa). Use directory with no argument to reset the source path to its default value. info line prints addresses in symbolic form as well as hex. Also.c" starts at pc 0x63e4 and ends at 0x6404. then print all existing source path substitution rules. the default address for the x command is changed to the starting address of the line. You can use the command set disassemble-next-line to set whether to disassemble next source line when execution stops. we can use info line to discover the location of the object code for the first line of function m4_changequote: (gdb) info line m4_changequote Line 895 of "builtin.Chapter 9: Examining Source Files 93 show substitute-path [path] If a path is specified.2 [Specify Location]. You can correct the situation as follows: 1. The default memory range is the function surrounding the program counter of the selected frame. and the command disassemble to display a range of addresses as machine instructions. . When two arguments are given. page 103). If no path is specified. this address is saved as the value of the convenience variable $_ (see Section 10. Use directory with suitable arguments to reinstall the directories you want in the source path. then print the source path substitution rule which would rewrite that path.c" starts at pc 0x634c and ends at 0x6350. gdb may sometimes cause confusion by finding the wrong versions of source. 2. When run under gnu Emacs mode.

dp 0x32dc <main+228>: ldo 0x588(r1).+10 Dump of assembler code from 0x400281 to 0x40028b: . Here is an example showing mixed source+assembly for Intel x86. The following example shows the disassembly of a range of addresses of HP PA-RISC 2. the instruction at that location is shown with a => marker. The argument(s) can be any expression yielding a numeric value.r26 0x32e0 <main+232>: ldil 0x3000.r1). => 0x0804833c <+12>: movl $0x8048440.rp 0x32d8 <main+224>: addil -0x800.dp 0x32c8 <main+208>: ldw 0x22c(sr0.+length the addresses from start (inclusive) to start+length (exclusive).r31) 0x32d4 <main+220>: ldo 0(r31).%esp $0x10.8’.\n").r31 0x32d0 <main+216>: ble 0x3f8(sr4.94 Debugging with gdb they should be separated by a comma.%eax End of assembler dump. (gdb) disas /r 0x400281. When 2 arguments are specified.0 code: (gdb) disas 0x32c4.r31 End of assembler dump.(%esp) 0x08048343 <+19>: call 0x8048284 <puts@plt> 7 8 return 0. the name of the function is also printed (since there could be several functions in the given range). ‘&main+10’ or ‘$pc . The arguments specify a range of addresses to dump.%esp $0xfffffff0. If the range of memory being disassembled contains current program counter. 0x32e4 Dump of assembler code from 0x32c4 to 0x32e4: 0x32c4 <main+204>: addil 0. } 0x08048348 <+24>: 0x0804834d <+29>: 0x0804834e <+30>: mov leave ret $0x0. in one of two forms: start. such as ‘0x32c4’. Here is another example showing raw instructions in hex for AMD x86-64.r26 0x32cc <main+212>: ldil 0x3000. possibly surrounded by whitespace. when the program is stopped just after function prologue: (gdb) disas /m main Dump of assembler code 5 { 0x08048330 <+0>: 0x08048331 <+1>: 0x08048333 <+3>: 0x08048336 <+6>: 0x08048339 <+9>: for function main: push mov sub and sub %ebp %esp.%esp 6 printf ("Hello.%ebp $0x8.end the addresses from start (inclusive) to end (exclusive) start.

which means never display the disassembly of the next line or instruction. The default is att. the AT&T flavor used by default by Unix assemblers for x86-based targets. .. If AUTO.Chapter 9: Examining Source Files 95 0x0000000000400281: 0x0000000000400283: 0x0000000000400288: 0x0000000000400289: End of assembler dump. For programs that were dynamically linked and use shared libraries.(%rsi) 2d 36 34 2e 73 sub $0x732e3436.(%dx) 2e 32 00 xor %cs:(%rax).%al Some architectures have more than one commonly-used set of instruction mnemonics or other syntax. gdb will display disassembly of the next instruction instead of showing the next source line. or there’s no line info in the debug info). gdb will display disassembly of the next source line when execution of the program being debugged stops. set disassembly-flavor instruction-set Select the instruction set to use when disassembling the program via the disassemble or x/i commands. gdb might be able to resolve these to actual function names. gdb will display disassembly of next instruction only if the source line cannot be displayed. If ON.g. You can set instruction-set to either intel or att. 38 36 cmp %dh. The default is OFF. instructions that call functions or branch to locations in the shared libraries might show a seemingly bogus location—it’s actually a location of the relocation table. set disassemble-next-line show disassemble-next-line Control whether or not gdb will disassemble the next source line or instruction when execution stops. which gdb always does if possible. if gdb cannot find the source file.%eax 6f outsl %ds:(%rsi). This setting causes gdb to display some feedback when you step through a function with no line info or whose source file is unavailable. Currently this command is only defined for the Intel x86 family. This is in addition to displaying the source line itself. On some architectures. show disassembly-flavor Show the current setting of the disassembly flavor. If the next source line cannot be displayed for some reason (e.

.

and string constants.Chapter 10: Examining Data 97 10 Examining Data The usual way to examine data in your program is with the print command (abbreviated p).5 [Output Formats]. most of the expressions shown in examples in this manual are in C.4 [Artificial Arrays]. It may also print the expression using a Python-based pretty-printer (see Section 10. for more information. It also includes preprocessor macros. It examines data in memory at a specified address and prints it in a specified format. see Section 10. gdb supports array constants in expressions input by the user. because it is so useful to cast a number into a pointer in order to examine a structure at that address in memory. gdb copies the array to memory that is malloced in the target program. See Section 10. print expr print /f expr expr is an expression (in the source language). in addition to those common to programming languages: @ ‘@’ is a binary operator for treating parts of memory as arrays. page 25. A more low-level way of examining data is with the x command. page 101. . This includes conditional expressions. page 189. where f is a letter specifying the format. if you compiled your program to include this information. you can choose a different format by specifying ‘/f’. page 116). Any kind of constant. or its synonym inspect. By default the value of expr is printed in a format appropriate to its data type. 3} to create an array of three integers. function calls. page 102. casts. we discuss operators that you can use in gdb expressions regardless of your programming language. variable or operator defined by the programming language you are using is valid in an expression in gdb. page 161. 10. 2. In this section. see Section 10. }. Casts are supported in all languages. for information on how to use expressions in other languages. gdb supports these operators. The syntax is {element. See Section 10.10 [Value History]. page 103. If you are interested in information about types. element. If you pass an array to a function or assign it to a program variable. page 161). gdb displays the last value again (from the value history. .1 [Compilation]. you can use the command print {1. For example.9 [Pretty Printing]. print print /f If you omit expr. This allows you to conveniently inspect the same value in an alternative format. Because C is so widespread. See Chapter 15 [Using gdb with Different Languages]. . See Chapter 16 [Examining the Symbol Table]. see Section 4. not just in C.1 Expressions print and many other gdb commands accept an expression and compute its value. or about how the fields of a struct or a class are declared. It evaluates and prints the value of an expression of the language your program is written in (see Chapter 15 [Using gdb with Different Languages]. page 114).6 [Examining Memory]. use the ptype exp command rather than print.

some programming languages (notably Ada. line number:875 [5] file:String.2 Ambiguous Expressions Expressions can sometimes contain some ambiguous elements.cc. A generic package is similar to C++ templates and is typically instantiated several times. line 867. resulting in the same function name being defined in different contexts. the next option in the menu is ‘[1] all’. We choose three particular definitions of that function name: (gdb) b String::after [0] cancel [1] all [2] file:String. When an ambiguity that needs to be resolved is detected. you can specify the signature of the function you want to break on.cc. and then waits for the selection with the prompt ‘>’. 10. This is called overloading. {type} addr Refers to an object of type type stored at address addr in memory. and typing 1 RET selects all possible choices.3 [Program Variables]. See Section 10. (gdb) set multiple-symbols mode This option allows you to adjust the debugger behavior when an expression is ambiguous. For instance in C++. line number:867 [3] file:String. for application in different contexts. and typing 0 RET aborts the current command.cc. using the fully qualified name of your function often makes the expression unambiguous as well. C++ and Objective-C) permit a single function name to be defined several times. For example. page 99.cc.cc. line number:853 [6] file:String.cc. the following session excerpt shows an attempt to set a breakpoint at the overloaded symbol String::after. line 875. Breakpoint 2 at 0xb344: file String.cc. line number:735 > 2 4 6 Breakpoint 1 at 0xb26c: file String. The first option is always ‘[0] cancel’. line number:860 [4] file:String.cc. it is possible to adjust the expression to remove the ambiguity. If the command in which the expression was used allows more than one choice to be selected. Multiple breakpoints were set. line 846. just as in a cast). Another example involving Ada is generics.cc. as in break function(types).98 Debugging with gdb :: ‘::’ allows you to specify a variable in terms of the file or function where it is defined. Use the "delete" command to delete unwanted breakpoints. line number:846 [7] file:String. Breakpoint 3 at 0xafcc: file String. the debugger has the capability to display a menu of numbered choices for each possibility. For instance. In some cases and depending on the language. addr may be any expression whose value is an integer or pointer (but parentheses are required around binary operators. This construct is allowed regardless of what kind of data is normally supposed to reside at addr. . In Ada.

When mode is set to ask. However. If that happens. show multiple-symbols Show the current value of the multiple-symbols setting.c’: . 10. when mode is set to cancel.Chapter 10: Examining Data 99 By default. If you wish. to print a global value of x defined in ‘f2. the debugger reports an error due to the ambiguity and the command is aborted. referring to that name has unpredictable effects. If the command with which the expression is used allows more than one choice. inserting a breakpoint on a function using an ambiguous name results in a breakpoint inserted on each possible match. but you can only use or examine the variable b while your program is executing inside the block where b is declared. But it is possible to have more than one such variable or function with the same name (in different source files). printing the address of an overloaded function will result in the use of the menu. For instance. In the case of file names. you can use quotes to make sure gdb parses the file name as a single word—for example. bar (b). they must be either: • global (or file-static) or • visible according to the scope rules of the programming language from the point of execution in that frame This means that in the function foo (a) int a.3 Program Variables The most common kind of expression to use is the name of a variable in your program. then gdb uses the menu to help you disambiguate the expression. page 84). { bar (a). There is an exception: you can refer to a variable or function whose scope is a single source file even if the current execution point is not in this file. Variables in expressions are understood in the selected stack frame (see Section 8. } } you can examine and use the variable a whenever your program is executing within the function foo. if a unique choice must be made. you can specify a static variable in a particular function or file. { int b = test ().3 [Selecting a Frame]. For instance. mode is set to all. using the colon-colon (::) notation: file::variable function::variable Here file or function is the name of the context for the static variable. the debugger always uses the menu when an ambiguity is detected. Finally. then gdb automatically selects all possible choices.

d (i=30) at gdb. For program code char var0[] = "A". To solve such problems. local variable definitions may be gone. page 165. Another possible effect of compiler optimizations is to optimize unused variables out of existence. (gdb) next 30 e (i). On exit. To be sure of always seeing accurate values. on most machines. for more information on choosing compiler options. for more information about debug info formats that are best suited to C++ programs. If you ask to print an object whose contents are unknown to gdb.c’::x This use of ‘::’ is very rarely in conflict with the very similar use of the same notation in C++. gdb also supports use of the C++ scope resolution operator in gdb expressions.base/entry-value. See Section 15. Depending on the support for such cases offered by the debug info format used by the compiler. gdb will say ‘<incomplete type>’. See Section 4. page 25.4. or use a different debug info format. You get during debugging . gdb might not be able to display values for such local variables. if the compiler supports several such formats. either recompile without optimizations. page 109. it usually also takes more than one machine instruction to destroy a stack frame. See Chapter 16 [Symbols].1 [Compilation]. Entry values are normally also printed at the function parameter list according to [set print entry-values]. Entry values are available only with some compilers. This is because. This may also happen when the compiler does significant optimizations. Arrays of either signed char or unsigned char get printed as arrays of 1 byte sized integers. gdb will print a message like this: No symbol "foo" in current context.c:29 29 i++.g. a local variable may appear to have the wrong value at certain points in a function—just after entry to a new scope. variables may appear to have the wrong values until the stack frame is completely built. if you are stepping by machine instructions. Warning: Occasionally.100 Debugging with gdb (gdb) p ’f2. fsigned-char or -funsigned-char gcc options have no effect as gdb defines literal string type "char" as char without a sign. it takes more than one instruction to set up a stack frame (including local variable definitions). signed char var1[] = "A". e. If that happens. for more about this.. or assign variables to registers (as opposed to memory addresses). and just before exit. (gdb) print i $1 = 31 (gdb) print i@entry $2 = 30 Strings are identified as arrays of char values without specified signedness. You may see this problem when you are stepping by machine instructions. because its data type is not completely specified by the debug information. Breakpoint 1. page 189. turn off all optimization when compiling. If you append @entry string to a function parameter name you get its value at the time the function got called.1 [C and C++]. after you begin stepping through that group of instructions. If the value is not available an error message is printed.

the elements of interest may not actually be adjacent—for example. after printing one out. 0x5678} Sometimes the artificial array mechanism is not quite enough. Here is an example. using the binary operator ‘@’. suppose you have an array dtab of pointers to structures. The left operand of ‘@’ should be the first element of the desired array and be an individual object. and so on. and are coerced to pointers when used in expressions. page 116). if you are interested in the values of pointers in an array. page 117) as a counter in an expression that prints the first interesting value.. and you are interested in the values of a field fv in each structure. 0 ’\0’} 10. a section of an array. This re-interprets a value as if it were an array. The right operand should be the desired length of the array. Another way to create an artificial array is to use a cast. . The result is an array value whose elements are all of the type of the left argument. One useful work-around in this situation is to use a convenience variable (see Section 10. if you leave the array length out (as in ‘(type[])value’) gdb calculates the size to fill the value (as ‘sizeof(value)/sizeof(type)’: (gdb) p/x (short[])0x12345678 $2 = {0x1234. you can print the contents of array with p *array@len The left operand of ‘@’ must reside in memory.11 [Convenience Variables]. For instance. Array values made with ‘@’ in this way behave just like other arrays in terms of subscripting. The value need not be in memory: (gdb) p/x (short[2])0x12345678 $1 = {0x1234. the second element comes from bytes of memory immediately following those that hold the first element. or an array of dynamically determined size for which only a pointer exists in the program.Chapter 10: Examining Data 101 (gdb) print var0 $1 = "A" (gdb) print var1 $2 = {65 ’A’.4 Artificial Arrays It is often useful to print out several successive objects of the same type in memory. If a program says int *array = (int *) malloc (len * sizeof (int)).10 [Value History]. in moderately complex data structures. You can do this by referring to a contiguous span of memory as an artificial array.. and then repeat that expression via RET. 0x5678} As a convenience. Here is an example of what you might type: set $i = 0 p dtab[$i++]->fv RET RET . The first element is actually the left argument. Artificial arrays most often appear in expressions via the value history (see Section 10.

both absolute in hexadecimal and as an offset from the nearest preceding symbol. The ‘r’ format bypasses any Python pretty-printer which might exist. gdb prints a value according to its data type. and signed char as strings. To do these things. Print as integer in binary. This typically results in a higher-level display of the value’s contents. Print as integer in octal. .1 Print as an address. You can use this format used to discover where (in what function) an unknown address is located: (gdb) p/a 0x54320 $3 = 0x54320 <_initialize_vx+396> The command info symbol 0x54320 yields similar results.102 Debugging with gdb 10. This is done by starting the arguments of the print command with a slash and a format letter. where ‘b’ stands for “byte”. page 189. The format letters supported are: x d u o t a Regard the bits of the value as an integer. The letter ‘t’ stands for “two”. Print as integer in signed decimal. Sometimes this is not what you want. gdb displays char. unsigned char. Regard as a string. specify an output format when you print a value. This prints both the numerical value and its character representation. With this format. page 114). Regard the bits of the value as a floating point number and print using typical floating point syntax.5 Output Formats By default. page 103. pointers to single-byte data are displayed as null-terminated strings and arrays of single-byte data are displayed as fixed-length strings. Without this format. if one is available (see Section 10. Without this format. By default. The simplest use of output formats is to say how to print a value already computed. c Regard as an integer and print it as a character constant. gdb will use a Python-based pretty-printer.6 [Examining Memory].9 [Pretty Printing]. or a pointer in decimal. For example. See Chapter 16 [Symbols]. and signed char data as character constants. you might want to print a number in hex. Single-byte members of a vector are displayed as an integer array. if possible. and print the integer in hexadecimal. Or you might want to view data in memory at a certain address as a character string or as an instruction. 1 f s r ‘b’ cannot be used because these format letters are also used with the x command. Single-byte members of vectors are displayed as integer data. The character representation is replaced with the octal escape ‘\nnn’ for characters outside the 7-bit ascii range. Other values are displayed in their natural types. unsigned char. Print using the ‘raw’ formatting. see Section 10. Print as integer in unsigned decimal. gdb displays pointers to and arrays of char.

x/nfu addr x addr x Use the x command to examine memory. . n. the unit size The unit size is any of b h w g Bytes. 10. the unit size is ignored and is normally not written. ‘u’. that size becomes the default unit the next time you use x. and u are all optional parameters that specify how much memory to display and how to format it. The next use of x /s will again display 8-bit strings. f. For the ‘s’ format. the display format The display format is one of the formats used by print (‘x’. For the ‘i’ format. unless it is explicitly given. this is because command names in gdb cannot contain a slash. Giant words (eight bytes). u.Chapter 10: Examining Data 103 For example. The default changes each time you use either x or print. ‘c’. page 119). The encoding is set by the programming language and cannot be altered. ‘f’. ‘s’). the ‘s’ modifier will use the UTF-16 encoding while ‘w’ will use UTF-32. and in addition ‘i’ (for machine instructions). independently of your program’s data types. f. Halfwords (two bytes). to print the program counter in hex (see Section 10. ‘d’. the repeat count The repeat count is a decimal integer. This is the initial default.6 Examining Memory You can use the command x (for “examine”) to examine memory in any of several formats.12 [Registers]. type p/x $pc Note that no space is required before the slash. you need not type the slash ‘/’. the unit size defaults to ‘b’. Each time you specify a unit size with x. Words (four bytes). Note that the results depend on the programming language of the current compilation unit. addr is an expression giving the address where you want to start displaying memory. ‘o’. the default is 1. ‘t’. It specifies how much memory (counting by units u) to display. To reprint the last value in the value history with a different format. ‘p/x’ reprints the last value in hex. If you use defaults for nfu. Use x /hs to display 16-bit char strings and x /ws to display 32-bit strings. you can use the print command with just a format and no expression. ‘a’. The default is ‘x’ (hexadecimal) initially. Several commands set convenient defaults for addr. If the language is C. For example. n.

page 93. for example. page 97. see Section 10. starting display address addr is the address where you want gdb to begin displaying memory. after you have inspected three machine instructions with ‘x/3i addr’. After an x command. Since the letters indicating unit sizes are all distinct from the letters specifying output formats. including any operands. page 119) in hexadecimal (‘x’).%ebp %ecx $0x4.) Even though the unit size u is ignored for the formats ‘s’ and ‘i’. the repeat count n is used again. if any. for more information on expressions. ‘$sp’. If you use RET to repeat the x command. you can inspect the next seven with just ‘x/7’.6 [Source and Machine Code]. the address and contents saved are from the last memory unit printed.12 [Registers]. especially when used with the display command. ‘x/3uh 0x54320’ is a request to display three halfwords (h) of memory. (However. the other arguments default as for successive uses of x. The output specifications ‘4xw’ and ‘4wx’ mean exactly the same thing. The contents of that address. See Section 10. it is always interpreted as an integer address of a byte of memory. The command disassemble gives an alternative way of inspecting machine instructions. and print (if you use it to display a value from memory). beyond the count specified. Instead. The default for addr is usually just after the last address examined—but several other commands also set the default address: info breakpoints (to the address of the last breakpoint listed). The expression need not have a pointer value (though it may). For example. see Section 9. For example. When examining machine instructions. ‘wx4’ does not work. For example: (gdb) x/5i $pc-6 0x804837f <main+11>: 0x8048381 <main+13>: 0x8048382 <main+14>: => 0x8048385 <main+17>: 0x804838c <main+24>: mov push sub movl call %esp. ‘3i’ specifies that you want to see three machine instructions. either order works. If the x command has a repeat count. ‘x/4xw $sp’ prints the four words (‘w’) of memory above the stack pointer (here. as examined. All the defaults for the arguments to x are designed to make it easy to continue scanning memory with minimal specifications each time you use x. this is not the same as the last address printed if several units were printed on the last line of output. gdb makes these values available for subsequent use in expressions as values of the convenience variables $_ and $__. starting at address 0x54320.%esp $0x8048460. which immediately follow the last instruction that is within the count. you might still want to use a count n.104 Debugging with gdb addr. the instruction at current program counter is shown with a => marker. info line (to the starting address of a line). you do not have to remember whether unit size or format comes first. the ‘i’ format also prints branch delay slot instructions. the last address examined is available for use in expressions in the convenience variable $_. are available in the convenience variable $__. formatted as unsigned decimal integers (‘u’).(%esp) 0x80482d4 <puts@plt> The addresses and contents printed by the x command are not saved in the value history because there is often too much of them and they would get in the way. For convenience. the count n must come first.1 [Expressions]. .

.12 [Registers]. This command’s availability depends on the target’s support for the "qCRC" remote request.. add the expression expr to the auto-display list but arrange to display it each time in the specified format fmt. 10. See Section 10. It can . otherwise it uses print.7 Automatic Display If you find that you want to print the value of an expression frequently (to see how it changes). to remove an expression from the list. The automatic display looks like this: 2: foo = 38 3: bar[5] = (struct hack *) 0x3804 This display shows item numbers. you may wish to verify the program’s image in the remote machine’s memory against the executable file you downloaded to the target. compares all loadable sections. display/fmt addr For fmt ‘i’ or ‘s’. See Section 10.Chapter 10: Examining Data 105 When you are debugging a program running on a remote target machine (see Chapter 20 [Remote Debugging].. or a unit size. expressions and their current values. display expr Add the expression expr to the list of expressions to display each time your program stops. undisplay dnums. display does not repeat if you press RET again after using it. see Section 10. display/fmt expr For fmt specifying only a display format and not a size or count. See Section 10. and report any mismatches. For example.1 [Expressions]. or including a unit-size or a number of units. As with displays you request manually using x or print. Examining means in effect doing ‘x/fmt addr’.6 [Examining Memory]. page 102. Each expression added to the list is given a number to identify it. to see the machine instruction about to be executed each time execution stops (‘$pc’ is a common name for the program counter. page 97. Specify the numbers of the displays that you want affected with the command argument dnums. delete display dnums. page 119). page 219). you specify that number. display decides whether to use print or x depending your format specification—it uses x if you specify either the ‘i’ or ‘s’ format. you can specify the output format you prefer. The comparesections command is provided for such situations. page 103. ‘display/i $pc’ can be helpful. compare-sections [section-name] Compare the data of a loadable section section-name in the executable file of the program being debugged with the same section in the remote machine’s memory. in fact. you might want to add it to the automatic display list so that gdb prints its value each time your program stops. With no arguments..5 [Output Formats]. add the expression addr as a memory address to be examined each time your program stops. Remove items from the list of expressions to display.

106

Debugging with gdb

be a single display number, one of the numbers shown in the first field of the ‘info display’ display; or it could be a range of display numbers, as in 2-4. undisplay does not repeat if you press RET after using it. (Otherwise you would just get the error ‘No display number ...’.) disable display dnums... Disable the display of item numbers dnums. A disabled display item is not printed automatically, but is not forgotten. It may be enabled again later. Specify the numbers of the displays that you want affected with the command argument dnums. It can be a single display number, one of the numbers shown in the first field of the ‘info display’ display; or it could be a range of display numbers, as in 2-4. enable display dnums... Enable display of item numbers dnums. It becomes effective once again in auto display of its expression, until you specify otherwise. Specify the numbers of the displays that you want affected with the command argument dnums. It can be a single display number, one of the numbers shown in the first field of the ‘info display’ display; or it could be a range of display numbers, as in 2-4. display Display the current values of the expressions on the list, just as is done when your program stops.

info display Print the list of expressions previously set up to display automatically, each one with its item number, but without showing the values. This includes disabled expressions, which are marked as such. It also includes expressions which would not be displayed right now because they refer to automatic variables not currently available. If a display expression refers to local variables, then it does not make sense outside the lexical context for which it was set up. Such an expression is disabled when execution enters a context where one of its variables is not defined. For example, if you give the command display last_char while inside a function with an argument last_char, gdb displays this argument while your program continues to stop inside that function. When it stops elsewhere—where there is no variable last_char—the display is disabled automatically. The next time your program stops where last_char is meaningful, you can enable the display expression once again.

10.8 Print Settings
gdb provides the following ways to control how arrays, structures, and symbols are printed. These settings are useful for debugging programs in any language: set print address set print address on gdb prints memory addresses showing the location of stack traces, structure values, pointer values, breakpoints, and so forth, even when it also displays the contents of those addresses. The default is on. For example, this is what a stack frame display looks like with set print address on:

Chapter 10: Examining Data

107

(gdb) f #0 set_quotes (lq=0x34c78 "<<", rq=0x34c88 ">>") at input.c:530 530 if (lquote != def_lquote)

set print address off Do not print addresses when displaying their contents. For example, this is the same stack frame displayed with set print address off:
(gdb) set print addr off (gdb) f #0 set_quotes (lq="<<", rq=">>") at input.c:530 530 if (lquote != def_lquote)

You can use ‘set print address off’ to eliminate all machine dependent displays from the gdb interface. For example, with print address off, you should get the same text for backtraces on all machines—whether or not they involve pointer arguments. show print address Show whether or not addresses are to be printed. When gdb prints a symbolic address, it normally prints the closest earlier symbol plus an offset. If that symbol does not uniquely identify the address (for example, it is a name whose scope is a single source file), you may need to clarify. One way to do this is with info line, for example ‘info line *0x4537’. Alternately, you can set gdb to print the source file and line number when it prints a symbolic address: set print symbol-filename on Tell gdb to print the source file name and line number of a symbol in the symbolic form of an address. set print symbol-filename off Do not print source file name and line number of a symbol. This is the default. show print symbol-filename Show whether or not gdb will print the source file name and line number of a symbol in the symbolic form of an address. Another situation where it is helpful to show symbol filenames and line numbers is when disassembling code; gdb shows you the line number and source file that corresponds to each instruction. Also, you may wish to see the symbolic form only if the address being printed is reasonably close to the closest earlier symbol: set print max-symbolic-offset max-offset Tell gdb to only display the symbolic form of an address if the offset between the closest earlier symbol and the address is less than max-offset. The default is 0, which tells gdb to always print the symbolic form of an address if any symbol precedes it. show print max-symbolic-offset Ask how large the maximum offset is that gdb prints in a symbolic address. If you have a pointer and you are not sure where it points, try ‘set print symbol-filename on’. Then you can determine the name and source file location of the

108

Debugging with gdb

variable where it points, using ‘p/a pointer’. This interprets the address in symbolic form. For example, here gdb shows that a variable ptt points at another variable t, defined in ‘hi2.c’:
(gdb) set print symbol-filename on (gdb) p/a ptt $4 = 0xe008 <t in hi2.c>

Warning: For pointers that point to a local variable, ‘p/a’ does not show the symbol name and filename of the referent, even with the appropriate set print options turned on. Other settings control how different kinds of objects are printed: set print array set print array on Pretty print arrays. This format is more convenient to read, but uses more space. The default is off. set print array off Return to compressed format for arrays. show print array Show whether compressed or pretty format is selected for displaying arrays. set print array-indexes set print array-indexes on Print the index of each element when displaying arrays. May be more convenient to locate a given element in the array or quickly find the index of a given element in that printed array. The default is off. set print array-indexes off Stop printing element indexes when displaying arrays. show print array-indexes Show whether the index of each element is printed when displaying arrays. set print elements number-of-elements Set a limit on how many elements of an array gdb will print. If gdb is printing a large array, it stops printing after it has printed the number of elements set by the set print elements command. This limit also applies to the display of strings. When gdb starts, this limit is set to 200. Setting number-of-elements to zero means that the printing is unlimited. show print elements Display the number of elements of a large array that gdb will print. If the number is 0, then the printing is unlimited. set print frame-arguments value This command allows to control how the values of arguments are printed when the debugger prints a frame (see Section 8.1 [Frames], page 81). The possible values are: all The values of all arguments are printed.

Chapter 10: Examining Data

109

scalars

Print the value of an argument only if it is a scalar. The value of more complex arguments such as arrays, structures, unions, etc, is replaced by .... This is the default. Here is an example where only scalar arguments are shown:
#1 0x08048361 in call_me (i=3, s=..., ss=0xbf8d508c, u=..., e=green) at frame-args.c:23

none

None of the argument values are printed. Instead, the value of each argument is replaced by .... In this case, the example above now becomes:
#1 0x08048361 in call_me (i=..., s=..., ss=..., u=..., e=...) at frame-args.c:23

By default, only scalar arguments are printed. This command can be used to configure the debugger to print the value of all arguments, regardless of their type. However, it is often advantageous to not print the value of more complex parameters. For instance, it reduces the amount of information printed in each frame, making the backtrace more readable. Also, it improves performance when displaying Ada frames, because the computation of large arguments can sometimes be CPU-intensive, especially in large applications. Setting print frame-arguments to scalars (the default) or none avoids this computation, thus speeding up the display of each Ada frame. show print frame-arguments Show how the value of arguments should be displayed when printing a frame. set print entry-values value Set printing of frame argument values at function entry. In some cases gdb can determine the value of function argument which was passed by the function caller, even if the value was modified inside the called function and therefore is different. With optimized code, the current value could be unavailable, but the entry value may still be known. The default value is default (see below for its description). Older gdb behaved as with the setting no. Compilers not supporting this feature will behave in the default setting the same way as with the no setting. This functionality is currently supported only by DWARF 2 debugging format and the compiler has to produce ‘DW_TAG_GNU_call_site’ tags. With gcc, you need to specify ‘-O -g’ during compilation, to get this information. The value parameter can be one of the following: no Print only actual parameter values, never print values from function entry point.
#0 #0 #0 #0 #0 equal (val=5) different (val=6) lost (val=<optimized out>) born (val=10) invalid (val=<optimized out>)

only

Print only parameter values from function entry point. The actual parameter values are never printed.

110

Debugging with gdb

#0 #0 #0 #0 #0

equal (val@entry=5) different (val@entry=5) lost (val@entry=5) born (val@entry=<optimized out>) invalid (val@entry=<optimized out>)

preferred Print only parameter values from function entry point. If value from function entry point is not known while the actual value is known, print the actual value for such parameter.
#0 #0 #0 #0 #0 equal (val@entry=5) different (val@entry=5) lost (val@entry=5) born (val=10) invalid (val@entry=<optimized out>)

if-needed Print actual parameter values. If actual parameter value is not known while value from function entry point is known, print the entry point value for such parameter.
#0 #0 #0 #0 #0 equal (val=5) different (val=6) lost (val@entry=5) born (val=10) invalid (val=<optimized out>)

both

Always print both the actual parameter value and its value from function entry point, even if values of one or both are not available due to compiler optimizations.
#0 #0 #0 #0 #0 equal (val=5, val@entry=5) different (val=6, val@entry=5) lost (val=<optimized out>, val@entry=5) born (val=10, val@entry=<optimized out>) invalid (val=<optimized out>, val@entry=<optimized out>)

compact

Print the actual parameter value if it is known and also its value from function entry point if it is known. If neither is known, print for the actual value <optimized out>. If not in MI mode (see Chapter 27 [GDB/MI], page 337) and if both values are known and identical, print the shortened param=param@entry=VALUE notation.
#0 #0 #0 #0 #0 equal (val=val@entry=5) different (val=6, val@entry=5) lost (val@entry=5) born (val=10) invalid (val=<optimized out>)

default

Always print the actual parameter value. Print also its value from function entry point, but only if it is known. If not in MI mode (see Chapter 27 [GDB/MI], page 337) and if both values are known and identical, print the shortened param=param@entry=VALUE notation.
#0 #0 #0 #0 #0 equal (val=val@entry=5) different (val=6, val@entry=5) lost (val=<optimized out>, val@entry=5) born (val=10) invalid (val=<optimized out>)

Chapter 10: Examining Data

111

For analysis messages on possible failures of frame argument values at function entry resolution see [set debug entry-values], page 132. show print entry-values Show the method being used for printing of frame argument values at function entry. set print repeats Set the threshold for suppressing display of repeated array elements. When the number of consecutive identical elements of an array exceeds the threshold, gdb prints the string "<repeats n times>", where n is the number of identical repetitions, instead of displaying the identical elements themselves. Setting the threshold to zero will cause all elements to be individually printed. The default threshold is 10. show print repeats Display the current threshold for printing repeated identical elements. set print null-stop Cause gdb to stop printing the characters of an array when the first null is encountered. This is useful when large arrays actually contain only short strings. The default is off. show print null-stop Show whether gdb stops printing an array on the first null character. set print pretty on Cause gdb to print structures in an indented format with one member per line, like this:
$1 = { next = 0x0, flags = { sweet = 1, sour = 1 }, meat = 0x54 "Pork" }

set print pretty off Cause gdb to print structures in a compact format, like this:
$1 = {next = 0x0, flags = {sweet = 1, sour = 1}, \ meat = 0x54 "Pork"}

This is the default format. show print pretty Show which format gdb is using to print structures. set print sevenbit-strings on Print using only seven-bit characters; if this option is set, gdb displays any eight-bit characters (in strings or character values) using the notation \nnn. This setting is best if you are working in English (ascii) and you use the highorder bit of characters as a marker or “meta” bit.

112

Debugging with gdb

set print sevenbit-strings off Print full eight-bit characters. This allows the use of more international character sets, and is the default. show print sevenbit-strings Show whether or not gdb is printing only seven-bit characters. set print union on Tell gdb to print unions which are contained in structures and other unions. This is the default setting. set print union off Tell gdb not to print unions which are contained in structures and other unions. gdb will print "{...}" instead. show print union Ask gdb whether or not it will print unions which are contained in structures and other unions. For example, given the declarations
typedef enum {Tree, Bug} Species; typedef enum {Big_tree, Acorn, Seedling} Tree_forms; typedef enum {Caterpillar, Cocoon, Butterfly} Bug_forms; struct thing { Species it; union { Tree_forms tree; Bug_forms bug; } form; }; struct thing foo = {Tree, {Acorn}};

with set print union on in effect ‘p foo’ would print
$1 = {it = Tree, form = {tree = Acorn, bug = Cocoon}}

and with set print union off in effect it would print
$1 = {it = Tree, form = {...}}

set print union affects programs written in C-like languages and in Pascal. These settings are of interest when debugging C++ programs: set print demangle set print demangle on Print C++ names in their source form rather than in the encoded (“mangled”) form passed to the assembler and linker for type-safe linkage. The default is on. show print demangle Show whether C++ names are printed in mangled or demangled form. set print asm-demangle set print asm-demangle on Print C++ names in their source form rather than their mangled form, even in assembler code printouts such as instruction disassemblies. The default is off.

Chapter 10: Examining Data

113

show print asm-demangle Show whether C++ names in assembly listings are printed in mangled or demangled form. set demangle-style style Choose among several encoding schemes used by different compilers to represent C++ names. The choices for style are currently: auto gnu hp lucid arm Allow gdb to choose a decoding style by inspecting your program. Decode based on the gnu C++ compiler (g++) encoding algorithm. This is the default. Decode based on the HP ANSI C++ (aCC) encoding algorithm. Decode based on the Lucid C++ compiler (lcc) encoding algorithm. Decode using the algorithm in the C++ Annotated Reference Manual. Warning: this setting alone is not sufficient to allow debugging cfront-generated executables. gdb would require further enhancement to permit that.

If you omit style, you will see a list of possible formats. show demangle-style Display the encoding style currently in use for decoding C++ symbols. set print object set print object on When displaying a pointer to an object, identify the actual (derived) type of the object rather than the declared type, using the virtual function table. Note that the virtual function table is required—this feature can only work for objects that have run-time type identification; a single virtual method in the object’s declared type is sufficient. set print object off Display only the declared type of objects, without reference to the virtual function table. This is the default setting. show print object Show whether actual, or declared, object types are displayed. set print static-members set print static-members on Print static members when displaying a C++ object. The default is on. set print static-members off Do not print static members when displaying a C++ object. show print static-members Show whether C++ static members are printed or not. set print pascal_static-members set print pascal_static-members on Print static members when displaying a Pascal object. The default is on.

114

Debugging with gdb

set print pascal_static-members off Do not print static members when displaying a Pascal object. show print pascal_static-members Show whether Pascal static members are printed or not. set print vtbl set print vtbl on Pretty print C++ virtual function tables. The default is off. (The vtbl commands do not work on programs compiled with the HP ANSI C++ compiler (aCC).) set print vtbl off Do not pretty print C++ virtual function tables. show print vtbl Show whether C++ virtual function tables are pretty printed, or not.

10.9 Pretty Printing
gdb provides a mechanism to allow pretty-printing of values using Python code. It greatly simplifies the display of complex objects. This mechanism works for both MI and the CLI.

10.9.1 Pretty-Printer Introduction
When gdb prints a value, it first sees if there is a pretty-printer registered for the value. If there is then gdb invokes the pretty-printer to print the value. Otherwise the value is printed normally. Pretty-printers are normally named. This makes them easy to manage. The ‘info pretty-printer’ command will list all the installed pretty-printers with their names. If a pretty-printer can handle multiple data types, then its subprinters are the printers for the individual data types. Each such subprinter has its own name. The format of the name is printer-name;subprinter-name. Pretty-printers are installed by registering them with gdb. Typically they are automatically loaded and registered when the corresponding debug information is loaded, thus making them available without having to do anything special. There are three places where a pretty-printer can be registered. • Pretty-printers registered globally are available when debugging all inferiors. • Pretty-printers registered with a program space are available only when debugging that program. See Section 23.2.2.14 [Progspaces In Python], page 308, for more details on program spaces in Python. • Pretty-printers registered with an objfile are loaded and unloaded with the corresponding objfile (e.g., shared library). See Section 23.2.2.15 [Objfiles In Python], page 309, for more details on objfiles in Python. See Section 23.2.2.6 [Selecting Pretty-Printers], page 295, for further information on how pretty-printers are selected, See Section 23.2.2.7 [Writing a Pretty-Printer], page 296, for implementing pretty printers for new types.

Chapter 10: Examining Data

115

10.9.2 Pretty-Printer Example
Here is how a C++ std::string looks without a pretty-printer:
(gdb) print s $1 = { static npos = 4294967295, _M_dataplus = { <std::allocator<char>> = { <__gnu_cxx::new_allocator<char>> = { <No data fields>}, <No data fields> }, members of std::basic_string<char, std::char_traits<char>, std::allocator<char> >::_Alloc_hider: _M_p = 0x804a014 "abcd" } }

With a pretty-printer for std::string only the contents are printed:
(gdb) print s $2 = "abcd"

10.9.3 Pretty-Printer Commands
info pretty-printer [object-regexp [name-regexp]] Print the list of installed pretty-printers. This includes disabled pretty-printers, which are marked as such. object-regexp is a regular expression matching the objects whose pretty-printers to list. Objects can be global, the program space’s file (see Section 23.2.2.14 [Progspaces In Python], page 308), and the object files within that program space (see Section 23.2.2.15 [Objfiles In Python], page 309). See Section 23.2.2.6 [Selecting Pretty-Printers], page 295, for details on how gdb looks up a printer from these three objects. name-regexp is a regular expression matching the name of the printers to list. disable pretty-printer [object-regexp [name-regexp]] Disable pretty-printers matching object-regexp and name-regexp. A disabled pretty-printer is not forgotten, it may be enabled again later. enable pretty-printer [object-regexp [name-regexp]] Enable pretty-printers matching object-regexp and name-regexp. Example: Suppose we have three pretty-printers installed: one from library1.so named foo that prints objects of type foo, and another from library2.so named bar that prints two types of objects, bar1 and bar2.
(gdb) info pretty-printer library1.so: foo library2.so: bar bar1 bar2 (gdb) info pretty-printer library2 library2.so:

116

Debugging with gdb

bar bar1 bar2 (gdb) disable pretty-printer library1 1 printer disabled 2 of 3 printers enabled (gdb) info pretty-printer library1.so: foo [disabled] library2.so: bar bar1 bar2 (gdb) disable pretty-printer library2 bar:bar1 1 printer disabled 1 of 3 printers enabled (gdb) info pretty-printer library2 library1.so: foo [disabled] library2.so: bar bar1 [disabled] bar2 (gdb) disable pretty-printer library2 bar 1 printer disabled 0 of 3 printers enabled (gdb) info pretty-printer library2 library1.so: foo [disabled] library2.so: bar [disabled] bar1 [disabled] bar2

Note that for bar the entire printer can be disabled, as can each individual subprinter.

10.10 Value History
Values printed by the print command are saved in the gdb value history. This allows you to refer to them in other expressions. Values are kept until the symbol table is re-read or discarded (for example with the file or symbol-file commands). When the symbol table changes, the value history is discarded, since the values may contain pointers back to the types defined in the symbol table. The values printed are given history numbers by which you can refer to them. These are successive integers starting with one. print shows you the history number assigned to a value by printing ‘$num = ’ before the value; here num is the history number. To refer to any previous value, use ‘$’ followed by the value’s history number. The way print labels its output is designed to remind you of this. Just $ refers to the most recent value in the history, and $$ refers to the value before that. $$n refers to the nth value from the end; $$2 is the value just prior to $$, $$1 is equivalent to $$, and $$0 is equivalent to $. For example, suppose you have just printed a pointer to a structure and want to see the contents of the structure. It suffices to type
p *$

Chapter 10: Examining Data

117

If you have a chain of structures where the component next points to the next one, you can print the contents of the next one with this:
p *$.next

You can print successive links in the chain by repeating this command—which you can do by just typing RET. Note that the history records values, not expressions. If the value of x is 4 and you type these commands:
print x set x=5

then the value recorded in the value history by the print command remains 4 even though the value of x has changed. show values Print the last ten values in the value history, with their item numbers. This is like ‘p $$9’ repeated ten times, except that show values does not change the history. show values n Print ten history values centered on history item number n. show values + Print ten history values just after the values last printed. If no more values are available, show values + produces no display. Pressing RET to repeat show values n has exactly the same effect as ‘show values +’.

10.11 Convenience Variables
gdb provides convenience variables that you can use within gdb to hold on to a value and refer to it later. These variables exist entirely within gdb; they are not part of your program, and setting a convenience variable has no direct effect on further execution of your program. That is why you can use them freely. Convenience variables are prefixed with ‘$’. Any name preceded by ‘$’ can be used for a convenience variable, unless it is one of the predefined machine-specific register names (see Section 10.12 [Registers], page 119). (Value history references, in contrast, are numbers preceded by ‘$’. See Section 10.10 [Value History], page 116.) You can save a value in a convenience variable with an assignment expression, just as you would set a variable in your program. For example:
set $foo = *object_ptr

would save in $foo the value contained in the object pointed to by object_ptr. Using a convenience variable for the first time creates it, but its value is void until you assign a new value. You can alter the value with another assignment at any time. Convenience variables have no fixed types. You can assign a convenience variable any type of value, including structures and arrays, even if that variable already has a value of a different type. The convenience variable, when used as an expression, has the type of its current value.

If the variable is already defined then the expression is not evaluated so any side-effects do not occur. it will be empty before you execute the run command. For example. if the application has not yet received any signals. page 144. or if extra static tracepoint data has not been collected. It is similar.1. See Section E. to using local static variables with initializers in C (except that convenience variables are global). init-if-undefined $variable = expression Set a convenience variable if it has not already been set. Its type is chosen to match the format in which the data was printed. The variable $_exitcode is automatically set to the exit code when the program being debugged terminates. The type of $_ is void * except when set by the x command. Some convenience variables are created automatically by gdb and given values likely to be useful. page 103). This variable contains the address of the thread information block. to print a field from successive elements of an array of structures: set $i = 0 print bar[$i++]->contents Repeat that command by typing RET. page 67). Note that $_sdata could be empty. One of the ways to use a convenience variable is as a counter to be incremented or a pointer to be advanced.118 Debugging with gdb show convenience Print a list of convenience variables used so far. For example.4 [General Query Packets]. Note that $_siginfo could be empty. The variable $__ is automatically set by the x command to the value found in the last address examined. in concept. $_sdata The variable $_sdata contains extra collected static tracepoint data.6 [Tracepoint Action Lists]. Abbreviated show conv. The variable $_siginfo contains extra signal information (see [extra signal information]. $__ $_exitcode $_siginfo . It can also be used to allow users to override default values used in a command script. these commands include info line and info breakpoint. $_tlb The variable $_tlb is automatically set when debugging applications running on MS-Windows in native mode or connected to gdbserver that supports the qGetTIBAddr request.6 [Examining Memory]. Other commands which provide a default address for x to examine also set $_ to that address. See Section 13. if not inspecting a trace buffer. and their values. $_ The variable $_ is automatically set by the x command to the last address examined (see Section 10. This is useful for user-defined commands that keep some state. in which case it is a pointer to the type of $__. page 477.

nowadays). before it searches for a convenience variable. gdb has four “standard” register names that are available (in expressions) on most machines—whenever they do not conflict with an architecture’s canonical mnemonics for registers. if you refer to a function or variable name that begins with a dollar sign. page 197.12 Registers You can refer to machine register contents. As discussed in detail below. register values are normally relative to the selected stack frame. on the SPARC. . The register names $pc and $sp are used for the program counter register and the stack pointer. see Section 17. $fp is used for a register that contains a pointer to the current stack frame. use return. help function Print a list of all convenience functions. so long as there is no conflict. you could print the program counter in hex with p/x $pc or print the instruction to be executed next with x/i $pc or add four to the stack pointer2 with set $sp += 4 Whenever possible. on machines where stacks grow downward in memory (most machines. as variables with names starting with ‘$’. in expressions. A convenience function can be used in an expression just like an ordinary function. info registers Print the names and values of all registers except floating-point and vector registers (in the selected stack frame). gdb searches for a user or system name first. a convenience function is implemented internally to gdb. setting $sp is not allowed when other stack frames are selected. these four standard register names are available on your machine even though the machine has different canonical mnemonics. regardless of machine architecture. This assumes that the innermost stack frame is selected. The names of registers are different for each machine. info all-registers Print the names and values of all registers.4 [Returning from a Function]. however.. The info registers command shows the canonical names. To pop entire frames off the stack.. including floating-point and vector registers (in the selected stack frame).Chapter 10: Examining Data 119 On HP-UX systems. 10. and $ps is used for a register that contains the processor status. use info registers to see the names used on your machine. gdb also supplies some convenience functions. regname may be any register name valid on the machine you are using. with or without the initial ‘$’. These have a syntax similar to convenience variables. info registers regname . 2 This is a way of removing one word from the stack. For example. Print the relativized value of each specified register regname. For example.

register values are relative to the selected stack frame (see Section 8. Some registers have distinct “raw” and “virtual” data formats. 1. 0. . 0.54142831e-044. 20657912.\001\v\000\000\000\r\000\000".13 Floating Point Hardware Depending on the configuration. Currently. v8_int16 = {0. Some machines have special registers whose contents can be interpreted in several different ways. 10. This means that you get the value that the register would contain if all stack frames farther in were exited and their saved registers restored.120 Debugging with gdb info registers displays the processor status register as $psr but you can also refer to it as $ps.92129282474342e-303. but all C programs expect to work with “double” (virtual) format. In such cases. 315. v2_double = {9. and on x86-based machines $ps is an alias for the eflags register. as if you were assigning value to a struct member: (gdb) set $xmm1. 13. the registers of the 68881 floating point coprocessor are always saved in “extended” (raw) format. 0}. 14072. v16_int8 = "\000\000\000\000\3706.3 [Selecting a Frame]. For example. 13}. uint128 = 0x0000000d0000000b013b36f800000000 } To set values of such registers. 3. The exact contents and layout vary depending on the floating point chip.43859137e-038. gdb always considers the contents of an ordinary register as an integer when the register is examined in this way. info float Display hardware-dependent information about the floating point unit. Some machines have special registers which can hold nothing but floating point. There is no way to refer to the contents of an ordinary register as floating point value (although you can print it as a floating point value with ‘print/f $regname’). the selected stack frame makes no difference. If some registers are not saved. gdb may be able to give you more information about the status of the floating point hardware. However. page 84). but the info registers command prints the data in both formats. ‘info float’ is supported on the ARM and x86 machines.821688e-044}. these registers are considered to have floating point values. gdb must deduce where registers are saved. 11. This means that the data format in which the register contents are saved by the operating system is not the same one that your program normally sees. from the machine code generated by your compiler. 55834574859}.uint128 = 0x000000000000000000000000FFFFFFFF Normally. v4_int32 = {0.7585945287983262e-313}. you must select the innermost frame (with ‘frame 0’). you need to tell gdb which view of the register you wish to change. For example. 1. or if gdb is unable to locate the saved registers. 11. modern x86-based machines have SSE and MMX registers that can hold several values packed together in several different formats. v2_int64 = {88725056443645952. gdb refers to such registers in struct notation: (gdb) print $xmm1 $1 = { v4_float = {0. 2. In order to see the true contents of hardware registers. gdb normally works with the virtual format only (the format that makes sense for your program).

and the command corresponding to the process. page 490. If the target does not return a list of possible types. For remote targets. gdb displays each value in the most appropriate form for a recognized tag. without interpretation. info udot Display the contents of the struct user maintained by the OS kernel for the program being debugged. called struct user. You can use the command info udot to display the contents of this data structure. info os List the types of OS information available for the target. gdb may be able to show you this information. info os processes Display the list of processes on the target. Some operating systems supply an auxiliary vector to programs at startup.15 Operating System Auxiliary Information gdb provides interfaces to useful OS facilities that can help you debug your program. Depending on the configuration and operating system facilities. gdb prints the process identifier. the meanings are well-known but system-specific. for this interface. gdb displays the contents of struct user as a list of hex numbers. For each process. this functionality depends on the remote stub’s support of the ‘qXfer:osdata:read’ packet. page 491. and also shows names and text descriptions for recognized tags. similar to the examine command.14 Vector Unit Depending on the configuration. and some pointers to strings or other data. see [qXfer osdata read]. this functionality may further depend on the remote stub’s support of the ‘qXfer:auxv:read’ packet. gdb can access operating-system-specific information and display it to user. When gdb runs on a Posix system (such as GNU or Unix machines). this command will report an error. some bit masks. the name of the user. but contains a systemdependent variety of binary values that tell system libraries important details about the hardware. and in hexadecimal for an unrecognized tag. operating system. info auxv Display the auxiliary vector of the inferior. The exact contents and layout vary depending on the hardware. which can be either a live process or a core dump file. 10. . This is akin to the arguments and environment that you specify for a program. Each value’s purpose is identified by an integer tag. gdb may be able to give you more information about the status of the vector unit. see [qXfer auxiliary vector read]. and process. Some values in the vector are numbers. info vector Display information about the vector unit.Chapter 10: Examining Data 121 10. The operating system creates a special sata structure. gdb prints each tag value numerically. For remote targets. it interfaces with the inferior via the ptrace system call. On some targets.

.. When a memory region is disabled. or no regions if the target does not support. with the following columns for each region: Memory Region Number Enabled or Disabled.16. Remove memory regions nums . 0xffffffff on 32 bit targets..16 Memory Region Attributes Memory region attributes allow you to describe special handling required by regions of your target’s memory. By default the description of memory regions is fetched from the target (if the current target supports this). (0xffff on 16 bit targets. to enable. delete mem nums. info mem Print a table of all defined memory regions. and whether to cache target memory. . Note that upper == 0 is a special case: it is treated as the target’s maximum memory address. if available..1 Attributes . . enable mem nums. Enable monitoring of memory regions nums . . . disable mem nums. . 10. . A disabled memory region is not forgotten. . gdb uses attributes to determine whether to allow certain types of memory accesses. gdb uses the default attributes when accessing memory in that region. from the list of regions monitored by gdb.) mem auto Discard any user changes to the memory regions and use target-supplied regions.. mem lower upper attributes. and add it to the list of regions monitored by gdb. Define a memory region bounded by lower and upper with attributes attributes . but the user can override the fetched regions. you specify that number.. Disabled memory regions are marked with ‘n’.. Lo Address The address defining the inclusive lower bound of the memory region. disable. Similarly. it is given a number to identify it. . It may be enabled again later.122 Debugging with gdb 10. . Defined memory regions can be individually enabled and disabled. Disable monitoring of memory regions nums . . Attributes The list of attributes set for this memory region. . Enabled memory regions are marked with ‘y’. Hi Address The address defining the exclusive upper bound of the memory region. When a memory region is defined. whether to use specific width accesses.. etc. or remove a memory region. gdb uses the default attributes when accessing all memory. if no memory regions have been defined.

set mem inaccessible-by-default [on|off] If on is specified. or to provide better error checking.16.2 Memory Access Size The access size attribute tells gdb to use specific sized accesses in the memory region. The following commands control this behaviour. make gdb treat the memory not explicitly described by the memory ranges as RAM. Memory is write only. 10. it can lead to incorrect results because gdb does not know about volatile variables or memory mapped device registers. 10.2 Memory Access Checking gdb can be instructed to refuse accesses to memory that is not explicitly described.16. cache nocache Enable gdb to cache target memory. 10. from accessing memory. While these attributes prevent gdb from performing invalid memory accesses. The checks are only performed if there’s at least one memory range defined. Disable gdb from caching target memory. Use 64 bit memory accesses. While this generally improves performance by reducing debug protocol overhead. make gdb treat memory not explicitly described by the memory ranges as non-existent and refuse accesses to such memory. If off is specified. Often memory mapped device registers require specific sized accesses. show mem inaccessible-by-default Show the current handling of accesses to unknown memory.1. Memory is read/write.Chapter 10: Examining Data 123 10. This can be useful if accessing such regions has undesired effects for a specific target. Use 32 bit memory accesses.1. 8 16 32 64 Use 8 bit memory accesses. This is the default. . gdb may use accesses of any size. etc. This is the default. Use 16 bit memory accesses.3 Data Cache The data cache attributes set whether gdb will cache target memory. I/O DMA.1 Memory Access Mode The access mode attributes set whether gdb may make read or write accesses to a memory region. they do nothing to prevent the target system.16. ro wo rw Memory is read only.1.16. The default value is on. If no access size attribute is specified.

The format parameter may be any one of: binary ihex srec tekhex Raw binary form. they will be restored at offset bias from that location. To restore a raw binary file you must specify the optional keyword binary after the filename. its value will be added to the addresses contained in the file. These offsets are relative to the addresses in the file. before the bias argument is applied.17 Copy Between Memory and a File You can use the commands dump. to filename in the given format. (gdb can only append data to files in raw binary form.124 Debugging with gdb 10. for information on invoking gdb in the post-mortem debugging mode. append [binary] memory filename start_addr end_addr append [binary] value filename expr Append the contents of memory from start addr to end addr. gdb uses the same definitions of these formats as the gnu binary utilities. Intel hex. in raw binary form. If format is omitted. append. Intel hex format. Motorola S-record.1 [Files]. or Tektronix Hex format. See Section 18. to the file filename. however. If bias is non-zero. 10. except for raw binary. gdb dumps the data in raw binary form. A program that crashes automatically produces a core file. Its primary use is post-mortem debugging of a program that crashed while it ran outside a debugger. Motorola S-record format. If start and/or end are non-zero. Other bfd files have a built-in location. page 201. Tektronix Hex format. like ‘objdump’ and ‘objcopy’.) restore filename [binary] bias start end Restore the contents of file filename into memory. then only data between file offset start and file offset end will be restored. . unless this feature is disabled by the user. The dump and append commands write data to a file. dump [format] memory filename start_addr end_addr dump [format] value filename expr Dump the contents of memory from start addr to end addr.). or the value of expr. or the value of expr. Files may be in binary.18 How to Produce a Core File from Your Program A core file or core dump is a file that records the memory image of a running process and its process status (register values etc. gdb can only append to binary files. so they will be restored at address bias. and the restore command reads data from a file back into the inferior’s memory. The restore command can automatically recognize any known bfd file format. Binary files always start at address zero. and restore to copy data between target memory and a file.

Note that this command is implemented only for some systems (as of this writing. using the set target-charset command. set charset charset Set the current host and target character sets to charset. As above. In this case. type set target-charset TABTAB. gdb cannot automatically determine the appropriate host character set. which uses the ISO Latin 1 character set. show charset Show the names of the current host and target character sets. and the target character set is ebcdic. Unixware. if you are running gdb on a gnu/Linux system. which uses the ebcdic character set. but you are using gdb’s remote protocol (see Chapter 20 [Remote Debugging]. Solaris. gdb uses a host character set appropriate to the system it is running on. If not specified. you can override that default using the set host-charset command. you must tell it. where pid is the inferior process ID. or use character and string literals in expressions. 10. gdb can only use certain character sets as its host character set. gdb has no way to automatically recognize which character set the inferior program uses. For example. Here are the commands for controlling gdb’s character set support: set target-charset charset Set the current target character set to charset. gdb can automatically translate between the character sets for you. If you give gdb the command set target-charset EBCDIC-US. If you type set host-charset TABTAB. To display the list of supported target character sets.Chapter 10: Examining Data 125 Occasionally. gnu/Linux. if you type set charset TABTAB. The character set gdb uses we call the host character set. gdb will list the names of the character sets that can be used for both host and target. gdb uses ‘UTF-8’. the file name defaults to ‘core. the one the inferior program uses we call the target character set. then the host character set is Latin-1.19 Character Sets If the program you are debugging uses a different character set to represent characters and strings than the one gdb uses itself. By default. then gdb translates between ebcdic and Latin 1 as you print character or string values.pid’. you may wish to produce a core file of the program you are debugging in order to preserve a snapshot of its state. page 219) to debug a program running on an IBM mainframe. On some systems. FreeBSD. and S390). gdb has a special command for that. gdb will list the host character sets it supports. generate-core-file [file] gcore [file] Produce a core dump of the inferior process. . described below. set host-charset charset Set the current host character set to charset. The optional argument file specifies the file name where to put the core dump.

10. let’s assume that if gdb prints characters using the ascii character set. world!\n"). encoded in the ascii and ibm1047 character sets. set target-wide-charset charset Set the current target’s wide character set to charset. 33. let’s use ascii as our initial character set: (gdb) set charset ASCII (gdb) show charset The current host and target character set is ‘ASCII’. Assume that the following source code has been placed in the file ‘charset-test. show target-charset Show the name of the current target character set. char ibm1047_hello[] = {200. 108. 111. 107. world!’ followed by a newline.h> char ascii_hello[] = {72. 153. 90. 166. Inc. We compile the program. Here is an example of gdb’s character set support in action. 114.. ascii_hello and ibm1047_hello are arrays containing the string ‘Hello. 150. our terminal will display them properly. 64. } In this program. 32. 150. the contents of ascii_hello print legibly: . 147. To display the list of supported wide character sets. (gdb) For the sake of printing this manual.c -o charset-test $ gdb -nw charset-test GNU gdb 2001-12-19-cvs Copyright 2001 Free Software Foundation.126 Debugging with gdb show host-charset Show the name of the current host character set.. 108. 100. 133.c’: #include <stdio. 147. 101. 37. Since our current target character set is also ascii. 132. and invoke the debugger on it: $ gcc -g charset-test. 111. main () { printf ("Hello. type set target-wide-charset TABTAB. (gdb) Let’s assume that ascii is indeed the correct character set for our host system — in other words. (gdb) We can use the show charset command to see what character sets gdb is currently using to interpret and display characters and strings: (gdb) show charset The current host and target character set is ‘ISO-8859-1’. 119. show target-wide-charset Show the name of the current target’s wide character set. 147. 0}. 0}. . This is the character set used by the target’s wchar_t type. 44. 108.

gdb tells us the character sets it supports: (gdb) set target-charset ASCII EBCDIC-US IBM1047 (gdb) set target-charset ISO-8859-1 We can select ibm1047 as our target character set. world!\n" (gdb) print ibm1047_hello[0] $9 = 200 ’H’ (gdb) As above. because it reduces the overhead of the remote protocol by bundling memory reads and writes into large . (gdb) print ascii_hello $6 = 0x401698 "\110\145%%?\054\040\167?\162%\144\041\012" (gdb) print ascii_hello[0] $7 = 72 ’\110’ (gdb) print ibm1047_hello $8 = 0x4016a8 "Hello. 10. and they display correctly: (gdb) set target-charset IBM1047 (gdb) show charset The current host character set is ‘ASCII’. The current target character set is ‘IBM1047’. ascii. gdb uses the target character set for character and string literals you use in expressions: (gdb) print ’+’ $10 = 78 ’+’ (gdb) The ibm1047 character set uses the number 78 to encode the ‘+’ character. world!\n" (gdb) print ascii_hello[0] $2 = 72 ’H’ (gdb) gdb uses the target character set for character and string literals you use in expressions: (gdb) print ’+’ $3 = 43 ’+’ (gdb) The ascii character set uses the number 43 to encode the ‘+’ character. If we print ibm1047_hello while our target character set is still ascii. ibm1047. Now the ascii string is wrong.20 Caching Data of Remote Targets gdb caches data exchanged between the debugger and a remote target (see Chapter 20 [Remote Debugging]. gdb relies on the user to tell it which character set the target program uses.Chapter 10: Examining Data 127 (gdb) print ascii_hello $1 = 0x401698 "Hello. page 219). Such caching generally improves performance. and examine the program’s strings again. we get jibberish: (gdb) print ibm1047_hello $4 = 0x4016a8 "\310\205\223\223\226k@\246\226\231\223\204Z%" (gdb) print ibm1047_hello[0] $5 = 200 ’\310’ (gdb) If we invoke the set target-charset followed by TABTAB. but gdb translates the contents of ibm1047_hello from the target character set. to the host character set.

this option is ON. and for each cache line. By default. Therefore. If a line number is specified. it exists for compatibility with old scripts. See also Section 10. etc. the contents of that line will be printed in hex. When ON. page 122. gdb only caches data known to be on the stack3 . Furthermore.20 [Caching Remote Data]. since gdb does not necessarily know anything about volatile values.16 [Memory Region Attributes]. Must be a power of 2. by default. Other regions of memory can be explicitly marked as cacheable. See also Section 10. and caching of stack reads provides a significant speed up of remote backtraces. page 127. page 127.5. show remotecache Show the current state of the obsolete remotecache flag. show dcache line-size Show default size of dcache lines. set remotecache on set remotecache off This option no longer does anything. see see Section 10. page 69) memory can be changed while a gdb command is executing. 10. info dcache [line] Print the information about the data cache performance.128 Debugging with gdb chunks. set dcache size size Set maximum number of entries in dcache (dcache depth above). This command is useful for debugging the data cache operation. in non-stop mode (see Section 5. it is moderately rare for a running thread to modify the stack of a stopped thread in a way that would interfere with a backtrace. set dcache line-size line-size Set number of bytes each dcache entry caches (dcache width above). and how many times it was referenced. show stack-cache Show the current state of data caching for memory accesses. set stack-cache on set stack-cache off Enable or disable caching of stack accesses.20 [Caching Remote Data]. Unfortunately. simply caching everything would lead to incorrect results. show dcache size Show maximum number of dcache entries. 3 In non-stop mode. address.21 Search Memory Memory can be searched for a particular sequence of bytes with the find command. memory-mapped I/O addresses. . The information displayed includes the dcache width and depth. use caching. its number.2 [Non-Stop Mode].

You can use strings as search values. etc. regardless of the endianness of the target and the size specification. val2.] find [/sn] start_addr. .Chapter 10: Examining Data 129 find [/sn] start_addr.. ’e’. search query size The size of each search query value. val2. printf ("%s\n". . b h w g bytes halfwords (two bytes) words (four bytes) giant words (eight bytes) All values are interpreted in the current language. s. apart or together. int i. +sizeof(hello). n. ’h’. For example. The default is to print all finds. static struct { char c. val2. that in the case of C-like languages a search for an untyped 0x42 will search for ‘(int) 0x42’ which is typically four bytes. 0x1234. maximum number of finds The maximum number of matches to print. Quote them with double-quotes (").] Search memory for the sequence of bytes specified by val1. ’l’. +sizeof(hello). The address of each match found is printed as well as a count of the number of matches found. ’o’ . if stopped at the printf in this function: void hello () { static char hello[] = "hello-hello".. end_addr. hello).. "hello" 0x804956d <hello. A count of the number of matches is stored in ‘$numfound’. The address of the last value found is stored in convenience variable ‘$_’. val1 [.1620+6> 1 pattern found (gdb) find &hello[0]. for example. } you get during debugging: (gdb) find &hello[0]. for example. The search begins at address start addr and continues for either len bytes or through to end addr inclusive. +len. val1 [.. s and n are optional parameters. short s. that if the current source language is C/C++ then searching for the string “hello” includes the trailing ’\0’. 0x87654321 }. } __attribute__ ((packed)) mixed = { ’c’. If the value size is not specified. This is useful when one wants to specify the search pattern as a mixture of types. This means. it is taken from the value’s type in the current language. Note that this means. They may be specified in either order. The string value is copied into the search pattern byte by byte. ’l’.

+sizeof(mixed).1620+6> 2 patterns found (gdb) find /b1 &hello[0]. +sizeof(hello).1625> 1 pattern found (gdb) print $numfound $1 = 1 (gdb) print $_ $2 = (void *) 0x8049560 . ’l’ 0x8049567 <hello.1620> 0x804956d <hello. (char) ’c’.130 Debugging with gdb 0x8049567 <hello. (short) 0x1234. 0x65. ’h’. (int) 0x87654321 0x8049560 <mixed.1620> 1 pattern found (gdb) find &mixed.

please report it to us as a bug (including a test case!).1 Inline Functions Inlining is an optimization that inserts a copy of the function body directly at each call site. and several other compilers do also. As the compiler applies more powerful optimizations. It instead displays the arguments and local variables of inlined functions as local variables in the caller. it is easier to follow the progress of your program during debugging. and if this fixes the problem. gdb only supports inlined functions when using dwarf 2. and escape from them with finish. unlike a non-inlined function. For gdb to support inlined functions. With help from debugging information generated by the compiler. particularly on machines with instruction scheduling. in a simplistic way. With optimization disabled. You can check whether a function was inlined by using the info frame command.3 [Variables]. the generated assembly code diverges from your original source code. If you can recompile without optimization. gdb displays inlined functions just like non-inlined functions. you can see both the context of the call and then the effect of the call. step into them with step. Only stepping by a single instruction using stepi or nexti does not do this. gdb is more accurate with optimization disabled. the compiler generates assembly code that corresponds directly to your source code. the debugger shows you what is really there. They appear in backtraces. Do not be too surprised when the execution path does not exactly match your source file! An extreme example: if you define a variable. page 99. and then stepping again shows the first line of the inlined function. gdb still pretends that the call site and the start of the inlined function are different instructions. recompile with ‘-g’ alone. instead of jumping to a shared routine. gdb can map from the running program back to constructs from your original source. Stepping to the call site shows the call site. The body of an inlined function is directly included at its call site. This makes source-level debugging much clearer. but never use it. But. Versions of gcc before 4. there are many cases where you may need to debug an optimized version. skip them with next. remember that the optimizer has rearranged your code. There are some ways that gdb does not pretend that inlined function calls are the same as normal calls: . When you debug a program compiled with ‘-g -O’. single instruction steps always show the inlined body. You can view their arguments and local variables. If in doubt. gdb never sees that variable—because the compiler optimizes it out of existence.1 do not emit two required attributes (‘DW_AT_call_file’ and ‘DW_AT_call_line’). for more information about debugging optimized code. the compiler must record information about inlining in the debug information — gcc using the dwarf 2 format does this. even though no additional instructions are executed.Chapter 11: Debugging Optimized Code 131 11 Debugging Optimized Code Almost all compilers support optimization. there are no instructions devoted to the call. gdb does not display inlined function calls with earlier versions of gcc. See Section 10. 11. Some things do not work as well with ‘-g -O’ as with just ‘-g’.

saved rip 0x4004c5 tail call frame. double)> (gdb) info frame Stack level 1. gdb may incorrectly move the breakpoint to the next line of the enclosing function. and it will then create fictitious call frame for that.cc:59). During execution of function C. you can step to the next line and print a variable where your program stored the return value. double)+11>: jmp 0x400640 <c(int. there will be no indication in the function call stack frames that it was tail-called from B. after finish. • gdb cannot locate the return value of inlined calls after using the finish command. until then.4 [Frame Info]. 11. after the call. If function A regularly calls function B which tail-calls function C. set a breakpoint on an earlier line or inside the inlined function instead. set debug entry-values When set to on. page 85) will indicate the tail call frame kind by text tail call frame such as in this sample gdb output: (gdb) x/i $pc . However. or else sets the breakpoint only on non-inlined copies of the function. • Setting breakpoints at the call site of an inlined function may not work. In unoptimized compilation the call of C is immediately followed by return instruction at the end of B code. Previous frame’s sp is 0x7fffffffda30 The detection of all the possible code path executions can find them ambiguous. There is no execution history stored (possible Chapter 6 [Reverse Execution]. Arglist at unknown address. In such case gdb still tries to show at least all the unambiguous top tail callers and all the unambiguous bottom tail calees. enables printing of analysis messages for both frame argument values at function entry and tail calls. you need to specify ‘-O -g’ during compilation. to get this information. then gdb will see A as the caller of C. with the return address set up as if B called C normally. if any. This functionality is currently supported only by DWARF 2 debugging format and the compiler has to produce ‘DW_TAG_GNU_call_site’ tags. in some cases gdb can determine that C was tail-called from B. This limitation will be removed in a future version of gdb. Locals at unknown address.2 0x40066b <b(int. This limitation will be removed in a future version of gdb. caller of frame at 0x7fffffffda30 source language c++. Optimizing compiler may replace the call and return in function B into one jump to function C instead. Such use of a jump instruction is called tail call. This is a limitation of compiler-generated debugging information. With gcc.2 Tail Call Frames Function B can call function C in its very last statement. because the call site does not contain any code. info frame command (see Section 8. It will show all the possible valid tail . set a breakpoint by line number on the first line of the inlined function instead. page 75 is never used for this purpose) and the last known caller could have reached the known callee by multiple different jump sequences. until then. frame at 0x7fffffffda30: rip = 0x40066d in b (amd64-entry-value.132 Debugging with gdb • You cannot set breakpoints on inlined functions. gdb either reports that there is no symbol with that name.

noclone)) a (void) { x++.c:8 () at t.that one is prefixed by compare:. return 0. } static void __attribute__((noinline. For the frame of function b in both cases there are different possible $pc values (0x4004cc or 0x4004ce). static void __attribute__((noinline. therefore this frame is also ambigous. } tailcall: initial: 0x4004d2(a) tailcall: compare: 0x4004d2(a) tailcall: reduced: 0x4004d2(a) (gdb) bt #0 f () at t. static void __attribute__((noinline. int main (void) { a (). DW_OP_GNU_entry_value resolving cannot find DW_TAG_GNU_call_site 0x40039a in main a () at t.c:5 Another possibility is an ambiguous virtual tail call frames resolution: int i. } noclone)) a (void) { b ().Chapter 11: Debugging Optimized Code 133 calls code paths it has considered. static void __attribute__((noinline. initial: state shows some random possible calling sequence gdb has found. The analysis messages for tail calls can for example show why the virtual tail call frame for function c has not been recognized (due to the indirect reference by variable x): static void __attribute__((noinline. The only non-ambiguous frame is the one for function a.c:9 Frames #0 and #2 are real. { if (i) c (). } f (). } f (). noclone)) a (void) { x++. } Breakpoint 1. It then finds another possible calling sequcen .c:3 #1 0x000000000040039a in main () at t. } d ().c:3 3 static void __attribute__((noinline. The nonambiguous intersection of these two is printed as the reduced: calling sequence. static void __attribute__((noinline. #1 is a virtual tail call frame. gdb cannot find which one from the inferior state. return 0. static void __attribute__((noinline. } int main (void) { x (). therefore this one is displayed to the user while the ambiguous frames are omitted. noclone)) c (void) { a (). static void __attribute__((noinline. void (*x) (void) = c.c:2 #1 0x00000000004004d2 in a () #2 0x0000000000400395 in main noclone)) noclone)) noclone)) noclone)) noclone)) f e d c b (void) (void) (void) (void) (void) { { { { i++. . } static void __attribute__((noinline. That one could have many futher compare: and reduced: statements as long as there remain any non-ambiguous sequence entries. show debug entry-values Show the current state of analysis messages printing for both frame argument values at function entry and tail calls. } 0x4004ce(b) 0x4004b2(c) 0x4004a2(d) 0x4004cc(b) 0x400492(e) | at t. It will also print the intersection of them with the final unambiguous (possibly partial or even empty) code path result. else e (). The code can have possible execution paths main->a->b->c->d->f or main->a->b->e->f. noclone)) c (void). } (gdb) bt #0 a () at t.

i) { a (i).1). static void __attribute__((noinline. } i) (gdb) bt #0 c (i=i@entry=0) at t. return 0.gdb prints <optimized out> instead. { if (i) b (i . static void __attribute__((noinline.c:7 gdb cannot find out from the inferior state if and how many times did function a call itself (via function b) as these calls would be tail calls.c:2 #1 0x0000000000400428 in a (DW_OP_GNU_entry_value resolving has found function "a" at 0x400420 can call itself via tail calls i=<optimized out>) at t.134 Debugging with gdb There can be also reasons why printing of frame argument values at function entry may fail: int v. static void __attribute__((noinline. } int main (void) { a (5). therefore gdb cannot be sure the value it knows would be right . Such tail calls would modify thue i variable. } noclone)) noclone)) noclone)) noclone)) c a b a (int (int (int (int i) { v++. static void __attribute__((noinline.c:6 #2 0x000000000040036e in main () at t. else c (0). } i). .

gdb uses the macros in scope at that frame’s source code line. show the result of macro expansion. and describe the source location or compiler command-line where that definition was established. at different points in the program. see Section 9. info macro [-a|-all] [--] macro Show the current definition or all definitions of the named macro. macro expand expression macro exp expression Show the results of expanding all preprocessor macro invocations in expression. The optional double dash is to signify the end of argument processing and the beginning of macro for non C-like macros where the macro may begin with a hyphen. Most compilers do not include macros in their debugging information. invocations of which are replaced by the tokens given in replacement-list. page 87. it can be any string of tokens. expression need not be a valid expression. gdb uses the macros in scope at the current listing location. expression need not be a valid expression. such as C and C++.Chapter 12: C Preprocessor Macros 135 12 C Preprocessor Macros Some languages. info macros linespec Show all macro definitions that are in effect at the location specified by linespec. Whenever gdb evaluates an expression. and then provide a different definition after that. Since gdb simply expands macros. or have no definition at all. Macro invocations appearing in that expansion are left unchanged. Thus. page 25. but does not parse the result. it always expands any macro invocations present in the expression. This command allows you to see the effect of a particular macro more clearly. remove that definition later. macro define macro replacement-list macro define macro(arglist) replacement-list Introduce a definition for a preprocessor macro named macro. Otherwise.) Show the results of expanding those preprocessor macro invocations that appear explicitly in expression. Since gdb simply expands macros. a macro may have different definitions. gdb can evaluate expressions containing macro invocations. See Section 4.1 [Compilation]. A program may define a macro at one point. gdb also provides the following commands for working with macros explicitly. macro expand-once expression macro exp1 expression (This command is not yet implemented. it can be any string of tokens. and describe the source location or compiler command-line where those definitions were established. provide a way to define and invoke “preprocessor macros” which expand into strings of tokens.1 [List]. If there is a current stack frame. even when you compile with the ‘-g’ flag. The first form of . You may need to compile your program specially to provide gdb with information about preprocessor macros. and show a macro’s definition. including where it was defined. without being confused by further expansions. but does not parse the result.

world!\n"). we compile the program using the gnu C compiler. as well as any previous user-supplied definition. Recent versions of gcc support ‘-gdwarf-3’ and ‘-gdwarf-4’. Here is a transcript showing the above commands in action. which takes no arguments.c #include <stdio.h" #define M 42 #define ADD(x) (M + x) main () { #define N 28 printf ("Hello. the second form defines a “function-like” macro. (gdb) 1 This is the minimum. which takes the arguments given in arglist. Inc. } $ cat sample. macro undef macro Remove any user-supplied definition for the macro named macro. $ gcc -gdwarf-2 -g3 sample. The definition overrides all definitions for macro present in the program being debugged. This command only affects definitions provided with the macro define command..c -o sample $ Now.\n"). we show our source files: $ cat sample.. world!\n"). . .136 Debugging with gdb this command defines an “object-like” macro.h> #include "sample. We pass the ‘-gdwarf-2’1 and ‘-g3’ flags to ensure the compiler includes information about preprocessor macros in the debugging information. #undef N printf ("We’re so creative. until it is removed with the macro undef command. #define N 1729 printf ("Goodbye. gcc. GDB is free software. described below. macro list List all the macros defined using the macro define command. it cannot remove definitions present in the program being debugged. described above. A definition introduced by this command is in scope in every expression evaluated in gdb. First. we recommend always choosing the most recent version of DWARF.h #define Q < $ Now. we start gdb on our sample program: $ gdb -nw sample GNU gdb 2002-05-06-cvs Copyright 2002 Free Software Foundation.

which was introduced by ADD. world! 12 printf ("We’re so creative. note that macro expand-once expands only the macro invocation explicit in the original text — the invocation of ADD — but does not expand the invocation of the macro M.Chapter 12: C Preprocessor Macros 137 We can expand macros and examine their definitions. (gdb) At line 10. (gdb) info macro ADD Defined at /home/jimb/gdb/macros/play/sample. gdb finds the definition (or lack thereof) in force at each point: (gdb) next Hello. line 10.h:1 included at /home/jimb/gdb/macros/play/sample. gdb uses the current listing position to decide which macro definitions are in scope: (gdb) list main 3 4 #define M 42 5 #define ADD(x) (M + x) 6 7 main () 8 { 9 #define N 28 10 printf ("Hello. gdb uses the macro definitions in force at the source line of the current stack frame: (gdb) break main Breakpoint 1 at 0x8048370: file sample.\n").c:9 #define N 28 (gdb) macro expand N Q M expands to: 28 < 42 (gdb) print N Q M $1 = 1 (gdb) As we step over directives that remove N’s definition.c:10 10 printf ("Hello. world!\n").c:2 #define Q < (gdb) macro expand ADD(1) expands to: (42 + 1) (gdb) macro expand-once ADD(1) expands to: once (M + 1) (gdb) In the example above. Once the program is running. 11 #undef N 12 printf ("We’re so creative.c. the definition of the macro N at line 9 is in force: (gdb) info macro N Defined at /home/jimb/gdb/macros/play/sample. (gdb) run Starting program: /home/jimb/gdb/macros/play/sample Breakpoint 1. world!\n").c:5 #define ADD(x) (M + x) (gdb) info macro Q Defined at /home/jimb/gdb/macros/play/sample. (gdb) info macro N . main () at sample. and then give it a new definition.\n"). even when the program is not running.

14 printf ("Goodbye.138 Debugging with gdb The symbol ‘N’ has no definition as a C/C++ preprocessor macro at /home/jimb/gdb/macros/play/sample. (gdb) info macro N Defined at /home/jimb/gdb/macros/play/sample. macros can be defined on the compilation command line using the ‘-Dname=value’ syntax.c:12 (gdb) next We’re so creative. (gdb) info macro __STDC__ Defined at /home/jimb/gdb/macros/play/sample.c:13 #define N 1729 (gdb) macro expand N Q M expands to: 1729 < 42 (gdb) print N Q M $2 = 0 (gdb) In addition to source files. gdb displays the location of their definition as line zero of the source file submitted to the compiler.c:0 -D__STDC__=1 (gdb) . world!\n"). For macros defined in such a way.

With static tracing. See Chapter 19 [Targets]. a set of instrumentation . A tracepoint is actually a special type of breakpoint (see Section 5. using the tfind command. none of the stubs distributed with gdb support tracepoints as of this writing. in a manner reminiscent of corefiles. while visiting a particular tracepoint. For each tracepoint. hopefully not disturbing the program’s behavior. some arbitrary set of data that you want the target to collect in the trace buffer when it hits that tracepoint.6 [Tracepoint Packets]. However. Later. an arbitrary number of tracepoints can be set. so you can manipulate it using standard breakpoint commands. For instance. meaning that they can be used to insert tracepoints at (almost) any location in the target. The format of the remote packets used to implement tracepoints are described in Section E. to identify which tracepoint to work on. you can examine the values those expressions had when the program hit the tracepoints. as with breakpoints. page 44). Ignore counts on tracepoints have no effect. It is useful to be able to observe the program’s behavior without interrupting it. Some targets may also support controlling static tracepoints from gdb. local variables. page 494. If the program’s correctness depends on its real-time behavior. and many of the commands associated with tracepoints take the tracepoint number as their argument. and use tfind to search through the file. and tracepoints cannot run gdb commands when they are hit. which are inserted in a different way (such as with a jump instead of a trap). it can do so quickly and unobtrusively. It is also possible to get trace data from a file. See Section 13. however. or global data. that is faster but possibly restricted in where they may be installed. In addition. Regular and fast tracepoints are dynamic tracing facilities. and arbitrary expressions to evaluate when those tracepoints are reached. The tracepoint facility is currently available only for remote targets. you may inspect those objects as if they were in memory at that moment. or perhaps fail. you can use gdb commands to examine the values these data had at the time the tracepoint was hit. Later. for example—whose values gdb should record.1 [Set Breaks]. 13. even when the code itself is correct. The expressions may also denote objects in memory— structures or arrays. because gdb records these values without interacting with you. it is not feasible for the debugger to interrupt the program’s execution long enough for the developer to learn anything helpful about its behavior. page 215. delays introduced by a debugger might cause the program to change its behavior drastically. your remote target must know how to collect trace data. Some targets may support fast tracepoints. This chapter describes the tracepoint commands and features. you can specify.1 Commands to Set Tracepoints Before running such a trace experiment. you specify the filename.Chapter 13: Tracepoints 139 13 Tracepoints In some applications. Using gdb’s trace and collect commands.1. Tracepoints do not support every breakpoint feature. page 154. you can specify locations in the program.4 [Trace Files]. called tracepoints. tracepoint numbers are successive integers starting from one. for more details. in advance. Tracepoints may not be thread-specific either. The collected data can include registers. This functionality is implemented in the remote stub.

and attach them with gdb defined high level tracepoints that expose the whole range of convenience of gdb’s tracepoints support. See Section 20. or an address in the target program. Setting a tracepoint or changing its actions takes effect immediately if the remote stub supports the ‘InstallInTrace’ feature (see [install tracepoint in tracing]. and then allow the program to continue. . The act of installing a gdb static tracepoint on an instrumentation point. gdb supports pending tracepoints—tracepoints whose address is not yet resolved. and gdb disconnects from the remote stub (see [disconnected tracing].140 Debugging with gdb points. page 88. Here are some examples of using the trace command: (gdb) trace foo.2 [Specify Location]. These are usually placed at locations which facilitate investigating what the target is actually doing. 13. page 221. are embedded in the target program. and once a trace experiment is running. is referred to as probing a static tracepoint marker. support for collecting registers values and values of global or local (to the instrumentation point) variables. See Section 9. page 488). Namely. a function name. The trace command defines a tracepoint.) Pending tracepoints are not downloaded to the target and not installed until they are resolved. Its argument location can be a source line. pending tracepoints can not be resolved (and downloaded to the remote stub) while gdb is disconnected. tracepoint conditions and trace state variables. also known as markers. collect some data. This section describes commands to set tracepoints and associated conditions and actions.1 Create and Delete Tracepoints trace location The trace command is very similar to the break command. gdb’s support for static tracing includes being able to list instrumentation points. page 148). (This is similar to pending breakpoints.1. The resolution of pending tracepoints requires gdb support—when debugging with the remote target. further changes will not have any effect until the next trace experiment starts. which is a point in the target program where the debugger will briefly stop. If remote stub doesn’t support the ‘InstallInTrace’ feature. and can be activated or deactivated by name or address.3 [Tracepoints support in gdbserver]. all these changes don’t take effect until the next tstart command. or marker. gdbserver supports tracepoints on some target systems. In addition.c:121 (gdb) trace +2 (gdb) trace my function // a source file and line number // 2 lines forward // first source line of function (gdb) trace *my function // EXACT start address of function (gdb) trace *0x2117c4 // an address You can abbreviate trace as tr.

bar33. or marker. On 32-bit x86-architecture systems. if cond evaluates as true. For targets that support it.8 [Listing Static Tracepoint Markers]. gdb handles arguments to ftrace exactly as for trace. with the addition that the user can also specify -m marker as location. and collect data only if the value is nonzero—that is. See Section 13. page 147.1. which translates to: (gdb) info static-tracepoint-markers Cnt Enb ID Address What 1 n ust/bar33 0x0000000000400ddc in main at stexample.4 [Tracepoint Conditions]. It may not be possible to create a fast tracepoint at the desired location. ftrace location [ if cond ] The ftrace command sets a fast tracepoint. but can be placed at 4-byte instructions if the low 64K of memory of the target program is available to install trampolines. Some Unix-type systems. found at location. fast tracepoints normally need to be placed at an instruction that is 5 bytes or longer. setting a static tracepoint probes a static instrumentation point. This probes the marker identified by the marker string identifier. You can find all the marker identifiers in the ‘ID’ field of the info static-tracepoint-markers command output. } the marker id is composed of joining the first two arguments to the trace_mark call with a slash. which leaves plenty of room for trampolines.c:22 Data: "str %s" . in the following small program using the UST tracing engine: main () { trace_mark(ust. For example.Chapter 13: Tracepoints 141 trace location if cond Set a tracepoint with condition cond. in which case the command will exit with an explanatory message. strace location [ if cond ] The strace command sets a static tracepoint. for more information on tracepoint conditions.1.mmap_min_addr=32768 which sets the low address to 32K. This identifier depends on the static tracepoint backend library your program is using. gdb handles arguments to strace exactly as for trace. page 143. or some sort of hardware support. but for instance with the Linux kernel it is possible to let gdb use this area by doing a sysctl command to set the mmap_min_addr kernel parameter. "str %s". For targets that support them. such as gnu/Linux. such as a jump instruction instead of a trap. exclude low addresses from the program’s address space. in which case the command will exit with an explanatory message. fast tracepoints will use a more efficient but possibly less general technique to trigger data collection. evaluate the expression cond each time the tracepoint is reached. See Section 13. as in sudo sysctl -w vm. The minimum address should be set to a page boundary. "FOOBAZ"). It may not be possible to set a static tracepoint at the desired location.

The convenience variable $tpnum records the tracepoint number of the most recently set tracepoint. the default is to delete all tracepoints. they are equivalent to plain disable and enable. With no argument. If the command is issued during a trace experiment and the debug target has support for disabling tracepoints during a trace experiment.142 Debugging with gdb [etc. Note that info statictracepoint-markers command output lists that format string in the ‘Data:’ field. then the enabled tracepoints will become effective immediately. In the UST example above. Otherwise. Otherwise. This collects arbitrary user data passed in the probe point call to the tracing library. disable tracepoint [num] Disable tracepoint num. The user data is then the result of running that formating string against the following arguments. See Section 13. Examples: (gdb) delete trace 1 2 3 // remove three tracepoints (gdb) delete trace // remove all tracepoints You can abbreviate this command as del tr. page 144. 13.6 [Tracepoint Action Lists]. You can inspect this data when analyzing the trace buffer. then the change will be effective immediately. You can re-enable a disabled tracepoint using the enable tracepoint command. but it is not forgotten. or all tracepoints. .] so you may probe the marker above with: (gdb) strace -m ust/bar33 Static tracepoints accept an extra collect action — collect $_sdata. it will be applied to the next trace experiment. by printing the $ sdata variable like any other variable available to gdb. you’ll see that the third argument to trace_mark is a printf-like format string.1.. enable tracepoint [num] Enable tracepoint num. or all tracepoints if no argument num is given. they will become effective the next time a trace experiment is run.2 Enable and Disable Tracepoints These commands are deprecated. If this command is issued during a trace experiment and the debug target supports enabling tracepoints during a trace experiment. delete tracepoint [num] Permanently delete one or more tracepoints. Note that the regular delete command can remove tracepoints also. A disabled tracepoint will have no effect during a trace experiment.1..

gdb encodes the expression into an agent expression (see Appendix F [Agent Expressions]. For instance. They can also be set or changed at any time with the condition command. the passcount command sets the passcount of the most recently defined tracepoint. the trace experiment will run until stopped explicitly by the user. 13. (gdb) trace normal_operation if errcode > 0 13. and data collection happens only if the condition is true. by using ‘if’ in the arguments to the trace command.1 [Expressions]. just as with breakpoints. // Stop tracing when foo has been // executed 3 times OR when bar has // been executed 2 times // OR when baz has been executed 1 time. If a tracepoint’s passcount is n. The syntax is the same as that for GDB’s convenience variables (a string prefixed . A tracepoint with a condition evaluates the expression each time your program reaches it. page 97).1.1. and so forth. suppose you have a function that is usually called frequently. Tracepoint conditions can be specified when a tracepoint is set. an unconditional tracepoint could end up collecting thousands of useless trace frames that you would have to search through.5 Trace State Variables A trace state variable is a special type of variable that is created and managed by target-side code. If no passcount is given. Unlike breakpoint conditions. Instead. locals become stack accesses. If the tracepoint number num is not specified.Chapter 13: Tracepoints 143 13.4 Tracepoint Conditions The simplest sort of tracepoint collects data every time your program reaches a specified place.1 [Setting Tracepoints]. independently of gdb. gdb does not actually evaluate the conditional expression itself. You can also specify a condition for a tracepoint. The passcount is a way to automatically stop a trace experiment. Global variables become raw memory locations. page 140. but should not be called after an error has occurred.3 Tracepoint Passcounts passcount [n [num]] Set the passcount of a tracepoint. page 521) suitable for execution on the target. then the trace experiment will be automatically stopped on the n’th time that tracepoint is hit. Examples: (gdb) passcount 5 2 // Stop on the 5th execution of // tracepoint 2 (gdb) passcount 12 (gdb) (gdb) (gdb) (gdb) (gdb) (gdb) trace foo pass 3 trace bar pass 2 trace baz pass 1 // Stop on the 12th execution of the // most recently defined tracepoint. You could use the following tracepoint command to collect data about calls of that function that happen while the error code is propagating through the program. A condition is just a Boolean expression in your programming language (see Section 10.1. See Section 13.1.

and optionally gives it an initial value of expression. If the tracepoint number num is not specified. but they are stored on the target. A subsequent tvariable command specifying the same name does not create a variable. type ‘actions num’ and follow it immediately with ‘end’. if the trace experiment is currently running. Trace state variables share the same namespace as other “$” variables. So far. Although trace state variables are managed by the target. teval. page 59). this command sets the actions for the one that was most recently defined (so that you can define a tracepoint and then say actions without bothering about its number). you can use them in print commands and expressions as if they were convenience variables. (gdb) collect data // collect some data (gdb) while-stepping 5 // single-step 5 times. overwriting any previous initial value. nor can you have a trace state variable and a convenience variable with the same name. except that only the defined actions are allowed.144 Debugging with gdb with “$”). the only defined actions are collect. Trace state variables are remembered by gdb. gdb will get the current value from the target while the trace experiment is running. delete tvariable [ $name . ] Delete the given trace state variables.7 [Breakpoint Command Lists]. info tvariables List all the trace state variables along with their initial values. expression is evaluated when this command is entered. and downloaded to the target along with tracepoint information when the trace experiment starts. the result will be converted to an integer if possible. using a tvariable command.6 Tracepoint Action Lists actions [num] This command will prompt for a list of actions to be taken when the tracepoint is hit. and terminate the actions list with a line containing just end. or all of them if no arguments are specified. Their current values may also be displayed. beyond memory limitations of the target. which means that you cannot have trace state variables with names like $23 or $pc. To remove all actions from a tracepoint. There are no intrinsic limits on the number of trace state variables.1. collect data (gdb) end // signals the end of actions. and while-stepping.1. one action at a time. The default initial value is 0.. but instead assigns the supplied initial value to the existing variable of that name.. They must be created explicitly. 13. actions is actually equivalent to commands (see Section 5. otherwise gdb will report an error. any other gdb command is rejected. tvariable $name [ = expression ] The tvariable command creates a new trace state variable named $name. They are always 64-bit signed integers. You specify the actions themselves on the following lines. .

or local variables. the action list is terminated by an end command.6 [Tracepoint Action Lists]. The while-stepping command is terminated by its own separate end command. in particular collecting the contents of the memory being pointed at. if s is followed by a decimal . page 144. static. . the following special arguments are supported: $regs $args $locals $_ret $_sdata Collect all registers. in order to single-step and collect additional data following the tracepoint. s requests that pointers to chars be handled as strings.. Other backends have similar mechanisms. In addition to global. Collect static tracepoint marker specific data.Chapter 13: Tracepoints 145 In the following example. the effect is the same. (gdb) trace foo (gdb) actions Enter actions for tracepoint 1. expr2. You can give several consecutive collect commands. a whilestepping command is used..baz > collect $regs > while-stepping 12 > collect $pc. Collect all function arguments. The optional mods changes the usual handling of the arguments. The tracing library is able to collect user specified data formatted to a character string using the format provided by the programmer that instrumented the program. up to the first zero. "hello %s". the action list begins with collect commands indicating the things to be collected when the tracepoint is hit. one per line: > collect bar. master_name) In this case. Collect all local variables. This command accepts a comma-separated list of any valid expressions. Here’s an example of a UST marker call: const char master_name[] = "$your_name". marker1. See Section 13. collecting $_sdata collects the string ‘hello $yourname’. This is helpful if you want to see more of a backtrace. Then. an instrumentation point resembles a printf function call. trace_mark(channel1. arr[i] > end end collect[/mods] expr1. or one collect command with several arguments separated by commas. On the UST static tracepoints library backend.1. followed by the list of things to be collected after each step in a sequence of single steps. Collect values of the given expressions when the tracepoint is hit. Collect the return address. The upper bound is by default the value of the print elements variable. Lastly. When analyzing the trace buffer. you can inspect ‘$_sdata’ like any other variable available to gdb. each one with a single argument. Only available for static tracepoints.

so this is mainly useful for assigning values to trace state variables (see Section 13. while-stepping n Perform n single-step instruction traces after the tracepoint. The expressions are parsed individually for each tracepoint. 13.] Display information about the tracepoint num. show default-collect Show the list of expressions that are collected by default at each tracepoint hit. . The while-stepping command is followed by the list of what to collect while stepping (followed by its own end command): > while-stepping 12 > collect $regs. expr2. teval expr1. you need to explicitly collect that register if you need it.cxx:7 while-stepping 20 collect globfoo. The results are discarded. set default-collect expr1. collecting new data after each step.1. This variable is a list of expressions to collect at each tracepoint hit. displays information about all the tracepoints defined so far. page 189) is particularly useful for figuring out what data to collect. So for instance ‘collect/s25 mystr’ collects as many as 25 characters at ‘mystr’. The format is similar to that used for info breakpoints. info tracepoints is the same command. The command info scope (see Chapter 16 [Symbols]. This command accepts a comma-separated list of expressions.1. $regs end collect globfoo2 end . A tracepoint’s listing may include additional information specific to tracing: • its passcount as given by the passcount n command (gdb) info trace Num Type Disp Enb Address What 1 tracepoint keep y 0x0804ab57 in foo() at main.. Evaluate the given expressions when the tracepoint is hit. myglobal > end > Note that $pc is not automatically collected by while-stepping.7 Listing Tracepoints info tracepoints [num. as appropriate to the tracepoint’s location.5 [Trace State Variables]. and a local for another. simply restricting itself to tracepoints... as would be the case if the collect action were used.. If you don’t specify a tracepoint number. so for instance a variable named xyz may be interpreted as a global for one tracepoint. that is the upper bound instead. It is effectively an additional collect action prepended to every tracepoint action list. expr2.146 Debugging with gdb number. You may abbreviate whilestepping as ws or stepping. .. page 143) without adding those values to the trace buffer. in fact..

as reported by the target. and begins collecting data. In the UST backend.c:24 Data: str %s (gdb) 13. In addition. or if the trace buffer becomes full. as a file and line number.9 Starting and Stopping Trace Experiments tstart This command takes no arguments. the following columns are printed: Count ID An incrementing counter. the following information may be printed for each marker: Data User data passed to the tracing library by the marker call. output to help readability. (gdb) info static-tracepoint-markers Cnt ID Enb Address What 1 ust/bar2 y 0x0000000000400e1a in main at stexample. Static tracepoints probing the marker The list of static tracepoints attached to the marker.c:25 Data: number1 %d number2 %d Probed by static tracepoints: #2 2 ust/bar33 n 0x0000000000400c87 in main at stexample. ‘n’ identifies marks that are not enabled. tstop . this column will be left blank.3 [Tracepoint Passcounts]. It starts the trace experiment. this is the format string passed as argument to the marker call.1. page 143). Enabled or Disabled Probed markers are tagged with ‘y’. Note: a trace experiment and data collection may stop automatically if any tracepoint’s passcount is reached (see Section 13.1. This is not a stable identifier. This command takes no arguments. This has the side effect of discarding all the data collected in the trace buffer during the previous trace experiment. If the debug information included in the program does not allow gdb to locate the source of the marker. Where the marker is in the source for your program. It ends the trace experiment. The marker ID.1. For each marker.8 Listing Static Tracepoint Markers info static-tracepoint-markers Display information about all static tracepoint markers defined in the program. 13. Address What Where the marker is in your program.Chapter 13: Tracepoints 147 pass count 1200 (gdb) This command can be abbreviated info tp. and stops collecting data. as a memory address.

. until there is enough room to continue collecting. simply set ‘circular-trace-buffer’ to on. you may simply delete them if they are of no use. and attempt to match them up.$args > while-stepping 11 > collect $regs > end > end (gdb) tstart [time passes . the trace experiment may or may not still be running. But for unexpected terminations (gdb crash. it will change buffer handling on the fly. Here is an example of the commands we described so far: (gdb) trace gdb c test (gdb) actions Enter actions for tracepoint #1. set disconnected-tracing on set disconnected-tracing off Choose whether a tracing run should continue to run if gdb has disconnected from the target. and your trace gets terminated prematurely because the buffer is full. allowing for the possibility that the numbers may have changed due to creation and deletion in the meantime. oldest first. or stopped for one of the other reasons. the target will upload information about the tracepoints in effect. one per line.148 Debugging with gdb tstatus This command displays the status of the current trace data collection. network outage). otherwise it will not take effect until the next run. including during tracing. gdb will then compare that information to the set of tracepoints currently defined. Upon reconnection. Note that detach or quit will ask you directly what to do about a running trace no matter what this variable’s setting. When you reconnect to the target. show disconnected-tracing Show the current choice for disconnected tracing. > collect $regs. If one of the target’s tracepoints does not match any in gdb. This is especially useful if your tracepoints are being hit too often. so that you have a number with which to specify that tracepoint. then you can run a trace experiment indefinitely without filling the trace buffer. and it may result in useless tracepoints being created. You can set this at any time. the debugger will create a new tracepoint.] (gdb) tstop You can choose to continue running the trace experiment even if gdb disconnects from the target. when space runs out.. voluntarily or involuntarily. For commands such as detach. it might have filled the trace buffer in the meantime.. such as loss of the network. so the variable disconnected-tracing lets you decide whether the trace should continue running without gdb. To ask for a circular trace buffer. If it is running. the debugger will ask what you want to do with the trace. so the variable is mainly useful for handling unexpected situations. it would be unfortunate to lose hard-won trace data. If your target agent supports a circular trace buffer. if the agent can do it.$locals. it will continue after reconnection. This matching-up process is necessarily heuristic. the agent deletes alreadycollected trace frames.

The following items describe some common problems. but it will have always room for the latest tracepoint hits. The stepping action may enter a new scope (for instance by stepping into a function). while a circular buffer will discard old trace data. Thus the full flexibility of GDB’s expression evaluator is not available. you will be limited by only having what was collected. You need to explicitly dereference the pointer and provide size information if you want to collect not only the pointer.Chapter 13: Tracepoints 149 set circular-trace-buffer on set circular-trace-buffer off Choose whether a tracing run should use a linear or circular buffer for trace data. cast objects to aggregate types. access convenience variables or modify values (except by assignment to trace state variables). Note that this may not match the agent’s current buffer handling. As described above.1. • Collection of an incompletely-initialized or partially-destroyed object may result in something that gdb cannot display. for instance if you are looking at frames from a trace file. and you may run into additional difficulties not mentioned here. • Collection of local variables. in general. and the amount of stack you wish to capture). *ptr@50 can be used to collect the 50 element array pointed to by ptr. The tracepoint data recorded uses the location information for the variables that is correct for the tracepoint location. and then at data examination time. • It is not possible to collect a complete stack backtrace at a tracepoint. Instead. but it is not exhaustive. . collecting the pointer during tracing does not automatically collect the string. you may collect the registers and a few hundred bytes from the stack pointer with something like *(unsigned char *)$esp@300 (adjust to use the name of the actual stack pointer register on your target architecture. Then the backtrace command will show a partial backtrace when using a trace frame. but the memory pointed to. A linear buffer will not lose any trace data. However. but may fill up prematurely. nor is it guaranteed to match the setting that might have been in effect during a past run. or displays in a misleading way. or the location of the variable may change (for instance it is loaded into a register). For example. to determine where the steps of a while-stepping sequence will advance the program—particularly if a conditional branch is stepped. it is not possible. 13.10 Tracepoint Restrictions There are a number of restrictions on the use of tracepoints. during while-stepping may behave erratically. When the tracepoint is created. You cannot call functions. • When gdb displays a pointer to character it automatically dereferences the pointer to also display characters of the string being pointed to. either individually or in bulk with $locals or $args. show circular-trace-buffer Show the current choice for the trace buffer. Thus the full capabilities of the debugger are not available during data gathering. and therefore cannot be collected either. Some language features may implicitly call functions (for instance Objective-C fields with accessors). tracepoint data gathering occurs on the target without interaction from gdb. • Tracepoint expressions are intended to gather objects (lvalues).

Here are the various forms of using the tfind command. If no argument n is given. Find the previous trace snapshot before the current one. This means that all gdb commands (print. When the remote stub is focused on a trace snapshot. and you can examine them later. etc. • If you do not collect registers at a tracepoint. Search proceeds forward from the last examined trace snapshot. 13. it will respond to all gdb requests for memory and registers by reading from the buffer which belongs to that snapshot. In those cases gdb will warn you that it can’t infer $pc. counting from zero. gdb can infer that the value of $pc must be the same as the address of the tracepoint and use that when you are looking at a trace frame for that tracepoint. resume live debugging.1 tfind n The basic command for selecting a trace snapshot from the buffer is tfind n. or if it has a while-stepping loop. tfind none Stop debugging trace snapshots.2. . info registers. The way you examine them is to focus on a specific trace snapshot. the target agent may report an error trying to read from an invalid address. tfind tracepoint num Find the next snapshot associated with tracepoint num. 13. This is a synonym for tfind 0 (since 0 is the number of the first snapshot).150 Debugging with gdb The number of stack frames that can be examined depends on the sizes of the frames in the collected stack. However. tfind start Find the first snapshot in the buffer. you use gdb commands for examining the trace data.) will behave as if we were currently debugging the program state as it was when the tracepoint occurred. this cannot work if the tracepoint has multiple locations (for instance if it was set in a function that was inlined). The basic idea is that each tracepoint collects a trace snapshot every time it is hit and another snapshot every time it single-steps. it means find the next snapshot collected for the same tracepoint as the current snapshot. Note that if you ask for a block so large that it goes past the bottom of the stack. rather than from real memory or registers of the program being debugged. If no argument num is given. which finds trace snapshot number n. the next snapshot is selected.2 Using the Collected Data After the tracepoint experiment ends. backtrace. and default it to zero. This permits retracing earlier steps. Any requests for data that are not in the buffer will fail. tfind end Same as ‘tfind none’. tfind tfind No argument means find the next trace snapshot. All these snapshots are consecutively numbered from zero and go into a buffer.

0030BF38. 9. 7. tfind range addr1. The tfind line command with no argument selects the snapshot for the next source line executed. 4. and then simply hitting RET repeatedly you can examine all the trace snapshots in order. if we want to examine the PC. FP FP FP FP FP FP FP FP FP FP = = = = = = = = = = 0030BF44 0030BF44 0030BF44 0030BF44 0030BF44 0030BF44 0030BF44 0030BF44 0030BF44 0030BF44 . FP = %08X\n". 0020DC78. 3. by giving one tfind command. 5. The tfind pc command with no argument selects the next snapshot with the same program counter (PC) as the current frame.Chapter 13: Tracepoints 151 tfind pc addr Find the next snapshot associated with the value addr of the program counter. we can say this: (gdb) tfind start (gdb) while ($trace frame != -1) > printf "Frame %d. 0030BF24. 0030BF2C. $fp > tfind > end Frame Frame Frame Frame Frame Frame Frame Frame Frame Frame 0. FP. 0020DC84. it means find the next snapshot with the same value of PC as the current snapshot.with no argument selects the previous trace snapshot. So. \ $trace_frame. 0030BF30. If no argument n is given. 6. 0030BF18. 0030BF1C. If no argument addr is given. 0020DC74. addr2 Find the next snapshot whose PC is between addr1 and addr2 (inclusive). The default arguments for the tfind commands are specifically designed to make it easy to scan through the trace buffer. 0030BF28. 0020DC70. tfind line [file:]n Find the next snapshot associated with the source line n. and SP registers from each trace frame in the buffer. these commands make it easy to construct gdb scripts that scan through the trace buffer and print out whatever collected data you are interested in. 2. PC = %08X. and tfind . Search proceeds forward from the last examined trace snapshot. 0020DC6C. it means find the next line other than the one currently being examined. tfind outside addr1. thus saying tfind line repeatedly can appear to have the same effect as stepping from line to line in a live debugging session. 0020DC88. PC PC PC PC PC PC PC PC PC PC = = = = = = = = = = 0020DC64. If the optional argument file is given. $pc. 0030BF34. Thus. 0030BF20. $sp. addr2 Find the next snapshot whose PC is outside the given range of addresses (exclusive). tfind with no argument selects the next trace snapshot. 0020DC7C. by saying tfind . SP = %08X. Or. 1. 0020DC80. In addition to letting you scan through the trace buffer manually. refer to line n in that source file. 8. SP SP SP SP SP SP SP SP SP SP = = = = = = = = = = 0030BF3C. For instance.and then hitting RET repeatedly you can examine the snapshots in reverse order. The tfind tracepoint command with no argument selects the next trace snapshot collected by the same tracepoint as the current one. Search proceeds forward from the last examined trace snapshot. 0020DC8E.

$trace_frame. if we want to examine the variable X at each source line in the buffer: (gdb) tfind start (gdb) while ($trace frame != -1) > printf "Frame %d. $locals. gdb_long_test > end (gdb) tstart (gdb) tfind line 444 #0 gdb_test (p1=0x11.2. p5=0x55. p4=0x44. X == %d\n". X = 1 Frame 7. X = 2 Frame 13.2 tdump This command takes no arguments. (gdb) trace 444 (gdb) actions Enter actions for tracepoint #2. X = 255 13. It prints all the data collected at the current trace snapshot. p2=0x22. SP = 0030BE3C. trace frame 1: d0 0xc4aa0085 -995491707 d1 0x18 24 d2 0x80 128 d3 0x33 51 d4 0x71aea3d 119204413 d5 0x22 34 d6 0xe0 224 d7 0x380035 3670069 a0 0x19e24a 1696330 a1 0x3000668 50333288 a2 0x100 256 a3 0x322000 3284992 a4 0x3000698 50333336 a5 0x1ad3cc 1758156 fp 0x30bf3c 0x30bf3c sp 0x30bf34 0x30bf34 ps 0x0 0 pc 0x20b2c8 0x20b2c8 fpcontrol 0x0 0 fpstatus 0x0 0 fpiaddr 0x0 0 p = 0x20e5b4 "gdb-test" p1 = (void *) 0x11 p2 = (void *) 0x22 p3 = (void *) 0x33 p4 = (void *) 0x44 .c:444 444 printp( "%s: arguments = 0x%X 0x%X 0x%X 0x%X 0x%X 0x%X\n".152 Debugging with gdb Frame 10. ) (gdb) tdump Data collected at tracepoint 2. X > tfind line > end Frame 0. PC = 00203F6C. $args. p6=0x66) at gdb_test. p3=0x33. one per line: > collect $regs. FP = 0030BF14 Or.

2. (int) $trace_line The line number for the current trace snapshot.3 Convenience Variables for Tracepoints (int) $trace_frame The current trace snapshot (a. which are managed by the target. or -1 if no snapshot is selected. frame) number. into a file ‘filename’ suitable for use in a later debugging session. (char []) $trace_func The name of the function containing $tracepoint. (gdb) tfind start (gdb) while $trace frame != -1 > output $trace_file > printf ". page 278). or the collections from the body of the while-stepping loop. $trace_line. (int) $tracepoint The tracepoint for the current trace snapshot.a. To read the saved tracepoint definitions. $tracepoint > tfind > end . for tracepoints with while-stepping loops. if $pc was not collected. use the source command (see Section 23. Note that these are not the same as trace state variables. 13.1. then tdump will always attempt to dump using the basic collection list. This allows it to correctly choose whether to display the basic list of collections. So tdump can fail. However. line %d (tracepoint #%d)\n". use output instead. The save-tracepoints command is a deprecated alias for save tracepoints 13.3 [Command Files]. and frames that were collected while stepping. and may fail if a while-stepping frame does not include all the same data that is collected at the tracepoint hit.3 save tracepoints filename This command saves all current tracepoint definitions together with their actions and passcounts. if after a run.k. Here’s a simple example of using these convenience variables for stepping through all the trace snapshots and printing some of their data. you change the tracepoint’s actions to mention variables that were not collected during the run. tdump uses the collected value of $pc to distinguish between trace frames that were collected at the tracepoint hit.Chapter 13: Tracepoints 153 p5 = (void *) 0x55 p6 = (void *) 0x66 gdb_long_test = 17 ’\021’ (gdb) tdump works by scanning the tracepoint’s current collection actions and printing the value of each expression listed. (char []) $trace_file The source file for the current trace snapshot. Also. Note: $trace_file is not suitable for use in printf.

so if necessary gdb will copy raw trace data up from the target and then save it. which may be more efficient if the trace buffer is very large. that target tfile can only read from files accessible to the host. . tsave [ -r ] filename Save the trace data to filename. but it is not possible to run any new trace experiments. If the target supports it. perhaps it crashed. (Note. however. To handle these cases. the target running a trace experiment may no longer be available.) target tfile filename Use the file named filename as a source of trace data. filename must be on a filesystem accessible to the host. and later use that file as a source of trace data. you can also supply the optional argument -r (“remote”) to direct the target to save the data directly into filename in its own filesystem. or the hardware was needed for a different activity. you can arrange to dump the trace data into a file. via the target tfile command.154 Debugging with gdb 13. By default. as well as the current trace frame you are examining. Commands that examine data work as they do with a live target. tstatus will report the state of the trace run at the moment the data was saved. this command assumes that filename refers to the host filesystem.4 Using Trace Files In some situations.

for example. call these modules overlays. except that the program variables and heap would share an address space with the main program and the overlay area. you must first copy that overlay’s machine code from the large memory into the space set aside for it in the instruction memory. To map an overlay.1 How Overlays Work Suppose you have a computer whose instruction address space is only 64 kilobytes long. 14. and need not call each other directly. and place their machine code in the larger memory. | | load address +-----------+ ‘--| overlay 3 | | | | | +-----------+ | | +-----------+ | | +-----------+ A code overlay The diagram (see [A code overlay].overlay 3 | | <---. Now. only one may be mapped at a time. Data Address Space +-----------+ | | +-----------+ | program | | variables | | and heap | +-----------+ | | +-----------+ Instruction Larger Address Space Address Space +-----------+ +-----------+ | | | | +-----------+ +-----------+<-. the diagram would be similar.----| overlay 1 | load address | program | | +-----------+ | | | | | | | | +-----------+<-. .-| overlay 2 | | | | | | | mapped --->+-----------+ | | +-----------+ address | | | | | | | overlay | <-’ | | | | area | <---’ +-----------+<-. gdb provides some support for debugging programs that use overlays.Chapter 14: Debugging Programs That Use Overlays 155 14 Debugging Programs That Use Overlays If your program is too large to fit completely in your target system’s memory. For a system with a single address space for data and instructions.overlay 1 | main | .overlay 2 +-----------+ | | | load address | | | . Since the overlays shown here all use the same mapped address. Suppose further that you want to adapt a program which is larger than 64 kilobytes to run on this system. page 155) shows a system with separate data and instruction address spaces. the program copies its code from the larger address space to the instruction address space. Place your main program in instruction memory. but which has much more memory which can be accessed by other means: special instructions. and then jump to its entry point there. but leave at least enough space there to hold the largest overlay as well. or memory management hardware. to call a function located in an overlay. One solution is to identify modules of your program which are relatively independent. Separate the overlays from the main program. segment registers. you can sometimes use overlays to work around this problem.

you can abbreviate this as ov or ovly. • The executable file you load onto your system must contain each overlay’s instructions. you will need to choose your overlays carefully to minimize their effect on your program’s performance. • You can use overlays to manage data. and could be improved in many ways: • If your system has suitable bank switch registers or memory management hardware. However. each overlay in your program must correspond to a separate section of the executable file. Also. you must copy its contents back out to its load address before you can copy a different data overlay into the same mapped area.156 Debugging with gdb An overlay loaded into instruction memory and ready for use is called a mapped overlay. your program must make sure that overlay is actually mapped. An overlay not present (or only partially present) in instruction memory is called unmapped. 14. The mapped address is also called the virtual memory address. if you change the contents of a data overlay. as well as instructions. In general. They introduce a new set of global constraints you must keep in mind as you design your program: • Before calling or returning to a function in an overlay. Otherwise. • If the process of mapping an overlay is expensive on your system. its load address is its address in the larger memory. and your program will probably crash. and have more than one overlay mapped at a time. each overlay’s instructions must be relocated and its symbols defined as if the overlay were at its mapped address. but in the wrong overlay. data overlays are even less transparent to your design than code overlays: whereas code overlays only require care when you call or return to functions. The overlay system described above is rather simple. The commands are: . the call or return will transfer control to the right address.2 Overlay Commands To use gdb’s overlay support. appearing at the overlay’s load address. overlays are not a completely transparent way to adapt a program to limited instruction memory. Unfortunately. • The procedure for loading executable files onto your system must be able to load their contents into the larger address space as well as the instruction and data spaces. • If your overlays are small enough. see Section “Overlay Description” in Using ld: the GNU linker. You can use GNU linker scripts to specify different load and relocation addresses for pieces of your program. This would probably be faster than copying the overlay to its mapped area in the usual way. not its mapped address. you could use those facilities to make an overlay’s load area contents simply appear at their mapped address in instruction space. or VMA. The section’s virtual memory address and load memory address must be the overlay’s mapped and load addresses. depending on whether the overlay is mapped or not. or LMA. the load address is also called the load memory address. you could set aside more than one overlay area. its mapped address is its address in the instruction memory. data overlays require care every time you access the data. gdb’s overlay commands all start with the word overlay. Identifying overlays with sections allows gdb to determine the appropriate address of a function or variable.

along with their mapped addresses. using the overlay map-overlay and overlay unmap-overlay commands described below. so this command should only be necessary if you have changed the overlay mapping yourself using gdb. see Section 14. and sizes. and which are not. In this mode. For details. gdb assumes that any other overlays whose mapped ranges overlap that of overlay are now unmapped.Chapter 14: Debugging Programs That Use Overlays 157 overlay off Disable gdb’s overlay support. For example. gdb consults a data structure the overlay manager maintains in the inferior to see which overlays are mapped.3 [Automatic Overlay Debugging]. overlay unmap-overlay overlay overlay unmap overlay Tell gdb that overlay is no longer mapped. overlay auto Enable automatic overlay debugging. overlay must be the name of the object file section containing the overlay. overlay load-target overlay load Re-read the overlay table from the inferior. gdb’s overlay support is disabled. and prints the names of unmapped functions with asterisks around them. gdb relies on you to tell it which overlays are mapped. In this mode. By default. Normally. When overlay support is disabled. if foo is a function in an unmapped overlay. gdb assumes that all functions and variables are always present at their mapped addresses. (gdb) print foo . gdb prints it this way: (gdb) overlay list No sections are mapped. it includes the name of the function the address falls in: (gdb) print main $3 = {int ()} 0x11a0 <main> When overlay debugging is enabled. gdb re-reads the table gdb automatically each time the inferior stops. overlay map-overlay overlay overlay map overlay Tell gdb that overlay is now mapped. When an overlay is mapped. overlay manual Enable manual overlay debugging. overlay must be the name of the object file section containing the overlay. when gdb prints a code address. overlay list-overlays overlay list Display a list of the overlays currently mapped. When an overlay is unmapped. page 158. This command is only useful when using automatic overlay debugging. gdb recognizes code in unmapped overlays. gdb assumes it can find the overlay’s functions and variables at their load addresses. Normally. load addresses. gdb assumes it can find the overlay’s functions and variables at their mapped addresses.

gdb prints the function’s name normally: (gdb) overlay list Section . • gdb can not set hardware or simulator-based breakpoints in unmapped overlays. /* The overlay’s load address. like break and disassemble. page 156). unsigned long size. } _novlys: This variable must be a four-byte signed integer. */ /* The size of the overlay.158 Debugging with gdb $5 = {int (int)} 0x100000 <*foo*> When foo’s overlay is mapped. holding the total number of elements in _ovly_table. To decide whether a particular overlay is mapped or not. unsigned long lma. given some simple co-operation from the overlay manager in the inferior. 14. If you enable automatic overlay debugging with the overlay auto command (see Section 14.text.3 Automatic Overlay Debugging gdb can automatically track which overlays are mapped and which are not. even on unmapped code. gdb will re-set its breakpoints properly. as long as gdb can write to the overlay at its load address. to work normally. gdb can find the correct address for functions and variables in an overlay. gdb looks for an entry in _ovly_table whose vma and lma members equal the VMA and LMA of the overlay’s section . However.0x100034. gdb’s breakpoint support has some limitations: • You can set breakpoints in functions in unmapped overlays. unsigned long vma. loaded at 0x100000 . whether or not the overlay is mapped. in bytes. if you are using manual overlay management). Here are the variables your overlay manager must define to support gdb’s automatic overlay debugging: _ovly_table: This variable must be an array of the following structures: struct { /* The overlay’s mapped address.ov.0x104a (gdb) print foo $6 = {int (int)} 0x1016 <foo> When overlay debugging is enabled. This allows most gdb commands. zero otherwise. However. if you set a breakpoint at the end of your overlay manager (and tell gdb which overlays are now mapped. */ */ /* Non-zero if the overlay is currently mapped. mapped at 0x1016 . */ unsigned long mapped.2 [Overlay Commands]. gdb looks in the inferior’s memory for certain variables describing the current state of the overlays.foo.

When gdb finds a matching entry. while relocating them to run at their mapped addresses.c overlays.c’.c -c ovlymgr.c -c baz. target architecture. Unfortunately.ld. except that you must substitute the appropriate compiler and linker script for the target system for d10v-elf-gcc and d10v. If the overlay manager then calls this function whenever it has changed the overlay table. you must write a linker script (see Section “Overlay Description” in Using ld: the GNU linker).ld -o overlays You can build the test program using the d10v-elf GCC cross-compiler like this: $ $ $ $ $ $ $ d10v-elf-gcc d10v-elf-gcc d10v-elf-gcc d10v-elf-gcc d10v-elf-gcc d10v-elf-gcc d10v-elf-gcc The build process is identical for any other architecture. with linker scripts for a few systems.4 Overlay Sample Program When linking a program which uses overlays. However.ld’ ‘m32r.o foo.c -c foo.-Td10v. as part of its test suite.c’ ‘bar. the gdb source distribution does contain an overlaid program. your overlay manager may define a function called _ovly_debug_event.o ovlymgr. .o \ baz. Linker scripts for linking the test program on the d10v-elf and m32r-elf targets. ‘foo. and update any breakpoints that may be set in overlays.base’: ‘overlays.o grbx. If this function is defined. used by ‘overlays.c’ ‘baz. -g -g -g -g -g -g -g -c overlays. and target memory layout.c’ A simple overlay manager. ‘ovlymgr. you must place the overlays at their load addresses.c’ ‘grbx.ld’ Overlay modules. To do this.c’ The main program file. 14.c -c grbx.c’.c’ ‘d10v. this manual cannot provide portable sample code demonstrating gdb’s overlay support.c -c bar. since linker scripts are specific to a particular host system.o bar. This will allow breakpoints to work even if the overlays are kept in ROM or other non-writable memory while they are not being executed. this will enable gdb to accurately keep track of which overlays are in program memory.Chapter 14: Debugging Programs That Use Overlays 159 in the executable file. The program consists of the following files from ‘gdb/testsuite/gdb.o -Wl. it consults the entry’s mapped member to determine whether the overlay is currently mapped. In addition. gdb will silently set a breakpoint there. loaded and used by ‘overlays.

.

that generates C but is written in another language. the compiler might indicate which language a particular source file is in.c++’ Ada source file. For some object file formats. See Section 15. gdb defaults to setting the language automatically.ada’ ‘. The working language is used to determine how expressions you type are interpreted. For instance. that way gdb will know the correct language of the source code of the original program.1. every source file that gdb knows about has its own working language. then gdb infers that its language is the one indicated. There is no way to set the language of a source file from within gdb.2 [Displaying the Language]. it is accomplished by p^. C source file C++ source file . 15. such as cfront or f2c. while in Modula-2 they appear as ‘1AEH’.cpp’ ‘. In addition to the working language.c’ ‘.a’ ‘. Language-specific information is built into gdb for some languages. The language you use to build expressions is called the working language. dereferencing a pointer p is accomplished by *p.adb’ ‘.cxx’ ‘. etc. allowing you to express operations like the above in your program’s native language.Chapter 15: Using gdb with Different Languages 161 15 Using gdb with Different Languages Although programming languages generally have common aspects. most of the time gdb infers the language from the name of the file. ‘. You can use the set language command for either purpose.cc’ ‘. The language of a source file controls whether C++ names are demangled—this way backtrace can show each frame appropriately for its own language.C’ ‘. However.1 Switching Between Source Languages There are two ways to control the working language—either have gdb set it automatically. Values can also be represented (and displayed) differently. in ANSI C.ads’ ‘. make the program use #line directives in its C output. but in Modula-2. page 162. and allowing gdb to output values in a manner consistent with the syntax of your program’s native language. This is most commonly a problem when you use a program. On startup. they are rarely expressed in the same manner. 15. and will display that source code. how values are printed.1 List of Filename Extensions and Languages If a source file name ends in one of the following extensions. not the generated C code. or select it manually yourself. but you can set the language associated with a filename extension. Hex numbers in C appear as ‘0x1ae’. In that case.cp’ ‘.

2 Setting the Working Language If you allow gdb to set the language automatically.s’ ‘.3 Having gdb Infer the Source Language To have gdb set the working language automatically. In C.1. gdb sets the working language to the language recorded for the function in that frame. issue the command ‘set language lang’. and gdb issues a warning. Setting the language manually prevents gdb from updating the working language automatically. a command such as: print a = b + c might not have the effect you intended. which are written entirely in one source language. The result printed would be the value of a. if the current source file were written in C.2 [Displaying the Language]. if the function or block corresponding to the frame was defined in a source file that does not have a recognized extension). type ‘set language’. program modules and libraries written in one source language can be used by a main program written in a different source language. For instance. page 162.mod’ ‘. you may set the language associated with a filename extension. and gdb was parsing Modula-2. gdb then infers the working language.162 Debugging with gdb ‘. This may not seem necessary for most programs. However.f’ ‘. If you wish. this means to add b and c and place the result in a.F’ ‘. See In addition. For a list of the supported languages. 15. Using ‘set language auto’ in this case frees you from having to set the working language manually. you may set the language manually. where lang is the name of a language.m’ ‘. this means to compare a to the result of b+c.2 Displaying the Language The following commands help you find out which language is the working language. This actually behaves almost like C. use ‘set language local’ or ‘set language auto’. If the language for a frame is unknown (that is. To do this. when an expression is acceptable to both languages—but means different things. This can lead to confusion if you try to debug a program when the working language is not the same as the source language. but gdb does not skip over function prologues when stepping. Section 15.d’ ‘. when your program stops in a frame (usually by encountering a breakpoint). expressions are interpreted the same way in your debugging session and your program. .S’ D source file Objective-C source file Fortran source file Modula-2 source file Assembler source file. 15. yielding a BOOLEAN value.1. and also what language source files were written in. In Modula-2. such as c or modula-2. 15. the current working language is not changed. That is.

These checks prevent type mismatch errors from ever causing any run-time problems. but they do not yet have any effect. meaning that the arguments to operators and functions have to be of the correct type. This is the language you can use with commands such as print to build and compute expressions that may involve variables in your program. Some languages are designed to guard you against making seemingly common errors through a series of compile.3. to identify the other information listed here.Chapter 15: Using gdb with Different Languages 163 show language Display the current working language. you may have source files with extensions not in the standard list.4 [Supported Languages]. info source Display the source language of this source file. to identify the other information listed here. This language becomes the working language if you use an identifier from this frame. This section documents the intended facilities. such as Modula-2. See Section 8. page 85. These include checking the type of arguments to functions and operators.3 Type and Range Checking Warning: In this release.4 [Information about a Frame]. gdb can check for conditions like the above if you wish. In unusual circumstances. info frame Display the source language for this frame. For example.3 . 15. otherwise an error occurs. page 165. Although gdb does not check the statements in your program.and run-time checks. 15. the gdb commands for type and range checking are included. and making sure mathematical overflows are caught at run time. 1 + 2 ⇒ 3 but error 1 + 2. for the default settings of supported languages. page 189. See Section 15. As with the working language. You can then set the extension associated with a language explicitly: set extension-language ext language Tell gdb that source files with extension ext are to be assumed as written in the source language language. gdb can also decide whether or not to check automatically based on your program’s source language.1 An Overview of Type Checking Some languages. are strongly typed. info extensions List all the filename extensions and the associated languages. Checks such as these help to ensure a program’s correctness once it has been compiled by eliminating type mismatches. it can check expressions entered directly into gdb for evaluation via the print command. See Chapter 16 [Examining the Symbol Table]. for example. and providing active checks for range errors when your program is running.

In C.4 [Supported Languages]. Evaluating the expression may still be impossible for other reasons. or indices on an array element access do not exceed the bounds of the array. you can tell gdb to treat range errors in one of three ways: ignore them. set check type on set check type off Set type checking on or off. to treat any mismatches as errors and abandon the expression. overriding the default setting for the current working language. See Section 15. for the default settings for each language. show type Show the current setting of the type checker. For example. Such range checking is meant to ensure program correctness by making sure computations do not overflow. so that they are valid arguments to mathematical operators. and whether or not gdb is setting it automatically. These particular type errors have nothing to do with the language in use. For instance. Issue a warning if the setting does not match the language default. it is an error to exceed the bounds of a type. always treat them as errors and abandon the expression. but to always attempt to evaluate the expression. gdb provides some additional commands for controlling the type checker: set check type auto Set type checking on or off based on the current working language. 15. such as the one described above. this is enforced with run-time checks. but also issues a warning. page 165. Each language defines to what degree it is strict about type. gdb evaluates expressions like the second example above. See Section 15. for further details on specific languages. For the expressions you use in gdb commands. When you choose the last of these.3. or issue warnings but evaluate the expression anyway.3. page 165. you can tell the gdb type checker to skip checking.4 [Supported Languages]. gdb does not know how to add an int and a struct foo. both Modula2 and C require the arguments to arithmetical operators to be numbers. For expressions you use in gdb commands. but evaluate the expression anyway. set check type warn Cause the type checker to issue warnings. and usually arise from expressions. If any type mismatches occur in evaluating an expression while type checking is on. which make little sense to evaluate anyway.164 Debugging with gdb The second example fails because the CARDINAL 1 is not type-compatible with the REAL 2. gdb cannot add numbers and structures.2 An Overview of Range Checking In some languages (such as Modula-2). or to only issue warnings when type mismatches occur. Even if you turn type checking off. gdb prints a message and aborts evaluation of the expression. . there may be other reasons related to type that prevent gdb from evaluating an expression. For instance. enumerated types and pointers can be represented as numbers.

or when you type a constant that is not a member of any type. There are many good books written on each of these languages. set check range warn Output messages when the gdb range checker detects a range error. Whenever this is the case. we discuss those languages together. mathematical overflow causes the result to “wrap around” to lower values—for example. such as accessing memory that the process does not own (a typical example from many Unix systems). D. show range Show the current setting of the range checker. then a message is printed and evaluation of the expression is aborted. The following sections detail to what degree each source language is supported by gdb. Fortran. See Section 15. for further details on specific languages. OpenCL C.4 [Supported Languages]. then m + 1 ⇒ s This. too. overriding the default setting for the current working language. A warning is issued if the setting does not match the language default. for the default settings for each language. These sections are not meant to be language tutorials or references. and in some cases specific to individual compilers or machines. however. but serve only as a reference guide to what the gdb expression parser accepts. and Ada. assembly. do not treat overflows as an error. is specific to individual languages. .4 Supported Languages gdb supports C. please look to these for a language reference or tutorial. 15. C++. Pascal. page 165. gdb provides some additional commands for controlling the range checker: set check range auto Set range checking on or off based on the current working language. Some languages.1 [Expressions]. from exceeding an array index bound. and what input and output formats should look like for different languages. page 97) can be used with the constructs of any supported language. If a range error occurs and range checking is on. Objective-C.1 C and C++ Since C and C++ are so closely related. and the ‘{type}addr’ construct (see Section 10. but attempt to evaluate the expression anyway. many features of gdb apply to both languages. Evaluating the expression may still be impossible for other reasons. set check range on set check range off Set range checking on or off. if m is the largest integer value.Chapter 15: Using gdb with Different Languages 165 A range error can result from numerical overflow. See Section 15. and s is the smallest. Some gdb features may be used in expressions regardless of the language you use: the gdb @ and :: operators. Java. and whether or not it is being set automatically by gdb. 15.4 [Supported Languages]. page 165. Modula2. In many implementations of C.4.

Defined on integral types. char. Defined on integral types. left shift. Defined on integral types.4. Logical and. Less than. >. and translated to a = a op b. The following operators are supported. • Pointer types include all types defined as (type *). the following definitions hold: • Integral types include int with any of its storage-class specifiers. for C++. %. *. The value of these expressions is 0 for false and non-zero for true. >= . The comma or sequencing operator. For instance. Expressions in a comma-separated list are evaluated from left to right. enum. and right shift. +. Equality and inequality. floating-point types and pointer types. Addition and subtraction. Operators are often defined on groups of types. != <. >>. and. to debug your C++ code effectively.166 Debugging with gdb The C++ debugging facilities are jointly implemented by the C++ compiler and gdb. and long double (if supported by the target platform). but not on structures. greater than or equal. For the purposes of C and C++. op= and = have the same precedence. Assignment. ^. • Scalar types include all of the above.1. Defined on integral types. Defined on scalar types. Therefore. The ternary operator.1 C and C++ Operators Operators must be defined on values of specific types. <<. bool. Defined on scalar types. you must compile your C++ programs with a supported C++ compiler. Defined on integral types. Bitwise exclusive-or. Defined on integral types. a ? b : c can be thought of as: if a then b else c. op is any one of the operators |. <<. The gdb “artificial array” operator (see Section 10. &. The value of an assignment expression is the value assigned. page 97). Bitwise or. /. Used in an expression of the form a op= b.1 [Expressions]. or the HP ANSI C++ compiler (aCC). Defined on integral types. such as gnu g++. 15. greater than. -. They are listed here in order of increasing precedence: . • Floating-point types include float. Defined on scalar types. a should be of an integral type. Bitwise and. with the result of the entire expression being the last expression evaluated. >> @ +. The value of these expressions is 0 for false and non-zero for true. Logical or. = op= ?: || && | ^ & ==. double. less than or equal. + is defined on numbers. <=.

Bitwise complement operator. division. 15. followed by a decimal point. Multiplication and division are defined on integral and floating-point types. which specifies a long double constant. and optionally followed by an exponent. and modulus. when appearing after it. the variable’s value is used before the operation takes place. Structure member. Octal constants are specified by a leading ‘0’ (i.. choosing whether to dereference a pointer based on the stored type information. • Enumerated constants consist of enumerated identifiers. specifying that the constant should be treated as being of the float (as opposed to the default double) type. Dereferences of pointers to members. Defined on pointer types. Same precedence as ++. union. where nnn is another sequence of digits. /. Address operator. and pointer-to-structure member. ->* [] () :: :: If an operator is redefined in the user code. Logical negation. and class types. page 97). Same precedence as ++. Constants may also end with a letter ‘l’. Increment and decrement. Same precedence as ++. Same precedence as ->. For convenience. Defined on variables.1. Same precedence as ++. • Floating point constants are a sequence of digits. * & ! ~ .*. zero). the operation is performed before the variable is used in an expression. or with a letter ‘l’ or ‘L’.1 [Expressions]. a[i] is defined as *(a+i). .4. gdb regards the two as equivalent. % ++. An exponent is of the form: ‘e[[+]|-]nnn’. followed by a sequence of digits. above. For debugging C++. and hexadecimal constants by a leading ‘0x’ or ‘0X’. . Array indexing. The ‘+’ is optional for positive exponents. specifying that the constant should be treated as a long value.Chapter 15: Using gdb with Different Languages 167 *. Defined on struct. -> Negative. -- Multiplication. Doubled colons also represent the gdb scope operator (see Section 10. or their integral equivalents. Modulus is defined on integral types. gdb implements a use of ‘&’ beyond what is allowed in the C++ language itself: you can use ‘&(&ref)’ to examine the address where a C++ reference variable (declared with ‘&ref’) is stored. Defined on integral types. Same precedence as ::.e.2 C and C++ Constants gdb allows you to express the constants of C and C++ in the following ways: • Integer constants are a sequence of digits. When appearing before a variable. Function parameter list. Same precedence as ->. Pointer dereferencing. Defined on integral and floating-point types. Defined on integral types. Same precedence as ++. Defined on struct and union data. gdb usually attempts to invoke the redefined version instead of using the operator’s predefined meaning. C++ scope resolution operator. A floating-point constant may also end with a letter ‘f’ or ‘F’.

• Array constants are comma-separated lists surrounded by braces ‘{’ and ‘}’. See Section 4. or of the form ‘\x’. &"there". Currently. It does perform integral conversions and promotions. ‘L’x’’ is the wide form of ‘x’.3 C++ Expressions gdb expression handling can interpret most C++ expressions.1 [Compilation].168 Debugging with gdb • Character constants are a single character surrounded by single quotes (’). arithmetic conversions. using declarations in the current scope are also respected by gdb. Other compilers and/or debug formats are likely to work badly or not at all when using gdb to debug C++ code. which are of the form ‘\nnn’.6}}’ is a three-by-two array. Double quotes within the string must be preceded by a backslash. floating-point promotions. 3. page 125). • String constants are a sequence of character constants surrounded by double quotes ("). page 125). gcc defaults to this on most popular platforms.3}’ is a three-element array of integers.2. ‘{{1.1.4}. Member function calls are allowed. ‘{1. Within quotes. Any valid character constant (as described above) may appear. gdb works best when debugging C++ code that is compiled with the most recent version of gcc possible. You can call overloaded functions. you can use expressions like count = aml->GetOriginal(x. as in C. as in C. The DWARF debugging format is preferred. {5. The target wide character set is used when computing the value of this constant (see Section 10. and . 1. calls to constructors.19 [Character Sets]. where ‘x’ is a predefined special character—for example. conversions of class objects to base classes. It also cannot handle ellipsis argument lists or default arguments.19 [Character Sets]. You can also write pointers to constants using the C operator ‘&’. • Pointer constants are an integral value. &"fred"}’ is a three-element array of pointers. or a number—the ordinal value of the corresponding character (usually its ascii value).4. where nnn is the octal representation of the character’s ordinal value. page 25. The target wide character set is used when computing the value of this constant (see Section 10. for example. so for instance ‘"a\"b’c"’ is a string of five characters. For example. Wide character constants can be written by prefixing a character constant with ‘L’. that is. gdb allows implicit references to the class instance pointer this following the same rules as C++. pointer conversions. While a member function is active (in the selected stack frame). Warning: gdb can only debug C++ code if you use the proper compiler and the proper debug format. gdb resolves the function call to the right definition. with some restrictions. 15. and ‘{&"hi". your expressions have the same namespace available as the member function.2}. ‘\n’ for newline. gdb does not perform overload resolution involving user-defined type conversions. Wide string constants can be written by prefixing a string constant with ‘L’. {3. or instantiations of templates that do not exist in the program. the single character may be represented by a letter or by escape sequences. y) 2.

union.3 [Program Variables]. You must specify set overload-resolution off in order to use an explicit function signature to call an overloaded function.int)’(’x’. Overload resolution is always performed.6 gdb and C The set print union and show print union commands apply to the union type. 15.4 C and C++ Defaults If you allow gdb to set type and range checking automatically. for further details. it appears as ‘{. 4. If you allow gdb to set the language automatically.c’. 5. you can use them in expressions just as you do in C++ source—they are automatically dereferenced. page 19. 13) The gdb command-completion facility can simplify this. any union that is inside a struct or class is also printed. This happens regardless of whether you or gdb selects the working language. gdb performs argument-dependent lookup. In the parameter list shown when gdb displays a frame. or types that have been declared equivalent through typedef. gdb also allows resolving name scope by reference to source files. page 162.3 [Having gdb Infer the Source Language]. page 170. since they are often used to index a pointer that is not itself an array. 15. Array indices are not checked. they both default to off whenever the working language changes to C or C++.4.cc’. this avoids clutter.2 [Command Completion]. Otherwise. if turned on.1.4. Range checking. Since one scope may be defined in another. 6. is done on mathematical operations. or enumerated tag. unless you have specified ‘set print address off’. ‘.Chapter 15: Using gdb with Different Languages 169 standard conversions such as those of functions or arrays to pointers. following the C++ specification.7 [gdb Features for C++].1. it recognizes source files whose names end with ‘. in both C and C++ debugging (see Section 10. unless you have specified set overloadresolution off. as in p ’foo(char. and when gdb enters code compiled from one of these files. • The two variables have the same type name.}’. etc. since references are often used for large structures. page 99). When set to ‘on’. . it sets the working language to C or C++. gdb supports the C++ name resolution operator ::—your expressions can use it just as expressions in your program do. See Section 15. See Section 15. gdb understands variables declared as C++ references. when gdb parses C or C++ expressions. for example in an expression like ‘scope1::scope2::name’.1. type checking is not used. the values of reference variables are not displayed (unlike other variables). or ‘. see Section 3.4. The address of a reference variable is always shown. 15.. gdb considers two variables type equivalent if: • The two variables are structured and have the same structure.C’. you can use :: repeatedly if necessary.1. if you turn type checking on.4.1. it requires an exact match on the number of function arguments. However.5 C and C++ Type and Range Checks By default..

gdb has the capability to display a menu of possible breakpoint locations to help you specify which function definition you want. gdb evaluates the arguments and searches for a function whose signature matches the argument types. rbreak regex Setting breakpoints using regular expressions is helpful for setting breakpoints on overloaded functions that are not members of any special classes. page 106. See Section 10. for details). using the standard C++ conversion rules (see Section 15. formed with pointers and a memory allocation function. See Section 10.8 [Print Settings]. (The vtbl commands do not work on programs compiled with the HP ANSI C++ compiler (aCC). page 44. . See Section 10. page 97. page 189.170 Debugging with gdb The @ operator aids in the debugging of dynamic arrays. page 52. both when displaying code as C++ source and when displaying disassemblies.2 [Ambiguous Expressions].8 [Print Settings]. For overloaded functions. See Section 5. set print demangle show print demangle set print asm-demangle show print asm-demangle Control whether C++ symbols display in their source form. See Section 10.3 [Setting Catchpoints]. page 98. page 106.7 gdb Features for C++ Some gdb commands are particularly useful with C++.1. The default is on.1 [Expressions].1. page 168. and some are designed specifically for use with C++. set print vtbl show print vtbl Control the format for printing virtual function tables. See Chapter 16 [Examining the Symbol Table]. See Section 5. catch throw catch catch Debug C++ exception handling using these commands. page 106.3 [C++ Expressions].1.4.1. Here is a summary: breakpoint menus When you want a breakpoint in a function whose name is overloaded. 15.1 [Setting Breakpoints]. ptype typename Print inheritance relationships as well as other information for type typename.8 [Print Settings]. See Section 10.) set overload-resolution on Enable overload resolution for C++ expression evaluation. If it cannot find a match. it emits a message. set print object show print object Choose whether to print derived (actual) or declared types of objects.4.

page 189.4. See Section 21. LDC or DMD compilers. for details on how to do this. depending on the architecture: BID (Binary Integer Decimal) for x86 and x86-64.1 Method Names in Commands The following commands have been extended to accept Objective-C method names as line specifications: .2 [Command Completion]. which in the C language correspond to the _Decimal32. gdb searches for a function whose signature exactly matches the argument types. In the PowerPC architecture.7 [PowerPC].3. See also Chapter 16 [Symbols].4. 15. set and perform computations with numbers in decimal floating point format.3 Objective-C This section provides information about some commands and command options that are useful for debugging Objective-C code. the library used by gdb to manipulate decimal floating point numbers. and DPD (Densely Packed Decimal) for PowerPC. or to finish the type list for you. error checking in decimal float operations ignores underflow. page 19. for a few more commands specific to Objective-C support.8 Decimal Floating Point format gdb can examine.1. _Decimal64 and _Decimal128 types as specified by the extension to support decimal floating-point arithmetic. for example) integers wider than 32-bit to decimal float. Overloaded symbol names You can specify a particular definition of an overloaded symbol. overflow and divide by zero exceptions. 15. There are two encodings in use.4. whether or not its arguments are of the correct type. Because of a limitation in ‘libdecnumber’. In addition. show overload-resolution Show the current setting of overload resolution. page 263 for more details. gdb will use the appropriate encoding for the configured target. For overloaded functions that are class member functions.2 D gdb can be used to debug programs written in D and compiled with GDC. gdb chooses the first function of the specified name that it finds in the symbol table. using the same notation that is used to declare such symbols in C++: type symbol(types) rather than just symbol. See Section 3. it is not possible to convert (using a cast. 15.4. in order to imitate gdb’s behaviour with binary floating point computations.Chapter 15: Using gdb with Different Languages 171 set overload-resolution off Disable overload resolution for C++ expression evaluation. For overloaded functions that are not class member functions. page 189. You can also use the gdb command-line word completion facilities to list the available choices.4. 15. gdb provides a set of pseudo-registers to inspect _Decimal128 values stored in floating point registers. Currently gdb supports only one D specific feature — dynamic arrays. and Chapter 16 [Symbols].

As another example. Indicate your choice by number. including any colons. 15. to clear a breakpoint established at the makeKeyAndOrderFront: method of the NSWindow class. In addition the half. print-object or po for short. similar to the way messages are specified in Objective-C source code. defined.4. _NSPrintForDebugger. enter: list +[NSText initialize] In the current version of gdb. For example.2 The Print Command With Objective-C The print command has also been extended to accept methods.1. . 15. the plus or minus sign is required. It is also possible to specify just a method name: break create You must specify the complete method name. to set a breakpoint at the create instance method of class Fruit in the program currently being debugged. this command may only work with certain Objective-C libraries that have a particular hook function. For example: print -[object hash] will tell gdb to send the hash message to object and print the result. However. enter: clear -[NSWindow makeKeyAndOrderFront:] 15. an additional command has been added.4.172 Debugging with gdb • clear • break • info line • jump • list A fully qualified Objective-C method name is specified as -[Class methodName] where the minus sign is used to indicate an instance method and a plus sign (not shown) is used to indicate a class method. the plus or minus sign will be optional. but you can use it to narrow the search. The class name Class and method name methodName are enclosed in brackets.4 OpenCL C This section provides information about gdbs OpenCL C support.4.4.1 OpenCL C Datatypes gdb supports the builtin scalar and vector datatypes specified by OpenCL 1. which is meant to print the description of an object. or type ‘0’ to exit if none apply. If your program’s source files contain more than one create method. you’ll be presented with a numbered list of classes that implement that method. Also.3. enter: break -[Fruit create] To list ten program lines around the initialize class method.and double-precision floating point data types of the cl_khr_fp16 and cl_khr_ fp64 OpenCL extensions are also known to gdb. In future versions of gdb.

5. The access component operator. 15. The range operator. so gdb by default uses case-insensitive matches for Fortran symbols. but not on characters or other non.5. Operators are often defined on groups of types. 15. the names of all COMMON blocks visible at the current program location are printed. Some Fortran compilers (gnu Fortran 77 and Fortran 95 compilers among them) append an underscore to the names of variables and functions. Normally used to access elements in derived types. 15.4. For instance. see Chapter 16 [Symbols].4.5.1 for scalar and vector data types.4.2 Fortran Defaults Fortran symbols are usually case-insensitive. It raises the first operand to the power of the second one. info common [common-name] This command prints the values contained in the Fortran COMMON block whose name is common-name. page 189. you will need to refer to variables and functions with a trailing underscore. Since OpenCL C is based on C99 most C expressions supported by gdb can be used as well. When you debug programs compiled by those compilers. . 15. 15.1 Fortran Operators and Expressions Operators must be defined on values of specific types. ** : % The exponentiation operator. Normally used in the form of array(low:high) to represent a section of array.4.4. You can change that with the ‘set case-insensitive’ command.3 OpenCL C Operators gdb supports the operators specified by OpenCL 1. As unions aren’t part of regular Fortran. Also suitable for unions.4.4.3 Special Fortran Commands gdb has some commands to support Fortran-specific features. but it currently supports only the features of Fortran 77 language. for the details.2 OpenCL C Expressions gdb supports accesses to vector components including the access as lvalue where possible.arithmetic types. such as displaying common blocks.5 Fortran gdb can be used to debug programs written in Fortran. + is defined on numbers. With no argument. this can only happen when accessing a register that uses a gdbarch-defined union type.Chapter 15: Using gdb with Different Languages 173 15.4.

CARDINAL. >= =. 15. For instance. Less than or equal to. The value of var := value is value. • Scalar types consist of all of the above. or nested functions does not currently work. floating-point and enumerated types. or set inclusion on set types. or enumerated types. and appear in order of increasing precedence: .1 [Expressions]. greater than or equal to on integral. Less than. Assignment.4. See Section 10. The Pascal-specific command set print pascal_static-members controls whether static members of Pascal objects are displayed. or similar features using Pascal syntax.7. Boolean conjunction. Same precedence as <. or union and difference on set types. valid on scalar types. • Set types consist of SET and BITSET types. Boolean disjunction. • Pointer types consist of anything declared as POINTER TO type. • Boolean types consist of BOOLEAN. <>. page 97). and attempting to debug executables produced by them is most likely to give an error as gdb reads in the executable’s symbol table. gdb does not support entering expressions. since # conflicts with the script comment character. Same precedence as <. Equality and two ways of expressing inequality. IN OR AND. Other Modula-2 compilers are not currently supported. The following operators are supported. Set membership. page 106. := <. The gdb “artificial array” operator (see Section 10. only <> is available for inequality. In gdb scripts. printing values. Operators are often defined on groups of types. Defined on boolean types. & @ +.4.1 Operators Operators must be defined on values of specific types. the following definitions hold: • Integral types consist of INTEGER. • Floating-point types consist of REAL. Same precedence as <. but not on structures.4. greater than on integral.8 [Print Settings]. Defined on boolean types. 15. Addition and subtraction on integral and floating-point types. + is defined on numbers.7 Modula-2 The extensions made to gdb to support Modula-2 only support output from the gnu Modula-2 compiler (which is currently being developed). file variables. floating-point. - .6 Pascal Debugging Pascal programs which use sets. Defined on set types and the types of their members. > <=. # Function argument or array index separator. For the purposes of Modula-2. subranges. • Character types consist of CHAR and its subranges. and their subranges.174 Debugging with gdb 15.

Generally used in the same function with the metavariable s.7.Chapter 15: Using gdb with Different Languages 175 * / DIV. Defined on integral types. . *. represents a variable or constant of integral type. represents a type. Defined on boolean types. Defined on ARRAY data. <>. #. Same precedence as ^. represents a variable or constant of one of many types.4. RECORD field selector. [] () ::. Array indexing. so gdb treats the use of the operator IN. or symmetric set difference on set types. n r t v x . In describing these. Defined on RECORD data. All Modula-2 built-in procedures also return a result. ABS(n) CAP(c) Returns the absolute value of n. the following metavariables are used: a c i m represents an ARRAY variable. represents a CHAR constant or variable. described below. represents an identifier that belongs to a set. <=. or the use of operators +. See the explanation of the function for details.2 Built-in Functions and Procedures Modula-2 also makes available several built-in procedures and functions. represents a variable. Same precedence as ^. or set intersection on set types. 15. Defined on pointer types. Same precedence as *. MOD ^ NOT . represents a variable or constant of floating-point type. Pointer dereferencing. Same precedence as *. it returns its upper case equivalent. -. Same precedence as ^. Procedure argument list. and >= on sets as an error. gdb and Modula-2 scope operators. otherwise it returns its argument. Defined on INTEGER and REAL data. Warning: Set expressions and their operations are not yet supported. Defined on PROCEDURE objects. If c is a lower case letter. /. Negative. The type of s should be SET OF mtype (where mtype is the type of m). . =. Same precedence as ^. Division on floating-point types. represents a variable or constant of integral or floating-point type. Boolean negation. Integer division and remainder. Multiplication on integral and floating-point types.

i) Warning: Sets and their operations are not yet supported. MAX(t) MIN(t) ODD(i) ORD(x) Returns the maximum value of the type t.176 Debugging with gdb CHR(i) DEC(v) DEC(v.3 Constants gdb allows you to express the constants of Modula-2 in the following ways: • Integer constants are simply a sequence of digits.7. x can be a variable or a type. x can be a variable or a type. • Character constants consist of a single character enclosed by a pair of like quotes. Returns the size of its argument. a constant is interpreted to be type-compatible with the rest of the expression. When used in an expression. Returns the new set. Returns the new set. Returns the new value. Returns the new value. and octal integers by a trailing ‘B’.i) INCL(m. so gdb treats the use of procedures INCL and EXCL as an error. Increments the value in the variable v by i. Decrements the value in the variable v by i. For example. followed by a decimal point and another sequence of digits. Returns the size of its argument.i) EXCL(m. in the form ‘E[+|-]nnn’.s) Returns the character whose ordinal value is i. Returns the member of the type t whose ordinal value is i. . x must be of an ordered type.s) Returns the floating point equivalent of the integer i. the ordinal value of a character is its ascii value (on machines supporting the ascii character set). Hexadecimal integers are specified by a trailing ‘H’. All of the digits of the floating point constant must be valid decimal (base 10) digits. usually) followed by a ‘C’. They may also be expressed by their ordinal value (their ascii value. Returns the minimum value of the type t. 15. Adds the element m to the set s if it is not already there. character and enumerated types. FLOAT(i) HIGH(a) INC(v) INC(v.4. Returns the new value. which include integral. where ‘[+|-]nnn’ is the desired exponent. Returns the integral part of r. Returns the new value. Increments the value in the variable v by one. either single (’) or double ("). Removes the element m from the set s. Decrements the value in the variable v by one. Returns the ordinal value of its argument. • Floating point constants appear as a sequence of digits. Returns boolean TRUE if i is an odd number. Returns the index of the last member of a. An optional exponent can then be specified. SIZE(x) TRUNC(r) TSIZE(x) VAL(t.

40] . The first example contains the following section of code: VAR s: SET OF CHAR . The following example shows how you might declare an array in Modula-2 and how you can interact with gdb to print its type and contents: VAR s: ARRAY [-10.’Z’] Note that at present you cannot interactively manipulate set expressions using the debugger. green) . r: [20.10] OF CHAR . (gdb) print s {’A’. Here are some more type related Modula-2 examples: TYPE colour = (blue.yellow] .. 15. • Enumerated constants consist of an enumerated identifier.4. • Set constants are not yet supported. red.. procedure types.. • Pointer constants consist of integral values only..2 [C and C++ Constants]. See Section 15. and you can request gdb to interrogate the type and value of r and s. You can also print the contents of variables declared using these type. yellow.. subrange types and base types. set types. ’Z’} (gdb) ptype s SET OF CHAR (gdb) print r 21 (gdb) ptype r [20. • Boolean constants consist of the identifiers TRUE and FALSE. for a brief explanation of escape sequences.’C’. expression handling still assumes that all arrays have a lower bound of zero and not -10 as in the example above.4 Modula-2 Types Currently gdb can print the following data types in Modula-2 syntax: array types..10] OF CHAR Note that the array handling is not yet complete and although the type is printed correctly..7.. enumerated types.4. (gdb) ptype s ARRAY [-10. record types. . This section gives a number of simple source code examples together with sample gdb sessions.Chapter 15: Using gdb with Different Languages 177 • String constants consist of a sequence of characters enclosed by a pair of like quotes. t = [blue.40] Likewise if your source code declares s as: VAR s: SET [’A’. pointer types. either single (’) or double (").1. Escape sequences in the style of C are also allowed. page 167. then you may query the type of s by: (gdb) ptype s type = SET [’A’.’Z’] .

. 0. VAR s: ARRAY [1.178 Debugging with gdb VAR s: t . 0. BEGIN s[1] := 1 . The gdb interaction shows how you can query the data type and value of a variable.. f3 : ARRAY [-2. Here we combine array types. and you can request that gdb describes the type of s.2] OF foo = RECORD f1 : CARDINAL.. 0} (gdb) ptype s type = ARRAY [1. BEGIN NEW(s) . s^[1] := 1 ..5] OF CARDINAL gdb handles compound types as we can see in this example. 0. f3: myarray . VAR s: POINTER TO ARRAY myrange OF foo . Observe that the contents are written in the same way as their C counterparts. myarray = ARRAY myrange OF CARDINAL . pointer types and subrange types: TYPE foo = RECORD f1: CARDINAL . and you can ask gdb to describe the type of s as shown below. f2 : CHAR. END . BEGIN s := blue . myrange = [-2.5] OF CARDINAL .2] OF CARDINAL. record types.5] OF CARDINAL The Modula-2 language interface to gdb also understands pointer types as shown in this example: VAR s: POINTER TO ARRAY [1.. (gdb) ptype s type = POINTER TO ARRAY [1.2] . (gdb) ptype s type = POINTER TO ARRAY [-2.yellow] In this example a Modula-2 array is declared and its contents displayed. (gdb) print s $1 = blue (gdb) ptype t type = [blue.5] OF CARDINAL . (gdb) print s $1 = {1... f2: CHAR . END ..

4.) • C escape sequences can be used in strings and characters to represent non-printable characters. but it may not be true of other compilers. then gdb searches all scopes enclosing the one specified by scope. module the name of a module.1. and id is any declared identifier within your program. then entering code compiled from a file whose name ends with ‘. the actual address contained in a pointer variable is hidden from you. 15.4. There are a few subtle differences between the Modula-2 scope operator (. • The assignment operator (:=) returns the value of its right-hand argument. (In standard Modula-2. it can only be modified through direct assignment to another pointer variable or expression that returned a pointer. If you allow gdb to set the language automatically. pointer constants can be formed by integers. This allows you to modify pointer variables during debugging.mod’ sets the working language to Modula-2. any attempt to combine variables whose types are not equivalent is an error.4. gdb does not yet perform type or range checking. 15.3 [Having gdb Infer the Source Language]. This is done primarily via loosening its type strictness: • Unlike in standard Modula-2.Chapter 15: Using gdb with Different Languages 179 15.5 Modula-2 Defaults If type and range checking are set automatically by gdb. • All built-in procedures both modify and return their argument.7. Range checking is done on all mathematical operations.4. .7. See Section 15.7. except another module. they both default to on whenever the working language changes to Modula-2. Single nonprintable characters are printed using the ‘CHR(nnn)’ format.) and the gdb scope operator (::). gdb prints out strings with these escape sequences embedded.7. (Note: This is true of the gnu Modula-2 compiler.) As long as type checking is enabled. array index bounds.7 Modula-2 Type and Range Checks Warning: in this release.6 Deviations from Standard Modula-2 A few changes have been made to make Modula-2 programs easier to debug. gdb considers two Modula-2 variables type equivalent if: • They are of types that have been declared equivalent via a TYPE t1 = t2 statement • They have been declared on the same line. The two have similar syntax: module .8 The Scope Operators :: and . Using the :: operator makes gdb search the scope specified by scope for the identifier id. id scope :: id where scope is the name of a module or a procedure. page 162. This happens regardless of whether you or gdb selected the working language. and all built-in functions and procedures. If it is not found in the specified scope. 15. for further details. assignment.

15. you may use ‘--’ for comments. operator makes gdb search the current scope for the identifier specified by id that was imported from the definition module specified by module. 15.1 Introduction The Ada mode of gdb supports a fairly large subset of Ada expression syntax. and the last to the C union type.180 Debugging with gdb Using the . ‘demangle’. the Modula-2 inequality operator # is interpreted as the beginning of a comment. thus making it unnecessary to fully qualify most names with their packages. dereferencing. Five subcommands of set print and show print apply specifically to C and C++: ‘vtbl’. and ‘union’. while available with any language. gdb asks the user’s intent. However. and attempting to debug executables produced by them is most likely to be difficult. indexing.1 [Expressions]. Its intent is to aid the debugging of dynamic arrays. but not in the middle (to allow based literals). the construct ‘{type}adrexp’ is still useful. for brevity. because an address can be specified by an integral constant. The @ operator (see Section 10. The philosophy behind the design of this subset is • That gdb should provide basic literals and access to operations for arithmetic. the debugger acts as if all names declared in user-written packages are directly visible. • That type safety and strict adherence to Ada language restrictions are not particularly important to the gdb user. 15. with some extensions. Where this causes ambiguity. which cannot be created in Modula-2 as they can in C or C++. With this operator. or if id is not an identifier in module. regardless of context.8. While in Ada mode. it is an error if the identifier id was not imported from definition module module. which has no direct analogue in Modula-2. Thus. Other Ada compilers are not currently supported. As for other languages.7. it will use the number of actual parameters and some .8 Ada The extensions made to gdb for Ada only support output from the gnu Ada (GNAT) compiler. ‘object’. even if they are not visible according to Ada rules.4. • That brevity is important to the gdb user. The first four apply to C++. page 97). Use <> instead. In gdb scripts. leaving more sophisticated computations to subprograms written into the program (which therefore may be called from gdb).9 gdb and Modula-2 Some gdb commands have little use when debugging Modula-2 programs. This is useful mostly for documenting command files.4. is not useful with Modula-2. it will enter Ada mode when stopped in a program that was translated from an Ada source file. The debugger will start in Ada mode if it detects an Ada main program. Given a subprogram call in which the function symbol has multiple definitions. and subprogram calls. The debugger supports limited overloading. field selection. ‘asm-demangle’. The standard gdb comment (‘#’) still works at the beginning of a line in Ada mode.4.

IEEE-conformant floating point.Latin_1 are not available and concatenation is not implemented. (4. They are permitted only on the right sides of assignments. 6) An_Array := (1. − ’Range on array objects (not subtypes). ’Unchecked_Access.2 Omissions from Ada Here are the notable omissions from the subset: • Only a subset of the attributes are supported: − ’First. Alive => True) Changing a discriminant’s value by assigning an aggregate has an undefined effect if that discriminant is used within the record. given a variable A_Rec declared to have a type such as: type Rec (Len : Small_Integer := 0) is record Id : Integer.3 => 2.. 4. • The other component-by-component array operations (and. 1. Thus.Len := 4 (gdb) set A_Rec := (Id => 42.8. and functions to procedures elsewhere. They will generally work correctly for strings and arrays whose elements have integer or enumeration types. True). They may not work correctly for arrays whose element types have user-defined equality. and relational tests other than equality) are not implemented. − ’Tag. − ’Address. xor. It also makes very limited use of context. you can first modify discriminants by directly assigning to them (which normally would not be allowed in Ada). end record.4.. 2. ’Last. Len). Vals => (1. 3. For example. escape characters in strings are not currently available. 2. − ’Access. A_Record := (Name => "Peter". for arrays of real values (in particular. and for arrays whose elements contain unused bits with indeterminate values. but only as the right operand of the membership (in) operator. or. 3. 5. 15. However. and ’Length on array objects (not on types and subtypes). preferring procedures to functions in the context of the call command.Chapter 15: Using gdb with Different Languages 181 information about their types to attempt to narrow the set of definitions. 6). others => 0) An_Array := (0|4 => 1. − ’Min and ’Max. "Peter". and ’Unrestricted_Access (a GNAT extension). 8. 3). 4)) . not. 5 => 6) A_2D_Array := ((1. 2. (7. • There is limited support for array and record aggregates. as in these examples: (gdb) (gdb) (gdb) (gdb) (gdb) (gdb) set set set set set set An_Array := (1. • The names in Characters. because of negative zeroes and NaNs). Id => 1. Vals : IntArray (1 . and then performing an aggregate assignment. 5. • Equality tests (‘=’ and ‘/=’) on arrays test for bitwise equality of representations. − ’Pos and ’Val. 9)) A_Record := (1. you can assign a value with a different size of Vals with two assignments: (gdb) set A_Rec.

some function calls will be ambiguous. for example. The names True and False. and the user will be asked to choose the proper resolution. You may freely use dynamic values as indices in component associations.” returning as its value the value of its righthand operand. less selective) than that of real Ada. It makes only limited use of the context in which a subexpression appears to resolve its meaning. arithmetic operations on the native VAX floating-point formats are not supported. you may enter (gdb) set x := y + 3 (gdb) print A(tmp := y + 1) • The semicolon is allowed as an “operator. when not part of a qualified name. complex conditional breaks: .182 Debugging with gdb • • • • • • • As this example also illustrates. In addition. Thus. since its prime use is in displaying parts of an array. It is not possible to slice a packed array. and it is much looser in its rules for allowing type matches.12 [Registers]. there are occasional uses when debugging programs in which certain debugging information has been optimized away. they will retain their original values upon assignment. In Ada. Calls to dispatching subprograms are not implemented.. • B::var means “the variable named var that appears in function or file B. you must typically surround it in single quotes. regardless of context.8. Aside from printing. gdb provides a few other shortcuts and outright additions specific to Ada: • The assignment statement is allowed as an expression. Should your program redefine these names in a package or procedure (at best a dubious practice).11 [Convenience Vars]. You may even use overlapping or redundant component associations. you will have to use fully qualified names to access their new definitions.” • A name starting with ‘$’ is a convenience variable (see Section 10. although which component values are assigned in such cases is not defined. and slicing will usually do this in Ada.1 [Expressions]. gdb makes certain generic extensions to Ada (see Section 10. As a result.4. this operator is generally not necessary. page 117) or a machine register (see Section 10. • The expression {type} addr means “the variable of type type that appears at address addr. gdb is very loose about the usual rules concerning aggregates. page 97): • If the expression E is a variable residing in memory (typically a local variable or array element) and N is a positive integer. Entry calls are not implemented. The overloading algorithm is much more limited (i. You may leave out some of the components of an array or record aggregate (such as the Len component in the assignment to A_Rec above).e. This allows. 15.3 Additions to Ada As it does for other languages. The new operator is not implemented.” When B is a file name. returning its right-hand operand as its value. page 119). However. then E@N displays the values of E and the N-1 adjacent variables following it in memory as an array. are interpreted as if implicitly prefixed by Standard.

page 35). the debugger normally maps identifiers you type to lower case.Latin_1. To run your program up to the beginning of elaboration. a’gth. which is also used to print strings. For example.LF) after each period. simply use the following two commands: tbreak adainit and run. "One line. For example.Chapter 15: Using gdb with Different Languages 183 (gdb) break f (gdb) condition 1 (report(i). it is valid to write (gdb) print ’max(x. As defined in the Ada Reference Manual.8. y) • When printing arrays. A(k) > 100) • Rather than use catenation and symbolic character names to introduce special characters into strings.["0a"]" contains an ASCII newline character (Ada. • You may abbreviate attributes in expressions with any unique.4 Stopping at the Very Beginning It is sometimes necessary to debug the program during elaboration. one may instead use a special bracket notation. For the rare occasions when you actually have to look at them. in contrast to valid Ada. or a’lh in place of a’length. component selection on such a value will operate on the specific type of the object. and ’Max is optional (and is ignored in any case). gdb uses positional notation when the array has a lower bound of 1. 1) That is. and uses a modified named notation otherwise. • Since Ada is case-insensitive. as in the following example: .Characters. The sequence of characters ‘["""]’ also denotes a single quotation mark in strings. only the first component has a => clause. For example.4. and before reaching the main procedure.4. 17. 15. you may use a’len.["0a"]Next line. 15. For example. Likewise. For example. A sequence of characters of the form ‘["XX"]’ within a string or character literal denotes the (single) character whose numeric encoding is XX in hexadecimal. which are normally of no interest to users.5 Extensions for Ada Tasks Support for Ada tasks is analogous to that for threads (see Section 4. gdb provides the following task-related commands: info tasks This command shows a list of current Ada tasks. multi-character subsequence of their names (an exact match gets preference).8. k += 1. enclose them in angle brackets to avoid the lower-case mapping. The GNAT compiler uses upper-case characters for some of its internal identifiers. • The subtype used as a prefix for the attributes ’Pos. the elaboration code is invoked from a procedure called adainit.10 [Threads]. (gdb) print <JMPBUF_SAVE>[0] • Printing an object of class-wide type or dereferencing an access-to-class-wide value will display all the components of the object’s specific type (as indicated by its run-time tag). ’Min. a one-dimensional array of three integers with a lower bound of 3 might print as (3 => 10.

Waiting on entry call The task is waiting on an entry call. in the sense of ARM 9.) It is conceptually "executing" in normal mode. Unactivated The task has been created but has not been activated. The Ada task ID. the asterisk before the last task indicates it to be the task currently being inspected. Delay Sleep The task is waiting on a select statement with only a delay alternative open. Accept Statement The task is waiting on an accept or selective wait statement. Any dependents that were waiting on terminate alternatives have been awakened and have terminated themselves.3 (5). Current state of the task. Async Select Wait The task is waiting to start the abortable part of an asynchronous select statement. ID TID P-ID Pri State Represents gdb’s internal task number. The parent’s task ID (gdb’s internal task number). (It may be waiting for a mutex. Child Termination Wait The task is sleeping having completed a master within itself. and is waiting for the tasks dependent on that Terminated . Runnable The task is not blocked for any reason known to Ada. though. It cannot be executing. The base priority of the task. Child Activation Wait The task is waiting for created tasks to complete activation.184 Debugging with gdb (gdb) info tasks ID TID P-ID Pri State Name 1 8088000 0 15 Child Activation Wait main_task 2 80a4000 1 15 Accept Statement b 3 809a800 1 15 Child Activation Wait a * 4 80ae800 3 15 Runnable c In this listing. The task is terminated.

(gdb) info tasks ID TID P-ID Pri State 1 8077870 0 15 Child Activation Wait * 2 807c458 1 15 Runnable (gdb) task [Current task is 2] Name main_task t task taskno This command is like the thread threadno command (see Section 4. info task taskno This command shows detailled informations on the specified task. It switches the context of debugging from the current task to the given task.os_interface. Wait Child in Term Alt The task is sleeping waiting for tasks on terminate alternatives to finish terminating.Chapter 15: Using gdb with Different Languages 185 master to become terminated or waiting on a terminate Phase. Name Name of the task in the program.pthread_cond_wait () . Accepting RV with taskno The task is accepting a rendez-vous with the task taskno. (gdb) info tasks ID TID P-ID Pri State Name 1 8077870 0 15 Child Activation Wait main_task * 2 807c458 1 15 Runnable t (gdb) task 1 [Switching to task 1] #0 0x8067726 in pthread_cond_wait () (gdb) bt #0 0x8067726 in pthread_cond_wait () #1 0x8056714 in system.10 [Threads]. page 35). as in the following example: (gdb) info tasks ID TID P-ID Pri State 1 8077880 0 15 Child Activation Wait * 2 807c468 1 15 Runnable (gdb) info task 2 Ada Task: 0x807c468 Name: task_1 Thread: 0x807f378 Parent: 1 (main_task) Base Priority: 15 State: Runnable Name main_task task_1 task This command prints the ID of the current task.

186 Debugging with gdb #2 #3 #4 0x805cb63 in system. For instance. shown in the first column of the ‘info tasks’ display. When inspecting a core file. For example. page 68). page 88. including Tru64. the breakpoint applies to all tasks of your program.. taskno is one of the numeric task identifiers assigned by gdb. (gdb) cont Continuing. the debugger needs to perform some memory writes in order to provide Ada tasking support. this means that the core file must be opened with read-write privileges.adb.. Use the qualifier ‘task taskno’ with a breakpoint command to specify that you only want gdb to stop the program when a particular Ada task reaches this breakpoint. line 15. On certain platforms.. These commands are like the break ..operations. on x86-linux.adb:15 15 flush. in this case. as opposed to debugging a live program.6 Tasking Support when Debugging Core Files When inspecting a core file. If you do not specify ‘task taskno’ when you set a breakpoint. depending on the platform being used.2 [Specify Location]. (gdb) info tasks ID TID P-ID Pri State Name 1 140022020 0 15 Child Activation Wait main_task * 2 140045060 1 15 Runnable t2 3 140044840 1 15 Runnable t1 4 140056040 1 15 Delay Sleep t3 15.stages.adb:5 break linespec task taskno break linespec task taskno if .tasking. task switching will work as usual. On Tru64.5 [Thread Stops]. using the command ‘"set . tasking support may be limited or even unavailable..4.. as described in Section 9.activate_tasks () 0x804aacc in un () at un. but task switching is not supported.task_primitives. task # 1 running task # 2 running Breakpoint 5. You can use the task qualifier on conditional breakpoints as well. test_task_debug () at test_task_debug.sleep () 0x806153e in system. (gdb) info tasks ID TID P-ID Pri State Name 1 140022020 0 15 Child Activation Wait main_task 2 140045060 1 15 Accept/Select Wait t2 3 140044840 1 15 Runnable t1 * 4 140056040 1 15 Runnable t3 (gdb) b 15 task 2 Breakpoint 5 at 0x120044cb0: file test_task_debug. linespec specifies source lines. the list of tasks is available. however. place ‘task taskno’ before the breakpoint condition (before the if).8. thread . command (see Section 5.

Chapter 15: Using gdb with Different Languages

187

write on"’ (see Section 17.6 [Patching], page 199). Under these circumstances, you should make a backup copy of the core file before inspecting it with gdb.

15.4.8.7 Tasking Support when using the Ravenscar Profile
The Ravenscar Profile is a subset of the Ada tasking features, specifically designed for systems with safety-critical real-time requirements. set ravenscar task-switching on Allows task switching when debugging a program that uses the Ravenscar Profile. This is the default. set ravenscar task-switching off Turn off task switching when debugging a program that uses the Ravenscar Profile. This is mostly intended to disable the code that adds support for the Ravenscar Profile, in case a bug in either gdb or in the Ravenscar runtime is preventing gdb from working properly. To be effective, this command should be run before the program is started. show ravenscar task-switching Show whether it is possible to switch from task to task in a program using the Ravenscar Profile.

15.4.8.8 Known Peculiarities of Ada Mode
Besides the omissions listed previously (see Section 15.4.8.2 [Omissions from Ada], page 181), we know of several problems with and limitations of Ada mode in gdb, some of which will be fixed with planned future releases of the debugger and the GNU Ada compiler. • Static constants that the compiler chooses not to materialize as objects in storage are invisible to the debugger. • Named parameter associations in function argument lists are ignored (the argument lists are treated as positional). • Many useful library packages are currently invisible to the debugger. • Fixed-point arithmetic, conversions, input, and output is carried out using floatingpoint arithmetic, and may give results that only approximate those on the host machine. • The GNAT compiler never generates the prefix Standard for any of the standard symbols defined by the Ada language. gdb knows about this: it will strip the prefix from names when you use it, and will never look for a name you have so qualified among local symbols, nor match against symbols in other packages or subprograms. If you have defined entities anywhere in your program other than parameters and local variables whose simple names match names in Standard, GNAT’s lack of qualification here can cause confusion. When this happens, you can usually resolve the confusion by qualifying the problematic names with package Standard explicitly. Older versions of the compiler sometimes generate erroneous debugging information, resulting in the debugger incorrectly printing the value of affected entities. In some cases, the debugger is able to work around an issue automatically. In other cases, the debugger is able to work around the issue, but the work-around has to be specifically enabled.

188

Debugging with gdb

set ada trust-PAD-over-XVS on Configure GDB to strictly follow the GNAT encoding when computing the value of Ada entities, particularly when PAD and PAD___XVS types are involved (see ada/exp_dbug.ads in the GCC sources for a complete description of the encoding used by the GNAT compiler). This is the default. set ada trust-PAD-over-XVS off This is related to the encoding using by the GNAT compiler. If gdb sometimes prints the wrong value for certain entities, changing ada trust-PAD-over-XVS to off activates a work-around which may fix the issue. It is always safe to set ada trust-PAD-over-XVS to off, but this incurs a slight performance penalty, so it is recommended to leave this setting to on unless necessary.

15.5 Unsupported Languages
In addition to the other fully-supported programming languages, gdb also provides a pseudo-language, called minimal. It does not represent a real programming language, but provides a set of capabilities close to what the C or assembly languages provide. This should allow most simple operations to be performed while debugging an application that uses a language currently not supported by gdb. If the language is set to auto, gdb will automatically select this language if the current frame corresponds to an unsupported language.

Chapter 16: Examining the Symbol Table

189

16 Examining the Symbol Table
The commands described in this chapter allow you to inquire about the symbols (names of variables, functions and types) defined in your program. This information is inherent in the text of your program and does not change as your program executes. gdb finds it in your program’s symbol table, in the file indicated when you started gdb (see Section 2.1.1 [Choosing Files], page 12), or by one of the file-management commands (see Section 18.1 [Commands to Specify Files], page 201). Occasionally, you may need to refer to symbols that contain unusual characters, which gdb ordinarily treats as word delimiters. The most frequent case is in referring to static variables in other source files (see Section 10.3 [Program Variables], page 99). File names are recorded in object files as debugging symbols, but gdb would ordinarily parse a typical file name, like ‘foo.c’, as the three words ‘foo’ ‘.’ ‘c’. To allow gdb to recognize ‘foo.c’ as a single symbol, enclose it in single quotes; for example,
p ’foo.c’::x

looks up the value of x in the scope of the file ‘foo.c’. set case-sensitive on set case-sensitive off set case-sensitive auto Normally, when gdb looks up symbols, it matches their names with case sensitivity determined by the current source language. Occasionally, you may wish to control that. The command set case-sensitive lets you do that by specifying on for case-sensitive matches or off for case-insensitive ones. If you specify auto, case sensitivity is reset to the default suitable for the source language. The default is case-sensitive matches for all languages except for Fortran, for which the default is case-insensitive matches. show case-sensitive This command shows the current setting of case sensitivity for symbols lookups. info address symbol Describe where the data for symbol is stored. For a register variable, this says which register it is kept in. For a non-register local variable, this prints the stack-frame offset at which the variable is always stored. Note the contrast with ‘print &symbol’, which does not work at all for a register variable, and for a stack local variable prints the exact address of the current instantiation of the variable. info symbol addr Print the name of a symbol which is stored at the address addr. If no symbol is stored exactly at addr, gdb prints the nearest symbol and an offset from it:
(gdb) info symbol 0x54320 _initialize_vx + 396 in section .text

This is the opposite of the info address command. You can use it to find out the name of a variable or a function given its address. For dynamically linked executables, the name of executable or shared library containing the symbol is also printed:

190

Debugging with gdb

(gdb) info symbol 0x400225 _start + 5 in section .text of /tmp/a.out (gdb) info symbol 0x2aaaac2811cf __read_nocancel + 6 in section .text of /usr/lib64/libc.so.6

whatis [arg] Print the data type of arg, which can be either an expression or a name of a data type. With no argument, print the data type of $, the last value in the value history. If arg is an expression (see Section 10.1 [Expressions], page 97), it is not actually evaluated, and any side-effecting operations (such as assignments or function calls) inside it do not take place. If arg is a variable or an expression, whatis prints its literal type as it is used in the source code. If the type was defined using a typedef, whatis will not print the data type underlying the typedef. If the type of the variable or the expression is a compound data type, such as struct or class, whatis never prints their fields or methods. It just prints the struct/class name (a.k.a. its tag). If you want to see the members of such a compound data type, use ptype. If arg is a type name that was defined using typedef, whatis unrolls only one level of that typedef. Unrolling means that whatis will show the underlying type used in the typedef declaration of arg. However, if that underlying type is also a typedef, whatis will not unroll it. For C code, the type names may also have the form ‘class class-name’, ‘struct struct-tag’, ‘union union-tag’ or ‘enum enum-tag’. ptype [arg] ptype accepts the same arguments as whatis, but prints a detailed description of the type, instead of just the name of the type. See Section 10.1 [Expressions], page 97. Contrary to whatis, ptype always unrolls any typedefs in its argument declaration, whether the argument is a variable, expression, or a data type. This means that ptype of a variable or an expression will not print literally its type as present in the source code—use whatis for that. typedefs at the pointer or reference targets are also unrolled. Only typedefs of fields, methods and inner class typedefs of structs, classes and unions are not unrolled even with ptype. For example, for this variable declaration:
typedef double real_t; struct complex { real_t real; double imag; }; typedef struct complex complex_t; complex_t var; real_t *real_pointer_var;

the two commands give this output:

Chapter 16: Examining the Symbol Table

191

(gdb) whatis var type = complex_t (gdb) ptype var type = struct complex { real_t real; double imag; } (gdb) whatis complex_t type = struct complex (gdb) whatis struct complex type = struct complex (gdb) ptype struct complex type = struct complex { real_t real; double imag; } (gdb) whatis real_pointer_var type = real_t * (gdb) ptype real_pointer_var type = double *

As with whatis, using ptype without an argument refers to the type of $, the last value in the value history. Sometimes, programs use opaque data types or incomplete specifications of complex data structure. If the debug information included in the program does not allow gdb to display a full declaration of the data type, it will say ‘<incomplete type>’. For example, given these declarations:
struct foo; struct foo *fooptr;

but no definition for struct foo itself, gdb will say:
(gdb) ptype foo $1 = <incomplete type>

“Incomplete type” is C terminology for data types that are not completely specified. info types regexp info types Print a brief description of all types whose names match the regular expression regexp (or all types in your program, if you supply no argument). Each complete typename is matched as though it were a complete line; thus, ‘i type value’ gives information on all types in your program whose names include the string value, but ‘i type ^value$’ gives information only on types whose complete name is value. This command differs from ptype in two ways: first, like whatis, it does not print a detailed description; second, it lists all source files where a type is defined. info scope location List all the variables local to a particular scope. This command accepts a location argument—a function name, a source line, or an address preceded by a ‘*’, and prints all the variables local to the scope defined by that location. (See Section 9.2 [Specify Location], page 88, for details about supported forms of location.) For example:

192

Debugging with gdb

(gdb) info scope command line handler Scope for command_line_handler: Symbol rl is an argument at stack/frame offset 8, length 4. Symbol linebuffer is in static storage at address 0x150a18, length 4. Symbol linelength is in static storage at address 0x150a1c, length 4. Symbol p is a local variable in register $esi, length 4. Symbol p1 is a local variable in register $ebx, length 4. Symbol nline is a local variable in register $edx, length 4. Symbol repeat is a local variable at frame offset -8, length 4.

This command is especially useful for determining what data to collect during a trace experiment, see Section 13.1.6 [Tracepoint Actions], page 144. info source Show information about the current source file—that is, the source file for the function containing the current point of execution: • the name of the source file, and the directory containing it, • the directory it was compiled in, • its length, in lines, • which programming language it is written in, • whether the executable includes debugging information for that file, and if so, what format the information is in (e.g., STABS, Dwarf 2, etc.), and • whether the debugging information includes information about preprocessor macros. info sources Print the names of all source files in your program for which there is debugging information, organized into two lists: files whose symbols have already been read, and files whose symbols will be read when needed. info functions Print the names and data types of all defined functions. info functions regexp Print the names and data types of all defined functions whose names contain a match for regular expression regexp. Thus, ‘info fun step’ finds all functions whose names include step; ‘info fun ^step’ finds those whose names start with step. If a function name contains characters that conflict with the regular expression language (e.g. ‘operator*()’), they may be quoted with a backslash. info variables Print the names and data types of all variables that are defined outside of functions (i.e. excluding local variables). info variables regexp Print the names and data types of all variables (except for local variables) whose names contain a match for regular expression regexp. info classes info classes regexp Display all Objective-C classes in your program, or (with the regexp argument) all those matching a particular regular expression.

Chapter 16: Examining the Symbol Table

193

info selectors info selectors regexp Display all Objective-C selectors in your program, or (with the regexp argument) all those matching a particular regular expression. Some systems allow individual object files that make up your program to be replaced without stopping and restarting your program. For example, in VxWorks you can simply recompile a defective object file and keep on running. If you are running on one of these systems, you can allow gdb to reload the symbols for automatically relinked modules: set symbol-reloading on Replace symbol definitions for the corresponding source file when an object file with a particular name is seen again. set symbol-reloading off Do not replace symbol definitions when encountering object files of the same name more than once. This is the default state; if you are not running on a system that permits automatic relinking of modules, you should leave symbol-reloading off, since otherwise gdb may discard symbols when linking large programs, that may contain several modules (from different directories or libraries) with the same name. show symbol-reloading Show the current on or off setting. set opaque-type-resolution on Tell gdb to resolve opaque types. An opaque type is a type declared as a pointer to a struct, class, or union—for example, struct MyType *—that is used in one source file although the full declaration of struct MyType is in another source file. The default is on. A change in the setting of this subcommand will not take effect until the next time symbols for a file are loaded. set opaque-type-resolution off Tell gdb not to resolve opaque types. In this case, the type is printed as follows:
{<no data fields>}

show opaque-type-resolution Show whether opaque types are resolved or not. maint print symbols filename maint print psymbols filename maint print msymbols filename Write a dump of debugging symbol data into the file filename. These commands are used to debug the gdb symbol-reading code. Only symbols with debugging data are included. If you use ‘maint print symbols’, gdb includes all the symbols for which it has already collected full details: that is, filename reflects symbols for only those files whose symbols gdb has read. You can use the command info sources to find out which files these are. If you use ‘maint

194

Debugging with gdb

print psymbols’ instead, the dump shows information about symbols that gdb only knows partially—that is, symbols defined in files that gdb has skimmed, but not yet read completely. Finally, ‘maint print msymbols’ dumps just the minimal symbol information required for each object file from which gdb has read some symbols. See Section 18.1 [Commands to Specify Files], page 201, for a discussion of how gdb reads symbols (in the description of symbol-file). maint info symtabs [ regexp ] maint info psymtabs [ regexp ] List the struct symtab or struct partial_symtab structures whose names match regexp. If regexp is not given, list them all. The output includes expressions which you can copy into a gdb debugging this one to examine a particular structure in more detail. For example:
(gdb) maint info psymtabs dwarf2read { objfile /home/gnu/build/gdb/gdb ((struct objfile *) 0x82e69d0) { psymtab /home/gnu/src/gdb/dwarf2read.c ((struct partial_symtab *) 0x8474b10) readin no fullname (null) text addresses 0x814d3c8 -- 0x8158074 globals (* (struct partial_symbol **) 0x8507a08 @ 9) statics (* (struct partial_symbol **) 0x40e95b78 @ 2882) dependencies (none) } } (gdb) maint info symtabs (gdb)

We see that there is one partial symbol table whose filename contains the string ‘dwarf2read’, belonging to the ‘gdb’ executable; and we see that gdb has not read in any symtabs yet at all. If we set a breakpoint on a function, that will cause gdb to read the symtab for the compilation unit containing that function:
(gdb) break dwarf2_psymtab_to_symtab Breakpoint 1 at 0x814e5da: file /home/gnu/src/gdb/dwarf2read.c, line 1574. (gdb) maint info symtabs { objfile /home/gnu/build/gdb/gdb ((struct objfile *) 0x82e69d0) { symtab /home/gnu/src/gdb/dwarf2read.c ((struct symtab *) 0x86c1f38) dirname (null) fullname (null) blockvector ((struct blockvector *) 0x86c1bd0) (primary) linetable ((struct linetable *) 0x8370fa0) debugformat DWARF 2 } } (gdb)

Chapter 17: Altering Execution

195

17 Altering Execution
Once you think you have found an error in your program, you might want to find out for certain whether correcting the apparent error would lead to correct results in the rest of the run. You can find the answer by experiment, using the gdb features for altering execution of the program. For example, you can store new values into variables or memory locations, give your program a signal, restart it at a different address, or even return prematurely from a function.

17.1 Assignment to Variables
To alter the value of a variable, evaluate an assignment expression. See Section 10.1 [Expressions], page 97. For example,
print x=4

stores the value 4 into the variable x, and then prints the value of the assignment expression (which is 4). See Chapter 15 [Using gdb with Different Languages], page 161, for more information on operators in supported languages. If you are not interested in seeing the value of the assignment, use the set command instead of the print command. set is really the same as print except that the expression’s value is not printed and is not put in the value history (see Section 10.10 [Value History], page 116). The expression is evaluated only for its effects. If the beginning of the argument string of the set command appears identical to a set subcommand, use the set variable command instead of just set. This command is identical to set except for its lack of subcommands. For example, if your program has a variable width, you get an error if you try to set a new value with just ‘set width=13’, because gdb has the command set width:
(gdb) whatis width type = double (gdb) p width $4 = 13 (gdb) set width=47 Invalid syntax in expression.

The invalid expression, of course, is ‘=47’. In order to actually set the program’s variable width, use
(gdb) set var width=47

Because the set command has many subcommands that can conflict with the names of program variables, it is a good idea to use the set variable command instead of just set. For example, if your program has a variable g, you run into problems if you try to set a new value with just ‘set g=4’, because gdb has the command set gnutarget, abbreviated set g:

196

Debugging with gdb

(gdb) whatis g type = double (gdb) p g $1 = 1 (gdb) set g=4 (gdb) p g $2 = 1 (gdb) r The program being debugged has been started already. Start it from the beginning? (y or n) y Starting program: /home/smith/cc_progs/a.out "/home/smith/cc_progs/a.out": can’t open to read symbols: Invalid bfd target. (gdb) show g The current BFD target is "=4".

The program variable g did not change, and you silently set the gnutarget to an invalid value. In order to set the variable g, use
(gdb) set var g=4

gdb allows more implicit conversions in assignments than C; you can freely store an integer value into a pointer variable or vice versa, and you can convert any structure to any other structure that is the same length or shorter. To store values into arbitrary places in memory, use the ‘{...}’ construct to generate a value of specified type at a specified address (see Section 10.1 [Expressions], page 97). For example, {int}0x83040 refers to memory location 0x83040 as an integer (which implies a certain size and representation in memory), and
set {int}0x83040 = 4

stores the value 4 into that memory location.

17.2 Continuing at a Different Address
Ordinarily, when you continue your program, you do so at the place where it stopped, with the continue command. You can instead continue at an address of your own choosing, with the following commands: jump linespec jump location Resume execution at line linespec or at address given by location. Execution stops again immediately if there is a breakpoint there. See Section 9.2 [Specify Location], page 88, for a description of the different forms of linespec and location. It is common practice to use the tbreak command in conjunction with jump. See Section 5.1.1 [Setting Breakpoints], page 44. The jump command does not change the current stack frame, or the stack pointer, or the contents of any memory location or any register other than the program counter. If line linespec is in a different function from the one currently executing, the results may be bizarre if the two functions expect different patterns of arguments or of local variables. For this reason, the jump command requests confirmation if the specified line is not in the function currently executing. However, even bizarre results are predictable if you are well acquainted with the machine-language code of your program.

Chapter 17: Altering Execution

197

On many systems, you can get much the same effect as the jump command by storing a new value into the register $pc. The difference is that this does not start your program running; it only changes the address of where it will run when you continue. For example,
set $pc = 0x485

makes the next continue command or stepping command execute at address 0x485, rather than at the address where your program stopped. See Section 5.2 [Continuing and Stepping], page 61. The most common occasion to use the jump command is to back up—perhaps with more breakpoints set—over a portion of a program that has already executed, in order to examine its execution in more detail.

17.3 Giving your Program a Signal
signal signal Resume execution where your program stopped, but immediately give it the signal signal. signal can be the name or the number of a signal. For example, on many systems signal 2 and signal SIGINT are both ways of sending an interrupt signal. Alternatively, if signal is zero, continue execution without giving a signal. This is useful when your program stopped on account of a signal and would ordinary see the signal when resumed with the continue command; ‘signal 0’ causes it to resume without a signal. signal does not repeat when you press RET a second time after executing the command. Invoking the signal command is not the same as invoking the kill utility from the shell. Sending a signal with kill causes gdb to decide what to do with the signal depending on the signal handling tables (see Section 5.4 [Signals], page 66). The signal command passes the signal directly to your program.

17.4 Returning from a Function
return return expression You can cancel execution of a function call with the return command. If you give an expression argument, its value is used as the function’s return value. When you use return, gdb discards the selected stack frame (and all frames within it). You can think of this as making the discarded frame return prematurely. If you wish to specify a value to be returned, give that value as the argument to return. This pops the selected stack frame (see Section 8.3 [Selecting a Frame], page 84), and any other frames inside of it, leaving its caller as the innermost remaining frame. That frame becomes selected. The specified value is stored in the registers used for returning values of functions. The return command does not resume execution; it leaves the program stopped in the state that would exist if the function had just returned. In contrast, the finish command

198

Debugging with gdb

(see Section 5.2 [Continuing and Stepping], page 61) resumes execution until the selected stack frame returns naturally. gdb needs to know how the expression argument should be set for the inferior. The concrete registers assignment depends on the OS ABI and the type being returned by the selected stack frame. For example it is common for OS ABI to return floating point values in FPU registers while integer values in CPU registers. Still some ABIs return even floating point values in CPU registers. Larger integer widths (such as long long int) also have specific placement rules. gdb already knows the OS ABI from its current target so it needs to find out also the type being returned to make the assignment into the right register(s). Normally, the selected stack frame has debug info. gdb will always use the debug info instead of the implicit type of expression when the debug info is available. For example, if you type return -1, and the function in the current stack frame is declared to return a long long int, gdb transparently converts the implicit int value of -1 into a long long int:
Breakpoint 1, func () at gdb.base/return-nodebug.c:29 29 return 31; (gdb) return -1 Make func return now? (y or n) y #0 0x004004f6 in main () at gdb.base/return-nodebug.c:43 43 printf ("result=%lld\n", func ()); (gdb)

However, if the selected stack frame does not have a debug info, e.g., if the function was compiled without debug info, gdb has to find out the type to return from user. Specifying a different type by mistake may set the value in different inferior registers than the caller code expects. For example, typing return -1 with its implicit type int would set only a part of a long long int result for a debug info less function (on 32-bit architectures). Therefore the user is required to specify the return type by an appropriate cast explicitly:
Breakpoint 2, 0x0040050b in func () (gdb) return -1 Return value type not available for selected stack frame. Please use an explicit cast of the value to return. (gdb) return (long long int) -1 Make selected stack frame return now? (y or n) y #0 0x00400526 in main () (gdb)

17.5 Calling Program Functions
print expr Evaluate the expression expr and display the resulting value. expr may include calls to functions in the program being debugged. call expr Evaluate the expression expr without displaying void returned values. You can use this variant of the print command if you want to execute a function from your program that does not return anything (a.k.a. a void function), but without cluttering the output with void returned values that gdb will otherwise print. If the result is not void, it is printed and saved in the value history.

If you’d like to be able to patch the binary. If set to on (the default). gdb opens executable and core files for both reading and writing. GDB builds a dummy-frame for the inferior function call. and the unwinder cannot seek for exception handlers outside of this dummy-frame. show unwind-on-terminating-exception Show the current setting of stack unwinding in the functions called by gdb. but left unhandled while in a function that gdb called in the program being debugged. A solution to that is to use the name of the aliased function instead. gdb opens the file containing your program’s executable code (or the corefile) read-only. gdb unwinds the stack it created for the call and restores the context to what it was before the call. you can specify that explicitly with the set write command. In such case. gdb stops in the frame where the signal was received. In this case. Similarly. which causes gdb to call the inferior function incorrectly.6 Patching Programs By default. If set to off (the default). any exception that is raised in the frame. For example. if you specify set write off (the default). If set to off. but it also prevents you from intentionally patching your program’s binary. a function you wish to call is actually a weak alias for another function. . if there’s a bug in the function. What happens in that case is controlled by the set unwind-on-terminating-exception command. but has an out-of-frame exception handler will not be found. show unwindonsignal Show the current setting of stack unwinding in the functions called by gdb. 17. the called function will function erroneously and may even crash.g. set unwind-on-terminating-exception Set unwinding of the stack if a C++ exception is raised. or even to make emergency repairs. gdb unwinds the stack it created for the call and restores the context to what it was before the call.Chapter 17: Altering Execution 199 It is possible for the function you call via the print or call command to generate a signal (e. Sometimes. including the types of the function arguments. gdb the exception is delivered to the default C++ exception handler and the inferior terminated. What happens in that case is controlled by the set unwindonsignal command. you might want to turn on internal debugging flags. As a result. gdb opens them read-only. set write on set write off If you specify ‘set write on’.. If set to on. set unwindonsignal Set unwinding of the stack if a signal is received while in a function that gdb called in the program being debugged. gdb might not pick up the type information. or if you passed it incorrect arguments). with a C++ program it is possible for the function you call via the print or call command to generate an exception that is not handled due to the constraints of the dummy frame. This prevents accidental alterations to machine code.

show write Display whether executable files and core files are opened for writing as well as reading. you must load it again (using the exec-file or core-file command) after changing set write.200 Debugging with gdb If you have already loaded a file. for your new setting to take effect. .

symbol-file [ filename ] Read symbol table information from file filename. gdb uses the environment variable PATH as a list of directories to search. exec-file [ filename ] Specify that the program to be run (but not the symbol table) is found in filename. Omitting filename means to discard information on the executable file. you could use gdb -write to patch object files using this technique. If you do not specify a directory and the file is not found in the gdb working directory. just as the shell does when looking for a program to run. for both gdb and your program.Chapter 18: gdb Files 201 18 gdb Files gdb needs to know the file name of the program to be debugged. Also. Or you may run gdb and forget to specify a file you want to use. This is because they may contain pointers . if the underlying BFD functionality supports it.o’ files into gdb using the file command. You will not be able to “run” an object file.1 Commands to Specify Files You may want to specify executable and core dump file names. To debug a core dump of a previous run. gdb searches the environment variable PATH if necessary to locate your program.3 [Using the gdbserver Program]. In these situations the gdb commands to specify new files are useful. both in order to read its symbol table and in order to start your program. you must also tell gdb the name of the core dump file. Or you are debugging a remote target via gdbserver (see Section 20. You can change the value of this variable. but you can disassemble functions and inspect variables. so branches and some initialized variables will appear to go to the wrong place. It is read for its symbols and for the contents of pure memory. Use the file command to get both symbol table and program to run from the same file. The symbol-file command causes gdb to forget the contents of some breakpoints and auto-display expressions. using the path command. Occasionally it is necessary to change to a different file during a gdb session. 18. You can load unlinked object ‘. file filename Use filename as the program to be debugged. It is also the program executed when you use the run command. PATH is searched when necessary. page 221). The usual way to do this is at start-up time. symbol-file with no argument clears out gdb information on your program’s symbol table. using the arguments to gdb’s start-up commands (see Chapter 2 [Getting In and Out of gdb]. file file with no argument makes gdb discard any information it has on both executable file and the symbol table. Note that gdb can neither interpret nor modify relocations in this case. But this feature is still handy from time to time. page 11).

For most kinds of object files.202 Debugging with gdb to the internal data recording symbols and data types. Best results are usually obtained from gnu compilers. you must kill the subprocess in which the program is running. Instead.7 [Optional Warnings and Messages]. The add-symbol-file command reads additional symbol table information from the file filename. page 270. (The set verbose command can turn these pauses into messages if desired. symbol-file reads the symbol table data in full right away. See Section 22. Note that “stabs-in-COFF” still does the two-stage strategy. When the symbol table is stored in COFF format. symbol-file does not repeat if you press RET again after executing it once. Note that the core file is ignored when your program is actually running under gdb. it is invisible except for occasional pauses while the symbol table details for a particular source file are being read. it scans the symbol table quickly to find which source files and which symbols are present. one source file at a time. if you want to be sure gdb has the entire symbol table available.8 [Killing the Child Process]. since the debug info is actually in stabs format. For the most part. as they are needed. core-file [filename] core Specify the whereabouts of a core dump file to be used as the “contents of memory”. with the exception of old SVR3 systems using COFF. for example. When gdb is configured for a particular environment. . To do this. add-symbol-file filename address add-symbol-file filename address [ -readnow ] add-symbol-file filename address -s section address . symbol-file [ -readnow ] filename file [ -readnow ] filename You can override the gdb two-stage strategy for reading symbol tables by using the ‘-readnow’ option with any of the commands that load symbol table information. So. page 32). You would use this command when filename has been dynamically loaded (by some other means) into the program that is running. it understands debugging information in whatever format is the standard generated for that environment. core files contain only some parts of the address space of the process that generated them.. the symbol-file command does not normally read the symbol table in full right away. if you have been running your program and you wish to debug a core file instead. The purpose of this two-stage reading strategy is to make gdb start up faster. The details are read later. using gcc you can generate debugging information for optimized code. or other compilers that adhere to the local conventions. which are part of the old symbol table data being discarded inside gdb. core-file with no argument specifies that no core file is to be used.. use the kill command (see Section 4. you may use either a gnu compiler.) We have not implemented the two-stage strategy for COFF yet. gdb can access the executable file itself for other parts. Traditionally.

to give an explicit section name and base address for that section. For this command to work. can load relocatable files into an already running program.5 [Cygwin Native]. where it is an alias for the dllsymbols command (see Section 21. add-symbol-file does not repeat if you press RET after using it. You can additionally specify an arbitrary number of ‘-s section address’ pairs. gdb automatically looks for shared libraries. use the symbol-file command without any arguments. it’s important to recognize that many native systems use complex link procedures (. • every section the file’s symbolic information refers to has actually been loaded into the inferior. assf is a shorthand alias for add-shared-symbol-files. and • you can determine the address at which every section was loaded. In general. The symbol table of the file filename is added to the symbol table originally read with the symbol-file command. you can also load symbolic information from relocatable ‘.linkonce section factoring and C++ constructor table assembly. It takes one argument: the shared library’s file name. You can specify any address as an expression. However.Chapter 18: gdb Files 203 address should be the memory address at which the file has been loaded. or some other object file which has been fully relocated for loading into a process. add-shared-symbol-files library-file assf library-file The add-shared-symbol-files command can currently be used only in the Cygwin build of gdb on MS-Windows OS. You can use the add-symbol-file command any number of times. gdb cannot figure this out for itself.1. for example) that make the requirements difficult to meet. an executable file. The argument can be any expression whose evaluation yields the address of the file’s shared object file header. however if gdb does not find yours. . Although filename is typically a shared library file. To discard all old symbol data instead. the new symbol data thus read keeps adding to the old. this DSO provides kernel-specific code for some system calls. you can invoke add-shared-symbol-files. Some embedded operating systems. the Linux kernel maps a syscall DSO into each process’s address space. add-symbol-file-from-memory address Load symbols from the given address in a dynamically loaded object file whose image is mapped directly into the inferior’s memory. like Sun Chorus and VxWorks. you must have used symbol-file or exec-file commands in advance. not to symbols defined by other object files. as it appears in the file. one cannot assume that using add-symbol-file to read a relocatable object file’s symbolic information will have the same effect as linking the relocatable object file into the program in the normal way. as long as: • the file’s symbolic information refers only to linker symbols defined in that file. such systems typically make the requirements above easy to meet. page 239). and provide these to the add-symbol-file command. For example.o’ files.

or when the addresses specified in the file itself are wrong. In addition. clear for . (such as in the a. Each section must be changed separately. maint info sections Another command that can give you extra information about program sections is maint info sections. The section flags that gdb currently knows about are: ALLOC Section will have space allocated in the process when loaded. info files info target info files and info target are synonymous. . section-flags Display info only for sections for which section-flags are true. and the files from which symbols were loaded. Section needs to be relocated before loading.bss sections. including shared libraries. Section contains data only (no executable code). The command help target lists all possible targets rather than current ones. lists all the sections and their addresses. LOAD RELOC READONLY CODE DATA ROM CONSTRUCTOR Section contains data for constructor/destructor lists. page 215). The info files command.out format). Section will reside in ROM. described below. Set for pre-initialized code and data. HAS_CONTENTS Section is not empty. In addition to the section information displayed by info files. maint info sections provides the following command options (which may be arbitrarily combined): ALLOBJ sections Display sections for all loaded object files. including the names of the executable and core dump files currently in use by gdb. Display info only for named sections. This can be used if the exec file does not contain section addresses. Section contains executable code only. both print the current target (see Chapter 19 [Specifying a Debugging Target]. Section will be loaded from the file into the child process memory. Section cannot be modified by the child process. this command displays the flags and file offset of each section in the executable and core dump files.204 Debugging with gdb section section addr The section command changes the base address of the named section of the exec file to addr. Set for all sections except those containing debug information.

See [Expat]. gdb automatically loads symbol definitions from shared libraries when you use the run command. If mode is off. and must therefore be fetched from the target when needed. The default value is on. . however. In that case. this can be a significant enhancement to debugging performance. rather than from the target program. set trust-readonly-sections off Tell gdb not to trust readonly sections. using the sharedlibrary command. For some targets (notably embedded ones). gdb supports gnu/Linux. There are times. On MS-Windows gdb must be linked with the Expat library to support shared libraries. set trust-readonly-sections on Tell gdb that readonly sections in your object file really are read-only (i. or when you examine a core file. IS_COMMON Section contains common symbols. show trust-readonly-sections Show the current setting of trusting readonly sections. symbols must be loaded manually. Irix. gdb automatically loads the symbols at the time of the shl_load call. when you may wish to not automatically load symbol definitions from shared libraries. that their contents will not change). page 451. use the commands: set auto-solib-add mode If mode is on. SVr4. such as when they are particularly large or there are many of them. (Before you issue the run command. All file-specifying commands allow both absolute and relative file names as arguments. gdb can fetch values from these sections out of the object file.Chapter 18: gdb Files 205 NEVER_LOAD An instruction to the linker to not output the section. gdb does not understand references to a function in a shared library. This means that the contents of the section might change while the program is running. To control the automatic loading of shared library symbols. however—unless you are debugging a core file). SunOS.e. MS-Windows. COFF_SHARED_LIBRARY A notification to the linker that the section contains COFF shared library information. HP-UX. and IBM RS/6000 AIX shared libraries. symbols from all shared object libraries will be loaded automatically when the inferior begins execution. or when the dynamic linker informs gdb that a new library has been loaded. if the program loads a library explicitly. The default is off. gdb always converts the file name to an absolute file name and remembers it that way. you attach to an independently started inferior. On HP-UX.

nosharedlibrary Unload all shared object library symbols. As with files loaded automatically. To that end. type set auto-solib-add off before running the inferior. sharedlibrary regex share regex Load shared object library symbols for files matching a Unix regular expression.206 Debugging with gdb If your program uses lots of shared libraries with debug info that takes large amounts of memory. Symbols from shared libraries that were loaded by explicit user requests are not discarded. For remote debugging. . you can decrease the gdb memory footprint by preventing it from automatically loading the symbols from shared libraries. If regex is omitted all shared libraries required by your program are loaded. they need to be the same as the target libraries. show stop-on-solib-events Show whether gdb stops and gives you control when shared library events happen. it only loads shared libraries required by your program for a core file or after typing run. so that it can load the correct copies—otherwise. This discards all symbols that have been loaded from all shared libraries. where regexp is a regular expression that matches the libraries whose symbols you want to be loaded. The most common event of interest is loading or unloading of a new shared library. or by asking gdb to automatically retrieve the libraries from the target. this can be accomplished either by providing copies of the libraries on the host system. you need to tell gdb where the target libraries are. Use the set stop-on-solib-events command for this: set stop-on-solib-events This command controls whether gdb should give you control when the dynamic linker notifies it about some shared library event. To explicitly load shared library symbols. use the sharedlibrary command: info share regex info sharedlibrary regex Print the names of the shared libraries which are currently loaded that match regex. Shared libraries are also supported in many cross or remote debugging configurations. If copies of the target libraries are provided. show auto-solib-add Display the current autoloading mode. gdb needs to have access to the target’s libraries. If regex is omitted then print all shared libraries that are loaded. it may try to load the host’s libraries. gdb has two variables to specify the search directories for target libraries. although the copies on the target can be stripped as long as the copies on the host are not. Sometimes you may wish that gdb stops and gives you control when any of shared library events happen. then load each library whose debug symbols you do need with sharedlibrary regexp.

gdb attempts prefixing the target file name with path.2 [Sending files to a remote system]. if you don’t want or need to. If that still does not find the shared library.Chapter 18: gdb Files 207 set sysroot path Use path as the system root for the program being debugged. gdb tries removing the ‘:’ character from the drive spec. for the case of the host file system not supporting file names with colons: c:/foo/bar. If the system root is inside gdb’s configured binary prefix (set with ‘--prefix’ or ‘--exec-prefix’).dll ⇒ /path/to/sysroot/c/foo/bar. because the backslash is not a directory separator on Unix: c:\foo\bar. You can set the default system root by using the configure-time ‘--with-sysroot’ option.dll If that does not find the shared library. If you use set sysroot to find shared libraries.dll This last lookup makes it possible to not care about the drive name.dll ⇒ /path/to/sysroot/c:/foo/bar. gdb tries prefixing a few variants of the target absolute file name with path. both for convenience. Any absolute shared library paths will be prefixed with path.dll ⇒ /path/to/sysroot/foo/bar. The part of path following the initial ‘remote:’ (if present) is used as system root prefix on the remote file system. you may want to setup your local copies of the target system shared libraries like so (note ‘c’ vs ‘z’): ‘/path/to/sysroot/c/sys/bin/foo. . But first. a ‘/lib’ and ‘/usr/lib’ hierarchy under path.dll’. gdb converts all backslash directory separators into forward slashes.dll’ and point the system root at ‘/path/to/sysroot’.dll’ ‘/path/to/sysroot/z/sys/bin/bar. If path starts with the sequence ‘remote:’.dll’.g.. on Unix hosts. 1 If you want to specify a local system root using a directory that happens to be named ‘remote:’.dll Then. gdb tries removing the whole drive spec from the target file name: c:/foo/bar.dll This makes it possible to have a system root that mirrors a target with more than one drive. and ‘z:\sys\bin\bar.g. gdb will retrieve the target libraries from the remote system. page 221). they need to be laid out in the same way that they are on the target. with e. so that gdb can find the correct copies of both ‘c:\sys\bin\foo. and. and looks for the resulting file name in the host file system: c:/foo/bar.dll ⇒ c:/foo/bar. such as MS-Windows and SymbianOS. E. you need to use some equivalent variant of the name like ‘.1 For targets with an MS-DOS based filesystem.dll’ ‘/path/to/sysroot/c/sys/bin/bar. This is only supported when using a remote target that supports the remote get command (see Section 20. The set solib-absolute-prefix command is an alias for set sysroot. then the default system root will be updated automatically if the installed gdb is moved to a new location./remote:’. many runtime loaders store the absolute paths to the shared library in the target program’s memory.

6 [Configuring the Current ABI]. from a Unix host. setting it to a nonexistent directory may interfere with automatic loading of shared library symbols. show solib-search-path Display the current shared library search path. File names starting with either a forward slash. and neither is the backslash normally considered a directory separator character.6 [Configuring the Current ABI]. in addition to one of the supported file system kinds. ‘c:’). path is a colon-separated list of directories to search for shared libraries. The supported file system settings are: unix Instruct gdb to assume the target file system is of Unix kind. be sure to set ‘sysroot’ to a nonexistent directory to prevent gdb from finding your host’s libraries. ‘sysroot’ is preferred. Shared library file names as reported by the target system may not make sense as is on the system gdb is running on. This is the default. and impractical with set solib-search-path. or a drive letter followed by a colon (e. gdb tries to determine the appropriate file system variant based on the current target’s operating system (see Section 22. page 269). dos-based . and both the slash (‘/’) and the backslash (‘\\’) characters are considered directory separators. This would make it impossible to point gdb at a copy of the remote target’s shared libraries on the host using set sysroot. In that case. Setting target-file-system-kind to dos-based tells gdb to interpret such file names similarly to how the target would.dll’. Instruct gdb to assume the target file system is DOS based. when remote debugging a target that has MS-DOS based file system semantics.208 Debugging with gdb show sysroot Display the current shared library prefix. set solib-search-path path If this variable is set. are considered absolute. auto Instruct gdb to use the file system kind associated with the target operating system (see Section 22. so the ‘c:\’ prefix is not normally understood as indicating an absolute file name. For example. and the directory separator character is also the forward slash. page 269). Only file names starting the forward slash (‘/’) character are considered absolute. and to map them to file names valid on gdb’s native file system semantics. If you want to use ‘solib-search-path’ instead of ‘sysroot’. the native file system would interpret this whole absolute file name as a relative file name with no directory components.g.. ‘solib-search-path’ is used after ‘sysroot’ fails to locate the library. the target may be reporting to gdb a list of loaded shared libraries with file names such as ‘c:\Windows\kernel32. there’s no concept of drive letters. set target-file-system-kind kind Set assumed file system kind for target reported file names. The value of kind can be "auto". In that case. or if the path to the library is relative instead of absolute. On Unix hosts.

then in a subdirectory of that directory named ‘. set basenames-may-differ Set whether a source file may have multiple base names.Chapter 18: gdb Files 209 When processing file names provided by the user. gdb frequently needs to compare them to the file names recorded in the program’s debug info..g. see below. This is usually true. gdb uses two different methods of looking for the debug file: • For the “debug link” method. The separate debug file’s name is usually ‘executable. but references to files that use symlinks or similar filesystem facilities violate that assumption.debug’.debug’ for ‘/usr/bin/ls’). in a subdirectory whose name is identical to the leading directories of the executable’s absolute file name. a unique bit string that is also present in the corresponding debug info file. you can set basenames-may-differ to true to instruct gdb to completely canonicalize each pair of file names it needs to compare.. 18. but can be computed from the build ID. after stripping all the leading directories. where nn are the first 2 hex . If your program records files using such facilities. Depending on the way the debug info file is specified. • The executable contains a build ID. notably those which use the ELF format for binary files and the gnu Binutils. which is reasonably fast even for very large programs. (This is supported only on some operating systems. (The base name of a file is the last portion of its name. and finally under the global debug directory. The debug info file’s name is not specified explicitly by the build ID. where executable is the name of the corresponding executable file without leading directories (e.debug’. which users can install only when they need to debug a problem. the debug link specifies a 32-bit Cyclic Redundancy Check (CRC) checksum for the debug file. see the description of the ‘--build-id’ command-line option in Section “Command Line Options” in The GNU Linker. gdb looks up the named file in the directory of the executable file. This will make file-name comparisons accurate. which gdb uses to validate that the executable and the debug file came from the same build. Normally.) This shortcut in comparison is based upon the assumption that files cannot have more than one base name. gdb looks in the ‘. in a way that allows gdb to find and load the debugging information automatically. ‘ls.) For more details about this feature. or if you provide file names to gdb using symlinks etc.2 Debugging Information in Separate Files gdb allows you to put a program’s debugging information in a file separate from the executable itself. In addition.build-id’ subdirectory of the global debug directory for a file named ‘nn/nnnnnnnn. show basenames-may-differ Show whether a source file may have multiple base names.debug’. gdb supports two ways of specifying the separate debug info file: • The executable contains a debug link that specifies the name of the separate debug info file. Since debugging information can be very large—sometimes larger than the executable code itself—some systems distribute debugging information for their executables in separate files. • For the “build ID” method. gdb compares just the base names of the files as strings. but at a price of a significant slowdown.

containing a full set of linker symbols.build-id.debug’. and • a four-byte CRC checksum. • zero to three bytes of padding. sections.gnu_debuglink with the contents described above. You can set the global debugging info directory’s name. and a build ID whose value in hex is abcdef1234. and in the separate debugging information file. as long as it can contain a section named . The checksum is computed on the debugging information file’s full contents by the function given below.gnu_debuglink.debug’. not 10. The default algorithm SHA1 produces 160 bits (40 hexadecimal characters) of the content for the build ID string. and sizes as the original file. show debug-file-directory Show the directories gdb searches for separate debugging information files. A debug link is a special section of the executable file named . suppose you ask gdb to debug ‘/usr/bin/ls’. then gdb will look for the following debug information files. followed by a zero byte.debug’ − ‘/usr/bin/ls. as needed to reach the next four-byte boundary within the section. The build ID is a special section in the executable file (and in other ELF binary files that gdb may consider).build-id/ab/cdef1234.gnu. passing zero as the crc argument. and debugging information. Multiple directory components can be set concatenating them by a directory separator. for example. This section is often named . but they need not contain any data—much like a . If the global debug directory is ‘/usr/lib/debug’.note. and view the name gdb is currently using. but that name is not mandatory.) So.debug/ls. The sections of the debugging information file should have the same names. set debug-file-directory directories Set the directories which gdb searches for separate debugging information files to directory. The debugging information file itself should be an ordinary executable. addresses.210 Debugging with gdb characters of the build ID bit string.debug’ − ‘/usr/bin/. It contains unique identification for the built files—the ID remains the same across multiple builds of the same build tree. which has a debug link that specifies the file ‘ls.debug’ − ‘/usr/lib/debug/usr/bin/ls. stored in the same endianness used for the executable file itself. in the indicated order: − ‘/usr/lib/debug/. (Real build ID strings are 32 or more hex characters. The section must contain: • A filename. in its stripped variant.bss section in an ordinary executable. The same section with an identical value is present in the original built binary with symbols. with any leading directory components removed. The gnu binary utilities (Binutils) package includes the ‘objcopy’ utility that can produce the separated executable / debugging information file pairs using the following commands: . and nnnnnnnn are the rest of the bit string. Any executable file format can carry a debug link.

0x26d930ac. 0x71b18589. • Build ID gets embedded into the main executable using ld --build-id or the gcc counterpart gcc -Wl.debug strip -g foo These commands remove the debugging information from the executable file ‘foo’ and place it in the file ‘foo. 0xd56041e4. 0x77073096. 0xa2677172.gnu_debuglink.18. 0xacbcf940. Inverting the initially supplied crc argument means that an initial call to this function passing in zero will start computing the CRC using 0xffffffff. 0x63066cd9. together. 0x90bf1d91. The initial pattern 0xffffffff is used. 0xe8b8d433. 0x1db71064. 0x2f6f7c87. 0xd20d85fd. 0x76dc4190. 0x646ba8c0. 0x21b4f4b5. 0x0edb8832. unsigned char *buf. 0x14015c4f. . 0x58684c11. Build ID support plus compatibility fixes for debug files separation are present in gnu binary utilities (Binutils) package since version 2. You can use the first. 0x9fbfe4a5. 0x8d080df5. 0x136c9856. 0x56b3c423. 0x4b04d447. 0x42b2986c. starting with version 0. 0xb6662d3d. 0xc1611dab. 0x5f058808. However in the case of the Remote Serial Protocol. unsigned long gnu_debuglink_crc32 (unsigned long crc. 0x2802b89e.3 using the polynomial: x32 + x26 + x23 + x22 + x16 + x12 + x11 + x10 + x8 + x7 + x5 + x4 + x2 + x + 1 The function is computed byte at a time. 0x06b6b51f. page 465).debug has the same functionality as the two objcopy commands and the ln -s command above. 0x35b5a8fa. 0xf4d4b551.gnu_debuglink is the CRC-32 defined in IEEE 802. 0xb10be924. 0x3b6e20c8.debug foo Ulrich Drepper’s ‘elfutils’ package. 0xc60cd9b2. 0xa50ab56b. 0xdcd60dcf. 0x98d220bc. 0x09b64c2b.53. 0x1adad47d. 0x97d2d988. 0xb8bda50f. 0xe963a535.--build-id. 0xf3b97148. 0x990951ba. 0x4c69105e. 0xabd13d59. 0x706af48f. to ensure leading zeros affect the CRC and the final result is inverted to ensure trailing zeros also affect the CRC.debug’. taking the least significant bit of each byte first. 0xe7b82d07. 0x84be41de. 0x076dc419. 0x79dcb8a4. 0x6ab020f2. 0xfa0f3d63. 0x9e6495a3. 0xfd62f97a. 0x9609a88e. 0xdbbbc9d6. 0xc8d75180. 0x51de003a. 0x01db7106. 0x45df5c75. Note: This is the same CRC polynomial as used in handling the Remote Serial Protocol qCRC packet (see Appendix E [gdb Remote Serial Protocol]. 0xee0e612c. 0xbfd06116. 0x83d385c7. 0xe0d5e91e. and the result is not inverted. the CRC is computed most significant bit first. so trailing zeros have no effect on the CRC value. 0x7807c9a2. we show below the code of the function which produces the CRC used in . 0x7eb17cbd. To complete the description. 0x8a65c9ec. size_t len) { static const unsigned long crc32_table[256] = { 0x00000000. contains a version of the strip command such that the command strip foo -f foo. second or both methods to link the two files: • The debug link method needs the following additional command to also leave behind a debug link in ‘foo’: objcopy --add-gnu-debuglink=foo. The CRC used in . 0x6ddde4eb. 0x0f00f934.Chapter 18: gdb Files 211 objcopy --only-keep-debug foo foo. 0xcfba9599. 0xefd5102a. 0x3c03e4d1. 0x32d86ce3.

0xad678846. 0xb0d09822. 0xcb61b38c. 0xb40bbe37. 0x3903b3c2. 0x0d6d6a3e. 0xaed16a4a. 0xbb0b4703. 0x67dd4acc. 0xbdbdf21c. 0xf862ae69. 0xa6bc5767. 0xf1d4e242. 0x92d28e9b. 0x40df0b66. 0x5268e236. 0xbc66831a. 0xd9d65adc. 0x0a00ae27. 0x5bdeae1d. 0x1e01f268. 0xda60b8d0. 0x36034af6. 0xa00ae278. 0x8cd37cf3. 0xfbd44c65. 0x2eb40d81. 0xc30c8ea1. 0x17b7be43. 0x7d079eb1. 0x44042d73. For large programs. 0x24b4a3a6. 0x74b1d29a. 0xedb88320. 0x1fda836e. 0xa9bcae53. so gdb provides a way to build an index. 0x206f85b3. 0xe40ecf0b. 0x026d930a. 0x91646c97. 0x1b01a57b. 0x256fd2a0. 0x7a6a5aa8. for (end = buf + len. 0x30b5ffe9. 0x54de5729. 0x3ab551ce.3 Index Files Speed Up gdb When gdb finds a symbol file. 0xc7d7a8b4. 0xf6b9265b. 0x5d681b02. 0xfcb9887c. 0xff0f6a70. 0x2bb45a92. 0x2a6f2b94. 0xa3bc0074. 0x856530d8. 0xd6d6a3e8. 0xb5d0cf31. 0x2d02ef8d }. 0x0cb61b38. 0xbad03605. 0xcdd70693. 0x346ed9fc. 0x1c6c6162. 0x5005713c. 0x3dd895d7. 0x48b2364b. 0x62dd1ddf. 0xf762575d. 0xec63f226. 0x196c3671. 0xe5d5be0d. 0x73dc1683. 0x9abfb3b6. buf < end. 0xaf0a1b4c. 0x6fb077e1. 0x9c0906a9. 0xd4bb30e2. 0x6b6b51f4. 0xb3667a2e. then you can put it into the symbol file using objcopy. } This computation does not apply to the “build ID” method. 0x6e6b06e7. 0xb7bd5c3b. 0x12b7e950. 0x53b39330. 18. 0x8ebeeff9. return ~crc & 0xffffffff. 0xf262004e. 0x270241aa. it scans the symbols in the file in order to construct an internal symbol table. 0xdebb9ec5. 0x616bffd3. 0x9b64c2b0. 0xf50fc457. 0xc4614ab8. 0x756aa39c. 0xf9b9df6f. 0xce61e49f. 0xe6635c01. 0x3e6e77db. 0xeb0e363f. 0xa1d1937e. gdb can write the index to a file. 0x086d3d2d. 0x6c0695ed. 0x7cdcefb7. 0x72076785. crc = ~crc & 0xffffffff. 0xcc0c7795. unsigned char *end. ++buf) crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8). 0x8f659eff. 0x9309ff9d. 0x23d967bf. 0x04db2615. 0x6906c2fe. 0x7bb12bae. 0x88085ae6. 0x3fb506dd. 0x11010b5c. 0x03b6e20c. 0x38d8c2c4. 0x5edef90e. 0x47b2cf7f. 0xc5ba3bbe. 0xd3d6f4fb. 0x806567cb. this delay can be quite lengthy. 0x5a05df1b. 0x66063bca. 0x7f6a0dbb. use the save gdb-index command: . 0x4fdff252. 0x0bdbdf21. 0xa7672661. 0x65b0d9c6. 0x60b08ed5. 0x4e048354. 0x2cd99e8b. 0xd70dd2ee. 0x95bf4a82. 0x4669be79. 0xd80d2bda. 0x5505262f. 0xb966d409. 0x8bbeb8ea. 0x4969474d. 0xcabac28a. 0x9dd277af. 0x316e8eef. 0x29d9c998. 0x220216b9. 0x18b74777. 0xc90c2086. 0x4adfa541. 0x05005713. 0xd06016f7. 0xdf60efc3. 0x37d83bf0. 0x86d3d2d4. 0x41047a60. 0x15da2d49. 0xc2d7ffa7. 0x4369e96a. 0x68ddb3f8. 0x89d32be0. 0xdd0d7cc9. 0x59b33d17. 0xbe0b1010.212 Debugging with gdb 0xe10e9818. 0xe2b87a14. 0x33031de5. 0x5cb36a04. 0xaa0a4c5f. 0xd1bb67f1. 0xa867df55. 0xc0ba6cad. 0xf00f9344. 0x4db26158. 0x8208f4c1. 0x5768b525. 0x166ccf45. 0x10da7a5a. To create an index file. 0xb2bd0b28. 0xead54739. The index is stored as a section in the symbol file. 0xa4d1c46d. This lets most gdb operations work quickly—at the cost of a delay early on. which speeds up startup. 0x94643b84. 0x81be16cd. 0x8708a3d2. 0xfed41b76. 0xe3630b12.

Chapter 18: gdb Files 213 save gdb-index directory Create an index file for each symbol file currently known by gdb. They only work when for DWARF debugging information. 18.gdb_index=readonly symfile symfile There are currently some limitation on indices. This is known to occur in the SunOS 4. or you can ask gdb to print more messages. gdb circumvents the problem by treating the inner block as if it had the same scope as the outer block. And. using objcopy: $ objcopy --add-section .4 Errors Reading Symbol Files While reading a symbol file. gdb circumvents the problem by treating the symbol scope block as starting on the previous source line. and has trouble locating symbols in the source file whose symbols it is reading. This error indicates that an inner scope block is not fully contained in its outer scope blocks. since they are relatively common and primarily of interest to people debugging compilers. and their meanings.1. block at address out of order The symbol information for symbol scope blocks should occur in order of increasing addresses. Once you have created an index file you can merge it into your symbol file. you can either ask gdb to print only one message about each such type of problem. they do not currently work for programs using Ada. . By default. Each file is named after its corresponding symbol file.7 [Optional Warnings and Messages]. In the error message.1 (and earlier) C compiler. symbol may be shown as “(don’t know)” if the outer block is not a function. This error indicates that it does not do so. such as symbol types it does not recognize. gdb does not circumvent this problem. page 270.gdb_index=symfile. or known bugs in compiler output. gdb does not notify you of such problems. See Section 22. include: inner block not inside outer block in symbol The symbol information shows where symbol scopes begin and end (such as at the start of a function or a block of statements).gdb-index \ --set-section-flags . If you are interested in seeing information about ill-constructed symbol tables. gdb occasionally encounters problems.gdb-index’ appended. here named ‘symfile’. to see how many times the problems occur. with ‘. (You can often determine what source file is affected by specifying set verbose on. with the set complaints command (see Section 22. page 270).) bad block start address patched The symbol information for a symbol scope block has a start address smaller than the address of the preceding source line. no matter how many times the problem occurs.7 [Optional Warnings and Messages]. and is written into the given directory. not stabs. The messages currently printed.

unknown symbol type 0xnn The symbol information contains new data types that gdb does not yet know how to read. You can set the data directory’s name. If the data directory is inside gdb’s configured binary prefix (set with ‘--prefix’ or ‘--exec-prefix’). gdb circumvents the error by ignoring this symbol information. gdb circumvents the problem by considering the symbol to have the name foo. The data directory may also be specified with the --data-directory command line option. const/volatile indicator missing (ok if using g++ v1.. though certain symbols are not accessible. page 13. and view the name gdb is currently using.5 GDB Data Files gdb will sometimes read an auxiliary data file. set data-directory directory Set the directory which gdb searches for auxiliary data files to directory. then go up to the function read_dbx_symtab and examine *bufp to see the symbol. breakpoint on complain. You can set the default data directory by using the configure-time ‘--with-gdb-datadir’ option. This usually allows you to debug your program. See Section 2.2 [Mode Options].1. which may cause other problems if many symbols end up with this name. got. you can debug gdb with itself. info mismatch between compiler and debugger gdb could not parse a type specification output by the compiler. in hexadecimal. then the default data directory will be updated automatically if the installed gdb is moved to a new location.214 Debugging with gdb bad string table offset in symbol n Symbol number n contains a pointer into the string table which is larger than the size of the string table. If you encounter such a problem and feel like debugging it. The symbol information for a C++ member function is missing some information that recent versions of the compiler should have output for it. stub type has NULL name gdb could not find the full definition for a struct or class. 0xnn is the symbol type of the uncomprehended information. These files are kept in a directory known as the data directory.. show data-directory Show the directory gdb searches for auxiliary data files. . 18.x).

one in each class. Core files belong to the process class. Often. When gdb is built like that. gdb can work concurrently on multiple active targets. This allows you to (for example) start a process and inspect its activity. show architecture Show the current target architecture. You use the argument type to specify the type or protocol of the target machine. you are presented a virtual layer of the recording target. page 31). in addition to one of the supported architectures. To specify as a target a process that is already running. Or if you start process recording (see Chapter 6 [Reverse Execution]. set architecture arch This command sets the current target architecture to arch. use the attach command (see Section 4. respectively.Chapter 19: Specifying a Debugging Target 215 19 Specifying a Debugging Target A target is the execution environment occupied by your program.2 [Commands for Managing Targets]. When you need more flexibility—for example. running gdb on a physically separate host. executable files or recording sessions.7 [Debugging an Already-running Process].2 Commands for Managing Targets target type parameters Connects the gdb host environment to a target machine or process. but typically include things like device names or host names to connect with. process numbers. 19. 19. page 201). Use the core-file and exec-file commands to select a new core file or executable target (see Section 18. page 75) and reverse-step there. The value of arch can be "auto".1 [Commands to Specify Files]. It is possible to build gdb for several different target architectures. set architecture and show architecture. gdb runs in the same host environment as your program. page 215). in that case. or controlling a standalone system over a serial port or a realtime system over a TCP/IP connection—you can use the target command to specify one of the target types configured for gdb (see Section 19. Further parameters are interpreted by the target protocol. and baud rates. A target is typically a protocol for talking to debugging facilities. while still having access to the executable file after the process finishes. . the debugging target is specified as a side effect when you use the file or core commands. while the process target remains stopped at the chronologically last point of the process execution. you can choose one of the available architectures with the set architecture command. set processor processor These are alias commands for.1 Active Targets There are multiple classes of targets such as: processes. Otherwise. making core file and process mutually exclusive.

. not a machine. you can specify the file format with the set gnutarget command. you must know the actual BFD name. ‘target core filename’ is the same as ‘core-file target remote medium A remote system connected to gdb via a serial line or network connection. In general.1 [Commands to Specify Files]. target sim load . including any parameters necessary to select it. Here are some common targets (available. If you have not set gnutarget. gdb knows whether it is reading an executable. See Chapter 20 [Remote Debugging]. help target Displays the names of all targets available. if you have a board connected to ‘/dev/ttya’ on the machine running gdb. or not. show gnutarget Use the show gnutarget command to display what file format gnutarget is set to read. and show gnutarget displays ‘The current BDF target is "auto"’. set gnutarget args gdb uses its own library BFD to read your files. To display targets currently selected. however. and you can put it somewhere in memory where it won’t get clobbered by the download. you could say: target remote /dev/ttya target remote supports the load command.1 [Commands to Specify Files].216 Debugging with gdb The target command does not repeat if you press RET again after executing the command. Builtin CPU simulator. page 219.. depending on the GDB configuration): target exec program An executable file. page 201).o file. a core. with gnutarget the target refers to a program. filename’. use either info target or info files (see Section 18. See Section 18. Unlike most target commands. This is only useful if you have some other way of getting the stub to the target system. For example. Warning: To specify a file format with set gnutarget. This command tells gdb to use its own remote protocol over medium for debugging. target sim [simargs] . gdb will determine the file format for each file automatically. gdb includes simulators for most architectures. page 201. or a . ‘target exec program’ is the same as ‘exec-file program’. help target name Describe a particular target. target core filename A core dump file.

PowerPC. like a. load filename Depending on what remote debugging facilities are configured into gdb. load does not repeat if you press RET again after using it. attempting to execute it gets the error message “You can’t do that when your target is .Chapter 19: Specifying a Debugging Target 217 run works. or dynamic linking. page 247. for other formats. 19. set hash This command controls whether a hash mark ‘#’ is displayed while downloading a file to the remote monitor. a hash mark is displayed after each S-record is successfully downloaded to the monitor.3 Choosing Target Byte Order Some types of processors. see the appropriate section in Section 21. Some configurations may include these targets as well: target nrom dev NetROM ROM emulator. If on. Different targets are available on different configurations of gdb. set debug monitor Enable or disable display of communications messages between gdb and the remote monitor. Depending on the remote side capabilities. however. like the add-symbol-file command. This target only supports downloading. offer the ability to run either big-endian or little-endian byte orders. For some object file formats.3 [Embedded Processors]. or even basic I/O is available. If your gdb does not have a load command. for example.out.” The file is loaded at whatever address is specified in the executable. your configuration may have more or fewer targets. Many remote targets require you to download the executable’s code once you’ve successfully established a connection. such as the MIPS. gdb may be able to load programs into flash memory. and Renesas SH. device drivers. and you will not need to worry about which to . the load command may be available.. although some simulators do provide these. show debug monitor Show the current status of displaying communications between gdb and the remote monitor. you cannot assume that a specific memory map. load also records the filename symbol table in gdb. you can specify the load address when you link the program. You may wish to control various aspects of this process. it is meant to make filename (an executable) available for debugging on the remote system—by downloading. Where it exists. show hash Show the current status of displaying the hash mark.. the object file format specifies a fixed address. Usually the executable or symbol will include a bit to designate the endian-ness. For info about any processor-specific simulator details.

Note that these commands merely adjust interpretation of symbolic data on the host. set endian auto Instruct gdb to use the byte order associated with the executable. . set endian big Instruct gdb to assume the target is big-endian.218 Debugging with gdb use. and that they have absolutely no effect on the target system. However. set endian little Instruct gdb to assume the target is little-endian. you may still find it useful to adjust gdb’s idea of processor endian-ness manually. show endian Display gdb’s current idea of the target byte order.

or use the set remotebaud command (see Section 20. to use a serial line connected to the device named ‘/dev/ttyb’: target remote /dev/ttyb If you’re using a serial line.4 [Remote Configuration]. or it might be a terminal server which in turn has a serial line to the target.Chapter 20: Debugging Remote Programs 219 20 Debugging Remote Programs If you are trying to debug a program running on a machine that cannot run gdb in the usual way. port must be a decimal number. if it is directly connected to the net. to connect to port 1234 on your local machine: target remote :1234 Note that the colon is still required here. a simulator for your target running on the same host). gdb can communicate with the target over a serial line. it is often useful to use remote debugging. For example. using the name of the local copy of your program as the first argument. to connect to port 2828 on a terminal server named manyfarms: target remote manyfarms:2828 If your remote target is actually running on the same machine as your debugger session (e. page 226) before the target command. or on a small system which does not have a general purpose operating system powerful enough to run a full-featured debugger. The host could be the target machine itself. The target remote command establishes a connection to the target. The host may be either a host name or a numeric IP address. Start up gdb as usual. gdb uses the same protocol for debugging your program. you may want to give gdb the ‘--baud’ option. For example. For example. since gdb needs symbol and debugging information. In each case. but not specific to any particular target system) which you can use if you write the remote stubs—the code that runs on the remote system to communicate with gdb. use help target to list them.1 Connecting to a Remote Target On the gdb host machine. gdb comes with a generic serial protocol (specific to gdb. Its arguments indicate which medium to use: target remote serial-device Use serial-device to communicate with the target. you will need an unstripped copy of your program. target remote host:port target remote tcp:host:port Debug using a TCP connection to port on host. . you can omit the hostname. For example. Some configurations of gdb have special serial or TCP/IP interfaces to make this work with particular debugging targets. Other remote targets may be available in your configuration of gdb.g. only the medium carrying the debugging packets varies. or over an IP network using TCP or UDP. you might use remote debugging on an operating system kernel. 20. In addition.

you can use ‘target remote’ again to connect once more. but the results will depend on your particular remote stub. This may or may not succeed. to be parsed and expanded by the system’s command shell. It will wait for gdb (this instance or another one) to connect and continue debugging. except that the target is generally not resumed. The remote program is already running. gdb attempts to stop the program. you can use step and continue.) Once the connection has been established. and send replies on its standard output. to connect to UDP port 2828 on a terminal server named manyfarms: target remote udp:manyfarms:2828 When using a UDP connection for remote debugging. it should expect remote protocol packets on its standard input. gdb goes back to waiting. gdb abandons the remote debugging session. and you do not need to use run. (If the program has already exited. The disconnect command behaves like detach. gdb will try to send it a SIGTERM signal. After the detach command.) If you type n. Give up (and stop debugging it)? (y or n) If you type y. /bin/sh. If you type the interrupt character once again.220 Debugging with gdb target remote udp:host:port Debug using UDP packets to port on host. you can use the detach command to release it from gdb control. gdb displays this prompt: Interrupted while waiting for the program. target remote | command Run command in the background and communicate with it using a pipe. monitor cmd This command allows you to send arbitrary commands directly to the remote monitor. if you type the interrupt character (often Ctrl-c). depending in part on the hardware and the serial drivers the remote system uses. For example. The command is a shell command. After the disconnect command. to make net connections using programs like ssh. you can use all the usual commands to examine and change data. disconnect . If command closes its standard output (perhaps by exiting). this will have no effect. you should keep in mind that the ‘U’ stands for “Unreliable”. UDP can silently drop packets on busy or unreliable networks. Detaching from the target normally resumes its execution. You could use this to run a stand-alone simulator that speaks the remote debugging protocol. (If you decide you want to try again later. gdb is again free to connect to another target. which will cause havoc with your debugging session. Since gdb doesn’t care about the commands it sends like this. or for other similar tricks. this command is the way to extend gdb—you can add new commands that only the external monitor will understand and implement. gdb is free to connect to another target. Whenever gdb is waiting for the remote program. detach When you have finished debugging the remote program.

g.g. The usual syntax is: . if you develop code for real-time systems. For other targets. 20. Finally. It is also easier to port than all of gdb. e. the name of your program. In fact. using the standard gdb remote serial protocol. so you can strip the program if necessary to save space. You need a copy of the program you want to debug. gdbserver is not a complete replacement for the debugging stubs. remote get targetfile hostfile Copy file targetfile from the target system to hostfile on the host system.3. so you may be able to get started more quickly on a new system by using gdbserver. which allows you to connect your program with a remote gdb via target remote—but without linking in the usual debugging stub. gdb and gdbserver communicate via either a serial line or a TCP connection.Chapter 20: Debugging Remote Programs 221 20. embedded devices with only a single serial port. for example by cross-compiling.1 Running gdbserver Run gdbserver on the target system. gnu/Linux systems running gdbserver over a network interface. remote delete targetfile Delete targetfile from the target system. a gdb connection to gdbserver provides access to the target system with the same privileges as the user running gdbserver. 20. this may be the only way to upload or download files.2 Sending files to a remote system Some remote targets offer the ability to transfer files over the same connection used to communicate with gdb. and the arguments for your program. because it is a much smaller program than gdb itself. Warning: gdbserver does not have any built-in security. To use the server. you may find that the tradeoffs involved in real-time operation make it more convenient to do as much development work as possible on another system. gdb on the host system does all the symbol handling. gdbserver does not need your program’s symbol table. remote put hostfile targetfile Copy file hostfile from the host system (the machine running gdb) to targetfile on the target system. Do not run gdbserver connected to any public network. a system that can run gdbserver to connect to a remote gdb could also run gdb locally! gdbserver is sometimes useful nevertheless. because it requires essentially the same operating-system facilities that gdb itself does. Not all remote targets support these commands. This is convenient for targets accessible through other means. you must tell it how to communicate with gdb.3 Using the gdbserver Program gdbserver is a control program for Unix-like systems. including any libraries it requires. You can use gdbserver to make a similar choice for debugging. e.

gdb closes the connection and gdbserver exits. 23 is reserved for telnet).1.1 Attaching to a Running Program On some targets. . When the debugged program exits. or you detach from it.) You can choose any number you want for the port number as long as it does not conflict with any TCP ports already in use on the target system (for example. gdbserver debugs the specified program only once.1.3. or program has multiple threads. to debug Emacs with the argument ‘foo.txt’ and communicate with gdb over the serial port ‘/dev/com1’: target> gdbserver /dev/com1 emacs foo.3. gdb stays connected to gdbserver even though no program is running. page 28).txt The only difference from the previous example is the first argument.222 Debugging with gdb target> gdbserver comm program [ args . gdbserver can also attach to running programs. To use a TCP connection instead of a serial line: target> gdbserver host:2345 emacs foo. If you connect using target extended-remote. To start gdbserver without supplying an initial command to run or process ID to attach. ] comm is either a device name (to use a serial line) or a TCP hostname and portnumber.2 Multi-Process Mode for gdbserver When you connect to gdbserver using target remote.txt gdbserver waits passively for the host gdb to communicate with it. 1 If you choose a port number that conflicts with another service. 20. except for wildcard expansion and I/O redirection (see Section 4.. gdbserver prints an error message and exits. When the program exits. use the ‘--multi’ command line option. Then you can connect using target extendedremote and start the program you want to debug. or you detach from it. 20.3 [Arguments]. The run and attach commands instruct gdbserver to run or attach to a new program. gdbserver enters multi-process mode.1 You must use the same port number with the host gdb target remote command. most versions of pidof support the -s option to only return the first process ID. For example.. (Currently. This is accomplished via the --attach argument. The ‘host:2345’ argument means that gdbserver is to expect a TCP connection from machine ‘host’ to local TCP port 2345. You can debug processes by name instead of process ID if your target has the pidof utility: target> gdbserver --attach comm ‘pidof program‘ In case more than one copy of program is running. The run command uses set remote exec-file (see [set remote exec-file]. specifying that you are communicating with the host gdb via TCP. the ‘host’ part is ignored. It isn’t necessary to point gdbserver at a binary for the running process. page 227) to select the program to run. Command line arguments are supported. The syntax is: target> gdbserver --attach comm pid pid is the process ID of a currently running process.

3. even for unexpectedly closed connections and even in the target extended-remote mode. e. gdbserver stays running even with no processes left.Chapter 20: Debugging Remote Programs 223 In multi-process mode gdbserver does not automatically exit unless you use the option ‘--once’. This means no further connections to gdbserver will be possible after the first one. Any Unix shell script ending with exec "$@" will also work. and gdb cannot ask gdbserver to kill its debugged processes. The ‘--multi’ option to gdbserver has no influence on that. You can use any program that eventually calls execve with its arguments as a wrapper. then any command-line arguments to pass to the wrapper. gdbserver keeps the listening TCP port open. you can use env to pass an environment variable to the debugged program.so -. at most one gdb can be connected at a time. Several standard Unix utilities do this. By default. if you start gdbserver with the ‘--once’ option. when the connection drops unexpectedly. For example. gdb normally terminates the spawned debugged process on its exit. page 148. and then gdb gains control. These options are intended for gdbserver development and for bug reports to the developers. On the other hand. since each instance closes its port after the first connection. The ‘--wrapper’ option specifies a wrapper to launch programs for debugging. it will stop listening for any further connection attempts after connecting to the first gdb session. The ‘--once’ option allows reusing the same port number for connecting to multiple instances of gdbserver running on the same host. You can terminate it by using monitor exit (see [Monitor Commands for gdbserver].:2222 . Such reconnecting is useful for features like [disconnected tracing].1. then the name of the program to debug. When gdbserver stays running. for target extended-remote. without setting the variable in gdbserver’s environment: $ gdbserver --wrapper env LD_PRELOAD=libtest. then -. gdbserver stays running even in the target remote mode. For completeness. The wrapper runs until it executes your program.g.4 Other Command-Line Arguments for gdbserver The ‘--debug’ option tells gdbserver to display extra status information about the debugging process. env and nohup. 20.1. then any arguments to the program./testprog . The option should be followed by the name of the wrapper. gdbserver normally terminates after all of its debugged processes have terminated in target remote mode. page 224). gdb can connect to it again later. 20.indicating the end of the wrapper arguments. which normally also terminates gdbserver in the target remote mode. so that additional connections are possible.3. Therefore. However.3 TCP port allocation lifecycle of gdbserver This section applies only when gdbserver is run to listen on a TCP port. It also means gdbserver will terminate after the first connection with remote gdb has closed. gdbserver runs the specified wrapper program with a combined command line including the wrapper arguments. The ‘--remote-debug’ option tells gdbserver to display remote protocol debug output. Note that the conditions under which gdbserver terminates depend on how gdb connects to it (target remote or target extended-remote).

you can use the monitor command to send special requests to gdbserver. page 465). path is a colon-separated list of directories to search for libthread_db (see Section 4.10 [set libthread-db-search-path]. The special entry ‘$pdir’ for ‘libthread-db-search-path’ is not supported in gdbserver. On gnu/Linux targets. 20. but which usually looks something like ‘Connection refused’. 20. If you omit path. fast tracepoints and static tracepoints. For TCP connections. . monitor set remote-debug 0 monitor set remote-debug 1 Disable or enable specific debugging messages associated with the remote protocol (see Appendix E [Remote Protocol]. Load symbols for your application using the file command before you connect. Use monitor exit to terminate gdbserver at the end of a multi-process mode debug session.4 Tracepoints support in gdbserver On some targets.3. with one exception: the files on the host system should not be stripped.3. page 35). Connect to your target (see Section 20. Here are the available commands. page 219). Mismatched or missing files will lead to confusing results during debugging. First make sure you have the necessary symbol files. even if the files on the target system are. monitor set debug 0 monitor set debug 1 Disable or enable general debugging messages. monitor set libthread-db-search-path [PATH] When this command is issued. monitor exit Tell gdbserver to exit immediately. ‘libthread-db-search-path’ will be reset to its default value.2 Connecting to gdbserver Run gdb on the host system. you must start up gdbserver prior to using the target remote command. gdbserver will detach from any attached processes and kill any processes it created. monitor help List the available monitor commands.1 [Connecting to a Remote Target]. mismatched or missing files may also prevent gdbserver from debugging multi-threaded programs.3 Monitor Commands for gdbserver During a gdb session using gdbserver. This command should be followed by disconnect to close the debugging session. Don’t use the load command in gdb when using gdbserver. Otherwise you may get an error whose text depends on the host system. gdbserver supports tracepoints. The symbol file and target libraries must exactly match the executable and libraries on the target. since the program is already on the target.224 Debugging with gdb 20.3. Use set sysroot to locate target libraries (unless your gdb was compiled with the correct sysroot using --with-sysroot).

for the dlopen function to be available. a special library called the in-process agent (IPA). you do that by specifying LD_PRELOAD=libinproctrace. like most Unix systems. .so’ as loaded in the process. or if gdbserver was explicitly configured using ‘--with-ust’ to point at such headers.. This library is built and distributed as an integral part of gdbserver. including the in-process agent. when you connect to gdbserver using target remote. start gdbserver like so: $ gdbserver :9999 myprogram Start GDB and connect to gdbserver like so. You’ll use the call command for that. before being able to use any of the fast or static tracepoints features. the function is dlopen. You are now ready to install fast tracepoints. In addition.org/ust) tracing engine is supported. At present.so in the environment. and start tracing. Using the system’s preloading mechanisms You can force loading the in-process agent at startup time by using your system’s support for preloading shared libraries. On systems that have a userspace dynamic loader.g. probe static tracepoints markers. In that case. On most systems.Chapter 20: Debugging Remote Programs 225 For fast or static tracepoints to work.) Note that on most Unix systems. . E. You can explicitly disable the support using ‘--with-ust=no’. In most cases. which will list ‘libinproctrace. http://lttng.so. if debugging a C or C++ program. this is accomplished by adding -linproctrace to the link command. There are several ways to load the in-process agent in your program: Specifying it as dependency at link time You can link your program dynamically with the in-process agent library. list static tracepoint markers. On most Unix systems. Using gdb to force loading the agent at run time On some systems. See also the description of gdbserver’s ‘--wrapper’ command line option.. support for static tracepoints requires building the in-process agent library with static tracepoints support. For example: (gdb) call dlopen ("libinproctrace. the program needs to be linked with -ldl.so". by calling a dynamic loader function in the inferior that takes care of dynamically looking up and loading a shared library. The simplest way to do that is to run the program to the main procedure. the UST (LTTng Userspace Tracer. must be loaded in the inferior process. and no shared library has been loaded in the program’s address space yet. Many Unixes support the concept of preloading user defined libraries.. you can confirm it with the info sharedlibrary command. and run to main: $ gdb myprogram (gdb) target remote myhost:9999 0x00007f215893ba60 in ?? () from /lib64/ld-linux-x86-64. you’ll find that the program is stopped at the dynamic loader’s entry point. you can force the inferior to load a shared library. This support is automatically available if UST development headers are found in the standard include path when gdbserver is built.2 (gdb) b main (gdb) continue The in-process tracing agent library should now be loaded into the process. you need to let the loader run and load the shared libraries.

show remotelogfile. since most remote systems expect to see ‘Ctrl-C’ as the interrupt signal. set remoteaddresssize bits Set the maximum size of address in a memory packet to the specified number of bits. gdb will mask off the address bits above that number. gdb sends the ‘Ctrl-C’ character instead. show remotebreak Show whether gdb sends BREAK or ‘Ctrl-C’ to interrupt the remote program. set remotelogfile file Record remote serial communications on the named file. The value is used to set the speed of the serial port used for debugging remote targets. and hex. when it passes addresses to the remote target. show remotelogbase Show the current setting of the radix for logging remote serial protocol. show remoteflow Show the current setting of hardware flow control.k.4 Remote Configuration This section documents the configuration options available when debugging remote programs.a. set remotebreak If set to on. radix) of logging serial protocol communications to base. gdb sends a BREAK signal to the remote when you type Ctrl-c to interrupt the program running on the remote. Supported values of base are: ascii. set remoteflow on set remoteflow off Enable or disable hardware flow control (RTS/CTS) on the serial port used to communicate to the remote target. . The default is off. The default value is the number of bits in the target’s address. set remotebaud n Set the baud rate for the remote serial I/O to n baud. page 513. The default is ascii.226 Debugging with gdb 20. The default is not to record at all. see [system]. Show the current setting of the file name on which to record the serial communications. show remotebaud Show the current speed of the remote connection. set remotelogbase base Set the base (a. For the options related to the File I/O extensions of the remote protocol. octal. If set to off. show remoteaddresssize Show the current value of remote address size in bits.

a Magic SysRq g. show remote hardware-watchpoint-length-limit Show the current limit (in bytes) of the maximum length of a remote hardware watchpoint. This should be set to a filename valid on the target system. the default.g. This is mostly needed when you debug Linux kernel. show remotetimeout Show the current number of seconds to wait for the remote target responses. set remote exec-file filename show remote exec-file Select the file used for run with target extended-remote. It is BREAK signal followed by character g. a BREAK or ‘BREAK-g’ as the sequence to the remote target in order to interrupt the execution. BREAK or BREAK-g is sent by gdb to interrupt the remote program. show interrupt-sequence Show which of ‘Ctrl-C’. the target will use a default filename (e. Some system prefers BREAK which is high level of serial line for some certain time.Chapter 20: Debugging Remote Programs 227 set remotetimeout num Set the timeout limit to wait for the remote target to respond to num seconds. Linux kernel prefers ‘BREAK-g’. is treated as unlimited. A limit of -1. set tcp auto-retry on Enable auto-retry for remote TCP connections. the default. set remote hardware-watchpoint-length-limit limit Restrict gdb to using limit bytes for the maximum length of a remote hardware watchpoint. if the initial attempt to . The default is 2 seconds.k. When auto-retry is enabled. set remote hardware-watchpoint-limit limit set remote hardware-breakpoint-limit limit Restrict gdb to using limit remote hardware breakpoint or watchpoints. show interrupt-on-connect Show whether interrupt-sequence is sent to remote target when gdb connects to it. This is useful if the remote debugging agent is launched in parallel with gdb. ‘Ctrl-C’ is a default. Linux kernel expects BREAK followed by g which is known as Magic SysRq g in order to connect gdb. there is a race condition because the agent may not become ready to accept the connection before gdb attempts to connect. set remote interrupt-on-connect Specify whether interrupt-sequence is sent to remote target when gdb connects to it. BREAK-g is BREAK signal followed by g and also known as Magic SysRq g. a. set remote interrupt-sequence Allow the user to select one of ‘Ctrl-C’. the last program run). A limit of -1. If it is not set. is treated as unlimited.

show tcp connect-timeout Show the current connection timeout setting. the command to enable or disable the packet is set remote name-packet. During normal use. page 465. you can use these commands to enable or disable individual packets. They all default to ‘auto’. You may want to report the problem to the gdb developers. ‘off’ (the remote target does not support this packet). set info auxv Detecting threads attach Stepping or resuming multiple threads run multiple attach verbose-resume vAttach vCont run vRun . For each packet name. or ‘auto’ (detect remote target support for this packet). and represents an approximate cumulative value. Each packet can be set to ‘on’ (the remote target supports this packet). you should not have to use any of these commands.228 Debugging with gdb connect fails. see Appendix E [Remote Protocol]. set tcp auto-retry off Do not auto-retry failed TCP connections. For more information about each packet. The timeout affects both polling to retry failed connections (enabled by set tcp auto-retry on) and waiting for connections that are merely slow to complete. The available settings are: Command Name fetch-register set-register binary-download read-aux-vector symbol-lookup Remote Packet p P X qXfer:auxv:read qSymbol Related Features info registers set load. or a bug in gdb. set tcp connect-timeout seconds Set the timeout for establishing a TCP connection to the remote target to seconds. gdb reattempts to establish the connection using the timeout specified by set tcp connect-timeout. that may be a bug in your remote debugging stub. If you need to override the autodetection. If you do. The gdb remote protocol autodetects the packets supported by your debugging stub. show tcp auto-retry Show the current auto-retry setting.

remote put com- memory-map read-sdata-object read-spu-object write-spu-object read-siginfo-object write-siginfo-object threads get-thread-localstorage-address get-threadinformation-blockaddress search-memory supported-packets qXfer:memory-map:read qXfer:sdata:read qXfer:spu:read qXfer:spu:write qXfer:siginfo:read qXfer:siginfo:write qXfer:threads:read qGetTLSAddr qGetTIBAddr qSearch:memory qSupported pass-signals hostio-close-packet QPassSignals vFile:close . find Remote munications parameters handle signal remote get.Chapter 20: Debugging Remote Programs 229 software-breakpoint hardware-breakpoint write-watchpoint read-watchpoint access-watchpoint target-features library-info Z0 Z1 Z2 Z3 Z4 qXfer:features:read qXfer:libraries:read break hbreak watch rwatch awatch set architecture info sharedlibrary info mem print $_sdata info spu info spu print $_siginfo set $_siginfo info threads Displaying __thread variables Display MSWindows Thread Information Block.

you can still ignore the details: start with one of the existing stub files. .c’ is the best organized. remote put remote delete Packet acknowledgment info os Querying process state. ‘sparc-stub. and therefore the easiest to read. The startup routine may be supplied by your hardware supplier. or you may have to write your own. For example.230 Debugging with gdb hostio-open-packet vFile:open remote get. for a C program. A startup routine to set up the C runtime environment. remote put remote get. remote attach hostio-pread-packet vFile:pread hostio-pwrite-packet vFile:pwrite hostio-unlink-packet noack-packet vFile:unlink QStartNoAckMode osdata query-attached qXfer:osdata:read qAttached traceframe-info install-in-trace qXfer:traceframeinfo:read InstallInTrace Traceframe info Install tracepoint in tracing set disablerandomization disable-randomization QDisableRandomization 20. remote put remote get. a download program. notably managing input and output. (If you’re implementing your own stub file. Normally. 2. you need: 1. and ignore the details.) To debug a program running on another machine (the debugging target machine). but you may have to write your own from hardware documentation. you must first arrange for all the usual prerequisites for the program to run by itself.5 Implementing a Remote Stub The stub files provided with gdb implement the target side of the communication protocol. 3. and the gdb side is implemented in the gdb source file ‘remote. A way of getting your program to the other machine—for example. These are often supplied by the hardware manufacturer. these usually have a name like ‘crt0’. A C subroutine library to support your program’s subroutine calls. you can simply allow these subroutines to communicate.c’.

handle_exception This is the central workhorse. The ‘README’ file in the gdb distribution may list other recently added stubs. use ‘sparc-stub. handle_exception takes control when your program stops during execution (for example. These working remote stubs are distributed with gdb: i386-stub.3 [Using the gdbserver Program]. The debugging stub is specific to the architecture of the remote machine.c For sparc architectures. You must call this subroutine explicitly near the beginning of your program. but your program never calls it explicitly—the setup code arranges for handle_exception to run when a trap is triggered. This is where the communications protocol is implemented. page 221.5. for example.1 What the Stub Can Do for You The debugging stub for your architecture supplies these three subroutines: set_debug_traps This routine arranges for handle_exception to run when your program stops. m68k-stub.c For Renesas SH architectures. It . page 215). for details. handle_exception acts as the gdb representative on the target machine. In general terms. on a breakpoint). sparcl-stub. sparc-stub.Chapter 20: Debugging Remote Programs 231 The next step is to arrange for your program to use a serial port to communicate with the machine where gdb is running (the host machine). On the target. The file containing these subroutines is called a debugging stub. gdb already understands how to use this protocol. sh-stub. you must link with your program a few special-purpose subroutines that implement the gdb remote serial protocol. the scheme looks like this: On the host.c For Intel 386 and compatible architectures.c’ to debug programs on sparc boards. you can simply use the ‘target remote’ command (see Chapter 19 [Specifying a Debugging Target]. you can use an auxiliary program gdbserver instead of linking a stub into your program. and mediates communications with gdb on the host machine.c For Motorola 680x0 architectures. 20.c For Fujitsu sparclite architectures. when everything else is set up. See Section 20. On certain remote targets.

a different name is used to allow you to distinguish the two if you wish. then continues to execute. in that situation. If you want gdb to be able to stop your program while it is running. and arrange for it to stop when it receives a ^C (‘\003’. to gdb. For instance.2 What You Must Do for the Stub The debugging stubs that come with gdb are set up for a particular chip architecture. You need to do this because the stub does not have any way of knowing what the exception handling tables on your target system are like (for example. Depending on the particular situation. retrieving and transmitting any information gdb needs. 20. until you execute a gdb command that makes your program resume. the processor’s table might be in rom. On some machines. Other routines you need to supply are: void exceptionHandler (int exception_number. if your target machine has some sort of interrupt button. a different name is used to allow you to distinguish the two if you wish. one quick and dirty way is to just execute a breakpoint instruction (the “dirty” part is that gdb reports a SIGTRAP instead of a SIGINT). That is the character which gdb uses to tell the remote system to stop. It may be identical to putchar for your target system. its meaning is architecture-dependent (for example. int getDebugChar() Write this subroutine to read a single character from the serial port. Getting the debugging target to return the proper status to gdb probably requires changes to the standard stub.5. void *exception_address) Write this function to install exception address in the exception handling tables. or if you simply want to make certain your program stops at a predetermined point for the start of your debugging session. you won’t need to call this. this may be the only way for gdb to get control. you need to use an interrupt-driven serial driver. containing entries which point to a table in ram). different numbers might . breakpoint Use this auxiliary subroutine to make your program contain a breakpoint. Call breakpoint if none of these is true. you don’t need to call breakpoint from your own program—simply running ‘target remote’ from the host gdb session gets control. at that point. First of all you need to tell the stub how to communicate with the serial port. handle_exception returns control to your own code on the target machine. void putDebugChar(int) Write this subroutine to write a single character to the serial port. pressing the interrupt button transfers control to handle_exception—in effect. the control-C character). It may be identical to getchar for your target system. but they have no information about the rest of your debugging target machine. exception number is the exception number which should be changed.232 Debugging with gdb begins by sending summary information on the state of your program. again. simply receiving characters on the serial port may also trigger a trap.

but if before calling set_debug_traps. void flush_i_cache() On sparc and sparclite only. you must follow these steps. Compile and link together: your program. but in general the stubs are likely to use any of the common library subroutines which gcc generates as inline code. You must also make sure this library routine is available: void *memset(void *. Insert these lines near the top of your program: set_debug_traps(). If you have one of the free versions of libc. The function indicated by exceptionHook is called with one parameter: an int which is the exception number. 20. 1. this varies from one stub to another. flush_i_cache. When this exception occurs. The gate should be at privilege level 0 (the most privileged level). you set it to point to a function in your program. on your target machine. The sparc and 68k stubs are able to mask interrupts themselves without help from exceptionHandler. int) This is the standard library function memset that sets an area of memory to a known value.3 Putting it All Together In summary. control should be transferred directly to exception address. if any. If there is no instruction cache. exceptionHandler. 3. gdb requires this function to make certain that the state of your program is stable. you need to provide a variable called exceptionHook. bus error). not a jump to subroutine. memset can be found there. Normally you just use: void (*exceptionHook)() = 0. otherwise. misaligned access. the gdb debugging stub for your target architecture. when your program is ready to debug. For the 386. this subroutine may be a no-op.5. So if you want to use a jump instruction to reach exception address. that function is called when gdb continues after stopping on a trap (for example. it should be a simple jump. and the supporting subroutines. 2. If you do not use the GNU C compiler. you must either obtain it from your hardware manufacturer. and the processor state (stack. breakpoint(). 4. and so on) should be just as it is when a processor exception occurs. exception address should be installed as an interrupt gate so that interrupts are masked while the handler runs. you may need other standard library subroutines as well. . memset. registers. Make sure you have defined the supporting low-level routines (see Section 20. int. or write your own. page 232): getDebugChar. putDebugChar. For the 680x0 stub only.2 [What You Must Do for the Stub].Chapter 20: Debugging Remote Programs 233 represent divide by zero. etc). On target machines that have instruction caches.5. write this subroutine to flush the instruction cache.a.

. 7.1 [Connecting to a Remote Target]. 6. Start gdb on the host. Make sure you have a serial connection between your target machine and the gdb host. and identify the serial port on the host. and start it. page 219). and connect to the target (see Section 20. Download your program to your target machine (or get it there by whatever means the manufacturer provides).234 Debugging with gdb 5.

provide the file name of the crash dump as an argument: (gdb) target kvm /var/crash/bsd. and Unixware. 21.Chapter 21: Configuration-Specific Information 235 21 Configuration-Specific Information While nearly all gdb commands are available for all native and cross versions of the debugger. info proc works only on SVR4 systems that include the procfs code.1 Native This section describes details specific to particular native configurations.1. the command info proc is available to report information about the process running your program. where the host and target are the same. 21.2 BSD libkvm Interface BSD-derived systems (FreeBSD/NetBSD/OpenBSD) have a kernel memory interface that provides a uniform interface for accessing kernel virtual memory images. gdb searches for a user or system name first. 21. There are three major categories of configurations: native configurations. Irix. but not HP-UX. embedded operating system configurations. the following commands are available: kvm pcb kvm proc Set current context from the Process Control Block (PCB) address. before it searches for a convenience variable. and bare embedded processors. info proc info proc process-id Summarize available information about any running process. This chapter describes things that are only available in certain configurations. gdb uses this interface to allow you to debug live kernels and kernel crash dumps on many native BSD configurations. If gdb is configured for an operating system with this facility. 21.1. If a process ID is specified by process-id. For debugging a live system.1 HP-UX On HP-UX systems. including live systems and crash dumps. This command isn’t available on modern FreeBSD systems. This includes. gnu/Linux. which are quite different from each other. Solaris. Set current context from proc address. if you refer to a function or variable name that begins with a dollar sign.1.3 SVR4 Process Information Many versions of SVR4 and compatible systems provide a facility called ‘/proc’ that can be used to examine the image of a running process using file-system subroutines. as of this writing. there are some exceptions. otherwise . load the currently running kernel into gdb and connect to the kvm target: (gdb) target kvm For debugging crash dumps. This is implemented as a special kvm debugging target. OSF/1 (Digital Unix). display information about that process.0 Once connected to the kvm target. or about any process running on your system. which are usually the same for several different processor architectures. for example.

blocked. set procfs-file file Tell gdb to write procfs API trace to the named file. info proc mappings Report the memory address space ranges accessible in the program. and ignored. see the ‘proc’ man page (type man 5 proc from your shell prompt). info proc stat info proc status These subcommands are specific to gnu/Linux systems. its stack size. process-id can be of the form ‘[pid]/tid’ which specifies a certain thread ID within a process. proc-trace-entry proc-trace-exit proc-untrace-entry proc-untrace-exit These commands enable and disable tracing of entries into and exits from the syscall interface. its TTY. write. set procfs-trace This command enables and disables tracing of procfs API calls. it means a thread from the process being debugged (the leading ‘/’ still needs to be present. this command displays the list of all the processes and all the threads within each process. show procfs-trace Show the current state of procfs API call tracing. its virtual memory usage. with information on whether the process has read. instead of the memory access rights to that range. its ‘nice’ value. For more information. . each memory range includes the object file which is mapped to that range. On some systems. On gnu/Linux systems.236 Debugging with gdb display information about the program being debugged. info proc all Show all the information about the process described under all of the above info proc subcommands. the command line used to invoke it. including the user ID and group ID. info pidlist For QNX Neutrino only. how many threads are there in the process. gdb appends the trace info to the previous contents of the file. etc. The summary includes the debugged process ID. the signals that are pending. its consumption of system and user time. If the optional pid part is missing. and its executable file’s absolute file name. or execute access rights to each range. They show the processrelated information. or else gdb will interpret the number as a process ID rather than a thread ID). show procfs-file Show the file to which procfs API trace is written. its current working directory. The default is to display the trace on the standard output.

A Page Table includes an entry for every page of memory that is mapped into the .e.1. Page Directories and Page Tables are data structures which control how virtual memory addresses are mapped into physical addresses. Global. all entries from the specified table are displayed. For example. the DPMI host will usually define additional segments in order to support the DPMI environment. The descriptor tables are data structures which store a descriptor for each segment that is currently in use. means display a single entry whose index is given by the argument. info dos gdt info dos ldt info dos idt These 3 commands display entries from. This subsection describes those commands. 21. info dos This is a prefix of djgpp-specific commands which print information about the target system and important OS structures. info dos sysinfo This command displays assorted information about the underlying platform: the CPU type and features. Exp-up) This comes in handy when you want to see whether a pointer is outside the data segment’s limit (i. and the available conventional and DPMI memory. Without an argument. the table entry for that index holds the descriptor’s base address and limit. and its attributes and access rights. and a DOS segment (which allows access to DOS/BIOS data structures and absolute addresses in conventional memory). a data segment (used for both data and the stack). garbled). here’s a convenient way to display information about the debugged program’s data segment: (gdb) info dos ldt $ds 0x13f: base=0x11970000 limit=0x0009ffff 32-Bit Data (Read/Write. which should be an integer expression. and defines a few commands specific to the djgpp port. djgpp programs are 32-bit protected-mode programs that use the DPMI (DOS Protected-Mode Interface) API to run on top of real-mode DOS systems and their emulations. respectively. the OS version and flavor. and Interrupt Descriptor Tables (GDT. gdb supports native debugging of djgpp programs. However. info dos pde info dos pte These two commands display entries from. Local. respectively. A typical djgpp program uses 3 segments: a code segment.4 Features for Debugging djgpp Programs djgpp is a port of the gnu development tools to MS-DOS and MS-Windows.Chapter 21: Configuration-Specific Information 237 info meminfo For QNX Neutrino only. The segment’s selector is an index into a descriptor table. and IDT). the DPMI version. An argument. These commands allow to display entries from the descriptor tables. LDT. the Page Directory and the Page Tables. this command displays the list of all mapinfos.

For example.238 Debugging with gdb program’s address space. there may be several Page Tables. it displays the Page Table entry for the transfer buffer: (gdb) info dos address-pte *((unsigned *)&_go32_info_block + 3) Page Table entry for address 0x29110: Base=0x00029000 Dirty Acc. info dos pde displays the entire Page Directory. the physical (0x00029000 + 0x110) and linear (0x29110) addresses are identical. These commands are supported only with some DPMI servers. because this command accepts addresses which may belong to any segment. the base address of all variables and functions in a djgpp program. Note that you must cast the addresses of variables to a char *. and info dos pte displays all the entries in all of the Page Tables. the one pointed to by the specified entry in the Page Directory.e. The argument addr is a linear address which should already have the appropriate segment’s base address added to it. and shows all the attributes of that page. info dos address-pte addr This command displays the Page Table entry for a specified linear address. These commands are useful when your program uses DMA (Direct Memory Access). In addition to native debugging. given to the info dos pde command means display only that entry from the Page Directory table. Not-Cached Write-Back Usr Read-Write +0xd30 This says that i is stored at offset 0xd30 from the page whose physical base address is 0x02698000. the DJGPP port supports remote debugging via a serial data link. will be added using the rules of C pointer arithmetics: if i is declared an int. A Page Directory has up to 4096 entries.) The output clearly shows that this DPMI server maps the addresses in conventional memory 1:1. here’s how to display the Page Table entry for the page where a variable i is stored: (gdb) info dos address-pte __djgpp_base_address + (char *)&i Page Table entry for address 0x11a00d30: Base=0x02698000 Dirty Acc. each one holding up to 4096 entries. . one each for every Page Table that is currently in use. An argument given to the info dos pte command means display entries from a single Page Table. gdb will add 4 times the value of __djgpp_base_address to the address of i. Without an argument. an integer expression. The following commands are specific to remote serial debugging in the DJGPP port of gdb. Not-Cached Write-Back Usr Read-Write +0x110 (The + 3 offset is because the transfer buffer’s address is the 3rd member of the _go32_info_block structure. set com1base addr This command sets the base I/O port address of the ‘COM1’ serial port. Here’s another example. since otherwise the value of __djgpp_base_address. set com1irq irq This command sets the Interrupt Request (IRQ) line to use for the ‘COM1’ serial port. This command is supported only with some DPMI servers. which needs physical addresses to program the DMA controller. i. An argument.

For this reason. There are various additional Cygwin-specific commands. dll-symbols This command loads symbols from a dll similarly to add-sym command but without the need to specify a base address.Chapter 21: Configuration-Specific Information 239 There are similar commands ‘set com2base’. Working with DLLs that have no debugging symbols is described in Section 21. gdb will break on exceptions that happen inside the Cygwin DLL. 21. info serial This command prints the status of the 4 DOS serial ports.5. info w32 selector This command displays information returned by the Win32 API GetThreadSelectorEntry function. If mode is off. and may ignore some exceptions which seem to be caused by internal Cygwin DLL “bookkeeping”. its I/O base address and IRQ number. Without argument.5 Features for Debugging MS Windows PE Executables gdb supports native debugging of MS Windows programs. etc. This option is meant primarily for debugging the Cygwin DLL itself. gdb will delay recognition of exceptions. this command displays information about the six segment registers. . info dll This is a Cygwin-specific alias of info shared.1. whether it uses a 16550-style FIFO. ‘set com3irq’. gdb on MSWindows supports C-BREAK as an alternative interrupt key sequence. and the counts of various errors encountered so far. info w32 This is a prefix of MS Windows-specific commands which print information about the target system and important OS structures. The related commands ‘show com1base’. which can be used to interrupt the debuggee even if it ignores C-c. its baudrate. info w32 thread-information-block This command displays thread specific information stored in the Thread Information Block (readable on the X86 CPU family using $fs selector for 32-bit programs and $gs for 64-bit programs). MS-Windows programs that call SetConsoleMode to switch off the special meaning of the ‘Ctrl-C’ keystroke cannot be interrupted by typing C-c. It takes an optional argument that is evaluated to a long value to give the information about this given selector. For each port. including DLLs with and without symbolic debugging information. described in this section. display the current settings of the base address and the IRQ lines used by the COM ports. for setting the port address and the IRQ lines for the other 3 COM ports. ‘show com1irq’ etc. page 240. the default value is off to avoid annoying gdb users with false SIGSEGV signals.1. it prints whether it’s active or not. set cygwin-exceptions mode If mode is on.1 [Non-debug DLL Symbols].

set debugexceptions This boolean value adds debug output concerning exceptions in the debuggee seen by the debugger.5. set debugmemory This boolean value adds debug output concerning debuggee memory reads and writes by the debugger. show shell Displays if the debuggee will be started with a shell. It is also possible . If mode is off. set debugexec This boolean value adds debug output concerning execute events (such as resume thread) seen by the debugger.1 Support for DLLs without Debugging Symbols Very often on windows. and debugging messages produced by the Windows OutputDebugString API call. DLL loading and unloading. set new-console mode If mode is on the debuggee will be started in a new console on next start.240 Debugging with gdb show cygwin-exceptions Displays whether gdb will break on exceptions that happen inside the Cygwin DLL itself.1. Note that before the debugged program has started execution.dll’). ‘kernel32. This section describes working with such symbols. set shell This boolean values specifies whether the debuggee is called via a shell or directly (default value is on). The easiest way around this problem is simply to start the program — either by setting a breakpoint or letting the program run once to completion. it relies on the minimal amount of symbolic information contained in the DLL’s export table. 21. When gdb doesn’t recognize any debugging symbols in a DLL. console interrupts. set debugevents This boolean value adds debug output concerning kernel events related to the debuggee seen by the debugger. set new-group mode This boolean value controls whether the debuggee should start a new group or stay in the same group as the debugger. no DLLs will have been loaded. the debuggee will be started in the same console as the debugger. some of the DLLs that your program relies on do not include symbolic debugging information (for example. This affects the way the Windows OS handles ‘Ctrl-C’. show new-console Displays whether a new console is used when the debuggee is started. This includes events that signal thread and process creation and exit. known internally to gdb as “minimal symbols”. show new-group Displays current value of new-group boolean.

or vice-versa. For this reason. or the dll-symbols command in Section 21.1.1. Use single-quotes around the name to avoid the exclamation mark (“!”) being interpreted as a language operator. In some cases there will be name clashes within a program (particularly if the executable itself includes full debugging symbols) necessitating the use of the fully qualified name when referring to the contents of the DLL. 21. it is often necessary to prefix a variable name with the address-of operator (“&”) and provide explicit type information in the command. Currently.Chapter 21: Configuration-Specific Information 241 to force gdb to load a particular DLL before starting the executable — see the shared library information in Section 18.2 DLL Name Prefixes In keeping with the naming conventions used by the Microsoft debugging tools. Variables are generally treated as pointers and dereferenced automatically. page 189). All that gdb can do is guess whether a symbol refers to a function or variable depending on the linker section that contains the symbol. which may adversely affect symbol lookup performance. If in doubt. explicitly loading symbols from a DLL with no debugging information will cause the symbol names to be duplicated in gdb’s lookup table. Since symbols within gdb are case-sensitive this may cause some confusion.] 21. This means that you cannot examine the contents of a variable or disassemble a function within a DLL without a running program. so CreateFileA is often sufficient. page 201.1.3 Working with Minimal Symbols Symbols extracted from a DLL’s export table do not contain very much type information.. Here’s an example: (gdb) info function CreateFileA All functions matching regular expression "CreateFileA": Non-debugging symbols: 0x77e885f4 CreateFileA 0x77e885f4 KERNEL32!CreateFileA (gdb) info function ! All functions matching regular expression "!": Non-debugging symbols: 0x6100114c cygwin1!__assert 0x61004034 cygwin1!_dll_crt0@0 0x61004240 cygwin1!dll_crt0(per_process *) [etc. Note that the internal name of the DLL may be all upper-case.5 [Cygwin Native]. even though the file name of the DLL is lower-case. The plain name is also entered into the symbol table. Also note that the actual contents of the memory contained in a DLL are not available unless the program is running. try the info functions and info variables commands or even maint print msymbols (see Chapter 16 [Symbols]. for instance KERNEL32!CreateFileA. DLL export symbols are made available with a prefix based on the DLL name.. page 239.5.1 [Files]. Here’s an example of the type of problem: (gdb) print ’cygwin1!__argv’ $1 = 268572168 .5.

are not affected by this command. under these circumstances. sigs is a shorthand alias for signals. The stopped process can be continued by delivering a signal to it. show signals show sigs Show the current state of intercepting inferior’s signals. set stopped This commands tells gdb that the inferior process is stopped. . That thread is run when a signal is delivered to a running process. gdb can’t examine the initial instructions of the function in order to skip the function’s frame set-up code. show signal-thread show sigthread These two commands show which thread will run when the inferior is delivered a signal. Mach exceptions. such as breakpoint traps. However.dll’ is completely safe.6 Commands Specific to gnu Hurd Systems This subsection describes gdb commands specific to the gnu Hurd native debugging. You can work around this by using “*&” to set the breakpoint at a raw memory address: (gdb) break *&’python22!PyOS_Readline’ Breakpoint 1 at 0x1e04eff0 The author of these extensions is not entirely convinced that setting a break point within a shared DLL like ‘kernel32. as with the SIGSTOP signal. set signals set sigs This command toggles the state of inferior signal interception by gdb.1. 21. set sigthread is the shorthand alias of set signal-thread.242 Debugging with gdb (gdb) x ’cygwin1!__argv’ 0x10021610: "\230y\"" And two possible solutions: (gdb) print ((char **)’cygwin1!__argv’)[0] $2 = 0x22fd98 "/cygdrive/c/mydirectory/myprogram" (gdb) x/2x &’cygwin1!__argv’ 0x610c0aa8 <cygwin1!__argv>: 0x10021608 0x00000000 (gdb) x/x 0x10021608 0x10021608: 0x0022fd98 (gdb) x/s 0x0022fd98 0x22fd98: "/cygdrive/c/mydirectory/myprogram" Setting a break point within a DLL is possible even before the program starts execution. set signal-thread set sigthread This command tells gdb which thread is the libc signal thread. show stopped This command shows whether gdb thinks the debuggee is stopped.

and the current thread is suspended whenever gdb gets control. set task exception-port set task excp This command sets the task exception port to which gdb will forward exceptions. show task pause Show the current state of task suspension. If this option is set to off.Chapter 21: Configuration-Specific Information 243 set exceptions Use this command to turn off trapping of exceptions in the inferior. The argument should be the value of the send rights of the task. Setting it to on takes effect immediately. set task detach-suspend-count This command sets the suspend count the task will be left with when gdb detaches from it. send rights. neither breakpoints nor single-stepping will work. set thread pause This command toggles current thread suspension when gdb has control. set task pause This command toggles task suspension when gdb has control. To restore the default. Setting it to on takes effect immediately. show task detach-suspend-count Show the suspend count the task will be left with when detaching. set task excp is a shorthand alias. show exceptions Show the current state of trapping exceptions in the inferior. you can use set thread default pause on or set thread pause on (see below) to pause individual threads. set exception trapping on. respectively. and the task is suspended whenever gdb gets control. port rights. Setting it to off will take effect the next time the inferior is . set exceptions. info info info info info info info send-rights receive-rights port-rights port-sets dead-names ports psets These commands display information about. set noninvasive This command switches gdb to a mode that is the least invasive as far as interfering with the inferior is concerned. port sets. receive rights. When exception trapping is off. Setting it to off will take effect the next time the inferior is continued. and dead names of a task. This is the same as using set task pause. There are also shorthand aliases: info ports for info port-rights and info psets for info portsets. and set signals to values opposite to the defaults.

set thread default pause. show thread detach-suspend-count Show the suspend count gdb will leave on the thread when detaching. show thread run Show whether the current thread is allowed to run. since when gdb has control. enables debugging messages specific to the QNX Neutrino support.g. gdb’s thread suspend counts are relative to the value gdb finds when it notices each thread. 21. set thread default exception-port. use set thread takeover-suspend-count to force it to an absolute value. this command comes in handy to suspend only the current thread. etc. if you used set task pause off (see above). This overrides the port set by set task exception-port (see above). set thread excp is the shorthand alias. set thread default show thread default Each of the above set thread commands has a set thread default counterpart (e. set thread detach-suspend-count This command sets the suspend count gdb will leave on a thread when detaching. This command changes the suspend counts to be absolute instead. set thread run This command sets whether the current thread is allowed to run. show debug nto-debug Show the current state of QNX Neutrino messages. set thread takeover-suspend-count Normally.7 QNX Neutrino gdb provides the following commands specific to the QNX Neutrino target: set debug nto-debug When set to on. However.).. The thread default variety of commands sets the default thread properties for all threads.1. Normally. this command has no effect. show thread pause This command shows the state of current thread suspension.244 Debugging with gdb continued. you can then change the properties of individual threads with the non-default commands. This number is relative to the suspend count found by gdb when it notices the thread. . the whole task is suspended. set thread exception-port set thread excp Set the thread exception port to which to forward exceptions.

faults are first reported as a Mach exception and are then mapped to a Posix signal. enables debugging messages specific to the Darwin support.) Higher values produce more verbose output. Higher values produce more verbose output. attached via TCP/IP.2 Embedded Operating Systems This section describes configurations involving the debugging of embedded operating systems that are available for several different architectures. to distinguish it from a gdb for debugging programs on the host itself. The argument machinename is the target system’s machine name or IP address. set mach-exceptions on set mach-exceptions off On Darwin. The program gdb is installed and executed on the Unix host.) . On VxWorks. show mach-exceptions Show the current state of exceptions trapping. (It may be installed with the name vxgdb. show debug darwin Show the current state of Darwin messages. Use this command to turn on trapping of Mach exceptions in the inferior.2.8 Darwin gdb provides the following commands specific to the Darwin target: set debug darwin num When set to a non zero value. set debug mach-o num When set to a non zero value. Already-running tasks spawned from the VxWorks shell can also be debugged. load links filename dynamically on the current target system as well as adding its symbols in gdb.Chapter 21: Configuration-Specific Information 245 21. (Mach-O is the file format used on Darwin for object and executable files. enables debugging messages while gdb is reading Darwin object files. This might be sometimes useful to better understand the cause of a fault. gdb enables developers to spawn and debug tasks running on networked VxWorks targets from a Unix host. gdb uses code that runs on both the Unix host and on the VxWorks target. gdb includes the ability to debug programs running on various real-time operating systems. 21. 21.1. The default is off.1 Using gdb with VxWorks target vxworks machinename A VxWorks system. show debug mach-o Show the current state of Mach-O file messages. This is a command to diagnose problems internal to gdb and should not be needed in normal usage.

gdb then attempts to read the symbol tables of any object modules loaded into the VxWorks target since it was last booted. type this on VxWorks: . The object file given as an argument to the load command is actually opened twice: first by the VxWorks target in order to download the code.a’ in your VxWorks system image and set your Unix execution search path to find gdb. From your Unix host. add the appropriate directory to the search path with the gdb command path.a’. you are ready to run gdb. run gdb (or vxgdb. To use gdb with VxWorks. When this happens.4 [Your Program’s Environment].h’ and rebuild your VxWorks kernel. For instance. and then to reference the file by its name. The following information on connecting to VxWorks was current when this manual was produced. and spawns the source debugging task tRdbTask when VxWorks is booted. Once you have included ‘rdb. if it fails to find an object file.a’. Connected to tt. To do this.1.o: No such file or directory. and execute the target command again. and args represents the number of seconds gdb waits for responses to rpc’s. The resulting kernel contains ‘rdb. gdb comes up showing the prompt: (vxgdb) 21.1 Connecting to VxWorks The gdb command target lets you connect to a VxWorks target on the network. you must rebuild your VxWorks kernel to include the remote debugging interface routines in the VxWorks library ‘rdb. page 29). depending on your installation). To load this program. newer releases of VxWorks may use revised procedures. define INCLUDE_ RDB in the VxWorks configuration file ‘configAll.2 VxWorks Download If you have connected to the VxWorks target and you want to debug an object that has not yet been loaded. This can lead to problems if the current working directories on the two systems differ. You might use this if your VxWorks target is a slow software simulator or is on the far side of a thin network line. Otherwise.2. To connect to a target whose host name is “tt”. it displays a message such as: prog.246 Debugging with gdb VxWorks-timeout args All VxWorks-based targets now support the option vxworks-timeout.. you can avoid these problems by using absolute paths. then by gdb in order to read the symbol table.2.. If both systems have NFS mounted the same filesystems. type: (vxgdb) target vxworks tt gdb displays messages like these: Attaching remote machine across net. a program ‘prog. you can use the gdb load command to download a file from Unix to VxWorks incrementally. gdb locates these files by searching the directories listed in the command search path (see Section 4. without any path. it is simplest to set the working directory on both systems to the directory in which the object file resides. see the manufacturer’s manual. For more information on configuring and remaking VxWorks.o’ may reside in ‘vxpath/vw/demo/rdb’ in VxWorks and in ‘hostpath/vw/demo/rdb’ on the host. This option is set by the user.1. 21.

Whenever a specific embedded processor has a simulator.1 ARM target rdi dev ARM Angel monitor.2. sim command Send an arbitrary command string to the simulator.Chapter 21: Configuration-Specific Information 247 -> cd "vxpath/vw/demo/rdb" Then. (This is necessary in order to preserve the integrity of debugger’s data structures that reference the target system’s symbol table. The "std" style is the standard style. type: (vxgdb) cd hostpath/vw/demo/rdb (vxgdb) load prog. 21.) 21. You may use this target to communicate with both boards running the Angel monitor.3 Embedded Processors This section goes into details specific to particular embedded configurations.3. Consult the documentation for the specific simulator in use for information about acceptable commands. auto-displays. via RDI library interface to ADP protocol. gdb provides the following ARM-specific commands: set arm disassembler This commands selects from a list of disassembly styles.. target rdp dev ARM Demon monitor.3 Running Tasks You can also attach to an existing task using the attach command as follows: (vxgdb) attach task where task is the VxWorks hexadecimal task ID. gdb allows to send an arbitrary command to the simulator. The task can be running or suspended when you attach to it. show arm disassembler Show the current disassembly style. You can also use the load command to reload an object module after editing and recompiling the corresponding source file.1.. . 21. and to clear the value history.o. Note that this makes gdb delete all currently-defined breakpoints. in gdb. and convenience variables. Running tasks are suspended at the time of attachment. or with the EmbeddedICE JTAG debug device. set arm apcs32 This command toggles ARM operation mode between 32-bit and 26-bit. done.o gdb displays a response similar to this: Reading symbol data from wherever/vw/demo/rdb/prog.

with mixed-endian doubles on little-endian ARM processors. when available. to determine whether instructions are ARM or Thumb. The following commands are available when an ARM target is debugged using the RDI interface: rdilogfile [file] Set the filename for the ADP (Angel Debugger Protocol) packet log. set arm force-mode (arm|thumb|auto) This command overrides use of the symbol table to determine whether instructions are ARM or Thumb.248 Debugging with gdb show arm apcs32 Display the current usage of the ARM 32-bit mode. The default is ‘auto’.log’. GCC-compiled FPA co-processor. set arm fpu fputype This command sets the ARM floating-point unit (FPU) type. show arm abi Show the currently used ABI. With an argument. sets the log file to the specified file. With no argument. . The default log file is ‘rdi. set arm abi This command forces gdb to use the specified ABI. show the current log file name. VFP co-processor. The argument fputype can be one of these: auto softfpa fpa softvfp vfp Determine the FPU type by querying the OS ABI. Software FPU. which causes gdb to use the symbol table and then the setting of ‘set arm fallback-mode’. show arm force-mode Show the current forced instruction mode. This command controls gdb’s default behavior when the symbol table is not available. which causes gdb to use the current execution mode (from the T bit in the CPSR register). set arm fallback-mode (arm|thumb|auto) gdb uses the symbol table. show debug arm Show whether ARM-specific debugging messages are enabled. The default is ‘auto’. show arm fpu Show the current type of the FPU. set debug arm Toggle whether to display ARM-specific debugging messages from the ARM target support subsystem. show arm fallback-mode Show the current fallback instruction mode. Software FPU with pure-endian doubles.

. set rdiheartbeat Enable or disable RDI heartbeat packets. so that zero address can be used. show download-path Show the default path for downloadable srec files. show rdiromatzero Show the current setting of ROM at zero address. If on. target sim [simargs] . The gdb ARM simulator accepts the following optional arguments. With an argument of 1 or "yes" enables logging. The default value is all.2 Renesas M32R/D and M32R/SDI target m32r dev Renesas M32R/D ROM monitor.3.. it needs to be invoked prior to the target rdi command. target m32rsdi dev Renesas M32R SDI server. If off (the default). set rdiromatzero Tell gdb whether the target has ROM at address 0. as well as the Angel monitor. show rdiheartbeat Show the setting of RDI heartbeat packets. The following gdb commands are specific to the M32R monitor: set download-path path Set the default path for finding downloadable srec files. When logging is enabled. with an argument 0 or "no" disables it. since it confuses ARM and EPI JTAG interface. It is not recommended to turn on this option. connected via parallel port to the board. For this command to take effect. none demon angel redboot all 21. --swi-support=type Tell the simulator which SWI interfaces to support. vector catching is disabled.. vector catching is enabled. type may be a comma separated list of the following values. ADP packets exchanged between gdb and the RDI target device are logged to a file. With no arguments displays the current setting.Chapter 21: Configuration-Specific Information 249 rdilogenable [arg] Control logging of ADP packets.

The following commands are available for M32R/SDI: sdireset sdistatus This command shows the SDI connection status.4 MicroBlaze The MicroBlaze is a soft-core processor supported on various Xilinx FPGAs.3 M68k The Motorola m68k configuration includes ColdFire support. use_debug_dma Instructs the remote to use the DEBUG DMA method of accessing memory. use_mon_code Instructs the remote to use the MON CODE method of accessing memory. use_dbt_break Instructs the remote to set breakpoints by DBT. 21. such as Spartan or Virtex series. If no file argument is given. tload [file] Test the upload command. 21. This command resets the SDI connection. The Xilinx Microprocessor Debugger (XMD) program communicates . and a target command for the following ROM monitor. show board-address Show the current IP address of the target board. Boards with these processors usually have JTAG ports which connect to a host system running the Xilinx Embedded Development Kit (EDK) or Software Development Kit (SDK). show server-address Display the IP address of the download server. which is the gdb’s host machine. upload [file] Upload the specified srec file via the monitor’s Ethernet upload capability. use_ib_break Instructs the remote to set breakpoints by IB break. set server-address addr Set the IP address for the download server.250 Debugging with gdb set board-address addr Set the IP address for the M32R-EVA target board. debug_chaos Instructs the remote that M32R/Chaos debugging is to be used. This host system is used to download the configuration bitstream to the target FPGA.3. target dbug dev dBUG ROM monitor for Motorola ColdFire.3. the current executable file is uploaded.

target pmon port PMON ROM monitor.5 MIPS Embedded gdb can use the MIPS remote debugging protocol to talk to a MIPS board attached to a serial line. By default xmd uses port 1234. using the syntax ‘hostname:portnumber’. target remote xmd-host:1234 Use this command to connect to the target if it is connected to xmd running on a different system named xmd-host. use the command ‘target mips port’. this sequence connects to the target board through a serial port.. it requires the use of undocumented xmd commands.3. target remote :1234 Use this command to connect to the target if you are running gdb on the same system as xmd. If the program has not already been downloaded to the board. . This is available when you configure gdb with ‘--target=mips-idt-ecoff’. set debug microblaze n Enable MicroBlaze-specific debugging messages if non-zero.. where port is the name of the serial port connected to the board. start up gdb with the name of your program as the argument.Chapter 21: Configuration-Specific Information 251 with the target board using the JTAG interface and presents a gdbserver interface to the board. Contact Xilinx support if you need to do this. target ddb port NEC’s DDB variant of PMON for Vr4300. you may use the load command to download it.) Use these GDB commands to connect to the MicroBlaze target processor. 21. show debug microblaze n Show MicroBlaze-specific debugging level. You can then use all the usual gdb commands. Use these gdb commands to specify the connection to your target board: target mips port To run a program on the board. to a serial line managed by a terminal concentrator) instead of a serial port. To connect to the board. load Use this command to download a program to the MicroBlaze target. (While it is possible to change this default port. you can specify a TCP connection (for instance. (gdb) target mips /dev/ttyb (gdb) load prog (gdb) run target mips hostname:portnumber On some gdb host configurations. and loads and runs a program called prog through the debugger: host$ gdb prog gdb is free software and . For example.

target array dev Array Tech LSI33K RAID controller board.252 Debugging with gdb target lsi port LSI variant of PMON.) The timeout set by set timeout does not apply when gdb is waiting for your program to stop. you can control the timeout used while waiting for an acknowledgment of a packet with the set retransmit-timeout seconds command. so ‘set mipsfpu on’ will select double precision and ‘set mipsfpu off’ will select no floating point. As usual. You can inspect both values with show timeout and show retransmit-timeout. with the set timeout seconds command. gdb also supports these special commands for MIPS targets: set mipsfpu double set mipsfpu single set mipsfpu none set mipsfpu auto show mipsfpu If your target board does not support the MIPS floating point coprocessor. target r3900 dev Densan DVE-R3900 ROM monitor for Toshiba R3900 Mips. It also allows gdb to avoid saving the floating point registers when calling functions on the board. in the MIPS remote protocol. Similarly. (These commands are only available when gdb is configured for ‘--target=mips-idt-ecoff’. Setting the limit to -1 means there’s no limit. This tells gdb how to find the return value of functions which return floating point values. set timeout seconds set retransmit-timeout seconds show timeout show retransmit-timeout You can control the timeout used while waiting for a packet. as on the r4650 processor. gdb waits forever because it has no way of knowing how long the program is going to run before stopping. In previous versions the only choices were double precision or no floating point. you should use the command ‘set mipsfpu none’ (if you need this. The default is 10 characters. use the command ‘set mipsfpu single’. The default is 5 seconds. The default double precision floating point coprocessor may be selected using ‘set mipsfpu double’. you can inquire about the mipsfpu variable with ‘show mipsfpu’. you may wish to put the command in your gdb init file). In that case. If you are using a floating point coprocessor with only single precision floating point support. . The default is 3 seconds. set syn-garbage-limit num Limit the maximum number of characters gdb should ignore when it tries to synchronize with the remote target.

Example: target jtag jtag://localhost:9999 or1ksim command If connected to or1ksim OpenRISC 1000 Architectural Simulator.org) for more information about platform and commands. target jtag jtag://host:port Connects to remote JTAG server. pmon command This command allows sending an arbitrary command string to the monitor. connected via parallel port to the board. set monitor-warnings Enable or disable monitor warnings about hardware breakpoints. .Chapter 21: Configuration-Specific Information 253 show syn-garbage-limit Show the current limit on the number of characters to ignore when trying to synchronize with the remote system. The default depends on the target: pmon target ‘PMON’ ddb target ‘NEC010’ lsi target ‘PMON>’ show monitor-prompt Show the current strings gdb expects as the prompt from the remote monitor. 21. This has effect only for the lsi target. info info info info or1k or1k or1k or1k spr group register spr register spr groupno registerno spr registerno Shows information about specified spr register. The monitor must be in debug mode for this to work. info or1k spr group info or1k spr groupno Displays register names in selected group. gdb will display warning messages whose codes are returned by the lsi PMON monitor for breakpoint commands. JTAG remote server can be either an or1ksim or JTAG server. proprietary commands can be executed.6 OpenRISC 1000 See OR1k Architecture document (www. info or1k spr Displays spr groups. show monitor-warnings Show the current setting of printing monitor warnings. When on.opencores. set monitor-prompt prompt Tell gdb to expect the specified prompt string from the remote monitor.3.

Hardware breakpoints/watchpoint triggers can be set using: $LEA/$LDATA Load effective address/data $SEA/$SDATA Store effective address/data $AEA/$ADATA Access effective address ($SEA or $LEA) or data ($SDATA/$LDATA) $FETCH Fetch data When triggered. htrace record [data]* Selects the data to be recorded. it can capture low level data. For example: hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50) hwatch ($LEA == my_var) && ($LDATA < 50) || ($SEA == my_var) && ($SDATA >= 50) htrace info Display information about current HW trace configuration. htrace stop conditional Set HW trace stopping criteria. htrace qualifier conditional Set acquisition qualifier for HW trace. Some implementations of OpenRISC 1000 Architecture also have hardware trace.254 Debugging with gdb spr spr spr spr group register value register value groupno registerno value registerno value Writes value to specified spr register. READSPR. . when qualifier is met and HW trace was triggered. htrace enable htrace disable Enables/disables the HW trace. like: PC. LSEA. except it does not interfere with normal program execution and is thus much faster. WRITESPR. It is very similar to gdb trace. htrace trigger conditional Set starting criteria for HW trace. LDATA. htrace commands: hwatch conditional Set hardware watchpoint on combination of Load/Store Effective Address(es) or Data. SDATA. INSTR.

34 or newer. unless the exact-watchpoints option is on. 21.7 PowerPC Embedded gdb supports using the DVC (Data Value Compare) register to implement in hardware simple hardware watchpoint conditions of the form: (gdb) watch ADDRESS|VARIABLE \ if ADDRESS|VARIABLE == CONSTANT EXPRESSION The DVC register will be automatically used when gdb detects such pattern in a condition expression. A ranged breakpoint stops execution of the inferior whenever it executes an instruction at any address within the range it specifies.2 [Specify Location]. or an address of an instruction (see Section 9. htrace mode suspend Set suspend trace mode. for a list of all the possible ways to specify a location. use the break-range command. htrace mode continuous Set continuous trace mode. or the variable has a length of one byte).3. page 49. and the created watchpoint uses one debug register (either the exactwatchpoints option is on and the variable is scalar. page 97): (gdb) watch *((char *) address)@length (gdb) watch {char[length]} address PowerPC embedded processors support masked watchpoints. See the discussion about the mask argument in Section 5. an offset of lines from the current line or from the start location. using current record configuration. gdb automatically uses ranged hardware watchpoints. When running on PowerPC embedded processors. You can create an artificial array to watch an arbitrary memory region using one of the following commands (see Section 10. start-location and end-location can specify a function name. in which case watchpoints using only one debug register are created when watching variables of scalar types. gdb provides the following PowerPC-specific commands: break-range start-location.2 [Set Watchpoints]. a line number. page 88. To set a ranged breakpoint in gdb. This feature is available in native gdb running on a Linux kernel version 2. new trace file is made and any newly collected data will be written there.1.) The breakpoint will stop execution of the inferior whenever it executes an instruction at any address within the specified range.) .6. If filename is specified. end-location Set a breakpoint for an address range. (including start-location and endlocation. PowerPC embedded processors support hardware accelerated ranged breakpoints. htrace print [start [len]] Prints trace buffer.Chapter 21: Configuration-Specific Information 255 htrace rewind [filename] Clears currently recorded trace data.1 [Expressions].

thus assuming that the variable is accessed through the address of its first byte. sds command Send the specified command string to the SDS monitor.256 Debugging with gdb set powerpc soft-float show powerpc soft-float Force gdb to use (or not use) a software floating point calling convention. show sdstimeout Show the current value of the SDS timeout. The valid options are ‘auto’. running on an OKI HPPA board. target ppcbug dev target ppcbug1 dev PPCBUG ROM monitor for PowerPC. . set powerpc vector-abi show powerpc vector-abi Force gdb to use the specified calling convention for vector arguments and return values.3. running on a Winbond HPPA board. to use AltiVec registers. By default. 21. target dink32 dev DINK32 ROM monitor. The program gdb is installed and executed on the Unix host. set powerpc exact-watchpoints show powerpc exact-watchpoints Allow gdb to use only one debug register when watching a variable of scalar type. running on a PowerPC board (such as Motorola’s ADS). ‘generic’.3. gdb selects the calling convention based on the selected architecture and the provided executable file. and ‘spe’ to use SPE registers. By default. ‘altivec’.8 HP PA Embedded target op50n dev OP50N monitor. gdb uses code that runs on both the Unix host and on the Sparclet target. The default is 2 seconds. 21.9 Tsqware Sparclet gdb enables developers to debug tasks running on Sparclet targets from a Unix host. The following commands specific to the SDS protocol are supported by gdb: set sdstimeout nsec Set the timeout for SDS protocol reads to be nsec seconds. to avoid vector registers even if they are present. target w89k dev W89K monitor. gdb selects the calling convention based on the selected architecture and the provided executable file. target sds dev SDS monitor.

Chapter 21: Configuration-Specific Information 257 remotetimeout args gdb supports the option remotetimeout.3.9./prog. When compiling for debugging. you are ready to run gdb. gdb locates the file by searching the directories listed in the command search path. If it fails to find a file. add the appropriate directories to the search paths with the gdb commands path and dir. if the program ‘prog’ was linked to text address 0x1201000. Example: sparclet-aout-gcc prog. type: .2 Connecting to Sparclet The gdb command target lets you connect to a Sparclet target.. For instance.9. the program must be loaded to the starting address. From your Unix host. and execute the target command again. source files will be searched as well.c:3 gdb displays messages like these: Connected to ttya. run gdb (or sparclet-aout-gdb. You may also want to add the options ‘-n’ or ‘-N’ in order to reduce the size of the sections. 21.4 [Your Program’s Environment]. If the file was compiled with debug information (option ‘-g’). page 29). with data at 0x12010160 and bss at 0x12010170.9.3. gdb locates the source files by searching the directories listed in the directory search path (see Section 4. you can use the gdb load command to download the file from the host to the target. The file name and load offset should be given as arguments to the load command. and args represents the number of seconds gdb waits for responses. This option is set by the user. To connect to a target on serial port “ttya”. Since the file format is aout.1 Setting File to Debug The gdb command file lets you choose with program to debug. depending on your installation). You can use objdump to find out what this value is.3 Sparclet Download Once connected to the Sparclet target. include the options ‘-g’ to get debug information and ‘-Ttext’ to relocate the program to where you wish to load it on the target.3. (gdbslet) file prog gdb then attempts to read the symbol table of ‘prog’. gdb comes up showing the prompt: (gdbslet) 21. When this happens. type: (gdbslet) target sparclet /dev/ttya Remote target sparclet connected to /dev/ttya main () at .c -Ttext 0x12010000 -g -o prog -N You can use objdump to verify that the addresses are what you intended: sparclet-aout-objdump --headers --syms prog Once you have set your Unix execution search path to find gdb. The load offset is an offset which is added to the VMA (virtual memory address) of each of the file’s sections. it displays a message such as: prog: No such file or directory. in gdb. 21.

‘b fputc if $cycles>5000’ sets a conditional breakpoint that suspends only after at least 5000 simulated clock ticks. Execution time in 60ths of a second. You must use an additional command to debug the program. the run command to run your program. argv=0xeffff21c) at prog.4 Running and Debugging You can now begin debugging the task using gdb’s execution control commands. . The simulator recognizes which architecture is appropriate by inspecting the object code. step. As well as making available all the usual machine registers (see Section 10. b.258 Debugging with gdb (gdbslet) load prog 0x12010000 Loading section . Counts instructions run in the simulator.3. main (argc=1. the Z8000 simulator provides three additional items of information as specially named registers: cycles insts time Counts clock-ticks in the simulator. use the file command to load a new program image. You can refer to these values in gdb expressions with the usual conventions.3. run.9.text.11 Zilog Z8000 When configured for debugging Zilog Z8000 targets. line 3.12 [Registers]. (gdbslet) 21. etc. For example: target remote dev using gdb standard remote protocol.c:3 3 char *symarg = 0.10 Fujitsu Sparclite target sparclite dev Fujitsu sparclite boards.3. and so on. 21. 21. (gdbslet) b main Breakpoint 1 at 0x12010000: file prog. size 0xdb0 vma 0x12010000 If the code is loaded at a different address then what the program was linked to. If the simulator supports setup options. for example. For the Z8000 family. After specifying this target. you can debug programs for the simulated CPU in the same style as programs for your host computer. target sim args Debug programs on a simulated CPU.c. used only for the purpose of loading. you may need to use the section and add-symbol-file commands to tell gdb where to map the symbol table. page 119). ‘target sim’ simulates either the Z8002 (the unsegmented variant of the Z8000 architecture) or the Z8001 (the segmented variant). See the gdb manual for the list of commands. (gdbslet) step 4 char *execarg = "hello!". (gdbslet) run Starting program: prog Breakpoint 1. specify them via args. gdb includes a Z8000 simulator.

and ‘renesas’. gdb provides these commands: regs Show the values of all Super-H registers. 21. It should only be changed when debugging in guru mode. gdb supports the following AVR-specific commands: info io_registers This command displays information about the AVR I/O registers. With the ‘gcc’ setting. regardless of the DWARF-2 information. . in which case it should be set to ‘guru’ (the default is ‘normal’). show sh calling-convention Show the current calling convention setting. The default is ‘on’.14 Renesas Super-H For the Renesas Super-H processor. set sh calling-convention convention Set the calling-convention used when calling functions from gdb. The CRIS version affects register names and sizes.3.13 CRIS When configured for debugging CRIS. If the calling convention is set to ‘renesas’. show cris-mode Show the current CRIS mode. set cris-mode mode Set the current CRIS mode to mode. For each register. the function is called using the Renesas calling convention. This command is useful in case autodetection of the CRIS version fails. or the compiler does not emit the DWARF-2 calling convention entry for a function. gdb prints its number and value. functions are called using the gcc calling convention. gdb provides the following CRIS-specific commands: set cris-version ver Set the current CRIS version to ver.12 Atmel AVR When configured for debugging the Atmel AVR. either ‘10’ or ‘32’.3. the Renesas calling convention is always used. show cris-version Show the current CRIS version.Chapter 21: Configuration-Specific Information 259 21. set cris-dwarf2-cfi Set the usage of DWARF-2 CFI for CRIS debugging. If the DWARF-2 information of the called function specifies that the function follows the Renesas calling convention. 21. Change to ‘off’ when using gcc-cris whose version is below R59. Allowed values are ‘gcc’. show cris-dwarf2-cfi Show the current state of using DWARF-2 CFI.3. which is the default setting. This can be used to override the default of ‘gcc’ if debug information is missing.

show heuristic-fence-post Display the current limit. and "default" (the default). Normally. you can get around this problem by specifying the ending address of the register stack with the set rstack_high_address command.1 x86 Architecture-specific Issues set struct-convention mode Set the convention used by the inferior to return structs and unions from functions to mode.4.4.260 Debugging with gdb 21. or 8 bytes will be returned in a register. This may result in gdb referencing memory locations that do not exist. 21. the larger the limit the more bytes heuristic-fence-post must search and therefore the longer it takes to run. There is no way for gdb to determine the extent of this stack. A value of 0 (the default) means there is no limit. where gdb may be restricted to a slow serial line for this search) you may want to limit the size of this search. 21. . However.4 MIPS Alpha.3 Alpha See the following section. both native and cross. 4. "default" or "pcc" means that structs are returned on the stack. which you probably want to precede with ‘0x’ to specify in hexadecimal. except for 0. which sometimes requires gdb to search backward in the object code to find the beginning of a function.4. If necessary.4 Architectures This section describes characteristics of architectures that affect all uses of gdb with the architecture. using one of these commands: set heuristic-fence-post limit Restrict gdb to examining at most limit bytes in its search for the beginning of a function. show struct-convention Show the current setting of the convention to return structs from functions. You should only need to use this command when debugging a stripped executable. The argument should be an address. 21. gdb just assumes that the stack is “large enough”.2 A29K set rstack_high_address address On AMD 29000 family processors. on AMD 29000 family processors. while "reg" means that a struct or a union whose size is 1. "reg".and MIPS-based computers use an unusual stack frame. registers are saved in a separate register stack. Possible values of mode are "pcc". show rstack_high_address Display the current limit of the register stack.4. 21. To improve response time (especially for embedded applications. 2.

page 251. set debug mips This command turns on and off debugging messages for the MIPS-specific target code in gdb. or ‘auto’. set mips mask-address arg This command determines whether the most-significant 32 bits of 64-bit MIPS addresses are masked off.3.Chapter 21: Configuration-Specific Information 261 These commands are available only when gdb is configured for debugging programs on Alpha or MIPS processors. which lets gdb determine the correct value.5 [MIPS Embedded]. show mips mask-address Show whether the upper 32 bits of MIPS addresses are masked off or not. . set remote-mips64-transfers-32bit-regs This command controls compatibility with 64-bit MIPS targets that transfer data in 32-bit quantities. like sr and fsr. show debug mips Show the current setting of MIPS debugging messages. The argument arg can be ‘on’. The latter is the default setting. show remote-mips64-transfers-32bit-regs Show the current setting of compatibility with older MIPS 64 targets. set this option to ‘on’. The default ABI associated with the current binary (this is the default). Possible values of arg are: ‘auto’ ‘o32’ ‘o64’ ‘n32’ ‘n64’ ‘eabi32’ ‘eabi64’ show mips abi Show the MIPS ABI used by gdb to debug the inferior. set mipsfpu show mipsfpu See Section 21. ‘off’. Several MIPS-specific commands are available when debugging MIPS programs: set mips abi arg Tell gdb which MIPS ABI is used by the inferior. and 64 bits for other registers. If you have an old MIPS 64 target that transfers 32 bits for some registers.

21. For each entry.262 Debugging with gdb 21. tag.4. it provides the following special commands: set debug hppa This command determines whether HPPA architecture-specific debugging messages are to be displayed. maint print unwind address This command displays the contents of the unwind table entry at the given address. and SPU Read Inbound mailboxes. info spu proxydma Display MFC Proxy-DMA status. For each entry. SPU Write Outbound Interrupt. info spu dma Display MFC DMA status. show debug hppa Show whether HPPA debugging messages are displayed. opcode. When set to on. opcode. Shows pending signal-control word and signal notification mode of both signal notification channels. Shows all pending commands in the MFC Proxy-DMA queue. When gdb is debugging a combined PowerPC/SPU application on the Cell Broadband Engine. class IDs. Shows all pending commands in the MFC DMA queue. in order of processing. in each of the SPU Write Outbound.4. gdb will give control to the user when a new SPE thread enters its main function. Shows all pending entries.6 Cell Broadband Engine SPU architecture When gdb is debugging the Cell Broadband Engine SPU architecture. effective and local store addresses and transfer size are shown. tag. The default is off. it provides the following special commands: info spu event Display SPU event facility status. class IDs.5 HPPA When gdb is debugging the HP PA architecture. . effective and local store addresses and transfer size are shown. it provides in addition the following special commands: set spu stop-on-load arg Set whether to stop for new SPE threads. show spu stop-on-load Show whether to stop for new SPE threads. Shows current event mask and pending event status. info spu signal Display SPU signal notification facility status. info spu mailbox Display SPU mailbox facility status.

Chapter 21: Configuration-Specific Information 263 set spu auto-flush-cache arg Set whether to automatically flush the software-managed cache. the 64-bit wide Extended Floating Point Registers (‘f32’ through ‘f63’). f2 and f3 for $dl1 and so on. This provides a consistent view of PowerPC memory that is accessed via the cache.7 PowerPC When gdb is debugging the PowerPC architecture. For POWER7 processors. show spu auto-flush-cache Show whether to automatically flush the software-managed cache. always starting at an even register like f0 or f2. and are formed by joining the even/odd register pairs f0 and f1 for $dl0. If an application does not use the software-managed cache. The pseudo-registers go from $dl0 through $dl15.4. it provides a set of pseudo-registers to enable inspection of 128-bit wide Decimal Floating Point numbers stored in the floating point registers. . 21. gdb provides a set of pseudo-registers. this option has no effect. These values must be stored in two consecutive registers. gdb will automatically cause the SPE software-managed cache to be flushed whenever SPE execution stops. When set to on.

.

Other settings are described here. csh-like history substitution. when debugging gdb with gdb. The commands for interacting with these extensions are: set extended-prompt prompt Set an extended prompt that allows for substitutions. page 285. page 324.4. For example: set extended-prompt Current working directory: \w (gdb) Note that when an extended-prompt is set. show prompt Prints a line of the form: ‘Gdb’s prompt is: your-prompt’ Versions of gdb that ship with Python scripting enabled have prompt extensions. it is useful to change the prompt in one of the gdb sessions so that you can always tell which one you are talking to. are replaced with the corresponding strings each time the prompt is displayed. See [prompt hook].2 Command Editing gdb reads its input commands via the Readline interface.2. You can change the prompt string with the set prompt command. You may control the behavior of command line editing in gdb with the command set. it takes control of the prompt hook hook. Advantages are gnu Emacs-style or vi-style inline editing of commands. for a list of escape sequences that can be used for substitution. show extended-prompt Prints the extended prompt. This allows you to set a prompt which ends in a space or a prompt that does not. set prompt newprompt Directs gdb to use newprompt as its prompt string henceforth. 22. For commands controlling how gdb displays data. This string is normally ‘(gdb)’. set editing set editing on Enable command line editing (enabled by default). Any escape sequences specified as part of the prompt string with set extended-prompt. For instance. Note: set prompt does not add a space for you after the prompt you set.8 [Print Settings]. See Section 23. Any escape sequences specified as part of the prompt string are replaced with the corresponding strings each time the prompt is displayed.prompt]. and a storage and recall of command history across debugging sessions. see Section 10. page 106.1 Prompt gdb indicates its readiness to read a command by printing a string called the prompt.3 [gdb. This gnu library provides consistent behavior for programs which provide a command line interface to the user. . 22.Chapter 22: Controlling gdb 265 22 Controlling gdb You can alter the way gdb interacts with you by using the set command. for further information.

This defaults to the value of the environment variable HISTSIZE. or to 256 if this variable is not set. prefix it with ‘server ’ (see Section 28.1. To issue a command to gdb without affecting certain aspects of the state which is seen by users. page 443. Since ! is also the logical not operator in C. or to ‘. for the detailed description of the History library. Users unfamiliar with gnu Emacs or vi are encouraged to read that chapter. for more details. This means that this command will not affect the command history./. you may .2 [Server Prefix]. and where it writes the command history from this session when it exits. 22. See Chapter 31 [Command Line Editing]. page 421. history expansion is off by default. for more details about the Readline interface. History expansion assigns special meaning to the character !.3 Command History gdb can keep track of the commands you type during your debugging sessions. Use these commands to manage the gdb command history facility. to provide the history facility. set history save set history save on Record command history in a file. a part of the Readline package. this option is disabled. to print a value without recording it into the value history. The server prefix does not affect the recording of values into the value history. By default. gdb uses the gnu History library. See Chapter 32 [Using History Interactively]. Here is the description of gdb commands related to command history. show editing Show whether command line editing is enabled. use the output command instead of the print command. This file defaults to the value of the environment variable GDBHISTFILE. set history filename fname Set the name of the gdb command history file to fname./_gdb_history’ on MS-DOS) if this variable is not set. You can access this list through history expansion or through the history command editing characters listed below.gdb_history’ (‘. whose name may be specified with the set history filename command. If you decide to enable history expansion with the set history expansion on command. set history size size Set the number of commands which gdb keeps in its history list.266 Debugging with gdb set editing off Disable command line editing. This is the file where gdb reads an initial command history list. nor will it affect gdb’s notion of which command to repeat if RET is pressed on a line by itself. page 443. See Section 32. page 412).1 [Event Designators]. set history save off Stop recording command history in a file. so that you can be certain of precisely what happened.

you can override it with the set height and set width commands: set height lpp show height set width cpl show width These set commands specify a screen height of lpp lines and a screen width of cpl characters. history by itself displays all four states. gdb pauses and asks you for input at the end of each page of output. show commands n Print ten commands centered on command number n. in an expression) with a space or a tab to prevent it from being expanded. The commands to control history expansion are: set history expansion on set history expansion Enable history expansion. History expansion is off by default. The associated show commands display the current settings. Normally gdb knows the size of the screen from the terminal driver software. If this is not correct. To help you read all of it.4 Screen Size Certain commands to gdb may produce large amounts of information output to the screen. This is useful if output is to a file or to an editor buffer. even when history expansion is enabled. 22. show commands + Print ten commands just after the commands last printed. Also.Chapter 22: Controlling gdb 267 sometimes need to follow ! (when it is used as logical not. or q to discard the remaining output. the screen width setting determines when to wrap lines of output. set history expansion off Disable history expansion. Depending on what is being printed. rather than simply letting it overflow onto the following line. on Unix gdb uses the termcap data base together with the value of the TERM environment variable and the stty rows and stty cols settings. For example. gdb tries to break the line at a readable place. If you specify a height of zero lines. show show commands Display the last ten commands in the command history. show show show show show history history filename history save history size history expansion These commands display the state of the gdb history parameters. . gdb does not pause during output no matter how long the output is. The readline history facilities do not attempt substitution on the strings != and !(. Type RET when you want to continue the output.

. by default. nor end with a ‘. Supported choices for base are decimal 8. base must itself be specified either unambiguously or using the current input radix. as 16 decimal. since ‘10’. if the current radix is 16. base must itself be specified either unambiguously or using the current input radix. set input-radix 0xa sets the input base to decimal.268 Debugging with gdb Likewise. you can specify ‘set width 0’ to prevent gdb from wrapping its output. or hexadecimal in gdb by the usual conventions: octal numbers begin with ‘0’. Note that running gdb with the ‘--batch’ option (see Section 2. Numbers that neither begin with ‘0’ or ‘0x’. You can change the default base for both input and output with the commands described below. for example. the default display for numbers—when no particular format is specified—is base 10. Thus. show pagination Show the current pagination mode. it resets the radix back to its default value of 10. the default is on. set output-radix base Set the default base for numeric display. On the other hand. being without any leading or trailing signs of its base. or 16.2 [Mode Options]. likewise. or 16.1. show output-radix Display the current default base for numeric display. 22. decimal. 10. is interpreted in the current radix. Supported choices for base are decimal 8.5 Numbers You can always enter numbers in octal. set pagination on set pagination off Turn the output pagination on or off. entered in base 10.’ are. any of set input-radix 012 set input-radix 10. set radix [base] show radix These commands set and show the default base for both input and output of numbers.’. ‘10’ is interpreted in hex. without an argument. which doesn’t change the radix. set radix sets the radix of input and output to the same base. and hexadecimal numbers begin with ‘0x’.e. decimal numbers end with ‘. set input-radix base Set the default base for numeric input. page 13) also automatically disables pagination. ‘set input-radix 10’ leaves the input radix unchanged. no matter what it was. Turning pagination off is the alternative to set height 0. show input-radix Display the current default base for numeric input. i. 10.

Other C++ compilers may use the “gnu-v2” or “gnu-v3” ABI’s as well. One gdb configuration can debug binaries for multiple operating system targets. show osabi Show the OS ABI currently in use. according to the architecture’s convention for float. gdb needs to know the ABI used for your program’s C++ objects. if your program contains code using multiple C++ ABI’s or if gdb can not identify your program’s ABI correctly. However. Use these commands to manage gdb’s view of the current ABI. and “hpaCC” for the HP ANSI C++ compiler. The correct C++ ABI depends on which C++ compiler was used to build your application. . This is the default setting. set coerce-float-to-double off Arguments of type float will be passed directly to unprototyped functions.0.6 Configuring the Current ABI gdb can determine the ABI (Application Binary Interface) of your application automatically. either via remote debugging or native emulation. If gdb calls a function that is not marked as prototyped. set osabi With no argument.Chapter 22: Controlling gdb 269 22. for g++ versions 3. you can tell gdb which ABI to use. the way that an argument of type float is passed to a function depends on whether the function is prototyped. One example where this is useful is in debugging of binaries which use an alternate C library (e. float arguments are passed unchanged. show coerce-float-to-double Show the current setting of promoting float to double. show cp-abi Show the C++ ABI currently in use. Generally.0 and later. it consults set coerce-float-to-double. gdb only fully supports programs with a single C++ ABI. For unprototyped (i. ANSI/ISO style) function.e. set cp-abi With no argument. Unfortunately. Currently supported ABI’s include “gnu-v2”. but you can override its conclusion using the set osabi command. The default setting is “auto”. show the list of supported C++ ABI’s. gdb will autodetect the OS ABI (Operating System ABI) in use. float arguments are first promoted to type double and then passed. set osabi abi Set the current OS ABI to abi. for g++ versions before 3. “gnu-v3”. uClibc for gnu/Linux) which does not have the same identifying marks that the standard C library for your platform provides. show the list of registered available OS ABI’s. some forms of debug information do not reliably indicate whether a function is prototyped. For a prototyped (i.g. sometimes you need to override its conclusions. set coerce-float-to-double set coerce-float-to-double on Arguments of type float will be promoted to double when passed to an unprototyped function.e. K&R style) functions.

set confirm on Enables confirmation requests (the default). Currently. you may want to use the set verbose command. if gdb encounters bugs in the symbol table of an object file.7 Optional Warnings and Messages By default. gdb is silent about its inner workings. Note that running gdb with the ‘--batch’ option (see Section 2.1 [Commands to Specify Files]. Start it from the beginning? (y or n) If you are willing to unflinchingly face the consequences of your own commands. By default. show complaints Displays how many symbol complaints gdb is permitted to produce. 22. set verbose on Enables gdb output of certain informational messages. you can disable this “feature”: set confirm off Disables confirmation requests. the messages controlled by set verbose are those which announce that the symbol table for a source file is being read.1. it is silent. . By default. gdb is cautious. you may find this information useful (see Section 18. If you are running on a slow machine. page 13) also automatically disables confirmation requests. so you will not think it has crashed. or return to automatic detection. and asks what sometimes seems to be a lot of stupid questions to confirm certain commands. if you try to run a program which is already running: (gdb) run The program being debugged has been started already.4 [Errors Reading Symbol Files]. show confirm Displays state of confirmation requests. page 213).270 Debugging with gdb set cp-abi abi set cp-abi auto Set the current C++ ABI to abi. Set limit to zero to suppress all complaints.2 [Mode Options]. This makes gdb tell you when it does a lengthy internal operation. set complaints limit Permits gdb to output limit complaints about each type of unusual symbols before becoming silent about the problem. see symbol-file in Section 18. but if you are debugging a compiler. show verbose Displays whether set verbose is on or off. set verbose off Disables gdb output of certain informational messages. For example. set it to a large number to prevent complaints from being suppressed. page 201.

show debug aix-thread Show the current state of AIX thread debugging info display. show debug check-physname Show the current state of “physname” checking. set debug arch Turns on or off display of gdbarch debugging info. 22. In this mode each command will be printed as it is executed.Chapter 22: Controlling gdb 271 If you need to debug user-defined commands or sourced files you may find it useful to enable command tracing. The default is off. A value of zero turns off the display. The value is the number of nesting levels to print. normally these commands are of interest to gdb maintainers. show exec-done-display Displays the current setting of asynchronous command completion notification. depending on exactly what information is present. When enabled. This section documents those commands. the quantity denoting the call depth of each command. gdb attempts to compute each entity’s name. set trace-commands on Enable command tracing. The default is off show debug arch Displays the current state of displaying gdbarch debugging info. When reading DWARF debugging information for C++. show trace-commands Display the current state of command tracing. set exec-done-display Turns on or off the notification of asynchronous commands’ completion. this setting causes gdb to compute the names both ways and display any discrepancies. gdb can do this computation in two different ways. set trace-commands off Disable command tracing. set debug dwarf2-die Dump DWARF2 DIEs after they are read in. gdb will print a message when an asynchronous command finishes its execution. set debug check-physname Check the results of the “physname” computation. prefixed with one or more ‘+’ symbols. . or when reporting a bug. set debug aix-thread Display debugging messages about inner workings of the AIX thread module.8 Optional Messages about Internal Happenings gdb has commands that enable optional debugging messages from various gdb subsystems. When on.

set debug jit Turns on or off debugging messages from JIT debug support. . show debug displaced Displays the current state of displaying gdb debugging info related to displaced stepping. The default is off. set debug infrun Turns on or off display of gdb debugging info for running the inferior. show debug event Displays the current state of displaying gdb event debugging info. show debug gnu-nat Show the current state of gnu/Hurd debugging messages. The default is off. set debug event Turns on or off display of gdb event debugging info. The default is off. show debug lin-lwp Show the current state of Linux LWP debugging messages. The default is off. show debug jit Displays the current state of gdb JIT debugging. set debug lin-lwp Turns on or off debugging messages from the Linux LWP debug support. set debug displaced Turns on or off display of gdb debugging info for the displaced stepping support.272 Debugging with gdb show debug dwarf2-die Show the current state of DWARF2 DIE debugging. The default is off. set debug gnu-nat Turns on or off debugging messages from the gnu/Hurd debug support.c’ contains GDB’s runtime state machine used for implementing operations such as single-stepping the inferior. ‘infrun. show debug infrun Displays the current state of gdb inferior debugging. set debug expression Turns on or off display of debugging info about gdb expression parsing. show debug expression Displays the current state of displaying debugging info about gdb expression parsing. show debug frame Displays the current state of displaying gdb frame debugging info. set debug frame Turns on or off display of gdb frame debugging info.

set debug parser Turns on or off the display of expression parser debugging output. show debug observer Displays the current state of observer debugging. show debug solib-frv Display the current state of FR-V shared-library code debugging messages. Internally. etc. and to 2 to also track the value of large memory transfers. set debug remote Turns on or off display of reports on all packets sent back and forth across the serial line to the remote machine. set debug overload Turns on or off display of gdb C++ overload debugging info. The default is 0. The default is off. The default is off. set debug target Turns on or off display of gdb target debugging info. show debug target Displays the current state of displaying gdb target debugging info. When enabled.Chapter 22: Controlling gdb 273 set debug observer Turns on or off display of gdb observer debugging. this sets the yydebug variable in the expression parser. show debug remote Displays the state of display of remote packets. as it happens. . The info is printed on the gdb standard output stream. The default is off. seconds and microseconds are displayed before each debugging message. Set it to 1 to track events. show debug serial Displays the current state of displaying gdb serial debugging info. for details. The default is off. set debug solib-frv Turns on or off debugging messages for FR-V shared-library code. set debug timestamp Turns on or off display of timestamps with gdb debugging info. See Section “Tracing Your Parser” in Bison. set debug serial Turns on or off display of gdb serial debugging info. show debug parser Show the current state of expression parser debugging. Changes to this flag do not take effect until the next time you connect to a target or use the run command. This includes info such as ranking of functions. show debug overload Displays the current state of displaying gdb C++ overload debugging info. This info includes what is going on at the target level of GDB. This includes info such as the notification of observable events.

If auto (the default). In practice. In the vast majority of cases. set debugvarobj Turns on or off display of gdb variable object debugging info.274 Debugging with gdb show debug timestamp Displays the current state of displaying timestamps with gdb debugging info. If off. set debug xml Turns on or off debugging messages for built-in XML parsers. show debugvarobj Displays the current state of displaying gdb variable object debugging info. and works in interactive-mode if it is. The default is off. such as running a MinGW gdb inside a cygwin window. and it uses the default answers to all queries. forces gdb to operate in the opposite mode. the debugger should be able to guess correctly which mode should be used. show interactive-mode Displays whether the debugger is operating in interactive mode or not. 22. this means that gdb should wait for the user to answer queries generated by commands entered at the command prompt. But this setting can be useful in certain specific cases. gdb tries to determine whether its standard input is a terminal. . non-interactively otherwise.9 Other Miscellaneous Settings set interactive-mode If on. show debug xml Displays the current state of XML debugging messages. forces gdb to assume that GDB was started in a terminal.

In addition. . $argc may be used to find out how many arguments have been passed..1 User-defined Commands A user-defined command is a sequence of gdb commands to which you assign a new name as a command. and the third is for defining new aliases of existing commands. show script-extension Display the current value of the script-extension option. See Section 23.1. 23. Otherwise. gdb is capable of evaluating the contents of a file.Chapter 23: Extending gdb 275 23 Extending gdb gdb provides three mechanisms for extension. 10. it evaluates the file as a gdb Command File. gdb can recognize which scripting language is being used by looking at the filename extension.3 [Command files]. The first is based on composition of gdb commands. 23. the second is based on the Python scripting language.7 [Breakpoint Command Lists]. page 59). This expands to a number in the range 0. and evaluates the script using that language. . so they may reference variables. use complex expressions. Files with an unrecognized filename extension are always treated as a gdb Command Files. set script-extension soft The debugger determines the scripting language based on filename extension. . User commands may accept up to 10 arguments separated by whitespace.1 Canned Sequences of Commands Aside from breakpoint commands (see Section 5.1.$arg9. gdb evaluates the script using that language. Note the arguments are text substitutions. You can control how gdb evaluates these files with the following setting: set script-extension off All scripts are always evaluated as gdb Command Files. set script-extension strict The debugger determines the scripting language based on filename extension. If the language is not supported. If this scripting language is supported. which prints the sum of its three arguments. When doing so. then the evaluation fails. page 278. gdb provides two ways to store sequences of commands for execution as a unit: user-defined commands and command files. To facilitate the use of the first two extensions. A trivial example: define adder print $arg0 + $arg1 + $arg2 end To execute the command use: adder 1 2 3 This defines the command adder.. This is done with the define command.1. or even perform inferior functions calls. Arguments are accessed within the user command via $arg0.

.1 [Command Syntax]. ending with end. help user-defined List all user-defined commands. The definition of the command is made up of other gdb command lines. which are given following the define command. It may also start with any predefined prefix command.276 Debugging with gdb define adder if $argc == 2 print $arg0 + $arg1 end if $argc == 3 print $arg0 + $arg1 + $arg2 end end define commandname Define a command named commandname. show max-user-call-depth set max-user-call-depth The value of max-user-call-depth controls how many recursion levels are allowed in user-defined commands before gdb suspects an infinite recursion and aborts the command. show user show user commandname Display the gdb commands used to define commandname (but not its documentation). so that it can be accessed by help. numbers. document commandname Document the user-defined command commandname. with the first line of the documentation (if any) for each. and underscores. page 19). Redefining the command with define does not change the documentation. The command commandname must already be defined. help on command commandname displays the documentation you have written. ‘define target my-target’ creates a user-defined ‘target my-target’ command. dont-repeat Used inside a user-defined command. display the definitions for all user-defined commands. This command reads lines of documentation just as define reads the lines of the command definition. If there is already a command by that name. The end of these commands is marked by a line containing end. You may use the document command again to change the documentation of a command. If no commandname is given. For example. After the document command is finished. commandname may be a bare command name consisting of letters. dashes. you are asked to confirm that you want to redefine it. this tells gdb that this command should not be repeated when the user hits RET (see Section 3.

g.1. but treat them normally during normal execution. the commands of the definition are not printed. If this occurs. the hook is not re-executed. to ignore SIGALRM signals while single-stepping. which are a special kind of user-defined command. user-defined commands frequently use control flow commands. you could define: define hook-echo echo <<<--end define hookpost-echo echo --->>>\n end (gdb) echo Hello World <<<---Hello World--->>> (gdb) You can define a hook for any single-word command in gdb. If used interactively. a pseudo-command. and to add extra text to the beginning and end of the message.1. it is executed (with no arguments) after that command.2 User-defined Command Hooks You may define hooks. if the user-defined command ‘hookpost-foo’ exists. page 278.Chapter 23: Extending gdb 277 In addition to the above commands. you should define a hook for the basic command name. it is executed (with no arguments) before that command. backtrace rather than . It is valid for a hook to call the command which it hooks. Whenever you run the command ‘foo’. Defining (‘hook-stop’) makes the associated commands execute every time execution stops in your program: before breakpoint commands are run. Many gdb commands that normally print messages to say what they are doing omit the messages when used in a user-defined command. An error in any command stops execution of the user-defined command. commands that would ask for confirmation proceed without asking when used inside a user-defined command. thereby avoiding infinite recursion. or the stack frame is printed. described in Section 23.3 [Command Files]. for the same command. Whenever you run the command ‘foo’. When user-defined commands are executed. Post-execution hooks may exist simultaneously with pre-execution hooks. ‘stop’ exists. displays are printed. For example. A hook may also be defined which is run after the command you executed. if the user-defined command ‘hook-foo’ exists. In addition. 23. to hook at the beginning and end of the echo command. you could define: define hook-stop handle SIGALRM nopass end define hook-run handle SIGALRM pass end define hook-continue handle SIGALRM pass end As a further example. e. but not for command aliases.

‘define target hook-remote’ to add a hook to ‘target remote’. unless the order of execution is changed by one of the flow-control commands described below. An error in any command terminates execution of the command file and control is returned to the console. Comments (lines starting with #) may also be included. if filename contains a drive specification.3 Command Files A command file for gdb is a text file made of lines that are gdb commands. If the file is not found there. For DOS-like systems. The exact behavior can be configured using the script-extension setting. for verbose mode. For example. The option must be given before filename. An empty line in a command file does nothing. The search is done by appending filename to each element of the search path. it is stripped before concatenation. In this mode. Errors in a command file supplied on standard input do not terminate execution of the command file—execution continues with the next command. The search is also done if filename is an absolute path. gdb also accepts command input from standard input. Commands that would ask for confirmation if used interactively proceed without asking when used in a command file. and is interpreted as part of the filename anywhere else. e.1. For example. execution of gdb commands stops and gdb issues a prompt (before the command that you actually typed had a chance to run). 23.278 Debugging with gdb bt. You can hook a multi-word command by adding hook. The commands are not printed as they are executed. If you try to define a hook which does not match any known command. then gdb also looks for the file on the source search path (specified with the ‘directory’ command). The lines in a command file are generally executed sequentially. See Chapter 23 [Extending GDB]. if filename is ‘d:myscript’ and the search path contains ‘c:/tmp’ then gdb will look for the script ‘c:/tmp/myscript’. as it would from the terminal.to the last word of the command. source [-s] [-v] filename Execute the command file filename. If an error occurs during the execution of your hook.g. You can request the execution of a command file with the source command. Many gdb commands that normally print messages to say what they are doing omit the messages when called from command files. then gdb searches for filename on the search path even if filename specifies a directory. for example. So. page 275. gdb first searches for filename in the current directory. normal output goes to standard output and error output goes to standard error. you get a warning from the define command. if filename is ‘mylib/myscript’ and the search path contains ‘/home/user’ then gdb will look for the script ‘/home/user/mylib/myscript’. If -s is specified. If -v. except that ‘$cdir’ is not searched because the compilation directory is not relevant to scripts. and filename does not specify a directory. if filename is ‘/tmp/myscript’ and the search path contains ‘/home/user’ then gdb will look for the script ‘/home/user/tmp/myscript’. Note that the source command is also used to evaluate scripts that are not Command Files. is given then gdb displays each command as it is executed. it does not mean to repeat the last command. .or hookpost.

There can then optionally be an else line. normal gdb output is suppressed. etc. Execution branches to the beginning of the while loop. This section describes three commands useful for generating exactly the output you want. where it evaluates the controlling expression.) This example will execute commands from the file ‘cmds’. Execution of the script continues after that whiles end line. you can write complex scripts that loop over data structures. changes in how the program being debugged is built. The commands in the body of while are executed repeatedly as long as the expression evaluates to true. such as different or unexpected values of variables and symbols. etc. All output and errors would be directed to ‘log’. Using these commands. In addition to the standard C escape sequences.4 Commands for Controlled Output During the execution of a command file or a user-defined command. Its syntax is similar to if: the command takes a single argument.1. terminated by an end. This is useful for displaying a string with spaces at the beginning or the end. while loop_break 23. a backslash followed by a space stands for a space. since leading and trailing spaces are otherwise trimmed from all arguments. No newline is printed unless you specify one. which is an expression to evaluate. echo text Print text. Since commands stored on command files tend to be more general than commands typed interactively. execute commands conditionally. This command allows to write loops. followed by a series of commands that are only executed if the expression was false. one per line. else. end Terminate the block of commands that are the body of if. the only output that appears is what is explicitly printed by the commands in the definition. and must be followed by the commands to execute. or while flow-control commands. use the command ‘echo \ and foo = \ ’. which is an expression to evaluate. It is followed by a series of commands that are executed only if the expression is true (its value is nonzero). These commands are called the body of the loop. they frequently need to deal with complicated situations. Nonprinting characters can be included in text using C escape sequences. The if command takes a single argument. loop_continue This command skips the execution of the rest of the body of commands in the while loop in whose body it is included. The end of the list is marked by a line containing end. To print ‘ and foo = ’. This command exits the while loop in whose body it is included. such as ‘\n’ to print a newline.Chapter 23: Extending gdb 279 gdb < cmds > log 2>&1 (The syntax above will vary depending on the shell used. gdb provides a set of flow-control commands to deal with these complexities. . if else This command allows to include in your script conditionally executed commands.

and ‘z’ are not supported. and the ‘L’ type modifier is supported only if long double type is available. • The modifier ‘*’ is not supported for specifying precision or width. For example. and then printed. are not supported. You can use the same formats as for print. foo. . • The type modifiers ‘hh’. exactly as a C program would do by executing the code below: printf (template. which may be either numbers or pointers. for more information.. output/fmt expression Print the value of expression in format fmt. no ‘$nn = ’. To print several values. The value is not entered in the value history either.5 [Output Formats]. • The conversion letters ‘a’ and ‘A’ are not supported.. such as ‘2$’. ‘t’. See Section 10. you can print two values in hex like this: printf "foo. ordinary characters in template are printed verbatim. 0x%x\n". with the following exceptions: • The argument-ordering modifiers. ‘j’. page 102. Note that the ‘ll’ type modifier is supported only if the underlying C implementation used to build gdb supports the long long int type. As in C printf. while conversion specification introduced by the ‘%’ character cause subsequent expressions to be evaluated.. to continue the command onto subsequent lines. their values converted and formatted according to type and style information encoded in the conversion specifications. For example.280 Debugging with gdb A backslash at the end of text can be used. expressions. as in C. echo This is some text\n\ which is continued\n\ onto several lines. expressions. • The conversion letter ‘n’ (as in ‘%n’) is not supported. including the flags and modifiers between the ‘%’ character and the conversion letter. Print the values of one or more expressions under the control of the string template. printf template. • The ‘’’ flag (for separation of digits into groups according to LC_NUMERIC’) is not supported.1 [Expressions]. bar-foo printf supports all the standard C conversion specifications. make expressions be a comma-separated list of individual expressions. Their values are printed as specified by template.. for more information on expressions. See Section 10.). page 97.\n produces the same output as echo This is some text\n echo which is continued\n echo onto several lines.\n output expression Print the value of expression and nothing but that value: no newlines. bar-foo = 0x%x.

23. • ‘DD’ for printing Decimal128 types.D128: %DDf\n".1 Python Commands gdb provides one command for accessing the Python interpreter. If given an argument.Chapter 23: Extending gdb 281 As in C. This directory. This feature is available only if gdb was configured using ‘--with-python’.2E10dd. page 214). letters: • ‘H’ for printing Decimal32 types.D64: %Df . the python command will evaluate the argument as a Python command. known as the python directory.. ‘\a’. where data-directory is the data directory as determined at gdb startup (see Section 18. other modifiers such as width and precision will also be available for gdb to use. Here’s an example of printing DFP types using the above conversion letters: printf "D32: %Hf . printf supports conversion specifications for DFP (Decimal Floating Point) types using the following length modifiers together with a floating point specifier. Additionally..2E1dl eval template. ‘\t’. is automatically added to the Python Search Path in order to allow the Python interpreter to locate all scripts installed at this location.1.2. ‘\\’. In this case. • ‘D’ for printing Decimal64 types. 23. ‘\"’. that consist of backslash followed by a single character. the Python script is made up of subsequent . expressions. and call it. printf supports simple backslash-escape sequences. it will act as a multi-line command.2345df.1.2 Scripting gdb using Python You can script gdb using the Python programming language. and ‘\f’. Python scripts used by gdb should be installed in ‘data-directory/python’. In case there is no such C support. no additional modifiers will be available and the value will be printed in the standard way. such as \n. Convert the values of one or more expressions under the control of the string template to a command line. For example: (gdb) python print 23 23 If you do not provide an argument to python. like define. Additionally. Octal and hexadecimal escape sequences are not supported.5 [Data Files]. gdb commands and convenience functions which are written in Python and are located in the ‘data-directory/python/gdb/command’ or ‘datadirectory/python/gdb/function’ directories are automatically imported when gdb starts. If the underlying C implementation used to build gdb has support for the three length modifiers for DFP types. and one related setting: python [code] The python command can be used to evaluate Python code.1.

2. 23. page 275.4 [Screen Size].282 Debugging with gdb command lines.2.2 [Python].py’ and gdb must be configured to recognize the script language based on filename extension using the script-extension setting. In this situation. gdb will not print a stack trace when an error occurs in a Python script. gdb overrides Python’s sys. >print 23 >end 23 maint set python print-stack This command is now deprecated. It must be a boolean value. a Python KeyboardInterrupt exception is thrown. For example: (gdb) python Type python script End with a line saying just "end". a string. page 281). See Chapter 23 [Extending GDB]. A Python program which outputs to one of these streams may have its output interrupted by the user (see Section 22. named gdb. as a gdb CLI command. gdb. gdb.PYTHONDIR [Variable] A string containing the python directory (see Section 23. This can be controlled using set python print-stack: if on. from tty specifies whether gdb ought to consider this command as having originated from the user invoking it interactively. .2. from tty [.2 Python API At startup. and thus is always available.1 Basic Python gdb introduces a new Python module.2 [Exception Handling]. All methods and classes added by gdb are placed in this module. if off.2. it defaults to False. to string]]) [Function] Evaluate command. Instead use set python print-stack set python print-stack By default. page 267). 23.execute (command [. If a GDB exception happens while command runs.2. then Python stack printing is enabled. It is also possible to execute a Python script from the gdb interpreter: source ‘script-name’ The script name must end with ‘. python execfile ("script-name") This method is based on the execfile Python built-in function. the default. then Python stack printing is disabled. If omitted.stdout and sys. gdb automatically imports the gdb module for use in all scripts evaluated by the python command. This command list is terminated using a line containing end.stderr to print using gdb’s output-paging streams. page 285. given after the python command. it is translated as described in Section 23.

If the to string parameter is True.11 [Convenience Vars]. If number is negative.parameter (parameter) If the named parameter does not exist. gdb. parameter may contain spaces if the parameter has a multi-part name. then output will be collected by gdb. gdb. gdb.20 [Breakpoints In Python]. into gdb’s internal event queue.10 [Value History]. however. page 285). there is no way to know when they will be processed relative to other events inside gdb. expression must be a string. as it provides a way to parse the command’s argument as an expression. page 317.error exception will be raised. it is the only way to get the value of a convenience variable (see Section 10. gdb.parse_and_eval (expression) [Function] Parse expression as an expression in the current language.Chapter 23: Extending gdb 283 By default.history (number) [Function] Return a value from gdb’s value history (see Section 10.2. If your Python program uses multiple threads.11 [Commands In Python]. evaluate it. Otherwise. the gdb virtual terminal will be temporarily set to unlimited width and height. then gdb will return the most recent element. see Section 22. and its pagination will be disabled. for example.execute and returned as a string. number indicates which history element to return. this function throws a gdb. page 267. page 286).2. page 117) as a gdb. For example. It is also useful simply to compute values. and returned. post_event ensures this. in which case the return value is None. gdb is not thread-safe. the parameter’s value is converted to a Python value of the appropriate type. For example: .2.. The default is False. page 302). any output produced by command is sent to gdb’s standard output. during gdb’s event processing. and return the result as a gdb. If number is zero.error (see Section 23. the most recent element) to find the value to return. ‘print object’ is a valid parameter name. See Section 23. page 116). a callable object taking no arguments. for more information.2 [Exception Handling]. This function can be useful when implementing a new command (see Section 23. then gdb will take its absolute value and count backward from the last element (i. If to string is True.4 [Screen Size].Value (see Section 23.2.e.breakpoints () [Function] Return a sequence holding all of gdb’s breakpoints.2. This callable will be invoked at some later point.Value.post_event (event) [Function] Put event. If the element specified by number doesn’t exist in the value history.2. If no exception is raised. [Function] Return the value of a gdb parameter.2. the return value is always an instance of gdb. parameter is a string naming the parameter to look up.3 [Values From Inferior]. you must be careful to only call gdb-specific functions in the main gdb thread. Events posted using post_event will be run in the order in which they were posted. a gdb.2.Value. gdb.

stderr will automatically call this function and will automatically direct the output to the relevant stream.stdout or sys.write(self.start() >end (gdb) Hello World gdb.post_event(Writer("World\n")) > >MyThread1(). message): > self.message) > >class MyThread1 (threading. Possible stream values are: gdb. gdb. The default stream is gdb’s standard output stream.write (string [. > def __call__(self): > gdb. Possible stream values are: gdb.284 Debugging with gdb (gdb) python >import threading > >class Writer(): > def __init__(self. gdb will flush the contents of a stream automatically when it encounters a newline in the buffer.STDLOG gdb’s log stream (see Section 2. The optional stream determines the stream to print to. gdb. The optional stream determines the stream to flush.STDERR gdb’s standard error stream.message = message. page 17).stdout or sys.stderr will automatically call this function for the relevant stream.4 [Logging Output].Thread): > def run (self): > gdb.STDOUT gdb’s standard output stream.4 [Logging Output]. stream]) [Function] Print a string to gdb’s paginated output stream.post_event(Writer("Hello ")) > >class MyThread2 (threading.STDERR gdb’s standard error stream.start() >MyThread2(). gdb. Writing to sys. gdb. Flushing sys.STDLOG gdb’s log stream (see Section 2.STDOUT gdb’s standard output stream.Thread): > def run (self): > gdb. gdb. page 17). .flush () [Function] Flush the buffer of a gdb paginated stream so that the contents are displayed immediately. The default stream is gdb’s standard output stream.

19 [Symbol Tables In Python]. for compatibility with earlier versions of gdb. gdb will call the method assigned to this operation before a prompt is displayed by gdb. and annotation related prompts are prohibited from being changed.2. This differs from gdb. line 1. or of the current line if no argument was given.2. [Function] Return the name of the shared library holding the given address as a string.error This is the base class for most exceptions generated by gdb. This function returns a Python tuple containing two elements. .19 [Character Sets]. Python exceptions uncaught within the Python code are translated to calls to gdb error-reporting mechanism. It is derived from RuntimeError.solib_name (address) gdb.target_wide_charset () [Function] Return the name of the current target wide character set (see Section 10.2. the gdb prompt will be set to that string. in <module> NameError: name ’foo’ is not defined gdb errors that happen in gdb commands invoked by Python code are converted to Python exceptions. gdb. The parameter current_prompt contains the current gdb prompt. The type of the Python exception depends on the error. If a string is returned.2 [Specify Location].Chapter 23: Extending gdb 285 gdb.parameter(’target-wide-charset’) in that ‘auto’ is never returned. The second element contains either None or another tuple that contains all the locations that match the expression represented as gdb. page 125). This differs from gdb. gdb will terminate it and print an error message containing the Python exception name.2 Exception Handling When executing the python command. If the command that called python does not handle the error. or None. The first element contains a string holding any unparsed section of expression (or None if the expression has been fully parsed). page 316).19 [Character Sets].parameter(’target-charset’) in that ‘auto’ is never returned.decode_line [expression] [Function] Return locations of the line specified by expression. If None is returned. page 88). and the Python call stack backtrace at the point where the exception was raised. gdb. Secondary prompts such as those used by readline for command input. page 125).Symtab_and_line objects (see Section 23. or None. gdb.target_charset () [Function] Return the name of the current target character set (see Section 10. gdb. If expression is provided. gdb will continue to use the current prompt.2. Some prompts cannot be substituted in gdb. 23. Example: (gdb) python print foo Traceback (most recent call last): File "<string>". the associated value. it is decoded the way that gdb’s inbuilt break or edit commands do (see Section 9. This method must return a Python string.prompt_hook (current prompt) [Function] If prompt hook is callable.

error which is thrown when an operation tried to access invalid memory in the inferior.Value object whose values are of the same type as those of some_val.Value object. bar will also be a gdb. it is useful to be able to throw an exception that doesn’t cause a traceback to be printed. Inferior values that are simple scalars can be used directly in Python expressions that are valid for the value’s data type.COMMAND_OBSCURE) > def invoke (self. bar will also be a gdb. args.__init__ ("hello-world". gdb.GdbError ("hello-world takes no arguments") > print "Hello. Inferior values that are structures or instances of some class can be accessed using the Python dictionary syntax. self). World!" >HelloWorld () >end (gdb) hello-world 42 hello-world takes no arguments 23. KeyboardInterrupt User interrupt (via C-c or by typing q at a pagination prompt) is translated to a Python KeyboardInterrupt exception. from_tty): > argv = gdb. In all cases.Value instance holding a structure. you can access its foo element with: bar = some_val[’foo’] Again. For example. Example: (gdb) python >class HelloWorld (gdb.Value. your exception handler will see the gdb error message as its value and the Python call stack backtrace at the Python statement closest to where the gdb error occured as the traceback. .286 Debugging with gdb If an error occurring in gdb does not fit into some more specific category. Use the gdb. gdb uses this object for its internal bookkeeping of the inferior’s values.2.GdbError exception to handle this case. the user may have invoked the command incorrectly.""" > def __init__ (self): > super (HelloWorld.Command. then the generated exception will have this type. When implementing gdb commands in Python via gdb. Here’s an example for an integer or floating-point value some_val: bar = some_val + 2 As result of this. gdb.string_to_argv (args) > if len (argv) != 0: > raise gdb.Command): > """Greet the whole world. if some_val is a gdb.2.3 Values From Inferior gdb provides values it obtains from the inferior program in an object of type gdb. and for fetching values when necessary. For example.MemoryError This is a subclass of gdb.

Otherwise. respectively. some_val is a gdb. The value of this attribute is a gdb.parse_and_eval (’somevar’) The value of somevar is not fetched at this time.20) Any values returned from a function call will be stored as a gdb.Value instance representing a function that takes two integers as arguments. The following attributes are provided: Value. For example: myval = gdb. this attribute holds None. If this value is of class type.is_lazy [Variable] The value of this read-only boolean attribute is True if this gdb. if any. this read-only attribute holds a gdb. Value. gdb does not fetch values until necessary.address [Variable] If this object is addressable. The following methods are provided: Value. it will just return the static type of the value as in ptype foo (see Chapter 16 [Symbols]. Any arguments provided to the call must match the function’s prototype. page 189). or when the fetch_lazy method is invoked. Otherwise.Value.Value object representing the address. and return a pointer or reference to that type. page 290).is_optimized_out Value. [Variable] This read-only boolean attribute is true if the compiler optimized out this value. To execute this function.Value has not yet been fetched from the inferior.Value.Type object (see Section 23. This uses C++ run-time type information (RTTI) to determine the dynamic type of the value.Chapter 23: Extending gdb 287 A gdb. [Variable] The type of this gdb. and must be provided in the order specified by that prototype.type Value. In all other cases. Specifically: . for efficiency. Note that this feature will only work when debugging a C++ program that includes RTTI for the object in question. it will return the class in which the value is embedded. For example.__init__ (val) [Function] Many Python values can be converted directly to a gdb.4 [Types In Python].2. It will be fetched when the value is needed.Value via this object initializer.dynamic_type [Variable] The dynamic type of this gdb. call it like so: result = some_val (10.Value.Value that represents a function can be executed via inferior function call. thus it is not available for fetching from the inferior. it will return the value’s static type. Value. it will compute the dynamic type of the referenced object. If this value is of pointer or reference to a class type.2.

dereference () The result bar will be a gdb.Value to access what foo points to like this: bar = foo. page 320). Consult a C++ reference for details.reinterpret_cast (type) .dynamic_cast (type) [Function] Like Value. Value. Consult a C++ reference for details. using the current target encoding. Python long A Python long is converted to the C long long type for the current architecture.cast.Value object whose contents is the object pointed to by the pointer.LazyString If val is a gdb.Type object. For example. which must be a gdb. Value. Python string A Python string is converted to a target string. [Function] Like Value. this method returns a new gdb. but works as if the C++ dynamic_cast operator were used. this method throws an exception. [Function] For pointer data types. if foo is a C pointer to an int.Value.cast (type) [Function] Return a new instance of gdb.2.288 Debugging with gdb Python boolean A Python boolean is converted to the boolean type from the current language.21 [Lazy Strings In Python]. Python integer A Python integer is converted to the C long type for the current architecture. Value.Value that is the result of casting this instance to the type described by type.LazyString (see Section 23. Value. gdb. and its result is used. If the cast cannot be performed for some reason.dereference () then you can use the corresponding gdb. Python float A Python float is converted to the C double type for the current architecture. then the lazy string’s value method is called.Value object holding the value pointed to by foo.Value If val is a gdb. declared in your C program as int *foo.cast. but works as if the C++ reinterpret_cast operator were used.2. gdb. then a copy of the value is made.

the string will be fetched and encoded to the length of characters specified.2. the string will be converted to that given length. The string is assumed to be terminated by a zero of the appropriate width. or a languagespecific encoding will be used. For further information on encoding in gdb please see Section 10.fetch_lazy () . If the encoding argument is an encoding that gdb does recognize. page 125) will be used.21 [Lazy Strings In Python].decode method. It accepts the same encodings as the corresponding argument to Python’s string. errors[. If encoding is not given. Value. Otherwise. then this method converts the contents to a Python string. this method will throw an exception.Value represents a string is determined by the current language. it must be a string naming the encoding of the string in the gdb. then this method converts the contents to a gdb. such as "ascii". whether a given gdb. then either the target-charset (see Section 10.19 [Character Sets]. Any errors that occur in the process will produce a Python exception. the string will be fetched and converted to the given length.lazy_string ([encoding [. ignoring any embedded zeros that the string may contain. this method will throw an exception. a value is a string if it is a pointer to or an array of characters or ints. or is an empty string. it must be a string naming the encoding of the gdb.decode method. If the optional length argument is given. Some examples are: ‘ascii’.Value represents a string. The optional errors argument is the same as the corresponding argument to Python’s string. If the optional encoding argument is not provided. and the Python codec machinery will be used to convert the string. then the value is fetched from the inferior.is_lazy is True). page 125. Otherwise. if the current language is able to supply one.LazyString.Value represents a string. If the length argument is not provided. the gdb encoding machinery is used to convert the string during printing. For C-like languages. the string will be fetched and encoded until a null of appropriate width is found. If the optional encoding argument is given. gdb will automatically select the encoding most suitable for the string type.Chapter 23: Extending gdb 289 Value. If the optional length argument is given.2.Value object is currently a lazy value (gdb. If the optional encoding argument is given. "iso8859-6" or "utf-8". ‘iso-8859-6’ or ‘utf-8’.19 [Character Sets]. length]]) Value. or if encoding is the empty string.Value. Strings are recognized in a language-specific way. However if the optional length argument is given.string ([encoding[. gdb will raise an error. length]]]) [Function] If this gdb. page 320). [Function] If the gdb.LazyString (see Section 23. When a lazy string is printed. [Function] If this gdb.Value.

Range types have two fields. 23. The tag name is the name after struct. then name is looked up in that scope. Ordinarily.290 Debugging with gdb If the gdb. if some_type is a gdb. then None is returned. Enum types have one field per enum constant. If the type is a structure or class type.Field object. If this type has no tag name. block]) [Function] This function looks up a type by name.2. an empty sequence will be returned. If the type has no fields. Usually. union. However. it is searched for globally.Value object is not a lazy value. not all languages have this concept.sizeof Type. a target’s char type will be an 8-bit byte.2. on some unusual platforms. Each field is a gdb. or enum in C and C++. the fields of that type can be accessed using the Python dictionary syntax. The base types of C++ classes are also represented as fields. If the named type cannot be found.fields () [Function] For structure and union types. or an enum type. this type may have a different size. it will throw an exception. this method has no effect.Type. see below under the description of the Type. [Variable] The size of this type.Type instance holding a structure type. The following type-related functions are available in the gdb module: gdb. you can access its foo field with: bar = some_type[’foo’] bar will be a gdb. Function and method types have one field per parameter. the minimum and maximum values.lookup_type (name [.code [Variable] The type code for this type. If block is given. in target char units. this method returns the fields. For example. with some pre-defined attributes: .Type. This method does not return a value. It must be a string. The type code will be one of the TYPE_CODE_ constants defined below.Field class.Field object. or does not fit into one of these categories. [Variable] The tag name for this type.tag The following methods are provided: Type. name is the name of the type to look up. An instance of Type has the following attributes: Type. Otherwise. Type.4 Types In Python gdb represents types from the inferior using the class gdb. this function will return an instance of gdb.fields method for a description of the gdb.

or None for anonymous fields. or if that type was not a C++ class.Type object which represents a volatile-qualified variant of this type. and is False if the field is not artificial. gdb will raise a gdb. If the type does not have a range. the value is the bit position of the field.2. this will be zero.array (n1 [.range () [Function] Return a Python Tuple object that contains two elements: the low bound of the argument type and the high bound of that type.volatile () Type. type Type. which is the size of the field in bits. then this will have a nonzero value. name artificial is_base_class This is True if the field represents a base class of a C++ structure. This attribute is always provided. in this case the field’s size is given by its type.Type object which represents an unqualified variant of this type. but it can be None in some situations. page 285). [Function] Return a new gdb. The type of the field. but the bounds can be. or is a bitfield. For enum fields. n2]) [Function] Return a new gdb. That is. The name of the field. bitsize If the field is packed.unqualified () Type. Otherwise.error exception (see Section 23. usually meaning that it was provided by the compiler and not the user. For non-static fields.Type object which represents an array of this type.2. in this case the lower bound is zero. Type. This attribute is always provided. This is True if the field is artificial. the result is neither const nor volatile. This is usually an instance of Type.Type object which represents a const-qualified variant of this type. .Chapter 23: Extending gdb 291 bitpos This attribute is not available for static fields (as in C++ or Java). If one argument is given. and the second argument is the upper bound of the array. [Function] Return a new gdb. it is the inclusive upper bound of the array. the value is the enumeration member’s integer representation. If two arguments are given. [Function] Return a new gdb.const () Type. and is False if the field is not a base class of the type that is the argument of fields. An array’s length must not be negative. the first argument is the lower bound of the array.2 [Exception Handling].

then name is looked up in that scope.TYPE_CODE_ENUM The type is an enum.target () Type.Type object which represents the target type of this type. gdb.template_argument (n [. Each type has a code.reference () Type. this method will throw an exception. the target type is the type of the elements of the array.TYPE_CODE_UNION The type is a union.Type that represents the real type. the target type is the type of the return value. the target type is the type of the elements. Ordinarily.TYPE_CODE_ARRAY The type is an array. For an array type (meaning C-like arrays). For a function or method type. it is searched for globally.Type object which represents a reference to this type. . after removing all layers of typedefs.Type which represents the type of the nth template argument. which indicates what category this type falls into. gdb. For a complex type.strip_typedefs () [Function] Return a new gdb. this will throw an exception. Type. If the type does not have a target.pointer () [Function] Return a new gdb. If block is given. gdb. only C++ code will have template types. gdb.Type object which represents a pointer to this type. For a typedef. this will return a new gdb.292 Debugging with gdb Type. used for things such as status registers. gdb.Type is an instantiation of a template. Type.TYPE_CODE_PTR The type is a pointer. For a pointer type. the target type is the type of the pointed-to object. [Function] Return a new gdb.TYPE_CODE_FLAGS A bit flags type.TYPE_CODE_FUNC The type is a function.TYPE_CODE_STRUCT The type is a structure. Otherwise. The available type categories are represented by constants defined in the gdb module: gdb. gdb. If this gdb. block]) [Function] If this gdb. the target type is the aliased type. [Function] Return a new gdb.Type is not a template type.

gdb. gdb. gdb. gdb.TYPE_CODE_TYPEDEF A typedef to some other type.TYPE_CODE_VOID The special type void. gdb.TYPE_CODE_INTERNAL_FUNCTION A function internal to gdb.TYPE_CODE_DECFLOAT A decimal floating point type.TYPE_CODE_METHOD A method type. an integer type with bounds. gdb. gdb.TYPE_CODE_CHAR A character type. C strings are not represented this way. This is the type used to represent convenience functions. gdb.TYPE_CODE_ERROR An unknown or erroneous type.TYPE_CODE_STRING A string type. that is.TYPE_CODE_RANGE A range type.TYPE_CODE_MEMBERPTR A pointer-to-member.TYPE_CODE_INT The type is an integer type.TYPE_CODE_FLT A floating point type.TYPE_CODE_NAMESPACE A C++ namespace.TYPE_CODE_COMPLEX A complex float type. gdb.TYPE_CODE_BOOL A boolean type. gdb. gdb. . gdb.TYPE_CODE_METHODPTR A pointer-to-member-function.TYPE_CODE_SET A Pascal set type. gdb. as found in C++ or Java. gdb.TYPE_CODE_BITSTRING A string of bits. gdb. gdb. Note that this is only used for certain languages with languagedefined string types. gdb.Chapter 23: Extending gdb 293 gdb. gdb.TYPE_CODE_REF A reference type.

2. respecting set print elements. if the to_string method exists. Exactly how this formatting is done is dependent on the display hint. If it does not exist. This method must return an object conforming to the Python iterator protocol. This method is optional. If it does exist.types Python module (see Section 23. The first element is the “name” of the child. pretty_printer. and may change as more hints are added. pretty_printer.types]. pretty_printer. Indicate that the object being printed is “string-like”. page 114). If the printer’s to_ string method returns a Python string of some kind. Some display hints are predefined by gdb: ‘array’ ‘map’ ‘string’ Indicate that the object being printed is “array-like”.4.children (self) [Function] gdb will call this method on a pretty-printer to compute the children of the prettyprinter’s value. page 106).294 Debugging with gdb Further support for types is provided in the gdb.display_hint (self) [Function] The CLI may call this method and use its result to change the formatting of a value. omitting the result of children.9 [Pretty Printing]. possibly escaping some characters. then gdb will call its internal language-specific string-printing function to format the string. this method must return a string. the CLI may print just the result of to_string in a stack trace. defined here. the second element is the child’s value. Also. 23. depending on the print settings (see Section 10. For the CLI this means adding quotation marks. A pretty-printer is just an object that holds a value and implements a specific interface. and the like.5 Pretty Printing API An example output is provided (see Section 10. gdb will act as though the value has no children.2 [gdb. If this method returns a string. The value can be any Python object which is convertible to a gdb value. then gdb will prepend its result to the values returned by children. it is printed verbatim.to_string (self) [Function] gdb will call this method to display the string representation of the value passed to the object’s constructor.2.8 [Print Settings]. Each item returned by the iterator must be a tuple holding two elements. Indicate that the object being printed is “map-like”. page 323). When printing from the CLI.2. The result will also be supplied to an MI consumer as a ‘displayhint’ attribute of the variable being printed. The CLI uses this to respect parameters such as set print elements and set print array. . This method is optional. and that the children of this value can be assumed to alternate between keys and values.

2.Value. If instead the method returns a Python value which is convertible to a gdb. 23.2.2. calling each enabled function until an object is returned. Pretty-printers are enabled and disabled by attaching an enabled attribute to the registered function or callable object.5 [Pretty Printing API].Objfile until it receives a pretty-printer object.2. Again.6 Selecting Pretty-Printers The Python list gdb. it should return None. Printers in this list are called global printers.Chapter 23: Extending gdb 295 Otherwise. If no such printer exists. then gdb prints this value. If the result is not one of these types.pretty_printers list. if print frame-arguments is on. and booleans) and strings are convertible to gdb. This may result in a call to another pretty-printer. floats. a backtrace can become highly illegible if any argument is printed with a broken printer.pretty_printers contains an array of functions or callable objects that have been registered via addition as a pretty-printer. .Objfile in the current program space and iteratively calls each enabled lookup routine in the list for that gdb. Python scalars (integers. If a function cannot create a pretty-printer for the value. The consequences of a broken pretty-printer are severe enough that gdb provides support for enabling and disabling individual printers.Objfile also contains a pretty_printers attribute. If a pretty-printer for this value exists. then this returns None.default_visualizer (value) [Function] This function takes a gdb. After these lists have been exhausted. The order in which the objfiles are searched is not specified. For example. then gdb performs the conversion and prints the resulting value.Value. again calling each enabled function until an object is returned.Value argument and should return a pretty-printer object conforming to the interface definition above (see Section 23.Value: gdb. If this attribute is present and its value is False. and iterated over sequentially until the end of the list. Each gdb. the underlying data structure may have changed and the pretty-printer is out of date. functions are always invoked from the head of the list. it tries the global gdb. Each function on these lists is passed a single gdb. page 294). then it is returned. gdb then searches the pretty-printer list of the current program space. For various reasons a pretty-printer may not work. this may result in a call to another pretty-printer.Value. or a printer object is returned. For a given list. if this method returns an instance of gdb. If no pretty-printer is found in the objfile lists.Progspace contains a pretty_printers attribute. Finally. they’re available when debugging all inferiors. other types are not.Value object as an argument. Each gdb. if this method returns None then no further operations are peformed in this method and nothing is printed. gdb first checks the pretty_printers attribute of each gdb. an exception is raised. the printer is disabled. For example. gdb provides a function which can be used to look up the default pretty-printer for a gdb. otherwise the printer is enabled.

To continue the std::string example (see Section 23. We recommend that you put your core pretty-printers into a Python package. If your pretty-printers are for use with a library. and attempts to match it to a type that it can pretty-print.2.pretty_printers. it returns None. and the printer itself.val[’_M_dataplus’][’_M_p’] def display_hint(self): return ’string’ And here is an example showing how a lookup function for the printer example above might be written.2.3 [Auto-loading]. val): self. for details on the API this class must provide. this approach will scale nicely to multiple inferiors. gdb will find the correct printers for the specific version of the library used by each inferior. See Section 23.2.2.2.5 [Pretty Printing API]. class StdStringPrinter(object): "Print a std::string" def __init__(self.v6: def register_printers(objfile): objfile.296 Debugging with gdb 23.7 Writing a Pretty-Printer A pretty-printer consists of two parts: a lookup function to detect if the type is supported. This practice will enable gdb to load multiple versions of your pretty-printers at the same time.libstdcxx.compile("^std::basic_string<char. If not. followed by a call to a register pretty-printers with the current objfile.match(lookup_tag): return StdStringPrinter(val) return None The example lookup function extracts the value’s type.5 [Pretty Printing API].2.tag if lookup_tag == None: return None regex = re. we further recommend embedding a version number into the package name.. Then.type. each potentially using a different library version. An ideal auto-load file will consist solely of imports of your printer modules. Embedding a version number in the Python package name will ensure that gdb is able to load both sets of printers simultaneously. page 320) such that it can be evaluated multiple times without changing its meaning.add(str_lookup_function) And then the corresponding contents of the auto-load file would be: . because they will have different names. If it is a type the printer can pretty-print. it will return a printer object.2.val = val def to_string(self): return self. Taken as a whole. page 294. page 294). You should write auto-loaded code (see Section 23.*>$") if regex. because the search for pretty-printers is done by objfile. Here is an example showing how a std::string printer might be written. and because your auto-loaded code took care to register your library’s printers with a specific objfile. def str_lookup_function(val): lookup_tag = val. this code might appear in gdb.

If a pretty-printer can handle multiple data types.printing. }.val = val def to_string(self): return ("x=<" + str(self.libstdcxx. even identical.val["y"]) + ">") This example doesn’t need a lookup function. ’^bar$’. but one could also have a single lookup function recognize several types. barPrinter) return pp And here is the autoload support: import gdb. struct bar { struct foo x. y.1 [gdb.register_printers(gdb. val): self.Chapter 23: Extending gdb 297 import gdb.printing]. page 323). The lookup function has a name.printing module.val["b"]) + ">") class barPrinter: """Print a bar object. but lookup functions can have arbitrary. ’^foo$’.val["x"]) + "> y=<" + str(self. There are a few things that can be improved on. These are the types we are going to pretty-print: struct foo { int a. val): self.current_objfile()) The previous example illustrates a basic pretty-printer.printing module provides a formal way of solving these problems (see Section 23.register_pretty_printer( .val["a"]) + "> b=<" + str(self. whereas a library typically has several types.printing def build_pretty_printer(): pp = gdb. then its subprinters are the printers for the individual data types.printing import my_library gdb.add_printer(’foo’.4.printing.RegexpCollectionPrettyPrinter( "my_library") pp. Second. }. that is handled by the gdb. The latter is the conventional way this is handled. the printer only handles one type.""" def __init__(self. fooPrinter) pp.v6. names. The gdb.libstdcxx.2. Here are the printers: class fooPrinter: """Print a foo object. Here is another example that handles multiple types.""" def __init__(self. The printer doesn’t have a name. import gdb. One could install a lookup function for each desired type in the library. b. making it hard to identify in a list of installed printers. Instead a function is provided to build up the object that handles the lookup.val = val def to_string(self): return ("a=<" + str(self.add_printer(’bar’.v6 gdb.

9 [Inferiors and Programs].write_memory function. as assigned by GDB. A gdb. [Function] This method returns a tuple holding all the threads which are valid when it is called. or started by gdb itself.was_attached A gdb.8 Inferiors In Python Programs which are being run under gdb are called inferiors (see Section 4.so: my_library foo bar 23. False if not. A gdb.current_objfile().Inferior class. here is the corresponding output of ‘info pretty-printer’: (gdb) info pretty-printer my_library.Inferior object has the following attributes: Inferior. Inferior. the method will return an empty tuple. If there are no valid threads. [Variable] Boolean signaling whether the inferior was created using ‘attach’.298 Debugging with gdb gdb. Inferior. [Function] [Function] gdb.selected_inferior () Return an object representing the current inferior. Python scripts can access information about and manipulate inferiors controlled by gdb via objects of the gdb. The following inferior-related functions are available in the gdb module: gdb.2. [Variable] Inferior.Inferior object will become invalid if the inferior no longer exists within gdb.Inferior object is valid. which behaves much like an array or a string. . starting at address.threads () Inferior.is_valid () [Function] Returns True if the gdb. length) [Function] Read length bytes of memory from the inferior. page 32). Returns a buffer object.pid [Variable] Process ID of the inferior. when this printer is loaded into gdb.inferiors () Return a tuple containing all inferior objects.Inferior object has the following methods: Inferior. All other gdb. as assigned by the underlying operating system.Inferior methods will throw an exception if it is invalid at the time the method is called. my_library. It can be modified and given to the gdb.num ID of inferior.read_memory (address.2.build_pretty_printer()) Finally.

or None if the pattern could not be found. As you can see in the example the ExitedEvent object has an attribute which indicates the exit code of the inferior. you must register an event handler with an event registry.cont Emits gdb. [Function] Remove the given object from the registry.exited. . length]) [Function] Write the contents of buffer to the inferior. length. An event registry is an object in the gdb. The following is a listing of the event registries that are available and details of the events they emit: events.read_memory. exit_handler gets called when the inferior exits. i. All the existing events are described below. A registry provides methods to register and unregister event handlers: EventRegistry.search_memory (address.. Once removed.Chapter 23: Extending gdb 299 Inferior. an array or the object returned from gdb. EventRegistry. length determines the number of bytes from buffer to be written. The pattern parameter must be a Python object which supports the buffer protocol. the object will no longer receive notifications of events. [Function] Search a region of the inferior memory starting at address with the given length using the search pattern supplied in pattern.events.read_memory. starting at address. The buffer parameter must be a Python object which supports the buffer protocol.exited. If given. Returns a Python Long containing the address where the pattern was found..write_memory (address. buffer [.2.ThreadEvent.9 Events In Python gdb provides a general event facility so that Python code can be notified of various state changes.disconnect (object) Here is an example: def exit_handler (event): print "event type: exit" print "exit code: %d" % (event. an array or the object returned from gdb. Once connected. particularly changes that occur in the inferior.ExitedEvent.e.connect (object) [Function] Add the given callable object to the registry. An event is just an object that describes some state change.2.connect (exit_handler) In the above example we connect our handler exit_handler to the registry events. The argument event in this example is of type gdb. pattern) 23. This object will be called when an event corresponding to this registry occurs.e. a string.events module which dispatches particular events. In order to be notified of an event. a string. Inferior. i.exit_code) gdb. The type of the object and its attributes will vary depending on the details of the change.

these events all extend gdb.Breakpoint) that were hit.ContinueEvent which extends gdb. When represented in Python. This event indicates that the inferior has been continued after a stop.BreakpointEvent which extends gdb.StopEvent which extends gdb.SignalEvent which extends gdb. and has the following attributes: BreakpointEvent. Emits gdb. Examples of these events are gdb.exited Emits events.2.ThreadEvent. Emits gdb. A list of possible signal values can be obtained by running the command info signals in the gdb command prompt. gdb.ThreadEvent above for more details. This event indicates that the inferior or one of its threads has received as signal.300 Debugging with gdb Some events can be thread specific when gdb is running in non-stop mode. gdb.ContinueEvent. events. Refer to gdb. gdb.BreakpointEvent event indicates that one or more breakpoints have been hit. [Variable] A reference to the inferior which triggered the exited event.ExitedEvent has two attributes: ExitedEvent. ExitedEvent inferior events.) If the exit code is unavailable. for example. ThreadEvent.StopEvent. All events emitted by this registry extend StopEvent. For inherited attribute refer to gdb. this event is not emitted directly. gdb detaches from the inferior. the attribute does not exist. which the inferior has returned. events. events which are emitted by this or other modules might extend this event. instead.ThreadEvent.BreakpointEvent and gdb. As a child of gdb.exit_code [Variable] An integer representing the exit code.stop_signal [Variable] A string representing the signal received by the inferior.breakpoints [Variable] A sequence containing references to all the breakpoints (type gdb. Also emits gdb.ExitedEvent which indicates that the inferior has exited.ThreadEvent above. See Section 23.20 . Note. Indicates that the inferior has stopped.SignalEvent has the following attributes: SignalEvent. if available. (The exit code could be unavailable if.inferior_thread [Variable] In non-stop mode this attribute will be set to the specific thread which was involved in the emitted event.StopEvent.2.StopEvent will indicate the stopped thread when gdb is running in non-stop mode.stop Emits gdb. Otherwise. it will be set to None.ThreadEvent.ThreadEvent.

InferiorThread class.Objfile) which has been loaded.ptid [Variable] ID of the thread. then this returns that name.2.10 Threads In Python Python scripts can access information about. for details of the gdb.2.new_objfile [Variable] A reference to the object file (gdb. 23. the second is the Lightweight Process ID (LWPID).Breakpoint object.breakpoints attribute. See Section 23. if an OS-supplied name is available.2.InferiorThread object has the following attributes: InferiorThread. page 317.BreakpointEvent. Otherwise.NewObjFileEvent has one attribute: NewObjFileEvent.name [Variable] The name of the thread. Either the LWPID or TID may be 0.Objfile object. this will return None.15 [Objfiles In Python]. via objects of the gdb. this returns None. which removes any user-specified thread name.selected_thread () [Function] This function returns the thread object for the selected thread. If there is no selected thread. events.breakpoint [Variable] A reference to the first breakpoint that was hit. A gdb. [Variable] InferiorThread. which indicates that the operating system does not use that identifier. page 309. A gdb. as assigned by the operating system. The new value must be a string object. The following thread-related functions are available in the gdb module: gdb. or None. for details of the gdb. InferiorThread. This attribute can be assigned to. BreakpointEvent.num ID of the thread. If the user specified a name using thread name. and the third is the Thread ID (TID). The first is the Process ID (PID). gdb. Otherwise. which sets the new name.InferiorThread object has the following methods: . and manipulate inferior threads controlled by gdb. This function is maintained for backward compatibility and is now deprecated in favor of the gdb. This attribute is a tuple containing three integers.Chapter 23: Extending gdb 301 [Breakpoints In Python].NewObjFileEvent which indicates that a new object file has been loaded by gdb.2. as assigned by GDB.new_objfile Emits gdb. then it is returned.

or the inferior that the thread belongs is deleted. 23.__init__ (name. command class should be one of the ‘COMMAND_’ constants defined below. [Function] This changes gdb’s currently selected thread to the one represented by this object. All other gdb. [Function] [Function] [Function] Return a Boolean indicating whether the thread is stopped. if one of the prefix commands does not exist.” is used.is_stopped () InferiorThread.2. name is the name of the command. If not given.switch () InferiorThread. Command. InferiorThread. completer class is an optional argument. False if not. A CLI command is implemented using an instance of the gdb. if no such method is found. This argument tells gdb how to perform completion for this command.InferiorThread object will become invalid if the thread exits. prefix]]) [Function] The object initializer for Command registers the new command with gdb. A gdb. There is no support for multi-line commands. it should be one of the ‘COMPLETE_’ constants defined below.is_valid () [Function] Returns True if the gdb. then the new command is a prefix command. most commonly using a subclass. If name consists of multiple words. This initializer is normally invoked from the subclass’ own __init__ method. If no documentation string is provided. an exception is raised. prefix is an optional argument.dont_repeat () [Function] By default. In this case. Command. then the initial words are looked for as prefix commands. the default value “This command is not documented. If True.is_running () Return a Boolean indicating whether the thread is running. InferiorThread.2. a gdb command is repeated when the user enters a blank line at the command prompt. If given.302 Debugging with gdb InferiorThread.Command class. completer_class [. A command can suppress this behavior by invoking the dont_ .InferiorThread object is valid. if there is one. This argument tells gdb how to categorize the new command in the help system. an error will occur when completion is attempted.InferiorThread methods will throw an exception if it is invalid at the time the method is called. gdb will attempt to complete using the object’s complete method (see below). The help text for the new command is taken from the Python documentation string for the command’s class.11 Commands In Python You can implement new gdb CLI commands in Python. sub-commands of this command may be registered.is_exited () Return a Boolean indicating whether the thread is exited. command_class [.

note that prefix commands are not listed under their own category but rather that of their top-level command. The available classifications are represented by constants defined in the gdb module: gdb. it means that there were no completions available.invoke (argument. Arguments are separated by spaces and may be quoted. . from tty) This method is called by gdb when this command is invoked. word holds the last word of the command line. and the complete command (see Section 3.COMMAND_NONE The command does not belong to any particular class. from tty is a boolean argument. page 275. ’4 "5’. The complete method can return several values: • If the return value is a sequence. When a new command is registered. • If the return value is one of the ‘COMPLETE_’ constants defined below. the contents of the sequence are used as the completions.1. and its result is used. If this method throws an exception. It is the argument to the command. that is. this is computed using a word-breaking heuristic.1 [Define]. [Function] argument is a string. when false it means that the command came from elsewhere.string_to_argv.3 [Help]. ’2 "3’. A zero-length sequence is allowed. "6 ’7"] Command.Chapter 23: Extending gdb 303 repeat method. All forms of completion are handled by this method. Example: print gdb. Otherwise.string_to_argv ("1 2\ \\\"3 ’4 \"5’ \"6 ’7\"") [’1’.complete (text. • All other results are treated as though there were no available completions. other elements in the sequence are ignored. When true. then the corresponding gdb-internal completion function is invoked. it must be declared as a member of some general class of commands. This is used to classify top-level commands in the on-line help system. This function behaves identically to gdb’s internal argument lexer buildargv. Only string elements of the sequence are used. word) [Function] This method is called by gdb when the user attempts completion on this command. A command in this category will not be displayed in any of the help categories. the return value is ignored. text holds the complete command line up to the cursor’s location. It is up to complete to ensure that the contents actually do complete the word. The arguments text and word are both strings. the TAB and M-? key bindings (see Section 3.2 [Completion]. see Section 23. To break argument up into an argv-like string use gdb. page 19). page 21). it is turned into a gdb error call. after leading and trailing whitespace has been stripped. this means that the command was entered by the user at the terminal. This is similar to the user command dont-repeat. Command. It is recommended to use this for consistency.

Type help files at the gdb prompt to see a list of commands in this category. gdb.304 Debugging with gdb gdb. and continue are in this category. step.COMMAND_STATUS The command is an ‘info’-related command. generally meaning things that are useful to the user when interacting with gdb. Type help support at the gdb prompt to see a list of commands in this category. related to the state of gdb itself.COMMAND_FILES This class is used for file-related commands. For example. call. The maintenance and flushregs commands are in this category. and tfind are in this category. clear. backtrace. gdb. Type help stack at the gdb prompt to see a list of commands in this category. For example. Type help tracepoints at the gdb prompt to see a list of commands in this category.COMMAND_RUNNING The command is related to running the inferior. make. For example. gdb. and print are in this category. find. gdb.COMMAND_BREAKPOINTS The command has to do with breakpoints. For example. For example. or is not of general interest to users. checkpoint.COMMAND_MAINTENANCE The command is only useful to gdb maintainers. For example. Type help internals at the gdb prompt to see a list of commands in this category. break. Type help status at the gdb prompt to see a list of commands in this category. file. that is. For example.COMMAND_SUPPORT This should be used for “support facilities”. macro. gdb.COMMAND_STACK The command has to do with manipulation of the stack. Type help obscure at the gdb prompt to see a list of commands in this category. gdb. Type help breakpoints at the gdb prompt to see a list of commands in this category. and shell are in this category. . start. For example. and delete are in this category. Type help running at the gdb prompt to see a list of commands in this category. Type help data at the gdb prompt to see a list of commands in this category. actions. and show are in this category. help. gdb.COMMAND_OBSCURE The command is only used in unusual circumstances. fork. gdb. info.COMMAND_TRACEPOINTS The command has to do with tracepoints. frame. and stop are in this category. list and section are in this category. gdb. but not related to the state of the inferior. and return are in this category.COMMAND_DATA The command is related to data or variables. trace. For example.

2 [Specify Location]. page 21.COMPLETE_FILENAME This constant means that filename completion should be performed.COMPLETE_NONE This constant means that no completion should be done.COMPLETE_COMMAND This constant means that completion should examine gdb command names. There are many parameters that already exist and can be set in gdb. parameter-class [.COMMAND_OBSCURE) def invoke (self. or by returning it from the complete method. Two examples are: set follow fork and set charset. either by specifying it via an argument at initialization.12 Parameters In Python You can implement new gdb parameters using Python.2. you may need to import the gdb module explicitly. Similarly. you can define parameters that can be used to influence behavior in custom Python scripts and commands.COMPLETE_SYMBOL This constant means that completion should be done using symbol names as the source. from_tty): print "Hello. and is necessary to trigger the registration of the command with gdb. This initializer is normally invoked from the subclass’ own __init__ method. command-class. See Section 9. gdb. page 88.__init__ (name. enum-sequence]) [Function] The object initializer for Parameter registers the new parameter with gdb.COMPLETE_LOCATION This constant means that location completion should be done.Command): """Greet the whole world.3 [Help]. The following code snippet shows how a trivial CLI command can be implemented in Python: class HelloWorld (gdb. gdb. A new parameter is implemented as an instance of the gdb. World!" HelloWorld () The last line instantiates the class. gdb. . Depending on how the Python code is read into gdb. gdb. arg. See Section 3.__init__ ("hello-world". Setting these parameters influences certain behavior in gdb.Chapter 23: Extending gdb 305 A new command can use a predefined completion function.Parameter class.""" def __init__ (self): super (HelloWorld. Parameter. gdb.2. self). Parameters are exposed to the user via the set and show commands. 23. These predefined completion constants are all defined in the gdb module: gdb.

It can be read and assigned to just as any other attribute. [Function] gdb will call this method when a parameter’s show API has been invoked (for example. Parameter. then the initial words are looked for as prefix parameters. In this case the parameter can subsequently be accessed in gdb as set print foo. set foo off).__init__ is invoked. If name consists of multiple words. These strings represent the possible values for the parameter. svalue) .2.2. This method must return a string. a default value is used. and is a string. then the presence of a fourth argument will cause an exception to be thrown. Parameter. command-class should be one of the ‘COMMAND_’ constants (see Section 23. If there is no documentation string.set_doc [Variable] If this attribute exists. if there is one. then its value is used as the help text for this parameter’s set command.value [Variable] The value attribute holds the underlying value of the parameter. then enum-sequence must be a sequence of strings. gdb does validation when assignments are made. show foo).__init__ is invoked. this information is used for input validation and completion. The argument svalue receives the string representation of the current value. The help text for the new parameter is taken from the Python documentation string for the parameter’s class. The value is examined when Parameter. subsequent changes have no effect.306 Debugging with gdb name is the name of the new parameter. an exception is raised. The value is examined when Parameter.11 [Commands In Python]. If name is print foo.get_set_string (self) [Function] gdb will call this method when a parameter’s value has been changed via the set API (for example. This argument tells gdb the type of the new parameter. Parameter. and is a string.get_show_string (self. If parameter-class is not PARAM_ENUM. The value attribute has already been populated with the new value and may be used in output. page 302). and no prefix parameter group can be found. This method must return a string. then its value is used as the help text for this parameter’s show command. parameter-class should be one of the ‘PARAM_’ constants defined below. subsequent changes have no effect. An example of this can be illustrated with the set print set of parameters. This argument tells gdb how to categorize the new parameter in the help system. If name consists of multiple words.show_doc [Variable] If this attribute exists. These are: Parameter. Parameter. There are two methods that should be implemented in any Parameter class. then print will be searched as the prefix parameter. If parameter-class is PARAM_ENUM.

PARAM_ZINTEGER The value is an integer. such as ‘\t’. its type must be specified.PARAM_STRING The value is a string. In Python. ‘\f’. Function. When the user modifies the string. A convenience function is an instance of a subclass of the class gdb. The available types are represented by constants defined in the gdb module: gdb.2.Function. True and False are the only valid values.PARAM_OPTIONAL_FILENAME The value is a either a filename (a string). are translated into corresponding characters and encoded into the current host charset.PARAM_FILENAME The value is a filename. and ‘auto’.11 [Convenience Vars]. The function will be visible to the user .13 Writing new convenience functions You can implement new convenience functions (see Section 10. When the user modifies the string. This is just like PARAM_STRING_NOESCAPE. any escape sequences. which must be one of a collection string constants provided when the parameter is created.2. gdb. The value of 0 should be interpreted to mean “unlimited”.PARAM_ENUM The value is a string. a string. gdb. 23. page 117) in Python.PARAM_AUTO_BOOLEAN The value has three possible states: true.PARAM_BOOLEAN The value is a plain boolean. gdb.PARAM_INTEGER The value is a signed integer. except 0 is interpreted as itself. gdb. but uses file names for completion. The argument name is the name of the function. gdb.__init__ (name) [Function] The initializer for Function registers the new function with gdb. and ‘auto’ is represented using None.Chapter 23: Extending gdb 307 When a new parameter is defined. and octal escapes. false. The Python boolean values. true and false are represented using boolean constants. The value of 0 should be interpreted to mean “unlimited”. gdb. gdb. gdb. This is like PARAM_INTEGER.PARAM_UINTEGER The value is an unsigned integer. or None.PARAM_STRING_NOESCAPE The value is a string. gdb. escapes are passed through untranslated.

[Variable] . for more details about program spaces. all available arguments are passed to invoke. and then the function’s invoke method is called.308 Debugging with gdb as a convenience variable of type internal function. Progspace.__init__ ("greet") def invoke (self.2. page 309. It consists of all of the objfiles of the program. The documentation for the new function is taken from the documentation string for the new class. page 32.2.string () Greet () The last line instantiates the class. Function.progspaces () Each progspace is represented by an instance of the gdb. gdb.Value. If an ordinary Python value is returned.2. name): return "Hello. See Section 4.15 [Objfiles In Python]. it is converted to a gdb. self). The following progspace-related functions are available in the gdb module: gdb. represents a symbolic view of an address space. %s!" % name. [Function] Return a sequence of all the progspaces currently known to gdb.14 Program Spaces In Python A program space. The return value of this method is used as its value in the enclosing expression. following the standard Python calling convention.Value following the usual rules. Takes a name as argument. 23. Note that gdb does not predetermine the arity of convenience functions. and is necessary to trigger the registration of the function with gdb.Progspace class. See Section 4.invoke (*args) [Function] When a convenience function is evaluated. Instead. See Section 23. or progspace. In particular. a convenience function can have default values for parameters without ill effect.filename The file name of the progspace as a string. The following code snippet shows how a trivial convenience function can be implemented in Python: class Greet (gdb.Function): """Return string to greet someone.2.""" def __init__ (self): super (Greet. its arguments are converted to instances of gdb. page 32.current_progspace () [Function] This function returns the program space of the currently selected inferior. Depending on how the Python code is read into gdb.9 [Inferiors and Programs]. whose name is the same as the given name.9 [Inferiors and Programs]. you may need to import the gdb module explicitly.

2.5 [Pretty more information. printers. the return value used to format the value. Otherwise.2. When the debugged program stops. then the search continues. then the search continues. A Value is passed to each function in order. for 23. the return value used to format the value.15 Objfiles In Python gdb loads symbols for an inferior from various symbol-containing files (see Section 18.2.Objfile object has the following methods: Objfile.Objfile object is valid. A gdb. this function returns None. page 320).2. A gdb. If there is no current objfile. See Section 23. [Variable] [Variable] It is used to look up prettyif the function returns None. printers. gdb. Objfile.2.2.2. This function returns the current objfile. should be an object which is Printing API].Frame class represents a frame in the stack. The following objfile-related functions are available in the gdb module: gdb. page 209). gdb will throw a gdb. These include the primary executable file. page 285). like: . If you try to use an invalid frame object. See Section 23. gdb is able to analyze its call stack (see Section 8.is_valid () [Function] Returns True if the gdb. page 201).1 [Files]. page 294. All other gdb.pretty_printers The pretty_printers attribute is a list of functions.2. any shared libraries used by the inferior.objfiles () Each objfile is represented by an instance of the gdb.Frame objects can be compared for equality with the == operator. A gdb. page 309.2.Objfile class.error exception (see Section 23. should be an object which is Printing API].current_objfile () [Function] When auto-loading a Python script (see Section 23. False if not. Otherwise. See Section 23. for Objfile. and any separate debug info files (see Section 18.16 Accessing inferior stack frames from Python.Objfile methods will throw an exception if it is invalid at the time the method is called. gdb calls these symbol-containing files objfiles. Two gdb.15 [Objfiles In Python].Chapter 23: Extending gdb 309 Progspace.filename The file name of the objfile as a string. 23. [Function] Return a sequence of all the objfiles current known to gdb.pretty_printers The pretty_printers attribute is a list of functions.2 [Exception Handling].5 [Pretty more information.3 [Auto-loading].Objfile object can become invalid if the object file it refers to is not loaded in gdb any longer.2 [Separate Debug Files].2. [Variable] It is used to look up prettyif the function returns None.2. page 294.2. gdb sets the “current objfile” to the corresponding objfile. A Value is passed to each function in order.1 [Stack frames].2.Frame object is only valid while its corresponding frame exists in the inferior’s stack. The gdb. page 81).

[Function] Returns the type of the frame. All gdb.SIGTRAMP_FRAME A signal trampoline frame.2 [Tail Call Frames].TAILCALL_FRAME A frame representing a tail call. see the unwind_stop_reason method further down in this section).NORMAL_FRAME that is older than this one.name () Frame. but it is only used for the newest frame. (see Section 8. false if not.Frame object has the following methods: Frame.Frame object is valid.ARCH_FRAME A fake stack frame representing a cross-architecture call. or None if it can’t be obtained. [Function] Return the newest frame object for the selected thread.3 [Selecting a Frame]. gdb. The value can be one of: gdb. gdb. The function was inlined into a gdb. Frame.selected_frame () True The following frame-related functions are available in the gdb module: gdb. gdb.is_valid () [Function] Returns true if the gdb. A gdb. as expressed by the given reason code (an integer.DUMMY_FRAME A fake stack frame that was created by gdb when performing an inferior function call. See Section 11.frame_stop_reason_string (reason) [Function] Return a string explaining the reason why gdb stopped unwinding frames.NORMAL_FRAME.SENTINEL_FRAME This is like gdb. A frame object can become invalid if the frame it refers to doesn’t exist anymore in the inferior. page 132.selected_frame () gdb. . This is the frame created by the OS when it calls into a signal handler. gdb. [Function] Returns the function name of the frame.310 Debugging with gdb (gdb) python print gdb. gdb.type () gdb.INLINE_FRAME A frame representing an inlined function.NORMAL_FRAME An ordinary stack frame.newest_frame () [Function] Return the selected frame object. gdb.newest_frame() == gdb. page 84).Frame methods will throw an exception if it is invalid at the time the method is called.

[Function] Frame.FRAME_UNWIND_FIRST_ERROR: print "An error occured: %s" % reason_str Frame. because that would require knowing the values of registers or memory that have not been collected.17 [Blocks In Python].FRAME_UNWIND_UNAVAILABLE Cannot unwind further.Chapter 23: Extending gdb 311 Frame.FRAME_UNWIND_FIRST_ERROR Any stop reason greater or equal to this value indicates some kind of error.FRAME_UNWIND_INNER_ID This frame ID looks like it ought to belong to a NEXT frame. gdb.2. you could write: reason = gdb.unwind_stop_reason () [Function] Return an integer representing the reason why it’s not possible to find more frames toward the outermost frame. but we needed one to unwind further. That means that unwinding further would almost certainly give us another frame with exactly the same ID. Using it.FRAME_UNWIND_SAME_ID This frame has the same ID as the previous one. It could also indicate stack corruption. . gdb. gdb.selected_frame().FRAME_UNWIND_NULL_ID The previous frame’s analyzer returns an invalid result. gdb. The value can be one of: gdb.frame_stop_reason_string (reason) if reason >= gdb. See Section 23.pc () Returns the frame’s resume address. Normally. This special value facilitates writing code that tests for errors in unwinding in a way that will work correctly even if the list of the other values is modified in future gdb versions. so break the chain. this is a sign of unwinder failure. this is a sign of unwinder failure.FRAME_UNWIND_OUTERMOST This frame is the outermost.2. gdb.FRAME_UNWIND_NO_SAVED_PC The frame unwinder did not find any saved PC.frame_stop_reason_ string to convert the value returned by this function to a string. Normally.block () [Function] Return the frame’s code block. It could also indicate stack corruption.FRAME_UNWIND_NO_REASON No particular reason (older frames should be available). but we got it for a PREV frame.unwind_stop_reason () reason_str = gdb. Use gdb. gdb. page 312. gdb.

See Section 23.block_for_pc (pc) [Function] Return the gdb. A block object can become invalid if the block it refers to doesn’t exist anymore in the inferior. [Variable] .2.2.2.Block object has the following methods: Block. variable must be a string or a gdb. If the optional argument block is provided. gdb maintains information on each block stored in that frame.read_var (variable [. Frame. Frame. If the block cannot be found for the pc value specified.2.select () [Function] Set this frame to be the selected frame.Block provides in an iteration context and via the Python iter built-in function.find_sal () [Function] Return the frame’s symtab and line object. See Section 23.Block methods will throw an exception if it is invalid at the time the method is called. page 313. and are represented individually in Python as a gdb. page 309.17 Accessing frame blocks from Python. Furthermore. [Function] Return the value of variable in this frame.Block object has the following attributes: Block.Block object.Block object is valid.Block containing the given pc value. This attribute is not writable.2.16 [Frames In Python]. See Chapter 8 [Examining the Stack]. search for the variable from that block.2.2.Symbol object. 23.18 [Symbols In Python].older () Frame. for more detailed technical information on gdb’s book-keeping of the stack. block]) Frame.2. otherwise start at the frame’s current block (which is determined by the frame’s current program counter). These blocks are organized hierarchically. All other gdb. This method is also made available to the Python iterator object that gdb.newer () Return the frame called by this frame. the function will return None. Within each frame. [Function] [Function] Return the frame that called this frame. Frame. The following block-related functions are available in the gdb module: gdb. block must be a gdb. page 81.is_valid () [Function] Returns True if the gdb. page 81.function () [Function] Return the symbol for the function corresponding to this frame.start The start address of the block. page 316.19 [Symbol Tables In Python].312 Debugging with gdb Frame. see Chapter 8 [Examining the Stack]. Please see Section 23. A gdb. False if not. for a more in-depth discussion on frames. A gdb.Block.

18 Python representation of Symbols. Block. This attribute is not writable. This attribute is not writable. The result is a tuple of two elements. page 189. gdb. . If omitted.lookup_symbol (name [. the second element is False. This attribute is not writable. domain]]) [Function] This function searches for a symbol by name. The first element is a gdb.Symbol object. block [.Block object is a static block. this attribute holds None.function [Variable] The name of the block represented as a gdb. [Variable] True if the gdb.Symbol.. The optional block argument restricts the search to symbols visible in that block. the second element is True if the symbol is a field of a method’s object (e. False if not. If the symbol is found. The search scope can be restricted to the parameters defined in the optional domain and block arguments.end The end address of the block. domain]) [Function] This function searches for a global symbol by name. The block argument must be a gdb.2.is_static 23.g. This attribute is not writable. If the block is not named. the block for the current frame is used. [Variable] True if the gdb.static_block Block. It must be a string. If this parent block does not exist. this in C++). The following symbol-related functions are available in the gdb module: gdb. otherwise it is False. This attribute is not writable. The domain argument must be a domain constant defined in the gdb module and described later in this chapter.Block object.2. gdb represents every variable. then this attribute holds None. Similarly. If the symbol is not found. name is the name of the symbol. The optional domain argument restricts the search to the domain type. [Variable] Block.global_block Block. [Variable] The static block associated with this block. This attribute is not writable. [Variable] The block containing this block. This attribute is not writable. The search scope can be restricted to by the domain argument.lookup_global_symbol (name [. Python represents these symbols in gdb with the gdb.Block object is a global block.Chapter 23: Extending gdb 313 Block. function and type as an entry in a symbol table.is_global Block. False if not. See Chapter 16 [Examining the Symbol Table]. [Variable] The global block associated with this block.Symbol object or None if the symbol is not found.superblock Block.

2. All other gdb.19 [Symbol Tables In Python]. Each address class is a constant defined in the gdb module and described later in this chapter.Type object.is_constant True if the symbol is a constant.2.Symbol object is valid.linkage_name Symbol.2.Symbol object has the following methods: Symbol. This attribute is not writable.4 [Types In Python]. False if not.symtab Symbol. This attribute is not writable. [Variable] The address class of the symbol. The optional domain argument restricts the search to the domain type.Symtab object.Symbol object can become invalid if the symbol it refers to does not exist in gdb any longer. page 290. as used by the linker (i.print_name Symbol. A gdb. This attribute is represented as a gdb. Symbol. [Variable] The name of the symbol in a form suitable for output.type [Variable] The type of the symbol or None if no type is recorded. may be mangled).name Symbol. This attribute is represented as a gdb. [Variable] [Variable] [Variable] [Variable] True if the symbol is an argument of a function. This attribute is not writable. This is either name or linkage_name.Symbol object or None if the symbol is not found.is_variable True if the symbol is a variable. [Variable] The name of the symbol as a string.is_valid () [Function] Returns True if the gdb. depending on whether the user asked gdb to display demangled or mangled names.2. Symbol. page 316. A gdb. See Section 23.e. .Symbol methods will throw an exception if it is invalid at the time the method is called.. The domain argument must be a domain constant defined in the gdb module and described later in this chapter.is_argument Symbol. It must be a string.Symbol object has the following attributes: Symbol. The result is a gdb. [Variable] The name of the symbol. See Section 23.addr_class Symbol. A gdb. [Variable] The symbol table in which the symbol appears. This attribute is not writable. This classifies how to find the value of a symbol. Symbol.is_function True if the symbol is a function or a method.314 Debugging with gdb name is the name of the symbol.

gdb. gdb.SYMBOL_LOC_CONST Value is constant int. typedef names and enum type values. gdb.SYMBOL_STRUCT_DOMAIN This domain holds struct.SYMBOL_LOC_UNDEF If this is returned by address class.SYMBOL_LOC_REF_ARG Value address is stored in the frame’s argument list. it indicates an error either in the symbol information or in gdb’s handling of symbols. The available address class categories in gdb.SYMBOL_LOC_ARG Value is an argument. This usually indicates an error either in the symbol information or in gdb’s handling of symbols. This value is at the offset stored within the symbol inside the frame’s argument list. gdb.SYMBOL_LOC_REGPARM_ADDR Value is a specified register.SYMBOL_TYPES_DOMAIN This domain contains all types.Chapter 23: Extending gdb 315 The available domain categories in gdb. gdb. union and enum type names. not the value itself. gdb. .SYMBOL_LOC_STATIC Value is at a fixed address. Just like LOC_ARG except that the value’s address is stored at the offset. gdb. gdb. it contains everything minus functions and types.SYMBOL_FUNCTION_DOMAIN This domain contains all functions.SYMBOL_UNDEF_DOMAIN This is used when a domain has not been discovered or none of the following domains apply. gdb.SYMBOL_LOC_REGISTER Value is in a register.SYMBOL_VARIABLES_DOMAIN This domain holds a subset of the SYMBOLS_VAR_DOMAIN. gdb.SYMBOL_LABEL_DOMAIN This domain contains names of labels (for gotos). gdb.Symbol are represented as constants in the gdb module: gdb. Just like LOC_REGISTER except the register holds the address of the argument instead of the argument itself.SYMBOL_VAR_DOMAIN This domain contains variables. function names.Symbol are represented as constants in the gdb module: gdb. gdb.

19 Symbol table representation in Python. This attribute is not writable.Frame object.SYMBOL_LOC_UNRESOLVED Value is at a fixed address.Symtab_and_line object has the following attributes: Symtab_and_line. . This attribute is not writable. See Section 23.symtab [Variable] The symbol table object (gdb. Symbols in the domain SYMBOL_STRUCT_DOMAIN all have this class.Symtab. A gdb.pc Symtab_and_line.2.SYMBOL_LOC_COMPUTED The value’s address is a computed location. page 189. False if not.2. gdb.2. This attribute is not writable. for more information.is_valid () [Function] Returns True if the gdb.SYMBOL_LOC_BLOCK Value is a block.SYMBOL_LOC_TYPEDEF Value not used. gdb. gdb.16 [Frames In Python].line A gdb.Symtab_and_line object is valid. page 309. For more information on gdb’s symbol table management.Symtab_and_line and gdb.316 Debugging with gdb gdb. but the address of the variable has to be determined from the minimal symbol table whenever the variable is referenced.Symtab_and_line object has the following methods: Symtab_and_line. gdb.Symtab_and_line object can become invalid if the Symbol table and line object it refers to does not exist in gdb any longer. see Chapter 16 [Examining the Symbol Table].SYMBOL_LOC_CONST_BYTES Value is a byte-sequence. All other gdb. Access to symbol table data maintained by gdb on the inferior is exposed to Python via two objects: gdb. [Variable] Indicates the current program counter address.Symtab_and_line methods will throw an exception if it is invalid at the time the method is called. Symtab_and_line. 23.Symtab) for this frame. [Variable] Indicates the current line number for this object.SYMBOL_LOC_OPTIMIZED_OUT The value does not actually exist in the program.2. gdb. Symbol table and line data for a frame is returned from the find_sal method in gdb. A gdb.SYMBOL_LOC_LOCAL Value is a local variable. gdb.

BP_BREAKPOINT. page 309. A gdb. type [.__init__ (spec [.. you may choose to implement the stop method. type defaults to gdb. alter the current frame context (i.BP_WATCHPOINT. You should not alter the execution state of the inferior (i. otherwise the inferior will continue. add or delete Breakpoint.objfile [Variable] The symbol table’s source filename.Breakpoint class. The optional wp class argument defines the class of watchpoint to create. or an expression that defines a watchpoint.Symtab object is valid.Breakpoint class can be sub-classed and. The optional type denotes the breakpoint to create from the types defined later in this chapter. or alter.2.WP_WRITE class. See Section 23. each one will be called regardless of the return status of the previous. This attribute is not writable.).BP_WATCHPOINT. etc.. This attribute is not writable. Symtab.e. or in the case of a watchpoint. it will be called when the inferior reaches any location of a breakpoint which instantiates that sub-class. If there are multiple breakpoints at the same location with a stop method. change the current active frame). in particular.15 [Objfiles In Python]. [Variable] The symbol table’s backing object file. In this scenario if one of the methods returns True but the others return False.Symtab object has the following methods: Symtab. by the watch command. [Function] The gdb. If the method returns True.is_valid () [Function] Returns True if the gdb.2. The optional internal argument allows the breakpoint to become invisible to the user. step.filename Symtab. A gdb. The breakpoint will neither be reported when created.20 Manipulating breakpoints using Python Python code can manipulate breakpoints via the gdb. spec is a string naming the location of the breakpoint. False if not. If this method is defined as a sub-class of gdb. next. This argument can be either: gdb. This ensures that all stop methods have a chance to execute at that location. The contents can be any location recognized by the break command. [Function] Return the symbol table’s source absolute file name.Breakpoint.Symtab object has the following attributes: Symtab.internal]]]) [Function] Create a new breakpoint.Symtab methods will throw an exception if it is invalid at the time the method is called. the inferior will still be stopped. the inferior will be stopped at the location of the breakpoint.2. If a watchpoint class is not provided.Chapter 23: Extending gdb 317 A gdb.fullname () 23. nor will it be listed in the output from info breakpoints (but will be listed with the maint info breakpoints command).Symtab object can become invalid if the symbol table it refers to does not exist in gdb any longer. if type is gdb.BP_BREAKPOINT or gdb. Breakpoint. it is assumed to be a gdb. wp class [.2. All other gdb.stop (self) .e.

and False otherwise.is_valid () [Function] Return True if this Breakpoint object is valid. If the breakpoint is not task-specific (or the underlying language is not Ada). This also invalidates the Python Breakpoint object. This is not reported by the silent attribute. [Function] Permanently deletes the gdb breakpoint. In this case. This attribute is writable. and False otherwise. If the breakpoint is not thread-specific.318 Debugging with gdb any breakpoint. False otherwise.silent [Variable] This attribute is True if the breakpoint is silent. the object still exists. Example stop implementation: class MyBreakpoint (gdb. Breakpoint. this attribute holds the thread id. As a general rule. A Breakpoint object can become invalid if the user deletes the breakpoint. In the cases of watchpoint scope. gdb.Breakpoint): def stop (self): inf_val = gdb.task . Breakpoint. gdb. [Variable] If the breakpoint is Ada task-specific. This attribute is writable. Any further access to this object’s attributes or methods will raise an error.WP_ACCESS Read/Write watchpoint. Breakpoint.enabled [Variable] This attribute is True if the breakpoint is enabled.parse_and_eval("foo") if inf_val == 3: return True return False The available watchpoint types represented by constants are defined in the gdb module: gdb. This attribute is writable. this attribute is None.thread [Variable] If the breakpoint is thread-specific. this attribute holds the Ada task id. This attribute is writable. Breakpoint.WP_READ Read only watchpoint. Note that a breakpoint can also be silent if it has commands and the first command is silent. the watchpoint remains valid even if execution of the inferior leaves the scope of that watchpoint. you should not alter any data within gdb or the inferior at this time. Breakpoint.WP_WRITE Write only watchpoint. this attribute is None.delete Breakpoint. but the underlying breakpoint does not.

It is a string. [Variable] This attribute holds the condition of the breakpoint. This attribute is not writable.visible The available types are represented by constants defined in the gdb module: gdb. [Variable] This attribute holds the breakpoint’s type — the identifier used to determine the actual breakpoint type or use-case. This attribute is not writable. as specified by the user. [Variable] This attribute holds the breakpoint’s number — the identifier used by the user to manipulate the breakpoint. If the breakpoint does not have a location (that is.BP_WATCHPOINT Watchpoint breakpoint. [Variable] This attribute tells whether the breakpoint is visible to the user when set.condition . gdb. but currently it can only be set to zero.Chapter 23: Extending gdb 319 Breakpoint.expression Breakpoint. [Variable] This attribute holds a breakpoint expression. as specified by the user. This attribute is writable.hit_count [Variable] This attribute holds the hit count for the breakpoint. If there is no condition.BP_HARDWARE_WATCHPOINT Hardware assisted watchpoint. If the breakpoint does not have an expression (the breakpoint is not a watchpoint) the attribute’s value is None. This attribute is writable.BP_BREAKPOINT Normal code breakpoint.type Breakpoint. It is a string. It is a string. Breakpoint.ignore_count [Variable] This attribute holds the ignore count for the breakpoint. gdb. This attribute is writable. an integer.number Breakpoint. [Variable] This attribute holds the location of the breakpoint.BP_READ_WATCHPOINT Hardware assisted read watchpoint.location Breakpoint. This attribute is not writable. this attribute’s value is None. it is a watchpoint) the attribute’s value is None. as specified by the user. This attribute is not writable. Breakpoint. This attribute is not writable. Breakpoint. or when the ‘info breakpoints’ command is run. gdb. gdb. an integer.BP_ACCESS_WATCHPOINT Hardware assisted access watchpoint.

A gdb. this attribute’s value is a string holding all the commands. but will lose all the delayed retrieval. LazyString. This attribute is not writable.LazyString object has the following functions: LazyString. then gdb will select the most appropriate encoding when the string is printed.2. This attribute is not writable.debug_gdb_scripts section.value () [Function] Convert the gdb.LazyString to a gdb.encoding LazyString. [Variable] This attribute holds the length of the string in characters. while a gdb.LazyString is retrieved and encoded during printing.length [Variable] This attribute holds the address of the string. If the length is -1. [Variable] This attribute holds the encoding that will be applied to the string when the string is printed by gdb.Value. page 290. an encoding that will be used to encode that region of memory.4 [Types In Python]. then the string will be fetched and encoded up to the first null of appropriate width. encoding and handling that gdb applies to a gdb. This attribute is not writable. 23. To resolve this to the lazy string’s character type. and a length to delimit the region of memory that represents the string. For a lazy string this will always be a pointer type.LazyString will be treated differently by gdb when printing. The auto-loading feature is useful for supplying application-specific debugging commands and scripts. LazyString. 23. gdb will look for Python support scripts in several ways: ‘objfile-gdb.Value is that a gdb. or contains an empty string. or because the inferior has loaded a shared library).21 Python representation of lazy strings. separated by newlines. This attribute is not writable. If the encoding is not set. .Value wrapping a string is immediately retrieved and encoded on creation.py’ and .LazyString is represented in gdb as an address that points to a region of memory.LazyString and a string wrapped within a gdb.3 Auto-loading When a new object file is read (for example.address LazyString.commands [Variable] This attribute holds the commands attached to the breakpoint.type [Variable] This attribute holds the type that is represented by the lazy string’s type. This value will point to the string in memory. A lazy string is a string whose contents is not retrieved or encoded until it is needed. this attribute is None. A gdb.LazyString. See Section 23. If there are commands. A gdb.2.320 Debugging with gdb Breakpoint. This attribute is not writable.2.2. If there are no commands. The difference between a gdb. due to the file command. use the type’s target method.2.

2. then gdb will look for a file named ‘datadirectory/python/auto-load/real-name’. and printing an error message for each one is problematic.py Missing my-foo-pretty-printers. if this file does not exist.py’ file should be careful to avoid errors if it is evaluated more than once. formed by ensuring that the file name is absolute. where objfile is the object file’s real name. If this file does not exist. page 309). and real-name is the object file’s real name.py’ file When a new object file is read. gdb does not track which files it has already auto-loaded this way. This is useful because their names are not printed when gdb tries to load them and fails.2 [.py’. gdb sets the current objfile.debug_gdb_scripts’.5 [Data Files]. and resolving . 23. where data-directory is gdb’s data directory (available via show data-directory.3.1 The ‘objfile-gdb. Example: (gdb) info auto-load-scripts Loaded Script Yes py-section-script. Finally.2 The . components. and .py full name: /tmp/py-section-script. Also printed is the list of scripts that were mentioned in the . then gdb will look for real-name in all of the directories mentioned in the value of debug-file-directory. If regexp is supplied only scripts with matching names are printed.2.2. when gdb loads a new object file it will look for a special section named ‘. page 209). see Section 18. . and the list of auto-loaded scripts can be printed. gdb will load the associated script every time the corresponding objfile is opened. its contents is a list of names of scripts to load. If this file exists and is readable. following all symlinks.2 [Separate Debug Files].3. This can be useful for registering objfile-specific pretty-printers. 23. page 321).3.debug_gdb_scripts section For systems using file formats like ELF and COFF.2. page 214).current_objfile function (see Section 23.debug_gdb_ scripts section and were not found (see Section 23. So your ‘-gdb. gdb looks for a file named ‘objfile-gdb. info auto-load-scripts [regexp] Print the list of all scripts that gdb auto-loaded.15 [Objfiles In Python]. If this section exists.debug gdb scripts section].2. There may be many of them. gdb will evaluate it as a Python script. show auto-load-scripts Show whether auto-loading of Python scripts is enabled or disabled.Chapter 23: Extending gdb 321 Auto-loading can be enabled or disabled. This is available via the gdb. and if the parameter debug-file-directory is set (see Section 18. as described above..py When reading an auto-loaded file. set auto-load-scripts [yes|no] Enable or disable the auto-loading of Python scripts.

except that ‘$cdir’ is not searched. Scripts for libraries done the ‘-gdb.debug_gdb_scripts\".g. since the compilation directory is not relevant to scripts.py’ script. and the build infrastructure necessary to install the ‘-gdb.debug_gdb_scripts with. ‘libstdc++’. */ #define DEFINE_GDB_SCRIPT(script_name) \ asm("\ . and it is cumbersome to attach all the scripts from all the input libraries to the executable’s ‘-gdb. When an application is statically linked the only objfile available is the executable. \"MS\". Benefits of the ‘-gdb. it might not always be clear which one to choose. This section provides some guidance. • Scripts needn’t be copied out of the source tree.322 Debugging with gdb gdb will look for each specified script file first in the current directory and then along the source search path (see Section 9.popsection \n\ ").1\n\ .@progbits. It may be easier to specify the scripts in the .py’ script to. If the macro is put in a header.3. Scripts specified in the . Then one can reference the macro in a header or source file like this: DEFINE_GDB_SCRIPT ("my-app-scripts. Some classes can be entirely inlined. • Doesn’t require source code additions.5 [Specifying Source Directories].. 23.3 Which flavor to choose? Given the multiple ways of auto-loading Python scripts. • Ease of finding scripts for public libraries. any application or library using this header will get a reference to the specified script.py’ scripts in a place where gdb can find them is cumbersome.py") The script name may include directories if desired.asciz \"" script_name "\"\n\ .2. there typically isn’t a source directory in which to find the script. for example. apps can be built out of large collections of internal libraries. Entries can be placed in section . and thus there may not be an associated shared library to attach a ‘-gdb.py’ way require an objfile to trigger their loading.debug_gdb_scripts way: • Works with static linking. Benefits of the .py’ way: • Can be used with file formats that don’t support multiple sections. e. • Works with classes that are entirely inlined. For publicly installed libraries.debug_gdb_scripts section are searched for in the source search path. page 90). this GCC macro: /* Note: The "MS" section flags are to remove duplicates.byte 1\n\ .pushsection \". In some circumstances.

page 296.printing This module provides a collection of utilities for working with pretty-printers.g.. RegexpCollectionPrettyPrinter (name) Utility class for handling multiple printers. register_pretty_printer (obj.1 gdb.type) has_field (type. all recognized via regular expressions.get_basic_type(foo_ref. .2. and add a path to the top of the source tree to the source search path.debug_gdb_scripts section as relative paths.2. int main () { return 0. 23.4.2. subprinters=None) This class specifies the API that makes ‘info pretty-printer’. printer. 23. replace=False) Register printer with the pretty-printer list of obj.Types objects. } Then in gdb: (gdb) (gdb) (gdb) (gdb) int start python import gdb. C++ example: typedef const int const_int. a structure or union). assumed to be a type with fields (e. Otherwise a RuntimeError exception is raised if a printer with the same name already exists.2 gdb.4.2. const_int foo (3). field) Return True if type. make_enum_dict (enum_type) Return a Python dictionary type produced from enum type.types This module provides a collection of utilities for working with gdb. If replace is True then any existing copy of the printer is replaced. get_basic_type (type) Return type with const and volatile qualifiers stripped. for an example. ‘enable pretty-printer’ and ‘disable pretty-printer’ work.types python foo_ref = gdb.2. SubPrettyPrinter (name) For printers that handle multiple types. const_int& foo_ref (foo). has field field.4 Python modules gdb comes with several modules to assist writing Python code.parse_and_eval("foo_ref") python print gdb. 23. this class specifies the corresponding API for the subprinters. See Section 23.Chapter 23: Extending gdb 323 . and with typedefs and C++ references converted to the underlying type.7 [Writing a Pretty-Printer].types. Pretty-printers should generally inherit from this class. PrettyPrinter (name.

You can specify arguments inside “{}” immediately following the escape sequence. Substitute an ESC character. }.2.3 gdb. the argument names the parameter. Begin a sequence of non-printing characters. For example: struct A { int a.iteritems method. Substitute the current working directory. Then in gdb: (gdb) python (gdb) python (gdb) python {[’a’. ’’]} (gdb) python {[’a’. union { int b0. an argument names a frame parameter. Example: “\[\e[0.324 Debugging with gdb deep_items (type) Returns a Python iterator similar to the standard gdb. an argument names a thread parameter. substitute_prompt (string) Return string with escape sequences substituted by values. The escape sequences you can pass to this function are: \\ \e \f \n \p \r \t \v \w \[ Substitute a backslash.types struct_a = gdb.lookup_type("struct A") print struct_a. Substitute a carriage return. Substitute a newline. ’b0’. End a sequence of non-printing characters. Substitute the selected thread. int b1. Substitute a parameter’s value. and are not counted in the string length. Some escape sequences take arguments.types. Substitute the selected frame.deep_items(struct_a)] ’b1’]} 23. }. \] . Substitute the version of GDB.v in gdb.Type. except that the iterator returned by deep_items will recursively traverse anonymous struct or union fields. import gdb.4.keys () print [k for k.prompt This module provides a method for prompt value-substitution.34m\](gdb)\[\e[0m\]” will return a blue-colored “(gdb)” prompt where the length is five. These sequences are typically used with the ESC character.

With a user-defined command. dashes and underscores. print arguments: scalars" 23. if a new gdb command defined in Python has a long name to type. you also need to write documentation for it with the ‘document’ command. An alias automatically picks up the documentation of the existing command. numbers. Unambiguously abbreviated commands are allowed in COMMAND and ALIAS.Chapter 23: Extending gdb 325 For example: substitute_prompt (‘‘frame: \f. Here is an example where we make ‘elms’ an abbreviation of ‘elements’ in the ‘set print elements’ command. For example ‘s’ is an alias of the ‘step’ command even though it is otherwise an ambiguous abbreviation of other commands like ‘set’ and ‘show’. Abbreviations are not shown in command lists displayed by the ‘help’ command. For example. . You can define a new alias with the ‘alias’ command. then you need to define the latter separately. the current shortest unambiguous abbreviation of the ‘disassemble’ command and you wanted an even shorter version named ‘di’. Suppose you were tired of typing ‘disas’. print arguments: \p{print frame-arguments}’’) will return the string: "frame: main. COMMAND specifies the name of an existing command that is being aliased.3 Creating new spellings of existing commands It is often useful to define alternate spellings of existing commands. and is useful when ALIAS begins with a dash. This is to show that you can make an abbreviation of any part of a command. gdb itself uses aliases. The ‘-a’ option specifies that the new alias is an abbreviation of the command. alias [-a] [--] ALIAS = COMMAND ALIAS specifies the name of the new alias. gdb provides the ‘tty’ alias of the ‘set inferior-tty’ command. just as they are normally. For example. Aliases are also used to provide shortened or more common versions of multi-word commands. (gdb) alias -a di = disas Note that aliases are different from user-defined commands. (gdb) (gdb) (gdb) (gdb) Limit alias -a set print elms = set print elements alias -a show print elms = show print elements set p elms 20 show p elms on string chars or array elements to print is 200. The following will accomplish this. Note that if you are defining an alias of a ‘set’ command. and you want to have an alias for the corresponding ‘show’ command. Each word of ALIAS must consist of letters. The ‘--’ option specifies the end of options. Here is a simple example showing how to make an abbreviation of a command so that there is less to type. it is handy to have an abbreviated version of it that involves less typing.

This creates alias ‘spe’ of the command ‘set print elements’. (gdb) alias spe = set print elements (gdb) spe 20 .326 Debugging with gdb (gdb) alias -a set pr elms = set p ele Finally. here is an example showing the creation of a one word alias for a more complex command.

page 337. Consider an IDE using gdb/mi. mi mi2 mi1 The interpreter being used by gdb may not be dynamically switched at runtime. gdb would switch to using the console interpreter. If you are running the console interpreter. This manual describes both of these interfaces in great detail.Chapter 24: Command Interpreters 327 24 Command Interpreters gdb supports multiple command interpreters. gdb will start with the console interpreter. this could lead to a very precarious situation.2. Used primarily by programs wishing to use gdb as a backend for a debugger GUI or an IDE. and 5. The newest gdb/mi interface (currently mi2).1. However. 5. For more information. The current gdb/mi interface. although it is only available in versions of gdb which support gdb/mi version 2 (or greater). This is the most often used interpreter with gdb. By default. Defined interpreters include: console The traditional console or command-line interpreter.3. see Chapter 27 [The gdb/mi Interface]. you may execute commands in any interpreter from the current interpreter using the appropriate command. . With no interpreter specified at runtime. and some command infrastructure to allow users or user interface writers to switch between interpreters or run commands in other interpreters. The gdb/mi interface included in gdb 5. Although possible. the console interpreter (sometimes called the command-line interpreter or cli) and the machine interface interpreter (or gdb/mi). gdb will use this interpreter. rendering the IDE inoperable! Although you may only choose a single interpreter at startup. the user may choose to start gdb with another interpreter by specifying the ‘-i’ or ‘--interpreter’ startup options. gdb currently supports two command interpreters. If a user enters the command "interpreter-set console" in a console view. simply use the interpreter-exec command: interpreter-exec mi "-data-list-register-names" gdb/mi has a similar command.

.

25. when the frame changes. Breakpoint is disabled. or • assembly and registers. The others can be arranged in several layouts: • source only. or when the program counter changes. See Section 25. the assembly output. You can also switch in and out of TUI mode while gdb runs by using various TUI commands and key bindings. The source and assembly windows show the current program position by highlighting the current line and marking it with a ‘>’ marker. . The source.Chapter 25: gdb Text User Interface 329 25 gdb Text User Interface The gdb Text User Interface (TUI) is a terminal interface which uses the curses library to show the source file. The second marker indicates whether the breakpoint is enabled or not: + Breakpoint is enabled. • assembly only. The command window is always visible. page 330. Breakpoint which was never hit. The current line and active breakpoints are displayed in this window. Registers are highlighted when their values change.2 [TUI Key Bindings]. the program registers and gdb commands in separate text windows. The TUI mode is enabled by default when you invoke gdb as either ‘gdbtui’ or ‘gdb -tui’. gdb can display several text windows: command source assembly register This window is the gdb command window with the gdb prompt and the gdb output. The TUI mode is supported only on platforms where a suitable version of the curses library is available. Hardware breakpoint which was never hit. The first marker indicates the breakpoint type: B b H h Breakpoint which was hit at least once.1 TUI Overview In TUI mode. assembly and register windows are updated when the current thread changes. The gdb input is still managed using readline. The assembly window shows the disassembly output of the program. Breakpoints are indicated with two markers. These windows are not all visible at the same time. • source and assembly. This window shows the processor registers. • source and registers. The source window shows the source file of the program. such as C-x C-a. Hardware breakpoint which was hit at least once.

When the current line number is not known. When reentering the TUI mode. When a new layout is chosen. the string ?? is displayed. the curses window management stops and gdb operates using its standard mode. Think of it as the Emacs C-x o binding.330 Debugging with gdb A status line above the command window shows the following information: target process function Indicates the current gdb target.8 [Print Settings]. line pc 25.3 [TUI Single Key Mode]. Use a TUI layout with at least two windows. C-x 1 C-x 2 C-x o C-x s The following key bindings only work in the TUI mode: PgUp PgDn Scroll the active window one page up.2 TUI Key Bindings The TUI installs several key bindings in the readline keymaps (see Chapter 31 [Command Line Editing]. The screen is then refreshed. The name is demangled if demangling is turned on (see Section 10. this field is set to No process. Gives the current process or thread number. C-x C-a C-x a C-x A Enter or leave the TUI mode. Switch in and out of the TUI SingleKey mode that binds single keys to gdb commands (see Section 25. When the current layout already has two windows. Think of this key binding as the Emacs C-x 1 binding. When the TUI mode is not active. The layout will either be ‘source’ or ‘assembly’. Use a TUI layout with only one window. the string ?? is displayed. Think of it as the Emacs C-x 2 binding. The following key bindings are installed for both TUI mode and the gdb standard mode. When no process is being debugged. writing on the terminal directly. (see Chapter 19 [Specifying a Debugging Target]. When leaving the TUI mode. Gives the current function name for the selected frame. Scroll the active window one page down. Indicates the current program counter address. page 106). it will switch to the TUI mode. Indicates the current line number for the selected frame. The TUI associates several key bindings (like scrolling and arrow keys) with the active window. page 331). When there is no symbol corresponding to the current program counter. control is given back to the curses windows. page 215). . one window will always be common to the previous layout and the new one. the next layout with two windows is used. page 421). Change the active window. This command gives the focus to the next TUI window.

Once the command is entered the TUI SingleKey mode is restored.Chapter 25: gdb Text User Interface 331 Up Down Left Right C-L Scroll the active window one line up. info win List and give the size of all displayed windows.4 TUI-specific Commands The TUI has specific commands to control the text windows. Scroll the active window one line down. even when gdb is not in the TUI mode. Note that if gdb’s stdout is not connected to a terminal. run step up info locals where Other keys temporarily switch to the gdb command prompt. Scroll the active window one column right. When another window is active. C-n. When gdb is in the standard mode. or gdb has been started with the machine interface interpreter (see Chapter 27 [The gdb/mi Interface]. most of these commands will automatically switch to the TUI mode.3 TUI Single Key Mode The TUI also provides a SingleKey mode. Scroll the active window one column left. The key that was pressed is inserted in the editing buffer so that it is possible to type most gdb commands without interaction with the TUI SingleKey mode. 25. most of these commands will fail with an error. you must use other readline key bindings such as C-p. page 337). Refresh the screen. . These commands are always available. where the following key bindings are used: c d f n q r s u v w continue down finish next exit the SingleKey mode. Type C-x s to switch into this mode. C-b and C-f to control the command window. Because the arrow keys scroll the active window in the TUI mode. The only way to permanently leave this mode is by typing q or C-x s. they are not available for their normal use by readline unless the command window has the focus. because it would not be possible or desirable to enable curses window management. 25. which binds several frequently used gdb commands to single keys.

focus prev Make the previous window active for scrolling. Positive counts increase the height. tabset nchars Set the width of tab stops to be nchars characters. This is similar to typing C-L. float. tui reg next Show the next register group. refresh Refresh the screen. focus src Make the source window active for scrolling. layout regs Display the register window together with the source or assembly window. all. focus asm Make the assembly window active for scrolling. save. layout asm Display the assembly window only. . layout src Display the source window only. tui reg float Show the floating point registers in the register window. The list of register groups as well as their order is target specific. focus cmd Make the command window active for scrolling. focus regs Make the register window active for scrolling. restore.332 Debugging with gdb layout next Display the next layout. layout split Display the source and assembly window. system. layout prev Display the previous layout. The predefined register groups are the following: general. update Update the source window and the current execution point. tui reg general Show the general registers in the register window. focus next Make the next window active for scrolling. vector. winheight name +count winheight name -count Change the height of the window name by count lines. tui reg system Show the system registers in the register window. while negative counts decrease it.

5 TUI Configuration Variables Several configuration variables control the appearance of TUI windows.Chapter 25: gdb Text User Interface 333 25. Use standout mode. bold Use extra bright or bold mode. half-standout Use half bright and standout mode. Use half bright mode. set tui border-mode mode set tui active-border-mode mode Select the display attributes for the borders of the inactive windows or the active window. set tui border-kind kind Select the border appearance for the source. assembly and register windows. bold-standout Use extra bright or bold and standout mode. The possible values are the following: space ascii acs Use a space character to draw the border. ‘-’ and ‘|’ to draw the border. Use the Alternate Character Set to draw the border. . The mode can be one of the following: normal standout reverse half Use normal attributes to display the border. Use ascii characters ‘+’. The border is drawn using character line graphics if the terminal supports them. Use reverse video mode.

.

if you keep several configurations around. This is useful because it means that you can copy the text of previous commands and input them again. Running gdb under Emacs can be just like running gdb normally except for two things: • All “terminal” input and output goes through an Emacs buffer. but on some operating systems it might not find the source. which provides further buffers that can control the execution and describe the state of your program. called the GUD buffer. In particular. Emacs 22. with different names) you can customize the Emacs variable gud-gdb-command-name to run the one you want. See Section 18. The initial working directory of gdb is printed on the top line of the GUD buffer and this serves as a default for the commands that specify files for gdb to operate on. and splits the screen to show both your gdb session and the source. See Section “GDB Graphical Interface” in The gnu Emacs Manual. We call this text command mode. All the facilities of Emacs’ Shell mode are available for interacting with your program. also uses a graphical mode. and to the input and output done by the program you are debugging. Emacs automatically finds the source file for that frame and puts an arrow (‘=>’) at the left margin of the current line. To use this interface. page 201. This command starts gdb as a subprocess of Emacs. In the GUD buffer. . you can even use parts of the output in this way.Chapter 26: Using gdb under gnu Emacs 335 26 Using gdb under gnu Emacs A special interface allows you to use gnu Emacs to view (and edit) the source files for the program you are debugging with gdb. If you only specify the file name.1 [Commands to Specify Files]. Each time gdb displays a stack frame. with input and output through a newly created Emacs buffer. enabled by default. M-x gdb calls the program called ‘gdb’. In this case. So. you can send signals the usual way—for example. but you probably have no reason to use them from Emacs. gdb may find your program by searching your environment’s PATH variable. then Emacs sets your current working directory to the directory associated with the previous buffer. • gdb displays source code through Emacs. use the command M-x gdb in Emacs. the auxiliary buffer does not display the current source and line of execution. Emacs uses a separate buffer for source display. By default. C-c C-z for a stop. then Emacs sets your current working directory to where your program resides. If you specify an absolute file name when prompted for the M-x gdb argument. and later.1. This applies both to gdb commands and their output. Explicit gdb list or search commands still produce output as usual. Give the executable file you want to debug as an argument. C-c C-c for an interrupt. although the gdb input and output session proceeds normally. you can use these special Emacs commands in addition to the standard Shell mode commands: C-h m Describe the features of Emacs’ GUD Mode. If you need to call gdb by a different name (for example.

C-c C-i C-c C-f C-c C-r C-c < C-c > In any source file. when you run under Emacs. like the gdb finish command. also update the display window to show the current file and location. If you add or delete lines from the text. like the gdb down command. but keep in mind that gdb communicates with Emacs in terms of line numbers. Execute to next source line in this function. this recreates the source buffer if necessary to show you the context of the current frame. the Emacs command C-x SPC (gud-break) tells gdb to set a breakpoint on the source line point is on. like the gdb next command. click Mouse-2 to make the selected frame become the current one. skipping all function calls. Then update the display window to show the current file and location. like the gdb up command. In graphical mode. the line numbers that gdb knows cease to correspond properly with the code. like the gdb step command. If you accidentally delete the source-display buffer. Execute one instruction. . Execute until exit from the selected stack frame. to request a frame display. Go up the number of frames indicated by the numeric argument (see Section “Numeric Arguments” in The gnu Emacs Manual). if you type M-x speedbar.336 Debugging with gdb C-c C-s C-c C-n Execute to another source line. like the gdb stepi command. an easy way to get it back is to type the command f in the gdb buffer. A more detailed description of Emacs’ interaction with gdb is given in the Emacs manual (see Section “Debuggers” in The gnu Emacs Manual). Move point to any frame in the stack and type RET to make it become the current frame and display the associated source in the source buffer. Emacs displays a separate frame which shows a backtrace when the GUD buffer is current. In text command mode. update display window accordingly. the speedbar displays watch expressions. You can edit the files with these buffers if you wish. like the gdb continue command. Alternatively. Go down the number of frames indicated by the numeric argument. The source files displayed in Emacs are in ordinary Emacs buffers which are visiting the source files in the usual way. Continue execution of your program.

It would not be feasible to include this information in response of resuming commands. page 343). the response contains the requested information. page 13). which is undesirable. It is written in the form of a reference manual. It is specifically intended to support the development of systems which use the debugger as just one small component of a larger system. For the commands that resume the target. Console output notifications are used to report output of CLI commands. 27. . so some of the features described below are incomplete and subject to change (see Section 27. The important examples of notifications are: • Exec notifications. or in gdb state. quite some time may pass before any event happens in the target. For the commands that do not resume the target. or stopped. Each command results in exactly one response. Note that gdb/mi is still under construction.3 gdb/mi General Design Interaction of a GDB/MI frontend with gdb involves three parts—commands sent to gdb. • ( group )+ means that group inside the parentheses may repeat one or more times. as well as diagnostics for other commands.Chapter 27: The gdb/mi Interface 337 27 The gdb/mi Interface Function and Purpose gdb/mi is a line based machine oriented text interface to gdb and is activated by specifying using the ‘--interpreter’ command line option (see Section 2. These are used to report changes in target state—when a target is resumed. that cannot conveniently be associated with a command and reported as part of that command response.6 [gdb/mi Development and Front Ends]. and status notifications. • [ something ] indicates that something is optional: it may or may not be given. responses to those commands and notifications. or an error.2 [Mode Options]. • ( group )* means that group inside the parentheses may repeat zero or more times. Also. including this information in command response would mean no output is produced until the command is finished. Naturally. Status notifications are used to report the progress of a long-running operation. indicating either successful completion of the command. the response only indicates whether the target was successfully resumed. This chapter is a specification of the gdb/mi interface. while a frontend needs to know whether the resuming command itself was successfully executed. Notifications is the mechanism for reporting changes in the state of the target. Notation and Terminology This chapter uses the following notation: • | separates two alternatives.1. • "string" means a literal string. because one resume commands can result in multiple events in different threads. • Console output.

and supplies them to target on each command. First.338 Debugging with gdb • General notifications. even when accessing global data. Second. Often. so no confusion is possible as to what thread and frame are the current ones. the state is not reverted to the state before the MI command was processed. the value to each is gdb identifier for thread and frame to operate on. Therefore. 27. or explicitly add -thread-select for all subsequent commands. getting this optimization right can be tricky. a command may change the selected thread.3. each one used for debugging a different thread. However. There’s no guarantee that whenever an MI command reports an error. In particular. and remembers the user selection for further operations. This doubles the number of commands that need to be sent. so it is suggested to just always pass the ‘--thread’ and ‘--frame’ options. if the user issues the CLI ‘thread’ command via the frontend. No such notification is available for the selected frame at the moment. However. Although such changes can be included in command response. The CLI interface maintains the selected thread and frame. the concept of selected thread and frame is less useful. if the frontend sends several commands to gdb. . the target requires that a thread be specified. Usually. The simplest way is for frontend to emit -thread-select command before every command. In the case of MI. a frontend should either wait for response from such problematic commands. Therefore. in some cases gdb may suggest that the current thread be changed. MI shares the selected thread with CLI.1 Context management In most cases when gdb accesses the target. it is desirable to change the frontend’s selected thread to the one specified by user. The alternative approach is to suppress -thread-select if the selected thread in gdb is supposed to be identical to the thread the frontend wants to operate on. However. For example. then the behaviour of subsequent commands will change. page 81). This increases the risk that by relying on implicitly selected thread. Commands may have various side effects on the gdb or target state beyond their official purpose. No frontend is known to do this exactly right. a graphical frontend can have more than one window. each MI command should explicitly specify which thread and frame to operate on. using notification allows for more orthogonal frontend design. and especially. Note that historically. For example. we recommend that the frontend refreshes all the information shown in the user interface. each top-level window in a frontend allows the user to select a thread and a frame. To make it possible. this access is done in context of a specific thread and frame (see Section 8. because a command line user would not want to specify that information explicitly on each command. when stopping on a breakpoint it is reasonable to switch to the thread where breakpoint is hit. and because user interacts with gdb via a single terminal. and one of the commands changes the selected thread. gdb or the target are in any specific state. getting this to work right is cumbersome. whenever an MI command results in an error. the frontend may be operating on a wrong one. and the frontend might want to access additional threads for internal purposes. For another example.1 [Frames]. a frontend can easily remember this information itself. gdb communicates the suggestion to change current thread using the ‘=thread-selected’ notification. This is convenient. each MI command accepts the ‘--thread’ and ‘--frame’ options. So. so frontends used the -thread-select to execute commands in the right context.

Even if gdb can accept a command while target is running. Note that even commands that operate on global state. many commands that access the target do not work when the target is running. which should be emitted before either running the executable or attaching to the target. nor an notion of the current process in the MI interface. Therefore. which correspond to processes that gdb is debugging at the moment. the two commands -exec-interrupt. asynchronous command execution is most useful when combined with non-stop mode (see Section 5. to find the state of a thread. on any target. . -listthread-groups. Thread group is a collection of threads and other thread groups.3 Thread groups gdb may be used to debug several processes at the same time. returns the list of top-level thread groups. This section describes the MI mechanism to support such debugging scenarios. When a given thread is running. may work or not work.Chapter 27: The gdb/mi Interface 339 27. On some platfroms. A new command. Therefore.3 [Background Execution]. In particular. it is not necessary to introduce neither additional ‘--process’ option.5. set. The key observation is that regardless of the structure of the target.2 Asynchronous command execution and non-stop mode On some targets. Then.3. it is possible to obtain the members of specific thread group. because most commands that accept the ‘--thread’ option do not need to know what process that thread belongs to. page 71). page 69). it can find if asynchronous execution is enabled using the -list-target-features command. By passing an identifier of a thread group to the -list-thread-groups command. or modify breakpoints. depending on the target. Commands that read memory. MI commands that try to access the target in the context of that thread may not work. However. still access the target in the context of a specific thread. MI can have a global list of threads. and breakpoint commands. such as print. To allow the user to discover such grouping. MI introduces the concept of a thread group. while other threads are running. 27. will always work. and may have additional attributes specific to the type. it is possible to examine the state of one thread. The only strictly new feature that is required is the ability to find how the threads are grouped into processes. The frontend may specify a preferrence for asynchronous execution using the -gdb-set target-async 1 command. to stop a thread. a type. gdb is capable of processing MI commands even while the target is running.2 [Non-Stop Mode].5. A thread group always has a string identifier.3. each one having several cores with several different processes running on each core. After the frontend has started the executable or attached to the target. so frontend should try to find a stopped thread and perform the operation on that thread (using the ‘--thread’ option). Which commands will work in the context of a running thread is highly target dependent. This is called asynchronous command execution (see Section 5. or may work only on some targets. and -thread-info. gdb may support debugging of several hardware systems. commands that try to operate on thread’s stack will not work. and to support arbitrary hierarchy of machines/cores/processes.

nl. Available thread group is an thread group that gdb is not debugging. Each inferior corresponds to a thread group of a special type ‘process’.4. page 32).4 gdb/mi Command Syntax 27.9 [Inferiors and Programs]. their output is described below. is passed back when the command finishes. Options occur first in the parameter list and can be delimited from normal parameters using ‘--’ (this is useful when some parameters begin with a dash). provided it doesn’t contain special characters such as "-". """ and of course " " c-string → """ seven-bit-iso-c-string-content """ nl → CR | CR-LF Notes: • The CLI commands are still handled by the mi interpreter. where cli-command is any existing gdb CLI command. but that can be attached to. and other objects.340 Debugging with gdb To allow the user to easily discover processes. he wishes to debug. and some additional operations are permitted on such thread groups. when present. • Some mi commands accept optional arguments as part of the parameter list. 27. Pragmatics: . In general. mi-command → [ token ] "-" operation ( " " option )* [ " --" ] ( " " parameter )* nl token → "any sequence of digits" option → "-" parameter [ " " parameter ] parameter → non-blank-sequence | c-string operation → any of the operations described in this chapter non-blank-sequence → anything. Thread groups are related to inferiors (see Section 4.1 gdb/mi Input Syntax command → cli-command | mi-command cli-command → [ token ] cli-command nl. a concept of available thread group is introduced. the content of a thread group may be only retrieved only after attaching to that thread group. Each option is identified by a leading ‘-’ (dash) and may be followed by an optional argument parameter. • The token. The list of available top-level thread groups can be obtained using ‘-list-thread-groups --available’. using the -targetattach command.

This result record is for the most recent command.2 gdb/mi Output Syntax The output from gdb/mi consists of zero or more out-of-band records followed." result )* nl out-of-band-record → async-record | stream-record async-record → exec-async-output | status-async-output | notify-async-output exec-async-output → [ token ] "*" async-output status-async-output → [ token ] "+" async-output notify-async-output → [ token ] "=" async-output async-output → async-class ( "." result )* "]" stream-record → console-stream-output | target-stream-output | log-stream-output ." result )* "}" "[]" | "[" value ( ". optionally. The sequence of output records is terminated by ‘(gdb)’.4. 27. by a single result record. output → ( out-of-band-record )* [ result-record ] "(gdb)" nl result-record → [ token ] "^" result-class ( ". result → variable "=" value variable → string value → const → tuple → list → const | tuple | list c-string "{}" | "{" result ( ". • We want it to be easy to spot a mi operation." value )* "]" | "[" result ( ".Chapter 27: The gdb/mi Interface 341 • We want easy access to the existing CLI syntax (for debugging). If an input command was prefixed with a token then the corresponding output for that command will also be prefixed by that same token." result )* nl result-class → "done" | "running" | "connected" | "error" | "exit" async-class → "stopped" | others (where others will be added depending on the needs—this is still in development).

• exec-async-output contains asynchronous state change on the target (stopped. started.342 Debugging with gdb console-stream-output → "~" c-string target-stream-output → "@" c-string log-stream-output → "&" c-string nl → token → Notes: • All output sequences end in a single line containing a period. such as if. CR | CR-LF any sequence of digits. This feature may be removed at some stage in the future and it is recommended that front ends use the -interpreter-exec command (see [-interpreter-exec]. • log-stream-output is output text coming from gdb’s internals. All async output is prefixed by ‘*’. for instance messages that should be displayed as part of an error log. It is the textual response to a CLI command. commands that query the user will behave as if the user replied yes. while the token is allowed by the grammar and may be output by future versions of gdb for select async output messages. page 344. Frontends should treat all async output as reporting general changes in the state of the target and there should be no need to associate async output to any prior command. a new breakpoint information). All the target output is prefixed by ‘@’. • The token is from the corresponding request. it is generally omitted. Note that for all async output. . See Section 27. prompt for further input with ‘>’.. • status-async-output contains on-going status information about the progress of a slow operation.g. for more details about the various output records. All notify output is prefixed by ‘=’. which is not valid MI output. when and define. • console-stream-output is output that should be displayed as is in the console. • notify-async-output contains supplementary information that the client should handle (e. All the log output is prefixed by ‘&’.5 gdb/mi Compatibility with CLI For the developers convenience CLI commands can be entered directly. For example. but there may be some unexpected behaviour. All the console output is prefixed by ‘~’. It can be discarded. • New gdb/mi commands should only output lists containing values. disappeared). 27. page 407).2 [gdb/mi Stream Records]. • target-stream-output is the output produced by the target program. breakpoint command lists are not executed and some CLI commands. All status output is prefixed by ‘+’.7.

so front ends should parse MI output in a way that can handle them: • New MI commands may be added. results are the return values. but all frontends should treat ‘^done’ and ‘^running’ identically and rely on the ‘*running’ output record to determine which threads are resumed. the MI version level will be increased by one. This makes it difficult to introduce new functionality without breaking existing usage.1 gdb/mi Result Records In addition to a number of out-of-band notifications. 27. page 382) may be extended. • New fields may be added to the output of any MI command. new versions of gdb will not support old versions of MI and it will be the responsibility of the front end to work with the new one. Although gdb/mi is still incomplete." results ] The synchronous operation was successful. The best way to avoid unexpected changes in MI that might break your front end is to make your project known to gdb developers and follow development on gdb@sourceware.org and gdb-patches@sourceware. This will allow the front end to parse the output according to the MI version. This section tries to minimize the problems by describing how the protocol might change.7 gdb/mi Output Records 27.6 gdb/mi Development and Front Ends The application which takes the MI output and presents the state of the program being debugged to the user is called a front end. If the changes are likely to break front ends. Apart from mi0. This behaviour is maintained for backward compatibility. "^error" ".7. . e. it was output instead of ‘^done’ if the command has resumed the target." c-string The operation failed.. "^running" This result record is equivalent to ‘^done’. Some changes in MI need not break a carefully designed front end. • The range of values for fields with specified values. the response to a gdb/mi command includes one of the following result indications: "^done" [ ". in_scope (see [-var-update]. The following is a list of changes that may occur within one level. The c-string contains the corresponding error message. and for these the MI version will remain unchanged.Chapter 27: The gdb/mi Interface 343 27.org. Historically. "^connected" gdb has connected to a remote target.g. "^exit" gdb has terminated. it is currently being used by a variety of front ends to gdb.

gdb may emit this notification several times. the target. "&" string-output The log stream contains debugging messages being produced by gdb’s internals. Each stream record begins with a unique prefix character which identifies its stream (see Section 27.thread-id="thread" The target is now running. and the log. target stopped). The following is the list of possible async records: *running.344 Debugging with gdb 27. The frontend should assume that no interaction with a running thread is possible after this notification is produced. because it cannot resume all threads together. The frontend should not assume that this notification is output only once for any command.g. a breakpoint modified) or a result of target activity (e.7.4. page 341).7.stopped-threads="stopped".3 gdb/mi Async Records Async records are used to notify the gdb/mi client of additional changes that have occurred. This is either raw text (with an implicit new line) or a quoted C string (which does not contain an implicit newline). This is only present when GDB’s event loop is truly asynchronous. which is currently only the case for remote targets. Those changes can either be a consequence of gdb/mi commands (e. either for different threads.reason="reason". It contains the textual responses to CLI commands.2 gdb/mi Stream Records gdb internally maintains a number of output streams: the console. The output intended for each of these streams is funneled through the gdb/mi interface using stream records. or even for a single thread.g. read-watchpoint-trigger A read watchpoint was triggered.core="core" The target has stopped. if the thread must be stepped though some code before letting it run freely.thread-id="id". "~" string-output The console output stream contains text that should be displayed in the CLI console window... The thread field tells which specific thread is now running. and can be ‘all’ if all threads are running. 27. each stream record contains a string-output. In addition to the prefix. The reason field can have one of the following values: breakpoint-hit A breakpoint was reached.2 [gdb/mi Output Syntax]. . access-watchpoint-trigger An access watchpoint was triggered. "@" string-output The target output stream contains any textual output from the running target. watchpoint-trigger A watchpoint was triggered. *stopped.

When a thread group is added. end-stepping-range An -exec-next. or only the thread that directly triggered the stop. either because the program has exited. When a thread group is removed. or because it was detached from. The id field contains the gdb identifier of the thread group. this list will always include a single thread. . the stopped field will have the value of "all". either because the program was just started or the thread group was attached to a program.id="id" =thread-group-removed.id="id" A thread group was either added or removed. =thread-group-started. its id becomes invalid and cannot be used in any way. -exec-next-instruction. signal-received A signal was received by the inferior. the value of the stopped field will be a list of thread identifiers. it generally might not be associated with a running process. exited The inferior exited. -exec-step. location-reached An -exec-until or similar CLI command was accomplished. exited-signalled The inferior exited because of a signal. specific to the operating system. Otherwise. Presently. exited-normally The inferior exited normally. =thread-group-added.id="id".Chapter 27: The gdb/mi Interface 345 function-finished An -exec-finish or similar CLI command was accomplished.pid="pid" A thread group became associated with a running program. but frontend should be prepared to see several threads in the list. page 68). gdb may either stop all threads. Depending on whether all-stop mode is in effect (see Section 5. If all threads are stopped. This field may be absent if such information is not available.1 [All-Stop Mode]. The id field contains the gdb identifier of the thread group. code is the exit code of the inferior. The pid field contains process identifier. watchpoint-scope A watchpoint has gone out of scope.5. The id field contains the gdb identifier of the thread group. =thread-group-exited. The id field identifies the thread that directly caused the stop – for example by hitting a breakpoint.exit-code="code"] A thread group is no longer associated with a running program. The core field reports the processor core on which the stop event has happened. -exec-stepinstruction or similar CLI command was accomplished. it exists only when the inferior exited with some code.id="id"[.

target-name and host-name fields give the name of the library file on the target. it means the library was unloaded in the context of all present thread groups. respectively. For remote debugging case. This notification has 4 fields—id. or has exited.. and symbols-loaded.} Reports that a breakpoint was created. front ends highlight the selected thread and cause subsequent commands to apply to that thread. modified.bkpt={. See Section 27. The thread-group field... Reports that a new library file was loaded by the program. if present.} =breakpoint-deleted.id="id" Informs that the selected thread was changed as result of the last command. We suggest that in response to this notification.id="id". directly or indirectly (via user-defined command).346 Debugging with gdb =thread-created. The symbols-loaded field is emitted only for backward compatibility and should not be relied on to convey any useful information. and on the host respectively. This notification has 3 fields—id. Only user-visible breakpoints are reported to the MI user. target-name.. 27. If the field is absent. The bkpt argument is of the same form as returned by the various breakpoint commands. In particular.bkpt={. then it will not also be emitted in an async record. The id field is an opaque identifier of the library.. invoking. The gid field identifies the thread group this thread belongs to. This information is a tuple that may have the following fields: ..id="id". specifies the id of the thread group in whose context the library was loaded. =library-loaded... or deleted. specifies the id of the thread group in whose context the library was unloaded.. page 349. Reports that a library was unloaded by the program. both those fields have the same value.. For native debugging.} =breakpoint-modified. This notification is not emitted as result of -thread-select command but is emitted whenever an MI command that is not documented to change the selected thread actually changes it..group-id="gid" =thread-exited. The id field contains the gdb identifier of the thread. =breakpoint-created. will generate this notification. the CLI thread command..10 [GDB/MI Breakpoint Commands]. =thread-selected. it means the library was loaded in the context of all present thread groups. The thread-group field.bkpt={. =library-unloaded. If the field is absent. target-name and host-name with the same meaning as for the =library-loaded notification.4 gdb/mi Frame Information Response from many MI commands includes an information about stack frame. Note that if a breakpoint is emitted in the result record of a command.7. host-name. if present.group-id="gid" A thread either was created.

The name of the binary file (either executable or shared library) the corresponds to the frame’s code address. while ‘<-’ means the output received from gdb/mi.7. Either ‘stopped’ or ‘running’.5 gdb/mi Thread Information Whenever gdb has to report an information about a thread.1. This field is optional. It is supposed to be human-readable and not interpreted by the frontend. gdb provides the name of the exception that was raised via the exception-name field. This field is always present. The numeric id assigned to the thread by gdb. 27. The innermost frame has the level of zero. they don’t appear in the real output. Note the line breaks shown in the examples are here only for readability. The source line corresponding to the frames’ code address. This field may be absent if gdb is unable to determine the function name. This field is always present.Chapter 27: The gdb/mi Interface 347 level func addr file line from The level of the stack frame. The value of this field is an integer number of the processor core the thread was last seen on. The name of the function corresponding to the frame. . The code address for the frame.8 Simple Examples of gdb/mi Interaction This subsection presents several simple examples of interaction using the gdb/mi interface. depending on whether the thread is presently running. The name of the source files that correspond to the frame’s code address. This field may be absent.6 gdb/mi Ada Exception Information Whenever a *stopped record is emitted because the program stopped after hitting an exception catchpoint (see Section 5. it uses a tuple with the following fields: id target-id Target-specific string identifying the thread. This field is optional. This field is always present. This field may be absent. 27. page 52).7. This field is always present. 27. Setting a Breakpoint Setting a breakpoint generates synchronous output which contains detailed information of the breakpoint. In these examples. details state core Additional information about the thread provided by the target. This field may be absent. ‘->’ means that the following line is passed to gdb/mi as input.3 [Set Catchpoints]. This field is always present.

file="myprog. gdb performs necessary cleanups.(gdb) 27. During that time.value="0xbfc4d4d4"}]. enabled="y".line="68".fullname="/home/nickrob/myprog.{name="argv".disp="keep".file="myprog.c".-gdb-exit <.msg="Undefined MI command: rubbish" <. including killing programs being debugged or disconnecting from debug hardware. -> (gdb) <. Each block of commands is laid out in a fashion similar to this section.func="main".addr="0x08048564".func="main".reason="breakpoint-hit".thread-id="0".(gdb) Program Execution Program execution generates asynchronous records and MI gives the reason that execution stopped.^error.bkpt={number="1".348 Debugging with gdb -> -break-insert main <. A Bad Command Here’s what happens if you pass a non-existent command: -> -rubbish <.c". .bkptno="1".^exit Please note that ‘^exit’ is printed immediately.9 gdb/mi Command Description Format The remaining sections describe blocks of commands.reason="exited-normally" (gdb) <-> <<<<- Quitting gdb Quitting gdb just prints the result class ‘^exit’.c".type="breakpoint".disp="keep". -> <<<-exec-run ^running (gdb) *stopped. but it might take some time for gdb to actually exit. Introduction A brief introduction to this collection of commands as a whole.value="1"}. so the frontend should wait till gdb exits and should only forcibly kill gdb if it fails to exit in reasonable time.times="0"} <.line="68"} (gdb) -exec-continue ^running (gdb) *stopped.c". frame={addr="0x08048564". fullname="/home/nickrob/myprog. Motivation The motivation for this collection of commands.^done. args=[{name="argc".

. Example Example(s) formatted for readability. body=[bkpt={number="1". fullname="/home/foo/hello.alignment="2".type="breakpoint".col_name="type".BreakpointTable={nr_rows="1".col_name="enabled".disp="keep".col_name="number".bkpt={number="1".colhdr="Type"}. {width="4". see the description of the ‘-break-list’ command below. The -break-after Command Synopsis -break-after number count The breakpoint number number is not in effect until it has been hit count times.A. . To see how this is reflected in the output of the ‘-break-list’ command. {width="14".alignment="-1".10 gdb/mi Breakpoint Commands This section documents gdb/mi commands for manipulating breakpoints. Result gdb Command The corresponding gdb CLI command(s).alignment="-1"..colhdr="What"}].file="hello.colhdr="Disp"}. Example (gdb) -break-insert main ^done.colhdr="Address"}. if any.alignment="-1".enabled="y". the following is described: Synopsis -command args.col_name="addr".colhdr="Num"}.func="main". Some of the described commands have not been implemented yet and these are labeled N.Chapter 27: The gdb/mi Interface 349 Commands For each command in the block.disp="keep".addr="0x000100d0".colhdr="Enb"}.alignment="-1".nr_cols="6". enabled="y".times="0"} (gdb) -break-after 1 3 ~ ^done (gdb) -break-list ^done. hdr=[{width="3". {width="10".type="breakpoint".c".alignment="-1". gdb Command The corresponding gdb command is ‘ignore’. {width="3".line="5".c".col_name="disp". {width="40".col_name="what". 27. (not available).

.c". any previously-set commands are cleared. Typical use of this functionality is tracing a program.alignment="-1".times="0"} (gdb) -break-commands 1 "print v" "continue" ^done (gdb) The -break-condition Command Synopsis -break-condition number expr Breakpoint number will stop the program only if the condition in expr is true. printing of values of some variables whenever breakpoint is hit and then continuing. commandN ] Specifies the CLI commands that should be executed when breakpoint number is hit. The parameters command1 to commandN are the commands. that is.. fullname="/home/foo/hello.addr="0x000100d0". gdb Command The corresponding gdb command is ‘condition’.BreakpointTable={nr_rows="1".file="hello. page 59.col_name="addr".col_name="disp".7 [Break Commands].col_name="enabled".colhdr="Disp"}.line="5". line="5".colhdr="Enb"}.bkpt={number="1".nr_cols="6". enabled="y".colhdr="Type"}.alignment="-1".disp="keep". {width="3".350 Debugging with gdb addr="0x000100d0".col_name="type".fullname="/home/foo/hello.1.alignment="-1".. hdr=[{width="3".times="0".colhdr="Address"}. {width="14".alignment="-1".func="main".c".file="hello.colhdr="Num"}. See Section 5. Example (gdb) -break-insert main ^done. gdb Command The corresponding gdb command is ‘commands’. {width="4".alignment="-1". If no command is specified.type="breakpoint".c". The condition becomes part of the ‘-break-list’ output (see the description of the ‘-break-list’ command below).c".func="main".col_name="number".ignore="3"}]} (gdb) The -break-commands Command Synopsis -break-commands number [ command1 . {width="10". Example (gdb) -break-condition 1 1 ^done (gdb) -break-list ^done.

col_name="addr". Example (gdb) -break-delete 1 ^done (gdb) -break-list ^done. body=[]} (gdb) The -break-disable Command Synopsis -break-disable ( breakpoint )+ Disable the named breakpoint(s).enabled="y". {width="10".alignment="-1". {width="4".disp="keep".col_name="number". line="5".alignment="-1".alignment="-1".alignment="-1".func="main". . Example (gdb) -break-disable 2 ^done (gdb) -break-list ^done. {width="14".file="hello.alignment="2".col_name="enabled".alignment="-1".col_name="disp".alignment="-1".colhdr="Type"}.fullname="/home/foo/hello. The field ‘enabled’ in the break list is now set to ‘n’ for the named breakpoint(s).colhdr="Address"}.ignore="3"}]} (gdb) The -break-delete Command Synopsis -break-delete ( breakpoint )+ Delete the breakpoint(s) whose number(s) are specified in the argument list.nr_cols="6". gdb Command The corresponding gdb command is ‘disable’.colhdr="Num"}.times="0".alignment="-1".alignment="-1". {width="40".col_name="what". {width="14".type="breakpoint". body=[bkpt={number="1".col_name="type".colhdr="What"}].nr_cols="6".BreakpointTable={nr_rows="0".colhdr="Num"}. addr="0x000100d0".col_name="what". {width="4".colhdr="Disp"}.colhdr="Disp"}.c".BreakpointTable={nr_rows="1".colhdr="Type"}. This is obviously reflected in the breakpoint list.colhdr="What"}]. {width="3".colhdr="Enb"}.col_name="type".cond="1". hdr=[{width="3".c".Chapter 27: The gdb/mi Interface 351 {width="40".col_name="number". gdb Command The corresponding gdb command is ‘delete’.alignment="2". hdr=[{width="3".col_name="disp".

col_name="enabled".nr_cols="6".func="main". gdb Command The corresponding gdb command is ‘info break breakpoint’.alignment="-1".colhdr="Address"}.alignment="-1".colhdr="Type"}.fullname="/home/foo/hello.colhdr="Address"}.alignment="2".enabled="n".c".c".alignment="-1". The -break-insert Command Synopsis -break-insert [ -t ] [ -h ] [ -f ] [ -d ] [ -a ] . gdb Command The corresponding gdb command is ‘enable’.col_name="addr".col_name="enabled".col_name="disp".c".func="main".colhdr="Enb"}. {width="40".colhdr="What"}].alignment="-1". {width="3". body=[bkpt={number="2".file="hello.file="hello.disp="keep". Example (gdb) -break-enable 2 ^done (gdb) -break-list ^done. hdr=[{width="3".352 Debugging with gdb {width="3".c". addr="0x000100d0". {width="4".colhdr="Enb"}. {width="40". line="5". Example N.type="breakpoint".alignment="-1". addr="0x000100d0". body=[bkpt={number="2".fullname="/home/foo/hello.col_name="addr".times="0"}]} (gdb) The -break-info Command Synopsis -break-info breakpoint Get information about a single breakpoint.type="breakpoint".times="0"}]} (gdb) The -break-enable Command Synopsis -break-enable ( breakpoint )+ Enable (previously disabled) breakpoint(s).disp="keep".BreakpointTable={nr_rows="1".col_name="type".alignment="-1".alignment="2".alignment="-1". line="5". {width="14". {width="10". {width="10".col_name="number".A.col_name="what".enabled="y".colhdr="Disp"}.col_name="what".colhdr="What"}].colhdr="Num"}.

Create a tracepoint. gdb will report an error. Note: this format is open to change.file="filename". location. create a pending breakpoint. See Chapter 13 [Tracepoints]. funcname is the name of the function where the breakpoint was inserted. fullname="/home/foo/recursive2.[thread="threadno. if location cannot be parsed. ‘thbreak’.bkpt={number="number".file="recursive2.addr="hex". Create a disabled breakpoint. ‘-f’ If location cannot be parsed (for example if it refers to unknown files or functions). and won’t create a breakpoint. Example (gdb) -break-insert main ^done. When this parameter is used together with ‘-h’. fullname="full_filename".type="type".disp="del"|"keep". ‘hbreak’. gdb Command The corresponding gdb commands are ‘break’. Without this flag.Chapter 27: The gdb/mi Interface 353 [ -c condition ] [ -i ignore-count ] [ -p thread ] [ location ] If specified. filename is the name of the source file which contains this function. can be one of: • function • filename:linenum • filename:function • *address The possible optional parameters of this command are: ‘-t’ ‘-h’ Insert a temporary breakpoint. Insert a hardware breakpoint.c". a fast tracepoint is created. enabled="y"|"n".line="4". ‘-i ignore-count’ Initialize the ignore-count. and ‘rbreak’.c. lineno is the source line number within that file and times the number of times that the breakpoint has been hit (always 0 for -break-insert but may be greater for -break-info or -break-list which use the same output).line="lineno". ‘-c condition’ Make the breakpoint conditional on condition.times="0"} (gdb) . page 139.bkpt={number="1".] times="times"} where number is the gdb number for this breakpoint.addr="0x0001072c".func="funcname". ‘tbreak’. ‘-d’ ‘-a’ Result The result is in the form: ^done.

colhdr="Type"}.c. int).type="breakpoint".354 Debugging with gdb -break-insert -t foo ^done.bkpt={number="2". line number number of times the breakpoint has been hit If there are no breakpoints or watchpoints.alignment="-1".col_name="number". body=[bkpt={number="1".file="recursive2.addr="0x00010774".type="breakpoint".line="11". bkpt={number="2".colhdr="Num"}.file="recursive2.times="0"}]} (gdb) -break-insert -r foo.nr_cols="6". "fullname="/home/foo/recursive2. fullname="/home/foo/recursive2. the BreakpointTable body field is an empty list.times="0"} (gdb) -break-list ^done.col_name="addr".alignment="2".times="0"}.bkpt={number="3".disp="keep"."line="4". fullname="/home/foo/recursive2.func="foo". {width="3".col_name="enabled". showing the following fields: ‘Number’ ‘Type’ number of the breakpoint type of the breakpoint: ‘breakpoint’ or ‘watchpoint’ ‘Disposition’ should the breakpoint be deleted or disabled when it is hit: ‘keep’ or ‘nokeep’ ‘Enabled’ ‘Address’ ‘What’ ‘Times’ is the breakpoint enabled or no: ‘y’ or ‘n’ memory location at which the breakpoint is set logical location of the breakpoint.alignment="-1".c.line="11". {width="10". {width="14".addr="0x00010774".BreakpointTable={nr_rows="2".c". Example (gdb) -break-list . ^done.enabled="y". expressed by function name. func="main".enabled="y".times="0"} (gdb) The -break-list Command Synopsis -break-list Displays the list of inserted breakpoints. gdb Command The corresponding gdb command is ‘info break’.file="recursive2.alignment="-1".colhdr="Disp"}.* ~int foo(int. {width="40".colhdr="Enb"}.alignment="-1".colhdr="Address"}.c".col_name="type".c". addr="0x0001072c". hdr=[{width="3".col_name="disp".disp="del". addr="0x00010774".c".line="11".col_name="what". {width="4".colhdr="What"}].alignment="-1".c".file="recursive2.c. fullname="/home/foo/recursive2. file name.

hdr=[{width="3".alignment="-1". body=[bkpt={number="1". {width="14".c".e.. addr="0x00010114".c".colhdr="Num"}.colhdr="Disp"}.func="main".disp="keep".e. gdb Command The corresponding gdb commands are ‘watch’.col_name="enabled".alignment="2".alignment="-1".col_name="number". {width="4".alignment="-1".file="hello. it will trigger only when the memory location is accessed for reading.colhdr="Address"}..col_name="addr".colhdr="Num"}. ‘awatch’.alignment="-1".col_name="what".Chapter 27: The gdb/mi Interface 355 ^done.col_name="type".nr_cols="6".colhdr="Disp"}.col_name="disp"..col_name="type".type="breakpoint".col_name="disp".col_name="addr". line="13". Example Setting a watchpoint on a variable in the main function: .c".colhdr="Enb"}.BreakpointTable={nr_rows="2". If the breakpoint referred to by tracepoint-number is not a tracepoint.alignment="-1". {width="3". error is emitted.enabled="y". bkpt={number="2".fullname="/home/foo/hello.alignment="-1". i.colhdr="Type"}. {width="40".alignment="-1". {width="14".alignment="-1". The -break-watch Command Synopsis -break-watch [ -a | -r ] Create a watchpoint. and ‘rwatch’.colhdr="Type"}.colhdr="Enb"}.times="0"}]} (gdb) Here’s an example of the result when there are no breakpoints: (gdb) -break-list ^done.colhdr="Address"}. With the ‘-a’ option it will create an access watchpoint.times="0"}. i. hdr=[{width="3". {width="10".2 [Setting Watchpoints].file="hello. {width="3".nr_cols="6".col_name="number".1.col_name="what". Without either of the options.alignment="2". i. addr="0x000100d0".enabled="y". it will trigger when the memory location is accessed for writing. a watchpoint that triggers either on a read from or on a write to the memory location.colhdr="What"}].disp="keep". body=[]} (gdb) The -break-passcount Command Synopsis -break-passcount tracepoint-number passcount Set the passcount for tracepoint tracepoint-number to passcount. page 49.col_name="enabled". Note that ‘-break-list’ will report a single list of watchpoints and breakpoints inserted. With the ‘-r’ option.alignment="-1". {width="40".line="5". the watchpoint created is a read watchpoint.alignment="-1". See Section 5. {width="10".colhdr="What"}]. {width="4".type="breakpoint".e. This corresponds to CLI command ‘passcount’.func="foo". the watchpoint created is a regular watchpoint.BreakpointTable={nr_rows="0".

func="callee4".. it is deleted.col_name="what"./devo/gdb/testsuite/gdb.args=[{name="strarg"./devo/gdb/testsuite/gdb. body=[bkpt={number="1".. fullname="/home/foo/bar/devo/gdb/testsuite/gdb.alignment="-1".col_name="type".c". wpt={number="5".wpnum="5". {width="3". {width="10"./.type="watchpoint".c".reason="watchpoint-trigger".mi/basics././.colhdr="Address"}.c"line="8"../.. fullname="/home/foo/bar/devo/gdb/testsuite/gdb.colhdr="Num"}. file=". frame={func="callee4"./devo/gdb/testsuite/gdb.exp="x"} (gdb) -exec-continue ^running (gdb) *stopped..mi/basics.wpt={number="5"..line="13"} (gdb) -exec-continue ^running (gdb) *stopped.colhdr="Disp"}.disp="keep"./.exp="C"} (gdb) -break-list ^done.mi/basics.\""}].alignment="-1".reason="watchpoint-trigger"..alignment="-1". at different points in the program execution.file="recursive2.wpt={number="2".enabled="y".new="55"}. addr="0x00010734".line="18"} (gdb) Listing breakpoints and watchpoints.c". fullname="/home/foo/devo/gdb/testsuite/gdb.mi/basics./. frame={func="main". Note that once the watchpoint goes out of scope.alignment="-1".col_name="number". then for the watchpoint going out of scope.colhdr="Type"}. frame={func="callee3".c". file=".line="5"} (gdb) Setting a watchpoint on a variable local to a function.wpt={number="2".reason="watchpoint-scope".value={old="-276895068".alignment="-1". gdb will stop the program execution twice: first for the variable changing value. {width="4".alignment="2".col_name="addr".356 Debugging with gdb (gdb) -break-watch x ^done. (gdb) -break-watch C ^done.c".wpt={number="2".c". (gdb) -break-watch C ^done.type="breakpoint".col_name="enabled". .mi/basics.new="3"}. hdr=[{width="3".nr_cols="6".col_name="disp".c". value="0x11940 \"A string argument. {width="14".. fullname="/home/foo/bar/recursive2.exp="C"}. bkpt={number="2"..BreakpointTable={nr_rows="2".mi/basics.args=[].exp="C"} (gdb) -exec-continue ^running (gdb) *stopped.times="1"}. value={old="-268439212".colhdr="Enb"}. {width="40".args=[]. file=".exp="x"}.disp="keep".colhdr="What"}].

fullname="/home/foo/bar/devo/gdb/testsuite/gdb.alignment="-1".col_name="type".func="callee4". addr="0x00010734"..alignment="-1".mi/basics./devo/gdb/testsuite/gdb.c"./devo/gdb/testsuite/gdb.what="C".alignment="2".. times="1"}]} (gdb) 27.col_name="enabled".col_name="what". body=[bkpt={number="1".enabled="y".c".c"../devo/gdb/testsuite/gdb./..reason="watchpoint-trigger"..line="8"..alignment="-1".c". fullname="/home/foo/devo/gdb/testsuite/gdb.colhdr="Type"}.line="13"} (gdb) -break-list ^done.alignment="-1".new="3"}.enabled="y".col_name="disp".disp="keep".mi/basics.BreakpointTable={nr_rows="1".alignment="-1"..col_name="number".col_name="addr"./. frame={func="callee3".type="watchpoint". file=".addr="".colhdr="Enb"}. {width="4".line="8". {width="10". addr="0x00010734".c". body=[bkpt={number="1". {width="4". value={old="-276895068". {width="14".reason="watchpoint-scope".mi/basics.colhdr="Disp"}. bkpt={number="2". file=".mi/basics.11 gdb/mi Program Context The -exec-arguments Command Synopsis -exec-arguments args Set the inferior program arguments..type="breakpoint".col_name="disp".col_name="enabled".alignment="-1".times="0"}]} (gdb) -exec-continue ^running (gdb) *stopped.col_name="addr".colhdr="Num"}. frame={func="callee4".colhdr="What"}].c".exp="C"}./.c".disp="keep".mi/basics. hdr=[{width="3". {width="10".colhdr="Num"}.c"./.colhdr="Address"}.times="-5"}]} (gdb) -exec-continue ^running ^done.mi/basics.nr_cols="6".wpt={number="2". {width="3".mi/basics./devo/gdb/testsuite/gdb.col_name="what"./.colhdr="Enb"}. .what="C".colhdr="Type"}.addr=""...alignment="2"..Chapter 27: The gdb/mi Interface 357 enabled="y".BreakpointTable={nr_rows="2".func="callee4". fullname="/home/foo/devo/gdb/testsuite/gdb. {width="40". enabled="y". value="0x11940 \"A string argument./. to be used in the next ‘-exec-run’. {width="14".colhdr="Disp"}.colhdr="What"}]./.colhdr="Address"}. {width="40".alignment="-1". file=". file=". {width="3"./.disp="keep".line="18"} (gdb) -break-list ^done.nr_cols="6".alignment="-1".alignment="-1".col_name="type". fullname="/home/foo/bar/devo/gdb/testsuite/gdb.col_name="number".alignment="-1".wpnum="2".args=[].\""}].mi/basics. hdr=[{width="3".args=[{name="strarg".type="breakpoint".times="1"}..

Example (gdb) -environment-directory /kwikemart/marge/ezannoni/flathead-dev/devo/gdb ^done.358 Debugging with gdb gdb Command The corresponding gdb command is ‘set args’. the current search path is displayed. the search path is reset to the default search path. If the ‘-r’ option is used.source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" (gdb) -environment-directory "" . gdb Command The corresponding gdb command is ‘dir’. Multiple directories may be specified. gdb Command The corresponding gdb command is ‘cd’. If directories pathdir are supplied in addition to the ‘-r’ option. Example (gdb) -environment-cd /kwikemart/marge/ezannoni/flathead-dev/devo/gdb ^done (gdb) The -environment-directory Command Synopsis -environment-directory [ -r ] [ pathdir ]+ Add directories pathdir to beginning of search path for source files. separated by blanks. The directory-separator character must not be used in any directory name. Specifying multiple directories in a single command results in the directories added to the beginning of the search path in the same order they were presented in the command. the path will show up separated by the system directory-separator character. the search path is first reset and then addition occurs as normal. In the command output. If blanks are needed as part of a directory name. If no directories are specified. Example (gdb) -exec-arguments -v word ^done (gdb) The -environment-cd Command Synopsis -environment-cd pathdir Set gdb’s working directory. double-quotes should be used around the name.

the search path is first reset and then addition occurs as normal. gdb Command The corresponding gdb command is ‘pwd’. If directories pathdir are supplied in addition to the ‘-r’ option. Example (gdb) .source-path="/home/jjohnstn/src/gdb:/usr/src:$cdir:$cwd" (gdb) -environment-directory -r ^done.path="/usr/local/bin:/usr/bin" (gdb) The -environment-pwd Command Synopsis -environment-pwd Show the current working directory. If the ‘-r’ option is used. the current path is displayed.Chapter 27: The gdb/mi Interface 359 ^done.source-path="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb:$cdir:$cwd" (gdb) -environment-directory -r /home/jjohnstn/src/gdb /usr/src ^done.path="/kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb:/bin:/usr/bin" (gdb) -environment-path -r /usr/local/bin ^done. gdb Command The corresponding gdb command is ‘path’. the search path is reset to the original search path that existed at gdb start-up. Example (gdb) -environment-path ^done. separated by blanks. If no directories are specified. Multiple directories may be specified. The directory-separator character must not be used in any directory name. the path will show up separated by the system directory-separator character. Specifying multiple directories in a single command results in the directories added to the beginning of the search path in the same order they were presented in the command.path="/usr/bin" (gdb) -environment-path /kwikemart/marge/ezannoni/flathead-dev/ppc-eabi/gdb /bin ^done.source-path="$cdir:$cwd" (gdb) The -environment-path Command Synopsis -environment-path [ -r ] [ pathdir ]+ Add directories pathdir to beginning of search path for object files. If blanks are needed as part of a directory name. In the command output. double-quotes should be used around the name.

frame={level="0". Otherwise. if gdb can extract the thread name from the target. The identifier that gdb uses to refer to the thread. then this field is the core identifier. The thread is running. It has the value ‘*’. ‘target-id’ The identifier that the target uses to refer to the thread.threads=[ {id="2". ‘details’ ‘name’ Extra information about the thread. This field is optional. If gdb cannot find the thread name. or about all threads. This field is optional. ‘frame’ ‘state’ If gdb can find the CPU core on which this thread is running. The stack frame currently executing in the thread. If the user specified a name using the thread name command. Frame information is available for stopped threads. Example -thread-info ^done. then that name is given. There’s no frame information for running threads. When printing information about all threads.360 Debugging with gdb -environment-pwd ^done. gdb Command The ‘info thread’ command prints the same information about all threads. The ‘state’ field may have the following values: stopped running ‘core’ The thread is stopped. The thread’s state. if the thread-id parameter is present.func="__kernel_vsyscall". also reports the current thread. . then this name is given.addr="0xffffe410".cwd="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb" (gdb) 27.target-id="Thread 0xb7e14b90 (LWP 21257)". Result The result is a list of threads.12 gdb/mi Thread Commands The -thread-info Command Synopsis -thread-info [ thread-id ] Reports information about either a specific thread. in a target-specific format. The name of the thread. then this field is omitted. The following attributes are defined for a given thread: ‘current’ ‘id’ This field exists only for the current thread.

/.c". This command is retained for historical reasons.thread-id="2". This command is deprecated in favor of explicitly using the ‘--thread’ option to each command.state="running"}.addr="0x0804891f".threads/linux-dp. Example (gdb) -thread-list-ids ^done.thread-ids={thread-id="3".func="foo".thread-id="1"}. At the end of the list it also prints the total number of such threads. the -thread-info command should be used instead.Chapter 27: The gdb/mi Interface 361 args=[]}. and the topmost frame for that thread.value="10"}].. gdb Command Part of ‘info threads’ supplies the same information.c" (gdb) -thread-list-ids ^done. frame={level="0".thread-id="2". .target-id="Thread 0xb7e156b0 (LWP 21254)". args=[{name="i". gdb Command The corresponding gdb command is ‘thread’. file=".line="187". state="running"}]./.fullname="/tmp/a. {id="1". current-thread-id="1".reason="end-stepping-range". current-thread-id="1" (gdb) The -thread-list-ids Command Synopsis -thread-list-ids Produces a list of the currently known gdb thread ids./devo/gdb/testsuite/gdb.. Example (gdb) -exec-next ^running (gdb) *stopped. file="/tmp/a..line="158"}.number-of-threads="3" (gdb) The -thread-select Command Synopsis -thread-select threadnum Make threadnum the current thread.c". It prints the number of the new current thread.

.4.13 gdb/mi Ada Tasking Commands The -ada-task-info Command Synopsis -ada-task-info [ task-id ] Reports information about either a specific Ada task. page 183. ‘parent-id’ This field exists only when the task was created by another task. For a detailed description of the possible states. The identifier that gdb uses to refer to the Ada task.value="0x2"}]. if the task-id parameter is present. Result The result is a table of Ada tasks.thread-id="1"}.value="0x8048e9c \"%*s%c %d %c\\n\""}.4. ‘state’ ‘name’ The current state of the task. The following columns are defined for each Ada task: ‘current’ ‘id’ ‘task-id’ This field exists only for the current thread.8. see Section 15.thread-id="2". number-of-threads="3" (gdb) -thread-select 3 ^done.line="31"} (gdb) 27. or about all Ada tasks. ‘thread-id’ The identifier of the thread corresponding to the Ada task. page 183). But if gdb cannot find this corresponding thread for any reason. ‘priority’ The base priority of the task. It has the value ‘*’. frame={level="0".c". The identifier that the target uses to refer to the Ada task. as Ada tasks are always implemented on top of a thread. gdb Command The ‘info tasks’ command prints the same information about all Ada tasks (see Section 15.362 Debugging with gdb thread-ids={thread-id="3".file="vprintf.new-thread-id="3". In this case. The name of the task. the field is omitted. it provides the ID of the parent task.func="vprintf". args=[{name="format". {name="arg". This field should always exist.5 [Ada Tasks].8.5 [Ada Tasks].

The -exec-continue Command Synopsis -exec-continue [--reverse] [--all|--thread-group N] Resumes the execution of the inferior program.colhdr=""}. If ‘--all’ is specified.col_name="id".5.colhdr="P-ID"}. hdr=[{width="1".thread-id="1".colhdr="Name"}]. line="13"} (gdb) .frame={ func="foo". {width="22". {width="9". which will continue to execute until it reaches a debugger stop event. execution resumes in reverse until it reaches a stop event.col_name="state". Currently gdb only really executes asynchronously with remote targets and this interaction is mimicked in other cases. If the ‘--thread-group’ options is specified.reason="breakpoint-hit". state="Child Termination Wait".1 [All-Stop Mode].tasks={nr_rows="3". all threads (in all inferiors) will be resumed. {width="3".col_name="parent-id".alignment="-1".col_name="name". page 68). {width="1".c".id="1".disp="keep". Stop events may include • breakpoints or watchpoints • signals or exceptions • the end of the process (or its beginning under ‘--reverse’) • the end or beginning of a replay log if one is being used.alignment="1".nr_cols="8".alignment="1".fullname="/home/foo/bar/hello. depending on the value of the ‘scheduler-locking’ variable.colhdr=""}.alignment="-1".c".colhdr="ID"}. The ‘--all’ option is ignored in all-stop mode. may resume only one thread. {width="4".14 gdb/mi Program Execution These are the asynchronous commands which generate the out-of-band record ‘*stopped’.bkptno="2".name="main_task"}]} (gdb) 27. body=[{current="*".alignment="1".col_name="priority". Example -exec-continue ^running (gdb) @Hello world *stopped. In all-stop mode (see Section 5. or all threads.colhdr="Pri"}.alignment="1".alignment="2".alignment="1". {width="4".file="hello.Chapter 27: The gdb/mi Interface 363 Example -ada-task-info ^done.col_name="task-id". then all threads in that thread group are resumed.col_name="current". {width="3".args=[].colhdr="TID"}. If the ‘--reverse’ option is specified.colhdr="State"}.task-id=" 644010".priority="48".col_name="thread-id". gdb Command The corresponding gdb corresponding is ‘continue’.

args=[{name="a". and the target stop will be reported after that using the ‘*stopped’ notification.return-value="0" (gdb) The -exec-interrupt Command Synopsis -exec-interrupt [--all|--thread-group N] Interrupts the background execution of the target. Displays the results returned by the function. If the ‘--thread-group’ option is specified.frame={addr="0x000107b0". If the ‘--reverse’ option is specified. only the context thread is interrupted by default. -exec-finish ^running (gdb) *stopped.frame={func="main". The name of the internal gdb variable storing the result is printed. That is.c".364 Debugging with gdb The -exec-finish Command Synopsis -exec-finish [--reverse] Resumes the execution of the inferior program until the current function is exited. first the ‘^done’ response will be printed. an error message will be printed. -exec-finish ^running (gdb) @hello from foo *stopped. Note how the token associated with the stop message is the one for the execution command that has been interrupted.{name="b". Note that when asynchronous execution is enabled. all threads in that group will be interrupted.c". gdb Command The corresponding gdb command is ‘finish’.reason="function-finished". gdb Command The corresponding gdb command is ‘interrupt’. Example Function returning void.value="9"}}. .fullname="/home/foo/bar/recursive2. together with the value itself. The token for the interrupt itself only appears in the ‘^done’ output. If the user is trying to interrupt a non-running program.c".reason="function-finished". file="recursive2. file="hello.line="14"}.fullname="/home/foo/bar/hello.line="7"} (gdb) Function returning other than void.value="1"].args=[]. gdb-result-var="$1". All threads (in all inferiors) will be interrupted if the ‘--all’ option is specified.c". In non-stop mode. resumes the reverse execution of the inferior program until the point where current function was called.func="foo". this command is asynchronous just like other execution commands.

to the source line where the function was called. resumes reverse execution of the inferior program.2 [Specify Location]. fullname="/home/foo/bar/try.file="try. If the ‘--reverse’ option is specified. See Section 9. Example -exec-jump foo. If you issue this command on the first line of a function.msg="mi_cmd_exec_interrupt: Inferior not executing. Example -exec-next .c". stopping when the beginning of the next source line is reached.func="foo".signal-meaning="Interrupt".c:10 *running. for a description of the different forms of location.Chapter 27: The gdb/mi Interface 365 Example (gdb) 111-exec-continue 111^running (gdb) 222-exec-interrupt 222^done (gdb) 111*stopped.line="13"} (gdb) (gdb) -exec-interrupt ^error.c".thread-id="all" ^running The -exec-next Command Synopsis -exec-next [--reverse] Resumes execution of the inferior program. stopping at the beginning of the previous source line.args=[]. page 88. gdb Command The corresponding gdb command is ‘jump’. it will take you back to the caller of that function. frame={addr="0x00010140"." (gdb) The -exec-jump Command Synopsis -exec-jump location Resumes execution of the inferior program at the location specified by parameter.signal-name="SIGINT". gdb Command The corresponding gdb command is ‘next’.

If the program stops at an instruction in the middle of a source line. gdb Command The corresponding gdb command is ‘return’.disp="keep"./. Displays the new current frame. gdb Command The corresponding gdb command is ‘nexti’.line="8"} (gdb) 000-exec-run 000^running (gdb) 000*stopped.bkpt={number="1"./devo/gdb/testsuite/gdb..line="5". . stopping at the previous instruction. If the previously executed instruction was a return from another function. Example (gdb) -exec-next-instruction ^running (gdb) *stopped. it will continue to execute in reverse until the call to that function (from the current stack frame) is reached.file="hello./.mi/basics.c" (gdb) The -exec-return Command Synopsis -exec-return Makes current function return immediately.reason="end-stepping-range". continues until the function returns.reason="end-stepping-range". Example (gdb) 200-break-insert callee4 200^done.reason="breakpoint-hit".366 Debugging with gdb ^running (gdb) *stopped. addr="0x000100d4". file=".c".file="hello.line="8".bkptno="1". resumes reverse execution of the inferior program. If the instruction is a function call. the address will be printed as well.c" (gdb) The -exec-next-instruction Command Synopsis -exec-next-instruction [--reverse] Executes one machine instruction.. Doesn’t execute the inferior..addr="0x00010734". If the ‘--reverse’ option is specified.

line="4"} (gdb) Program exited normally: (gdb) -exec-run ^running (gdb) x = 55 *stopped. If the ‘--thread-group’ option is specified.. fullname="/home/foo/bar/devo/gdb/testsuite/gdb. args=[{name="strarg".c".mi/basics. value="0x11940 \"A string argument.mi/basics. fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics./devo/gdb/testsuite/gdb.file="recursive2.Chapter 27: The gdb/mi Interface 367 frame={func="callee4"./devo/gdb/testsuite/gdb.\""}]..c".c". gdb Command The corresponding gdb command is ‘run’.bkpt={number="1". frame={func="main"./. fullname="/home/foo/bar/recursive2. then all inferiors will be started.args=[]..frame={level="0".file="recursive2.mi/basics. When no option is specified. Examples (gdb) -break-insert main ^done.. The inferior executes until either a breakpoint is encountered or the program exits.c".reason="breakpoint-hit". file=".line="8"} (gdb) 205-break-delete 205^done (gdb) 111-exec-return 111^done./.c"..c"..bkptno="1"./.func="callee3".line="4"} (gdb) -exec-run ^running (gdb) *stopped.disp="keep". file=". it should refer to a thread group of type ‘process’. if the program has exited exceptionally.addr="0x0001072c".reason="exited-normally" (gdb) Program exited exceptionally: (gdb) -exec-run . the current inferior is started.line="18"} (gdb) The -exec-run Command Synopsis -exec-run [--all | --thread-group N] Starts execution of the inferior from the beginning.c". If the ‘--all’ option is specified./. and that thread group will be started. In the latter case the output will include an exit code.args=[].

. stopping at the previously executed instruction.reason="end-stepping-range". stop at the first instruction of the called function. gdb/mi displays this: (gdb) *stopped.args=[{name="a".c" (gdb) The -exec-step-instruction Command Synopsis -exec-step-instruction [--reverse] Resumes the inferior which executes one machine instruction. If it is. resumes reverse execution of the inferior program.c".reason="exited".c". gdb Command The corresponding gdb command is ‘step’.reason="exited-signalled". once gdb has stopped.signal-name="SIGINT".value="10"}. If the ‘--reverse’ option is specified. the address at which the program stopped will be printed as well. will vary depending on whether we have stopped in the middle of a source line or not.line="11"} (gdb) Regular stepping: -exec-step ^running (gdb) *stopped. In the former case. signal-meaning="Interrupt" The -exec-step Command Synopsis -exec-step [--reverse] Resumes execution of the inferior program.value="0"}]. The output.line="14". stopping at the beginning of the previously executed source line. frame={func="foo".reason="end-stepping-range". If the ‘--reverse’ option is specified. if the next source line is not a function call. resumes reverse execution of the inferior program. {name="b". fullname="/home/foo/bar/recursive2.file="recursive2. Example Stepping into a function: -exec-step ^running (gdb) *stopped. stopping when the beginning of the next source line is reached.368 Debugging with gdb ^running (gdb) x = 55 *stopped.file="recursive2. In this case.exit-code="01" (gdb) Another way the program can terminate is if it receives a signal such as SIGINT.

fullname="/home/foo/bar/recursive2.args=[]. Example (gdb) -exec-until recursive2. Example (gdb) -exec-step-instruction ^running (gdb) *stopped. the inferior executes until a source line greater than the current one is reached. .c". file="recursive2.c".c".func="foo".frame={func="main". fullname="/home/foo/bar/try.c".reason="end-stepping-range".c".file="try. frame={addr="0x000100f4".line="10"} (gdb) -exec-step-instruction ^running (gdb) *stopped.line="6"} (gdb) 27. If there is no argument.15 gdb/mi Stack Manipulation Commands The -stack-info-frame Command Synopsis -stack-info-frame Get info on the selected frame. fullname="/home/foo/bar/try.args=[]. gdb Command The corresponding gdb command is ‘until’.reason="end-stepping-range".Chapter 27: The gdb/mi Interface 369 gdb Command The corresponding gdb command is ‘stepi’.c:6 ^running (gdb) x = 55 *stopped.c".line="10"} (gdb) The -exec-until Command Synopsis -exec-until [ location ] Executes the inferior until the location specified in the argument is reached.reason="location-reached". The reason for stopping in this case will be ‘location-reached’.file="try.args=[]. frame={func="foo".

/./devo/gdb/testsuite/gdb. file=". show the single frame at the corresponding level. .line="17"} (gdb) The -stack-info-depth Command Synopsis -stack-info-depth [ max-depth ] Return the depth of the stack. On the other hand. Example For a stack with frame levels 0 through 11: (gdb) -stack-info-depth ^done.depth="12" (gdb) -stack-info-depth ^done. If low-frame and high-frame are not provided.c"...addr="0x0001076c".. If the two arguments are equal. list the arguments for the whole call stack. high-frame may be larger than the actual number of frames.depth="11" (gdb) -stack-info-depth ^done. It is an error if low-frame is larger than the actual number of frames. Example (gdb) -stack-info-frame ^done.mi/basics.depth="12" (gdb) 4 12 11 13 The -stack-list-arguments Command Synopsis -stack-list-arguments print-values [ low-frame high-frame ] Display a list of the arguments for the frames between low-frame and high-frame (inclusive). gdb Command There’s no equivalent gdb command. fullname="/home/foo/bar/devo/gdb/testsuite/gdb./. do not count beyond max-depth frames.depth="12" (gdb) -stack-info-depth ^done.mi/basics.frame={level="1".func="callee3".c".370 Debugging with gdb gdb Command The corresponding gdb command is ‘info frame’ or ‘frame’ (without arguments).depth="4" (gdb) -stack-info-depth ^done. in which case only existing frames will be returned. If the integer argument max-depth is specified.

/./devo/gdb/testsuite/gdb.mi/basics. gdb Command gdb does not have an equivalent command. frame={level="1".args=[]}.mi/basics.args=[ {name="intarg". file=".c".. file="..c"./.mi/basics. Use of this command to obtain arguments in a single frame is deprecated in favor of the ‘-stack-list-variables’ command. stack=[ frame={level="0".c". and if it is 2 or --simple-values.args=[]}] ..c". file=".addr="0x0001076c". frame={level="3".args=[]}...func="main". fullname="/home/foo/bar/devo/gdb/testsuite/gdb.mi/basics.func="callee1".c". frame={level="1"... print only the names of the variables./.name="fltarg"]}. frame={level="2"./.addr="0x000107b4".mi/basics.c". Example (gdb) -stack-list-frames ^done. {frame={level="3".mi/basics. frame={level="1".line="8"}./devo/gdb/testsuite/gdb./. stack-args=[ frame={level="0".mi/basics.5"}]}.addr="0x00010734". file=".line="22"}.\""}]}.mi/basics. and the name and type for arrays.args=[]}] (gdb) -stack-list-arguments 1 ^done.value="0x11940 \"A string argument. {name="strarg".addr="0x0001078c".args=[ {name="intarg".mi/basics. frame={level="2".Chapter 27: The gdb/mi Interface 371 If print-values is 0 or --no-values. {name="fltarg". print also their values.value="3./. print the name..line="32"}] (gdb) -stack-list-arguments 0 ^done.name="strarg"../devo/gdb/testsuite/gdb. frame={level="3".c"./.name="strarg"]}. gdbtk has a ‘gdb_get_args’ command which partially overlaps with the functionality of ‘-stack-list-arguments’. args=[{name="strarg".. file=".args=[name="intarg"./.line="17"}..args=[name="intarg". frame={level="2". fullname="/home/foo/bar/devo/gdb/testsuite/gdb. structures and unions.c".func="callee3". if it is 1 or --all-values. fullname="/home/foo/bar/devo/gdb/testsuite/gdb./. fullname="/home/foo/bar/devo/gdb/testsuite/gdb./.\""}.c".line="27"}./devo/gdb/testsuite/gdb.c"./devo/gdb/testsuite/gdb. frame={level="4". {name="strarg". frame={level="4".addr="0x000107e0". type and value for simple data types. fullname="/home/foo/bar/devo/gdb/testsuite/gdb.func="callee4".\""}]}.value="2"}...value="0x11940 \"A string argument.func="callee2".mi/basics.value="0x11940 \"A string argument.args=[name="strarg"]}.. stack-args=[ frame={level="0".value="2"}.. frame={level="4".

line="14"}.value="0x11940 \"A string argument. the innermost function.addr="0x000107a4".name="strarg"]}] (gdb) -stack-list-arguments 1 2 2 ^done. If invoked without arguments.fullname="/home/foo/bar/recursive2.c".fullname="/home/foo/bar/recursive2.fullname="/home/foo/bar/recursive2. File name of the source file where the function lives. If the two arguments are equal.line="14"}. If given two integer arguments. {name="strarg".c".. Function name. This is only given if the frame’s function is not known.c".stack-args=[frame={level="2".c".addr="0x000107a4".func="foo".fullname="/home/foo/bar/recursive2.c".c". in which case only existing frames will be returned. . For each frame it displays the following info: ‘level’ ‘addr’ ‘func’ ‘file’ ‘fullname’ The full file name of the source file where the function lives.args=[name="intarg". The shared library where this function is defined. Example Full stack backtrace: (gdb) -stack-list-frames ^done.stack= [frame={level="0".addr="0x000107a4". file="recursive2.c". it shows the single frame at the corresponding level. i.value="2"}.372 Debugging with gdb (gdb) -stack-list-arguments 0 2 2 ^done. args=[{name="intarg".c".stack-args=[frame={level="2". gdb Command The corresponding gdb commands are ‘backtrace’ and ‘where’.func="foo". this command prints a backtrace for the whole stack. The frame number.line="11"}. 0 being the topmost frame.\""}]}] (gdb) The -stack-list-frames Command Synopsis -stack-list-frames [ low-frame high-frame ] List the frames currently on the stack.addr="0x0001076c".func="foo". On the other hand. file="recursive2. frame={level="3". it shows the frames whose levels are between the two arguments (inclusive).func="foo". file="recursive2.line="14"}.e. frame={level="2". file="recursive2. ‘line’ ‘from’ Line number corresponding to the $pc. high-frame may be larger than the actual number of frames. The $pc value for that frame. It is an error if low-frame is larger than the actual number of frames. frame={level="1".

c".line="14"}.addr="0x000107a4". structures and unions.addr="0x000107a4".addr="0x00010738". frame={level="5". print the name. print only the names of the variables.func="foo".fullname="/home/foo/bar/recursive2.c".c".func="foo".line="14"}.Chapter 27: The gdb/mi Interface 373 frame={level="4". if it is 1 or --all-values.c".line="14"}. type and value for simple data types.line="14"}.line="14"}.fullname="/home/foo/bar/recursive2. file="recursive2.c".fullname="/home/foo/bar/recursive2.addr="0x000107a4". file="recursive2.c".line="14"}] (gdb) The -stack-list-locals Command Synopsis -stack-list-locals print-values Display the local variable names for the selected frame. frame={level="8". file="recursive2. file="recursive2.fullname="/home/foo/bar/recursive2.c".stack= [frame={level="3".c".func="foo". frame={level="10".addr="0x000107a4".c".c".func="foo".c".line="14"}. This command is deprecated in favor of the ‘-stack-list-variables’ command.addr="0x000107a4".c".func="foo". and if it is 2 or --simple-values.c". file="recursive2.line="14"}. file="recursive2.fullname="/home/foo/bar/recursive2.func="foo".fullname="/home/foo/bar/recursive2.func="foo".c".line="14"}] (gdb) Show a single frame: (gdb) -stack-list-frames 3 3 ^done. and the name and type for arrays.line="4"}] (gdb) Show frames between low frame and high frame: (gdb) -stack-list-frames 3 5 ^done.fullname="/home/foo/bar/recursive2. file="recursive2. file="recursive2.c".addr="0x000107a4".c".c".fullname="/home/foo/bar/recursive2.addr="0x000107a4".addr="0x000107a4".c". If print-values is 0 or --novalues.func="foo".line="14"}.c".stack= [frame={level="3".func="main". frame={level="4".fullname="/home/foo/bar/recursive2. frame={level="11".c". file="recursive2.c". file="recursive2. ‘gdb_get_locals’ in gdbtk.fullname="/home/foo/bar/recursive2. frame={level="7". print also their values. . frame={level="6". a frontend can immediately display the value of simple data types and create variable objects for other data types when the user wishes to explore their values in more detail.addr="0x000107a4". file="recursive2.c".addr="0x000107a4".c". In this last case.line="14"}. frame={level="9".fullname="/home/foo/bar/recursive2. frame={level="5".addr="0x000107a4".func="foo".fullname="/home/foo/bar/recursive2.c".func="foo". gdb Command ‘info locals’ in gdb. file="recursive2.func="foo".

print also their values.{name="B".value="11"}. Unlike some other MI interfaces that work with expressions.locals=[name="A". structures and unions.locals=[{name="A".{name="C". b = 2}"}] (gdb) The -stack-select-frame Command Synopsis -stack-select-frame framenum Change the selected frame. and ‘down-silent’.value="{1. if it is 1 or --allvalues.value="1"}. This command in deprecated in favor of passing the ‘--frame’ option to every command.value="2"}. {name="B". Example (gdb) -stack-list-variables --thread 1 --frame 0 --all-values ^done. 3}"}] -stack-list-locals --simple-values ^done. ‘up-silent’. Select a different frame framenum on the stack. ‘select-frame’.name="B". ‘down’.374 Debugging with gdb Example (gdb) -stack-list-locals 0 ^done.name="C"] (gdb) -stack-list-locals --all-values ^done.variables=[{name="x". Example (gdb) -stack-select-frame 2 ^done (gdb) 27.locals=[{name="A".type="int". 2.value="2"}.type="int". gdb Command The corresponding gdb commands are ‘frame’. variable objects .type="int [3]"}] (gdb) The -stack-list-variables Command Synopsis -stack-list-variables print-values Display the names of local variables and function arguments for the selected frame. If print-values is 0 or --no-values.{name="s".value="1"}. ‘up’.16 gdb/mi Variable Objects Introduction to Variable Objects Variable objects are "object-oriented" MI interface for examining and changing values of expressions.value="{a = 1. and if it is 2 or --simple-values. print the name. print only the names of the variables. {name="C". type and value for simple data types. and the name and type for arrays.

Any variable object that corresponds to a composite type. or it can be an arbitrary complex expression. Consider this example: void do_work(. Such variable objects are never implicitly updated. gdb will read target memory only for leaf variables that frontend has created. Variable objects have hierarchical tree structure. As result. Assignment to a non-leaf variable object is not allowed. or “closed”. String value can be also obtained for a non-leaf variable object. A child variable object can itself have children.) { struct work_state state. recursively. including associating identifiers to specific variables. the expression is parsed when the variable object is created. } If a fixed variable object for the state variable is created in this function. if (. The meaning of expression never changes.. A variable object is identified by string name. After creating a variable object.. As noted above. This considerably reduces the amount of data that must be transferred to the frontend. If an expression specified when creating a fixed variable object refers to a local variable... has a number of child variable objects. Variable objects can be either fixed or floating. no child will be created. When a variable object is created. and we enter the recursive call. which always have built-in types. such as structure in C. the variable object becomes bound to the thread and frame in which the variable object . For a leaf variable object it is possible to obtain its value as a string. a floating variable object will report the value of state in the current frame. Instead. so a frontend might want to disable automatic update for the variables that are either not visible on the screen. For another example. and never update it. the frontend specifies the expression for that variable object. For example.. the frontend can invoke other variable object operations—for example to obtain or change the value of a variable object. For the fixed variable object. so if a frontend is not interested in the children of a particular variable object. The expression can be a simple variable. This is possible using so called “frozen variable objects”. Child variable objects are created only by explicit request.) do_work(.). fetching memory is relatively slow for embedded targets. or to change display format. and only leaf variable objects have a real value. children variable objects are created on demand. Recursion ends when we reach leaf variable objects.Chapter 27: The gdb/mi Interface 375 are specifically designed for simple and efficient presentation in the frontend. but it’s generally a string that only indicates the type of the object.. and does not list its contents. a frontend might want to keep a value of some expression for future reference. A frontend does not need to read the values of all variable objects each time the program stops. and can even involve CPU registers. MI provides an update command that lists all variable objects whose values has changed since the last update operation. for example corresponding to each element of a structure. For a floating variable object the values of variables whose names appear in the expressions are re-evaluated every time in the context of the current frame. On the other hand. The automatic update is not always desirable. or set the value from a string. the variable object will report the value of state in the top-level do_work invocation.

The -var-create Command Synopsis -var-create {name | "-"} {frame-addr | "*" | "@"} expression . This feature is currently (as of gdb 7. this command will still succeed (and do nothing). Once enabled. because there was no way to implement this in a fully backwardcompatible way. this feature cannot be disabled. Note that if Python support has not been compiled into gdb.0) experimental. and re-evaluates the variable object in context of that thread/frame.376 Debugging with gdb is created. -enable-pretty-printing -var-create -var-delete -var-set-format -var-show-format -var-info-num-children -var-list-children -var-info-type -var-info-expression Description And Use of Operations on Variable Objects The -enable-pretty-printing Command -enable-pretty-printing gdb allows Python-based visualizers to affect the output of the MI variable object commands. However. gdb makes sure that the thread/frame combination the variable object is bound to still exists. When such variable object is updated. and may work differently in future versions of gdb. a front end must request that this functionality be enabled. The following is the complete set of gdb/mi operations defined to access this functionality: Operation Description enable Python-based pretty-printing create a variable object delete the variable object and/or its children set the display format of this variable show the display format of this variable tells how many children this object has return a list of the object’s children show the type of this variable object print parent-relative expression that this variable object represents -var-info-path-expression print full expression that this variable object represents -var-show-attributes is this variable editable? does it exist here? -var-evaluate-expression get the value of this variable -var-assign set the value of this variable -var-update update the variable and its children -var-set-frozen set frozeness attribute -var-set-update-range set range of children to display on update In the next subsection we describe each operation in detail and suggest how it can be used.

‘thread-id’ If a variable object is bound to a specific thread. A ‘@’ indicates that a floating variable object must be created. A ‘*’ indicates that the current frame should be used. The command fails if a duplicate name is found. Dynamic varobjs have slightly different semantics in some cases. a memory cell or a CPU register.2. then this attribute will not be present. The frame under which the expression should be evaluated can be specified by frameaddr. ‘has_more’ For a dynamic varobj. as would be printed by the gdb CLI. These are: ‘name’ ‘numchild’ The number of children of the varobj. This number is not necessarily reliable for a dynamic varobj. If ‘-’ is specified. The name parameter is the string by which the object can be referenced. This ensures backward compatibility for existing clients. you must examine the ‘has_more’ attribute. where addr is the address of a memory cell • ‘*addr-addr’ — a memory address range (TBD) • ‘$regname’ — a CPU register name A varobj’s contents may be provided by a Python-based pretty-printer. expression is any expression valid on the current language set (must not begin with a ‘*’). The name of the varobj.Chapter 27: The gdb/mi Interface 377 This operation creates a variable object. . For a non-dynamic varobj.. ‘value’ ‘type’ The varobj’s scalar value.2. the varobj system will generate a string “varNNNNNN” automatically. For a varobj whose type is some sort of aggregate (e. or one of the following: • ‘*addr’. ‘dynamic’ This attribute will be present and have the value ‘1’ if the varobj is a dynamic varobj. page 294. The varobj’s type.5 [Pretty Printing API]. This is a string representation of the type. The value comes directly from the Python pretty-printer object’s display_hint method. In this case the varobj is known as a dynamic varobj. or for a dynamic varobj.g. the result of an expression. which allows the monitoring of a variable. It will be unique provided that one does not specify name of that format. Instead. It must be unique. then gdb will never create a dynamic varobj. then this is the thread’s identifier. If the -enable-pretty-printing command is not sent. Result This operation returns attributes of the newly-created varobj. ‘displayhint’ A dynamic varobj can supply a display hint to the front end. a struct). this indicates whether there appear to be any children available. See Section 23. this will be 0. If the varobj is not a dynamic varobj. this value will not be interesting.

has_more="has_more" The -var-delete Command Synopsis -var-delete [ -c ] name Deletes a previously created variable object and all of its children.378 Debugging with gdb Typical output will look like this: name="name". the format is set only on the variable itself.numchild="N". format → format-spec The -var-info-num-children Command Synopsis -var-info-num-children name Returns the number of children of a variable object name: numchild=n Note that this number is not completely reliable for a dynamic varobj.thread-id="M".). and the children are not affected. hex for pointers. Returns an error if the object name is not found. The syntax for the format-spec is as follows: format-spec → {binary | decimal | hexadecimal | octal | natural} The natural format is the default format choosen automatically based on the variable type (like decimal for an int. With the ‘-c’ option. For a variable with children. just deletes the children. The -var-set-format Command Synopsis -var-set-format name format-spec Sets the output format for the value of the object name to be format-spec. but more children may be available.type="type". The -var-list-children Command . etc. The -var-show-format Command Synopsis -var-show-format name Returns the format used to display the value of the object name. It will return the current number of children.

Otherwise. indicate the range of children to report. For example this may be the name of a structure member. For a dynamic varobj.5 [Pretty Printing API]. this is the thread id.2. it will only affect the current call to -var-list-children. also print their values. this will be 0. numchild type value thread-id frozen Number of children this child has. The value comes directly from the Python pretty-printer object’s display_hint method. the range is reset and all children will be reported. for example. In this case the type and value are not present. With a single argument or if print-values has a value of 0 or --no-values. if specified. this value cannot be used to form an expression. scrolling a view may cause the front end to request more children with -var-list-children. from and to. For this. print only the names of the variables. The result may have its own attributes: ‘displayhint’ A dynamic varobj can supply a display hint to the front end. children starting at from (zero-based) and up to and excluding to will be reported. If from or to is less than zero. regardless of the language. For C/C++ structures there are several pseudo children returned to designate access qualifiers. and then the front end could call -var-set-updaterange with a different range to ensure that future updates are restricted to just the visible items. A dynamic varobj will not report the access qualifying pseudo-children. For these pseudo children exp is ‘public’. The type of the child. If values were requested. See Section 23. For each child the following results are returned: name exp Name of the variable object created for this child. if they do not already exist. if print-values is 1 or --all-values. but not future calls to -var-update. page 294. ‘private’.Chapter 27: The gdb/mi Interface 379 Synopsis -var-list-children [print-values] name [from to] Return a list of the children of the specified variable object and create variable objects for them.2. For a dynamic varobj. There is no way to do this at all with a dynamic varobj. The intent of this approach is to enable a front end to implement any update approach it likes. and if it is 2 or --simple-values print the name and value for simple data types and just the name for arrays. this variable will be present with a value of 1. or ‘protected’. . you must instead use -var-set-updaterange. If the variable object is frozen. Otherwise this result is not present. This information is not available at all with a dynamic varobj. this is the value. The expression to be shown to the user by the front end to designate this child. If a child range is requested. If this variable object is associated with a thread. structures and unions.

and cannot be evaluated.type=type}. .1 ^done.value=value. The type is returned as a string in the same format as it is output by the gdb CLI: type=typename The -var-info-expression Command Synopsis -var-info-expression name Returns a string that is suitable for presenting this variable object in user interface.children=[child={name=name.children=[child={name=name.exp="1" Here. numchild=n. numchild=n.(repeats N times)] (gdb) -var-list-children --all-values n ^done.numchild=n.(repeats N times)] The -var-info-type Command Synopsis -var-info-type name Returns the type of the specified variable name.lang="C". so the -var-info-expression command is of limited use. which result can be used only for UI presentation. This command is currently not valid for children of a dynamic varobj. if a is an array. Compare this with the -var-info-expression command.exp=exp. and variable object A was created for a. The -var-info-path-expression Command Synopsis -var-info-path-expression name Returns an expression that can be evaluated in the current context and will yield the same value that a variable object has.exp=exp.380 Debugging with gdb ‘has_more’ This is an integer attribute which is nonzero if there are children remaining after the end of the selected range.type=type}. Typical use of the -varinfo-path-expression command is creating a watchpoint from a variable object. Example (gdb) -var-list-children n ^done. For example. and will give an error when invoked on one. the values of lang can be {"C" | "C++" | "Java"}. then we’ll get this output: (gdb) -var-info-expression A. The string is generally not valid expression in the current language. Note that the output of the -var-list-children command also includes those expressions.numchild=n.

attr )* ] where attr is { { editable | noneditable } | TBD }. we’ll get this output: (gdb) -var-info-path-expression C.m_size) The -var-show-attributes Command Synopsis -var-show-attributes name List attributes of the specified variable object name: status=attr [ ( . The -var-assign Command Synopsis -var-assign name expression Assigns the value of expression to the variable object specified by name. The -var-evaluate-expression Command Synopsis -var-evaluate-expression [-f format-spec] name Evaluates the expression that is represented by the specified variable object and returns its value as a string.Chapter 27: The gdb/mi Interface 381 For example. the variable will show up in any subsequent -var-update list. derived from class Base. The current display format can be changed using the -var-set-format command.path_expr=((Base)c).changelist=[{name="var1". Example (gdb) -var-assign var1 3 ^done.type_changed="false"}] (gdb) The -var-update Command .m_size ^done.in_scope="true". value=value Note that one must invoke -var-list-children for a variable before the value of a child variable can be evaluated.Base. Then. suppose C is a C++ class. The format of the string can be specified with the ‘-f’ option. the current display format will be used.value="3" (gdb) -var-update * ^done. The possible values of this option are the same as for -var-set-format (see [-var-set-format]. Assume a variable c is has the type of C and a variable object C was created for variable c. If the variable’s value is altered by the assign. and that the Base class has a member called m_size. The object must be ‘editable’. If the ‘-f’ option is not specified.public. page 378).

382

Debugging with gdb

Synopsis
-var-update [print-values] {name | "*"}

Reevaluate the expressions corresponding to the variable object name and all its direct and indirect children, and return the list of variable objects whose values have changed; name must be a root variable object. Here, “changed” means that the result of -varevaluate-expression before and after the -var-update is different. If ‘*’ is used as the variable object names, all existing variable objects are updated, except for frozen ones (see [-var-set-frozen], page 383). The option print-values determines whether both names and values, or just names are printed. The possible values of this option are the same as for -var-list-children (see [-var-list-children], page 379). It is recommended to use the ‘--all-values’ option, to reduce the number of MI commands needed on each program stop. With the ‘*’ parameter, if a variable object is bound to a currently running thread, it will not be updated, without any diagnostic. If -var-set-update-range was previously used on a varobj, then only the selected range of children will be reported. -var-update reports all the changed varobjs in a tuple named ‘changelist’. Each item in the change list is itself a tuple holding: ‘name’ ‘value’ ‘in_scope’ This field is a string which may take one of three values: "true" "false" The variable object’s current value is valid. The variable object does not currently hold a valid value but it may hold one in the future if its associated expression comes back into scope. The variable object no longer holds a valid value. This can occur when the executable file being debugged has changed, either through recompilation or by using the gdb file command. The front end should normally choose to delete these variable objects. In the future new values may be added to this list so the front should be prepared for this possibility. See Section 27.6 [GDB/MI Development and Front Ends], page 343. ‘type_changed’ This is only present if the varobj is still valid. If the type changed, then this will be the string ‘true’; otherwise it will be ‘false’. ‘new_type’ If the varobj’s type changed, then this field will be present and will hold the new type. The name of the varobj. If values were requested for this update, then this field will be present and will hold the value of the varobj.

"invalid"

Chapter 27: The gdb/mi Interface

383

‘new_num_children’ For a dynamic varobj, if the number of children changed, or if the type changed, this will be the new number of children. The ‘numchild’ field in other varobj responses is generally not valid for a dynamic varobj – it will show the number of children that gdb knows about, but because dynamic varobjs lazily instantiate their children, this will not reflect the number of children which may be available. The ‘new_num_children’ attribute only reports changes to the number of children known by gdb. This is the only way to detect whether an update has removed children (which necessarily can only happen at the end of the update range). ‘displayhint’ The display hint, if any. ‘has_more’ This is an integer value, which will be 1 if there are more children available outside the varobj’s update range. ‘dynamic’ This attribute will be present and have the value ‘1’ if the varobj is a dynamic varobj. If the varobj is not a dynamic varobj, then this attribute will not be present.

‘new_children’ If new children were added to a dynamic varobj within the selected update range (as set by -var-set-update-range), then they will be listed in this attribute.

Example
(gdb) -var-assign var1 3 ^done,value="3" (gdb) -var-update --all-values var1 ^done,changelist=[{name="var1",value="3",in_scope="true", type_changed="false"}] (gdb)

The -var-set-frozen Command Synopsis
-var-set-frozen name flag

Set the frozenness flag on the variable object name. The flag parameter should be either ‘1’ to make the variable frozen or ‘0’ to make it unfrozen. If a variable object is frozen, then neither itself, nor any of its children, are implicitly updated by -var-update of a parent variable or by -var-update *. Only -var-update of the variable itself will update its value and values of its children. After a variable object is unfrozen, it is implicitly updated by all subsequent -var-update operations. Unfreezing a variable does not update it, only subsequent -var-update does.

384

Debugging with gdb

Example
(gdb) -var-set-frozen V 1 ^done (gdb)

The -var-set-update-range command Synopsis
-var-set-update-range name from to

Set the range of children to be returned by future invocations of -var-update. from and to indicate the range of children to report. If from or to is less than zero, the range is reset and all children will be reported. Otherwise, children starting at from (zero-based) and up to and excluding to will be reported.

Example
(gdb) -var-set-update-range V 1 2 ^done

The -var-set-visualizer command Synopsis
-var-set-visualizer name visualizer

Set a visualizer for the variable object name. visualizer is the visualizer to use. The special value ‘None’ means to disable any visualizer in use. If not ‘None’, visualizer must be a Python expression. This expression must evaluate to a callable object which accepts a single argument. gdb will call this object with the value of the varobj name as an argument (this is done so that the same Python pretty-printing code can be used for both the CLI and MI). When called, this object must return an object which conforms to the pretty-printing interface (see Section 23.2.2.5 [Pretty Printing API], page 294). The pre-defined function gdb.default_visualizer may be used to select a visualizer by following the built-in process (see Section 23.2.2.6 [Selecting Pretty-Printers], page 295). This is done automatically when a varobj is created, and so ordinarily is not needed. This feature is only available if Python support is enabled. The MI command -listfeatures (see Section 27.23 [GDB/MI Miscellaneous Commands], page 403) can be used to check this.

Example
Resetting the visualizer:
(gdb) -var-set-visualizer V None ^done

Reselecting the default (type-based) visualizer:

Chapter 27: The gdb/mi Interface

385

(gdb) -var-set-visualizer V gdb.default_visualizer ^done

Suppose SomeClass is a visualizer class. A lambda expression can be used to instantiate this class for a varobj:
(gdb) -var-set-visualizer V "lambda val: SomeClass()" ^done

27.17 gdb/mi Data Manipulation
This section describes the gdb/mi commands that manipulate data: examine memory and registers, evaluate expressions, etc.

The -data-disassemble Command Synopsis
-data-disassemble [ -s start-addr -e end-addr ] | [ -f filename -l linenum [ -n lines ] ] -- mode

Where: ‘start-addr’ is the beginning address (or $pc) ‘end-addr’ is the end address ‘filename’ is the name of the file to disassemble ‘linenum’ ‘lines’ is the line number to disassemble around is the number of disassembly lines to be produced. If it is -1, the whole function will be disassembled, in case no end-addr is specified. If end-addr is specified as a non-zero value, and lines is lower than the number of disassembly lines between start-addr and end-addr, only lines lines are displayed; if lines is higher than the number of lines between start-addr and end-addr, only the lines up to end-addr are displayed. is either 0 (meaning only disassembly), 1 (meaning mixed source and disassembly), 2 (meaning disassembly with raw opcodes), or 3 (meaning mixed source and disassembly with raw opcodes).

‘mode’

Result
The output for each instruction is composed of four fields: • Address • Func-name • Offset • Instruction

386

Debugging with gdb

Note that whatever included in the instruction field, is not manipulated directly by gdb/mi, i.e., it is not possible to adjust its format.

gdb Command
There’s no direct mapping from this command to the CLI.

Example
Disassemble from the current value of $pc to $pc + 20:
(gdb) -data-disassemble -s $pc -e "$pc + 20" -- 0 ^done, asm_insns=[ {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}, {address="0x000107c8",func-name="main",offset="12", inst="or %o2, 0x140, %o1\t! 0x11940 <_lib_version+8>"}, {address="0x000107cc",func-name="main",offset="16", inst="sethi %hi(0x11800), %o2"}, {address="0x000107d0",func-name="main",offset="20", inst="or %o2, 0x168, %o4\t! 0x11968 <_lib_version+48>"}] (gdb)

Disassemble the whole main function. Line 32 is part of main.
-data-disassemble -f basics.c -l 32 -- 0 ^done,asm_insns=[ {address="0x000107bc",func-name="main",offset="0", inst="save %sp, -112, %sp"}, {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}, [...] {address="0x0001081c",func-name="main",offset="96",inst="ret "}, {address="0x00010820",func-name="main",offset="100",inst="restore "}] (gdb)

Disassemble 3 instructions from the start of main:
(gdb) -data-disassemble -f basics.c -l 32 -n 3 -- 0 ^done,asm_insns=[ {address="0x000107bc",func-name="main",offset="0", inst="save %sp, -112, %sp"}, {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}] (gdb)

Disassemble 3 instructions from the start of main in mixed mode:
(gdb) -data-disassemble -f basics.c -l 32 -n 3 -- 1 ^done,asm_insns=[ src_and_asm_line={line="31", file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ testsuite/gdb.mi/basics.c",line_asm_insn=[

Chapter 27: The gdb/mi Interface

387

{address="0x000107bc",func-name="main",offset="0", inst="save %sp, -112, %sp"}]}, src_and_asm_line={line="32", file="/kwikemart/marge/ezannoni/flathead-dev/devo/gdb/ \ testsuite/gdb.mi/basics.c",line_asm_insn=[ {address="0x000107c0",func-name="main",offset="4", inst="mov 2, %o0"}, {address="0x000107c4",func-name="main",offset="8", inst="sethi %hi(0x11800), %o2"}]}] (gdb)

The -data-evaluate-expression Command Synopsis
-data-evaluate-expression expr

Evaluate expr as an expression. The expression could contain an inferior function call. The function call will execute synchronously. If the expression contains spaces, it must be enclosed in double quotes.

gdb Command
The corresponding gdb commands are ‘print’, ‘output’, and ‘call’. In gdbtk only, there’s a corresponding ‘gdb_eval’ command.

Example
In the following example, the numbers that precede the commands are the tokens described in Section 27.4 [gdb/mi Command Syntax], page 340. Notice how gdb/mi returns the same tokens in its output.
211-data-evaluate-expression 211^done,value="1" (gdb) 311-data-evaluate-expression 311^done,value="0xefffeb7c" (gdb) 411-data-evaluate-expression 411^done,value="4" (gdb) 511-data-evaluate-expression 511^done,value="4" (gdb) A

&A

A+3

"A + 3"

The -data-list-changed-registers Command Synopsis
-data-list-changed-registers

Display a list of the registers that have changed.

gdb Command
gdb doesn’t have a direct analog for this command; gdbtk has the corresponding command ‘gdb_changed_register_list’.

388

Debugging with gdb

Example
On a PPC MBX board:
(gdb) -exec-continue ^running (gdb) *stopped,reason="breakpoint-hit",disp="keep",bkptno="1",frame={ func="main",args=[],file="try.c",fullname="/home/foo/bar/try.c", line="5"} (gdb) -data-list-changed-registers ^done,changed-registers=["0","1","2","4","5","6","7","8","9", "10","11","13","14","15","16","17","18","19","20","21","22","23", "24","25","26","27","28","30","31","64","65","66","67","69"] (gdb)

The -data-list-register-names Command Synopsis
-data-list-register-names [ ( regno )+ ]

Show a list of register names for the current target. If no arguments are given, it shows a list of the names of all the registers. If integer numbers are given as arguments, it will print a list of the names of the registers corresponding to the arguments. To ensure consistency between a register name and its number, the output list may include empty register names.

gdb Command
gdb does not have a command which corresponds to ‘-data-list-register-names’. In gdbtk there is a corresponding command ‘gdb_regnames’.

Example
For the PPC MBX board:
(gdb) -data-list-register-names ^done,register-names=["r0","r1","r2","r3","r4","r5","r6","r7", "r8","r9","r10","r11","r12","r13","r14","r15","r16","r17","r18", "r19","r20","r21","r22","r23","r24","r25","r26","r27","r28","r29", "r30","r31","f0","f1","f2","f3","f4","f5","f6","f7","f8","f9", "f10","f11","f12","f13","f14","f15","f16","f17","f18","f19","f20", "f21","f22","f23","f24","f25","f26","f27","f28","f29","f30","f31", "", "pc","ps","cr","lr","ctr","xer"] (gdb) -data-list-register-names 1 2 3 ^done,register-names=["r1","r2","r3"] (gdb)

The -data-list-register-values Command Synopsis
-data-list-register-values fmt [ ( regno )*]

Display the registers’ contents. fmt is the format according to which the registers’ contents are to be returned, followed by an optional list of numbers specifying the registers

Chapter 27: The gdb/mi Interface

389

to display. A missing list of numbers indicates that the contents of all the registers must be returned. Allowed formats for fmt are: x o t d r N Hexadecimal Octal Binary Decimal Raw Natural

gdb Command
The corresponding gdb commands are ‘info reg’, ‘info all-reg’, and (in gdbtk) ‘gdb_fetch_registers’.

Example
For a PPC MBX board (note: line breaks are for readability only, they don’t appear in the actual output):
(gdb) -data-list-register-values r 64 65 ^done,register-values=[{number="64",value="0xfe00a300"}, {number="65",value="0x00029002"}] (gdb) -data-list-register-values x ^done,register-values=[{number="0",value="0xfe0043c8"}, {number="1",value="0x3fff88"},{number="2",value="0xfffffffe"}, {number="3",value="0x0"},{number="4",value="0xa"}, {number="5",value="0x3fff68"},{number="6",value="0x3fff58"}, {number="7",value="0xfe011e98"},{number="8",value="0x2"}, {number="9",value="0xfa202820"},{number="10",value="0xfa202808"}, {number="11",value="0x1"},{number="12",value="0x0"}, {number="13",value="0x4544"},{number="14",value="0xffdfffff"}, {number="15",value="0xffffffff"},{number="16",value="0xfffffeff"}, {number="17",value="0xefffffed"},{number="18",value="0xfffffffe"}, {number="19",value="0xffffffff"},{number="20",value="0xffffffff"}, {number="21",value="0xffffffff"},{number="22",value="0xfffffff7"}, {number="23",value="0xffffffff"},{number="24",value="0xffffffff"}, {number="25",value="0xffffffff"},{number="26",value="0xfffffffb"}, {number="27",value="0xffffffff"},{number="28",value="0xf7bfffff"}, {number="29",value="0x0"},{number="30",value="0xfe010000"}, {number="31",value="0x0"},{number="32",value="0x0"}, {number="33",value="0x0"},{number="34",value="0x0"}, {number="35",value="0x0"},{number="36",value="0x0"}, {number="37",value="0x0"},{number="38",value="0x0"}, {number="39",value="0x0"},{number="40",value="0x0"}, {number="41",value="0x0"},{number="42",value="0x0"}, {number="43",value="0x0"},{number="44",value="0x0"}, {number="45",value="0x0"},{number="46",value="0x0"}, {number="47",value="0x0"},{number="48",value="0x0"}, {number="49",value="0x0"},{number="50",value="0x0"}, {number="51",value="0x0"},{number="52",value="0x0"},

390

Debugging with gdb

{number="53",value="0x0"},{number="54",value="0x0"}, {number="55",value="0x0"},{number="56",value="0x0"}, {number="57",value="0x0"},{number="58",value="0x0"}, {number="59",value="0x0"},{number="60",value="0x0"}, {number="61",value="0x0"},{number="62",value="0x0"}, {number="63",value="0x0"},{number="64",value="0xfe00a300"}, {number="65",value="0x29002"},{number="66",value="0x202f04b5"}, {number="67",value="0xfe0043b0"},{number="68",value="0xfe00b3e4"}, {number="69",value="0x20002b03"}] (gdb)

The -data-read-memory Command
This command is deprecated, use -data-read-memory-bytes instead.

Synopsis
-data-read-memory [ -o byte-offset ] address word-format word-size nr-rows nr-cols [ aschar ]

where: ‘address’ An expression specifying the address of the first memory word to be read. Complex expressions containing embedded white space should be quoted using the C convention.

‘word-format’ The format to be used to print the memory words. The notation is the same as for gdb’s print command (see Section 10.5 [Output Formats], page 102). ‘word-size’ The size of each memory word in bytes. ‘nr-rows’ ‘nr-cols’ ‘aschar’ The number of rows in the output table. The number of columns in the output table. If present, indicates that each row should include an ascii dump. The value of aschar is used as a padding character when a byte is not a member of the printable ascii character set (printable ascii characters are those whose code is between 32 and 126, inclusively).

‘byte-offset’ An offset to add to the address before fetching memory. This command displays memory contents as a table of nr-rows by nr-cols words, each word being word-size bytes. In total, nr-rows * nr-cols * word-size bytes are read (returned as ‘total-bytes’). Should less than the requested number of bytes be returned by the target, the missing words are identified using ‘N/A’. The number of bytes read from the target is returned in ‘nr-bytes’ and the starting address used to read memory in ‘addr’. The address of the next/previous row or page is available in ‘next-row’ and ‘prev-row’, ‘next-page’ and ‘prev-page’.

gdb Command
The corresponding gdb command is ‘x’. gdbtk has ‘gdb_get_mem’ memory read command.

Chapter 27: The gdb/mi Interface

391

Example
Read six bytes of memory starting at bytes+6 but then offset by -6 bytes. Format as three rows of two columns. One byte per word. Display each word in hex.
(gdb) 9-data-read-memory -o -6 -- bytes+6 x 1 3 2 9^done,addr="0x00001390",nr-bytes="6",total-bytes="6", next-row="0x00001396",prev-row="0x0000138e",next-page="0x00001396", prev-page="0x0000138a",memory=[ {addr="0x00001390",data=["0x00","0x01"]}, {addr="0x00001392",data=["0x02","0x03"]}, {addr="0x00001394",data=["0x04","0x05"]}] (gdb)

Read two bytes of memory starting at address shorts + 64 and display as a single word formatted in decimal.
(gdb) 5-data-read-memory shorts+64 d 2 1 1 5^done,addr="0x00001510",nr-bytes="2",total-bytes="2", next-row="0x00001512",prev-row="0x0000150e", next-page="0x00001512",prev-page="0x0000150e",memory=[ {addr="0x00001510",data=["128"]}] (gdb)

Read thirty two bytes of memory starting at bytes+16 and format as eight rows of four columns. Include a string encoding with ‘x’ used as the non-printable character.
(gdb) 4-data-read-memory bytes+16 x 1 8 4 x 4^done,addr="0x000013a0",nr-bytes="32",total-bytes="32", next-row="0x000013c0",prev-row="0x0000139c", next-page="0x000013c0",prev-page="0x00001380",memory=[ {addr="0x000013a0",data=["0x10","0x11","0x12","0x13"],ascii="xxxx"}, {addr="0x000013a4",data=["0x14","0x15","0x16","0x17"],ascii="xxxx"}, {addr="0x000013a8",data=["0x18","0x19","0x1a","0x1b"],ascii="xxxx"}, {addr="0x000013ac",data=["0x1c","0x1d","0x1e","0x1f"],ascii="xxxx"}, {addr="0x000013b0",data=["0x20","0x21","0x22","0x23"],ascii=" !\"#"}, {addr="0x000013b4",data=["0x24","0x25","0x26","0x27"],ascii="$%&’"}, {addr="0x000013b8",data=["0x28","0x29","0x2a","0x2b"],ascii="()*+"}, {addr="0x000013bc",data=["0x2c","0x2d","0x2e","0x2f"],ascii=",-./"}] (gdb)

The -data-read-memory-bytes Command Synopsis
-data-read-memory-bytes [ -o byte-offset ] address count

where: ‘address’ An expression specifying the address of the first memory word to be read. Complex expressions containing embedded white space should be quoted using the C convention. The number of bytes to read. This should be an integer literal.

‘count’

392

Debugging with gdb

‘byte-offset’ The offsets in bytes relative to address at which to start reading. This should be an integer literal. This option is provided so that a frontend is not required to first evaluate address and then perform address arithmetics itself. This command attempts to read all accessible memory regions in the specified range. First, all regions marked as unreadable in the memory map (if one is defined) will be skipped. See Section 10.16 [Memory Region Attributes], page 122. Second, gdb will attempt to read the remaining regions. For each one, if reading full region results in an errors, gdb will try to read a subset of the region. In general, every single byte in the region may be readable or not, and the only way to read every readable byte is to try a read at every address, which is not practical. Therefore, gdb will attempt to read all accessible bytes at either beginning or the end of the region, using a binary division scheme. This heuristic works well for reading accross a memory map boundary. Note that if a region has a readable range that is neither at the beginning or the end, gdb will not read it. The result record (see Section 27.7.1 [GDB/MI Result Records], page 343) that is output of the command includes a field named ‘memory’ whose content is a list of tuples. Each tuple represent a successfully read memory block and has the following fields: begin end offset contents The start address of the memory block, as hexadecimal literal. The end address of the memory block, as hexadecimal literal. The offset of the memory block, as hexadecimal literal, relative to the start address passed to -data-read-memory-bytes. The contents of the memory block, in hex.

gdb Command
The corresponding gdb command is ‘x’.

Example
(gdb) -data-read-memory-bytes &a 10 ^done,memory=[{begin="0xbffff154",offset="0x00000000", end="0xbffff15e", contents="01000000020000000300"}] (gdb)

The -data-write-memory-bytes Command Synopsis
-data-write-memory-bytes address contents

where: ‘address’ An expression specifying the address of the first memory word to be read. Complex expressions containing embedded white space should be quoted using the C convention. The hex-encoded bytes to write.

‘contents’

Chapter 27: The gdb/mi Interface

393

gdb Command
There’s no corresponding gdb command.

Example
(gdb) -data-write-memory-bytes &a "aabbccdd" ^done (gdb)

27.18 gdb/mi Tracepoint Commands
The commands defined in this section implement MI support for tracepoints. For detailed introduction, see Chapter 13 [Tracepoints], page 139.

The -trace-find Command Synopsis
-trace-find mode [parameters...]

Find a trace frame using criteria defined by mode and parameters. The following table lists permissible modes and their parameters. For details of operation, see Section 13.2.1 [tfind], page 150. ‘none’ No parameters are required. Stops examining trace frames.

‘frame-number’ An integer is required as parameter. Selects tracepoint frame with that index. ‘tracepoint-number’ An integer is required as parameter. Finds next trace frame that corresponds to tracepoint with the specified number. ‘pc’ An address is required as parameter. Finds next trace frame that corresponds to any tracepoint at the specified address.

‘pc-inside-range’ Two addresses are required as parameters. Finds next trace frame that corresponds to a tracepoint at an address inside the specified range. Both bounds are considered to be inside the range. ‘pc-outside-range’ Two addresses are required as parameters. Finds next trace frame that corresponds to a tracepoint at an address outside the specified range. Both bounds are considered to be inside the range. ‘line’ Line specification is required as parameter. See Section 9.2 [Specify Location], page 88. Finds next trace frame that corresponds to a tracepoint at the specified location.

If ‘none’ was passed as mode, the response does not have fields. Otherwise, the response may have the following fields: ‘found’ This field has either ‘0’ or ‘1’ as the value, depending on whether a matching tracepoint was found.

‘tracepoint’ The index of the found tracepoint. This field is present only if a trace frame was found.alignment="-1". The initial value. Example (gdb) -trace-list-variables ^done. gdb Command The corresponding gdb command is ‘tvariable’. This field is absent iff current value is not defined. or is presently running. The value the trace variable has at the moment. . -trace-list-variables Synopsis -trace-list-variables Return a table of all defined trace variables.colhdr="Initial"}. Each element of the table has the following fields: ‘name’ ‘initial’ ‘current’ The name of the trace variable. hdr=[{width="15". If value is specified. ‘frame’ The information about the frame corresponding to the found trace frame.col_name="initial".4 [GDB/MI Frame Information].nr_cols="3". {width="11". -trace-define-variable Synopsis -trace-define-variable name [ value ] Create trace variable name if it does not exist. for example if the trace was never run. page 346. This is a 64-bit signed integer. This field is always present. gdb Command The corresponding gdb command is ‘tvariables’. This field is present iff the ‘found’ field has value of ‘1’.7.colhdr="Name"}.394 Debugging with gdb ‘traceframe’ The index of the found traceframe. See Section 27. This field is always present. for description of this field. sets the initial value of the specified trace variable to that value.col_name="name".alignment="-1".trace-variables={nr_rows="1". Note that the name should start with the ‘$’ character. This is a 64-bit signed integer. This field is present iff the ‘found’ field has value of ‘1’. gdb Command The corresponding gdb command is ‘tfind’.

when no tracing operations are supported. The value of ‘passcount’ means tracing was stopped when a tracepoint was passed a maximal number of times for that tracepoint. This field is always present. The result of this command does not have any fields. -trace-status Synopsis -trace-status Obtains the status of a tracing experiment. Without the ‘-r’ option. This field may be absent iff tracing was never stopped on target yet. The value of ‘overflow’ means the tracing buffer is full. when all tracing operations are supported. the data is downloaded from the target and saved in a local file. This field is present if ‘supported’ field is not ‘0’. This field is present if ‘supported’ field is not ‘0’.colhdr="Current"}]. ‘running’ May have a value of either ‘0’ or ‘1’ depending on whether tracing experiement is in progress on target.current="15"}]} (gdb) -trace-save Synopsis -trace-save [-r ] filename Saves the collected trace data to filename. ‘stop-reason’ Report the reason why the tracing was stopped last time.Chapter 27: The gdb/mi Interface 395 {width="11".initial="0"} variable={name="$foo". . ‘1’. gdb Command The corresponding gdb command is ‘tsave’. With the ‘-r’ option the target is asked to perform the save.col_name="current". -trace-start Synopsis -trace-start Starts a tracing experiments. gdb Command The corresponding gdb command is ‘tstart’. The value of ‘request’ means the tracing was stopped as result of the -trace-stop command.alignment="-1".initial="10". body=[variable={name="$trace_timestamp". The value of ‘disconnection’ means tracing was automatically stopped when gdb has disconnected. examining of trace frame is possible but new tracing experiement cannot be started. or ‘file’ when examining trace file. In the latter case. The result may include the following fields: ‘supported’ May have a value of either ‘0’.

‘disconnected’ The value of the disconnected tracing flag. including ones that were discarded. gdb Command There is no corresponding gdb command. while ‘frames-created’ is the total created during the run. ‘frames’ ‘frames-created’ The ‘frames’ field is a count of the total number of trace frames in the trace buffer. gdb Command The corresponding gdb command is ‘tstop’. such as when a circular trace buffer filled up. These fields are optional. 1 means that the trace buffer is circular and old trace frames will be discarded if necessary to make room. -trace-stop Synopsis -trace-stop Stops a tracing experiment. This field is present iff the ‘stop-reason’ field has the value of ‘passcount’. 27. gdb Command The corresponding gdb command is ‘tstatus’. The result of this command has the same fields as -tracestatus.396 Debugging with gdb ‘stopping-tracepoint’ The number of tracepoint whose passcount as exceeded.19 gdb/mi Symbol Query Commands The -symbol-list-lines Command Synopsis -symbol-list-lines filename Print the list of lines that contain code and their associated program addresses for the given source filename. ‘buffer-size’ ‘buffer-free’ These fields tell the current size of the tracing buffer and the remaining space. 0 means that the trace run will stop. . ‘circular’ The value of the circular trace buffer flag. The entries are sorted in ascending PC order. 1 means that tracing will continue after gdb disconnects. except that the ‘supported’ and ‘running’ fields are not output. Both fields are optional. 0 means that the trace buffer is linear and may fill up.

If used without argument. Otherwise. This file is the one from which the symbol table is also read.mbx ^done (gdb) The -file-exec-file Command Synopsis -file-exec-file file Specify the executable file to be debugged.lines=[{pc="0x08048554". the command clears the executable and symbol information. Example (gdb) -file-exec-and-symbols /kwikemart/marge/ezannoni/TRUNK/mbx/hello.Chapter 27: The gdb/mi Interface 397 Example (gdb) -symbol-list-lines basics. gdb will produce error messages. If no file is specified. except a completion notification.{pc="0x0804855a". The -file-exec-and-symbols Command Synopsis -file-exec-and-symbols file Specify the executable file to be debugged. gdb Command The corresponding gdb command is ‘exec-file’. Unlike ‘-file-exec-and-symbols’. gdb Command The corresponding gdb command is ‘file’.c ^done. No output is produced.line="8"}] (gdb) 27. gdb clears the information about the executable file. no output is produced. Example (gdb) -file-exec-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello.20 gdb/mi File Commands This section describes the GDB/MI commands to specify executable file names and to read in and obtain symbol table information. the symbol table is not read from this file.mbx ^done (gdb) The -file-list-exec-source-file Command . If breakpoints are set when using this command with no arguments. except a completion notification.line="7"}.

c}. will it output the fullname. gdbtk has an analogous command ‘gdb_listfiles’. gdb Command The corresponding gdb command is ‘symbol-file’.mbx . When used without arguments.c}. {file=/home/bar.line="1". {file=gdb_could_not_find_fullpath.c.398 Debugging with gdb Synopsis -file-list-exec-source-file List the line number. No output is produced. clears gdb’s symbol table info. and the absolute path to the current source file for the current executable.c}] (gdb) The -file-symbol-file Command Synopsis -file-symbol-file file Read symbol table info from the specified file argument.c. It will always output the filename.macro-info="1" (gdb) The -file-list-exec-source-files Command Synopsis -file-list-exec-source-files List the source files for the current executable.file="foo. but only when gdb can find the absolute file name of a source file. The macro information field has a value of ‘1’ or ‘0’ depending on whether or not the file includes preprocessor macro information. Example (gdb) -file-symbol-file /kwikemart/marge/ezannoni/TRUNK/mbx/hello. Example (gdb) -file-list-exec-source-files ^done.c". gdb Command The gdb equivalent is ‘info sources’.c.fullname=/home/bar. the current source file. except for a completion notification. gdb Command The gdb equivalent is ‘info source’ Example (gdb) 123-file-list-exec-source-file 123^done.fullname="/home/bar/foo.files=[ {file=foo.fullname=/home/foo.

thread-id="1".Chapter 27: The gdb/mi Interface 399 ^done (gdb) 27. detaches from either the specified process. Example (gdb) -target-attach 34 =thread-created. Example (gdb) -target-detach ^done (gdb) The -target-disconnect Command Synopsis -target-disconnect Disconnect from the remote target. . There’s no output.func="bar". If either pid or gid is specified. gdb Command The corresponding gdb command is ‘detach’. If attaching to a thread group.id="1" *stopped. or a thread group gid.21 gdb/mi Target Manipulation Commands The -target-attach Command Synopsis -target-attach pid | gid | file Attach to a process pid or a file file outside of gdb. gdb Command The corresponding gdb command is ‘attach’. There’s no output and the target is generally not resumed. the id previously returned by ‘-list-thread-groups --available’ must be used. or specified thread group.frame={addr="0xb7f7e410".args=[]} ^done (gdb) The -target-detach Command Synopsis -target-detach [ pid | gid ] Detach from the remote target which normally resumes its execution.

page 341). Each message is sent as status record (see Section 27. it prints the name and size of the sections. ‘total-size’ The size of the overall executable to download. a summary is printed.400 Debugging with gdb gdb Command The corresponding gdb command is ‘disconnect’. In addition.4. Example Note: each status message appears on a single line. ‘section-sent’ The size of what has been sent so far for that section. It prints out an update message every half second. as they are downloaded. which includes the fields: ‘section’ The name of the section. These messages include the following fields: ‘section’ The name of the section. ‘section-size’ The size of the section. ‘total-sent’ The total size of what was sent so far (the current and the previous sections). gdb Command The corresponding gdb command is ‘load’. ‘section-size’ The size of the section. Example (gdb) -target-disconnect ^done (gdb) The -target-download Command Synopsis -target-download Loads the executable onto the remote target. . ‘total-size’ The size of the overall executable to download. At the end.2 [gdb/mi Output Syntax]. Here the messages have been broken down so that they can fit onto a page.

data".{section=".text".A.address="0x10004".{section=".section-sent="3072".section-size="6668".section-size="6668".section-sent="3072". total-sent="3072".data".data".section-size="6668". total-sent="9284".section-sent="5120".section-sent="2048".section-size="6668". total-sent="3584".total-size="9880"} +download.section-sent="512". total-sent="2560". total-sent="8772".section-sent="2560". total-sent="6144".total-size="9880"} +download.section-size="6668".{section=".section-size="6668". total-sent="2048".text". total-sent="7748".section-size="6668".text".data".text".section-size="3156".section-size="3156".text". total-sent="5632".section-sent="2560".section-sent="512".{section=".section-sent="5632".section-sent="6656".total-size="9880"} +download.section-size="6668".section-sent="1024".{section=".total-size="9880"} +download. total-sent="5120". total-sent="9796".total-size="9880"} +download.{section=".total-size="9880"} +download.{section=". total-sent="1536".total-size="9880"} +download.total-size="9880"} +download.text".total-size="9880"} ^done.section-size="3156".section-size="28".text".data".{section=".total-size="9880"} +download. total-sent="4608".total-size="9880"} +download.{section=". total-sent="512".{section=". The -target-select Command .total-size="9880"} +download.{section=".section-size="6668".section-sent="2048".section-size="6668".section-size="3156".text".{section=".data". total-sent="1024".section-size="3156".text". write-rate="429" (gdb) gdb Command No equivalent.{section=".{section=".section-size="6668".section-size="6668".text".{section=".section-sent="3584". total-sent="4096".total-size="9880"} +download.text".total-size="9880"} +download.load-size="9880".{section=".section-sent="6144". total-sent="8260". total-sent="6656".text".{section=".total-size="9880"} +download.total-size="9880"} +download.{section=".section-sent="1024".total-size="9880"} +download.section-sent="1536".text".total-size="9880"} +download.transfer-rate="6586".section-size="3156". Example N.total-size="9880"} +download.init".section-size="3156".section-sent="1536". total-sent="7236".section-size="28".total-size="9880"} +download.total-size="9880"} +download.fini".total-size="9880"} +download.{section=".{section=".Chapter 27: The gdb/mi Interface 401 (gdb) -target-download +download.section-sent="4608".section-sent="4096".section-size="6668".{section=".section-size="6668".text".total-size="9880"} +download.{section=".{section=".data".

Connect gdb to the remote target.addr="address". gdb Command The corresponding gdb command is ‘remote get’. for instance ‘remote’. page 215.. in the following form: ^connected.addr="0xfe00a300". for more details. Example (gdb) -target-file-put localfile remotefile ^done (gdb) The -target-file-get Command Synopsis -target-file-get targetfile hostfile Copy file targetfile from the target system to hostfile on the host system.22 gdb/mi File Transfer Commands The -target-file-put Command Synopsis -target-file-put hostfile targetfile Copy file hostfile from the host system (the machine running gdb) to targetfile on the target system. ‘parameters’ Device names. This command takes two args: ‘type’ The type of target. host names and the like.2 [Commands for Managing Targets].args=[] (gdb) 27. gdb Command The corresponding gdb command is ‘remote put’.func="??". followed by the address at which the target program is.. The output is a connection notification. args=[arg list] gdb Command The corresponding gdb command is ‘target’.402 Debugging with gdb Synopsis -target-select type parameters . . See Section 19. Example (gdb) -target-select remote /dev/ttya ^connected. etc.func="function name".

Example (gdb) -gdb-exit ^exit The -gdb-set Command Synopsis -gdb-set Set an internal gdb variable. gdb Command Approximately corresponds to ‘quit’. gdb Command The corresponding gdb command is ‘set’. . gdb Command The corresponding gdb command is ‘remote delete’.Chapter 27: The gdb/mi Interface 403 Example (gdb) -target-file-get remotefile localfile ^done (gdb) The -target-file-delete Command Synopsis -target-file-delete targetfile Delete targetfile from the target system. Example (gdb) -target-file-delete remotefile ^done (gdb) 27.23 Miscellaneous gdb/mi Commands The -gdb-exit Command Synopsis -gdb-exit Exit gdb immediately.

~This GDB was configured as "--host=sparc-sun-solaris2. ~GDB is free software. ~Type "show copying" to see the conditions. gdb by default shows this information when you start an interactive session. Type "show warranty" for ~ details. Example (gdb) -gdb-show annotate ^done.1 ~Copyright 2000 Free Software Foundation. A feature can be a command. gdb Command The corresponding gdb command is ‘show’. or a new field in an output of some command.2. Used mostly in testing. covered by the GNU General Public License.value="0" (gdb) The -gdb-version Command Synopsis -gdb-version Show version information for gdb. ^done (gdb) The -list-features Command Returns a list of particular features of the MI protocol that this version of gdb implements. or even an .5. Example (gdb) -gdb-version ~GNU gdb 5. ~There is absolutely no warranty for GDB.404 Debugging with gdb Example (gdb) -gdb-set $foo=3 ^done (gdb) The -gdb-show Command Synopsis -gdb-show Show the current value of a gdb variable. gdb Command The gdb equivalent is ‘show version’.1 --target=ppc-eabi". and ~you are welcome to change it and/or distribute copies of it under ~ certain conditions. Inc.

with each string naming an available feature. Whenever a target can change. -target-attach or exec-run.result=["feature1". for more information. due to commands such as -target-select. which means that gdb will accept further commands while the target is running. The command returns a list of strings. Those features affect the permitted MI commands. as well as possible presense of the frozen field in the output of -varobj-create. ‘python’ Indicates Python scripting support. ‘data-read-memory-bytes’ Indicates support for the -data-read-memory-bytes and the -data-writememory-bytes commands. page 75.result=["async"] The current list of features is: ‘async’ ‘reverse’ Indicates that the target is capable of asynchronous command execution. The -list-target-features Command Returns a list of particular features that are supported by the target. . and possible presence of the ‘display_hint’ field in the output of -var-listchildren ‘thread-info’ Indicates support for the -thread-info command. Each returned string is just a name. Example output: (gdb) -list-features ^done. the list of target features may change. the features depend on which target GDB is using at the moment. but unlike the features reported by the -list-features command. Example output: (gdb) -list-features ^done. ‘ada-task-info’ Indicates support for the -ada-task-info command. ‘pending-breakpoints’ Indicates support for the ‘-f’ option to the -break-insert command. While a frontend can sometimes detect presence of a feature at runtime. it is easier to perform detection at debugger startup. Python-based pretty-printing commands. The list of possible feature names is given below. ‘breakpoint-notifications’ Indicates that changes to breakpoints and breakpoints created via the CLI will be announced via async records."feature2"] The current list of features is: ‘frozen-varobjs’ Indicates support for the -var-set-frozen command.Chapter 27: The gdb/mi Interface 405 important bugfix. Indicates that the target is capable of reverse execution. and the frontend should obtain it again. See Chapter 6 [Reverse Execution]. it does not have any internal structure.

with each tuple describing a thread (see Section 27. then every reported thread group will also include its children. The ‘thread’ result has a list of tuples as value. page 347). It may be present if the ‘--recurse’ option is specified. If top-level groups are requested (that is. threads This field has a list of tuples as value. Presently. by passing the ‘--recurse’ option and the recursion depth. The output of this command may have either a ‘threads’ result or a ‘groups’ result. Normally. The identifier is an opaque string.5 [GDB/MI Thread Information]. When several thread group are passed.406 Debugging with gdb The -list-thread-groups Command Synopsis -list-thread-groups [ --available ] [ --recurse 1 ] [ group . The target-specific process identifier. with the following caveats: • When a single thread group is passed. limited information may be available. This field may be absent for an available thread group. each tuple describing a thread group. only ‘process’ is a valid type.. lists information about all top-level thread groups. When a single thread group is passed as the argument. The type of the thread group. the output always has a ‘groups’ result. gdb reports thread groups available on the target. lists the children of that group. only recursion depth of 1 is permitted. The ‘groups’ result has a list of tuples as value. thread groups that are being debugged are reported.7. page 339). With the ‘--available’ option. any combination of option and parameters is permitted. If this option is present. To reduce the number of roundtrips it’s possible to list thread groups together with their children.. Without any parameters. This field is only present for thread groups of type ‘process’ and only if the process exists. The ‘groups’ result is a list of tuples. Because threads may not contain anything. ] Lists thread groups (see Section 27. At present. type pid num_children The number of children this thread group has. frontends should not try to convert it to an integer. either as ‘group’ or ‘threads’ field. • When the ‘--available’ option is passed. specifying specific thread groups might not give any performance advantage over listing all thread groups. Further. lists information about those thread groups. In general. or when several groups are passed. and it’s actually possible to obtain the threads. the ‘recurse’ option will be ignored. the output will typically be the ‘threads’ result. the list of threads of a process might be inaccessible. The format of the ‘group’ result is described below. In particular.3 [Thread groups]. no parameter is passed). . where each tuple may have the following fields: id Identifier of the thread group. This field is always present. even though it might look like one. The frontend should assume that ‘-list-thread-groups --available’ is always an expensive operation and cache the results. each tuple describing a thread.3.

.num_children="2".target-id="Thread 0xb7e14b90 (LWP 21257)".groups=[{id="17".cores=[2]}]}.cores=[1]}. {id="2".] The -add-inferior Command Synopsis -add-inferior Creates a new inferior (see Section 4.cores=[1. The created inferior is not associated with any executable. frame={level="0". frame={level="0". Example gdb -list-thread-groups ^done. page 397).args=[]}.pid="yyy".num_children="2". Example gdb -add-inferior ^done.thread-group="i3" The -interpreter-exec Command Synopsis -interpreter-exec interpreter command Execute the specified command in the given interpreter. threads=[{id="1". The name of the executable file that corresponds to this thread group. The field is only present for thread groups of type ‘process’. This field may be absent if such information is not available.2]}] -list-thread-groups --available --recurse 1 ^done.func="foo". types="process".target-id="Thread 0xb7e14b90"..line="158"}.type="process".9 [Inferiors and Programs].num_children="2"}] -list-thread-groups 17 ^done. .pid="yyy".cores=[2]}]}. gdb Command The corresponding gdb command is ‘interpreter-exec’. Such association may be established with the ‘-file-exec-and-symbols’ command (see Section 27..groups=[{id="17".cores=[1.cores=[1.groups=[{id="17".target-id="Thread 0xb7e14b90".groups=[{id="17".addr="0x0804891f". ‘thread-group’.func="__kernel_vsyscall".2].state="running"}.c". {id="2". file="/tmp/a.num_children="2". page 32).type="process".c". and only if there is a corresponding executable file.target-id="Thread 0xb7e156b0 (LWP 21254)". The command response has a single field.args=[{name="i".value="10"}].Chapter 27: The gdb/mi Interface 407 cores executable This field is a list of integers.cores=[1]}. {id="1".threads=[{id="2"..addr="0xffffe410". each identifying a core that one thread of the group is running on. threads=[{id="1". types="process".target-id="Thread 0xb7e14b90".fullname="/tmp/a.2]. whose value is the identifier of the thread group corresponding to the new inferior.state="running"}]] -list-thread-groups --available ^done.] -list-thread-groups --available --recurse 1 17 18 ^done.target-id="Thread 0xb7e14b90".pid="yyy".pid="yyy".20 [GDB/MI File Commands]..

/src/gdb/main. This command is to help frontend developers optimize the performance of their code.408 Debugging with gdb Example (gdb) -interpreter-exec console "break main" &"During symbol reading.c./. .. bad structure-type format.. Example (gdb) -inferior-tty-set /dev/pts/1 ^done (gdb) -inferior-tty-show ^done.\n" ^done (gdb) The -inferior-tty-set Command Synopsis -inferior-tty-set /dev/pts/1 Set terminal for future runs of the program being debugged.inferior_tty_terminal="/dev/pts/1" (gdb) The -enable-timings Command Synopsis -enable-timings [yes | no] Toggle the printing of the wallclock. gdb Command The corresponding gdb command is ‘show inferior-tty’. Example (gdb) -inferior-tty-set /dev/pts/1 ^done (gdb) The -inferior-tty-show Command Synopsis -inferior-tty-show Show terminal for future runs of program being debugged. line 743. user and system times for an MI command as a field in its output. No argument is equivalent to ‘yes’.\n" ~"Breakpoint 1 at 0x8074fc6: file . gdb Command The corresponding gdb command is ‘set inferior-tty’ /dev/pts/1. couldn’t parse type. debugger out of date?.\n" &"During symbol reading.

value="0xbfb60364"}].times="0"}. fullname="/home/nickrob/myprog.type="breakpoint".system="0.line="73"} (gdb) .func="main". addr="0x080484ed".disp="keep".bkpt={number="1".bkptno="1".c".user="0.05185".00800". fullname="/home/nickrob/myprog.func="main".args=[{name="argc".line="73".file="myprog.c".c".c".enabled="y".value="1"}. frame={addr="0x080484ed". {name="argv".Chapter 27: The gdb/mi Interface 409 gdb Command No equivalent. Example (gdb) -enable-timings ^done (gdb) -break-insert main ^done.reason="breakpoint-hit".thread-id="0".file="myprog. time={wallclock="0.disp="keep".00000"} (gdb) -enable-timings no ^done (gdb) -exec-run ^running (gdb) *stopped.

.

and level 2 annotations have been made obsolete (see Section “Limitations of the Annotation Interface” in GDB’s Obsolete Annotations). Type "show warranty" for details. which is specified using the ‘--annotate’ command line option (see Section 2. If there is no additional information associated with this annotation.2 [Mode Options]. the name of the annotation is followed by a space. covered by the GNU General Public License. two ‘control-z’ characters. level 3 is the maximum annotation suitable for programs that control gdb. source lines.1. page 337). Any output not beginning with a newline and two ‘control-z’ characters denotes literal output from gdb. The additional information cannot contain newline characters. but if there was such a need. show annotate Show the current annotation level. level 1 is for use when gdb is run as a subprocess of gnu Emacs. Currently there is no need for gdb to output a newline followed by two ‘control-z’ characters. Annotations were designed to interface gdb to graphical user interfaces or other similar programs which want to interact with gdb at a relatively high level. page 13). Type "show copying" to see the conditions. There is absolutely no warranty for GDB. values of expressions. and the name of the annotation. The annotation level.1 What is an Annotation? Annotations start with a newline character.Chapter 28: gdb Annotations 411 28 gdb Annotations This chapter describes annotations in gdb. Level 0 is for no annotations. 28. and other types of output. The annotation mechanism has largely been superseded by gdb/mi (see Chapter 27 [GDB/MI].0 Copyright 2003 Free Software Foundation. This GDB was configured as "i386-pc-linux-gnu" ^Z^Zpre-prompt (gdb) ^Z^Zprompt quit . GDB is free software. Inc. the name of the annotation is followed immediately by a newline. and a newline. the additional information. This chapter describes level 3 annotations. controls how much information gdb prints together with its prompt. A simple example of starting up gdb with annotations is: $ gdb --annotate=3 GNU gdb 6. and you are welcome to change it and/or distribute copies of it under certain conditions. the annotations could be extended with an ‘escape’ annotation which means those three characters as output. If there is additional information. set annotate level The gdb command set annotate sets the level of annotations to the specified level.

. The server prefix does not affect the recording of values into the value history. use the output command instead of the print command. and then a post. The three lines beginning ‘^Z^Z’ (where ‘^Z’ denotes a ‘control-z’ character) are annotations. Using this prefix also disables confirmation requests (see [confirmation requests]. Note: Don’t expect this to work well. the rest is output from gdb.annotation. prompt-for-continue When gdb is asking the user to press return to continue. to print a value without recording it into the value history. page 270). which denotes the beginning of any prompt which is being output. a plain annotation. Different kinds of input each have a different input type. The annotations are repeated for each command which is input. 28.annotation which denotes the end of any echo which may (or may not) be associated with the input. This means that commands can be run behind a user’s back by a front-end in a transparent manner. etc. overload-choice When gdb wants the user to select between various overloaded functions. when the output from a given command is over. like in the commands command. which denotes the end of the prompt.2 The Server Prefix If you prefix a command with ‘server ’ then it will not affect the command history. 28. the prompt input type features the following annotations: ^Z^Zpre-prompt ^Z^Zprompt ^Z^Zpost-prompt The input types are prompt commands When gdb is prompting for a command (the main gdb prompt). nor will it affect gdb’s notion of which command to repeat if RET is pressed on a line by itself. When gdb prompts for a set of commands. the rest is output from gdb. Each input type has three annotations: a pre.3 Annotation for gdb Input When gdb prompts for input. it annotates this fact so it is possible to know when to send output.412 Debugging with gdb ^Z^Zpost-prompt $ Here ‘quit’ is input to gdb. query When gdb wants the user to confirm a potentially dangerous operation. For example. instead use set height 0 to disable prompting. This is because the counting of lines is buggy in the presence of annotations.

and exit-status is the exit status (zero for successful exit. otherwise nonzero). After the ^Z^Zsignalled.4 Errors ^Z^Zquit This annotation occurs right before gdb responds to an interrupt. one cannot expect to receive the matching value-history-end. the annotation continues: intro-text ^Z^Zsignal-name name ^Z^Zsignal-name-end middle-text ^Z^Zsignal-string . ^Z^Zbreakpoints-invalid The breakpoints may have changed. A quit or error annotation may be preceded by ^Z^Zerror-begin Any output between that and the quit or error annotation is the error message.5 Invalidation Notices The following annotations say that certain pieces of state may have changed. ^Z^Zframes-invalid The frames (for example.6 Running the Program When the program starts executing due to a gdb command such as step or continue. ^Z^Zstopped is output. For example. ^Z^Zexited exit-status The program exited. Warning messages are not yet annotated. One cannot expect not to receive it either. When the program stops. 28. if a value-history-begin annotation is followed by a error. however. 28. ^Z^Zerror This annotation occurs right before gdb responds to an error. output from the backtrace command) may have changed. Before the stopped annotation. a variety of annotations describe how the program stopped. an error annotation does not necessarily mean that gdb is immediately returning all the way to the top level. For example. the user just added or deleted a breakpoint. Quit and error annotations indicate that any annotations which gdb was in the middle of may end abruptly. ^Z^Zsignalled The program exited with a signal. ^Z^Zstarting is output.Chapter 28: gdb Annotations 413 28.

7 Displaying Source The following annotation is used instead of displaying source code: ^Z^Zsource filename:line:character:middle:addr where filename is an absolute file name indicating which source file. 28. such as Illegal Instruction or Segmentation fault. ^Z^Zwatchpoint number The program hit watchpoint number number. intro-text. not that it was terminated with it.414 Debugging with gdb string ^Z^Zsignal-string-end end-text where name is the name of the signal. ^Z^Zsignal The syntax of this annotation is just like signalled. . middle is ‘middle’ if addr is in the middle of the line. line is the line number within that file (where 1 is the first line in the file). and end-text are for the user’s benefit and have no particular format. and string is the explanation of the signal. and addr is the address in the target program associated with the source which is being displayed. but gdb is just saying that the program received the signal. middle-text. ^Z^Zbreakpoint number The program hit breakpoint number number. character is the character position within the file (where 0 is the first character in the file) (for most debug formats this will necessarily point to the beginning of a line). such as SIGILL or SIGSEGV. addr is in the form ‘0x’ followed by one or more lowercase hex digits (note that this does not depend on the language). or ‘beg’ if addr is at the beginning of the line.

Broadly speaking. and puts a breakpoint in the function so that it can find out about additional code. struct jit_code_entry *relevant_entry.Chapter 29: JIT Compilation Interface 415 29 JIT Compilation Interface This chapter documents gdb’s just-in-time (JIT) compilation interface. struct jit_code_entry *prev_entry. JIT_UNREGISTER_FN } jit_actions_t. struct jit_code_entry *first_entry. }. then it should work transparently so long as you have not stripped the binary. the JIT interface mirrors the dynamic loader interface. */ uint32_t action_flag. gdb has an interface that allows the program to register in-memory symbol files with gdb at runtime. the only known client of this interface is the LLVM JIT. If you are developing a JIT compiler. }. */ void __attribute__((noinline)) __jit_debug_register_code() { }. Programs that use JIT compilation are normally difficult to debug because portions of their code are generated at runtime. /* GDB puts a breakpoint in this function. /* This type should be jit_actions_t. If you are using gdb to debug a program that uses this interface. . instead of being loaded from object files. 29. The JIT compiler communicates with gdb by writing data into a global variable and calling a fuction at a well-known symbol. At this time. uint64_t symfile_size. struct jit_descriptor { uint32_t version. A JIT compiler is a program or library that generates native executable code at runtime and executes it. const char *symfile_addr. In order to debug programs that use JIT compilation. which is where gdb normally finds the program’s symbols and debug information. struct jit_code_entry { struct jit_code_entry *next_entry. but we use uint32_t to be explicit about the bitwidth. then the interface is documented in the rest of this chapter. JIT_REGISTER_FN. usually in order to achieve good performance while maintaining platform independence.1 JIT Declarations These are the relevant struct declarations that a C program should include to implement the interface: typedef enum { JIT_NOACTION = 0. it reads a linked list of symbol files from the global variable to find existing code. When gdb attaches.

3 Unregistering Code If code is freed. However.416 Debugging with gdb /* Make sure to specify the version statically. the linked list must still be maintained in order to allow gdb to attach to a running process and still find the symbol files. If the JIT frees or recompiles code without unregistering it. When gdb is attached and the breakpoint fires. then it is important that the JIT synchronize any modifications to this global data properly. 0 }. • Point the relevant_entry field of the descriptor at the code entry.2 Registering Code To register code with gdb. the JIT should follow this protocol: • Generate an object file in memory with symbols and other desired debug information. which can easily be done by putting a global mutex around modifications to these structures. • Set action_flag to JIT_REGISTER and call __jit_debug_register_code. • Add it to the linked list in the JIT descriptor. • Create a code entry for the file. because the debugger may check the version before we can set it. • Point the relevant entry field of the descriptor at the entry. The file must include the virtual addresses of the sections. gdb uses the relevant_entry pointer so it doesn’t have to walk the list looking for new code. */ struct jit_descriptor __jit_debug_descriptor = { 1. 0. then gdb and the JIT will leak the memory used for the associated symbol files. then the JIT should use the following protocol: • Remove the code entry corresponding to the code from the linked list. 0. 29. 29. which gives the start and size of the symbol file. • Set action_flag to JIT_UNREGISTER and call __jit_debug_register_code. If the JIT is multi-threaded. .

that is a bug. Thus. or to any newsgroups. state it! Often people omit facts because they think they know what causes the problem and assume that some details do not matter. If you obtained gdb from a support organization. it is better to send bug reports to the mailing list. Alternatively. that is a gdb bug. In order for a bug report to serve its purpose. For this reason. that is a bug. you might assume that the name of the . (Note that if you’re cross debugging. the e-mail gateway can be used.Chapter 30: Reporting Bugs in gdb 417 30 Reporting Bugs in gdb Your bug reports play an essential role in making gdb reliable. here are some guidelines: • If the debugger gets a fatal signal. or it may not. if we need to ask for more information. you should note that your idea of “invalid input” might be our idea of “an extension” or “support for traditional practice”.bug’ which serves as a repeater. The mailing list ‘bug-gdb’ has a newsgroup ‘gnu. but it has one problem which can be crucial: a newsgroup posting often lacks a mail path back to the sender. you must include the information that enables us to fix the bug.) • If gdb does not produce an error message for invalid input. You can find contact information for many support companies and individuals in the file ‘etc/SERVICE’ in the gnu Emacs distribution. Thus. In any event. This appears to work. Do not send bug reports to ‘info-gdb’.2 How to Report Bugs A number of companies and individuals offer support for gnu products. The fundamental principle of reporting bugs usefully is this: report all the facts. for any input whatever. 30. Those that do have arranged to receive ‘bug-gdb’.gdb. or to ‘help-gdb’. But in any case the principal function of a bug report is to help the entire community by making the next version of gdb work better. Reliable debuggers never crash.1 Have You Found a Bug? If you are not sure whether you have found a bug. If you are not sure whether to state a fact or leave it out. we may be unable to reach you. • If you are an experienced user of debugging tools. Reporting a bug may help you by bringing a solution to your problem. However. The preferred method is to submit them directly using gdb’s Bugs web page. Most users of gdb do not want to receive bug reports. Bug reports are your contribution to the maintenance of gdb. the problem may also be somewhere in the connection to the target. your suggestions for improvement of gdb are welcome in any case. 30. • If gdb produces an error message for valid input. we recommend you contact that organization first. we also recommend that you submit bug reports for gdb. The mailing list and the newsgroup carry exactly the same messages. Often people think of posting bug reports to the newsgroup instead of mailing them.

• A description of what behavior you observe that you believe is incorrect. and all necessary source files.32. gdb announces it if you start with no arguments. your copy of gdb is out of synch. To collect all this information. (This has happened!) Your copy might crash and ours would not.10.g. but one cannot be sure. if the name were different. and the operating system name and version number.418 Debugging with gdb variable you use in an example does not matter. For example. for other compilers. It may be that the bug has been reported previously. we would know that the bug was not happening for us. Play it safe and give a specific. “gcc–2.1”. then when ours fails to crash.8. If we were to try to guess the arguments. Well. A copy of the Makefile (or the output from make) is sufficient. • The command arguments you gave the compiler to compile your example and observe the bug. we would probably guess wrong and then we might not encounter the bug. • What compiler (and its version) was used to compile gdb—e. Perhaps the bug is a stray memory reference which happens to fetch from the location where that name is stored in memory. you can use a session recording program such as script. such as. and we urge everyone to refuse to respond to them except to chide the sender to report bugs properly. or “HP92453-01 A. see the documentation for those compilers. we will not know whether there is any point in looking for the bug in the current version of gdb. if the bug is that gdb gets a fatal signal. or you have encountered a bug in the C library on your system. “Does this ring a bell?” Those bug reports are useless. probably it does not. Even if the problem you experience is a fatal signal. “gcc–2. But if the bug is incorrect output. . • The type of machine you are using. You might as well not give us a chance to make a mistake. “It gets a fatal signal. that will reproduce the bug. perhaps.03 HP C Compiler”. you can say gcc --version to get this information. Suppose something strange is going on. Sometimes people give a few sketchy facts and ask.1”. complete example. but neither you nor we can know that unless your bug report is complete and self-contained. which is available on many Unix systems. you can also print it at any time using show version. list them all. If you told us to expect a crash. To enable us to fix the bug. the contents of that location would fool the debugger into doing the right thing despite the bug. Keep in mind that the purpose of a bug report is to enable us to fix the bug. • What compiler (and its version) was used to compile the program you are debugging— e. That is the easiest thing for you to do. you should still say so explicitly. did you use ‘-O’? To guarantee you will not omit something important.” Of course. we might not notice unless it is glaringly wrong. For example.g.8. then we will certainly notice it. • A complete input script. For gcc. then we would not be able to draw any conclusion from our observations. Just run your gdb session inside script and then include the ‘typescript’ file with your bug report. you should include all these things: • The version of gdb. and the most helpful. Without this. If you had not told us to expect a crash.

A patch for the bug does help us if it is a good one. so we will not be able to verify that the bug is fixed. Sometimes with a program as complicated as gdb it is very hard to construct an example that will make the program follow a certain path through the code. report the bug anyway and send us the entire test case you used. Your line numbers would convey no useful information to us. If you even discuss something in the gdb source. • A guess about what the bug is or what it depends on. This is often time consuming and not very useful. if you do not want to do this. we will not be able to construct one. we will not install it. and so on. or why your patch should be an improvement. Such guesses are usually wrong. We recommend that you save your time for something else. • If you wish to suggest changes to the gdb source. We might see problems with your patch and decide to fix the problem another way. Often people who encounter a bug spend a lot of time investigating which changes to the input file will make the bug go away and which changes will not affect it. The line numbers in our development sources will not match those in your sources. If you do not send us the example. refer to it by context. because the way we will find the bug is by running a single example under the debugger with breakpoints. However. Even we cannot guess right about such things without first using the debugger to find the facts. And if we cannot understand what bug you are trying to fix. not by pure deduction from a series of examples. Errors in the output will be easier to spot. on the assumption that a patch is all we need. A test case will help us to understand. that is a convenience for us. Here are some things that are not necessary: • A description of the envelope of the bug. Of course. simplification is not vital. But do not omit the necessary information. if you can find a simpler example to report instead of the original one. running under the debugger will take less time. • A patch for the bug. . send us context diffs.Chapter 30: Reporting Bugs in gdb 419 Another way to record a gdb session is to run gdb inside Emacs and then save the entire buffer to a file. such as the test case. or we might not understand it at all. not by line number.

.

and then typing k. and TAB all stand for themselves when seen in this text. In that case. LFD. typing C-j will produce the desired character. and not notice the error until you have typed several other characters. and the k key is pressed. the ALT on the left side is generally set to work as a Meta key. you move the cursor to the place that needs correction. The ALT key on the right may also be configured to work as a Meta key or may be configured as some other modifier. and delete or insert the text of the corrections. The typed character appears where the cursor was. you will notice that characters to the right of the cursor are ‘pushed over’ to make room for the text that you have inserted. you can move the cursor to the right with C-f. You do not have to be at the end of the line to press RET. RET. such as a Compose key for typing accented characters. you can type C-b to move the cursor to the left. On keyboards with two keys labeled ALT (usually to either side of the space bar). page 424). 31.3 [Readline Init File]. allowing you to just fix your typo. or another key working as a Meta key. The text M-k is read as ‘Meta-K’ and describes the character produced when the Meta key (if you have one) is depressed. and not forcing you to retype the majority of the line. you can use your erase character to back up and delete the mistyped character. When you add text in the middle of a line. DEL. and then correct your mistake. The text C-k is read as ‘Control-K’ and describes the character produced when the k key is pressed while the Control key is depressed. Using these editing commands. the entire line is accepted regardless of the location of the cursor within the line. In addition. If you mistype a character. Likewise. characters to the right of the cursor are ‘pulled . The Meta key is labeled ALT on many keyboards. If you do not have a Meta or ALT key.2 Readline Interaction Often during an interactive session you type in a long line of text. SPC. Sometimes you may mistype a character. Then.1 Introduction to Line Editing The following paragraphs describe the notation used to represent keystrokes. and then the cursor moves one space to the right. when you delete text behind the cursor. when you are satisfied with the line. 31. simply type them.2. 31. Either process is known as metafying the k key.1 Readline Bare Essentials In order to enter characters into the line. Specifically. Afterwards. the identical keystroke can be generated by typing ESC first. only to notice that the first word on the line is misspelled.Chapter 31: Command Line Editing 421 31 Command Line Editing This chapter describes the basic features of the gnu command line editing interface. you simply press RET. The Readline library gives you a set of commands for manipulating the text as you type it in. The RET key may be labeled Return or Enter on some keyboards. or in an init file (see Section 31. If your keyboard lacks a LFD key. several keys have their own names. ESC. The text M-C-k is read as ‘Meta-Control-k’ and describes the character produced by metafying C-k.

the text is saved in a kill-ring.2. C-d Delete the character underneath the cursor. rather than the character to the left of the cursor. usually by yanking (re-inserting) it back into the line. Clear the screen. C-_ or C-x C-u Undo the last editing command. the text that you killed on a previously typed line is available to be yanked back later. C-d. Notice how C-f moves forward a character. while M-f moves forward a word. Move to the end of the line. For your convenience. When you use a kill command. 31. Move forward one character. like C-d. you get it all. C-a C-e M-f M-b C-l Move to the start of the line. the Backspace key be set to delete the character to the left of the cursor and the DEL key set to delete the character underneath the cursor. (‘Cut’ and ‘paste’ are more recent jargon for ‘kill’ and ‘yank’. Move forward a word. reprinting the current line at the top.422 Debugging with gdb back’ to fill in the blank space created by the removal of the text. and DEL. Move backward a word. Any number of consecutive kills save all of the killed text together. then you can be sure that you can get the text back in a different (or the same) place later. many other commands have been added in addition to C-b. where a word is composed of letters and digits. It is a loose convention that control keystrokes operate on characters while meta keystrokes operate on words.2 Readline Movement Commands The above table describes the most basic keystrokes that you need in order to do editing of the input line. A list of the bare essentials for editing the text of an input line follows.3 Readline Killing Commands Killing text means to delete the text from the line. C-f. so that when you yank it back.2. . (Depending on your configuration.) If the description for a command says that it ‘kills’ text.) 31. C-b C-f Move back one character. Printing characters Insert the character into the line at the cursor. Here are some commands for moving more rapidly about the line. but to save it away for later use. The kill ring is not line specific. when you are typing another line. Here is the list of commands for killing text. You can undo all the way back to an empty line. DEL or Backspace Delete the character to the left of the cursor.

C-w Here is how to yank the text back into the line. or. you could type ‘M-1 0 C-d’. or. you can type the remainder of the digits. To search backward in the history for a particular string. if between words.5 Searching for Commands in the History Readline provides commands for searching through the command history for lines containing a specified string.4 Readline Arguments You can pass numeric arguments to Readline commands. C-y M-y Yank the most recently killed text back into the buffer at the cursor. C-g will abort an incremental search and restore the original line. Typing C-s searches forward through the history. As each character of the search string is typed. Any other key sequence bound to a Readline command will terminate the . Word boundaries are the same as those used by M-f. Rotate the kill-ring. The characters present in the value of the isearch-terminators variable are used to terminate an incremental search. If you pass a negative argument to a command which normally acts in a forward direction. When the search is terminated. then the sign of the argument will be negative. Word boundaries are the same as those used by M-b. that command will act in a backward direction. other times it is the sign of the argument that is significant.2. You can only do this if the prior command is C-y or M-y. 31. the ESC and C-J characters will terminate an incremental search. If that variable has not been assigned a value. if between words. Kill from the cursor to the previous whitespace. to the start of the previous word. There are two search modes: incremental and non-incremental. to the end of the next word. Kill from the cursor the start of the current word. This will search backward or forward in the history for the next entry matching the search string typed so far. the history entry containing the search string becomes the current line. to kill text back to the start of the line. Sometimes the argument acts as a repeat count. which will delete the next ten characters on the input line. The general way to pass numeric arguments to a command is to type meta digits before the command. 31. Yanking means to copy the mostrecently-killed text from the kill buffer. Kill from the cursor to the end of the current word. Once you have typed one meta digit to get the argument started. type C-r. If the first ‘digit’ typed is a minus sign (‘-’). To find other matching entries in the history list.C-k’. An incremental search requires only as many characters as needed to find the desired history entry. Incremental searches begin before the user has finished typing the search string. This is different than M-DEL because the word boundaries differ. to give the C-d command an argument of 10. and then the command.Chapter 31: Command Line Editing 423 C-k M-d M-DEL Kill the text from the current cursor position to the end of the line. For example. For example.2. Readline displays the next entry from the history matching the string typed so far. and yank the new top. you might type ‘M-. type C-r or C-s as appropriate.

Lines beginning with a ‘$’ indicate conditional constructs (see Section 31. For instance. Readline remembers the last incremental search string. conventionally in his home directory. it is possible to use a different set of keybindings. Unrecognized variable names are ignored. Readline never rings the bell. where appropriate. for example. the C-x C-r command re-reads this init file. are recognized without regard to case.3 Readline Init File Although the Readline library comes with a set of Emacs-like keybindings installed by default.3. If that variable is unset. Variable Settings You can modify the run-time behavior of Readline by altering the values of variables in Readline using the set command within the init file. The search string may be typed by the user or be part of the contents of the current line. bell-style Controls what happens when Readline wants to ring the terminal bell. the ultimate default is ‘/etc/inputrc’. 31. If set to ‘none’. page 430). Boolean variables (those that can be set to on or off) are set to on if the value is null or empty. the default is ‘~/.inputrc’. or 1. A great deal of run-time behavior is changeable with the following variables. on (case-insensitive). If set to .3. and the key bindings are set. When a program which uses the Readline library starts up. Any user can customize programs that use Readline by putting commands in an inputrc file. the init file is read. Lines beginning with a ‘#’ are comments. Non-incremental searches read the entire search string before starting to search for matching history lines. If two C-rs are typed without any intervening characters defining a new search string. any remembered search string is used.424 Debugging with gdb search and execute that command. a RET will terminate the search and accept the line.1 Readline Init File Syntax There are only a few basic constructs allowed in the Readline init file. make the last line found the current line. In addition. A movement command will terminate the search. 31. and begin editing. Other lines denote variable settings and key bindings. The syntax is simple: set variable value Here. The name of this file is taken from the value of the environment variable INPUTRC. thus incorporating any changes that you might have made to it. Any other value results in the variable being set to off. Blank lines are ignored. is how to change from the default Emacs-like key binding to use vi line editing commands: set editing-mode vi Variable names and values. thereby executing the command from the history list.2 [Conditional Init Constructs]. If that file does not exist or cannot be read.

Completion characters will be inserted into the line as if they had been mapped to self-insert. If set to ‘audible’ (the default). Readline performs filename matching and completion in a case-insensitive fashion. The default value is -1. . bind-tty-special-chars If set to ‘on’. disable-completion If set to ‘On’. completion-query-items The number of possible completions that determines when the user is asked whether the list of possibilities should be displayed. Readline will convert characters with the eighth bit set to an ascii key sequence by stripping the eighth bit and prefixing an ESC character. completion-prefix-display-length The length in characters of the common prefix of a list of possible completions that is displayed without modification. This variable must be set to an integer value greater than or equal to 0. converting them to a meta-prefixed key sequence. The default limit is 100. completion-ignore-case If set to ‘on’. comment-begin The string to insert at the beginning of the line when the insertcomment command is executed. Readline will inhibit word completion. A value of 0 will cause matches to be displayed one per line. they are simply listed. and completion-ignore-case is enabled. common prefixes longer than this value are replaced with an ellipsis when displaying possible completions. A negative value means Readline should never ask.Chapter 31: Command Line Editing 425 ‘visible’. completion-map-case If set to ‘on’. Readline will ask the user whether or not he wishes to view them. The default value is ‘off’. Readline attempts to ring the terminal’s bell. When set to a value greater than zero. If the number of possible completions is greater than this value. Readline treats hyphens (‘-’) and underscores (‘_’) as equivalent when performing case-insensitive filename matching and completion. convert-meta If set to ‘on’. otherwise. completion-display-width The number of screen columns used to display possible matches when performing completion. Readline attempts to bind the control characters treated specially by the kernel’s terminal driver to their Readline equivalents. The default is ‘off’. The default value is "#". Readline uses a visible bell if one is available. The default value is ‘on’. The value is ignored if it is less than 0 or greater than the terminal screen width.

instead of wrapping onto a new screen line. tilde expansion is performed when Readline attempts word completion. The default is ‘on’. The default is ‘off’. If set to zero. enable-meta-key When set to ‘on’. where the keystrokes are most similar to Emacs. The default is ‘on’.426 Debugging with gdb editing-mode The editing-mode variable controls which default set of key bindings is used. By default. Readline will enable eight-bit input (it will not clear the eighth bit in the characters it reads). The default is ‘off’. regardless of what the terminal claims it can support. echo-control-characters When set to ‘on’. The default value is ‘off’. Setting it to ‘on’ means that the text of the lines being edited will scroll horizontally on a single screen line when they are longer than the width of the screen. readline echoes a character corresponding to a signal generated from the keyboard. horizontal-scroll-mode This variable can be set to either ‘on’ or ‘off’. The name meta-flag is a synonym for this variable. the history code attempts to place the point (the current cursor position) at the same location on each history line retrieved with previous-history or next-history. By default. this variable is set to ‘off’. on operating systems that indicate they support it. On many terminals. Readline starts up in Emacs editing mode. isearch-terminators The string of characters that should terminate an incremental search without subsequently executing the character as a command . Readline will try to enable any meta modifier key the terminal claims to support when it is called. enable-keypad When set to ‘on’. input-meta If set to ‘on’. Readline will try to enable the application keypad when it is called. the number of entries in the history list is not limited. history-preserve-point If set to ‘on’. the meta key is used to send eight-bit characters. history-size Set the maximum number of history entries saved in the history list. Some systems need this to enable the arrow keys. This variable can be set to either ‘emacs’ or ‘vi’. expand-tilde If set to ‘on’. The default is ‘off’.

completed directory names have a slash appended. Acceptable keymap names are emacs. The default is ‘on’. Readline will display completions with matches sorted horizontally in alphabetical order. mark-directories If set to ‘on’. vi-move. print-completions-horizontally If set to ‘on’. causes Readline to match files whose names begin with a ‘.’ (hidden files) when performing filename completion. emacs-meta. when set to ‘on’. when set to ‘on’. mark-modified-lines This variable. The default is ‘off’. This variable is ‘on’ by default. vi-command. This variable is ‘on’ by default. The value of the editing-mode variable also affects the default keymap. The default is ‘off’. rather than down the screen. completed names which are symbolic links to directories have a slash appended (subject to the value of markdirectories). keymap Sets Readline’s idea of the current keymap for key binding commands.2. This variable is ‘off’ by default. causes Readline to display an asterisk (‘*’) at the start of history lines which