GNU Debugger

GNU Debugger
Developer(s)	GNU Project
Initial release	1986; 38 years ago
Stable release	15.2 / 29 September 2024
Repository	sourceware.org/git/binutils-gdb.git ;
Written in	C, C++, Python
Operating system	Unix-like, Windows
Type	Debugger
License	GPLv3
Website	www.gnu.org/software/gdb

The GNU Debugger (GDB) is a portable debugger that runs on many Unix-like systems and works for many programming languages, including Ada, Assembly, C, C++, D, Fortran, Haskell, Go, Objective-C, OpenCL C, Modula-2, Pascal, Rust,^[2] and partially others.^[3]

History

GDB was first written by Richard Stallman in 1986 as part of his GNU system, after his GNU Emacs was "reasonably stable".^[4] GDB is free software released under the GNU General Public License (GPL). It was modeled after the DBX debugger, which came with Berkeley Unix distributions.^[4]

From 1990 to 1993 it was maintained by John Gilmore.^[5] Now it is maintained by the GDB Steering Committee which is appointed by the Free Software Foundation.^[6]

Technical details

Features

GDB offers extensive facilities for tracing and altering the execution of computer programs. The user can monitor and modify the values of programs' internal variables, and even call functions independently of the program's normal behavior.

GDB target processors (as of 2003) include: Alpha, ARM, AVR, H8/300, Altera Nios/Nios II, System/370, System 390, X86 and its 64-bit extension X86-64, IA-64 "Itanium", Motorola 68000, MIPS, PA-RISC, PowerPC, SuperH, SPARC, and VAX. Lesser-known target processors supported in the standard release have included A29K, ARC, ETRAX CRIS, D10V, D30V, FR-30, FR-V, Intel i960, 68HC11, Motorola 88000, MCORE, MN10200, MN10300, NS32K, Stormy16, and Z8000. (Newer releases will likely not support some of these.) GDB has compiled-in simulators for even lesser-known target processors such like M32R or V850.^[7]

GDB is still actively being developed. As of version 7.0 new features include support for Python scripting^[8] and as of version 7.8 GNU Guile scripting as well.^[9] Since version 7.0, support for "reversible debugging" — allowing a debugging session to step backward, much like rewinding a crashed program to see what happened — is available.^[10]

Remote debugging

GDB offers a "remote" mode often used when debugging embedded systems. Remote operation is when GDB runs on one machine and the program being debugged runs on another. GDB can communicate to the remote "stub" that understands GDB protocol through a serial device or TCP/IP.^[11] A stub program can be created by linking to the appropriate stub files provided with GDB, which implement the target side of the communication protocol.^[12] Alternatively, gdbserver can be used to remotely debug the program without needing to change it in any way.

The same mode is also used by KGDB for debugging a running Linux kernel on the source level with gdb. With KGDB, kernel developers can debug a kernel in much the same way as they debug application programs. It makes it possible to place breakpoints in kernel code, step through the code, and observe variables. On architectures where hardware debugging registers are available, watchpoints can be set which trigger breakpoints when specified memory addresses are executed or accessed. KGDB requires an additional machine which is connected to the machine to be debugged using a serial cable or Ethernet. On FreeBSD, it is also possible to debug using FireWire direct memory access (DMA).^[13]

Graphical user interface

The debugger does not contain its own graphical user interface, and defaults to a command-line interface, although it does contain a text user interface. Several front-ends have been built for it, such as UltraGDB, Xxgdb, Data Display Debugger (DDD), Nemiver, KDbg, the Xcode debugger, GDBtk/Insight, Gede [1], Seer [2], and HP Wildebeest Debugger GUI (WDB GUI). IDEs such as Codelite, Code::Blocks, Dev-C++, Geany, GNAT Programming Studio (GPS), KDevelop, Qt Creator, Lazarus, MonoDevelop, Eclipse, NetBeans, and Visual Studio can interface with GDB. GNU Emacs has a "GUD mode" and tools for Vim exist (e.g. clewn). These offer facilities similar to debuggers found in IDEs.

Some other debugging tools have been designed to work with GDB, such as memory leak detectors.

Internals

GDB uses a system call named ptrace (the name is an abbreviation of "process trace") to observe and control the execution of another process, and examine and change the process' memory and registers.

