docs/xml/manual-intro.xml

   1 <?xml version="1.0"?> <!-- -*- sgml -*- -->
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
   4 [ <!ENTITY % vg-entities SYSTEM "vg-entities.xml"> %vg-entities; ]>
   5
   6 <chapter id="manual-intro" xreflabel="Introduction">
   7 <title>Introduction</title>
   8
   9 <sect1 id="manual-intro.overview" xreflabel="An Overview of Valgrind">
  10 <title>An Overview of Valgrind</title>
  11
  12 <para>Valgrind is an instrumentation framework for building dynamic analysis
  13 tools.  It comes with a set of tools each of which performs some kind of
  14 debugging, profiling, or similar task that helps you improve your programs.
  15 Valgrind's architecture is modular, so new tools can be created easily
  16 and without disturbing the existing structure.</para>
  17
  18 <para>A number of useful tools are supplied as standard.</para>
  19
  20 <orderedlist>
  21
  22   <listitem>
  23     <para><command>Memcheck</command> is a memory error detector.  It helps
  24     you make your programs, particularly those written in C and C++, more
  25     correct.</para>
  26   </listitem>
  27
  28   <listitem>
  29     <para><command>Cachegrind</command> is a cache and branch-prediction
  30     profiler.  It helps you make your programs run faster.</para>
  31   </listitem>
  32
  33   <listitem>
  34     <para><command>Callgrind</command> is a call-graph generating cache
  35     profiler.  It has some overlap with Cachegrind, but also gathers some
  36     information that Cachegrind does not.</para>
  37   </listitem>
  38
  39   <listitem>
  40     <para><command>Helgrind</command> is a thread error detector.
  41     It helps you make your multi-threaded programs more correct.
  42     </para>
  43   </listitem>
  44
  45   <listitem>
  46     <para><command>DRD</command> is also a thread error detector.  It is
  47     similar to Helgrind but uses different analysis techniques and so may
  48     find different problems.</para>
  49   </listitem>
  50
  51   <listitem>
  52     <para><command>Massif</command> is a heap profiler.  It helps you
  53     make your programs use less memory.</para>
  54   </listitem>
  55
  56   <listitem>
  57     <para><command>DHAT</command> is a different kind of heap
  58     profiler.  It helps you understand issues of block lifetimes,
  59     block utilisation, and layout inefficiencies.</para>
  60   </listitem>
  61
  62   <listitem>
  63     <para><command>BBV</command> is an experimental SimPoint basic block
  64     vector generator.  It is useful to people doing computer architecture
  65     research and development.</para>
  66   </listitem>
  67
  68 </orderedlist>
  69
  70 <para>There are also a couple of minor tools that aren't useful to
  71 most users:  <command>Lackey</command> is an example tool that illustrates
  72 some instrumentation basics; and <command>Nulgrind</command> is the minimal
  73 Valgrind tool that does no analysis or instrumentation, and is only useful
  74 for testing purposes.</para>
  75
  76 <para>Valgrind is closely tied to details of the CPU and operating
  77 system, and to a lesser extent, the compiler and basic C libraries.
  78 Nonetheless, it supports a number of widely-used platforms, listed in full
  79 at <ulink url="&vg-url;">&vg-url;</ulink>.</para>
  80
  81 <para>Valgrind is built via the standard Unix
  82 <computeroutput>./configure</computeroutput>,
  83 <computeroutput>make</computeroutput>, <computeroutput>make
  84 install</computeroutput> process;  full details are given in the
  85 README file in the distribution.</para>
  86
  87 <para>Valgrind is licensed under the <xref linkend="license.gpl"/>,
  88 version 2.  The <computeroutput>valgrind/*.h</computeroutput> headers
  89 that you may wish to include in your code (eg.
  90 <filename>valgrind.h</filename>, <filename>memcheck.h</filename>,
  91 <filename>helgrind.h</filename>, etc.) are
  92 distributed under a BSD-style license, so you may include them in your
  93 code without worrying about license conflicts.  Some of the PThreads
  94 test cases, <filename>pth_*.c</filename>, are taken from "Pthreads
  95 Programming" by Bradford Nichols, Dick Buttlar &amp; Jacqueline Proulx
  96 Farrell, ISBN 1-56592-115-1, published by O'Reilly &amp; Associates,
  97 Inc.</para>
  98
  99 <para>If you contribute code to Valgrind, please ensure your
 100 contributions are licensed as "GPLv2, or (at your option) any later
 101 version."  This is so as to allow the possibility of easily upgrading
 102 the license to GPLv3 in future.  If you want to modify code in the VEX
 103 subdirectory, please also see the file VEX/HACKING.README in the
 104 distribution.</para>
 105
 106
 107 </sect1>
 108
 109
 110 <sect1 id="manual-intro.navigation" xreflabel="How to navigate this manual">
 111 <title>How to navigate this manual</title>
 112
 113 <para>This manual's structure reflects the structure of Valgrind itself.
 114 First, we describe the Valgrind core, how to use it, and the options
 115 it supports.  Then, each tool has its own chapter in this manual.  You
 116 only need to read the documentation for the core and for the tool(s) you
 117 actually use, although you may find it helpful to be at least a little
 118 bit familiar with what all tools do.  If you're new to all this, you probably
 119 want to run the Memcheck tool and you might find the <xref
 120 linkend="quick-start"/> useful.</para>
 121
 122 <para>Be aware that the core understands some command line options, and
 123 the tools have their own options which they know about.  This means
 124 there is no central place describing all the options that are
 125 accepted -- you have to read the options documentation both for
 126 <xref linkend="manual-core"/> and for the tool you want to use.</para>
 127
 128
 129 </sect1>
 130
 131 </chapter>