Table of Contents

Summary of GDB

Free software
Free Software Needs Free Documentation
Contributors to GDB

1. A Sample GDB Session
2. Getting In and Out of GDB

2.1 Invoking GDB

2.1.1 Choosing files
2.1.2 Choosing modes

2.2 Quitting GDB
2.3 Shell commands
2.4 Logging output

3. GDB Commands

3.1 Command syntax
3.2 Command completion
3.3 Getting help

4. Running Programs Under GDB

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 programs with multiple threads
4.10 Debugging programs with multiple processes

5. Stopping and Continuing

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 Breakpoint menus
5.1.9 "Cannot insert breakpoints"

5.2 Continuing and stepping
5.3 Signals
5.4 Stopping and starting multi-thread programs

6. Examining the Stack

6.1 Stack frames
6.2 Backtraces
6.3 Selecting a frame
6.4 Information about a frame

7. Examining Source Files

7.1 Printing source lines
7.2 Editing source files

7.2.1 Choosing your editor

7.3 Searching source files
7.4 Specifying source directories
7.5 Source and machine code

8. Examining Data

8.1 Expressions
8.2 Program variables
8.3 Artificial arrays
8.4 Output formats
8.5 Examining memory
8.6 Automatic display
8.7 Print settings
8.8 Value history
8.9 Convenience variables
8.10 Registers
8.11 Floating point hardware
8.12 Vector Unit
8.13 Memory region attributes

8.13.1 Attributes

8.13.1.1 Memory Access Mode
8.13.1.2 Memory Access Size
8.13.1.3 Data Cache

8.14 Copy between memory and a file
8.15 Character Sets

9. C Preprocessor Macros
10. Tracepoints

10.1 Commands to Set Tracepoints

10.1.1 Create and Delete Tracepoints
10.1.2 Enable and Disable Tracepoints
10.1.3 Tracepoint Passcounts
10.1.4 Tracepoint Action Lists
10.1.5 Listing Tracepoints
10.1.6 Starting and Stopping Trace Experiment

10.2 Using the collected data

10.2.1 tfind n
10.2.2 tdump
10.2.3 save-tracepoints filename

10.3 Convenience Variables for Tracepoints

11. Debugging Programs That Use Overlays

11.1 How Overlays Work
11.2 Overlay Commands
11.3 Automatic Overlay Debugging
11.4 Overlay Sample Program

12. Using GDB with Different Languages

12.1 Switching between source languages

12.1.1 List of filename extensions and languages
12.1.2 Setting the working language
12.1.3 Having GDB infer the source language

12.2 Displaying the language
12.3 Type and range checking

12.3.1 An overview of type checking
12.3.2 An overview of range checking

12.4 Supported languages

12.4.1 C and C++

12.4.1.1 C and C++ operators
12.4.1.2 C and C++ constants
12.4.1.3 C++ expressions
12.4.1.4 C and C++ defaults
12.4.1.5 C and C++ type and range checks
12.4.1.6 GDB and C
12.4.1.7 GDB features for C++

12.4.2 Objective-C

12.4.2.1 Method Names in Commands
12.4.2.2 The Print Command With Objective-C

12.4.3 Modula-2

12.4.3.1 Operators
12.4.3.2 Built-in functions and procedures
12.4.3.3 Constants
12.4.3.4 Modula-2 defaults
12.4.3.5 Deviations from standard Modula-2
12.4.3.6 Modula-2 type and range checks
12.4.3.7 The scope operators :: and .
12.4.3.8 GDB and Modula-2

12.5 Unsupported languages

13. Examining the Symbol Table
14. Altering Execution

14.1 Assignment to variables
14.2 Continuing at a different address
14.3 Giving your program a signal
14.4 Returning from a function
14.5 Calling program functions
14.6 Patching programs

15. GDB Files

15.1 Commands to specify files
15.2 Debugging Information in Separate Files
15.3 Errors reading symbol files

16. Specifying a Debugging Target

16.1 Active targets
16.2 Commands for managing targets
16.3 Choosing target byte order
16.4 Remote debugging
16.5 Kernel Object Display

17. Debugging remote programs

17.1 Connecting to a remote target
17.2 Using the gdbserver program
17.3 Using the gdbserve.nlm program
17.4 Remote configuration
17.5 Implementing a remote stub

17.5.1 What the stub can do for you
17.5.2 What you must do for the stub
17.5.3 Putting it all together

18. Configuration-Specific Information

18.1 Native

18.1.1 HP-UX
18.1.2 SVR4 process information
18.1.3 Features for Debugging DJGPP Programs
18.1.4 Features for Debugging MS Windows PE executables

18.1.4.1 Support for DLLs without debugging symbols
18.1.4.2 DLL name prefixes
18.1.4.3 Working with minimal symbols

18.2 Embedded Operating Systems

18.2.1 Using GDB with VxWorks

18.2.1.1 Connecting to VxWorks
18.2.1.2 VxWorks download
18.2.1.3 Running tasks

18.3 Embedded Processors

18.3.1 ARM
18.3.2 Hitachi H8/300

18.3.2.1 Connecting to Hitachi boards
18.3.2.2 Using the E7000 in-circuit emulator
18.3.2.3 Special GDB commands for Hitachi micros

