Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / valgrind / 801288e7153eb205f7b68dfc36d6e704f39029f7 / . / README
blob: 71c525fddfc84ad1c95b5e3ab274da2b9f4dfeb9 [file] [log] [blame]
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]1
nethercote5da1e172003-12-03 21:44:45 +0000[diff] [blame]2Release notes for Valgrind
3~~~~~~~~~~~~~~~~~~~~~~~~~~
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]4If you are building a binary package of Valgrind for distribution,
5please read README_PACKAGERS. It contains some important information.
sewardj365a8512002-07-01 08:30:05 +0000[diff] [blame]6
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]7If you are developing Valgrind, please read README_DEVELOPERS. It contains
8some useful information.
9
10For instructions on how to build/install, see the end of this file.
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]11
njn4be4e2a2009-06-12 23:40:04 +0000[diff] [blame]12If you have problems, consult the FAQ to see if there are workarounds.
13
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]14
15Executive Summary
16~~~~~~~~~~~~~~~~~
njn4be4e2a2009-06-12 23:40:04 +0000[diff] [blame]17Valgrind is an award-winning instrumentation framework for building
18dynamic analysis tools. There are Valgrind tools that can automatically
19detect many memory management and threading bugs, and profile your
20programs in detail. You can also use Valgrind to build new tools.
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]21
njn4be4e2a2009-06-12 23:40:04 +0000[diff] [blame]22The Valgrind distribution currently includes six production-quality
23tools: a memory error detector, two thread error detectors, a cache and
24branch-prediction profiler, a call-graph generating cache profiler, and
njn57b87ea2009-07-14 04:24:18 +0000[diff] [blame]25a heap profiler. It also includes two experimental tools: a
26heap/stack/global array overrun detector, and a SimPoint basic block vector
27generator.
nethercote5da1e172003-12-03 21:44:45 +0000[diff] [blame]28
njn4be4e2a2009-06-12 23:40:04 +0000[diff] [blame]29Valgrind is closely tied to details of the CPU, operating system and to
30a lesser extent, compiler and basic C libraries. This makes it difficult
31to make it portable. Nonetheless, it is available for the following
32platforms:
nethercote5da1e172003-12-03 21:44:45 +0000[diff] [blame]33
njn4be4e2a2009-06-12 23:40:04 +0000[diff] [blame]34- x86/Linux
35- AMD64/Linux
36- PPC32/Linux
37- PPC64/Linux
38- x86/MacOSX
39- AMD64/MacOSX
njn567c0142006-03-31 12:24:37 +0000[diff] [blame]40
njn4be4e2a2009-06-12 23:40:04 +0000[diff] [blame]41Note that AMD64 is just another name for x86-64, and Valgrind runs fine
42on Intel processors. Also note that the core of MacOSX is called
43"Darwin" and this name is used sometimes.
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]44
45Valgrind is licensed under the GNU General Public License, version 2.
njn25e49d8e72002-09-23 09:36:25 +0000[diff] [blame]46Read the file COPYING in the source distribution for details.
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]47
48
49Documentation
50~~~~~~~~~~~~~
51A comprehensive user guide is supplied. Point your browser at
nethercote5da1e172003-12-03 21:44:45 +0000[diff] [blame]52$PREFIX/share/doc/valgrind/manual.html, where $PREFIX is whatever you
53specified with --prefix= when building.
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]54
55
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]56Building and installing it
57~~~~~~~~~~~~~~~~~~~~~~~~~~
njn0d733b82005-07-26 22:01:04 +0000[diff] [blame]58To install from the Subversion repository :
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]59
njn0d733b82005-07-26 22:01:04 +0000[diff] [blame]60 0. Check out the code from SVN, following the instructions at
njn1b70e822005-11-08 19:38:58 +0000[diff] [blame]61 http://www.valgrind.org/downloads/repository.html.
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]62
63 1. cd into the source directory.
64
65 2. Run ./autogen.sh to setup the environment (you need the standard
66 autoconf tools to do so).
67
njn0d733b82005-07-26 22:01:04 +0000[diff] [blame]68 3. Continue with the following instructions...
69
nethercote5da1e172003-12-03 21:44:45 +0000[diff] [blame]70To install from a tar.bz2 distribution:
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]71
njn801288e2009-08-04 07:02:54 +0000[diff] [blame^]72 4. Run ./configure, with some options if you wish. The only interesting
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]73 one is the usual --prefix=/where/you/want/it/installed.
74
njn8b68b642009-06-24 00:37:09 +0000[diff] [blame]75 5. Run "make".
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]76
njn8b68b642009-06-24 00:37:09 +0000[diff] [blame]77 6. Run "make install", possibly as root if the destination permissions
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]78 require that.
79
njn0d733b82005-07-26 22:01:04 +0000[diff] [blame]80 7. See if it works. Try "valgrind ls -l". Either this works, or it
81 bombs out with some complaint. In that case, please let us know
82 (see www.valgrind.org).
nethercoteed7e0732003-12-02 15:30:28 +0000[diff] [blame]83
84Important! Do not move the valgrind installation into a place
85different from that specified by --prefix at build time. This will
86cause things to break in subtle ways, mostly when Valgrind handles
87fork/exec calls.
88
sewardjde4a1d02002-03-22 01:27:54 +0000[diff] [blame]89
njn1b70e822005-11-08 19:38:58 +0000[diff] [blame]90The Valgrind Developers