2010-06-07 15:42:49 +08:00
|
|
|
|
README for GDB release
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
This is GDB, the GNU source-level debugger.
|
|
|
|
|
|
2002-04-08 03:09:58 +08:00
|
|
|
|
A summary of new features is in the file `gdb/NEWS'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2002-04-26 07:26:23 +08:00
|
|
|
|
Check the GDB home page at http://www.gnu.org/software/gdb/ for up to
|
|
|
|
|
date release information, mailing list links and archives, etc.
|
2002-04-08 03:09:58 +08:00
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
GDB's bug tracking data base can be found at
|
|
|
|
|
http://www.gnu.org/software/gdb/bugs/
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
Unpacking and Installation -- quick overview
|
|
|
|
|
==========================
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
The release is provided as a gzipped tar file called
|
|
|
|
|
'gdb-VERSION.tar.gz', where VERSION is the version of GDB.
|
|
|
|
|
|
|
|
|
|
The GDB debugger sources, the generic GNU include
|
1999-04-16 09:35:26 +08:00
|
|
|
|
files, the BFD ("binary file description") library, the readline
|
|
|
|
|
library, and other libraries all have directories of their own
|
2010-06-07 15:42:49 +08:00
|
|
|
|
underneath the gdb-VERSION directory. The idea is that a variety of GNU
|
1999-04-16 09:35:26 +08:00
|
|
|
|
tools can share a common copy of these things. Be aware of variation
|
2010-05-03 00:10:03 +08:00
|
|
|
|
over time--for example don't try to build GDB with a copy of bfd from
|
|
|
|
|
a release other than the GDB release (such as a binutils release),
|
2001-10-31 10:53:17 +08:00
|
|
|
|
especially if the releases are more than a few weeks apart.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
Configuration scripts and makefiles exist to cruise up and down this
|
|
|
|
|
directory tree and automatically build all the pieces in the right
|
|
|
|
|
order.
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
When you unpack the gdb-VERSION.tar.gz file, it will create a
|
|
|
|
|
source directory called `gdb-VERSION'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-12-22 23:03:10 +08:00
|
|
|
|
You can build GDB right in the source directory:
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
cd gdb-VERSION
|
2018-09-14 12:24:07 +08:00
|
|
|
|
./configure --prefix=/usr/local (or wherever you want)
|
|
|
|
|
make all install
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-12-22 23:03:10 +08:00
|
|
|
|
However, we recommend that an empty directory be used instead.
|
|
|
|
|
This way you do not clutter your source tree with binary files
|
2022-09-28 21:58:51 +08:00
|
|
|
|
and will be able to create different builds with different
|
2000-12-22 23:03:10 +08:00
|
|
|
|
configuration options.
|
|
|
|
|
|
|
|
|
|
You can build GDB in any empty build directory:
|
|
|
|
|
|
2001-10-31 10:53:17 +08:00
|
|
|
|
mkdir build
|
|
|
|
|
cd build
|
2018-09-14 12:24:07 +08:00
|
|
|
|
<full path to your sources>/gdb-VERSION/configure [etc...]
|
|
|
|
|
make all install
|
2000-12-22 23:03:10 +08:00
|
|
|
|
|
2000-04-13 00:51:27 +08:00
|
|
|
|
(Building GDB with DJGPP tools for MS-DOS/MS-Windows is slightly
|
2010-06-07 15:42:49 +08:00
|
|
|
|
different; see the file gdb-VERSION/gdb/config/djgpp/README for details.)
|
2000-04-13 00:51:27 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
This will configure and build all the libraries as well as GDB. If
|
|
|
|
|
`configure' can't determine your system type, specify one as its
|
|
|
|
|
argument, e.g., `./configure sun4' or `./configure decstation'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
Make sure that your 'configure' line ends in 'gdb-VERSION/configure':
|
2003-01-19 01:43:14 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
/berman/migchain/source/gdb-VERSION/configure # RIGHT
|
|
|
|
|
/berman/migchain/source/gdb-VERSION/gdb/configure # WRONG
|
2003-01-19 01:43:14 +08:00
|
|
|
|
|
2010-05-03 00:10:03 +08:00
|
|
|
|
The GDB package contains several subdirectories, such as 'gdb',
|
2003-01-19 01:43:14 +08:00
|
|
|
|
'bfd', and 'readline'. If your 'configure' line ends in
|
2010-06-07 15:42:49 +08:00
|
|
|
|
'gdb-VERSION/gdb/configure', then you are configuring only the gdb
|
2010-05-03 00:10:03 +08:00
|
|
|
|
subdirectory, not the whole GDB package. This leads to build errors
|
2003-01-19 01:43:14 +08:00
|
|
|
|
such as:
|
|
|
|
|
|
|
|
|
|
make: *** No rule to make target `../bfd/bfd.h', needed by `gdb.o'. Stop.
|
|
|
|
|
|
|
|
|
|
If you get other compiler errors during this stage, see the `Reporting
|
2000-05-11 15:55:25 +08:00
|
|
|
|
Bugs' section below; there are a few known problems.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
GDB's `configure' script has many options to enable or disable
|
|
|
|
|
different features or dependencies. These options are not generally
|
|
|
|
|
known to the top-level `configure', so if you want to see a complete
|
|
|
|
|
list of options, invoke the subdirectory `configure', like:
|
|
|
|
|
|
|
|
|
|
/berman/migchain/source/gdb-VERSION/gdb/configure --help
|
|
|
|
|
|
|
|
|
|
(Take note of how this differs from the invocation used to actually
|
|
|
|
|
configure the build tree.)
|
|
|
|
|
|
2023-09-12 20:34:51 +08:00
|
|
|
|
GDB requires a C++17 compiler. If you do not have a
|
|
|
|
|
C++17 compiler for your system, you may be able to download and install
|
2001-10-31 10:53:17 +08:00
|
|
|
|
the GNU CC compiler. It is available via anonymous FTP from the
|
2007-03-30 20:58:13 +08:00
|
|
|
|
directory `ftp://ftp.gnu.org/pub/gnu/gcc'. GDB also requires an ISO
|
2010-05-03 00:10:03 +08:00
|
|
|
|
C standard library. The GDB remote server, GDBserver, builds with some
|
2007-03-30 20:58:13 +08:00
|
|
|
|
non-ISO standard libraries - e.g. for Windows CE.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
GDB can optionally be built against various external libraries.
|
|
|
|
|
These dependencies are described below in the "`configure options"
|
|
|
|
|
section of this README.
|
2017-11-22 20:53:43 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
GDB can be used as a cross-debugger, running on a machine of one
|
|
|
|
|
type while debugging a program running on a machine of another type.
|
|
|
|
|
See below.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
More Documentation
|
|
|
|
|
******************
|
|
|
|
|
|
|
|
|
|
All the documentation for GDB comes as part of the machine-readable
|
2000-05-11 15:55:25 +08:00
|
|
|
|
distribution. The documentation is written in Texinfo format, which
|
|
|
|
|
is a documentation system that uses a single source file to produce
|
|
|
|
|
both on-line information and a printed manual. You can use one of the
|
|
|
|
|
Info formatting commands to create the on-line version of the
|
|
|
|
|
documentation and TeX (or `texi2roff') to typeset the printed version.
|
|
|
|
|
|
|
|
|
|
GDB includes an already formatted copy of the on-line Info version
|
|
|
|
|
of this manual in the `gdb/doc' subdirectory. The main Info file is
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/gdb/doc/gdb.info', and it refers to subordinate files
|
2000-05-11 15:55:25 +08:00
|
|
|
|
matching `gdb.info*' in the same directory. If necessary, you can
|
|
|
|
|
print out these files, or read them with any editor; but they are
|
|
|
|
|
easier to read using the `info' subsystem in GNU Emacs or the
|
|
|
|
|
standalone `info' program, available as part of the GNU Texinfo
|
|
|
|
|
distribution.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
If you want to format these Info files yourself, you need one of the
|
|
|
|
|
Info formatting programs, such as `texinfo-format-buffer' or
|
|
|
|
|
`makeinfo'.
|
|
|
|
|
|
|
|
|
|
If you have `makeinfo' installed, and are in the top level GDB
|
2010-06-07 15:42:49 +08:00
|
|
|
|
source directory (`gdb-VERSION'), you can make the Info file by
|
|
|
|
|
typing:
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2001-10-31 10:53:17 +08:00
|
|
|
|
cd gdb/doc
|
|
|
|
|
make info
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
If you want to typeset and print copies of this manual, you need
|
|
|
|
|
TeX, a program to print its DVI output files, and `texinfo.tex', the
|
|
|
|
|
Texinfo definitions file. This file is included in the GDB
|
2010-06-07 15:42:49 +08:00
|
|
|
|
distribution, in the directory `gdb-VERSION/texinfo'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
TeX is a typesetting program; it does not print files directly, but
|
|
|
|
|
produces output files called DVI files. To print a typeset document,
|
|
|
|
|
you need a program to print DVI files. If your system has TeX
|
|
|
|
|
installed, chances are it has such a program. The precise command to
|
|
|
|
|
use depends on your system; `lpr -d' is common; another (for PostScript
|
|
|
|
|
devices) is `dvips'. The DVI print command may require a file name
|
|
|
|
|
without any extension or a `.dvi' extension.
|
|
|
|
|
|
2022-09-28 21:58:51 +08:00
|
|
|
|
TeX also requires a macro definitions file called `texinfo.tex'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
This file tells TeX how to typeset a document written in Texinfo
|
|
|
|
|
format. On its own, TeX cannot read, much less typeset a Texinfo file.
|
|
|
|
|
`texinfo.tex' is distributed with GDB and is located in the
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/texinfo' directory.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
If you have TeX and a DVI printer program installed, you can typeset
|
2011-04-20 02:04:11 +08:00
|
|
|
|
and print this manual. First switch to the `gdb' subdirectory of
|
2010-06-07 15:42:49 +08:00
|
|
|
|
the main source directory (for example, to `gdb-VERSION/gdb') and then type:
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2001-10-31 10:53:17 +08:00
|
|
|
|
make doc/gdb.dvi
|
2001-07-25 22:58:38 +08:00
|
|
|
|
|
|
|
|
|
If you prefer to have the manual in PDF format, type this from the
|
|
|
|
|
`gdb/doc' subdirectory of the main source directory:
|
|
|
|
|
|
2001-10-31 10:53:17 +08:00
|
|
|
|
make gdb.pdf
|
2001-07-25 22:58:38 +08:00
|
|
|
|
|
|
|
|
|
For this to work, you will need the PDFTeX package to be installed.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installing GDB
|
|
|
|
|
**************
|
|
|
|
|
|
|
|
|
|
GDB comes with a `configure' script that automates the process of
|
|
|
|
|
preparing GDB for installation; you can then use `make' to build the
|
|
|
|
|
`gdb' program.
|
|
|
|
|
|
|
|
|
|
The GDB distribution includes all the source code you need for GDB in
|
2010-06-07 15:42:49 +08:00
|
|
|
|
a single directory. That directory contains:
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/{COPYING,COPYING.LIB}'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
Standard GNU license files. Please read them.
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/bfd'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
source for the Binary File Descriptor library
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/config*'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
script for configuring GDB, along with other support files
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/gdb'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
the source specific to GDB itself
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/include'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
GNU include files
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/libiberty'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
source for the `-liberty' free software library
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/opcodes'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
source for the library of opcode tables and disassemblers
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/readline'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
source for the GNU command-line interface
|
1999-04-27 02:34:20 +08:00
|
|
|
|
NOTE: The readline library is compiled for use by GDB, but will
|
|
|
|
|
not be installed on your system when "make install" is issued.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/sim'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
source for some simulators (ARM, D10V, SPARC, M32R, MIPS, PPC, V850, etc)
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/texinfo'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
The `texinfo.tex' file, which you need in order to make a printed
|
|
|
|
|
manual using TeX.
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`gdb-VERSION/etc'
|
1999-04-16 09:35:26 +08:00
|
|
|
|
Coding standards, useful files for editing GDB, and other
|
|
|
|
|
miscellanea.
|
|
|
|
|
|
2000-04-13 00:51:27 +08:00
|
|
|
|
Note: the following instructions are for building GDB on Unix or
|
|
|
|
|
Unix-like systems. Instructions for building with DJGPP for
|
|
|
|
|
MS-DOS/MS-Windows are in the file gdb/config/djgpp/README.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
The simplest way to configure and build GDB is to run `configure'
|
2010-06-07 15:42:49 +08:00
|
|
|
|
from the `gdb-VERSION' directory.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
First switch to the `gdb-VERSION' source directory if you are
|
1999-04-16 09:35:26 +08:00
|
|
|
|
not already in it; then run `configure'.
|
|
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
cd gdb-VERSION
|
2001-10-31 10:53:17 +08:00
|
|
|
|
./configure
|
|
|
|
|
make
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
Running `configure' followed by `make' builds the `bfd',
|
|
|
|
|
`readline', `mmalloc', and `libiberty' libraries, then `gdb' itself.
|
|
|
|
|
The configured source files, and the binaries, are left in the
|
|
|
|
|
corresponding source directories.
|
|
|
|
|
|
|
|
|
|
`configure' is a Bourne-shell (`/bin/sh') script; if your system
|
|
|
|
|
does not recognize this automatically when you run a different shell,
|
|
|
|
|
you may need to run `sh' on it explicitly:
|
|
|
|
|
|
2001-10-31 10:53:17 +08:00
|
|
|
|
sh configure
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
If you run `configure' from a directory that contains source
|
2010-06-07 15:42:49 +08:00
|
|
|
|
directories for multiple libraries or programs, `configure' creates
|
|
|
|
|
configuration files for every directory level underneath (unless
|
|
|
|
|
you tell it not to, with the `--norecursion' option).
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
You can install `gdb' anywhere; it has no hardwired paths. However,
|
|
|
|
|
you should make sure that the shell on your path (named by the `SHELL'
|
|
|
|
|
environment variable) is publicly readable. Remember that GDB uses the
|
|
|
|
|
shell to start your program--some systems refuse to let GDB debug child
|
|
|
|
|
processes whose programs are not readable.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Compiling GDB in another directory
|
|
|
|
|
==================================
|
|
|
|
|
|
|
|
|
|
If you want to run GDB versions for several host or target machines,
|
|
|
|
|
you need a different `gdb' compiled for each combination of host and
|
|
|
|
|
target. `configure' is designed to make this easy by allowing you to
|
|
|
|
|
generate each configuration in a separate subdirectory, rather than in
|
|
|
|
|
the source directory. If your `make' program handles the `VPATH'
|
|
|
|
|
feature correctly (GNU `make' and SunOS 'make' are two that should),
|
|
|
|
|
running `make' in each of these directories builds the `gdb' program
|
|
|
|
|
specified there.
|
|
|
|
|
|
|
|
|
|
To build `gdb' in a separate directory, run `configure' with the
|
|
|
|
|
`--srcdir' option to specify where to find the source. (You also need
|
|
|
|
|
to specify a path to find `configure' itself from your working
|
|
|
|
|
directory. If the path to `configure' would be the same as the
|
|
|
|
|
argument to `--srcdir', you can leave out the `--srcdir' option; it
|
|
|
|
|
will be assumed.)
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
For example, you can build GDB in a separate
|
1999-04-16 09:35:26 +08:00
|
|
|
|
directory for a Sun 4 like this:
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
cd gdb-VERSION
|
1999-04-16 09:35:26 +08:00
|
|
|
|
mkdir ../gdb-sun4
|
|
|
|
|
cd ../gdb-sun4
|
2010-06-07 15:42:49 +08:00
|
|
|
|
../gdb-VERSION/configure
|
1999-04-16 09:35:26 +08:00
|
|
|
|
make
|
|
|
|
|
|
|
|
|
|
When `configure' builds a configuration using a remote source
|
|
|
|
|
directory, it creates a tree for the binaries with the same structure
|
|
|
|
|
(and using the same names) as the tree under the source directory. In
|
|
|
|
|
the example, you'd find the Sun 4 library `libiberty.a' in the
|
|
|
|
|
directory `gdb-sun4/libiberty', and GDB itself in `gdb-sun4/gdb'.
|
|
|
|
|
|
|
|
|
|
One popular reason to build several GDB configurations in separate
|
|
|
|
|
directories is to configure GDB for cross-compiling (where GDB runs on
|
|
|
|
|
one machine--the host--while debugging programs that run on another
|
|
|
|
|
machine--the target). You specify a cross-debugging target by giving
|
|
|
|
|
the `--target=TARGET' option to `configure'.
|
|
|
|
|
|
|
|
|
|
When you run `make' to build a program or library, you must run it
|
|
|
|
|
in a configured directory--whatever directory you were in when you
|
|
|
|
|
called `configure' (or one of its subdirectories).
|
|
|
|
|
|
|
|
|
|
The `Makefile' that `configure' generates in each source directory
|
|
|
|
|
also runs recursively. If you type `make' in a source directory such
|
2010-06-07 15:42:49 +08:00
|
|
|
|
as `gdb-VERSION' (or in a separate configured directory configured with
|
|
|
|
|
`--srcdir=PATH/gdb-VERSION'), you will build all the required libraries,
|
1999-04-16 09:35:26 +08:00
|
|
|
|
and then build GDB.
|
|
|
|
|
|
|
|
|
|
When you have multiple hosts or targets configured in separate
|
|
|
|
|
directories, you can run `make' on them in parallel (for example, if
|
|
|
|
|
they are NFS-mounted on each of the hosts); they will not interfere
|
|
|
|
|
with each other.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Specifying names for hosts and targets
|
|
|
|
|
======================================
|
|
|
|
|
|
|
|
|
|
The specifications used for hosts and targets in the `configure'
|
|
|
|
|
script are based on a three-part naming scheme, but some short
|
|
|
|
|
predefined aliases are also supported. The full naming scheme encodes
|
|
|
|
|
three pieces of information in the following pattern:
|
|
|
|
|
|
|
|
|
|
ARCHITECTURE-VENDOR-OS
|
|
|
|
|
|
|
|
|
|
For example, you can use the alias `sun4' as a HOST argument or in a
|
|
|
|
|
`--target=TARGET' option. The equivalent full name is
|
|
|
|
|
`sparc-sun-sunos4'.
|
|
|
|
|
|
|
|
|
|
The `configure' script accompanying GDB does not provide any query
|
2022-09-28 21:58:51 +08:00
|
|
|
|
facility to list all supported host and target names or aliases.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
`configure' calls the Bourne shell script `config.sub' to map
|
|
|
|
|
abbreviations to full names; you can read the script, if you wish, or
|
|
|
|
|
you can use it to test your guesses on abbreviations--for example:
|
|
|
|
|
|
|
|
|
|
% sh config.sub sun4
|
|
|
|
|
sparc-sun-sunos4.1.1
|
|
|
|
|
% sh config.sub sun3
|
|
|
|
|
m68k-sun-sunos4.1.1
|
|
|
|
|
% sh config.sub decstation
|
|
|
|
|
mips-dec-ultrix4.2
|
|
|
|
|
% sh config.sub hp300bsd
|
|
|
|
|
m68k-hp-bsd
|
|
|
|
|
% sh config.sub i386v
|
|
|
|
|
i386-pc-sysv
|
|
|
|
|
% sh config.sub i786v
|
|
|
|
|
Invalid configuration `i786v': machine `i786v' not recognized
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
`config.sub' is also distributed in the GDB source directory.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
`configure' options
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
Here is a summary of the `configure' options and arguments that are
|
|
|
|
|
most often useful for building GDB. `configure' also has several other
|
2018-09-14 12:24:07 +08:00
|
|
|
|
options not listed here. There are many options to gdb's `configure'
|
|
|
|
|
script, some of which are only useful in special situation.
|
|
|
|
|
*note : (autoconf.info)Running configure scripts, for a full
|
|
|
|
|
explanation of `configure'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
configure [--help]
|
|
|
|
|
[--prefix=DIR]
|
|
|
|
|
[--srcdir=PATH]
|
|
|
|
|
[--target=TARGET]
|
|
|
|
|
[--host=HOST]
|
|
|
|
|
[HOST]
|
|
|
|
|
|
|
|
|
|
You may introduce options with a single `-' rather than `--' if you
|
2018-09-14 12:24:07 +08:00
|
|
|
|
prefer; but you may abbreviate option names if you use `--'. Some
|
|
|
|
|
more obscure GDB `configure' options are not listed here.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
`--help'
|
|
|
|
|
Display a quick summary of how to invoke `configure'.
|
|
|
|
|
|
|
|
|
|
`-prefix=DIR'
|
|
|
|
|
Configure the source to install programs and files under directory
|
|
|
|
|
`DIR'.
|
|
|
|
|
|
|
|
|
|
`--srcdir=PATH'
|
|
|
|
|
*Warning: using this option requires GNU `make', or another `make'
|
|
|
|
|
that compatibly implements the `VPATH' feature.*
|
|
|
|
|
Use this option to make configurations in directories separate
|
|
|
|
|
from the GDB source directories. Among other things, you can use
|
|
|
|
|
this to build (or maintain) several configurations simultaneously,
|
|
|
|
|
in separate directories. `configure' writes configuration
|
|
|
|
|
specific files in the current directory, but arranges for them to
|
|
|
|
|
use the source in the directory PATH. `configure' will create
|
|
|
|
|
directories under the working directory in parallel to the source
|
|
|
|
|
directories below PATH.
|
|
|
|
|
|
2009-05-23 21:18:38 +08:00
|
|
|
|
`--host=HOST'
|
|
|
|
|
Configure GDB to run on the specified HOST.
|
|
|
|
|
|
|
|
|
|
There is no convenient way to generate a list of all available
|
|
|
|
|
hosts.
|
|
|
|
|
|
|
|
|
|
`HOST ...'
|
|
|
|
|
Same as `--host=HOST'. If you omit this, GDB will guess; it's
|
|
|
|
|
quite accurate.
|
|
|
|
|
|
1999-04-16 09:35:26 +08:00
|
|
|
|
`--target=TARGET'
|
|
|
|
|
Configure GDB for cross-debugging programs running on the specified
|
|
|
|
|
TARGET. Without this option, GDB is configured to debug programs
|
|
|
|
|
that run on the same machine (HOST) as GDB itself.
|
|
|
|
|
|
|
|
|
|
There is no convenient way to generate a list of all available
|
|
|
|
|
targets.
|
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
`--enable-targets=TARGET,TARGET,...'
|
|
|
|
|
`--enable-targets=all`
|
|
|
|
|
Configure GDB for cross-debugging programs running on the
|
|
|
|
|
specified list of targets. The special value `all' configures
|
|
|
|
|
GDB for debugging programs running on any target it supports.
|
|
|
|
|
|
2009-04-24 05:28:20 +08:00
|
|
|
|
`--with-gdb-datadir=PATH'
|
|
|
|
|
Set the GDB-specific data directory. GDB will look here for
|
|
|
|
|
certain supporting files or scripts. This defaults to the `gdb'
|
|
|
|
|
subdirectory of `datadir' (which can be set using `--datadir').
|
|
|
|
|
|
2009-05-23 21:18:38 +08:00
|
|
|
|
`--with-relocated-sources=DIR'
|
|
|
|
|
Sets up the default source path substitution rule so that
|
|
|
|
|
directory names recorded in debug information will be
|
|
|
|
|
automatically adjusted for any directory under DIR. DIR should
|
|
|
|
|
be a subdirectory of GDB's configured prefix, the one mentioned
|
|
|
|
|
in the `--prefix' or `--exec-prefix' options to configure. This
|
|
|
|
|
option is useful if GDB is supposed to be moved to a different
|
|
|
|
|
place after it is built.
|
|
|
|
|
|
|
|
|
|
`--enable-64-bit-bfd'
|
|
|
|
|
Enable 64-bit support in BFD on 32-bit hosts.
|
|
|
|
|
|
|
|
|
|
`--disable-gdbmi'
|
|
|
|
|
Build GDB without the GDB/MI machine interface.
|
|
|
|
|
|
|
|
|
|
`--enable-tui'
|
|
|
|
|
Build GDB with the text-mode full-screen user interface (TUI).
|
|
|
|
|
Requires a curses library (ncurses and cursesX are also
|
|
|
|
|
supported).
|
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
`--with-curses'
|
|
|
|
|
Use the curses library instead of the termcap library, for
|
|
|
|
|
text-mode terminal operations.
|
2009-05-23 21:18:38 +08:00
|
|
|
|
|
2020-02-27 06:40:49 +08:00
|
|
|
|
`--with-debuginfod'
|
|
|
|
|
Build GDB with libdebuginfod, the debuginfod client library. Used
|
|
|
|
|
to automatically fetch source files and separate debug files from
|
|
|
|
|
debuginfod servers using the associated executable's build ID.
|
|
|
|
|
Enabled by default if libdebuginfod is installed and found at
|
|
|
|
|
configure time. debuginfod is packaged with elfutils, starting
|
|
|
|
|
with version 0.178. You can get the latest version from
|
|
|
|
|
'https://sourceware.org/elfutils/'.
|
|
|
|
|
|
2012-03-09 03:08:11 +08:00
|
|
|
|
`--with-libunwind-ia64'
|
|
|
|
|
Use the libunwind library for unwinding function call stack on ia64
|
|
|
|
|
target platforms.
|
|
|
|
|
See http://www.nongnu.org/libunwind/index.html for details.
|
2009-05-23 21:18:38 +08:00
|
|
|
|
|
|
|
|
|
`--with-system-readline'
|
|
|
|
|
Use the readline library installed on the host, rather than the
|
2019-04-22 03:58:49 +08:00
|
|
|
|
library supplied as part of GDB. Readline 7 or newer is required;
|
|
|
|
|
this is enforced by the build system.
|
2009-05-23 21:18:38 +08:00
|
|
|
|
|
2024-05-09 17:46:38 +08:00
|
|
|
|
`--with-system-zlib'
|
2018-09-14 12:24:07 +08:00
|
|
|
|
Use the zlib library installed on the host, rather than the
|
2018-09-30 20:00:01 +08:00
|
|
|
|
library supplied as part of GDB.
|
2018-09-14 12:24:07 +08:00
|
|
|
|
|
2009-05-23 21:18:38 +08:00
|
|
|
|
`--with-expat'
|
2018-09-14 12:24:07 +08:00
|
|
|
|
Build GDB with Expat, a library for XML parsing. (Done by
|
|
|
|
|
default if libexpat is installed and found at configure time.)
|
|
|
|
|
This library is used to read XML files supplied with GDB. If it
|
|
|
|
|
is unavailable, some features, such as remote protocol memory
|
|
|
|
|
maps, target descriptions, and shared library lists, that are
|
|
|
|
|
based on XML files, will not be available in GDB. If your host
|
|
|
|
|
does not have libexpat installed, you can get the latest version
|
|
|
|
|
from `http://expat.sourceforge.net'.
|
|
|
|
|
|
|
|
|
|
`--with-libiconv-prefix[=DIR]'
|
|
|
|
|
Build GDB with GNU libiconv, a character set encoding conversion
|
|
|
|
|
library. This is not done by default, as on GNU systems the
|
|
|
|
|
`iconv' that is built in to the C library is sufficient. If your
|
|
|
|
|
host does not have a working `iconv', you can get the latest
|
|
|
|
|
version of GNU iconv from `https://www.gnu.org/software/libiconv/'.
|
|
|
|
|
|
|
|
|
|
GDB's build system also supports building GNU libiconv as part of
|
|
|
|
|
the overall build. See the GDB manual instructions on how to do
|
|
|
|
|
this.
|
|
|
|
|
|
|
|
|
|
`--with-lzma'
|
|
|
|
|
Build GDB with LZMA, a compression library. (Done by default if
|
|
|
|
|
liblzma is installed and found at configure time.) LZMA is used
|
|
|
|
|
by GDB's "mini debuginfo" feature, which is only useful on
|
|
|
|
|
platforms using the ELF object file format. If your host does
|
|
|
|
|
not have liblzma installed, you can get the latest version from
|
|
|
|
|
`https://tukaani.org/xz/'.
|
2009-05-23 21:18:38 +08:00
|
|
|
|
|
2022-11-08 15:57:18 +08:00
|
|
|
|
`--with-gmp=DIR'
|
|
|
|
|
`--with-gmp-lib=LIBDIR'
|
|
|
|
|
`--with-gmp-include=INCDIR'
|
2020-11-24 11:09:23 +08:00
|
|
|
|
Build GDB using the GMP library installed at the directory DIR.
|
|
|
|
|
If your host does not have GMP installed, you can get the latest
|
|
|
|
|
version at `https://gmplib.org/'.
|
2022-11-08 15:57:18 +08:00
|
|
|
|
The `--with-gmp=gmpinstalldir` option is shorthand for
|
|
|
|
|
`--with-gmp-lib=gmpinstalldir/lib` and
|
|
|
|
|
`--with-gmp-include=gmpinstalldir/include`.
|
|
|
|
|
|
|
|
|
|
`--with-mpfr=DIR'
|
|
|
|
|
`--with-mpfr-lib=LIBDIR'
|
|
|
|
|
`--with-mpfr-include=INCDIR'
|
|
|
|
|
Build GDB using GNU MPFR installed at the directory DIR,
|
|
|
|
|
a library for multiple-precision floating-point computation
|
|
|
|
|
with correct rounding.
|
2018-09-14 12:24:07 +08:00
|
|
|
|
This library is used to emulate target floating-point arithmetic
|
|
|
|
|
during expression evaluation when the target uses different
|
2022-11-08 15:57:18 +08:00
|
|
|
|
floating-point formats than the host.
|
|
|
|
|
If your host does not have GNU MPFR installed, you
|
2020-11-24 11:10:06 +08:00
|
|
|
|
can get the latest version from `https://www.mpfr.org/'.
|
2018-09-14 12:24:07 +08:00
|
|
|
|
|
2022-11-08 15:57:18 +08:00
|
|
|
|
The `--with-mpfr=mpfrinstalldir` option is shorthand for
|
|
|
|
|
`--with-mpfr-lib=mpfrinstalldir/lib` and
|
|
|
|
|
`--with-mpfr-include=mpfrinstalldir/include`.
|
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
`--with-python[=PYTHON]'
|
2009-05-23 21:18:38 +08:00
|
|
|
|
Build GDB with Python scripting support. (Done by default if
|
|
|
|
|
libpython is present and found at configure time.) Python makes
|
|
|
|
|
GDB scripting much more powerful than the restricted CLI
|
|
|
|
|
scripting language. If your host does not have Python installed,
|
2018-09-14 12:24:07 +08:00
|
|
|
|
you can find it on `http://www.python.org/download/'. The oldest
|
2021-12-24 09:20:46 +08:00
|
|
|
|
version of Python supported by GDB is 3.2. The optional argument
|
2018-09-14 12:24:07 +08:00
|
|
|
|
PYTHON is used to find the Python headers and libraries. It can
|
|
|
|
|
be either the name of a Python executable, or the name of the
|
|
|
|
|
directory in which Python is installed.
|
|
|
|
|
|
|
|
|
|
`--with-guile[=GUILE]'
|
|
|
|
|
Build GDB with GNU Guile scripting support. (Done by default if
|
|
|
|
|
libguile is present and found at configure time.) If your host
|
|
|
|
|
does not have Guile installed, you can find it at
|
|
|
|
|
`https://www.gnu.org/software/guile/'. The optional argument
|
|
|
|
|
GUILE can be a version number, which will cause `configure' to
|
|
|
|
|
try to use that version of Guile; or the file name of a
|
|
|
|
|
`pkg-config' executable, which will be queried to find the
|
|
|
|
|
information needed to compile and link against Guile.
|
2009-05-23 21:18:38 +08:00
|
|
|
|
|
2019-11-12 02:39:31 +08:00
|
|
|
|
`--enable-source-highlight'
|
|
|
|
|
When printing source code, use source highlighting. This requires
|
|
|
|
|
libsource-highlight to be installed and is enabled by default
|
|
|
|
|
if the library is found.
|
|
|
|
|
|
|
|
|
|
`--with-xxhash'
|
|
|
|
|
Use libxxhash for hashing. This has no user-visible effect but
|
|
|
|
|
speeds up various GDB operations such as symbol loading. Enabled
|
|
|
|
|
by default if libxxhash is found.
|
|
|
|
|
|
gdb: initial support for ROCm platform (AMDGPU) debugging
This patch adds the foundation for GDB to be able to debug programs
offloaded to AMD GPUs using the AMD ROCm platform [1]. The latest
public release of the ROCm release at the time of writing is 5.4, so
this is what this patch targets.
The ROCm platform allows host programs to schedule bits of code for
execution on GPUs or similar accelerators. The programs running on GPUs
are typically referred to as `kernels` (not related to operating system
kernels).
Programs offloaded with the AMD ROCm platform can be written in the HIP
language [2], OpenCL and OpenMP, but we're going to focus on HIP here.
The HIP language consists of a C++ Runtime API and kernel language.
Here's an example of a very simple HIP program:
#include "hip/hip_runtime.h"
#include <cassert>
__global__ void
do_an_addition (int a, int b, int *out)
{
*out = a + b;
}
int
main ()
{
int *result_ptr, result;
/* Allocate memory for the device to write the result to. */
hipError_t error = hipMalloc (&result_ptr, sizeof (int));
assert (error == hipSuccess);
/* Run `do_an_addition` on one workgroup containing one work item. */
do_an_addition<<<dim3(1), dim3(1), 0, 0>>> (1, 2, result_ptr);
/* Copy result from device to host. Note that this acts as a synchronization
point, waiting for the kernel dispatch to complete. */
error = hipMemcpyDtoH (&result, result_ptr, sizeof (int));
assert (error == hipSuccess);
printf ("result is %d\n", result);
assert (result == 3);
return 0;
}
This program can be compiled with:
$ hipcc simple.cpp -g -O0 -o simple
... where `hipcc` is the HIP compiler, shipped with ROCm releases. This
generates an ELF binary for the host architecture, containing another
ELF binary with the device code. The ELF for the device can be
inspected with:
$ roc-obj-ls simple
1 host-x86_64-unknown-linux file://simple#offset=8192&size=0
1 hipv4-amdgcn-amd-amdhsa--gfx906 file://simple#offset=8192&size=34216
$ roc-obj-extract 'file://simple#offset=8192&size=34216'
$ file simple-offset8192-size34216.co
simple-offset8192-size34216.co: ELF 64-bit LSB shared object, *unknown arch 0xe0* version 1, dynamically linked, with debug_info, not stripped
^
amcgcn architecture that my `file` doesn't know about ----´
Running the program gives the very unimpressive result:
$ ./simple
result is 3
While running, this host program has copied the device program into the
GPU's memory and spawned an execution thread on it. The goal of this
GDB port is to let the user debug host threads and these GPU threads
simultaneously. Here's a sample session using a GDB with this patch
applied:
$ ./gdb -q -nx --data-directory=data-directory ./simple
Reading symbols from ./simple...
(gdb) break do_an_addition
Function "do_an_addition" not defined.
Make breakpoint pending on future shared library load? (y or [n]) y
Breakpoint 1 (do_an_addition) pending.
(gdb) r
Starting program: /home/smarchi/build/binutils-gdb-amdgpu/gdb/simple
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
[New Thread 0x7ffff5db7640 (LWP 1082911)]
[New Thread 0x7ffef53ff640 (LWP 1082913)]
[Thread 0x7ffef53ff640 (LWP 1082913) exited]
[New Thread 0x7ffdecb53640 (LWP 1083185)]
[New Thread 0x7ffff54bf640 (LWP 1083186)]
[Thread 0x7ffdecb53640 (LWP 1083185) exited]
[Switching to AMDGPU Wave 2:2:1:1 (0,0,0)/0]
Thread 6 hit Breakpoint 1, do_an_addition (a=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>,
b=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>,
out=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>) at simple.cpp:24
24 *out = a + b;
(gdb) info inferiors
Num Description Connection Executable
* 1 process 1082907 1 (native) /home/smarchi/build/binutils-gdb-amdgpu/gdb/simple
(gdb) info threads
Id Target Id Frame
1 Thread 0x7ffff5dc9240 (LWP 1082907) "simple" 0x00007ffff5e9410b in ?? () from /opt/rocm-5.4.0/lib/libhsa-runtime64.so.1
2 Thread 0x7ffff5db7640 (LWP 1082911) "simple" __GI___ioctl (fd=3, request=3222817548) at ../sysdeps/unix/sysv/linux/ioctl.c:36
5 Thread 0x7ffff54bf640 (LWP 1083186) "simple" __GI___ioctl (fd=3, request=3222817548) at ../sysdeps/unix/sysv/linux/ioctl.c:36
* 6 AMDGPU Wave 2:2:1:1 (0,0,0)/0 do_an_addition (
a=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>,
b=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>,
out=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>) at simple.cpp:24
(gdb) bt
Python Exception <class 'gdb.error'>: Unhandled dwarf expression opcode 0xe1
#0 do_an_addition (a=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>,
b=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>,
out=<error reading variable: DWARF-2 expression error: `DW_OP_regx' operations must be used either alone or in conjunction with DW_OP_piece or DW_OP_bit_piece.>) at simple.cpp:24
(gdb) continue
Continuing.
result is 3
warning: Temporarily disabling breakpoints for unloaded shared library "file:///home/smarchi/build/binutils-gdb-amdgpu/gdb/simple#offset=8192&size=67208"
[Thread 0x7ffff54bf640 (LWP 1083186) exited]
[Thread 0x7ffff5db7640 (LWP 1082911) exited]
[Inferior 1 (process 1082907) exited normally]
One thing to notice is the host and GPU threads appearing under
the same inferior. This is a design goal for us, as programmers tend to
think of the threads running on the GPU as part of the same program as
the host threads, so showing them in the same inferior in GDB seems
natural. Also, the host and GPU threads share a global memory space,
which fits the inferior model.
Another thing to notice is the error messages when trying to read
variables or printing a backtrace. This is expected for the moment,
since the AMD GPU compiler produces some DWARF that uses some
non-standard extensions:
https://llvm.org/docs/AMDGPUDwarfExtensionsForHeterogeneousDebugging.html
There were already some patches posted by Zoran Zaric earlier to make
GDB support these extensions:
https://inbox.sourceware.org/gdb-patches/20211105113849.118800-1-zoran.zaric@amd.com/
We think it's better to get the basic support for AMD GPU in first,
which will then give a better justification for GDB to support these
extensions.
GPU threads are named `AMDGPU Wave`: a wave is essentially a hardware
thread using the SIMT (single-instruction, multiple-threads) [3]
execution model.
GDB uses the amd-dbgapi library [4], included in the ROCm platform, for
a few things related to AMD GPU threads debugging. Different components
talk to the library, as show on the following diagram:
+---------------------------+ +-------------+ +------------------+
| GDB | amd-dbgapi target | <-> | AMD | | Linux kernel |
| +-------------------+ | Debugger | +--------+ |
| | amdgcn gdbarch | <-> | API | <=> | AMDGPU | |
| +-------------------+ | | | driver | |
| | solib-rocm | <-> | (dbgapi.so) | +--------+---------+
+---------------------------+ +-------------+
- The amd-dbgapi target is a target_ops implementation used to control
execution of GPU threads. While the debugging of host threads works
by using the ptrace / wait Linux kernel interface (as usual), control
of GPU threads is done through a special interface (dubbed `kfd`)
exposed by the `amdgpu` Linux kernel module. GDB doesn't interact
directly with `kfd`, but instead goes through the amd-dbgapi library
(AMD Debugger API on the diagram).
Since it provides execution control, the amd-dbgapi target should
normally be a process_stratum_target, not just a target_ops. More
on that later.
- The amdgcn gdbarch (describing the hardware architecture of the GPU
execution units) offloads some requests to the amd-dbgapi library,
so that knowledge about the various architectures doesn't need to be
duplicated and baked in GDB. This is for example for things like
the list of registers.
- The solib-rocm component is an solib provider that fetches the list of
code objects loaded on the device from the amd-dbgapi library, and
makes GDB read their symbols. This is very similar to other solib
providers that handle shared libraries, except that here the shared
libraries are the pieces of code loaded on the device.
Given that Linux host threads are managed by the linux-nat target, and
the GPU threads are managed by the amd-dbgapi target, having all threads
appear in the same inferior requires the two targets to be in that
inferior's target stack. However, there can only be one
process_stratum_target in a given target stack, since there can be only
one target per slot. To achieve it, we therefore resort the hack^W
solution of placing the amd-dbgapi target in the arch_stratum slot of
the target stack, on top of the linux-nat target. Doing so allows the
amd-dbgapi target to intercept target calls and handle them if they
concern GPU threads, and offload to beneath otherwise. See
amd_dbgapi_target::fetch_registers for a simple example:
void
amd_dbgapi_target::fetch_registers (struct regcache *regcache, int regno)
{
if (!ptid_is_gpu (regcache->ptid ()))
{
beneath ()->fetch_registers (regcache, regno);
return;
}
// handle it
}
ptids of GPU threads are crafted with the following pattern:
(pid, 1, wave id)
Where pid is the inferior's pid and "wave id" is the wave handle handed
to us by the amd-dbgapi library (in practice, a monotonically
incrementing integer). The idea is that on Linux systems, the
combination (pid != 1, lwp == 1) is not possible. lwp == 1 would always
belong to the init process, which would also have pid == 1 (and it's
improbable for the init process to offload work to the GPU and much less
for the user to debug it). We can therefore differentiate GPU and
non-GPU ptids this way. See ptid_is_gpu for more details.
Note that we believe that this scheme could break down in the context of
containers, where the initial process executed in a container has pid 1
(in its own pid namespace). For instance, if you were to execute a ROCm
program in a container, then spawn a GDB in that container and attach to
the process, it will likely not work. This is a known limitation. A
workaround for this is to have a dummy process (like a shell) fork and
execute the program of interest.
The amd-dbgapi target watches native inferiors, and "attaches" to them
using amd_dbgapi_process_attach, which gives it a notifier fd that is
registered in the event loop (see enable_amd_dbgapi). Note that this
isn't the same "attach" as in PTRACE_ATTACH, but being ptrace-attached
is a precondition for amd_dbgapi_process_attach to work. When the
debugged process enables the ROCm runtime, the amd-dbgapi target gets
notified through that fd, and pushes itself on the target stack of the
inferior. The amd-dbgapi target is then able to intercept target_ops
calls. If the debugged process disables the ROCm runtime, the
amd-dbgapi target unpushes itself from the target stack.
This way, the amd-dbgapi target's footprint stays minimal when debugging
a process that doesn't use the AMD ROCm platform, it does not intercept
target calls.
The amd-dbgapi library is found using pkg-config. Since enabling
support for the amdgpu architecture (amdgpu-tdep.c) depends on the
amd-dbgapi library being present, we have the following logic for
the interaction with --target and --enable-targets:
- if the user explicitly asks for amdgcn support with
--target=amdgcn-*-* or --enable-targets=amdgcn-*-*, we probe for
the amd-dbgapi and fail if not found
- if the user uses --enable-targets=all, we probe for amd-dbgapi,
enable amdgcn support if found, disable amdgcn support if not found
- if the user uses --enable-targets=all and --with-amd-dbgapi=yes,
we probe for amd-dbgapi, enable amdgcn if found and fail if not found
- if the user uses --enable-targets=all and --with-amd-dbgapi=no,
we do not probe for amd-dbgapi, disable amdgcn support
- otherwise, amd-dbgapi is not probed for and support for amdgcn is not
enabled
Finally, a simple test is included. It only tests hitting a breakpoint
in device code and resuming execution, pretty much like the example
shown above.
[1] https://docs.amd.com/category/ROCm_v5.4
[2] https://docs.amd.com/bundle/HIP-Programming-Guide-v5.4
[3] https://en.wikipedia.org/wiki/Single_instruction,_multiple_threads
[4] https://docs.amd.com/bundle/ROCDebugger-API-Guide-v5.4
Change-Id: I591edca98b8927b1e49e4b0abe4e304765fed9ee
Co-Authored-By: Zoran Zaric <zoran.zaric@amd.com>
Co-Authored-By: Laurent Morichetti <laurent.morichetti@amd.com>
Co-Authored-By: Tony Tye <Tony.Tye@amd.com>
Co-Authored-By: Lancelot SIX <lancelot.six@amd.com>
Co-Authored-By: Pedro Alves <pedro@palves.net>
2023-01-04 04:07:07 +08:00
|
|
|
|
`--with-amd-dbgapi=[auto,yes,no]'
|
|
|
|
|
Whether to use the amd-dbgapi library to support local debugging of
|
|
|
|
|
AMD GCN architecture GPUs.
|
|
|
|
|
|
|
|
|
|
When explicitly requesting support for an AMD GCN architecture through
|
|
|
|
|
`--enable-targets' or `--target', there is no need to use
|
|
|
|
|
`--with-amd-dbgapi': `configure' will automatically look for the
|
|
|
|
|
amd-dbgapi library and fail if not found.
|
|
|
|
|
|
|
|
|
|
When using --enable-targets=all, support for the AMD GCN architecture will
|
|
|
|
|
only be included if the amd-dbgapi is found. `--with-amd-dbgapi=yes' can
|
|
|
|
|
be used to make it a failure if the amd-dbgapi library is not found.
|
|
|
|
|
`--with-amd-dbgapi=no' can be used to prevent looking for the amd-dbgapi
|
|
|
|
|
library altogether.
|
|
|
|
|
|
2009-05-23 21:18:38 +08:00
|
|
|
|
`--without-included-regex'
|
|
|
|
|
Don't use the regex library included with GDB (as part of the
|
|
|
|
|
libiberty library). This is the default on hosts with version 2
|
|
|
|
|
of the GNU C library.
|
|
|
|
|
|
|
|
|
|
`--with-sysroot=DIR'
|
|
|
|
|
Use DIR as the default system root directory for libraries whose
|
|
|
|
|
file names begin with `/lib' or `/usr/lib'. (The value of DIR
|
|
|
|
|
can be modified at run time by using the "set sysroot" command.)
|
|
|
|
|
If DIR is under the GDB configured prefix (set with `--prefix' or
|
|
|
|
|
`--exec-prefix' options), the default system root will be
|
|
|
|
|
automatically adjusted if and when GDB is moved to a different
|
|
|
|
|
location.
|
|
|
|
|
|
|
|
|
|
`--with-system-gdbinit=FILE'
|
|
|
|
|
Configure GDB to automatically load a system-wide init file.
|
|
|
|
|
FILE should be an absolute file name. If FILE is in a directory
|
|
|
|
|
under the configured prefix, and GDB is moved to another location
|
|
|
|
|
after being built, the location of the system-wide init file will
|
2022-09-28 21:58:51 +08:00
|
|
|
|
be adjusted accordingly.
|
2009-05-23 21:18:38 +08:00
|
|
|
|
|
2019-11-12 02:39:31 +08:00
|
|
|
|
`--with-system-gdbinit-dir=DIR'
|
|
|
|
|
Configure GDB to automatically load system-wide init files from
|
|
|
|
|
a directory. Files with extensions `.gdb', `.py' (if Python
|
|
|
|
|
support is enabled) and `.scm' (if Guile support is enabled) are
|
|
|
|
|
supported. DIR should be an absolute directory name. If DIR is
|
|
|
|
|
in a directory under the configured prefix, and GDB is moved to
|
|
|
|
|
another location after being built, the location of the system-
|
|
|
|
|
wide init directory will be adjusted accordingly.
|
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
`--enable-build-warnings'
|
|
|
|
|
When building the GDB sources, ask the compiler to warn about any
|
|
|
|
|
code which looks even vaguely suspicious. It passes many
|
|
|
|
|
different warning flags, depending on the exact version of the
|
|
|
|
|
compiler you are using.
|
|
|
|
|
|
|
|
|
|
`--enable-werror'
|
|
|
|
|
Treat compiler warnings as werrors. It adds the -Werror flag to
|
|
|
|
|
the compiler, which will fail the compilation if the compiler
|
|
|
|
|
outputs any warning messages.
|
|
|
|
|
|
2018-08-19 05:32:46 +08:00
|
|
|
|
`--enable-ubsan'
|
|
|
|
|
Enable the GCC undefined behavior sanitizer. By default this is
|
|
|
|
|
disabled in GDB releases, but enabled when building from git.
|
|
|
|
|
The undefined behavior sanitizer checks for C++ undefined
|
|
|
|
|
behavior. It has a performance cost, so if you are looking at
|
|
|
|
|
GDB's performance, you should disable it.
|
|
|
|
|
|
2018-09-18 03:58:55 +08:00
|
|
|
|
`--enable-unit-tests[=yes|no]'
|
|
|
|
|
Enable (i.e., include) support for unit tests when compiling GDB
|
|
|
|
|
and GDBServer. Note that if this option is not passed, GDB will
|
|
|
|
|
have selftests if it is a development build, and will *not* have
|
|
|
|
|
selftests if it is a non-development build.
|
|
|
|
|
|
1999-04-16 09:35:26 +08:00
|
|
|
|
`configure' accepts other options, for compatibility with configuring
|
2018-09-14 12:24:07 +08:00
|
|
|
|
other GNU tools recursively.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Remote debugging
|
|
|
|
|
=================
|
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
The files m68k-stub.c, i386-stub.c, and sparc-stub.c are examples
|
|
|
|
|
of remote stubs to be used with remote.c. They are designed to run
|
|
|
|
|
standalone on an m68k, i386, or SPARC cpu and communicate properly
|
|
|
|
|
with the remote.c stub over a serial line.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
Move gdbserver to top level
This patch moves gdbserver to the top level.
This patch is as close to a pure move as possible -- gdbserver still
builds its own variant of gnulib and gdbsupport. Changing this will
be done in a separate patch.
[v2] Note that, per Simon's review comment, this patch changes the
tree so that gdbserver is not built for or1k or score. This makes
sense, because there is apparently not actually a gdbserver port here.
[v3] This version of the patch also splits out some configury into a
new file, gdbserver/configure.host, so that the top-level configure
script can simply rely on it in order to decide whether gdbserver
should be built.
[v4] This version adds documentation and removes some unnecessary
top-level dependencies.
[v5] Update docs to mention "make all-gdbserver" and change how
top-level configure decides whether to build gdbserver, switching to a
single, shared script.
Tested by the buildbot.
ChangeLog
2020-02-07 Tom Tromey <tom@tromey.com>
Pedro Alves <palves@redhat.com>
* src-release.sh (GDB_SUPPORT_DIRS): Add gdbserver.
* gdbserver: New directory, moved from gdb/gdbserver.
* configure.ac (host_tools): Add gdbserver.
Only build gdbserver on certain systems.
* Makefile.in, configure: Rebuild.
* Makefile.def (host_modules, dependencies): Add gdbserver.
* MAINTAINERS: Add gdbserver.
gdb/ChangeLog
2020-02-07 Tom Tromey <tom@tromey.com>
* README: Update gdbserver documentation.
* gdbserver: Move to top level.
* configure.tgt (build_gdbserver): Remove.
* configure.ac: Remove --enable-gdbserver.
* configure: Rebuild.
* Makefile.in (distclean): Don't mention gdbserver.
Change-Id: I826b7565b54604711dc7a11edea0499cd51ff39e
2019-12-15 22:37:06 +08:00
|
|
|
|
The directory gdbserver/ contains `gdbserver', a program that
|
2010-05-03 00:10:03 +08:00
|
|
|
|
allows remote debugging for Unix applications. GDBserver is only
|
Move gdbserver to top level
This patch moves gdbserver to the top level.
This patch is as close to a pure move as possible -- gdbserver still
builds its own variant of gnulib and gdbsupport. Changing this will
be done in a separate patch.
[v2] Note that, per Simon's review comment, this patch changes the
tree so that gdbserver is not built for or1k or score. This makes
sense, because there is apparently not actually a gdbserver port here.
[v3] This version of the patch also splits out some configury into a
new file, gdbserver/configure.host, so that the top-level configure
script can simply rely on it in order to decide whether gdbserver
should be built.
[v4] This version adds documentation and removes some unnecessary
top-level dependencies.
[v5] Update docs to mention "make all-gdbserver" and change how
top-level configure decides whether to build gdbserver, switching to a
single, shared script.
Tested by the buildbot.
ChangeLog
2020-02-07 Tom Tromey <tom@tromey.com>
Pedro Alves <palves@redhat.com>
* src-release.sh (GDB_SUPPORT_DIRS): Add gdbserver.
* gdbserver: New directory, moved from gdb/gdbserver.
* configure.ac (host_tools): Add gdbserver.
Only build gdbserver on certain systems.
* Makefile.in, configure: Rebuild.
* Makefile.def (host_modules, dependencies): Add gdbserver.
* MAINTAINERS: Add gdbserver.
gdb/ChangeLog
2020-02-07 Tom Tromey <tom@tromey.com>
* README: Update gdbserver documentation.
* gdbserver: Move to top level.
* configure.tgt (build_gdbserver): Remove.
* configure.ac: Remove --enable-gdbserver.
* configure: Rebuild.
* Makefile.in (distclean): Don't mention gdbserver.
Change-Id: I826b7565b54604711dc7a11edea0499cd51ff39e
2019-12-15 22:37:06 +08:00
|
|
|
|
supported for some native configurations.
|
2018-09-14 12:24:07 +08:00
|
|
|
|
|
Move gdbserver to top level
This patch moves gdbserver to the top level.
This patch is as close to a pure move as possible -- gdbserver still
builds its own variant of gnulib and gdbsupport. Changing this will
be done in a separate patch.
[v2] Note that, per Simon's review comment, this patch changes the
tree so that gdbserver is not built for or1k or score. This makes
sense, because there is apparently not actually a gdbserver port here.
[v3] This version of the patch also splits out some configury into a
new file, gdbserver/configure.host, so that the top-level configure
script can simply rely on it in order to decide whether gdbserver
should be built.
[v4] This version adds documentation and removes some unnecessary
top-level dependencies.
[v5] Update docs to mention "make all-gdbserver" and change how
top-level configure decides whether to build gdbserver, switching to a
single, shared script.
Tested by the buildbot.
ChangeLog
2020-02-07 Tom Tromey <tom@tromey.com>
Pedro Alves <palves@redhat.com>
* src-release.sh (GDB_SUPPORT_DIRS): Add gdbserver.
* gdbserver: New directory, moved from gdb/gdbserver.
* configure.ac (host_tools): Add gdbserver.
Only build gdbserver on certain systems.
* Makefile.in, configure: Rebuild.
* Makefile.def (host_modules, dependencies): Add gdbserver.
* MAINTAINERS: Add gdbserver.
gdb/ChangeLog
2020-02-07 Tom Tromey <tom@tromey.com>
* README: Update gdbserver documentation.
* gdbserver: Move to top level.
* configure.tgt (build_gdbserver): Remove.
* configure.ac: Remove --enable-gdbserver.
* configure: Rebuild.
* Makefile.in (distclean): Don't mention gdbserver.
Change-Id: I826b7565b54604711dc7a11edea0499cd51ff39e
2019-12-15 22:37:06 +08:00
|
|
|
|
The file gdbserver/README includes further notes on GDBserver; in
|
2010-05-03 00:10:03 +08:00
|
|
|
|
particular, it explains how to build GDBserver for cross-debugging
|
|
|
|
|
(where GDBserver runs on the target machine, which is of a different
|
2008-01-18 04:18:48 +08:00
|
|
|
|
architecture than the host machine running GDB).
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
|
2002-04-08 03:09:58 +08:00
|
|
|
|
Reporting Bugs in GDB
|
|
|
|
|
=====================
|
|
|
|
|
|
2023-06-04 04:43:57 +08:00
|
|
|
|
There are several ways of reporting bugs in GDB. The preferred
|
2002-04-08 03:09:58 +08:00
|
|
|
|
method is to use the World Wide Web:
|
|
|
|
|
|
|
|
|
|
http://www.gnu.org/software/gdb/bugs/
|
|
|
|
|
|
|
|
|
|
As an alternative, the bug report can be submitted, via e-mail, to the
|
|
|
|
|
address "bug-gdb@gnu.org".
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
When submitting a bug, please include the GDB version number, and
|
|
|
|
|
how you configured it (e.g., "sun4" or "mach386 host,
|
2018-09-14 12:24:07 +08:00
|
|
|
|
i586-intel-synopsys target"). Since GDB supports so many
|
2000-05-11 15:55:25 +08:00
|
|
|
|
different configurations, it is important that you be precise about
|
2018-09-14 12:24:07 +08:00
|
|
|
|
this. The simplest way to do this is to include the output from these
|
|
|
|
|
commands:
|
|
|
|
|
|
|
|
|
|
% gdb --version
|
|
|
|
|
% gdb --config
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2002-04-08 03:09:58 +08:00
|
|
|
|
For more information on how/whether to report bugs, see the
|
|
|
|
|
Reporting Bugs chapter of the GDB manual (gdb/doc/gdb.texinfo).
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
|
|
|
|
|
Graphical interface to GDB -- X Windows, MS Windows
|
|
|
|
|
==========================
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
Several graphical interfaces to GDB are available. You should
|
|
|
|
|
check:
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2018-09-14 12:24:07 +08:00
|
|
|
|
https://sourceware.org/gdb/wiki/GDB%20Front%20Ends
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
for an up-to-date list.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
Emacs users will very likely enjoy the Grand Unified Debugger mode;
|
2001-04-06 00:52:30 +08:00
|
|
|
|
try typing `M-x gdb RET'.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Writing Code for GDB
|
|
|
|
|
=====================
|
|
|
|
|
|
2013-09-17 02:00:34 +08:00
|
|
|
|
There is information about writing code for GDB in the file
|
|
|
|
|
`CONTRIBUTE' and at the website:
|
|
|
|
|
|
|
|
|
|
http://www.gnu.org/software/gdb/
|
|
|
|
|
|
|
|
|
|
in particular in the wiki.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
If you are pondering writing anything but a short patch, especially
|
2013-09-17 02:00:34 +08:00
|
|
|
|
take note of the information about copyrights and copyright assignment.
|
|
|
|
|
It can take quite a while to get all the paperwork done, so
|
1999-04-16 09:35:26 +08:00
|
|
|
|
we encourage you to start that process as soon as you decide you are
|
|
|
|
|
planning to work on something, or at least well ahead of when you
|
|
|
|
|
think you will be ready to submit the patches.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GDB Testsuite
|
|
|
|
|
=============
|
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
Included with the GDB distribution is a DejaGNU based testsuite
|
|
|
|
|
that can either be used to test your newly built GDB, or for
|
|
|
|
|
regression testing a GDB with local modifications.
|
|
|
|
|
|
|
|
|
|
Running the testsuite requires the prior installation of DejaGNU,
|
|
|
|
|
which is generally available via ftp. The directory
|
2002-02-24 04:59:55 +08:00
|
|
|
|
ftp://sources.redhat.com/pub/dejagnu/ will contain a recent snapshot.
|
|
|
|
|
Once DejaGNU is installed, you can run the tests in one of the
|
|
|
|
|
following ways:
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
(1) cd gdb-VERSION
|
2000-05-11 15:55:25 +08:00
|
|
|
|
make check-gdb
|
|
|
|
|
|
|
|
|
|
or
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
(2) cd gdb-VERSION/gdb
|
1999-04-16 09:35:26 +08:00
|
|
|
|
make check
|
|
|
|
|
|
|
|
|
|
or
|
|
|
|
|
|
2010-06-07 15:42:49 +08:00
|
|
|
|
(3) cd gdb-VERSION/gdb/testsuite
|
1999-04-16 09:35:26 +08:00
|
|
|
|
make site.exp (builds the site specific file)
|
|
|
|
|
runtest -tool gdb GDB=../gdb (or GDB=<somepath> as appropriate)
|
|
|
|
|
|
2009-06-30 00:41:45 +08:00
|
|
|
|
When using a `make'-based method, you can use the Makefile variable
|
|
|
|
|
`RUNTESTFLAGS' to pass flags to `runtest', e.g.:
|
|
|
|
|
|
|
|
|
|
make RUNTESTFLAGS=--directory=gdb.cp check
|
|
|
|
|
|
|
|
|
|
If you use GNU make, you can use its `-j' option to run the testsuite
|
|
|
|
|
in parallel. This can greatly reduce the amount of time it takes for
|
|
|
|
|
the testsuite to run. In this case, if you set `RUNTESTFLAGS' then,
|
|
|
|
|
by default, the tests will be run serially even under `-j'. You can
|
|
|
|
|
override this and force a parallel run by setting the `make' variable
|
|
|
|
|
`FORCE_PARALLEL' to any non-empty value. Note that the parallel `make
|
|
|
|
|
check' assumes that you want to run the entire testsuite, so it is not
|
|
|
|
|
compatible with some dejagnu options, like `--directory'.
|
|
|
|
|
|
2000-05-11 15:55:25 +08:00
|
|
|
|
The last method gives you slightly more control in case of problems
|
|
|
|
|
with building one or more test executables or if you are using the
|
|
|
|
|
testsuite `standalone', without it being part of the GDB source tree.
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
See the DejaGNU documentation for further details.
|
|
|
|
|
|
2012-01-04 12:11:38 +08:00
|
|
|
|
|
|
|
|
|
Copyright and License Notices
|
|
|
|
|
=============================
|
|
|
|
|
|
|
|
|
|
Most files maintained by the GDB Project contain a copyright notice
|
|
|
|
|
as well as a license notice, usually at the start of the file.
|
|
|
|
|
|
|
|
|
|
To reduce the length of copyright notices, consecutive years in the
|
|
|
|
|
copyright notice can be combined into a single range. For instance,
|
|
|
|
|
the following list of copyright years...
|
|
|
|
|
|
|
|
|
|
1986, 1988, 1989, 1991-1993, 1999, 2000, 2007, 2008, 2009, 2010, 2011
|
|
|
|
|
|
|
|
|
|
... is abbreviated into:
|
|
|
|
|
|
|
|
|
|
1986, 1988-1989, 1991-1993, 1999-2000, 2007-2011
|
|
|
|
|
|
|
|
|
|
Every year of each range, inclusive, is a copyrightable year that
|
|
|
|
|
could be listed individually.
|
|
|
|
|
|
1999-04-16 09:35:26 +08:00
|
|
|
|
|
|
|
|
|
(this is for editing this file with GNU emacs)
|
|
|
|
|
Local Variables:
|
|
|
|
|
mode: text
|
|
|
|
|
End:
|