2002-12-19 09:18:14 +01:00
|
|
|
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
|
|
|
<!DOCTYPE html
|
|
|
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta name="AUTHOR" content="bkoz@gcc.gnu.org (Benjamin Kosnik)" />
|
|
|
|
|
<meta name="KEYWORDS" content="c++, libstdc++, gdb, g++, debug" />
|
|
|
|
|
<meta name="DESCRIPTION" content="Debugging C++ binaries" />
|
|
|
|
|
<meta name="GENERATOR" content="vi and ten fingers" />
|
|
|
|
|
<title>Debugging schemes and strategies</title>
|
configopts.html, [...]: Add <link> tags.
2003-11-18 Jonathan Wakely <redi@gcc.gnu.org>
* docs/html/configopts.html, docs/html/debug.html,
docs/html/documentation.html, docs/html/explanations.html,
docs/html/install.html, docs/html/17_intro/contribute.html,
docs/html/17_intro/howto.html, docs/html/17_intro/license.html,
docs/html/18_support/howto.html, docs/html/19_diagnostics/howto.html,
docs/html/20_util/howto.html, docs/html/21_strings/howto.html,
docs/html/22_locale/codecvt.html, docs/html/22_locale/ctype.html,
docs/html/22_locale/howto.html, docs/html/22_locale/locale.html,
docs/html/22_locale/messages.html, docs/html/23_containers/howto.html,
docs/html/24_iterators/howto.html, docs/html/25_algorithms/howto.html,
docs/html/26_numerics/howto.html, docs/html/27_io/howto.html,
docs/html/ext/howto.html, docs/html/ext/sgiexts.html: Add <link> tags.
From-SVN: r73712
2003-11-18 21:56:12 +01:00
|
|
|
<link rel="StyleSheet" href="lib3styles.css" type="text/css" />
|
|
|
|
|
<link rel="Copyright" href="17_intro/license.html" type="text/html" />
|
2002-12-19 09:18:14 +01:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h1 class="centered"><a name="top">Debugging schemes and strategies</a></h1>
|
|
|
|
|
|
|
|
|
|
<p class="fineprint"><em>
|
2003-03-13 01:15:59 +01:00
|
|
|
The latest version of this document is always available at
|
2002-12-19 09:18:14 +01:00
|
|
|
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/debug.html">
|
|
|
|
|
http://gcc.gnu.org/onlinedocs/libstdc++/debug.html</a>.
|
2003-03-13 01:15:59 +01:00
|
|
|
</em></p>
|
2002-12-19 09:18:14 +01:00
|
|
|
|
2003-03-13 01:15:59 +01:00
|
|
|
<p><em>
|
|
|
|
|
To the <a href="http://gcc.gnu.org/libstdc++/">libstdc++-v3 homepage</a>.
|
2002-12-19 09:18:14 +01:00
|
|
|
</em></p>
|
|
|
|
|
|
|
|
|
|
<!-- ####################################################### -->
|
|
|
|
|
<hr />
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>There are numerous things that can be done to improve the ease with
|
2003-11-11 21:09:16 +01:00
|
|
|
which C++ binaries are debugged when using the GNU
|
|
|
|
|
tool chain. Here are some of them.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2003-03-13 01:15:59 +01:00
|
|
|
<h3 class="left"><a name="gplusplus">Compiler flags determine debug info</a></h3>
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>The default optimizations and debug flags for a libstdc++ build are
|
2002-12-19 09:18:14 +01:00
|
|
|
<code>-g -O2</code>. However, both debug and optimization flags can
|
|
|
|
|
be varied to change debugging characteristics. For instance,
|
|
|
|
|
turning off all optimization via the <code>-g -O0</code> flag will
|
|
|
|
|
disable inlining, so that stepping through all functions, including
|
2003-11-11 21:09:16 +01:00
|
|
|
inlined constructors and destructors, is possible. In addition,
|
2005-02-02 20:38:38 +01:00
|
|
|
<code>-fno-eliminate-unused-debug-types</code> can be used when
|
2003-11-11 21:09:16 +01:00
|
|
|
additional debug information, such as nested class info, is desired.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>Or, the debug format that the compiler and debugger use to communicate
|
2002-12-19 09:18:14 +01:00
|
|
|
information about source constructs can be changed via <code>
|
|
|
|
|
-gdwarf-2 </code> or <code> -gstabs </code> flags: some debugging
|
|
|
|
|
formats permit more expressive type and scope information to be
|
2003-11-11 21:09:16 +01:00
|
|
|
shown in gdb. The default debug information for a particular
|
|
|
|
|
platform can be identified via the value set by the
|
|
|
|
|
PREFERRED_DEBUGGING_TYPE macro in the gcc sources.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>Many other options are available: please see
|
2003-03-13 01:15:59 +01:00
|
|
|
<a href="http://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html#Debugging%20Options">"Options for Debugging Your Program"</a>
|
2002-12-19 09:18:14 +01:00
|
|
|
in Using the GNU Compiler Collection (GCC) for a complete list.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<h3 class="left"><a name="lib">Using special flags to make a debug binary</a></h3>
|
2003-11-11 21:09:16 +01:00
|
|
|
<p>If you would like debug symbols in libstdc++, there are two ways to
|
|
|
|
|
build libstdc++ with debug flags. The first is to run make from the
|
|
|
|
|
toplevel in a freshly-configured tree with
|
2005-02-02 20:38:38 +01:00
|
|
|
</p>
|
2003-03-13 01:15:59 +01:00
|
|
|
<pre>
|
2003-11-11 21:09:16 +01:00
|
|
|
--enable-libstdcxx-debug
|
2003-03-13 01:15:59 +01:00
|
|
|
</pre>
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>and perhaps</p>
|
2003-03-13 01:15:59 +01:00
|
|
|
<pre>
|
2003-11-11 21:09:16 +01:00
|
|
|
--enable-libstdcxx-debug-flags='...'
|
2003-03-13 01:15:59 +01:00
|
|
|
</pre>
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>to create a separate debug build. Both the normal build and the
|
2002-12-19 09:18:14 +01:00
|
|
|
debug build will persist, without having to specify
|
|
|
|
|
<code>CXXFLAGS</code>, and the debug library will be installed in a
|
|
|
|
|
separate directory tree, in <code>(prefix)/lib/debug</code>. For
|
2003-03-13 01:15:59 +01:00
|
|
|
more information, look at the <a href="configopts.html">configuration
|
|
|
|
|
options</a> document.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2003-11-11 21:09:16 +01:00
|
|
|
<p>A second approach is to use the configuration flags
|
|
|
|
|
</p>
|
|
|
|
|
<pre>
|
|
|
|
|
make CXXFLAGS='-g3 -O0' all
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>This quick and dirty approach is often sufficient for quick
|
|
|
|
|
debugging tasks, when you cannot or don't want to recompile your
|
|
|
|
|
application to use the <a href="#safe">debug mode</a>.</p>
|
|
|
|
|
|
|
|
|
|
<h3 class="left"><a name="safe">The libstdc++ debug mode</a></h3>
|
|
|
|
|
<p>By default, libstdc++ is built with efficiency in mind, and
|
|
|
|
|
therefore performs little or no error checking that is not required
|
|
|
|
|
by the C++ standard. This means that programs that incorrectly use
|
|
|
|
|
the C++ standard library will exhibit behavior that is not portable
|
|
|
|
|
and may not even be predictable, because they tread into
|
|
|
|
|
implementation-specific or undefined behavior. To detect some of
|
|
|
|
|
these errors before they can become problematic, libstdc++ offers a
|
|
|
|
|
debug mode that provides additional checking of library facilities,
|
|
|
|
|
and will report errors in the use of libstdc++ as soon as they can
|
|
|
|
|
be detected by emitting a description of the problem to standard
|
2004-07-23 10:22:20 +02:00
|
|
|
error and aborting the program. This debug mode is available with
|
|
|
|
|
GCC 3.4.0 and later versions. </p>
|
2003-11-11 21:09:16 +01:00
|
|
|
|
|
|
|
|
<p>The libstdc++ debug mode performs checking for many areas of the C++
|
|
|
|
|
standard, but the focus is on checking interactions among standard
|
|
|
|
|
iterators, containers, and algorithms, including:</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
<li><em>Safe iterators</em>: Iterators keep track of the
|
|
|
|
|
container whose elements they reference, so errors such as
|
|
|
|
|
incrementing a past-the-end iterator or dereferencing an iterator
|
|
|
|
|
that points to a container that has been destructed are diagnosed
|
|
|
|
|
immediately.</li>
|
|
|
|
|
|
|
|
|
|
<li><em>Algorithm preconditions</em>: Algorithms attempt to
|
|
|
|
|
validate their input parameters to detect errors as early as
|
|
|
|
|
possible. For instance, the <code>set_intersection</code>
|
|
|
|
|
algorithm requires that its iterator
|
|
|
|
|
parameters <code>first1</code> and <code>last1</code> form a valid
|
|
|
|
|
iterator range, and that the sequence
|
|
|
|
|
[<code>first1</code>, <code>last1</code>) is sorted according to
|
|
|
|
|
the same predicate that was passed
|
|
|
|
|
to <code>set_intersection</code>; the libstdc++ debug mode will
|
|
|
|
|
detect an error if the sequence is not sorted or was sorted by a
|
|
|
|
|
different predicate.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<h4 class="left">Using the libstdc++ debug mode</h4>
|
|
|
|
|
<p>To use the libstdc++ debug mode, compile your application with the
|
|
|
|
|
compiler flag <code>-D_GLIBCXX_DEBUG</code>. Note that this flag
|
|
|
|
|
changes the sizes and behavior of standard class templates such
|
|
|
|
|
as <code>std::vector</code>, and therefore you can only link code
|
|
|
|
|
compiled with debug mode and code compiled without debug mode if no
|
|
|
|
|
instantiation of a container is passed between the two translation
|
|
|
|
|
units.</p>
|
|
|
|
|
|
|
|
|
|
<p>For information about the design of the libstdc++ debug mode,
|
|
|
|
|
please see the <a href="debug_mode.html">libstdc++ debug mode design
|
|
|
|
|
document</a>.</p>
|
|
|
|
|
|
|
|
|
|
<h4 class="left">Using the debugging containers without debug
|
|
|
|
|
mode</h4>
|
|
|
|
|
<p>When it is not feasible to recompile your entire application, or
|
|
|
|
|
only specific containers need checking, debugging containers are
|
|
|
|
|
available as GNU extensions. These debugging containers are
|
|
|
|
|
functionally equivalent to the standard drop-in containers used in
|
|
|
|
|
debug mode, but they are available in a separate namespace as GNU
|
|
|
|
|
extensions and may be used in programs compiled with either release
|
2003-11-14 01:15:00 +01:00
|
|
|
mode or with debug mode. The
|
2003-11-11 21:09:16 +01:00
|
|
|
following table provides the names and headers of the debugging
|
|
|
|
|
containers:
|
2005-02-02 20:38:38 +01:00
|
|
|
</p>
|
2003-11-11 21:09:16 +01:00
|
|
|
|
|
|
|
|
<table title="Debugging containers" border="1">
|
|
|
|
|
<tr>
|
|
|
|
|
<th>Container</th>
|
|
|
|
|
<th>Header</th>
|
|
|
|
|
<th>Debug container</th>
|
|
|
|
|
<th>Debug header</th>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::bitset</td>
|
|
|
|
|
<td><bitset></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::bitset</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/bitset></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::deque</td>
|
|
|
|
|
<td><deque></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::deque</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/deque></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::list</td>
|
|
|
|
|
<td><list></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::list</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/list></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::map</td>
|
|
|
|
|
<td><map></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::map</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/map></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::multimap</td>
|
|
|
|
|
<td><map></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::multimap</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/map></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::multiset</td>
|
|
|
|
|
<td><set></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::multiset</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/set></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::set</td>
|
|
|
|
|
<td><set></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::set</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/set></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::string</td>
|
|
|
|
|
<td><string></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::string</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/string></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::wstring</td>
|
|
|
|
|
<td><string></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::wstring</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/string></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::basic_string</td>
|
|
|
|
|
<td><string></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::basic_string</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/string></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>std::vector</td>
|
|
|
|
|
<td><vector></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::vector</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/vector></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>__gnu_cxx::hash_map</td>
|
|
|
|
|
<td><ext/hash_map></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::hash_map</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/hash_map></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>__gnu_cxx::hash_multimap</td>
|
|
|
|
|
<td><ext/hash_map></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::hash_multimap</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/hash_map></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>__gnu_cxx::hash_set</td>
|
|
|
|
|
<td><ext/hash_set></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::hash_set</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/hash_set></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td>__gnu_cxx::hash_multiset</td>
|
|
|
|
|
<td><ext/hash_set></td>
|
2006-02-09 05:31:38 +01:00
|
|
|
<td>__gnu_debug::hash_multiset</td>
|
2003-11-11 21:09:16 +01:00
|
|
|
<td><debug/hash_set></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h4 class="left">Debug mode semantics</h4>
|
2003-11-14 01:15:00 +01:00
|
|
|
<p>A program that uses the C++ standard library correctly
|
2003-11-11 21:09:16 +01:00
|
|
|
will maintain the same semantics under debug mode as it had with
|
|
|
|
|
the normal (release) library. All functional and exception-handling
|
|
|
|
|
guarantees made by the normal library also hold for the debug mode
|
|
|
|
|
library, with one exception: performance guarantees made by the
|
|
|
|
|
normal library may not hold in the debug mode library. For
|
|
|
|
|
instance, erasing an element in a <code>std::list</code> is a
|
|
|
|
|
constant-time operation in normal library, but in debug mode it is
|
|
|
|
|
linear in the number of iterators that reference that particular
|
|
|
|
|
list. So while your (correct) program won't change its results, it
|
|
|
|
|
is likely to execute more slowly.</p>
|
|
|
|
|
|
|
|
|
|
<p>libstdc++ includes many extensions to the C++ standard library. In
|
|
|
|
|
some cases the extensions are obvious, such as the hashed
|
|
|
|
|
associative containers, whereas other extensions give predictable
|
|
|
|
|
results to behavior that would otherwise be undefined, such as
|
|
|
|
|
throwing an exception when a <code>std::basic_string</code> is
|
|
|
|
|
constructed from a NULL character pointer. This latter category also
|
|
|
|
|
includes implementation-defined and unspecified semantics, such as
|
|
|
|
|
the growth rate of a vector. Use of these extensions is not
|
|
|
|
|
considered incorrect, so code that relies on them will not be
|
|
|
|
|
rejected by debug mode. However, use of these extensions may affect
|
|
|
|
|
the portability of code to other implementations of the C++ standard
|
|
|
|
|
library, and is therefore somewhat hazardous. For this reason, the
|
|
|
|
|
libstdc++ debug mode offers a "pedantic" mode (similar to
|
|
|
|
|
GCC's <code>-pedantic</code> compiler flag) that attempts to emulate
|
2003-11-14 01:15:00 +01:00
|
|
|
the semantics guaranteed by the C++ standard. For
|
2003-11-11 21:09:16 +01:00
|
|
|
instance, constructing a <code>std::basic_string</code> with a NULL
|
|
|
|
|
character pointer would result in an exception under normal mode or
|
|
|
|
|
non-pedantic debug mode (this is a libstdc++ extension), whereas
|
|
|
|
|
under pedantic debug mode libstdc++ would signal an error. To enable
|
|
|
|
|
the pedantic debug mode, compile your program with
|
|
|
|
|
both <code>-D_GLIBCXX_DEBUG</code>
|
2005-05-23 23:53:46 +02:00
|
|
|
and <code>-D_GLIBCXX_DEBUG_PEDANTIC</code> .
|
|
|
|
|
(N.B. In GCC 3.4.x and 4.0.0, due to a bug,
|
|
|
|
|
<code>-D_GLIBXX_DEBUG_PEDANTIC</code> was also needed. The problem has
|
|
|
|
|
been fixed in GCC 4.0.1 and later versions.) </p>
|
2003-11-11 21:09:16 +01:00
|
|
|
|
|
|
|
|
<p>The following library components provide extra debugging
|
|
|
|
|
capabilities in debug mode:</p>
|
|
|
|
|
<ul>
|
2003-11-14 01:15:00 +01:00
|
|
|
<li><code>std::basic_string</code> (no safe iterators)</li>
|
2003-11-11 21:09:16 +01:00
|
|
|
<li><code>std::bitset</code></li>
|
|
|
|
|
<li><code>std::deque</code></li>
|
|
|
|
|
<li><code>std::list</code></li>
|
|
|
|
|
<li><code>std::map</code></li>
|
|
|
|
|
<li><code>std::multimap</code></li>
|
|
|
|
|
<li><code>std::multiset</code></li>
|
|
|
|
|
<li><code>std::set</code></li>
|
|
|
|
|
<li><code>std::vector</code></li>
|
2005-12-19 01:56:05 +01:00
|
|
|
<li><code>__gnu_cxx::hash_map</code></li>
|
|
|
|
|
<li><code>__gnu_cxx::hash_multimap</code></li>
|
|
|
|
|
<li><code>__gnu_cxx::hash_multiset</code></li>
|
|
|
|
|
<li><code>__gnu_cxx::hash_set</code></li>
|
2003-11-11 21:09:16 +01:00
|
|
|
</ul>
|
|
|
|
|
|
2002-12-19 09:18:14 +01:00
|
|
|
|
|
|
|
|
<h3 class="left"><a name="mem">Tips for memory leak hunting</a></h3>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>There are various third party memory tracing and debug utilities
|
2002-12-19 09:18:14 +01:00
|
|
|
that can be used to provide detailed memory allocation information
|
|
|
|
|
about C++ code. An exhaustive list of tools is not going to be
|
2003-03-13 01:15:59 +01:00
|
|
|
attempted, but includes <code>mtrace</code>, <code>valgrind</code>,
|
2003-11-11 21:09:16 +01:00
|
|
|
<code>mudflap</code>, and the non-free commercial product
|
|
|
|
|
<code>purify</code>. In addition, <code>libcwd</code> has a
|
|
|
|
|
replacement for the global new and delete operators that can track
|
|
|
|
|
memory allocation and deallocation and provide useful memory
|
|
|
|
|
statistics.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>Regardless of the memory debugging tool being used, there is one
|
2002-12-19 09:18:14 +01:00
|
|
|
thing of great importance to keep in mind when debugging C++ code
|
|
|
|
|
that uses <code>new</code> and <code>delete</code>:
|
|
|
|
|
there are different kinds of allocation schemes that can be used by
|
|
|
|
|
<code> std::allocator </code>. For implementation details, see this
|
2003-03-13 01:15:59 +01:00
|
|
|
<a href="ext/howto.html#3"> document</a> and look specifically for
|
2003-07-28 06:13:58 +02:00
|
|
|
<code>GLIBCXX_FORCE_NEW</code>.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>In a nutshell, the default allocator used by <code>
|
2002-12-19 09:18:14 +01:00
|
|
|
std::allocator</code> is a high-performance pool allocator, and can
|
2003-11-11 21:09:16 +01:00
|
|
|
give the mistaken impression that in a suspect executable, memory
|
|
|
|
|
is being leaked, when in reality the memory "leak" is a pool being
|
|
|
|
|
used by the library's allocator and is reclaimed after program
|
|
|
|
|
termination.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>For valgrind, there are some specific items to keep in mind. First
|
2002-12-19 09:18:14 +01:00
|
|
|
of all, use a version of valgrind that will work with current GNU
|
|
|
|
|
C++ tools: the first that can do this is valgrind 1.0.4, but later
|
|
|
|
|
versions should work at least as well. Second of all, use a
|
|
|
|
|
completely unoptimized build to avoid confusing valgrind. Third,
|
2003-07-28 06:13:58 +02:00
|
|
|
use GLIBCXX_FORCE_NEW to keep extraneous pool allocation noise from
|
2003-11-11 21:09:16 +01:00
|
|
|
cluttering debug information.
|
2002-12-19 09:18:14 +01:00
|
|
|
</p>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>Fourth, it may be necessary to force deallocation in other
|
2002-12-19 09:18:14 +01:00
|
|
|
libraries as well, namely the "C" library. On linux, this can be
|
|
|
|
|
accomplished with the appropriate use of the
|
|
|
|
|
<code>__cxa_atexit</code> or <code>atexit</code> functions.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
2002-12-26 22:14:19 +01:00
|
|
|
#include <cstdlib>
|
2002-12-19 09:18:14 +01:00
|
|
|
|
|
|
|
|
extern "C" void __libc_freeres(void);
|
|
|
|
|
|
|
|
|
|
void do_something() { }
|
|
|
|
|
|
|
|
|
|
int main()
|
|
|
|
|
{
|
|
|
|
|
atexit(__libc_freeres);
|
2002-12-26 22:14:19 +01:00
|
|
|
do_something();
|
2002-12-19 09:18:14 +01:00
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>or, using <code>__cxa_atexit</code>:</p>
|
2002-12-19 09:18:14 +01:00
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
extern "C" void __libc_freeres(void);
|
|
|
|
|
extern "C" int __cxa_atexit(void (*func) (void *), void *arg, void *d);
|
|
|
|
|
|
|
|
|
|
void do_something() { }
|
|
|
|
|
|
|
|
|
|
int main()
|
|
|
|
|
{
|
|
|
|
|
extern void* __dso_handle __attribute__ ((__weak__));
|
|
|
|
|
__cxa_atexit((void (*) (void *)) __libc_freeres, NULL,
|
2002-12-26 22:14:19 +01:00
|
|
|
&__dso_handle ? __dso_handle : NULL);
|
2002-12-19 09:18:14 +01:00
|
|
|
do_test();
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
</pre>
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>Suggested valgrind flags, given the suggestions above about setting
|
2002-12-19 09:18:14 +01:00
|
|
|
up the runtime environment, library, and test file, might be:
|
|
|
|
|
</p>
|
2003-03-13 01:15:59 +01:00
|
|
|
<pre>
|
|
|
|
|
valgrind -v --num-callers=20 --leak-check=yes --leak-resolution=high --show-reachable=yes a.out
|
|
|
|
|
</pre>
|
2002-12-19 09:18:14 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 class="left"><a name="gdb">Some gdb strategies</a></h3>
|
2002-12-26 22:14:19 +01:00
|
|
|
<p>Many options are available for gdb itself: please see <a
|
2003-03-13 01:15:59 +01:00
|
|
|
href="http://sources.redhat.com/gdb/current/onlinedocs/gdb_13.html#SEC109">
|
2002-12-26 22:14:19 +01:00
|
|
|
"GDB features for C++" </a> in the gdb documentation. Also
|
|
|
|
|
recommended: the other parts of this manual.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>These settings can either be switched on in at the gdb command
|
2002-12-19 09:18:14 +01:00
|
|
|
line, or put into a .gdbint file to establish default debugging
|
|
|
|
|
characteristics, like so:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
set print pretty on
|
|
|
|
|
set print object on
|
|
|
|
|
set print static-members on
|
|
|
|
|
set print vtbl on
|
|
|
|
|
set print demangle on
|
|
|
|
|
set demangle-style gnu-v3
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
|
2002-12-26 22:14:19 +01:00
|
|
|
<h3 class="left"><a name="verbterm">Tracking uncaught exceptions</a></h3>
|
|
|
|
|
<p>The <a href="19_diagnostics/howto.html#4">verbose termination handler</a>
|
|
|
|
|
gives information about uncaught exceptions which are killing the
|
|
|
|
|
program. It is described in the linked-to page.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
2002-12-19 09:18:14 +01:00
|
|
|
<p>Return <a href="#top">to the top of the page</a> or
|
|
|
|
|
<a href="http://gcc.gnu.org/libstdc++/">to the libstdc++ homepage</a>.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ####################################################### -->
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
|
<p class="fineprint"><em>
|
|
|
|
|
See <a href="17_intro/license.html">license.html</a> for copying conditions.
|
|
|
|
|
Comments and suggestions are welcome, and may be sent to
|
|
|
|
|
<a href="mailto:libstdc++@gcc.gnu.org">the libstdc++ mailing list</a>.
|
|
|
|
|
</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
