Mentions légales du service

Skip to content
Snippets Groups Projects
README 3.26 KiB
Newer Older
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.
Julian Seward's avatar
Julian Seward committed

Nicholas Nethercote's avatar
 
Nicholas Nethercote committed
If you have problems, consult the FAQ to see if there are workarounds.

Julian Seward's avatar
Julian Seward committed

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.
Nicholas Nethercote's avatar
 
Nicholas Nethercote committed

The Valgrind distribution currently includes seven production-quality
tools: a memory error detector, two thread error detectors, a cache
and branch-prediction profiler, a call-graph generating cache and
branch-prediction profiler, and two heap profilers. It also includes
one experimental tool: a SimPoint basic block vector generator.
Nicholas Nethercote's avatar
 
Nicholas Nethercote committed

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: 

Julian Seward's avatar
Julian Seward committed
- X86/Linux
Nicholas Nethercote's avatar
 
Nicholas Nethercote committed
- AMD64/Linux
- PPC32/Linux
- PPC64/Linux
- S390X/Linux
Julian Seward's avatar
Julian Seward committed
- MIPS32/Linux
- nanoMIPS/Linux
- X86/Solaris
- AMD64/Solaris
Paul Floyd's avatar
Paul Floyd committed
- X86/FreeBSD
- AMD64/FreeBSD
- ARM64/FreeBSD
Nicholas Nethercote's avatar
 
Nicholas Nethercote committed

Julian Seward's avatar
Julian Seward committed
Note that AMD64 is just another name for x86_64, and Valgrind runs fine
on Intel processors.  Also note that the core of macOS is called
Nicholas Nethercote's avatar
 
Nicholas Nethercote committed
"Darwin" and this name is used sometimes.
Julian Seward's avatar
Julian Seward committed

Valgrind is licensed under the GNU General Public License, version 2. 
Read the file COPYING in the source distribution for details.
Julian Seward's avatar
Julian Seward committed

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

Julian Seward's avatar
Julian Seward committed

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 GIT repository:
Julian Seward's avatar
Julian Seward committed

  0. Clone the code from GIT:
     git clone https://sourceware.org/git/valgrind.git
     There are further instructions at
Nicholas Nethercote's avatar
Nicholas Nethercote committed
     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).
Nicholas Nethercote's avatar
 
Nicholas Nethercote committed

Nicholas Nethercote's avatar
Nicholas Nethercote committed
  3. Continue with the following instructions...

Nicholas Nethercote's avatar
 
Nicholas Nethercote committed

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

  6. Run "make install", possibly as root if the destination permissions
Nicholas Nethercote's avatar
Nicholas Nethercote committed
  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 http://valgrind.org/support/bug_reports.html).

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.


Nicholas Nethercote's avatar
Nicholas Nethercote committed
The Valgrind Developers