MAN page from OpenSuSE cross-avr-gdb-7.9.1-3.1.x86_64.rpm


Section: GNU Development Tools (1)
Updated: 2017-10-25


gdbserver - Remote Server for the GNU Debugger 


gdbserver comm prog [args...]

gdbserver --attach comm pid

gdbserver --multi comm 


gdbserver is a program that allows you to run GDB on a different machinethan the one which is running the program being debugged.

Usage (server (target) side):

First, you need to have a copy of the program you want to debug put ontothe target system. The program can be stripped to save space if needed, asgdbserver doesn't care about symbols. All symbol handling is taken care of bythe GDB running on the host system.

To use the server, you log on to the target system, and run the gdbserverprogram. You must tell it (a) how to communicate with GDB, (b) the name ofyour program, and (c) its arguments. The general syntax is:

        target> gdbserver <comm> <program> [<args> ...]

For example, using a serial port, you might say:

        target> gdbserver /dev/com1 emacs foo.txt

This tells gdbserver to debug emacs with an argument of foo.txt, andto communicate with GDB via /dev/com1. gdbserver nowwaits patiently for the host GDB to communicate with it.

To use a TCP connection, you could say:

        target> gdbserver host:2345 emacs foo.txt

This says pretty much the same thing as the last example, except that we aregoing to communicate with the "host" GDB via TCP. The "host:2345" argument meansthat we are expecting to see a TCP connection from "host" to local TCP port2345. (Currently, the "host" part is ignored.) You can choose any number youwant for the port number as long as it does not conflict with any existing TCPports on the target system. This same port number must be used in the hostGDBs "target remote" command, which will be described shortly. Note that ifyou chose a port number that conflicts with another service, gdbserver willprint an error message and exit.

gdbserver can also attach to running programs.This is accomplished via the --attach argument. The syntax is:

        target> gdbserver --attach <comm> <pid>

pid is the process ID of a currently running process. It isn'tnecessary to point gdbserver at a binary for the running process.

To start "gdbserver" without supplying an initial command to runor process ID to attach, use the --multi command line option.In such case you should connect using "target extended-remote" to startthe program you want to debug.

        target> gdbserver --multi <comm>

Usage (host side):

You need an unstripped copy of the target program on your host system, sinceGDB needs to examine it's symbol tables and such. Start up GDB as you normallywould, with the target program as the first argument. (You may need to use the--baud option if the serial line is running at anything except 9600 baud.)That is "gdb TARGET-PROG", or "gdb --baud BAUD TARGET-PROG". After that, the onlynew command you need to know about is "target remote"(or "target extended-remote"). Its argument is eithera device name (usually a serial device, like /dev/ttyb), or a "HOST:PORT"descriptor. For example:

        (gdb) target remote /dev/ttyb

communicates with the server via serial line /dev/ttyb, and:

        (gdb) target remote the-target:2345

communicates via a TCP connection to port 2345 on host `the-target', whereyou previously started up gdbserver with the same port number. Note that forTCP connections, you must start up gdbserver prior to using the `target remote'command, otherwise you may get an error that looks something like`Connection refused'.

gdbserver can also debug multiple inferiors at once,described inthe GDB manual in node "Inferiors and Programs"--- shell command "info -f gdb -n 'Inferiors and Programs'".In such case use the "extended-remote" GDB command variant:

        (gdb) target extended-remote the-target:2345

The gdbserver option --multi may or may not be used in suchcase. 


There are three different modes for invoking gdbserver:
Debug a specific program specified by its program name:

        gdbserver <comm> <prog> [<args>...]

The comm parameter specifies how should the server communicatewith GDB; it is either a device name (to use a serial line),a TCP port number (":1234"), or "-" or "stdio" to usestdin/stdout of "gdbserver". Specify the name of the program todebug in prog. Any remaining arguments will be passed to theprogram verbatim. When the program exits, GDB will close theconnection, and "gdbserver" will exit.

Debug a specific program by specifying the process ID of a runningprogram:

        gdbserver --attach <comm> <pid>

The comm parameter is as described above. Supply the process IDof a running program in pid; GDB will do everythingelse. Like with the previous mode, when the process pid exits,GDB will close the connection, and "gdbserver" will exit.

Multi-process mode --- debug more than one program/process:

        gdbserver --multi <comm>

In this mode, GDB can instruct gdbserver whichcommand(s) to run. Unlike the other 2 modes, GDB will notclose the connection when a process being debugged exits, so you candebug several processes in the same session.

In each of the modes you may specify these options:

List all options, with brief explanations.
This option causes gdbserver to print its version number and exit.
gdbserver will attach to a running program. The syntax is:

        target> gdbserver --attach <comm> <pid>

pid is the process ID of a currently running process. It isn'tnecessary to point gdbserver at a binary for the running process.

To start "gdbserver" without supplying an initial command to runor process ID to attach, use this command line option.Then you can connect using "target extended-remote" and startthe program you want to debug. The syntax is:

        target> gdbserver --multi <comm>
Instruct "gdbserver" to display extra status information about the debuggingprocess.This option is intended for "gdbserver" development and for bug reports tothe developers.
Instruct "gdbserver" to display remote protocol debug output.This option is intended for "gdbserver" development and for bug reports tothe developers.
Instruct "gdbserver" to include extra information in each lineof debugging output.
Specify a wrapper to launch programsfor debugging. The option should be followed by the name of thewrapper, then any command-line arguments to pass to the wrapper, then"--" indicating the end of the wrapper arguments.
By default, gdbserver keeps the listening TCP port open, so thatadditional connections are possible. However, if you start "gdbserver"with the --once option, it will stop listening for any furtherconnection attempts after connecting to the first GDB session.


The full documentation for GDB is maintained as a Texinfo manual.If the "info" and "gdb" programs and GDB's Texinfodocumentation are properly installed at your site, the command

        info gdb

should give you access to the complete manual.

Using GDB: A Guide to the GNU Source-Level Debugger,Richard M. Stallman and Roland H. Pesch, July 1991. 


Copyright (c) 1988-2015 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this documentunder the terms of the GNU Free Documentation License, Version 1.3 orany later version published by the Free Software Foundation; with theInvariant Sections being ``Free Software'' and ``Free Software NeedsFree 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 modifythis GNU Manual. Buying copies from GNU Press supports the FSF indeveloping GNU and promoting software freedom.''




This document was created byman2html,using the manual pages.