sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 1 | |
nethercote | 5da1e17 | 2003-12-03 21:44:45 +0000 | [diff] [blame] | 2 | Release notes for Valgrind |
| 3 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 4 | If you are building a binary package of Valgrind for distribution, |
| 5 | please read README_PACKAGERS. It contains some important information. |
sewardj | 365a851 | 2002-07-01 08:30:05 +0000 | [diff] [blame] | 6 | |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 7 | If you are developing Valgrind, please read README_DEVELOPERS. It contains |
| 8 | some useful information. |
| 9 | |
| 10 | For instructions on how to build/install, see the end of this file. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 11 | |
njn | 4be4e2a | 2009-06-12 23:40:04 +0000 | [diff] [blame] | 12 | If you have problems, consult the FAQ to see if there are workarounds. |
| 13 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 14 | |
| 15 | Executive Summary |
| 16 | ~~~~~~~~~~~~~~~~~ |
njn | 4be4e2a | 2009-06-12 23:40:04 +0000 | [diff] [blame] | 17 | Valgrind is an award-winning instrumentation framework for building |
| 18 | dynamic analysis tools. There are Valgrind tools that can automatically |
| 19 | detect many memory management and threading bugs, and profile your |
| 20 | programs in detail. You can also use Valgrind to build new tools. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 21 | |
njn | 4be4e2a | 2009-06-12 23:40:04 +0000 | [diff] [blame] | 22 | The Valgrind distribution currently includes six production-quality |
| 23 | tools: a memory error detector, two thread error detectors, a cache and |
| 24 | branch-prediction profiler, a call-graph generating cache profiler, and |
njn | 57b87ea | 2009-07-14 04:24:18 +0000 | [diff] [blame] | 25 | a heap profiler. It also includes two experimental tools: a |
| 26 | heap/stack/global array overrun detector, and a SimPoint basic block vector |
| 27 | generator. |
nethercote | 5da1e17 | 2003-12-03 21:44:45 +0000 | [diff] [blame] | 28 | |
njn | 4be4e2a | 2009-06-12 23:40:04 +0000 | [diff] [blame] | 29 | Valgrind is closely tied to details of the CPU, operating system and to |
| 30 | a lesser extent, compiler and basic C libraries. This makes it difficult |
| 31 | to make it portable. Nonetheless, it is available for the following |
| 32 | platforms: |
nethercote | 5da1e17 | 2003-12-03 21:44:45 +0000 | [diff] [blame] | 33 | |
njn | 4be4e2a | 2009-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 |
njn | 567c014 | 2006-03-31 12:24:37 +0000 | [diff] [blame] | 40 | |
njn | 4be4e2a | 2009-06-12 23:40:04 +0000 | [diff] [blame] | 41 | Note that AMD64 is just another name for x86-64, and Valgrind runs fine |
| 42 | on Intel processors. Also note that the core of MacOSX is called |
| 43 | "Darwin" and this name is used sometimes. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 44 | |
| 45 | Valgrind is licensed under the GNU General Public License, version 2. |
njn25 | e49d8e7 | 2002-09-23 09:36:25 +0000 | [diff] [blame] | 46 | Read the file COPYING in the source distribution for details. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 47 | |
| 48 | |
| 49 | Documentation |
| 50 | ~~~~~~~~~~~~~ |
| 51 | A comprehensive user guide is supplied. Point your browser at |
nethercote | 5da1e17 | 2003-12-03 21:44:45 +0000 | [diff] [blame] | 52 | $PREFIX/share/doc/valgrind/manual.html, where $PREFIX is whatever you |
| 53 | specified with --prefix= when building. |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 54 | |
| 55 | |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 56 | Building and installing it |
| 57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ |
njn | 0d733b8 | 2005-07-26 22:01:04 +0000 | [diff] [blame] | 58 | To install from the Subversion repository : |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 59 | |
njn | 0d733b8 | 2005-07-26 22:01:04 +0000 | [diff] [blame] | 60 | 0. Check out the code from SVN, following the instructions at |
njn | 1b70e82 | 2005-11-08 19:38:58 +0000 | [diff] [blame] | 61 | http://www.valgrind.org/downloads/repository.html. |
nethercote | ed7e073 | 2003-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 | |
njn | 0d733b8 | 2005-07-26 22:01:04 +0000 | [diff] [blame] | 68 | 3. Continue with the following instructions... |
| 69 | |
nethercote | 5da1e17 | 2003-12-03 21:44:45 +0000 | [diff] [blame] | 70 | To install from a tar.bz2 distribution: |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 71 | |
njn | 801288e | 2009-08-04 07:02:54 +0000 | [diff] [blame] | 72 | 4. Run ./configure, with some options if you wish. The only interesting |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 73 | one is the usual --prefix=/where/you/want/it/installed. |
| 74 | |
njn | 8b68b64 | 2009-06-24 00:37:09 +0000 | [diff] [blame] | 75 | 5. Run "make". |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 76 | |
njn | 8b68b64 | 2009-06-24 00:37:09 +0000 | [diff] [blame] | 77 | 6. Run "make install", possibly as root if the destination permissions |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 78 | require that. |
| 79 | |
njn | 0d733b8 | 2005-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). |
nethercote | ed7e073 | 2003-12-02 15:30:28 +0000 | [diff] [blame] | 83 | |
| 84 | Important! Do not move the valgrind installation into a place |
| 85 | different from that specified by --prefix at build time. This will |
| 86 | cause things to break in subtle ways, mostly when Valgrind handles |
| 87 | fork/exec calls. |
| 88 | |
sewardj | de4a1d0 | 2002-03-22 01:27:54 +0000 | [diff] [blame] | 89 | |
njn | 1b70e82 | 2005-11-08 19:38:58 +0000 | [diff] [blame] | 90 | The Valgrind Developers |