[4b0ebf70] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[ac38e9dc] | 7 | <!ENTITY gdb-download-http "https://ftp.gnu.org/gnu/gdb/gdb-&gdb-version;.tar.xz">
|
---|
[b52dab73] | 8 | <!ENTITY gdb-download-ftp "ftp://ftp.gnu.org/gnu/gdb/gdb-&gdb-version;.tar.xz">
|
---|
[9ea9aa7] | 9 | <!ENTITY gdb-md5sum "b5c784685e1cde65ba135feea86b6d75">
|
---|
[ac38e9dc] | 10 | <!ENTITY gdb-size "18 MB">
|
---|
[9ea9aa7] | 11 | <!ENTITY gdb-buildsize "399 MB (additional 173 MB for tests, additional 1.3 GB for documentation)">
|
---|
| 12 | <!ENTITY gdb-time "2.6 SBU (add up to 13 SBU for tests)">
|
---|
[4b0ebf70] | 13 | ]>
|
---|
| 14 |
|
---|
[d3970e1] | 15 | <sect1 id="gdb" xreflabel="GDB-&gdb-version;">
|
---|
[4b0ebf70] | 16 | <?dbhtml filename="gdb.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[d3970e1] | 23 | <title>GDB-&gdb-version;</title>
|
---|
[4b0ebf70] | 24 |
|
---|
| 25 | <indexterm zone="gdb">
|
---|
[4890200] | 26 | <primary sortas="a-GDB">GDB</primary>
|
---|
[4b0ebf70] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[d3970e1] | 30 | <title>Introduction to GDB</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>GDB</application>, the GNU Project debugger, allows you
|
---|
| 34 | to see what is going on <quote>inside</quote> another program while it
|
---|
| 35 | executes -- or what another program was doing at the moment it crashed.
|
---|
| 36 | Note that <application>GDB</application> is most effective when tracing
|
---|
| 37 | programs and libraries that were built with debugging symbols and not
|
---|
| 38 | stripped.
|
---|
| 39 | </para>
|
---|
[4b0ebf70] | 40 |
|
---|
[a91856d1] | 41 | &lfs79_checked;
|
---|
[4b0ebf70] | 42 |
|
---|
[6d27308] | 43 | &gcc6_checked;
|
---|
| 44 |
|
---|
[4b0ebf70] | 45 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 46 | <itemizedlist spacing="compact">
|
---|
| 47 | <listitem>
|
---|
[4890200] | 48 | <para>
|
---|
| 49 | Download (HTTP): <ulink url="&gdb-download-http;"/>
|
---|
| 50 | </para>
|
---|
[4b0ebf70] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[4890200] | 53 | <para>
|
---|
| 54 | Download (FTP): <ulink url="&gdb-download-ftp;"/>
|
---|
| 55 | </para>
|
---|
[4b0ebf70] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[4890200] | 58 | <para>
|
---|
| 59 | Download MD5 sum: &gdb-md5sum;
|
---|
| 60 | </para>
|
---|
[4b0ebf70] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[4890200] | 63 | <para>
|
---|
| 64 | Download size: &gdb-size;
|
---|
| 65 | </para>
|
---|
[4b0ebf70] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[4890200] | 68 | <para>
|
---|
| 69 | Estimated disk space required: &gdb-buildsize;
|
---|
| 70 | </para>
|
---|
[4b0ebf70] | 71 | </listitem>
|
---|
| 72 | <listitem>
|
---|
[4890200] | 73 | <para>
|
---|
| 74 | Estimated build time: &gdb-time;
|
---|
| 75 | </para>
|
---|
[4b0ebf70] | 76 | </listitem>
|
---|
| 77 | </itemizedlist>
|
---|
| 78 |
|
---|
[d3970e1] | 79 | <bridgehead renderas="sect3">GDB Dependencies</bridgehead>
|
---|
[d4c9b7c] | 80 |
|
---|
| 81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 82 | <para role="optional">
|
---|
[b52dab73] | 83 | <xref linkend="dejagnu"/> (for tests),
|
---|
[ac38e9dc] | 84 | <xref linkend="doxygen"/>,
|
---|
[184f8af] | 85 | <xref linkend="guile"/>,
|
---|
[2037ec4] | 86 | <xref linkend="python2"/>,
|
---|
| 87 | <xref linkend="valgrind"/>, and
|
---|
| 88 | <ulink url="https://sourceware.org/systemtap/">SystemTap</ulink>
|
---|
| 89 | (run-time dependency, also used in a few tests)
|
---|
[d4c9b7c] | 90 | </para>
|
---|
| 91 |
|
---|
[4b0ebf70] | 92 | <para condition="html" role="usernotes">User Notes:
|
---|
[d3970e1] | 93 | <ulink url="&blfs-wiki;/gdb"/>
|
---|
| 94 | </para>
|
---|
[4b0ebf70] | 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
[d3970e1] | 98 | <title>Installation of GDB</title>
|
---|
[4b0ebf70] | 99 |
|
---|
[d3970e1] | 100 | <para>
|
---|
| 101 | Install <application>GDB</application> by running the following
|
---|
| 102 | commands:
|
---|
| 103 | </para>
|
---|
[4b0ebf70] | 104 |
|
---|
[a55a187] | 105 | <screen><userinput>./configure --prefix=/usr --with-system-readline &&
|
---|
[4b0ebf70] | 106 | make</userinput></screen>
|
---|
| 107 |
|
---|
[ac38e9dc] | 108 | <para>
|
---|
| 109 | Optionally, to build the API documentation using
|
---|
| 110 | <xref linkend="doxygen"/>, run:
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <screen><userinput>make -C gdb/doc doxy</userinput></screen>
|
---|
| 114 |
|
---|
[d3970e1] | 115 | <para>
|
---|
[2037ec4] | 116 | To test the results, issue:
|
---|
[184f8af] | 117 | </para>
|
---|
| 118 |
|
---|
| 119 | <screen><userinput>pushd gdb/testsuite &&
|
---|
[2037ec4] | 120 | make site.exp &&
|
---|
| 121 | echo "set gdb_test_timeout 120" >> site.exp &&
|
---|
[184f8af] | 122 | runtest TRANSCRIPT=y
|
---|
| 123 | popd</userinput></screen>
|
---|
| 124 |
|
---|
| 125 | <para>
|
---|
[2037ec4] | 126 | See <emphasis>gdb/testsuite/README</emphasis> and <ulink
|
---|
| 127 | url="https://sourceware.org/gdb/wiki/TestingGDB">TestingGDB</ulink>.
|
---|
[9ea9aa7] | 128 | There are many problems with the test suite:
|
---|
[d3970e1] | 129 | </para>
|
---|
[4b0ebf70] | 130 |
|
---|
[9ea9aa7] | 131 | <itemizedlist>
|
---|
| 132 | <listitem>
|
---|
| 133 | <para>
|
---|
| 134 | Clean directories ire needed if re-running the tests. For that
|
---|
| 135 | reason, it is recommended to make a copy of the compiled source code
|
---|
| 136 | directory before the tests in case you need to run the tests again.
|
---|
| 137 | </para>
|
---|
| 138 | </listitem>
|
---|
| 139 |
|
---|
| 140 | <listitem>
|
---|
| 141 | <para>
|
---|
| 142 | Results depend on installed compilers.
|
---|
| 143 | </para>
|
---|
| 144 | </listitem>
|
---|
| 145 |
|
---|
| 146 | <listitem>
|
---|
| 147 | <para>
|
---|
| 148 | If run remotely over an ssh connection, the tests will hang
|
---|
| 149 | and require a hard (power cycle) reset of the sytem.
|
---|
| 150 | </para>
|
---|
| 151 | </listitem>
|
---|
| 152 |
|
---|
| 153 | <listitem>
|
---|
| 154 | <para>
|
---|
| 155 | There are a large number of timeouts (there is a variable
|
---|
| 156 | that can be set to increase time for timeout, but
|
---|
| 157 | changing it will result in a different number of tests being
|
---|
| 158 | run.
|
---|
| 159 | </para>
|
---|
| 160 | </listitem>
|
---|
| 161 |
|
---|
| 162 | <listitem>
|
---|
| 163 | <para>
|
---|
| 164 | There are failures associated with system readline 6.x.
|
---|
| 165 | </para>
|
---|
| 166 | </listitem>
|
---|
| 167 |
|
---|
| 168 | <listitem>
|
---|
| 169 | <para>
|
---|
| 170 | A few tests assume that the header file
|
---|
| 171 | <filename><sys/sdt.h></filename>, part of <ulink
|
---|
| 172 | url="https://sourceware.org/systemtap/">SystemTap</ulink>, is
|
---|
| 173 | present.
|
---|
| 174 | </para>
|
---|
| 175 | </listitem>
|
---|
| 176 |
|
---|
| 177 | <listitem>
|
---|
| 178 | <para>
|
---|
| 179 | About 3% of the tests fail (out of over 35000 tests).
|
---|
| 180 | </para>
|
---|
| 181 | </listitem>
|
---|
| 182 |
|
---|
| 183 | </itemizedlist>
|
---|
| 184 |
|
---|
[d3970e1] | 185 | <para>
|
---|
| 186 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 187 | </para>
|
---|
[4b0ebf70] | 188 |
|
---|
| 189 | <screen role="root"><userinput>make -C gdb install</userinput></screen>
|
---|
| 190 |
|
---|
[ac38e9dc] | 191 | <para>
|
---|
| 192 | If you have built the API documentation, it is now in gdb/doc/doxy.
|
---|
| 193 | You can install it (as the <systemitem class="username">root</systemitem>
|
---|
| 194 | user):
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
| 197 | <screen role="root"><userinput>install -d /usr/share/doc/gdb-&gdb-version; &&
|
---|
[184f8af] | 198 | rm -rf gdb/doc/doxy/xml &&
|
---|
[ac38e9dc] | 199 | cp -Rv gdb/doc/doxy /usr/share/doc/gdb-&gdb-version;</userinput></screen>
|
---|
| 200 |
|
---|
[4b0ebf70] | 201 | </sect2>
|
---|
[d3970e1] | 202 |
|
---|
[4b0ebf70] | 203 | <sect2 role="content">
|
---|
| 204 | <title>Contents</title>
|
---|
| 205 |
|
---|
| 206 | <segmentedlist>
|
---|
| 207 | <segtitle>Installed Programs</segtitle>
|
---|
| 208 | <segtitle>Installed Library</segtitle>
|
---|
| 209 | <segtitle>Installed Directories</segtitle>
|
---|
| 210 |
|
---|
| 211 | <seglistitem>
|
---|
[4890200] | 212 | <seg>
|
---|
[6cd96df] | 213 | gcore, gdb and gdbserver
|
---|
[4890200] | 214 | </seg>
|
---|
| 215 | <seg>
|
---|
| 216 | libinproctrace.so
|
---|
| 217 | </seg>
|
---|
| 218 | <seg>
|
---|
[2037ec4] | 219 | /usr/{include,share}/gdb and /usr/share/doc/gdb-&gdb-version;
|
---|
[4890200] | 220 | </seg>
|
---|
[4b0ebf70] | 221 | </seglistitem>
|
---|
| 222 | </segmentedlist>
|
---|
| 223 |
|
---|
| 224 | <variablelist>
|
---|
| 225 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 226 | <?dbfo list-presentation="list"?>
|
---|
| 227 | <?dbhtml list-presentation="table"?>
|
---|
| 228 |
|
---|
[a55a187] | 229 | <varlistentry id="gcore">
|
---|
| 230 | <term><command>gcore</command></term>
|
---|
| 231 | <listitem>
|
---|
| 232 | <para>
|
---|
| 233 | generates a core dump of a running program.
|
---|
| 234 | </para>
|
---|
| 235 | <indexterm zone="gdb gcore">
|
---|
| 236 | <primary sortas="b-gcore">gcore</primary>
|
---|
| 237 | </indexterm>
|
---|
| 238 | </listitem>
|
---|
| 239 | </varlistentry>
|
---|
| 240 |
|
---|
[4b0ebf70] | 241 | <varlistentry id="gdb-prog">
|
---|
| 242 | <term><command>gdb</command></term>
|
---|
| 243 | <listitem>
|
---|
[d3970e1] | 244 | <para>
|
---|
| 245 | is the GNU Debugger.
|
---|
| 246 | </para>
|
---|
[4b0ebf70] | 247 | <indexterm zone="gdb gdb-prog">
|
---|
| 248 | <primary sortas="b-gdb-prog">gdb-prog</primary>
|
---|
| 249 | </indexterm>
|
---|
| 250 | </listitem>
|
---|
| 251 | </varlistentry>
|
---|
| 252 |
|
---|
| 253 | <varlistentry id="gdbserver">
|
---|
| 254 | <term><command>gdbserver</command></term>
|
---|
| 255 | <listitem>
|
---|
[d3970e1] | 256 | <para>
|
---|
[4890200] | 257 | is a remote server for the GNU debugger (it allows programs
|
---|
| 258 | to be debugged from a different machine).
|
---|
[d3970e1] | 259 | </para>
|
---|
[4b0ebf70] | 260 | <indexterm zone="gdb gdbserver">
|
---|
| 261 | <primary sortas="b-gdbserver">gdbserver</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
| 265 |
|
---|
| 266 | <varlistentry id="libinproctrace">
|
---|
[4890200] | 267 | <term><filename class="libraryfile">libinproctrace.so</filename></term>
|
---|
[4b0ebf70] | 268 | <listitem>
|
---|
[d3970e1] | 269 | <para>
|
---|
| 270 | contains functions for the in-process tracing agent. The agent
|
---|
| 271 | allows for installing fast tracepoints, listing static tracepoint
|
---|
| 272 | markers, probing static tracepoints markers, and starting trace
|
---|
| 273 | monitoring.
|
---|
| 274 | </para>
|
---|
[4b0ebf70] | 275 | <indexterm zone="gdb libinproctrace">
|
---|
| 276 | <primary sortas="c-libinproctrace">libinproctrace.so</primary>
|
---|
| 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
[d3970e1] | 279 | </varlistentry>
|
---|
[4b0ebf70] | 280 |
|
---|
| 281 | </variablelist>
|
---|
| 282 |
|
---|
| 283 | </sect2>
|
---|
| 284 |
|
---|
| 285 | </sect1>
|
---|