Common gdb commands	Corresponding ptrace calls
`(gdb) start`	PTRACE_TRACEME – makes parent a tracer (called by a tracee)
`(gdb) attach PID`	PTRACE_ATTACH – attach to a running process
`(gdb) stop`	`kill(child_pid, SIGSTOP)` (or PTRACE_INTERRUPT)
`(gdb) continue`	PTRACE_CONT
`(gdb) info registers`	PTRACE_GET(FP)REGS(ET) and PTRACE_SET(FP)REGS(ET)
`(gdb) x`	PTRACE_PEEKTEXT and PTRACE_POKETEXT

A breakpoint is implemented by replacing an instruction at a given memory address with another special instruction. Executing breakpoint instruction causes SIGTRAP.

Examples of commands

`$ gdb program`	Debug "program" (from the shell)
`(gdb) run -v`	Run the loaded program with the parameters
`(gdb) bt`	Backtrace (in case the program crashed)
`(gdb) info registers`	Dump all registers
`(gdb) disas $pc-32, $pc+32`	Disassemble

An example session

Consider the following source-code written in C:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

size_t foo_len( const char *s )
{
  return strlen( s );
}

int main( int argc, char *argv[] )
{
  const char *a = NULL;

  printf( "size of a = %lu\n", foo_len(a) );

  exit( 0 );
}

Using the GCC compiler on Linux, the code above must be compiled using the -g flag in order to include appropriate debug information on the binary generated, thus making it possible to inspect it using GDB. Assuming that the file containing the code above is named example.c, the command for the compilation could be:

$ gcc example.c -Og -g -o example

And the binary can now be run:

$ ./example
Segmentation fault

Since the example code, when executed, generates a segmentation fault, GDB can be used to inspect the problem.

$ gdb ./example
GNU gdb (GDB) Fedora (7.3.50.20110722-13.fc16)
Copyright (C) 2011 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "x86_64-redhat-linux-gnu".
For bug reporting instructions, please see:
<https://www.gnu.org/software/gdb/bugs/>...
Reading symbols from /path/example...done.
(gdb) run
Starting program: /path/example

Program received signal SIGSEGV, Segmentation fault.
0x0000000000400527 in foo_len (s=0x0) at example.c:7
7	  return strlen (s);
(gdb) print s
$1 = 0x0

The problem is present in line 7, and occurs when calling the function strlen (because its argument, s, is NULL). Depending on the implementation of strlen (inline or not), the output can be different, e.g.:

GNU gdb (GDB) 7.3.1
Copyright (C) 2011 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "i686-pc-linux-gnu".
For bug reporting instructions, please see:
<https://www.gnu.org/software/gdb/bugs/>...
Reading symbols from /tmp/gdb/example...done.
(gdb) run
Starting program: /tmp/gdb/example

Program received signal SIGSEGV, Segmentation fault.
0xb7ee94f3 in strlen () from /lib/i686/cmov/libc.so.6
(gdb) bt
#0  0xb7ee94f3 in strlen () from /lib/i686/cmov/libc.so.6
#1  0x08048435 in foo_len (s=0x0) at example.c:7
#2  0x0804845a in main (argc=<optimized out>, argv=<optimized out>) at example.c:14

To fix the problem, the variable a (in the function main) must contain a valid string. Here is a fixed version of the code:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

size_t foo_len( const char *s )
{
  return strlen(s);
}

int main( int argc, char *argv[] )
{
  const char *a = "This is a test string";

  printf( "size of a = %lu\n", foo_len(a) );

  exit( 0 );
}

Recompiling and running the executable again inside GDB now gives a correct result:

$ gdb ./example
GNU gdb (GDB) Fedora (7.3.50.20110722-13.fc16)
Copyright (C) 2011 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.  Type "show copying"
and "show warranty" for details.
This GDB was configured as "x86_64-redhat-linux-gnu".
For bug reporting instructions, please see:
<https://www.gnu.org/software/gdb/bugs/>...
Reading symbols from /path/example...done.
(gdb) run
Starting program: /path/example
size of a = 21
[Inferior 1 (process 14290) exited normally]

GDB prints the output of printf in the screen, and then informs the user that the program exited normally.

References

