source: general/prog/valgrind.xml@ 5c22cb01

systemd-13485
Last change on this file since 5c22cb01 was 5c22cb01, checked in by Douglas R. Reno <renodr@…>, 6 years ago

Updated lsof URL. Merged from trunk r17090
Updated PIN-Entry dependencies. Merged from trunk r17090
Updated Valgrind dependencies. Merged from trunk r17090
Added note about OpenSSL's Test Suite not supporting parallel make jobs. Merged from trunk r17090.
Restored autoconf to libva-intel-driver. Merged from trunk r17090
Updated to Sudo-1.8.16. Merged from trunk r17127
Changed the configure script in the GCC-5.3.0 page to use the new configure switch for the libstdc++ ABI.
Updated to OpenSSH-7.2p2. Merged from trunk r17106.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17199 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 10.2 KB
Line 
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
7 <!ENTITY valgrind-download-http "http://valgrind.org/downloads/valgrind-&valgrind-version;.tar.bz2">
8 <!ENTITY valgrind-download-ftp " ">
9 <!ENTITY valgrind-md5sum "4ea62074da73ae82e0162d6550d3f129">
10 <!ENTITY valgrind-size "10.5 MB">
11 <!ENTITY valgrind-buildsize "343 MB (additional 228 MB for tests)">
12 <!ENTITY valgrind-time "1.2 SBU (additional 5.1 SBU for tests)">
13]>
14
15<sect1 id="valgrind" xreflabel="Valgrind-&valgrind-version;">
16 <?dbhtml filename="valgrind.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Valgrind-&valgrind-version;</title>
24
25 <indexterm zone="valgrind">
26 <primary sortas="a-Valgrind">Valgrind</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Valgrind</title>
31
32 <para>
33 <application>Valgrind</application> is an instrumentation framework for
34 building dynamic analysis tools. There are Valgrind tools that can
35 automatically detect many memory management and threading bugs, and
36 profile programs in detail. Valgrind can also be used to build new
37 tools.
38 </para>
39
40 &lfs79_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&valgrind-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&valgrind-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &valgrind-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &valgrind-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &valgrind-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &valgrind-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
77 <itemizedlist spacing="compact">
78 <listitem>
79 <para>
80 Required patch:
81 <ulink url="&patch-root;/valgrind-&valgrind-version;-pthread_barrier_fix-1.patch"/>
82 </para>
83 </listitem>
84 </itemizedlist>
85
86 <bridgehead renderas="sect3">Valgrind Dependencies</bridgehead>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="boost"/>,
91 <xref linkend="llvm"/> (with Clang),
92 <xref linkend="gdb"/> (for tests),
93 <xref linkend="which"/> (for tests),
94 <xref linkend="bind"/> or <xref linkend="bind-utils"/> (for tests), and
95 <ulink url="http://www.openmp.org">OpenMP</ulink>
96 </para>
97
98 <bridgehead renderas="sect4">Optional for regenerating the documentation</bridgehead>
99 <para role="optional">
100 <xref linkend="libxslt"/> and
101 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
102 </para>
103
104 <para condition="html" role="usernotes">User Notes:
105 <ulink url="&blfs-wiki;/valgrind"/>
106 </para>
107 </sect2>
108
109 <sect2 role="installation">
110 <title>Installation of Valgrind</title>
111
112 <para>
113 Install <application>Valgrind</application> by running the following
114 commands:
115 </para>
116
117<screen><userinput>patch -Np1 -i ../valgrind-3.11.0-pthread_barrier_fix-1.patch &amp;&amp;
118
119sed -i 's|/doc/valgrind||' docs/Makefile.in &amp;&amp;
120./configure --prefix=/usr \
121 --datadir=/usr/share/doc/valgrind-&valgrind-version; &amp;&amp;
122make</userinput></screen>
123
124 <para>
125 To test the results, issue: <command>make regtest</command>. The tests
126 may hang forever if <xref linkend="gdb"/> is not installed.
127 </para>
128<!-- Note to maintainer: Recheck when next texlive (2015) is released.
129 <para>
130 If you wish to regenerate the documentation, run:
131 </para>
132
133<screen><userinput>make -C docs download-docs</userinput></screen>
134-->
135 <para>
136 Now, as the <systemitem class="username">root</systemitem> user:
137 </para>
138
139<screen role="root"><userinput>make install</userinput></screen>
140
141 </sect2>
142
143 <sect2 role="commands">
144 <title>Command Explanations</title>
145
146 <para>
147 <command>sed -i ... docs/Makefile.in </command>: This sed provides for
148 installing the documentation in a versioned directory.
149 </para>
150
151 </sect2>
152
153 <sect2 role="content">
154 <title>Contents</title>
155
156 <segmentedlist>
157 <segtitle>Installed Programs</segtitle>
158 <segtitle>Installed Library</segtitle>
159 <segtitle>Installed Directories</segtitle>
160
161 <seglistitem>
162 <seg>
163 callgrind_annotate,
164 callgrind_control,
165 cg_annotate,
166 cg_diff,
167 cg_merge,
168 ms_print,
169 valgrind,
170 valgrind-di-server,
171 valgrind-listener, and
172 vgdb
173 </seg>
174 <seg>
175 libcoregrind-&lt;Arch&gt;-linux.a,
176 libreplacemalloc_toolpreload-&lt;Arch&gt;-linux.a,
177 libvex-&lt;Arch&gt;-linux.a,
178 libvexmultiarch-amd64-linux.a,
179 vgpreload_core-&lt;Arch&gt;-linux.so,
180 vgpreload_drd-&lt;Arch&gt;-linux.so,
181 vgpreload_exp-dhat-&lt;Arch&gt;-linux.so,
182 vgpreload_exp-sgcheck-&lt;Arch&gt;-linux.so,
183 vgpreload_helgrind-&lt;Arch&gt;-linux.so,
184 vgpreload_massif-&lt;Arch&gt;-linux.so, and
185 vgpreload_memcheck-&lt;Arch&gt;-linux.so, where
186 &lt;Arch&gt; is x86 or amd64
187 </seg>
188 <seg>
189 /usr/lib/valgrind,
190 /usr/include/valgrind, and
191 /usr/share/doc/valgrind-&valgrind-version;
192 </seg>
193 </seglistitem>
194 </segmentedlist>
195
196 <variablelist>
197 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
198 <?dbfo list-presentation="list"?>
199 <?dbhtml list-presentation="table"?>
200
201 <varlistentry id="valgrind-prog">
202 <term><command>valgrind</command></term>
203 <listitem>
204 <para>
205 is a program for debugging and profiling Linux executables.
206 </para>
207 <indexterm zone="valgrind valgrind-prog">
208 <primary sortas="b-valgrind">valgrind</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="callgrind_annotate">
214 <term><command>callgrind_annotate</command></term>
215 <listitem>
216 <para>
217 takes an output file produced by the
218 <application>Valgrind</application> tool Callgrind and prints the
219 information in an easy-to-read form.
220 </para>
221 <indexterm zone="callgrind_annotate">
222 <primary sortas="b-callgrind_annotate">callgrind_annotate</primary>
223 </indexterm>
224 </listitem>
225 </varlistentry>
226
227 <varlistentry id="callgrind_control">
228 <term><command>callgrind_control</command></term>
229 <listitem>
230 <para>
231 controls programs being run by the <application>Valgrind</application>
232 tool Callgrind.
233 </para>
234 <indexterm zone="valgrind callgrind_control">
235 <primary sortas="b-callgrind_control">callgrind_control</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="cg_annotate">
241 <term><command>cg_annotate</command></term>
242 <listitem>
243 <para>
244 is a post-processing tool for the <application>Valgrind</application>
245 tool Cachegrind.
246 </para>
247 <indexterm zone="valgrind cg_annotate">
248 <primary sortas="b-cg_annotate">cg_annotate</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="cg_diff">
254 <term><command>cg_diff</command></term>
255 <listitem>
256 <para>
257 compares two Cachegrind output files.
258 </para>
259 <indexterm zone="valgrind cg_diff">
260 <primary sortas="b-cg_diff">cg_diff</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="cg_merge">
266 <term><command>cg_merge</command></term>
267 <listitem>
268 <para>
269 merges multiple Cachegrind output files into one.
270 </para>
271 <indexterm zone="valgrind cg_merge">
272 <primary sortas="b-cg_merge">cg_merge</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="ms_print">
278 <term><command>ms_print</command></term>
279 <listitem>
280 <para>
281 takes an output file produced by the <application>Valgrind</application>
282 tool Massif and prints the information in an easy-to-read form.
283 </para>
284 <indexterm zone="valgrind ms_print">
285 <primary sortas="b-ms_print">ms_print</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="valgrind-di-server">
291 <term><command>valgrind-di-server</command></term>
292 <listitem>
293 <para>
294 is a server that reads debuginfo from objects stored on a
295 different machine.
296 </para>
297 <indexterm zone="valgrind valgrind-di-server">
298 <primary sortas="b-valgrind-di-server">valgrind-di-server</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="valgrind-listener">
304 <term><command>valgrind-listener</command></term>
305 <listitem>
306 <para>
307 listens on a socket for Valgrind commentary.
308 </para>
309 <indexterm zone="valgrind valgrind-listener">
310 <primary sortas="b-valgrind-listener">valgrind-listener</primary>
311 </indexterm>
312 </listitem>
313 </varlistentry>
314
315 <varlistentry id="vgdb">
316 <term><command>vgdb</command></term>
317 <listitem>
318 <para>
319 is an intermediary between Valgrind and GDB or a shell.
320 </para>
321 <indexterm zone="valgrind vgdb">
322 <primary sortas="b-vgdb">vgdb</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 </variablelist>
328
329 </sect2>
330
331</sect1>
Note: See TracBrowser for help on using the repository browser.