18.3.3 H8/500
18.3.4 Mitsubishi M32R/D
18.3.5 M68k
18.3.6 MIPS Embedded
18.3.7 OpenRISC 1000
18.3.8 PowerPC
18.3.9 HP PA Embedded
18.3.10 Hitachi SH
18.3.11 Tsqware Sparclet

18.3.11.1 Setting file to debug
18.3.11.2 Connecting to Sparclet
18.3.11.3 Sparclet download
18.3.11.4 Running and debugging

18.3.12 Fujitsu Sparclite
18.3.13 Tandem ST2000
18.3.14 Zilog Z8000

18.4 Architectures

18.4.1 A29K
18.4.2 Alpha
18.4.3 MIPS

19. Controlling GDB

19.1 Prompt
19.2 Command editing
19.3 Command history
19.4 Screen size
19.5 Numbers
19.6 Configuring the current ABI
19.7 Optional warnings and messages
19.8 Optional messages about internal happenings

20. Canned Sequences of Commands

20.1 User-defined commands
20.2 User-defined command hooks
20.3 Command files
20.4 Commands for controlled output

21. Command Interpreters
22. GDB Text User Interface

22.1 TUI overview
22.2 TUI Key Bindings
22.3 TUI Single Key Mode
22.4 TUI specific commands
22.5 TUI configuration variables

23. Using GDB under GNU Emacs
24. The GDB/MI Interface

Function and Purpose
Notation and Terminology
24.1 GDB/MI Command Syntax

24.1.1 GDB/MI Input Syntax
24.1.2 GDB/MI Output Syntax
24.1.3 Simple Examples of GDB/MI Interaction

24.2 GDB/MI Compatibility with CLI
24.3 GDB/MI Output Records

24.3.1 GDB/MI Result Records
24.3.2 GDB/MI Stream Records
24.3.3 GDB/MI Out-of-band Records

24.4 GDB/MI Command Description Format
24.5 GDB/MI Breakpoint table commands
24.6 GDB/MI Data Manipulation
24.7 GDB/MI Program control
24.8 Miscellaneous GDB commands in GDB/MI
24.9 GDB/MI Stack Manipulation Commands
24.10 GDB/MI Symbol Query Commands
24.11 GDB/MI Target Manipulation Commands
24.12 GDB/MI Thread Commands
24.13 GDB/MI Tracepoint Commands
24.14 GDB/MI Variable Objects

25. GDB Annotations

25.1 What is an Annotation?
25.2 The Server Prefix
25.3 Annotation for GDB Input
25.4 Errors
25.5 Invalidation Notices
25.6 Running the Program
25.7 Displaying Source

26. Reporting Bugs in GDB

26.1 Have you found a bug?
26.2 How to report bugs

27. Command Line Editing

27.1 Introduction to Line Editing
27.2 Readline Interaction

27.2.1 Readline Bare Essentials
27.2.2 Readline Movement Commands
27.2.3 Readline Killing Commands
27.2.4 Readline Arguments
27.2.5 Searching for Commands in the History

27.3 Readline Init File

27.3.1 Readline Init File Syntax
27.3.2 Conditional Init Constructs
27.3.3 Sample Init File

27.4 Bindable Readline Commands

27.4.1 Commands For Moving
27.4.2 Commands For Manipulating The History
27.4.3 Commands For Changing Text
27.4.4 Killing And Yanking
27.4.5 Specifying Numeric Arguments
27.4.6 Letting Readline Type For You
27.4.7 Keyboard Macros
27.4.8 Some Miscellaneous Commands

27.5 Readline vi Mode

28. Using History Interactively

28.1 History Expansion

28.1.1 Event Designators
28.1.2 Word Designators
28.1.3 Modifiers

A. Formatting Documentation
B. Installing GDB

B.1 Compiling GDB in another directory
B.2 Specifying names for hosts and targets
B.3 configure options

C. Maintenance Commands
D. GDB Remote Serial Protocol

D.1 Overview
D.2 Packets
D.3 Stop Reply Packets
D.4 General Query Packets
D.5 Register Packet Format
D.6 Examples
D.7 File-I/O remote protocol extension

D.7.1 File-I/O Overview
D.7.2 Protocol basics
D.7.3 The F request packet
D.7.4 The F reply packet
D.7.5 Memory transfer
D.7.6 The Ctrl-C message
D.7.7 Console I/O
D.7.8 The isatty(3) call
D.7.9 The system(3) call
D.7.10 List of supported calls

open
close
read
write
lseek
rename
unlink
stat/fstat
gettimeofday
isatty
system

D.7.11 Protocol specific representation of datatypes

Integral datatypes
Pointer values
struct stat
struct timeval

D.7.12 Constants

Open flags
mode_t values
Errno values
Lseek flags
Limits

D.7.13 File-I/O Examples

E. The GDB Agent Expression Mechanism

E.1 General Bytecode Design
E.2 Bytecode Descriptions
E.3 Using Agent Expressions
E.4 Varying Target Capabilities
E.5 Tracing on Symmetrix
E.6 Rationale

F. GNU GENERAL PUBLIC LICENSE

Preamble
How to Apply These Terms to Your New Programs

G. GNU Free Documentation License

ADDENDUM: How to use this License for your documents

Index