Cross Reference: /external/valgrind/main/

Release notes for Valgrind
~~~~~~~~~~~~~~~~~~~~~~~~~~
If you are building a binary package of Valgrind for distribution,
please read README_PACKAGERS.  It contains some important information.

If you are developing Valgrind, please read README_DEVELOPERS.  It contains
some useful information.

For instructions on how to build/install, see the end of this file.

If you have problems, consult the FAQ to see if there are workarounds.


Executive Summary
~~~~~~~~~~~~~~~~~
Valgrind is a framework for building dynamic analysis tools. There are
Valgrind tools that can automatically detect many memory management
and threading bugs, and profile your programs in detail. You can also
use Valgrind to build new tools.

The Valgrind distribution currently includes six production-quality
tools: a memory error detector, two thread error detectors, a cache
and branch-prediction profiler, a call-graph generating cache abd
branch-prediction profiler, and a heap profiler. It also includes
three experimental tools: a heap/stack/global array overrun detector,
a different kind of heap profiler, and a SimPoint basic block vector
generator.

Valgrind is closely tied to details of the CPU, operating system and to
a lesser extent, compiler and basic C libraries. This makes it difficult
to make it portable.  Nonetheless, it is available for the following
platforms:

- X86/Linux
- AMD64/Linux
- PPC32/Linux
- PPC64/Linux
- ARM/Linux
- x86/MacOSX
- AMD64/MacOSX
- S390X/Linux
- MIPS32/Linux
- MIPS64/Linux

Note that AMD64 is just another name for x86_64, and Valgrind runs fine
on Intel processors.  Also note that the core of MacOSX is called
"Darwin" and this name is used sometimes.

Valgrind is licensed under the GNU General Public License, version 2.
Read the file COPYING in the source distribution for details.

However: if you contribute code, you need to make it available as GPL
version 2 or later, and not 2-only.


Documentation
~~~~~~~~~~~~~
A comprehensive user guide is supplied.  Point your browser at
$PREFIX/share/doc/valgrind/manual.html, where $PREFIX is whatever you
specified with --prefix= when building.


Building and installing it
~~~~~~~~~~~~~~~~~~~~~~~~~~
To install from the Subversion repository :

  0. Check out the code from SVN, following the instructions at
     http://www.valgrind.org/downloads/repository.html.

  1. cd into the source directory.

  2. Run ./autogen.sh to setup the environment (you need the standard
     autoconf tools to do so).

  3. Continue with the following instructions...

To install from a tar.bz2 distribution:

  4. Run ./configure, with some options if you wish.  The only interesting
     one is the usual --prefix=/where/you/want/it/installed.

  5. Run "make".

  6. Run "make install", possibly as root if the destination permissions
     require that.

  7. See if it works.  Try "valgrind ls -l".  Either this works, or it
     bombs out with some complaint.  In that case, please let us know
     (see www.valgrind.org).

Important!  Do not move the valgrind installation into a place
different from that specified by --prefix at build time.  This will
cause things to break in subtle ways, mostly when Valgrind handles
fork/exec calls.


The Valgrind Developers
Name	Date	Size
..	12-Mar-2015	4 KiB
Android.build_all.mk	12-Mar-2015	964
Android.build_one.mk	12-Mar-2015	1.9 KiB
Android.clean.mk	12-Mar-2015	900
Android.mk	12-Mar-2015	16.9 KiB
Android.test.mk	12-Mar-2015	159
AUTHORS	12-Mar-2015	3.2 KiB
autogen.sh	12-Mar-2015	191
auxprogs/	12-Mar-2015	4 KiB
bionic.supp	12-Mar-2015	1.3 KiB
cachegrind/	12-Mar-2015	4 KiB
callgrind/	12-Mar-2015	4 KiB
config.h	12-Mar-2015	10.6 KiB
COPYING	12-Mar-2015	17.6 KiB
COPYING.DOCS	12-Mar-2015	19.9 KiB
coregrind/	12-Mar-2015	4 KiB
darwin10-drd.supp	12-Mar-2015	2.5 KiB
darwin10.supp	12-Mar-2015	1.7 KiB
darwin11.supp	12-Mar-2015	6.1 KiB
darwin12.supp	12-Mar-2015	7.2 KiB
darwin9-drd.supp	12-Mar-2015	10 KiB
darwin9.supp	12-Mar-2015	7 KiB
docs/	12-Mar-2015	4 KiB
drd/	12-Mar-2015	4 KiB
exp-bbv/	12-Mar-2015	4 KiB
exp-dhat/	12-Mar-2015	4 KiB
exp-sgcheck/	12-Mar-2015	4 KiB
exp-sgcheck.supp	12-Mar-2015	372
gdbserver_tests/	12-Mar-2015	12 KiB
glibc-2.2-LinuxThreads-helgrind.supp	12-Mar-2015	1.2 KiB
glibc-2.2.supp	12-Mar-2015	9.3 KiB
glibc-2.3.supp	12-Mar-2015	11 KiB
glibc-2.34567-NPTL-helgrind.supp	12-Mar-2015	5.8 KiB
glibc-2.4.supp	12-Mar-2015	4.7 KiB
glibc-2.5.supp	12-Mar-2015	3.8 KiB
glibc-2.6.supp	12-Mar-2015	4.7 KiB
glibc-2.7.supp	12-Mar-2015	695
glibc-2.X-drd.supp	12-Mar-2015	6.6 KiB
glibc-2.X.supp	12-Mar-2015	4.6 KiB
glibc-2.X.supp.in	12-Mar-2015	5.2 KiB
helgrind/	12-Mar-2015	4 KiB
include/	12-Mar-2015	4 KiB
lackey/	12-Mar-2015	4 KiB
Makefile.all.am	12-Mar-2015	8.9 KiB
Makefile.am	12-Mar-2015	3.3 KiB
Makefile.tool-tests.am	12-Mar-2015	1.4 KiB
Makefile.tool.am	12-Mar-2015	5.8 KiB
Makefile.vex.am	12-Mar-2015	4.7 KiB
massif/	12-Mar-2015	4 KiB
memcheck/	12-Mar-2015	4 KiB
MODULE_LICENSE_GPL	12-Mar-2015	0
mpi/	12-Mar-2015	4 KiB
NEWS	12-Mar-2015	109.4 KiB
NEWS.old	12-Mar-2015	84.6 KiB
nightly/	12-Mar-2015	4 KiB
none/	12-Mar-2015	4 KiB
perf/	12-Mar-2015	4 KiB
README	12-Mar-2015	3.2 KiB
README.aarch64	12-Mar-2015	6.9 KiB
README.android	12-Mar-2015	6.3 KiB
README.android_emulator	12-Mar-2015	1.8 KiB
README.mips	12-Mar-2015	2.2 KiB
README.s390	12-Mar-2015	1.9 KiB
README_DEVELOPERS	12-Mar-2015	11.1 KiB
README_DEVELOPERS_processes	12-Mar-2015	3.5 KiB
README_MISSING_SYSCALL_OR_IOCTL	12-Mar-2015	6.8 KiB
README_PACKAGERS	12-Mar-2015	4.4 KiB
shared/	12-Mar-2015	4 KiB
tests/	12-Mar-2015	4 KiB
valgrind.pc.in	12-Mar-2015	447
valgrind.spec.in	12-Mar-2015	1.2 KiB
VEX/	12-Mar-2015	4 KiB
vg-in-place	12-Mar-2015	691
xfree-3.supp	12-Mar-2015	2.9 KiB
xfree-4.supp	12-Mar-2015	8.8 KiB