Previous: Remote Configuration, Up: Remote Debugging

20.5 Implementing a Remote Stub

The stub files provided with gdb implement the target side of the communication protocol, and the gdb side is implemented in the gdb source file remote.c. Normally, you can simply allow these subroutines to communicate, and ignore the details. (If you're implementing your own stub file, you can still ignore the details: start with one of the existing stub files. sparc-stub.c is the best organized, and therefore the easiest to read.)

To debug a program running on another machine (the debugging target machine), you must first arrange for all the usual prerequisites for the program to run by itself. For example, for a C program, you need:

  1. A startup routine to set up the C runtime environment; these usually have a name like crt0. The startup routine may be supplied by your hardware supplier, or you may have to write your own.
  2. A C subroutine library to support your program's subroutine calls, notably managing input and output.
  3. A way of getting your program to the other machine—for example, a download program. These are often supplied by the hardware manufacturer, but you may have to write your own from hardware documentation.

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). In general terms, the scheme looks like this:

On the host,
gdb already understands how to use this protocol; when everything else is set up, you can simply use the ‘target remote’ command (see Specifying a Debugging Target).
On the target,
you must link with your program a few special-purpose subroutines that implement the gdb remote serial protocol. The file containing these subroutines is called a debugging stub.

On certain remote targets, you can use an auxiliary program gdbserver instead of linking a stub into your program. See Using the gdbserver Program, for details.

The debugging stub is specific to the architecture of the remote machine; for example, use sparc-stub.c to debug programs on sparc boards.

These working remote stubs are distributed with gdb:

i386-stub.c
For Intel 386 and compatible architectures.
m68k-stub.c
For Motorola 680x0 architectures.
sh-stub.c
For Renesas SH architectures.
sparc-stub.c
For sparc architectures.
sparcl-stub.c
For Fujitsu sparclite architectures.

The README file in the gdb distribution may list other recently added stubs.