^ Joël Brobecker (29 September 2024). "GDB 15.2 released!". Retrieved 20 December 2024.
^ "GDB Documentation - Supported Languages". Archived from the original on 2017-12-28. Retrieved 2011-11-28.
^ "GDB Documentation - Summary". Archived from the original on 2012-07-01. Retrieved 2011-11-28.
^ ^a ^b "Richard Stallman lecture at the Royal Institute of Technology, Sweden (1986-10-30)". Retrieved 2006-09-21. Then after GNU Emacs was reasonably stable, which took all in all about a year and a half, I started getting back to other parts of the system. I developed a debugger which I called GDB which is a symbolic debugger for C code, which recently entered distribution. Now this debugger is to a large extent in the spirit of DBX, which is a debugger that comes with Berkeley Unix.
^ "John Gilmore (activist)". hyperleap.com. Archived from the original on 2021-02-26. Retrieved 2020-10-13.
^ "GDB Steering Committee". Retrieved 2008-05-11.
^ "GDB Documentation - Summary - Contributors". Archived from the original on 2011-09-29. Retrieved 2011-12-01.
^ "GDB 7.0 Release Notes". Retrieved 2011-11-28.
^ Joel Brobecker (2014-07-29). "GDB 7.8 released!". Retrieved 2014-07-30.
^ "Reverse Debugging with GDB". Retrieved 2014-01-20.
^ "Howto: GDB Remote Serial Protocol: Writing a RSP Server" (PDF).
^ "Implementing a remote stub".
^ "Kernel debugging with Dcons".

External links

Documentation

Richard M. Stallman, Roland Pesch, Stan Shebs, et al., Debugging with GDB (Free Software Foundation, 2011) ISBN 978-0-9831592-3-0
GDB Internals

Tutorials

RMS's gdb Tutorial (Ryan Michael Schmidt, not Richard Matthew Stallman)
GDB Tutorial

[wikidata-46510a22d0f247075aa99943476c67d544ad34a4-v18-1] Joël Brobecker (29 September 2024). "GDB 15.2 released!". Retrieved 20 December 2024.

[2] "GDB Documentation - Supported Languages". Archived from the original on 2017-12-28. Retrieved 2011-11-28.

[3] "GDB Documentation - Summary". Archived from the original on 2012-07-01. Retrieved 2011-11-28.

[stallman-quote-1986-4] "Richard Stallman lecture at the Royal Institute of Technology, Sweden (1986-10-30)". Retrieved 2006-09-21. Then after GNU Emacs was reasonably stable, which took all in all about a year and a half, I started getting back to other parts of the system. I developed a debugger which I called GDB which is a symbolic debugger for C code, which recently entered distribution. Now this debugger is to a large extent in the spirit of DBX, which is a debugger that comes with Berkeley Unix.

[5] "John Gilmore (activist)". hyperleap.com. Archived from the original on 2021-02-26. Retrieved 2020-10-13.

[6] "GDB Steering Committee". Retrieved 2008-05-11.

[7] "GDB Documentation - Summary - Contributors". Archived from the original on 2011-09-29. Retrieved 2011-12-01.

[8] "GDB 7.0 Release Notes". Retrieved 2011-11-28.

[9] Joel Brobecker (2014-07-29). "GDB 7.8 released!". Retrieved 2014-07-30.

[10] "Reverse Debugging with GDB". Retrieved 2014-01-20.

[11] "Howto: GDB Remote Serial Protocol: Writing a RSP Server" (PDF).

[12] "Implementing a remote stub".

[13] "Kernel debugging with Dcons".

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

v t e GNU Project
History	GNU Manifesto Free Software Foundation Europe India Latin America History of free software
Licenses	GNU General Public License linking exception font exception GNU Lesser General Public License GNU Affero General Public License GNU Free Documentation License GNAT Modified General Public License
Software	GNU (variants) Hurd Linux-libre glibc Bash coreutils findutils Build system GCC binutils GDB GRUB GNUstep GIMP Jami GNU Emacs GNU TeXmacs GNU Octave GNU Taler GNU R GSL GMP GNU Electric GNU Archimedes GNUnet GNU Privacy Guard Gnuzilla (IceCat) GNU Health GNUmed GNU LilyPond GNU Go GNU Chess Gnash Guix more...
Contributors	Benjamin Mako Hill Bradley M. Kuhn Brian Fox Federico Heinz Georg C. F. Greve John Sullivan Nagarjuna G. Richard M. Stallman
Other topics	GNU/Linux naming controversy Revolution OS Free Software Foundation anti-Windows campaigns Defective by Design